Upgrade Service Manager to v4 in `require`, Cache to v4 and Validator to v3 in `require-dev` #103

Jurj-Bogdan · 2025-01-24T10:41:46Z

Upgraded laminas/laminas-servicemanager to version 4, as well as the other dependencies required for it, and added various Psalm tweaks.

I seems I was working on this PR alongside #102 , with the main difference seemingly being the removal of v2 functions from the codebase in preparation for a new major release.

I was about to make a different PR to the current branch marking the functions removed here as deprecated, but I'll wait for feedback regarding the desired way forward.

…ed deprecated usage functions Signed-off-by: Jurj-Bogdan <[email protected]>

Signed-off-by: Jurj-Bogdan <[email protected]>

arhimede · 2025-01-24T15:23:15Z

@Jurj-Bogdan See #102
Please open a separate PR, which do not break BC , and against 2.23 branch, for the milestone 2.23.1

arhimede · 2025-02-04T11:45:25Z

@laminas/technical-steering-committee
We have this PR and the other PR, #102
which are doing the same thing.
Only that this PR is removing the deprecated function .

So, should I create the branch 3.0.x and merge this one there ?

gsteel · 2025-02-04T11:59:44Z

So, should I create the branch 3.0.x and merge this one there

Yes, create 3.0.x from the tip of the next minor release - You should probably get 2.24.x patches resolved first such as #106 so that merge-ups from 2.x have fewer conflicts

arhimede · 2025-02-05T11:00:34Z

@Jurj-Bogdan Please fix the conflicts

Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

…ed deprecated usage functions Signed-off-by: Jurj-Bogdan <[email protected]>

Signed-off-by: Jurj-Bogdan <[email protected]>

src/SaveHandler/Cache.php

gsteel · 2025-02-07T12:15:51Z

src/Service/ContainerAbstractServiceFactory.php

@@ -41,28 +40,20 @@ class ContainerAbstractServiceFactory implements AbstractFactoryInterface
 {


This class should be made final and all properties private. You should also mark this class soft final with @final in a 2.x release

Done - also a related question here. I just noticed there are already some classes marked as deprecated, maybe this should be a good time to remove them as well?

Talking about AbstractValidatorChain and AbstractValidatorChainEM3

Yes - anything that's deprecated should be dealt with in the next major. I don't know this lib well enough to know what the implications or plans might have been though.

Don't forget to document any BC breaks here with companion patches against 2.x including deprecations, and, make a start on a migration guide that lists all the BC breaking changes

src/Service/ContainerAbstractServiceFactory.php

src/Validator/Csrf.php

gsteel · 2025-02-07T12:28:27Z

src/Validator/Csrf.php

- *     session?: Container,
- *     timeout?: ?int,
- * }
- */
 final class Csrf extends AbstractValidator


This whole class will probably need further refactoring such as deprecating and dropping all the public setters and getters

Not suggesting that work should happen in this patch tho!

gsteel · 2025-02-07T12:35:50Z

test/Service/SessionManagerFactoryTest.php

@@ -114,7 +114,8 @@ public function testFactoryWillAddValidatorViaConfiguration(): void

        $manager->start();

-        $chain     = $manager->getValidatorChain();
+        $chain = $manager->getValidatorChain();
+        /** @psalm-suppress ArgumentTypeCoercion **/


Please remove this suppression and replace it with assertions.

Assert the manager is ManagerInterface
Assert the chain is a EventManagerInterface or whatever it's supposed to be

Added some phpunit assertions as they're useful, but Psalm is still adamant in throwing "ArgumentTypeCoercion" errors which is why the suppressions are still there.

You need to assert $chain is an instance of EventManager (The concrete class) because that's what getListenersForEvent expects.

Please also add findUnusedPsalmSuppress="true" to psalm.xml so that unused inline suppressions are flagged.

gsteel · 2025-02-07T12:36:05Z

test/Service/SessionManagerFactoryTest.php

@@ -198,7 +199,8 @@ public function testFactoryDoesNotAttachValidatorTwoTimes(): void
            // Ignore exception, because we are not interested whether session validation passes in this test
        }

-        $chain     = $manager->getValidatorChain();
+        $chain = $manager->getValidatorChain();
+        /** @psalm-suppress ArgumentTypeCoercion **/


Same here… More assertions!

This suppression still needs fixing too!

psalm-baseline.xml

Signed-off-by: Jurj-Bogdan <[email protected]>

gsteel

Thanks @Jurj-Bogdan - A few more tweaks please :)

Apart from inline comments, all of the changed factories need to be made final and they should all have a good cleanup - i.e protected props to private, drop any methods that are pointless etc. Happy to wait for another patch for those things, but we really don't want users extending factories and need to prevent that in the next major

gsteel · 2025-02-18T16:36:38Z

src/Service/ContainerAbstractServiceFactory.php

     */
-    protected function getConfig(ContainerInterface $container)
+    protected function getConfig(ContainerInterface $container): array


This should be private

gsteel · 2025-02-18T16:36:44Z

src/Service/ContainerAbstractServiceFactory.php

     */
-    protected function getSessionManager(ContainerInterface $container)
+    protected function getSessionManager(ContainerInterface $container): ?ManagerInterface


This should be private

gsteel · 2025-02-18T16:37:18Z

src/Service/ContainerAbstractServiceFactory.php

     */
