Add resetFormatsAfterRequest issue test

Author: Seros

.env

@@ -14,3 +14,9 @@ DATABASE_URL=sqlite:///%kernel.project_dir%/var/test.db3
 ###> symfony/mailer ###
 MAILER_DSN=null://null
 ###< symfony/mailer ###
+
+###> lexik/jwt-authentication-bundle ###
+JWT_SECRET_KEY=%kernel.project_dir%/config/jwt/private.pem
+JWT_PUBLIC_KEY=%kernel.project_dir%/config/jwt/public.pem
+JWT_PASSPHRASE=b406fa29adfd637669a87d0d0e0032139731110641fcf3ac692c3fde392a9566
+###< lexik/jwt-authentication-bundle ###

.github/workflows/symfony.yml

@@ -55,5 +55,8 @@ jobs:
       - name: Load Doctrine fixtures
         run: php bin/console doctrine:fixtures:load --quiet
 
+      - name: Generate JWT keypair
+        run: php bin/console lexik:jwt:generate-keypair
+
       - name: Run functional tests
         run: vendor/bin/codecept run Functional

.gitignore

@@ -34,3 +34,7 @@ yarn-error.log
 /phpunit.xml
 .phpunit.result.cache
 ###< phpunit/phpunit ###
+
+###> lexik/jwt-authentication-bundle ###
+/config/jwt/*.pem
+###< lexik/jwt-authentication-bundle ###

README.md

@@ -24,11 +24,13 @@ Lastly, if you just want to see the module in action and run the tests yourself
    ```shell
    composer update
    ```
-3. Update database schema and load Doctrine fixtures
+3. Update database schema, load Doctrine fixtures and generate JWT keypair
    ```shell
    php bin/console doctrine:schema:update --force
 
    php bin/console doctrine:fixtures:load --quiet
+   
+   php bin/console lexik:jwt:generate-keypair
    ```
 
 Then, go to the project directory and run:

composer.json

@@ -14,7 +14,9 @@
         "php": ">=8.2.0",
         "ext-ctype": "*",
         "ext-iconv": "*",
+        "api-platform/symfony": "^4.0",
         "doctrine/doctrine-bundle": "^2.11",
+        "lexik/jwt-authentication-bundle": "^3.1",
         "symfony/apache-pack": "^1.0",
         "symfony/console": "6.4.*",
         "symfony/dotenv": "6.4.*",
@@ -34,6 +36,7 @@
         "codeception/module-asserts": "^3.2",
         "codeception/module-doctrine": "^3.1",
         "codeception/module-phpbrowser": "^3.0",
+        "codeception/module-rest": "^3.4",
         "codeception/module-symfony": "^3.2 | *@dev",
         "doctrine/doctrine-fixtures-bundle": "^3.5",
         "friendsofphp/php-cs-fixer": "^3.46",
@@ -102,7 +105,8 @@
         ],
         "post-create-project-cmd": [
             "@php bin/console doctrine:schema:update --force",
-            "@php bin/console doctrine:fixtures:load --quiet"
+            "@php bin/console doctrine:fixtures:load --quiet",
+            "@php bin/console lexik:jwt:generate-keypair"
         ]
     },
     "conflict": {

config/bundles.php

@@ -9,4 +9,6 @@
     Symfony\Bundle\SecurityBundle\SecurityBundle::class => ['all' => true],
     Symfony\Bundle\TwigBundle\TwigBundle::class => ['all' => true],
     Symfony\Bundle\WebProfilerBundle\WebProfilerBundle::class => ['dev' => true, 'test' => true],
+    ApiPlatform\Symfony\Bundle\ApiPlatformBundle::class => ['all' => true],
+    Lexik\Bundle\JWTAuthenticationBundle\LexikJWTAuthenticationBundle::class => ['all' => true],
 ];

config/packages/api_platform.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+use Symfony\Config\ApiPlatformConfig;
+
+return static function (ApiPlatformConfig $apiPlatformConfig): void {
+    $apiPlatformConfig->title('Hello API Platform');
+    $apiPlatformConfig->version('1.0.0');
+    $apiPlatformConfig->formats('jsonld', ['mime_types' => ['application/ld+json']]);
+    $apiPlatformConfig->formats('json', ['mime_types' => ['application/json']]);
+    $defaults = $apiPlatformConfig->defaults();
+    $defaults->stateless(true);
+    $defaults->cacheHeaders(['vary' => ['Content-Type', 'Authorization', 'Origin']]);
+    $apiPlatformConfig->doctrine(['enabled' => false]);
+};

config/packages/lexik_jwt_authentication.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+use Symfony\Config\LexikJwtAuthenticationConfig;
+
+return static function (LexikJwtAuthenticationConfig $lexikJwtAuthenticationConfig): void {
+    $lexikJwtAuthenticationConfig->secretKey('%env(resolve:JWT_SECRET_KEY)%')
+        ->publicKey('%env(resolve:JWT_PUBLIC_KEY)%')
+        ->passPhrase('%env(JWT_PASSPHRASE)%');
+};

config/packages/security.php

@@ -19,6 +19,18 @@
         ->pattern('^/(_(profiler|wdt)|css|images|js)/')
         ->security(false);
 
+    $apiFirewall = $security->firewall('api');
+    $apiFirewall
+        ->pattern('^/api')
+        ->stateless(true)
+        ->provider('app_user_provider')
+        ->jwt();
+    $apiFirewall->jsonLogin([
+        'check_path' => '/api/login',
+        'success_handler' => 'lexik_jwt_authentication.handler.authentication_success',
+        'failure_handler' => 'lexik_jwt_authentication.handler.authentication_failure',
+    ]);
+
     $mainFirewall = $security->firewall('main');
     $mainFirewall
         ->lazy(true)
@@ -27,7 +39,7 @@
     $mainFirewall->logout(['path' => 'app_logout']);
     $mainFirewall->rememberMe(['secret' => '%env(APP_SECRET)%']);
 
-    $security->accessControl([
-        'path' => '^/dashboard', 'roles' => 'ROLE_USER'
-    ]);
+    $security->accessControl(['path' => '^/api/login', 'roles' => 'PUBLIC_ACCESS']);
+    $security->accessControl(['path' => '^/api', 'roles' => 'IS_AUTHENTICATED_FULLY']);
+    $security->accessControl(['path' => '^/dashboard', 'roles' => 'ROLE_USER']);
 };

config/packages/uid.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+use Symfony\Config\FrameworkConfig;
+
+return static function (FrameworkConfig $framework): void {
+    $uid = $framework->uid();
+    $uid->defaultUuidVersion(7);
+    $uid->timeBasedUuidVersion(7);
+};

config/routes.php

@@ -88,4 +88,7 @@
     $routes->add('send_email', '/send-email')
         ->controller(App\Controller\SendEmailController::class)
         ->methods(['GET']);
+
+    $routes->add('api_login', '/api/login')
+        ->methods(['POST']);
 };

config/routes/api_platform.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;
+
+return static function (RoutingConfigurator $routes): void {
+    $routes->import('.', 'api_platform')
+        ->prefix('/api');
+};

src/ApiResource/Book.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace App\ApiResource;
+
+use ApiPlatform\Metadata\ApiResource;
+use Symfony\Component\Validator\Constraints\NotNull;
+
+#[ApiResource]
+class Book
+{
+    #[NotNull]
+    public string $name;
+}

symfony.lock

@@ -1,4 +1,18 @@
 {
+    "api-platform/symfony": {
+        "version": "4.1",
+        "recipe": {
+            "repo": "github.com/symfony/recipes",
+            "branch": "main",
+            "version": "4.0",
+            "ref": "e9952e9f393c2d048f10a78f272cd35e807d972b"
+        },
+        "files": [
+            "config/packages/api_platform.yaml",
+            "config/routes/api_platform.yaml",
+            "src/ApiResource/.gitignore"
+        ]
+    },
     "codeception/codeception": {
         "version": "5.0",
         "recipe": {
@@ -46,6 +60,18 @@
             "./.php-cs-fixer.dist.php"
         ]
     },
+    "lexik/jwt-authentication-bundle": {
+        "version": "3.1",
+        "recipe": {
+            "repo": "github.com/symfony/recipes",
+            "branch": "main",
+            "version": "2.5",
+            "ref": "e9481b233a11ef7e15fe055a2b21fd3ac1aa2bb7"
+        },
+        "files": [
+            "config/packages/lexik_jwt_authentication.yaml"
+        ]
+    },
     "phpstan/phpstan": {
         "version": "1.10",
         "recipe": {
@@ -215,6 +241,18 @@
             "./templates/base.html.twig"
         ]
     },
+    "symfony/uid": {
+        "version": "6.4",
+        "recipe": {
+            "repo": "github.com/symfony/recipes",
+            "branch": "main",
+            "version": "6.2",
+            "ref": "d294ad4add3e15d7eb1bae0221588ca89b38e558"
+        },
+        "files": [
+            "config/packages/uid.yaml"
+        ]
+    },
     "symfony/validator": {
         "version": "7.0",
         "recipe": {

tests/Functional.suite.yml

@@ -9,3 +9,5 @@ modules:
         - Doctrine:
               depends: Symfony
               cleanup: true
+        - REST:
+              depends: Symfony

tests/Functional/IssuesCest.php

@@ -6,6 +6,7 @@
 
 use App\Entity\User;
 use App\Tests\Support\FunctionalTester;
+use Codeception\Util\HttpCode;
 use Doctrine\DBAL\Connection;
 
 final class IssuesCest
@@ -19,7 +20,7 @@ public function keepDoctrineDbalConnection(FunctionalTester $I)
             User::class,
             [
                 'email' => 'fixture@fixture.test',
-                'password' => uniqid(),
+                'password' => uniqid(more_entropy: true),
             ]
         );
         $ormConnection = $I->grabService('doctrine.orm.default_entity_manager')->getConnection();
@@ -53,4 +54,22 @@ public function runSymfonyConsoleCommandIgnoresSpecificOptions(FunctionalTester
         $numRecords = $I->grabNumRecords(User::class);
         $I->assertSame(1, $numRecords);
     }
+
+    /**
+     * @see https://github.com/Codeception/module-symfony/pull/209
+     */
+    public function resetFormatsAfterRequest(FunctionalTester $I)
+    {
+        $I->amApiAuthenticated();
+        $I->haveHttpHeader('Content-Type', 'application/json');
+        $I->haveHttpHeader('Accept', 'application/json');
+        $I->sendPost('/api/books');
+        $I->seeResponseCodeIs(HttpCode::UNPROCESSABLE_ENTITY);
+        $I->seeHttpHeader('Content-Type', 'application/problem+json; charset=utf-8');
+
+        $I->amApiAuthenticated(); // This would fail because of overwrite of format mimetypes
+        $I->sendPost('/api/books', ['name' => 'test']);
+        $I->seeResponseCodeIs(HttpCode::CREATED);
+        $I->seeHttpHeader('Content-Type', 'application/json; charset=utf-8');
+    }
 }

tests/Support/FunctionalTester.php

@@ -9,4 +9,16 @@
 class FunctionalTester extends Actor
 {
     use _generated\FunctionalTesterActions;
+
+    public function amApiAuthenticated(): void
+    {
+        $this->haveHttpHeader('content-type', 'application/json');
+        $this->sendPost('/api/login', [
+            'username' => 'john_doe@gmail.com',
+            'password' => '123456',
+        ]);
+        $token = $this->grabDataFromResponseByJsonPath('$.token')[0];
+
+        $this->amBearerAuthenticated($token);
+    }
 }