It is also used to acquire the cache key.
public function testPurgeResult()
{
$requestBag = new RequestBag();
// populate request bag and point the cache key creation to the mocked class
$requestBag->setApi('CacheTest')->setMethodData(['cache' => ['ttl' => 100]])->setClassInstance(new MockCacheTestApiClass())->setClassData(['cacheKeyInterface' => true]);
\Webiny\Component\Rest\Response\Cache::saveResult($requestBag, 'my result');
$result = \Webiny\Component\Rest\Response\Cache::getFromCache($requestBag);
$this->assertSame('my result', $result);
\Webiny\Component\Rest\Response\Cache::purgeResult($requestBag);
$result = \Webiny\Component\Rest\Response\Cache::getFromCache($requestBag);
$this->assertFalse($result);
}
/**
* Processes the callback and returns an instance of CallbackResult.
*
* @return CallbackResult
* @throws \Webiny\Component\Rest\RestException
*/
public function getCallbackResult()
{
$class = $this->requestBag->getClassData()['class'];
$this->requestBag->setClassInstance(new $class());
// create CallbackResult instance
$cr = new CallbackResult();
$env = 'production';
if ($this->requestBag->getApiConfig()->get('Environment', 'production') == 'development') {
$cr->setEnvToDevelopment();
$env = 'development';
}
// attach some metadata
$cr->attachDebugHeader('Class', $class);
$cr->attachDebugHeader('ClassVersion', $this->requestBag->getClassData()['version']);
$cr->attachDebugHeader('Method', strtoupper($this->httpRequest()->getRequestMethod()));
if (!$this->requestBag->getMethodData()) {
// if no method matched the request
$cr->setHeaderResponse(404);
$cr->setErrorResponse('No service matched the request.');
return $cr;
}
// check rate limit
try {
$rateControl = RateControl::isWithinRateLimits($this->requestBag, $cr);
if (!$rateControl) {
$cr->setHeaderResponse(429);
$cr->setErrorResponse('Rate control limit reached.');
return $cr;
}
} catch (\Exception $e) {
throw new RestException('Rate control verification failed. ' . $e->getMessage());
}
// verify access role
try {
$hasAccess = Security::hasAccess($this->requestBag);
if (!$hasAccess) {
$cr->setHeaderResponse(403);
$cr->setErrorResponse('You don\'t have the required access level.');
$cr->attachDebugHeader('RequestedRole', $this->requestBag->getMethodData()['role']);
return $cr;
}
} catch (\Exception $e) {
throw new RestException('Access role verification failed. ' . $e->getMessage());
}
// verify cache
try {
$cachedResult = Cache::getFromCache($this->requestBag);
} catch (\Exception $e) {
throw new RestException('Reading result from cache failed. ' . $e->getMessage());
}
// finalize output
if ($cachedResult) {
$cr->setData($cachedResult);
$cr->attachDebugHeader('Cache', 'HIT');
} else {
try {
$result = call_user_func_array([$this->requestBag->getClassInstance(), $this->requestBag->getMethodData()['method']], $this->requestBag->getMethodParameters());
// check if method has custom headers set
$cr->setHeaderResponse($this->requestBag->getMethodData()['header']['status']['success']);
$cr->attachDebugHeader('Cache', 'MISS');
// add result to output
$cr->setData($result);
// check if we need to attach the cache headers
if ($this->requestBag->getMethodData()['header']['cache']['expires'] > 0) {
$cr->setExpiresIn($this->requestBag->getMethodData()['header']['cache']['expires']);
}
// cache the result
Cache::saveResult($this->requestBag, $result);
} catch (RestErrorException $re) {
// check if method has custom headers set
$cr->setHeaderResponse($statusCode = $re->getResponseCode(), $this->requestBag->getMethodData()['header']['status']['errorMessage']);
// check if a custom http response code is set
$cr->setErrorResponse($re->getErrorMessage(), $re->getErrorDescription(), $re->getErrorCode());
$errors = $re->getErrors();
foreach ($errors as $e) {
$cr->addErrorMessage($e);
}
if ($env == 'development') {
$cr->addDebugMessage(['file' => $re->getFile(), 'line' => $re->getLine(), 'traces' => explode('#', $re->getTraceAsString())]);
}
} catch (\Exception $e) {
// check if method has custom headers set
$cr->setHeaderResponse($this->requestBag->getMethodData()['header']['status']['error'], $this->requestBag->getMethodData()['header']['status']['errorMessage']);
$cr->setErrorResponse('There has been an error processing the request.');
if ($env == 'development') {
$cr->addErrorMessage(['message' => $e->getMessage()]);
$cr->addDebugMessage(['file' => $e->getFile(), 'line' => $e->getLine(), 'traces' => explode('#', $e->getTraceAsString())]);
}
}
}
return $cr;
}