-    protected function normalizeContainerName($name)
+    protected function normalizeContainerName(string $name): string


This should be private or maybe inlined if it's only used once

gsteel · 2025-02-18T16:44:45Z

test/Service/SessionManagerFactoryTest.php

@@ -114,7 +114,8 @@ public function testFactoryWillAddValidatorViaConfiguration(): void

        $manager->start();

-        $chain     = $manager->getValidatorChain();
+        $chain = $manager->getValidatorChain();
+        /** @psalm-suppress ArgumentTypeCoercion **/


You need to assert $chain is an instance of EventManager (The concrete class) because that's what getListenersForEvent expects.

Please also add findUnusedPsalmSuppress="true" to psalm.xml so that unused inline suppressions are flagged.

gsteel · 2025-02-18T16:53:37Z

test/Service/SessionManagerFactoryTest.php

@@ -198,7 +199,8 @@ public function testFactoryDoesNotAttachValidatorTwoTimes(): void
            // Ignore exception, because we are not interested whether session validation passes in this test
        }

-        $chain     = $manager->getValidatorChain();
+        $chain = $manager->getValidatorChain();
+        /** @psalm-suppress ArgumentTypeCoercion **/


This suppression still needs fixing too!

Jurj-Bogdan and others added 4 commits January 24, 2025 12:25

bumped laminas-servicemanager to v4 alongside its dependencies, remov…

e812c7a

…ed deprecated usage functions Signed-off-by: Jurj-Bogdan <[email protected]>

Merge branch '2.24.x' into laminas-servicemanager-4

9a776c2

Signed-off-by: Jurj-Bogdan <[email protected]>

added missing import

1f50bc1

Signed-off-by: Jurj-Bogdan <[email protected]>

psalm baseline update

dae4f7a

Signed-off-by: Jurj-Bogdan <[email protected]>

Jurj-Bogdan mentioned this pull request Jan 24, 2025

marked methods to be removed in version 3 as deprecated, updated composer lock #104

Merged

arhimede linked an issue Jan 28, 2025 that may be closed by this pull request

Version 3 + Implement service manager 4 #101

Open

arhimede added this to the 3.0.0 milestone Feb 5, 2025

arhimede changed the base branch from 2.24.x to 3.0.x February 5, 2025 10:58

renovate bot and others added 4 commits February 6, 2025 11:48

Lock file maintenance

37e7a4f

Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

bumped laminas-servicemanager to v4 alongside its dependencies, remov…

e9e2f27

…ed deprecated usage functions Signed-off-by: Jurj-Bogdan <[email protected]>

branch rebase, conflicts resolved

da6159e

Signed-off-by: Jurj-Bogdan <[email protected]>

Merge branch '3.0.x' into laminas-servicemanager-4

564139e

Signed-off-by: Jurj-Bogdan <[email protected]>

arhimede requested a review from gsteel February 6, 2025 21:08

gsteel requested changes Feb 7, 2025

View reviewed changes

gsteel added Enhancement Dependencies Updates and changes to dependencies labels Feb 7, 2025

requested changes

3411dbd

Signed-off-by: Jurj-Bogdan <[email protected]>

arhimede requested a review from gsteel February 17, 2025 10:18

gsteel requested changes Feb 18, 2025

View reviewed changes

gsteel added the BC Break label Feb 18, 2025

gsteel changed the title ~~bumped laminas-servicemanager to v4 alongside its dependencies, remov…~~ Upgrade Service Manager to v4 in require, Cache to v4 and Validator to v3 in require-dev Feb 18, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Upgrade Service Manager to v4 in `require`, Cache to v4 and Validator to v3 in `require-dev` #103

Upgrade Service Manager to v4 in `require`, Cache to v4 and Validator to v3 in `require-dev` #103

Jurj-Bogdan commented Jan 24, 2025

arhimede commented Jan 24, 2025

arhimede commented Feb 4, 2025

gsteel commented Feb 4, 2025

arhimede commented Feb 5, 2025

gsteel Feb 7, 2025

Jurj-Bogdan Feb 13, 2025

gsteel Feb 18, 2025

gsteel Feb 7, 2025

gsteel Feb 7, 2025

gsteel Feb 7, 2025

Jurj-Bogdan Feb 13, 2025

gsteel Feb 18, 2025

gsteel Feb 7, 2025

gsteel Feb 18, 2025

gsteel left a comment

gsteel Feb 18, 2025

gsteel Feb 18, 2025

gsteel Feb 18, 2025

gsteel Feb 18, 2025

gsteel Feb 18, 2025

		@@ -41,28 +40,20 @@ class ContainerAbstractServiceFactory implements AbstractFactoryInterface
		{

Upgrade Service Manager to v4 in require, Cache to v4 and Validator to v3 in require-dev #103

Are you sure you want to change the base?

Upgrade Service Manager to v4 in require, Cache to v4 and Validator to v3 in require-dev #103

Conversation

Jurj-Bogdan commented Jan 24, 2025

arhimede commented Jan 24, 2025

arhimede commented Feb 4, 2025

gsteel commented Feb 4, 2025

arhimede commented Feb 5, 2025

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

Choose a reason for hiding this comment

gsteel left a 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

Upgrade Service Manager to v4 in `require`, Cache to v4 and Validator to v3 in `require-dev` #103

Upgrade Service Manager to v4 in `require`, Cache to v4 and Validator to v3 in `require-dev` #103