Major update breaking back-compatibility with command pattern for API queries and fixing cache management

Author: Vincent Chalnot

Action/RedirectUrlSetterAction.php

@@ -1,4 +1,4 @@
-<?php
+<?php declare(strict_types=1);
 /*
  * This file is part of the CleverAge/OAuthApiBundle package.
  *

CleverAgeOAuthApiBundle.php

@@ -1,4 +1,4 @@
-<?php
+<?php declare(strict_types=1);
 /*
  * This file is part of the CleverAge/OAuthApiBundle package.
  *

Client/ApiClient.php

@@ -1,4 +1,4 @@
-<?php
+<?php declare(strict_types=1);
 /*
  * This file is part of the CleverAge/OAuthApiBundle package.
  *
@@ -12,12 +12,11 @@
 
 use CleverAge\OAuthApiBundle\Exception\ApiDeserializationException;
 use CleverAge\OAuthApiBundle\Exception\ApiRequestException;
+use CleverAge\OAuthApiBundle\Request\ApiRequestInterface;
 use Http\Client\Exception as HttpException;
 use GuzzleHttp\Psr7\Request;
 use Http\Client\HttpClient;
-use Psr\Cache\InvalidArgumentException;
 use Psr\Log\LoggerInterface;
-use Symfony\Component\Cache\Adapter\AdapterInterface;
 use Symfony\Component\Serializer\SerializerInterface;
 
 /**
@@ -39,160 +38,94 @@ class ApiClient implements ApiClientInterface
     /** @var LoggerInterface */
     protected $logger;
 
-    /** @var AdapterInterface|null */
-    protected $cacheAdapter;
-
-    /** @var string|null */
-    protected $errorClass;
-
     /**
-     * @param HttpClient            $client
-     * @param SerializerInterface   $serializer
-     * @param LoggerInterface       $logger
-     * @param string                $baseUrl
-     * @param AdapterInterface|null $cacheAdapter
-     * @param string|null           $errorClass
+     * @param HttpClient          $client
+     * @param SerializerInterface $serializer
+     * @param LoggerInterface     $logger
+     * @param string              $baseUrl
      */
     public function __construct(
         HttpClient $client,
         SerializerInterface $serializer,
         LoggerInterface $logger,
-        string $baseUrl,
-        AdapterInterface $cacheAdapter = null,
-        string $errorClass = null
+        string $baseUrl
     ) {
         $this->client = $client;
         $this->serializer = $serializer;
         $this->logger = $logger;
         $this->baseUrl = $baseUrl;
-        $this->cacheAdapter = $cacheAdapter;
-        $this->errorClass = $errorClass;
     }
 
     /**
      * {@inheritDoc}
      */
