Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added @template-extends to solve Psalm issues #745

Merged
merged 1 commit into from
Oct 31, 2023

Conversation

driehle
Copy link
Member

@driehle driehle commented Oct 15, 2023

The issues came from a recent new release of laminas-stdlib, which introduced templates in AbstractOptions.

@driehle driehle added the Enhacement New feature or request label Oct 15, 2023
@driehle driehle added this to the 6.0.1 milestone Oct 15, 2023
@driehle driehle changed the title Added @template-implements to solve Psalm issues Added @template-extends to solve Psalm issues Oct 15, 2023
@driehle driehle requested a review from a team October 15, 2023 04:58
@@ -8,6 +8,8 @@

/**
* Configuration options for a DBAL Connection
*
* @template-extends AbstractOptions<mixed>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we be more precise here? 🤔

Copy link
Member Author

@driehle driehle Oct 15, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would need to be the supertype of all options stored in the container. Not sure if that's desirable? Talking about all affected containers, most options are string, but there's also bool and some other objects. I don't really see the point to use template types for AbstractOptions anyways, but that's obviously not me to decide. 😇

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you add ... to the array, you should be able to cover the whole supertype

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instructions unclear 🙈
Which array? 🤔

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The template type to add here, in theory , is array{foo: bar, ...}

Copy link
Member Author

@driehle driehle Oct 15, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe I am misunderstanding AbstractOptions somehow, but it's technically an iterable<string, TValue>. Therefore, the template TValue does not reflect the configuration array, as your snippet suggests, but rather is the type applicable to each option value. That's the reason why I am questioning the usefulness of the template as such.

Here, in this class, we have three options:

  • resultCache as string
  • sqlLogger as ?string
  • types as array or mixed[], though this could probably easily made more specific using the syntax you suggested

Therefore, we could use @template-extends AbstractOptions<null|string|array>, but since the relation between different options (i.e. keys) and their types is not preserved, I don't see much advantage in doing so. What is the benefit of being able to inject an array as resultCache type-wise, if that's not an allowed value?

@driehle driehle merged commit bb23630 into doctrine:6.0.x Oct 31, 2023
22 checks passed
@driehle driehle deleted the fix/psalm branch October 31, 2023 06:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhacement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants