Merge pull request #16 from niden-code/1.x

Video #8

Author: niden

.github/workflows/main.yml

@@ -93,6 +93,11 @@ jobs:
           MYSQL_DATABASE: phalcon
           MYSQL_PASSWORD: secret
 
+      redis:
+        image: redis:8-alpine
+        ports:
+          - "6379:6379"
+
     steps:
       - uses: actions/checkout@v4
 

config/.env.ci

@@ -1,5 +1,10 @@
+# Docker prefix
 PROJECT_NAME="rest"
 
+# Environment
+APP_ENV_ADAPTER="dotenv"
+APP_ENV_FILE_PATH="./"
+
 # Mariadb
 DB_HOST="127.0.0.1"
 DB_PORT=3306
@@ -8,9 +13,21 @@ DB_PASS="secret"
 DB_NAME="phalcon"
 DB_CHARSET="utf8"
 
-# Redis
-DATA_REDIS_HOST="app-cache"
-DATA_REDIS_PORT=6379
-DATA_REDIS_NAME="0"
+# Cache
+CACHE_ADAPTER="redis"
+CACHE_HOST="127.0.0.1"
+CACHE_PORT=6379
+CACHE_INDEX="0"
+CACHE_LIFETIME=86400
+CACHE_PREFIX="-rest-"
+
+# Logger
+LOG_FILENAME="rest-api"
+LOG_PATH="storage/logs"
 
+# Code Coverage
 XDEBUG_MODE=coverage
+
+# JWT
+TOKEN_EXPIRATION=14400
+TOKEN_AUDIENCE="https://rest-api.phalcon.io"

config/.env.example

@@ -1,16 +1,33 @@
+# Docker prefix
 PROJECT_NAME="rest"
 
+# Environment
+APP_ENV_ADAPTER="dotenv"
+APP_ENV_FILE_PATH="./"
+
 # Mariadb
-DB_HOST="app-db"
+DB_HOST="rest-db"
 DB_PORT=3306
 DB_USER="root"
 DB_PASS="secret"
 DB_NAME="phalcon"
-DB_CHARSET= "utf8"
+DB_CHARSET="utf8"
+
+# Cache
+CACHE_ADAPTER="redis"
+CACHE_HOST="rest-cache"
+CACHE_PORT=6379
+CACHE_INDEX="0"
+CACHE_LIFETIME=86400
+CACHE_PREFIX="-rest-"
 
-# Redis
-DATA_REDIS_HOST="app-cache"
-DATA_REDIS_PORT=6379
-DATA_REDIS_NAME="0"
+# Logger
+LOG_FILENAME="rest-api"
+LOG_PATH="storage/logs"
 
+# Code Coverage
 XDEBUG_MODE=coverage
+
+# JWT
+TOKEN_EXPIRATION=14400
+TOKEN_AUDIENCE="https://rest-api.phalcon.io"

phpunit.xml.dist

@@ -4,7 +4,6 @@
          bootstrap="./phpunit.php"
          cacheDirectory="tests/_output/.phpunit.result.cache"
          colors="true"
-         processIsolation="true"
 >
     <testsuites>
         <testsuite name="unit tests">

src/Action/ActionHandler.php

@@ -15,10 +15,15 @@
 
 use Phalcon\Api\Domain\ADR\DomainInterface;
 use Phalcon\Api\Domain\ADR\Input;
+use Phalcon\Api\Domain\ADR\InputTypes;
 use Phalcon\Api\Responder\ResponderInterface;
 use Phalcon\Http\RequestInterface;
 use Phalcon\Http\ResponseInterface;
 
