Add logical cursor for long query parameters

.github/workflows/phpstan-6.yaml → .github/workflows/phpstan-9.yaml

@@ -1,7 +1,7 @@
-name: PHPStan level 6
+name: PHPStan level 8
 on: push
 jobs:
-  phpstan-6:
+  phpstan-9:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
@@ -20,4 +20,4 @@ jobs:
         uses: php-actions/phpstan@v3
         with:
           path: src/
-          level: 6
+          level: 9

.github/workflows/quality.yaml

@@ -1,4 +1,4 @@
-name: Quality (PHPStan lvl 5)
+name: Quality (PHPStan lvl 7)
 on: push
 jobs:
     cs-fixer:
@@ -12,7 +12,7 @@ jobs:
                 run: |
                     wget -q https://cs.symfony.com/download/php-cs-fixer-v3.phar -O php-cs-fixer
                     chmod a+x php-cs-fixer
-                    PHP_CS_FIXER_IGNORE_ENV=true ./php-cs-fixer fix src --dry-run
+                    ./php-cs-fixer fix src --dry-run
 
     phpstan:
         runs-on: ubuntu-latest
@@ -32,4 +32,4 @@ jobs:
               uses: php-actions/phpstan@v3
               with:
                   path: src/
-                  level: 5
+                  level: 7

phpstan.neon

@@ -0,0 +1,3 @@
+parameters:
+    level: 7
+    treatPhpDocTypesAsCertain: false

src/CategoryLookup.php

@@ -7,55 +7,159 @@
 use Kiboko\Component\Bucket\AcceptanceResultBucket;
 use Kiboko\Component\Bucket\EmptyResultBucket;
 use Kiboko\Component\Bucket\RejectionResultBucket;
+use Kiboko\Contract\Bucket\RejectionResultBucketInterface;
 use Kiboko\Contract\Mapping\CompiledMapperInterface;
 use Kiboko\Contract\Pipeline\TransformerInterface;
-use Psr\SimpleCache\CacheInterface;
+use Kiboko\Magento\Client;
+use Kiboko\Magento\Exception\GetV1CategoriesCategoryIdBadRequestException;
+use Kiboko\Magento\Exception\UnexpectedStatusCodeException;
+use Kiboko\Magento\Model\CatalogDataCategoryInterface;
+use Kiboko\Magento\Model\ErrorResponse;
+use Psr\Http\Client\NetworkExceptionInterface;
+use Psr\Log\LoggerInterface;
 
