add request into model providers

Maelmin Henge · Maelmin Henge · commit edeb147bdec4 · 2025-03-11T10:10:56.000+02:00
diff --git a/src/Cache/CacheManager.php b/src/Cache/CacheManager.php
@@ -1,12 +1,11 @@
 <?php
 
-
 namespace Hengebytes\WebserviceCoreAsyncBundle\Cache;
 
+use Exception;
 use Hengebytes\WebserviceCoreAsyncBundle\Request\WSRequest;
 use Hengebytes\WebserviceCoreAsyncBundle\Response\CacheResponse;
 use Hengebytes\WebserviceCoreAsyncBundle\Tagger\CacheTagProvider;
-use Exception;
 use Psr\Cache\CacheException;
 use Psr\Cache\InvalidArgumentException;
 use Symfony\Component\Cache\Adapter\TagAwareAdapterInterface;
@@ -163,7 +162,7 @@ public function invalidateCacheById(string $id): void
 
     public function invalidateCacheByWSRequest(WSRequest $request): void
     {
-        //$this->invalidateCacheById($this->buildCacheId($request));
+        $this->invalidateCacheById($this->buildCacheId($request));
 
         $tags = $this->cacheTagProvider->getInvalidateTags($request);
         if (!$tags) {
diff --git a/src/Cache/Middleware/Request/CacheTTLRequestModifier.php b/src/Cache/Middleware/Request/CacheTTLRequestModifier.php
@@ -3,8 +3,8 @@
 namespace Hengebytes\WebserviceCoreAsyncBundle\Cache\Middleware\Request;
 
 use Hengebytes\WebserviceCoreAsyncBundle\Middleware\RequestModifierInterface;
-use Hengebytes\WebserviceCoreAsyncBundle\Request\WSRequest;
 use Hengebytes\WebserviceCoreAsyncBundle\Provider\ParamsProviderInterface;
+use Hengebytes\WebserviceCoreAsyncBundle\Request\WSRequest;
 
 readonly class CacheTTLRequestModifier implements RequestModifierInterface
 {
diff --git a/src/DependencyInjection/HBWebserviceCoreAsyncExtension.php b/src/DependencyInjection/HBWebserviceCoreAsyncExtension.php
@@ -10,9 +10,9 @@
 use Hengebytes\WebserviceCoreAsyncBundle\Provider\ParamsProviderInterface;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Extension\Extension;
 use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
 use Symfony\Component\DependencyInjection\Reference;
-use Symfony\Component\DependencyInjection\Extension\Extension;
 
 class HBWebserviceCoreAsyncExtension extends Extension
 {
diff --git a/src/Enum/RequestMethodEnum.php b/src/Enum/RequestMethodEnum.php
@@ -9,4 +9,6 @@ enum RequestMethodEnum: string
     case PUT = 'PUT';
     case PATCH = 'PATCH';
     case DELETE = 'DELETE';
+    case OPTIONS = 'OPTIONS';
+    case HEAD = 'HEAD';
 }
diff --git a/src/Exception/NotSupportedModelException.php b/src/Exception/NotSupportedModelException.php
@@ -2,9 +2,9 @@
 
 namespace Hengebytes\WebserviceCoreAsyncBundle\Exception;
 
-use Exception;
+use RuntimeException;
 
-class NotSupportedModelException extends Exception
+class NotSupportedModelException extends RuntimeException
 {
     public function __construct($model)
     {
diff --git a/src/Handler/AsyncRequestHandler.php b/src/Handler/AsyncRequestHandler.php
@@ -35,7 +35,7 @@ public function request(WSRequest $request): AsyncResponse
     {
         $this->requestModification->modifyRequest($request);
 
-        $isCachableRequest = $request->isCachable() && $this->cacheManager !== null;
+        $isCachableRequest = $this->cacheManager !== null && $request->isCachable();
         if ($isCachableRequest && !$request->isSkipReadCache()) {
             $cacheResponse = $this->cacheManager->getByWSRequest($request);
             if (in_array($cacheResponse->getStatusCode(), [Response::HTTP_OK, Response::HTTP_LOCKED], true)) {
diff --git a/src/Middleware/Request/BaseUrlRequestModifier.php b/src/Middleware/Request/BaseUrlRequestModifier.php
@@ -3,8 +3,8 @@
 namespace Hengebytes\WebserviceCoreAsyncBundle\Middleware\Request;
 
 use Hengebytes\WebserviceCoreAsyncBundle\Middleware\RequestModifierInterface;
-use Hengebytes\WebserviceCoreAsyncBundle\Request\WSRequest;
 use Hengebytes\WebserviceCoreAsyncBundle\Provider\ParamsProviderInterface;
+use Hengebytes\WebserviceCoreAsyncBundle\Request\WSRequest;
 use RuntimeException;
 
 readonly class BaseUrlRequestModifier implements RequestModifierInterface
diff --git a/src/Middleware/Request/TimeoutRequestModifier.php b/src/Middleware/Request/TimeoutRequestModifier.php
@@ -3,8 +3,8 @@
 namespace Hengebytes\WebserviceCoreAsyncBundle\Middleware\Request;
 
 use Hengebytes\WebserviceCoreAsyncBundle\Middleware\RequestModifierInterface;
-use Hengebytes\WebserviceCoreAsyncBundle\Request\WSRequest;
 use Hengebytes\WebserviceCoreAsyncBundle\Provider\ParamsProviderInterface;
+use Hengebytes\WebserviceCoreAsyncBundle\Request\WSRequest;
 
 readonly class TimeoutRequestModifier implements RequestModifierInterface
 {
diff --git a/src/Provider/ModelProvider.php b/src/Provider/ModelProvider.php
@@ -3,6 +3,7 @@
 namespace Hengebytes\WebserviceCoreAsyncBundle\Provider;
 
 use Hengebytes\WebserviceCoreAsyncBundle\Exception\NotSupportedModelException;
+use Hengebytes\WebserviceCoreAsyncBundle\Request\WSRequest;
 use Symfony\Component\DependencyInjection\Attribute\TaggedIterator;
 
 /**
@@ -19,9 +20,9 @@ public function __construct(
     /**
      * @param class-string<T> $className
      * @return T
-     * @throws NotSupportedModelException
+     * @throws NotSupportedModelException if no provider for $className
      */
-    public function getModel(string $className, mixed $data)
+    public function getModel(string $className, mixed $data, ?WSRequest $request = null): object
     {
         $supportedProvider = null;
         /** @var ModelProviderInterface $provider */
@@ -36,6 +37,6 @@ public function getModel(string $className, mixed $data)
             throw new NotSupportedModelException($className);
         }
 
-        return $supportedProvider->getModel($data, $this);
+        return $supportedProvider->getModel($data, $this, $request);
     }
 }
diff --git a/src/Provider/ModelProviderInterface.php b/src/Provider/ModelProviderInterface.php
@@ -2,12 +2,13 @@
 
 namespace Hengebytes\WebserviceCoreAsyncBundle\Provider;
 
+use Hengebytes\WebserviceCoreAsyncBundle\Request\WSRequest;
 use Symfony\Component\DependencyInjection\Attribute\AutoconfigureTag;
 
 #[AutoconfigureTag('webservice_core_async.provider.model')]
 interface ModelProviderInterface
 {
-    public function getModel(mixed $data, ModelProvider $modelProvider): object;
+    public function getModel(mixed $data, ModelProvider $modelProvider, ?WSRequest $WSRequest = null): object;
 
     public function supports(string $model): bool;
 
diff --git a/src/Response/AsyncResponse.php b/src/Response/AsyncResponse.php
@@ -1,12 +1,11 @@
 <?php
 
-
 namespace Hengebytes\WebserviceCoreAsyncBundle\Response;
 
+use Exception;
 use Hengebytes\WebserviceCoreAsyncBundle\Callback\OnResponseReceivedCallback;
 use Hengebytes\WebserviceCoreAsyncBundle\Exception\ResponseFailException;
 use Hengebytes\WebserviceCoreAsyncBundle\Request\WSRequest;
-use Exception;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
 use Symfony\Contracts\HttpClient\ResponseInterface;
@@ -27,22 +26,15 @@ public function __construct(
 
     public function getStatusCode(): int
     {
-        if (!$this->parsedResponse) {
-            $this->parsedResponse = new ParsedResponse($this);
-        }
-
-        if ($this->callbacksExecuted) {
-            return $this->parsedResponse->statusCode;
-        }
         try {
-            foreach ($this->onResponseReceivedCallbacks as $callback) {
-                $callback($this->parsedResponse);
-            }
-            $this->callbacksExecuted = true;
+            $this->processCallbacks();
         } catch (Exception) {
-            return $this->WSResponse->getStatusCode();
-        } catch (TransportExceptionInterface $e) {
-            return Response::HTTP_SERVICE_UNAVAILABLE;
+            try {
+                // original status code: $this->WSResponse->getStatusCode();
+                return $this->WSResponse->getStatusCode();
+            } catch (TransportExceptionInterface) {
+                return Response::HTTP_SERVICE_UNAVAILABLE;
+            }
         }
 
         return $this->parsedResponse->statusCode;
@@ -53,16 +45,7 @@ public function getStatusCode(): int
      */
     public function getHeaders(): array
     {
-        if (!$this->parsedResponse) {
-            $this->parsedResponse = new ParsedResponse($this);
-        }
-
-        if (!$this->callbacksExecuted) {
-            foreach ($this->onResponseReceivedCallbacks as $callback) {
-                $callback($this->parsedResponse);
-            }
-            $this->callbacksExecuted = true;
-        }
+        $this->processCallbacks();
 
         if ($this->parsedResponse->exception) {
             /** @throws ResponseFailException */
@@ -77,15 +60,7 @@ public function getHeaders(): array
      */
     public function toArray(): array
     {
-        if (!$this->parsedResponse) {
-            $this->parsedResponse = new ParsedResponse($this);
-        }
-        if (!$this->callbacksExecuted) {
-            foreach ($this->onResponseReceivedCallbacks as $callback) {
-                $callback($this->parsedResponse);
-            }
-            $this->callbacksExecuted = true;
-        }
+        $this->processCallbacks();
 
         if ($this->parsedResponse->exception) {
             /** @throws ResponseFailException */
@@ -99,4 +74,18 @@ public function addOnResponseReceivedCallback(OnResponseReceivedCallback $onResp
     {
         $this->onResponseReceivedCallbacks[] = $onResponseReceived;
     }
+
+    protected function processCallbacks(): void
+    {
+        if (!$this->parsedResponse) {
+            $this->parsedResponse = new ParsedResponse($this);
+        }
+
+        if (!$this->callbacksExecuted) {
+            foreach ($this->onResponseReceivedCallbacks as $callback) {
+                $callback($this->parsedResponse);
+            }
+            $this->callbacksExecuted = true;
+        }
+    }
 }
diff --git a/src/Response/ModelPromise.php b/src/Response/ModelPromise.php
@@ -3,9 +3,8 @@
 namespace Hengebytes\WebserviceCoreAsyncBundle\Response;
 
 use Hengebytes\WebserviceCoreAsyncBundle\Exception\NotSupportedModelException;
-use Hengebytes\WebserviceCoreAsyncBundle\Provider\ModelProvider;
 use Hengebytes\WebserviceCoreAsyncBundle\Exception\ResponseFailException;
-use Symfony\Contracts\HttpClient\Exception\DecodingExceptionInterface;
+use Hengebytes\WebserviceCoreAsyncBundle\Provider\ModelProvider;
 
 /**
  * @template T
@@ -23,8 +22,8 @@ class ModelPromise
      * @param ModelProvider $modelProvider
      */
     public function __construct(
-        readonly private AsyncResponse $response,
-        readonly private string $className,
+        private AsyncResponse $response,
+        private string $className,
         readonly private ModelProvider $modelProvider
     ) {
     }
@@ -39,7 +38,8 @@ public function getModel()
         if (!$this->model) {
             $data = $this->response->toArray();
 
-            $this->model = $this->modelProvider->getModel($this->className, $data);
+            $this->model = $this->modelProvider->getModel($this->className, $data, $this->response->WSRequest);
+            unset($this->response, $this->className);
         }
 
         return $this->model;

Original file line number	Diff line number	Diff line change
`@@ -3,8 +3,8 @@`
`3`	`3`	`namespace Hengebytes\WebserviceCoreAsyncBundle\Cache\Middleware\Request;`
`4`	`4`
`5`	`5`	`use Hengebytes\WebserviceCoreAsyncBundle\Middleware\RequestModifierInterface;`
`6`		`-use Hengebytes\WebserviceCoreAsyncBundle\Request\WSRequest;`
`7`	`6`	`use Hengebytes\WebserviceCoreAsyncBundle\Provider\ParamsProviderInterface;`
	`7`	`+use Hengebytes\WebserviceCoreAsyncBundle\Request\WSRequest;`
`8`	`8`
`9`	`9`	`readonly class CacheTTLRequestModifier implements RequestModifierInterface`
`10`	`10`	`{`
Original file line number	Diff line number	Diff line change
`@@ -9,4 +9,6 @@ enum RequestMethodEnum: string`
`9`	`9`	`case PUT = 'PUT';`
`10`	`10`	`case PATCH = 'PATCH';`
`11`	`11`	`case DELETE = 'DELETE';`
	`12`	`+ case OPTIONS = 'OPTIONS';`
	`13`	`+ case HEAD = 'HEAD';`
`12`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,9 +2,9 @@`
`2`	`2`
`3`	`3`	`namespace Hengebytes\WebserviceCoreAsyncBundle\Exception;`
`4`	`4`
`5`		`-use Exception;`
	`5`	`+use RuntimeException;`
`6`	`6`
`7`		`-class NotSupportedModelException extends Exception`
	`7`	`+class NotSupportedModelException extends RuntimeException`
`8`	`8`	`{`
`9`	`9`	`public function __construct($model)`
`10`	`10`	`{`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ public function request(WSRequest $request): AsyncResponse`
`35`	`35`	`{`
`36`	`36`	`$this->requestModification->modifyRequest($request);`
`37`	`37`
`38`		`- $isCachableRequest = $request->isCachable() && $this->cacheManager !== null;`
	`38`	`+ $isCachableRequest = $this->cacheManager !== null && $request->isCachable();`
`39`	`39`	`if ($isCachableRequest && !$request->isSkipReadCache()) {`
`40`	`40`	`$cacheResponse = $this->cacheManager->getByWSRequest($request);`
`41`	`41`	`if (in_array($cacheResponse->getStatusCode(), [Response::HTTP_OK, Response::HTTP_LOCKED], true)) {`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`namespace Hengebytes\WebserviceCoreAsyncBundle\Provider;`
`4`	`4`
`5`	`5`	`use Hengebytes\WebserviceCoreAsyncBundle\Exception\NotSupportedModelException;`
	`6`	`+use Hengebytes\WebserviceCoreAsyncBundle\Request\WSRequest;`
`6`	`7`	`use Symfony\Component\DependencyInjection\Attribute\TaggedIterator;`
`7`	`8`
`8`	`9`	`/**`
`@@ -19,9 +20,9 @@ public function __construct(`
`19`	`20`	`/**`
`20`	`21`	`* @param class-string<T> $className`
`21`	`22`	`* @return T`
`22`		`- * @throws NotSupportedModelException`
	`23`	`+ * @throws NotSupportedModelException if no provider for $className`
`23`	`24`	`*/`
`24`		`- public function getModel(string $className, mixed $data)`
	`25`	`+ public function getModel(string $className, mixed $data, ?WSRequest $request = null): object`
`25`	`26`	`{`
`26`	`27`	`$supportedProvider = null;`
`27`	`28`	`/** @var ModelProviderInterface $provider */`
`@@ -36,6 +37,6 @@ public function getModel(string $className, mixed $data)`
`36`	`37`	`throw new NotSupportedModelException($className);`
`37`	`38`	`}`
`38`	`39`
`39`		`- return $supportedProvider->getModel($data, $this);`
	`40`	`+ return $supportedProvider->getModel($data, $this, $request);`
`40`	`41`	`}`
`41`	`42`	`}`