+/**
+ * @phpstan-import-type TLoginInput from InputTypes
+ * @phpstan-import-type TUserInput from InputTypes
+ */
 final readonly class ActionHandler implements ActionInterface
 {
     public function __construct(
@@ -32,6 +37,7 @@ public function __construct(
     public function __invoke(): void
     {
         $input = new Input();
+        /** @var TLoginInput|TUserInput $data */
         $data  = $input->__invoke($this->request);
 
         $this->responder->__invoke(

src/Domain/ADR/DomainInterface.php

@@ -16,13 +16,13 @@
 use Phalcon\Domain\Payload;
 
 /**
- * @phpstan-import-type THelloInput from InputTypes
+ * @phpstan-import-type TLoginInput from InputTypes
  * @phpstan-import-type TUserInput from InputTypes
  */
 interface DomainInterface
 {
     /**
-     * @param THelloInput|TUserInput $input
+     * @param TLoginInput|TUserInput $input
      *
      * @return Payload
      */

src/Domain/ADR/Input.php

@@ -15,6 +15,8 @@
 
 use Phalcon\Http\RequestInterface;
 
+use function array_merge;
+
 /**
  * @phpstan-import-type TRequestQuery from InputTypes
  */
@@ -29,7 +31,9 @@ public function __invoke(RequestInterface $request): array
     {
         /** @var TRequestQuery $query */
         $query = $request->getQuery();
+        /** @var TRequestQuery $post */
+        $post = $request->getPost();
 
-        return $query;
+        return array_merge($query, $post);
     }
 }

src/Domain/ADR/InputTypes.php

@@ -14,7 +14,10 @@
 namespace Phalcon\Api\Domain\ADR;
 
 /**
- * @phpstan-type THelloInput array{}
+ * @phpstan-type TLoginInput array{
+ *     email?: string,
+ *     password?: string
+ * }
  * @phpstan-type TUserInput array{
  *     userId?: int
  * }

src/Domain/Components/Cache/Cache.php

@@ -0,0 +1,92 @@
+<?php
+
+/**
+ * This file is part of the Phalcon API.
+ *
+ * (c) Phalcon Team <[email protected]>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Phalcon\Api\Domain\Components\Cache;
+
+use DateTimeImmutable;
+use Phalcon\Api\Domain\Components\Constants\Dates;
+use Phalcon\Api\Domain\Components\DataSource\User\UserTransport;
+use Phalcon\Api\Domain\Components\Env\EnvManager;
+use Phalcon\Cache\Cache as PhalconCache;
+use Psr\SimpleCache\InvalidArgumentException;
+
+use function sha1;
+
+class Cache extends PhalconCache
+{
+    /** @var int */
+    public const CACHE_LIFETIME_DAY = 86400;
+    /** @var int */
+    public const CACHE_LIFETIME_HOUR = 3600;
+    /**
+     * Cache Timeouts
+     */
+    /** @var int */
+    public const CACHE_LIFETIME_MINUTE = 60;
+    /** @var int */
+    public const CACHE_LIFETIME_MONTH = 2592000;
+    /**
+     * Default token expiry - 4 hours
+     */
+    /** @var int */
+    public const CACHE_TOKEN_EXPIRY = 14400;
+    /**
+     * Cache masks
+     */
+    /** @var string */
+    private const MASK_TOKEN_USER = 'tk-%s-%s';
+
+    /**
+     * @param UserTransport $domainUser
+     * @param string        $token
+     *
+     * @return string
+     */
+    public function getCacheTokenKey(UserTransport $domainUser, string $token): string
+    {
+        return sprintf(
+            self::MASK_TOKEN_USER,
+            $domainUser->getId(),
+            sha1($token)
+        );
+    }
+
+    /**
+     * @param EnvManager    $env
+     * @param UserTransport $domainUser
+     * @param string        $token
+     *
+     * @return bool
+     * @throws InvalidArgumentException
+     */
+    public function storeTokenInCache(
+        EnvManager $env,
+        UserTransport $domainUser,
+        string $token
+    ): bool {
+        $cacheKey = $this->getCacheTokenKey($domainUser, $token);
+        /** @var int $expiration */
+        $expiration     = $env->get('TOKEN_EXPIRATION', self::CACHE_TOKEN_EXPIRY, 'int');
+        $expirationDate = (new DateTimeImmutable())
+            ->modify('+' . $expiration . ' seconds')
+            ->format(Dates::DATE_TIME_FORMAT)
+        ;
+
+        $payload = [
+            'token'  => $token,
+            'expiry' => $expirationDate,
+        ];
+
+        return $this->set($cacheKey, $payload, $expiration);
+    }
+}