-    public function getRemoteObject(
-        string $path,
-        string $className,
-        array $deserializationContext = [],
-        int $ttl = 0,
-        bool $private = false
-    ) {
-        $uri = $this->baseUrl.$path;
-        $request = new Request('GET', $uri);
-
-        return $this->fetchRemoteObject($request, $className, $deserializationContext, $ttl, $private);
-    }
-
-    /**
-     * {@inheritDoc}
-     */
-    public function postRemoteObject(
-        string $path,
-        $content,
-        string $className,
-        array $serializationContext = [],
-        array $deserializationContext = []
-    ) {
-        $serializedData = $this->serializer->serialize($content, 'json', $serializationContext);
-//        dump(\json_decode($serializedData)); // @todo remove me
-
-        $uri = $this->baseUrl.$path;
-        $request = new Request(
-            'POST',
-            $uri,
-            [
-                'Content-Type' => 'application/json',
-            ],
-            $serializedData
-        );
+    public function query(ApiRequestInterface $apiRequest)
+    {
+        $request = $this->getRequest($apiRequest);
+        $normalizedData = $this->getResponseData($request);
 
-        return $this->fetchRemoteObject($request, $className, $deserializationContext);
+        return $this->deserialize($apiRequest, $normalizedData);
     }
 
     /**
-     * @param Request $request
-     * @param string  $className
-     * @param array   $deserializationContext
-     * @param int     $ttl
-     * @param bool    $private
+     * @param ApiRequestInterface $apiRequest
+     * @param string|null         $normalizedData
      *
      * @return object
      */
-    protected function fetchRemoteObject(
-        Request $request,
-        string $className,
-        array $deserializationContext = [],
-        int $ttl = 0,
-        bool $private = false
-    ) {
-        $normalizedData = $this->getResponseData($request, $ttl, $private);
-//        dump(json_decode($normalizedData)); // @todo remove me
-
+    protected function deserialize(ApiRequestInterface $apiRequest, ?string $normalizedData)
+    {
         try {
             return $this->serializer->deserialize(
                 $normalizedData,
-                $className,
+                $apiRequest->getClassName(),
                 'json',
-                $deserializationContext
+                $apiRequest->getDeserializationContext()
             );
         } catch (\Exception $e) {
-            throw $this->handleError($e, $normalizedData, $className, $deserializationContext);
+            throw $this->handleError(
+                $e,
+                $normalizedData,
+                $apiRequest->getClassName(),
+                $apiRequest->getDeserializationContext()
+            );
         }
     }
 
     /**
-     * @param Request $request
-     * @param int     $ttl
+     * @param ApiRequestInterface $apiRequest
      *
-     * @param bool    $private
-     *
-     * @return string|null
+     * @return Request
      */
-    protected function getResponseData(
-        Request $request,
-        int $ttl = 0,
-        bool $private = false
-    ): ?string {
-        if (!$this->cacheAdapter || 0 === $ttl) {
-            return $this->doGetResponseData($request);
-        }
-
-        $cacheKey = $this->getCacheKey($request, $private);
-
-        $result = null;
-        try {
-            $result = $this->cacheAdapter->getItem($cacheKey);
-            if ($result->isHit()) {
-                $this->logger->info("Cache hit for request {$request->getUri()}");
-
-                return $result->get();
-            }
-        } catch (InvalidArgumentException $e) {
-            $this->logger->alert(
-                "Unable to access api cache: {$e->getMessage()}",
-                [
-                    'exception' => $e,
-                ]
+    protected function getRequest(ApiRequestInterface $apiRequest): Request
+    {
+        $serializedContent = null;
+        if ($apiRequest->getContent()) {
+            $serializedContent = $this->serializer->serialize(
+                $apiRequest->getContent(),
+                'json',
+                $apiRequest->getSerializationContext()
             );
         }
 
-        $body = $this->doGetResponseData($request);
-        $result->set($body);
-        $result->expiresAfter($ttl);
-        $this->cacheAdapter->save($result);
-
-        return $body;
+        return new Request(
+            $apiRequest->getMethod(),
+            $this->baseUrl.$apiRequest->getPath(),
+            [
+                'Content-Type' => 'application/json',
+            ],
+            $serializedContent
+        );
     }
 
     /**
      * @param Request $request
      *
-     * @return string
+     * @return string|null
      */
-    protected function doGetResponseData(Request $request): string
-    {
+    protected function getResponseData(
+        Request $request
+    ): ?string {
         try {
             $response = $this->client->sendRequest($request);
         } catch (HttpException $e) {
@@ -202,28 +135,6 @@ protected function doGetResponseData(Request $request): string
         return (string) $response->getBody();
     }
 
-    /**
-     * @param Request $request
-     * @param bool    $private
-     *
-     * @return string
-     */
-    protected function getCacheKey(Request $request, bool $private): string
-    {
-        $subCacheKey = $request->getMethod().$request->getUri().$request->getBody();
-        if ($private) {
-            $client = $this->client;
-            if ($client instanceof OAuthTokenAwareHttpClientInterface) {
-                // Append authorization token to cache key if private
-                $subCacheKey .= $client->getToken()->getAuthorization();
-            } else {
-                throw new \UnexpectedValueException('Unable to store private API cache, no private token available');
-            }
-        }
-
-        return sha1($subCacheKey);
-    }
-
     /**
      * @param \Exception  $exception
      * @param string|null $normalizedData
@@ -239,15 +150,16 @@ protected function handleError(
         array $deserializationContext
     ): ApiDeserializationException {
         $errorObject = null;
-        if ($this->errorClass) {
+        $errorClass = $deserializationContext['error_class'] ?? null;
+        if ($errorClass) {
             try {
                 $errorObject = $this->serializer->deserialize(
                     $normalizedData,
-                    $this->errorClass,
+                    $errorClass,
                     'json',
                     $deserializationContext
                 );
-            } catch (\Exception $e) {
+            } /** @noinspection BadExceptionsProcessingInspection */ catch (\Exception $e) {
                 $errorObject = \json_decode($normalizedData, true);
             }
         } else {

Client/ApiClientInterface.php

@@ -1,4 +1,4 @@
-<?php
+<?php declare(strict_types=1);
 /*
  * This file is part of the CleverAge/OAuthApiBundle package.
  *
@@ -10,44 +10,19 @@
 
 namespace CleverAge\OAuthApiBundle\Client;
 
+use CleverAge\OAuthApiBundle\Request\ApiRequestInterface;
+
 /**
- * Base logic used to fetch remote objects
+ * Base logic used to query a remote API
  *
  * @author Vincent Chalnot <vchalnot@clever-age.com>
  */
 interface ApiClientInterface
 {
     /**
-     * @param string $path
-     * @param string $className
-     * @param array  $deserializationContext
-     * @param int    $ttl
-     * @param bool   $private
-     *
-     * @return object
-     */
-    public function getRemoteObject(
-        string $path,
-        string $className,
-        array $deserializationContext = [],
-        int $ttl = 0,
-        bool $private = false
-    );
-
-    /**
-     * @param string       $path
-     * @param array|object $content
-     * @param string       $className
-     * @param array        $serializationContext
-     * @param array        $deserializationContext
+     * @param ApiRequestInterface $request
      *
      * @return object
      */
-    public function postRemoteObject(
-        string $path,
-        $content,
-        string $className,
-        array $serializationContext = [],
-        array $deserializationContext = []
-    );
+    public function query(ApiRequestInterface $request);
 }