Improve inference for `InputFilterPluginManager::get()` #97

gsteel · 2024-01-09T14:41:09Z

Currently, InputFilterPluginManager::get(FQCN::class) yields the union of InputFilterInterface|InputInterface.

Ideally, this would be the given FQCN when it implements one of those interfaces.

Also, the @method get docblock is problematic as it trumps any user defined stubs and causes other problems that I can't remember!

Because the plugin manager here is guaranteed to return InputFilterInterface|InputInterface as opposed to T|mixed, this conflicts with AbstractPluginManager::get().

Furthermore, I think psalm might have issues with class-string<PsalmAliasOfUnion>.

This patch provides correct inference for consumers when they provide a FQCN or string alias at the expense of 2 or 3 extra baselined issues that I believe are due to using a union type for InstanceType on the class level template.

…tInterface` Signed-off-by: George Steel <[email protected]>

Signed-off-by: George Steel <[email protected]>

Xerkus · 2024-01-09T15:14:33Z

src/Factory.php

@@ -317,6 +318,7 @@ public function createInputFilter($inputFilterSpecification)
        }

        $inputFilter = $this->getInputFilterManager()->get($type);
+        assert($inputFilter instanceof InputFilterInterface); // As opposed to InputInterface


How do we know it is not an InputInterface here? InputFilterManager allows both

Because the createInputFilter method expects a spec (Array of type InputFilterSpecification). Here $type defaults to InputFilter::class and InputFilterSpecification['type'] is class-string<InputFilterInterface>

I think this ought to be full check for input filter with meaningful exception, not just an assert since the method is user facing and there is no soft guard somewhere else.

An exception here would be a BC break though wouldn't it? The assertion will blow up in tests, it verifies the intended type for static analysis, and otherwise is a no-op for users

It wouldn't be. It would just be a fatal error if method not implemented or kinda work with anything as long as object has add() or __call()

This is more of a usability concern really. Exception would allow to say it needs to be input filter and get_debug_type was returned for the requested type $type.

Ocramius · 2024-01-09T15:41:32Z

src/InputFilterPluginManager.php

+
+    /**
+     * @inheritDoc
+     * @template T1 of InputInterface
+     * @template T2 of InputFilterInterface
+     * @param class-string<T1>|class-string<T2>|string $name
+     * @return T1|T2
+     * @psalm-return ($name is class-string<T1> ? T1 : ($name is class-string<T2> ? T2 : T1|T2))
+     */
+    public function get($name, ?array $options = null)
+    {
+        return parent::get($name, $options);
+    }


Isn't the entire signature the same as @param class-string<T> @return T?

Overall OK with this, just seems redundant with the parent DIC declarations

I am testing this locally. It seems it could be simplified.

I tried following:

/** * @inheritDoc * @template T of InputInterface|InputFilterInterface * @param class-string<T>|string $name * @psalm-return ($name is class-string<T> ? T : T) */ public function get($name, ?array $options = null)

Result is close:

ERROR: Trace - test/StaticAnalysis/InputFilterPluginManagerType.php:27:9 - $input: Laminas\InputFilter\Input (see https://psalm.dev/224) /** @psalm-trace $input */ $input = $this->manager->get(Input::class); ERROR: Trace - test/StaticAnalysis/InputFilterPluginManagerType.php:29:9 - $input: Laminas\InputFilter\InputInterface (see https://psalm.dev/224) /** @psalm-trace $input */ $input = $this->manager->get('string'); ERROR: Trace - test/StaticAnalysis/InputFilterPluginManagerType.php:31:9 - $input: Laminas\InputFilter\InputInterface (see https://psalm.dev/224) /** @psalm-trace $input */ $input = $this->manager->get('stdClass'); ERROR: Trace - test/StaticAnalysis/InputFilterPluginManagerType.php:33:9 - $input: LaminasTest\InputFilter\StaticAnalysis\InputFilterWithTemplatedValues (see https://psalm.dev/224) /** @psalm-trace $input */ $input = $this->manager->get(InputFilterWithTemplatedValues::class);

For string parameters values are wrong.

However if I replace conditional fallback with explicit types it works out:

/** * @inheritDoc * @template T of InputInterface|InputFilterInterface * @param class-string<T>|string $name * @psalm-return ($name is class-string<T> ? T : InputInterface|InputFilterInterface) */ public function get($name, ?array $options = null)

ERROR: Trace - test/StaticAnalysis/InputFilterPluginManagerType.php:27:9 - $input: Laminas\InputFilter\Input (see https://psalm.dev/224) /** @psalm-trace $input */ $input = $this->manager->get(Input::class); ERROR: Trace - test/StaticAnalysis/InputFilterPluginManagerType.php:29:9 - $input: Laminas\InputFilter\InputFilterInterface|Laminas\InputFilter\InputInterface (see https://psalm.dev/224) /** @psalm-trace $input */ $input = $this->manager->get('string'); ERROR: Trace - test/StaticAnalysis/InputFilterPluginManagerType.php:31:9 - $input: Laminas\InputFilter\InputFilterInterface|Laminas\InputFilter\InputInterface (see https://psalm.dev/224) /** @psalm-trace $input */ $input = $this->manager->get('stdClass'); ERROR: Trace - test/StaticAnalysis/InputFilterPluginManagerType.php:33:9 - $input: LaminasTest\InputFilter\StaticAnalysis\InputFilterWithTemplatedValues (see https://psalm.dev/224) /** @psalm-trace $input */ $input = $this->manager->get(InputFilterWithTemplatedValues::class);

Actually nevermind. This is wrong with both your version and my smiplification

ERROR: Trace - test/StaticAnalysis/InputFilterPluginManagerType.php:32:9 - $input: PHPUnit\Framework\TestCase (see https://psalm.dev/224) /** @psalm-trace $input */ $input = $this->manager->get(TestCase::class);

I don't think conditional actually uses template there. It creates transient template instead used only for conditional.

I was having problems with class-string<InstanceType> where InstanceType is the union, and similarly with class-string<InputInterface|InputFilterInterface> so that's why I went for class-string<InputInterface>|class-string<InputFilterInterface> - the simplified version is much better. I'll update the patch. Perhaps the cache was messing it up for me…

Ok, so here is the results:
This is not a valid expression @template T of InputInterface|InputFilterInterface. If I drop string from parameter I get:

ERROR: InvalidArgument - test/StaticAnalysis/InputFilterPluginManagerType.php:34:38 - Argument 1 of Laminas\InputFilter\InputFilterPluginManager::get expects class-string<Laminas\InputFilter\InputInterface>, but LaminasTest\InputFilter\StaticAnalysis\InputFilterWithTemplatedValues::class provided (see https://psalm.dev/004) $input = $this->manager->get(InputFilterWithTemplatedValues::class);

This indicates that template constraint is InputInterface and union part was ignored.

This is closer but has other issues:

/** * @inheritDoc * @template T * @param class-string<T>|string $name * @return ($name is class-string<InputInterface>|class-string<InputFilterInterface> ? T : InputInterface|InputFilterInterface) */

Psalm then insists on throwing in mixed here

ERROR: MixedAssignment - src/Factory.php:174:13 - Unable to determine the type that $managerInstance is being assigned to (see https://psalm.dev/032) /** @psalm-trace $managerInstance */ $managerInstance = $this->getInputFilterManager()->get($class); The type of $managerInstance is sourced from here - src/InputFilterPluginManager.php:194:16 * @return ($name is class-string<InputInterface>|class-string<InputFilterInterface> ? T : InputInterface|InputFilterInterface) ERROR: Trace - src/Factory.php:174:13 - $managerInstance: Laminas\InputFilter\InputFilterInterface|Laminas\InputFilter\InputInterface|mixed (see https://psalm.dev/224) /** @psalm-trace $managerInstance */ $managerInstance = $this->getInputFilterManager()->get($class); ERROR: MixedInferredReturnType - test/StaticAnalysis/InputFilterPluginManagerType.php:21:8 - Could not verify return type 'Laminas\InputFilter\InputFilterInterface|Laminas\InputFilter\InputInterface' for LaminasTest\InputFilter\StaticAnalysis\InputFilterPluginManagerType::getWillReturnAnInputOrInputFilterGivenAString (see https://psalm.dev/047) ): InputInterface|InputFilterInterface { ERROR: MixedReturnStatement - test/StaticAnalysis/InputFilterPluginManagerType.php:22:16 - Possibly-mixed return value (see https://psalm.dev/138) return $this->manager->get($anyString); ERROR: MixedReturnStatement - test/StaticAnalysis/InputFilterPluginManagerType.php:22:16 - Could not infer a return type (see https://psalm.dev/138) return $this->manager->get($anyString); ERROR: Trace - test/StaticAnalysis/InputFilterPluginManagerType.php:28:9 - $input: Laminas\InputFilter\Input (see https://psalm.dev/224) /** @psalm-trace $input */ $input = $this->manager->get(Input::class); ERROR: Trace - test/StaticAnalysis/InputFilterPluginManagerType.php:30:9 - $input: Laminas\InputFilter\InputFilterInterface|Laminas\InputFilter\InputInterface (see https://psalm.dev/224) /** @psalm-trace $input */ $input = $this->manager->get('string'); ERROR: Trace - test/StaticAnalysis/InputFilterPluginManagerType.php:32:9 - $input: Laminas\InputFilter\InputFilterInterface|Laminas\InputFilter\InputInterface (see https://psalm.dev/224) /** @psalm-trace $input */ $input = $this->manager->get(TestCase::class); ERROR: Trace - test/StaticAnalysis/InputFilterPluginManagerType.php:34:9 - $input: LaminasTest\InputFilter\StaticAnalysis\InputFilterWithTemplatedValues (see https://psalm.dev/224) /** @psalm-trace $input */ $input = $this->manager->get(InputFilterWithTemplatedValues::class);

This is uncharted waters and I feel we are hitting at least couple edge case bugs here.

So, for current psalm version following works:

/** * @inheritDoc * // Template constraint required or we get mixed added to output. Two templates because union does not work * @template T1 of InputInterface * @template T2 of InputFilterInterface * // string would allow anything and both templates currently receive the passed class ignoring constraint * // use both templates because of the first point. * @param class-string<T1>|class-string<T2>|string $name * // We can combine conditionals and use one of templates or swap templates and it will still work. Keep both as it will likely remain working in the future * @return ($name is class-string<InputInterface> ? T1 : ($name is class-string<InputFilterInterface> ? T2 : InputInterface|InputFilterInterface)) */

@gsteel Psalm tests could be improved with https://psalm.dev/docs/annotating_code/supported_annotations/#psalm-check-type to ensure we get expected types

I am sure it will not cause us any more grief on another lockfile maintenance PR 😆

@Xerkus - just looking at this now and unfortunately, the string case union return type is messed up:

https://psalm.dev/r/84bf036569

https://psalm.dev/r/6e213fb5a6 Looks like a bug with @psalm-check-type not resolving FQCN against use statements and resolving against namespace for right side of union.

Signed-off-by: George Steel <[email protected]>

Xerkus

psalm conditional does not work as expected. Working variant was found. It needs to be applied and checked.

Xerkus · 2024-01-10T11:34:10Z

psalm-baseline.xml

-      <code>Plu</code>
+      <code>get</code>
    </MethodSignatureMustProvideReturnType>


Why psalm complains about plugin manager get? Does it want simple typehinted return and conditional be in psalm-return?

Also what is the MethodSignatureMismatch just above that was previously baselined? Is it due to psr container aliasing shenanigans?

To answer it: some inherited weirdness going on.

ERROR: MethodSignatureMismatch - src/InputFilterPluginManager.php:30:7 - Method Laminas\ServiceManager\ServiceManager::has with return type '' is different to return type 'bool' of inherited method Psr\Container\ContainerInterface::has (see https://psalm.dev/042) ERROR: MethodSignatureMismatch - src/InputFilterPluginManager.php:30:7 - Method Laminas\InputFilter\InputFilterPluginManager::get with return type '' is different to return type 'object' of inherited method Psr\Container\ContainerInterface::get (see https://psalm.dev/042)

I think a lot of this will be solved with SMv4 when we can drop PSR container v1 and tighten up the templates and types in the plugin manager.

…A test The return type union of `InputInterface|InputFilterInterface` is problematic in Psalm, so it has been "simplified" into 2 templates and a nested return conditional to ensure the expected return type in each of the 3 expected input types. Template constraints and Unions do not appear to work when used in a parameterised class-string, so `class-string<T1|T2>` is problematic as is `class-string<FQCNa|FQCNb>`, as is `class-string<T>` where `T` = `FQCNa|FQCNb` Signed-off-by: George Steel <[email protected]>

gsteel added 4 commits January 9, 2024 14:25

Add an assertion to remove the possibility that the value is an `Inpu…

