Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

[Console] Readd missing php-doc parameter for constructor#42281

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
derrabus merged 1 commit intosymfony:4.4frombrosenberger:patch-1
Jul 27, 2021

Conversation

@brosenberger
Copy link
Contributor

QA
Branch?4.4
Bug fix?yes
New feature?no
Deprecations?no
Ticketsno
LicenseMIT
Doc PRsymfony/symfony-docs#...

partly revert the php constroctur php doc (readd missing php-doc for $name and $description) even if they not that meaningfull

This is needed as Magento2 uses this library and needs all php-doc parameter for interception compilation. if there are any missing parameters (in this case $name and $description) break compile step as the parameters are missmatching the actual parameters:
image
(AbstractConfigOption extends InputOption)

Alanaktion, viktym, kandy, JacobBrownAustin, fascinosum, phoenix-bjoern, jorgb90, ihor-sviziev, chriz-io, and yaroslav-qlicks reacted with thumbs up emojiro0NL, thomas-kl1, and sstok reacted with thumbs down emojiderrabus reacted with eyes emoji
@carsonbot
Copy link

Hey!

I see that this is your first PR. That is great! Welcome!

Symfony has acontribution guide which I suggest you to read.

In short:

  • Always add tests
  • Keep backward compatibility (seehttps://symfony.com/bc).
  • Bug fixes must be submitted against the lowest maintained branch where they apply (seehttps://symfony.com/releases)
  • Features and deprecations must be submitted against the 5.4 branch.

Review the GitHub status checks of your pull request and try to solve the reported issues. If some tests are failing, try to see if they are failing because of this change.

When two Symfony core team members approve this change, it will be merged and you will become an official Symfony contributor!
If this PR is merged in a lower version branch, it will be merged up to all maintained branches within a few days.

I am going to sit back now and wait for the reviews.

Cheers!

Carsonbot

@kassner
Copy link

The change was introduced in#41992

Copy link
Member

@derrabusderrabus left a comment

Choose a reason for hiding this comment

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

This looks like an issue of the tool that you are using there. I'm very much against re-introducing redundant doc block annotations.

kassner, thomas-kl1, jvasseur, and sstok reacted with thumbs up emoji
@carsonbotcarsonbot changed the titleReadd missing php-doc parameter for constructor[Console] Readd missing php-doc parameter for constructorJul 27, 2021
@brosenberger
Copy link
ContributorAuthor

brosenberger commentedJul 27, 2021
edited
Loading

@derrabus i agree that those comments are not really usefull, nethertheless all magento2 builds use this module and do generate interceptors (for a precompiled aop solution) which uses the method parameter php-doc (if present) - therefore many shops have to update their versions either to fixate it to v4.4.26 or add a patch where the@params are added again to gain a green build

mortenbirkelund reacted with thumbs up emojiIbrahimS2 and thomas-kl1 reacted with thumbs down emoji

@derrabus
Copy link
Member

Okay and why can't this be fixed on Magento's side?

kandy reacted with confused emojisstok reacted with rocket emoji

@derrabusderrabus mentioned this pull requestJul 27, 2021
@hostep
Copy link

@derrabus: Magento really needs to fix this, but the release cycle of Magento is super slow and upgrades from one version of Magento to another are very tedious and take a lot of time, even for minor releases. So even if Magento released a new version (next one is scheduled for 2022, they will only release security fixes in 2021 anymore), it would take people a lot of time and effort to upgrade to it.

ihor-sviziev, fredden, Den4ik, mortenbirkelund, and marvinhinz reacted with thumbs up emojithomas-kl1 reacted with thumbs down emoji

@alcaeus
Copy link
Contributor

@brosenberger There are multiple packages that do the same thing, including many Doctrine packages. These two parameters are self-explanatory through the signature and the documentation adds no value (especially since Symfony no longer publishes this documentation IIRC).

Slow release process aside, I don't think this issue should be fixed anywhere but in Magento itself.

@derrabus
Copy link
Member

So Magento is basically not doing bugfix releases?

marvinhinz and sstok reacted with laugh emoji

@fascinosum
Copy link

@alcaeus IMHO, using a mixed approach for DocBlock annotation may be not the best. At least when you read reduced DocBlock, it does not contribute to a better understanding. I would say it can be confusing
Speaking of best practices:https://github.com/php-fig/fig-standards/blob/master/proposed/phpdoc-tags.md#59-param

ihor-sviziev reacted with thumbs up emoji

@nicolas-grekas
Copy link
Member

Are you completely sure this is the only phpdoc that Magento needs? We removed much more, that's why I'm asking.
I'm fine reverting in 4.4, but we should keep that change in 5.4 IMHO.

viktym, derrabus, hostep, ihor-sviziev, chalasr, and sstok reacted with thumbs up emoji

@viktym
Copy link

viktym commentedJul 27, 2021
edited
Loading

@nicolas-grekas currently Magento has dependency on "symfony/console": "~4.4.0".
Do you have any ETA when symfony/console:4.4.29 with this fix for Magento can be released?

ihor-sviziev reacted with thumbs up emoji

@mortenbirkelund
Copy link

So Magento is basically not doing bugfix releases?

Magento make quarterly releases, and anything else has to be patched manually on each shops either by using magentos patch tool (with a limited amount of patches) ; by using patch command on Linux or a library like cweagans.
https://devdocs.magento.com/guides/v2.4/comp-mgr/patching.html

So this is possible, but as stated by@hostep it will require alot of work by alot of people (all shops individually)
A bug fix release of symfony/console would be the easiest solution by far, and then hopefully magento will fix the actual problem in next release.

ihor-sviziev reacted with thumbs up emoji

@derrabus
Copy link
Member

and then hopefully magento will fix the actual problem in next release.

They'll have to. We really cannot anticipate which doc block change might break this little Magento tool again.

Do you have any ETA when symfony/console:4.4.29 with this fix for Magento can be released?

The next regular release would be by the end of August.

lefte reacted with thumbs down emoji

@IbrahimS2
Copy link

@derrabus I fully agree with you, Why in the world is Magento not reading the "variables type properly",it is already defined in the construct itself! if not then and only then can fall back to PHP variables annotations.

Anyhow, I think the point here is to be part of the solution; if we can let this one slide so not everyone gets into this problem until a proper fix is presented in Magento would be highly appreciated.

mortenbirkelund, brosenberger, ihor-sviziev, jvasseur, vbuck, and marvinhinz reacted with thumbs up emoji

Copy link
Member

@derrabusderrabus left a comment

Choose a reason for hiding this comment

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

Agreed.

ihor-sviziev reacted with thumbs up emojihostep, brosenberger, and ihor-sviziev reacted with hooray emoji
@derrabus
Copy link
Member

Thank you@brosenberger.

@derrabusderrabus merged commit7f0641f intosymfony:4.4Jul 27, 2021
@derrabus
Copy link
Member

To be extra-sure: Can you please test your Magento installations with:

{"symfony/console":"^4.4.29@dev"}

… and confirm that the issue is gone and that there is no other doc block that breaks that tool?

chriz-io reacted with thumbs up emoji

@derrabus
Copy link
Member

As suggested by@nicolas-grekas, I have reverted the change while merging to the 5.4 branch.

@thomas-kl1
Copy link

@nicolas-grekas you shouldn't pay the Magento debt :(

@chernenm-zz
Copy link

To be extra-sure: Can you please test your Magento installations with:

{"symfony/console":"^4.4.29@dev"}

… and confirm that the issue is gone and that there is no other doc block that breaks that tool?

hi@derrabus, Thank you for your help with this. We can confirm that everything works on Magento side with this change.

derrabus, jorgb90, ihor-sviziev, chriz-io, simonmaass, and cmuench reacted with thumbs up emojiderrabus, jorgb90, hostep, ihor-sviziev, chriz-io, simonmaass, and johebting reacted with hooray emojichriz-io and maerroc reacted with heart emoji

@ihor-sviziev
Copy link

Hi@derrabus,
Could you release a stable version of the symfony/console as a hotfix for the Magento?

@derrabus
Copy link
Member

Could you release a stable version of the symfony/console as a hotfix for the Magento?

@fabpot just did that.

ihor-sviziev and gene-roussetos reacted with hooray emojihostep reacted with heart emoji

@ihor-sviziev
Copy link

FYI The original issue in thelaminas-code with incorrect argument type detection when@param is not declared for all parameters got fixed inlaminas/laminas-code#95 and releasedhttps://github.com/laminas/laminas-code/releases/tag/4.4.3

fascinosum reacted with thumbs up emojihostep reacted with hooray emoji

@brosenbergerbrosenberger deleted the patch-1 branchNovember 10, 2021 14:18
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

@derrabusderrabusderrabus approved these changes

@chalasrchalasrAwaiting requested review from chalasrchalasr is a code owner

Assignees

No one assigned

Projects

None yet

Milestone

4.4

Development

Successfully merging this pull request may close these issues.

14 participants

@brosenberger@carsonbot@kassner@derrabus@hostep@alcaeus@fascinosum@nicolas-grekas@viktym@mortenbirkelund@IbrahimS2@thomas-kl1@chernenm-zz@ihor-sviziev

[8]ページ先頭

©2009-2025 Movatter.jp