+/**
+ * @template InputType of array
+ * @template OutputType of InputType|array
+ *
+ * @implements TransformerInterface<InputType, OutputType>
+ */
 final readonly class CategoryLookup implements TransformerInterface
 {
+    /**
+     * @param CompiledMapperInterface<CatalogDataCategoryInterface, InputType, OutputType> $mapper
+     */
     public function __construct(
-        private \Psr\Log\LoggerInterface $logger,
-        private \Kiboko\Magento\Client $client,
-        private CacheInterface $cache,
-        private string $cacheKey,
+        private LoggerInterface $logger,
+        private Client $client,
         private CompiledMapperInterface $mapper,
         private string $mappingField,
     ) {
     }
 
+    /**
+     * @return RejectionResultBucketInterface<OutputType>
+     */
+    private function rejectErrorResponse(ErrorResponse $response): RejectionResultBucketInterface
+    {
+        $this->logger->error(
+            $response->getMessage(),
+            [
+                'resource' => 'getV1CategoriesCategoryId',
+                'method' => 'get',
+            ],
+        );
+
+        return new RejectionResultBucket($response->getMessage(), null);
+    }
+
+    /**
+     * @return RejectionResultBucketInterface<OutputType>
+     */
+    private function rejectInvalidResponse(): RejectionResultBucketInterface
+    {
+        $this->logger->error(
+            $message = 'The result provided by the API client does not match the expected type. The connector compilation may have fetched incompatible versions.',
+            [
+                'resource' => 'getV1CategoriesCategoryId',
+                'method' => 'get',
+            ],
+        );
+
+        return new RejectionResultBucket($message, null);
+    }
+
+    /**
+     * @param InputType $line
+     *
+     * @return OutputType
+     */
+    public function passThrough(array $line): array
+    {
+        /* @var OutputType $line */
+        return $line;
+    }
+
     public function transform(): \Generator
     {
         $line = yield new EmptyResultBucket();
         while (true) {
+            if (null === $line) {
+                $line = yield new EmptyResultBucket();
+                continue;
+            }
+
             if (null === $line[$this->mappingField]) {
-                $line = yield new AcceptanceResultBucket($line);
+                $line = yield new AcceptanceResultBucket($this->passThrough($line));
+                continue;
             }
 
             try {
-                $lookup = $this->cache->get(sprintf($this->cacheKey, $line[$this->mappingField]));
-
-                if (null === $lookup) {
-                    $lookup = $this->client->getV1CategoriesCategoryId(
-                        categoryId: (int) $line[$this->mappingField],
-                    );
+                $lookup = $this->client->getV1CategoriesCategoryId(
+                    categoryId: (int) $line[$this->mappingField],
+                );
 
-                    if (!$lookup instanceof \Kiboko\Magento\Model\CatalogDataCategoryInterface) {
-                        return;
-                    }
+                if ($lookup instanceof ErrorResponse) {
+                    $line = yield $this->rejectErrorResponse($lookup);
+                    continue;
+                }
 
-                    $this->cache->set(
-                        sprintf($this->cacheKey, $line[$this->mappingField]),
-                        $lookup,
-                    );
+                if (!$lookup instanceof CatalogDataCategoryInterface) {
+                    $line = yield $this->rejectInvalidResponse();
+                    continue;
                 }
-            } catch (\RuntimeException $exception) {
-                $this->logger->warning($exception->getMessage(), ['exception' => $exception, 'item' => $line]);
+            } catch (NetworkExceptionInterface $exception) {
+                $this->logger->critical(
+                    $exception->getMessage(),
+                    [
+                        'exception' => $exception,
+                        'resource' => 'getV1CategoriesCategoryId',
+                        'method' => 'get',
+                        'categoryId' => (int) $line[$this->mappingField],
+                        'mappingField' => $this->mappingField,
+                    ],
+                );
+                $line = yield new RejectionResultBucket(
+                    'There are some network difficulties. We could not properly connect to the Magento API. There is nothing we could no to fix this currently. Please contact the Magento administrator.',
+                    $exception,
+                    $this->passThrough($line),
+                );
+                continue;
+            } catch (GetV1CategoriesCategoryIdBadRequestException $exception) {
+                $this->logger->error(
+                    $exception->getMessage(),
+                    [
+                        'exception' => $exception,
+                        'resource' => 'getV1CategoriesCategoryId',
+                        'method' => 'get',
+                        'categoryId' => (int) $line[$this->mappingField],
+                        'mappingField' => $this->mappingField,
+                    ],
+                );
                 $line = yield new RejectionResultBucket(
-                    sprintf('Something went wrong in the attempt to recover the category with id %d', (int) $line[$this->mappingField]),
+                    'The source API rejected our request. Ignoring line. Maybe you are requesting on incompatible versions.',
                     $exception,
-                    $line
+                    $this->passThrough($line),
                 );
                 continue;
+            } catch (UnexpectedStatusCodeException $exception) {
+                $this->logger->critical(
+                    $exception->getMessage(),
+                    [
+                        'exception' => $exception,
+                        'resource' => 'getV1CategoriesCategoryId',
+                        'method' => 'get',
+                        'categoryId' => (int) $line[$this->mappingField],
+                        'mappingField' => $this->mappingField,
+                    ],
+                );
+                $line = yield new RejectionResultBucket(
+                    'The source API responded with a status we did not expect. Aborting. Please check the availability of the source API and if there are no rate limiting or redirections active.',
+                    $exception,
+                    $this->passThrough($line),
+                );
+
+                return;
             }
 
             $output = ($this->mapper)($lookup, $line);