15e9e3d

…tInterface` Signed-off-by: George Steel <[email protected]>

Suppress UnusedClass in SA Tests in config instead of inline

774bb40

Signed-off-by: George Steel <[email protected]>

Override get() so that we can properly type the return value.

be8b829

Signed-off-by: George Steel <[email protected]>

Baseline issues stemming for more precise types in get()

be509ec

Signed-off-by: George Steel <[email protected]>

gsteel added Documentation Enhancement Review Needed labels Jan 9, 2024

gsteel added this to the 2.29.0 milestone Jan 9, 2024

gsteel requested a review from a team January 9, 2024 14:42

Xerkus reviewed Jan 9, 2024

View reviewed changes

Ocramius reviewed Jan 9, 2024

View reviewed changes

Ocramius approved these changes Jan 9, 2024

View reviewed changes

Simplify templates for get()

68627d4

Signed-off-by: George Steel <[email protected]>

Xerkus mentioned this pull request Jan 9, 2024

Improve type inference for FormElementManager::get() laminas/laminas-form#260

Merged

Xerkus requested changes Jan 9, 2024

View reviewed changes

gsteel requested a review from Xerkus January 10, 2024 11:20

Xerkus approved these changes Jan 10, 2024

View reviewed changes

gsteel force-pushed the manager-get-inference branch from e7cc0a1 to 910f999 Compare January 10, 2024 11:31

Xerkus reviewed Jan 10, 2024

View reviewed changes

gsteel force-pushed the manager-get-inference branch from 910f999 to 5e15bfa Compare January 10, 2024 11:42

gsteel force-pushed the manager-get-inference branch from 5e15bfa to 765bebb Compare January 10, 2024 11:43

Xerkus merged commit 82a76f4 into laminas:2.29.x Jan 10, 2024
11 checks passed

Xerkus removed the Review Needed label Jan 10, 2024

gsteel deleted the manager-get-inference branch January 10, 2024 12:04

Xerkus mentioned this pull request Feb 28, 2024

Fix return type to generic in ReflectionBasedAbstractFactory laminas/laminas-servicemanager#222

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve inference for `InputFilterPluginManager::get()` #97

Improve inference for `InputFilterPluginManager::get()` #97

gsteel commented Jan 9, 2024

Xerkus Jan 9, 2024

gsteel Jan 9, 2024

Xerkus Jan 9, 2024 •

edited

Loading

gsteel Jan 9, 2024

Xerkus Jan 9, 2024

Xerkus Jan 9, 2024

Ocramius Jan 9, 2024

Xerkus Jan 9, 2024 •

edited

Loading

Xerkus Jan 9, 2024 •

edited

Loading

Xerkus Jan 9, 2024 •

edited

Loading

gsteel Jan 9, 2024

Xerkus Jan 9, 2024

Xerkus Jan 9, 2024

Xerkus Jan 9, 2024

gsteel Jan 10, 2024

Xerkus Jan 10, 2024

Xerkus left a comment

Xerkus Jan 10, 2024

Xerkus Jan 10, 2024

gsteel Jan 10, 2024

Improve inference for InputFilterPluginManager::get() #97

Improve inference for InputFilterPluginManager::get() #97

Conversation

gsteel commented Jan 9, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Xerkus Jan 9, 2024 • edited Loading

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

Xerkus Jan 9, 2024 • edited Loading

Choose a reason for hiding this comment

Xerkus Jan 9, 2024 • edited Loading

Choose a reason for hiding this comment

Xerkus Jan 9, 2024 • edited Loading

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

Xerkus 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

Improve inference for `InputFilterPluginManager::get()` #97

Improve inference for `InputFilterPluginManager::get()` #97

Xerkus Jan 9, 2024 •

edited

Loading

Xerkus Jan 9, 2024 •

edited

Loading

Xerkus Jan 9, 2024 •

edited

Loading

Xerkus Jan 9, 2024 •

edited

Loading