Merge pull request #21 from OpenClassrooms/remove_openclassrooms_cache

Remove openclassrooms/cache deps

Author: kletord

.github/workflows/tests.yml

@@ -0,0 +1,37 @@
+name: Tests
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/master' }}
+
+jobs:
+
+  tests:
+    runs-on: ubuntu-24.04
+    strategy:
+      matrix:
+        php-versions: [ '8.2', '8.3', '8.4' ]
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup PHP, with composer and extensions
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-versions }}
+          coverage: none
+
+      - name: Composer install
+        run: composer install --no-scripts --no-interaction --prefer-dist -oa
+
+      - name: Run Phpunit
+        run: ./vendor/bin/phpunit
+
+      - name: Run PHPStan
+        run: ./vendor/bin/phpstan analyse src

.gitignore

@@ -2,3 +2,4 @@
 composer.lock
 composer.phar
 vendor/
+.phpunit.result.cache

composer.json

@@ -26,11 +26,14 @@
     },
     "require": {
         "php": ">=8.2",
-        "doctrine/annotations": "~2.0",
-        "openclassrooms/cache": "^v1.1.0"
+        "doctrine/annotations": "^1.0|~2.0",
+        "psr/log": "^2.0|^3.0",
+        "psr/cache": "^2.0|^3.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^9.6.20"
+        "phpunit/phpunit": "^11.0",
+        "phpstan/phpstan": "^2.1",
+        "symfony/cache": "^5.4|^6.4|^7.0"
     },
     "extra": {
         "branch-alias": {

phpunit.xml.dist

@@ -1,26 +1,18 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
-<phpunit
-        backupGlobals               = "false"
-        backupStaticAttributes      = "false"
-        colors                      = "true"
-        convertErrorsToExceptions   = "true"
-        convertNoticesToExceptions  = "true"
-        convertWarningsToExceptions = "true"
-        processIsolation            = "false"
-        stopOnFailure               = "false"
-        syntaxCheck                 = "false"
-        bootstrap                   = "./tests/bootstrap.php">
-
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.5/phpunit.xsd"
+         bootstrap="tests/bootstrap.php">
     <testsuites>
-        <testsuite name="Use Case Test Suite">
-            <directory>./tests/</directory>
+        <testsuite name="unit">
+            <directory>tests/</directory>
         </testsuite>
     </testsuites>
-    <filter>
-        <whitelist>
-            <directory suffix=".php">./src</directory>
-        </whitelist>
-    </filter>
-</phpunit>
 
+    <source>
+        <include>
+            <directory>src/</directory>
+        </include>
+    </source>
+
+    <coverage pathCoverage="true" />
+</phpunit>

src/OpenClassrooms/UseCase/Application/Services/Event/Exceptions/InvalidEventNameException.php

@@ -2,8 +2,6 @@
 
 namespace OpenClassrooms\UseCase\Application\Services\Event\Exceptions;
 
-use Exception;
-
 /**
  * @author Romain Kuzniak <romain.kuzniak@turn-it-up.org>
  */

src/OpenClassrooms/UseCase/Application/Services/Proxy/Strategies/Impl/Cache/CacheProxyStrategy.php

@@ -2,35 +2,30 @@
 
 namespace OpenClassrooms\UseCase\Application\Services\Proxy\Strategies\Impl\Cache;
 
-use OpenClassrooms\Cache\Cache\Cache;
 use OpenClassrooms\UseCase\Application\Services\Proxy\Strategies\Impl\DTO\ProxyStrategyResponseDTO;
 use OpenClassrooms\UseCase\Application\Services\Proxy\Strategies\Requestors\Cache\CacheProxyStrategyRequest;
 use OpenClassrooms\UseCase\Application\Services\Proxy\Strategies\Requestors\PostExecuteProxyStrategy;
 use OpenClassrooms\UseCase\Application\Services\Proxy\Strategies\Requestors\PreExecuteProxyStrategy;
 use OpenClassrooms\UseCase\Application\Services\Proxy\Strategies\Requestors\ProxyStrategy;
 use OpenClassrooms\UseCase\Application\Services\Proxy\Strategies\Requestors\ProxyStrategyRequest;
 use OpenClassrooms\UseCase\Application\Services\Proxy\Strategies\Responders\ProxyStrategyResponse;
+use Psr\Cache\CacheItemInterface;
+use Psr\Cache\CacheItemPoolInterface;
 
 /**
  * @author Romain Kuzniak <romain.kuzniak@turn-it-up.org>
  */
 class CacheProxyStrategy implements PreExecuteProxyStrategy, PostExecuteProxyStrategy
 {
-
-    /**
-     * @var mixed
-     */
-    private $data;
-
     /**
-     * @var Cache
+     * @var CacheItemPoolInterface
      */
     private $cache;
 
     /**
      * @var bool
      */
-    private $postExecute = true;
+    private $postExecute;
 
     /**
      * @return string
@@ -46,28 +41,14 @@ public function getType()
     public function preExecute(ProxyStrategyRequest $proxyStrategyRequest)
     {
         /** @var CacheProxyStrategyRequest $proxyStrategyRequest */
-        $this->data = $this->cache->fetchWithNamespace(
+        $item = $this->fetchWithNamespace(
             $proxyStrategyRequest->getId(),
             $proxyStrategyRequest->getNamespaceId()
         );
 
-        if ($this->responseIsInCache()) {
-            $stopExecution = true;
-            $this->postExecute = false;
-        } else {
-            $stopExecution = false;
-        }
-        $response = new ProxyStrategyResponseDTO($this->data, $stopExecution);
-
-        return $response;
-    }
+        $this->postExecute = !$item->isHit();
 
-    /**
-     * @return bool
-     */
-    private function responseIsInCache()
-    {
-        return $this->data;
+        return new ProxyStrategyResponseDTO($item->get(), $item->isHit());
     }
 
     /**
@@ -76,17 +57,51 @@ private function responseIsInCache()
     public function postExecute(ProxyStrategyRequest $proxyStrategyRequest)
     {
         /** @var CacheProxyStrategyRequest $proxyStrategyRequest */
-        $saved = $this->cache->saveWithNamespace(
+        $item = $this->saveWithNamespace(
             $proxyStrategyRequest->getId(),
             $proxyStrategyRequest->getData(),
             $proxyStrategyRequest->getNamespaceId(),
             $proxyStrategyRequest->getLifeTime()
         );
-        $response = new ProxyStrategyResponseDTO($saved, false);
 
-        return $response;
+        return new ProxyStrategyResponseDTO($item->get(), false);
     }
 
+    private function fetchWithNamespace(string $id, string $namespace = null): CacheItemInterface
+    {
+        if ($namespace !== null) {
+            $namespaceId = $this->cache->getItem($namespace);
+
+            $id = ((string) $namespaceId->get()) . $id;
+        }
+
+        return $this->cache->getItem($id);
+    }
+
+    private function saveWithNamespace(string $id, mixed $data, string $namespace = null, int $lifetime = null): CacheItemInterface
+    {
+        if ($namespace !== null) {
+            $namespaceId = $this->cache->getItem($namespace);
+
+            if (!$namespaceId->isHit()) {
+                $namespaceId->set($namespace . '_' . random_int(0, 10000));
+                $namespaceId->expiresAfter(604800); // 7 days
+
+                $this->cache->save($namespaceId);
+            }
+
+            $id = ((string) $namespaceId->get()) . $id;
+        }
+
+        $item = $this->cache->getItem($id);
+        $item->set($data)->expiresAfter($lifetime);
+
+        $this->cache->save($item);
+
+        return $item;
+    }
+
+
     /**
      * @return boolean
      */
@@ -95,7 +110,7 @@ public function isPostExecute()
         return $this->postExecute;
     }
 
-    public function setCache(Cache $cache)
+    public function setCache(CacheItemPoolInterface $cache)
     {
         $this->cache = $cache;
     }

src/OpenClassrooms/UseCase/Application/Services/Proxy/Strategies/Impl/CacheProxyStrategyBagImpl.php

@@ -28,8 +28,6 @@ class CacheProxyStrategyBagImpl extends ProxyStrategyBag
 
     public function isPostExecute()
     {
-        /** @var $this ->proxyStrategy */
-
         return $this->proxyStrategy->isPostExecute();
     }
 }

src/OpenClassrooms/UseCase/Application/Services/Proxy/Strategies/Impl/Transaction/TransactionProxyStrategy.php

@@ -45,7 +45,9 @@ public function preExecute(ProxyStrategyRequest $proxyStrategyRequest)
      */
     public function postExecute(ProxyStrategyRequest $proxyStrategyRequest)
     {
-        return $this->transaction->commit();
+        $this->transaction->commit();
+
+        return new ProxyStrategyResponseDTO();
     }
 
     /**
@@ -54,8 +56,10 @@ public function postExecute(ProxyStrategyRequest $proxyStrategyRequest)
     public function onException(ProxyStrategyRequest $proxyStrategyRequest)
     {
         if ($this->transaction->isTransactionActive()) {
-            return $this->transaction->rollBack();
+            $this->transaction->rollBack();
         }
+
+        return new ProxyStrategyResponseDTO();
     }
 
     public function setTransaction(Transaction $transaction)

src/OpenClassrooms/UseCase/Application/Services/Proxy/Strategies/Requestors/OnExceptionProxyStrategy.php

@@ -10,7 +10,7 @@
 interface OnExceptionProxyStrategy extends ProxyStrategy
 {
     /**
-     * @return ProxyStrategyResponse
+     * @return ?bool
      */
     public function onException(ProxyStrategyRequest $proxyStrategyRequest);
 }

