Drop support for Symfony 3.4 and 5.3, add support for Symfony 6, drop MongoDB ODM 1.x #284

mbabker · 2021-11-06T16:52:08Z

Symfony 3.4 and MongoDB ODM 1.x are EOL, there isn't much of a point in keeping support for them now (one can use older versions if they still need it).

Symfony 5.3 goes EOL this month (January 2022), let's drop it now and simplify a bit of the new authenticator API code.

Symfony 6 is here, this adds the support needed for it.

mbabker · 2021-11-06T16:53:12Z

Doctrine/RefreshTokenManager.php

-        if (!$this->repository instanceof RefreshTokenRepositoryInterface) {
+        $repository = $om->getRepository($class);
+
+        if (!$repository instanceof RefreshTokenRepositoryInterface) {


I made this tweak after doing a PHPStan analysis, this avoids setting the class property if the type is incorrect (if the property would typed, this would result in a type error instead of the exception below)

mbabker · 2021-11-06T16:53:53Z

Event/RefreshAuthenticationFailureEvent.php


 class RefreshAuthenticationFailureEvent extends Event
 {
    private AuthenticationException $exception;

-    private ?Response $response;
+    private Response $response;


SF6 typehints the response as non-nullable in authentication success and failure handlers, so the events shouldn't allow nulllability either

mbabker · 2021-11-06T16:54:45Z

Http/RefreshAuthenticationFailureResponse.php

@@ -14,7 +14,41 @@
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Response;

-class RefreshAuthenticationFailureResponse extends JsonResponse
+if (80000 <= \PHP_VERSION_ID && (new \ReflectionMethod(JsonResponse::class, 'setData'))->hasReturnType()) {


B/C layer because in SF6 there are PHP 8 types used on the class, so the eval hack is needed for PHP 7.4 compat.

mbabker · 2021-11-06T16:55:12Z

Model/AbstractRefreshToken.php

@@ -56,7 +56,7 @@ public static function createForUserWithTtl(string $refreshToken, UserInterface
     */
    public function __toString()
    {
-        return $this->getRefreshToken();
+        return $this->getRefreshToken() ?: '';


getRefreshToken() has a nullable return, __toString() should always be a string.

mbabker · 2021-11-06T16:56:29Z

README.md

@@ -25,6 +25,8 @@ If you want to use this bundle with previous Symfony versions, please use 0.2.x

 **It's important you manually require either Doctrine's ORM or MongoDB ODM as well, these packages are not required automatically as you can choose between them. Failing to do so may trigger errors on installation**

+If using Symfony 5.2 or older, you will also need to install the `symfony/security-guard` package, it is only required for the legacy authentication API and is not compatible with Symfony 6.0.


The Guard component is deprecated and dropped in Symfony 6. I made it an optional dependency, folks on Symfony 4.4 will need to manually install that component to keep using this package. Folks on Symfony 5.3 and later won't need to have it installed since the newer API doesn't use it.

mbabker · 2021-11-06T16:57:15Z

Security/Provider/RefreshTokenProvider.php

@@ -129,6 +129,6 @@ public function supportsClass($class)
            return true;
        }

-        return User::class === $class;
+        return class_exists(User::class) && User::class === $class;


SF6 drops the User class, so technically the provider shouldn't support the class if it's not available.

mbabker · 2021-11-06T16:58:19Z

composer.json

  },
  "require-dev": {
-    "akeneo/phpspec-skip-example-extension": "^4.0|^5.0",
+    "babdev/phpspec-skip-example-extension": "^1.0",


The source package for this looks to be not well maintained and doesn't actually support skipping examples with requirements declared at the example level. So, this changes to my fork that adds the feature.

Thankfully now not needed :)

mbabker · 2021-11-13T18:12:46Z

DependencyInjection/GesdinetJWTRefreshTokenExtension.php

@@ -51,7 +52,8 @@ public function load(array $configs, ContainerBuilder $container): void
        $refreshTokenClass = RefreshTokenEntity::class;
        $objectManager = 'doctrine.orm.entity_manager';

-        if (!class_exists(DoctrineOrmMappingsPass::class) || 'mongodb' === strtolower($config['manager_type'])) {
+        // Change the refresh token and object manager to the MongoDB ODM if the configuration explicitly sets it or if the ORM is not installed and the MongoDB ODM is
+        if ('mongodb' === strtolower($config['manager_type']) || (!class_exists(EntityManager::class) && class_exists(DocumentManager::class))) {


Changing this to use the object managers instead of the compiler passes in the bundles allows to break the dev dependencies on the bundles (which, were only pulled in for these checks).

bravik · 2021-12-01T09:31:58Z

Service/RefreshToken.php

-                $this->authenticator->getCredentials($request),
-                $this->provider
-            );
+            $user = $this->authenticator->getUser($credentials, $this->provider);

            $postAuthenticationToken = $this->authenticator->createAuthenticatedToken($user, $this->providerKey);


this should probably be removed or deprecated too, as PostAuthenticationGuardToken is deprecated.
For ->onAuthenticationSuccess() any TokenInterface (maybe just JWTUserToken) will work, as it only uses getUser().
And for RefreshToken event getting pre authenticated toeken should probably be deprecated or reworked.. I'm not sure why is it needed at all

This whole class is already deprecated, the only reason I touched it in this PR is there’s no need for it to have the event dispatcher compat check.

ad3n · 2022-01-06T10:34:06Z

Any update?

mbabker · 2022-01-06T15:20:26Z

Blocked by phpspec not supporting Symfony 6 yet.

markitosgv · 2022-01-10T10:40:41Z

merged @webignition #293

mbabker · 2022-01-11T00:50:03Z

OK, we're good to go here.

…support for MongoDB ODM 1.x

README.md

mbabker commented Nov 6, 2021

View reviewed changes

mbabker force-pushed the symfony-6 branch 2 times, most recently from 58db407 to dc803e0 Compare November 6, 2021 17:02

mbabker force-pushed the symfony-6 branch from dc803e0 to 38053ed Compare November 13, 2021 18:09

mbabker changed the title ~~[WIP] Drop support for Symfony 3.4 and add support for Symfony 6~~ [WIP] Drop support for Symfony 3.4 and add support for Symfony 6, drop MongoDB ODM 1.x Nov 13, 2021

mbabker commented Nov 13, 2021

View reviewed changes

bravik reviewed Dec 1, 2021

View reviewed changes

webignition mentioned this pull request Dec 1, 2021

Use Symfony 6.0 smartassert/users#221

Closed

mbabker force-pushed the symfony-6 branch 3 times, most recently from bb579b3 to 69042a1 Compare December 21, 2021 14:38

mbabker mentioned this pull request Dec 21, 2021

Support for symfony 6 #290

Open

webignition mentioned this pull request Jan 7, 2022

Replace phpspec tests with phpunit tests? #292

Closed

mbabker force-pushed the symfony-6 branch from 30b1b5f to 854a706 Compare January 11, 2022 00:44

mbabker changed the title ~~[WIP] Drop support for Symfony 3.4 and add support for Symfony 6, drop MongoDB ODM 1.x~~ [WIP] Drop support for Symfony 3.4 and 5.3, add support for Symfony 6, drop MongoDB ODM 1.x Jan 11, 2022

mbabker force-pushed the symfony-6 branch 2 times, most recently from 9efab5b to c684d3d Compare January 11, 2022 00:48

mbabker marked this pull request as ready for review January 11, 2022 00:49

mbabker changed the title ~~[WIP] Drop support for Symfony 3.4 and 5.3, add support for Symfony 6, drop MongoDB ODM 1.x~~ Drop support for Symfony 3.4 and 5.3, add support for Symfony 6, drop MongoDB ODM 1.x Jan 11, 2022

mbabker force-pushed the symfony-6 branch from c684d3d to 7a66659 Compare January 11, 2022 00:51

mbabker force-pushed the symfony-6 branch from 7a66659 to 0efe0d8 Compare January 11, 2022 00:59

Drop support for Symfony 3.4 and add support for Symfony 6, and drop …

bac4cfd

…support for MongoDB ODM 1.x

mbabker force-pushed the symfony-6 branch from 0efe0d8 to bac4cfd Compare January 11, 2022 01:02

webignition reviewed Jan 11, 2022

View reviewed changes

README.md Show resolved Hide resolved

Misc. README updates

1d5f86f

markitosgv merged commit a73998f into markitosgv:master Jan 11, 2022

mbabker deleted the symfony-6 branch January 11, 2022 20:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Drop support for Symfony 3.4 and 5.3, add support for Symfony 6, drop MongoDB ODM 1.x #284

Drop support for Symfony 3.4 and 5.3, add support for Symfony 6, drop MongoDB ODM 1.x #284

mbabker commented Nov 6, 2021 •

edited

mbabker Nov 6, 2021

mbabker Nov 6, 2021

mbabker Nov 6, 2021

mbabker Nov 6, 2021

mbabker Nov 6, 2021

mbabker Nov 6, 2021

mbabker Nov 6, 2021

webignition Jan 10, 2022

mbabker Nov 13, 2021

bravik Dec 1, 2021 •

edited

mbabker Dec 1, 2021

ad3n commented Jan 6, 2022

mbabker commented Jan 6, 2022

markitosgv commented Jan 10, 2022

mbabker commented Jan 11, 2022

		@@ -25,6 +25,8 @@ If you want to use this bundle with previous Symfony versions, please use 0.2.x

		It's important you manually require either Doctrine's ORM or MongoDB ODM as well, these packages are not required automatically as you can choose between them. Failing to do so may trigger errors on installation

		If using Symfony 5.2 or older, you will also need to install the `symfony/security-guard` package, it is only required for the legacy authentication API and is not compatible with Symfony 6.0.

Drop support for Symfony 3.4 and 5.3, add support for Symfony 6, drop MongoDB ODM 1.x #284

Drop support for Symfony 3.4 and 5.3, add support for Symfony 6, drop MongoDB ODM 1.x #284

Conversation

mbabker commented Nov 6, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bravik Dec 1, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ad3n commented Jan 6, 2022

mbabker commented Jan 6, 2022

markitosgv commented Jan 10, 2022

mbabker commented Jan 11, 2022

mbabker commented Nov 6, 2021 •

edited

bravik Dec 1, 2021 •

edited