src/OpenClassrooms/UseCase/Application/Services/Proxy/UseCases/UseCaseProxyBuilder.php

@@ -3,7 +3,6 @@
 namespace OpenClassrooms\UseCase\Application\Services\Proxy\UseCases;
 
 use Doctrine\Common\Annotations\Reader;
-use OpenClassrooms\Cache\Cache\Cache;
 use OpenClassrooms\UseCase\Application\Services\Event\EventFactory;
 use OpenClassrooms\UseCase\Application\Services\Event\EventSender;
 use OpenClassrooms\UseCase\Application\Services\Proxy\Strategies\Impl\Cache\CacheProxyStrategy;
@@ -28,6 +27,7 @@
 use OpenClassrooms\UseCase\Application\Services\Security\Security;
 use OpenClassrooms\UseCase\Application\Services\Transaction\Transaction;
 use OpenClassrooms\UseCase\BusinessRules\Requestors\UseCase;
+use Psr\Cache\CacheItemPoolInterface;
 use Psr\Log\LoggerInterface;
 
 /**
@@ -42,7 +42,7 @@ abstract class UseCaseProxyBuilder
     protected $useCaseProxy;
 
     /**
-     * @var Cache
+     * @var CacheItemPoolInterface
      */
     private $cache;
 
@@ -85,7 +85,7 @@ abstract public function create(UseCase $useCase);
     /**
      * @return UseCaseProxyBuilder
      */
-    public function withCache(Cache $cache = null)
+    public function withCache(CacheItemPoolInterface $cache = null)
     {
         $this->cache = $cache;