Migrate to `static` data providers using `rector/rector` #48668

OskarStark · 2022-12-15T18:41:25Z

Q	A
Branch?	5.4
Bug fix?	no
New feature?	no
Deprecations?	no
Tickets	#48281
License	MIT
Doc PR	n/a

@nicolas-grekas it can be executed by running:

tools/vendor/bin/rector process --config=tools/rector.php

Review commit by commit.
We need to check now where we use object context in static providers and fix them manually, an maybe merge them manually, unmerge them and apply rector one by one to every branch.

GromNaN

This is huge 😃

Some abstract test classes are extended in other packages, including packages external to symfony/*, they are covered by our BC policy. Changing the signature of an abstract method to make it static is a breaking change.

We need to update them, but I don't know if that is possible in a backward compatible way.

src/Symfony/Component/Mailer/Test/TransportFactoryTestCase.php

src/Symfony/Component/Notifier/Test/TransportFactoryTestCase.php

src/Symfony/Component/Notifier/Test/TransportTestCase.php

src/Symfony/Component/Security/Core/Test/AccessDecisionStrategyTestCase.php

src/Symfony/Component/Translation/Test/ProviderFactoryTestCase.php

src/Symfony/Component/Translation/Test/ProviderTestCase.php

OskarStark · 2022-12-16T09:50:27Z

Exactly, I don't know either 🤨

OskarStark · 2022-12-17T07:46:41Z

Maybe we can copy the AbstractTestCases and deprecate the old ones, the new ones then switch to the static dataProviders, but are basically the same.

@nicolas-grekas @stof would this work for you?

In the Symfony codebase itself we then use the not deprecated class and bump the requirements in composer.json.

OskarStark · 2022-12-20T07:37:18Z

I excluded the abstract test cases for now in b48c5d8

refs symfony#48668 follows symfony#48625

This PR was squashed before being merged into the 5.4 branch. Discussion ---------- Use static methods inside data providers | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | n/a | License | MIT | Doc PR | n/a refs #48668 follows * #48625 Commits ------- 9a18048 Use static methods inside data providers

alexandre-daubois · 2023-01-12T06:43:25Z

Would that help to create a few PRs aiming to refactor data providers using $this to ease their transition to static ones?

OskarStark · 2023-01-12T06:59:40Z

Would that help to create a few PRs aiming to refactor data providers using $this to ease their transition to static ones?

Yes, this work needs to be done manually anyway, so we can do it in smaller PRs, thanks

… providers (alexandre-daubois) This PR was merged into the 5.4 branch. Discussion ---------- [Tests] Remove `$this` occurrences in future static data providers | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes-ish | New feature? | no  | Deprecations? | no  | Tickets | Easing #48668 (comment) | License | MIT | Doc PR | _NA_ Commits ------- 6fb7cb9 [Tests] Remove `$this` occurrences in future static data providers

OskarStark · 2023-01-16T07:37:13Z

@alexandre-daubois I rebased this PR after your

[Tests] Remove $this occurrences in future static data providers #48980

was merged 👍

… future static data providers (alexandre-daubois) This PR was merged into the 5.4 branch. Discussion ---------- [Tests] New iteration of removing `$this` occurrences in future static data providers | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes-ish | New feature? | no  | Deprecations? | no  | Tickets | Easing #48668 (comment) | License | MIT | Doc PR | _NA_ Follow-up of #48980 Commits ------- 1386ac2 [Tests] New iteration of removing `$this` occurrences in future static data providers

… future static data providers (alexandre-daubois) This PR was merged into the 5.4 branch. Discussion ---------- [Tests] New iteration of removing `$this` occurrences in future static data providers | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes-ish | New feature? | no  | Deprecations? | no  | Tickets | Easing symfony/symfony#48668 (comment) | License | MIT | Doc PR | _NA_ Follow-up of #48980 Commits ------- 1386ac2e81 [Tests] New iteration of removing `$this` occurrences in future static data providers

alexandre-daubois · 2023-02-07T16:57:24Z

@TomasVotruba definitely, will comment your issue on my next iteration! 👍

…e-daubois) This PR was merged into the 5.4 branch. Discussion ---------- [Tests] Migrate tests to static data providers | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes-ish | New feature? | no | Deprecations? | no | Tickets | Continuing #48668 (comment) | License | MIT | Doc PR | _NA_ This is yet another PR to continue the manual work needed for the migration of data providers to static ones. I also took the opportunity to pass a few `static::` to `self::` calls, as pointed out by Nicolas in this comment: #49244 (comment) cc `@OskarStark` 👋 Commits ------- 3b8b070 [Tests] Migrate tests to static data providers

…e-daubois) This PR was merged into the 5.4 branch. Discussion ---------- [Tests] Migrate tests to static data providers | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes-ish | New feature? | no | Deprecations? | no | Tickets | Continuing symfony/symfony#48668 (comment) | License | MIT | Doc PR | _NA_ This is yet another PR to continue the manual work needed for the migration of data providers to static ones. I also took the opportunity to pass a few `static::` to `self::` calls, as pointed out by Nicolas in this comment: symfony/symfony#49244 (comment) cc `@OskarStark` 👋 Commits ------- 3b8b07037b [Tests] Migrate tests to static data providers

OskarStark · 2023-02-10T18:38:32Z

Rebased after #49288

nicolas-grekas · 2023-02-11T09:26:57Z

There are some remaining failures to fix :)

OskarStark · 2023-02-11T09:46:24Z

I know I need to exclude the abstract test case from notifier, we need to fix this later in a BC way and some others.

I am on it and ofc @alexandre-daubois 👍🏻

I think we can finish this one next week

OskarStark · 2023-02-11T11:09:03Z

@TomasVotruba here is another issue we are facing at our codebase

Add failing test fixture for StaticDataProviderClassMethodRector with ignored abstract parent test case rectorphp/rector-phpunit#160

alexandre-daubois · 2023-02-11T11:56:04Z

I am on it and ofc @alexandre-daubois 👍🏻

I hope to send the next (and I hope the last 🤞) one by tomorrow or so!

TomasVotruba · 2023-02-11T11:58:11Z

@OskarStark I'm on it 👍

…e-daubois) This PR was merged into the 5.4 branch. Discussion ---------- [Tests] Migrate tests to static data providers | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes-ish | New feature? | no | Deprecations? | no | Tickets | Continuing #48668 (comment) | License | MIT | Doc PR | _NA_ This PR should take care of remaining errors of #48668. cc `@OskarStark` Commits ------- dea43a6 [Tests] Migrate tests to static data providers

nicolas-grekas · 2023-02-13T13:40:01Z

rebase unlocked

OskarStark · 2023-02-13T19:28:19Z

Rebased and excluded Mailer and Notifier tests which use an abstract test case from /Test/ directory

OskarStark · 2023-02-13T19:56:33Z

@nicolas-grekas I would propose to keep and upmerge the rector config, as we need to exclude the same paths in the upper branches too 🤷‍♂️ we can remove /tools directory when merging is done, WDYT?

nicolas-grekas · 2023-02-14T08:07:39Z

Thank you @OskarStark.

nicolas-grekas · 2023-02-14T09:33:20Z

For Test folders that we currently skipped, I think it's fine moving them to static methods.
Yes, this is a BC break, but building on those is going to be rare since building a private Notifier, Messenger, Translation bridge or Security strategy is not very common. It's also not something that will break any prod.
Can you please work on a PR that fixes them also? Don't forget to bump the min version in composer.json files of course.

alexandre-daubois · 2023-02-14T09:38:17Z

Would love to help on this! Would this kind of PR also target 5.4?

nicolas-grekas · 2023-02-14T09:42:10Z

Yes please

OskarStark · 2023-02-14T09:56:07Z

I will run the rector again against 5.4, let's see what's left todo then @alexandre-daubois 👍

…tic (OskarStark, alexandre-daubois) This PR was merged into the 5.4 branch. Discussion ---------- [BC Break] Make data providers for abstract test cases static | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | Refs #48668 | License | MIT | Doc PR | - Follows #48668 (comment) ### Todos * [x] Bump min version in `composer.json` Notifier `@OskarStark` * [x] Bump min version in `composer.json` Translation `@OskarStark` * [x] Bump min version in `composer.json` Mailer `@OskarStark` * [x] Bump min version in `composer.json` Security `@OskarStark` - _nothing todo_ * [x] document BC break in CHANGELOG files Notifier `@OskarStark` * [x] document BC break in CHANGELOG files Translation `@OskarStark` * [x] document BC break in CHANGELOG files Mailer `@OskarStark` * [x] document BC break in CHANGELOG files Security `@OskarStark` * [x] document BC break in UPGRADE files Notifier `@OskarStark` * [x] document BC break in UPGRADE files Translation `@OskarStark` * [x] document BC break in UPGRADE files Mailer `@OskarStark` * [x] document BC break in UPGRADE files Security `@OskarStark` * [x] remove $this in static methods `@alexandre`-daubois * [x] make tests green Commits ------- c444a43 [Translation][Mailer] Convert `$this` calls to static ones in data providers 77c8444 [BC Break] Make data providers for abstract test cases static

OskarStark requested review from xabbuh, lyrixx, dunglas, yceruto, wouterj, chalasr and jderusse as code owners December 15, 2022 18:41

carsonbot added the Status: Needs Review label Dec 15, 2022

carsonbot added this to the 5.4 milestone Dec 15, 2022

GromNaN reviewed Dec 16, 2022

View reviewed changes

OskarStark force-pushed the static-data-providers-rector branch from d2a196c to 0609d48 Compare December 20, 2022 07:36

OskarStark added a commit to OskarStark/symfony that referenced this pull request Dec 20, 2022

Fix more code which is used in data providers

df7ac0e

refs symfony#48668 follows symfony#48625

OskarStark mentioned this pull request Dec 20, 2022

Use static methods inside data providers #48709

Merged

GromNaN mentioned this pull request Jan 12, 2023

[Tests] Declare static data providers #48953

Closed

alexandre-daubois mentioned this pull request Jan 14, 2023

[Tests] Remove $this occurrences in future static data providers #48980

Merged

alexandre-daubois mentioned this pull request Jan 15, 2023

[Tests] New iteration of removing $this occurrences in future static data providers #48988

Merged

OskarStark force-pushed the static-data-providers-rector branch from 0609d48 to 28aee0b Compare January 16, 2023 07:36

alexandre-daubois mentioned this pull request Jan 20, 2023

[Tests] New iteration of removing $this occurrences in future static data providers #49054

Closed

alexandre-daubois mentioned this pull request Feb 7, 2023

[Tests] Migrate tests to static data providers #49288

Merged

OskarStark force-pushed the static-data-providers-rector branch from 2242a61 to acdd54c Compare February 10, 2023 18:37

OskarStark mentioned this pull request Feb 11, 2023

Add failing test fixture for StaticDataProviderClassMethodRector with ignored abstract parent test case rectorphp/rector-phpunit#160

Closed

alexandre-daubois mentioned this pull request Feb 12, 2023

[Tests] Migrate tests to static data providers #49345

Merged

OskarStark force-pushed the static-data-providers-rector branch from 41d5ff4 to 3fa5450 Compare February 13, 2023 19:28

Migrate to static data providers using rector/rector

2ec54e9

nicolas-grekas force-pushed the static-data-providers-rector branch from 770206a to 2ec54e9 Compare February 14, 2023 08:04

nicolas-grekas merged commit 8ca9e51 into symfony:5.4 Feb 14, 2023

OskarStark deleted the static-data-providers-rector branch February 14, 2023 09:55

OskarStark mentioned this pull request Feb 14, 2023

[BC Break] Make data providers for abstract test cases static #49368

Merged

14 tasks

GromNaN mentioned this pull request Jan 20, 2025

[SecurityBundle] Make data provider static #59563

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrate to `static` data providers using `rector/rector` #48668

Migrate to `static` data providers using `rector/rector` #48668

OskarStark commented Dec 15, 2022 •

edited

Loading

GromNaN left a comment

OskarStark commented Dec 16, 2022

OskarStark commented Dec 17, 2022

OskarStark commented Dec 20, 2022

alexandre-daubois commented Jan 12, 2023

OskarStark commented Jan 12, 2023

OskarStark commented Jan 16, 2023

alexandre-daubois commented Feb 7, 2023

OskarStark commented Feb 10, 2023

nicolas-grekas commented Feb 11, 2023

OskarStark commented Feb 11, 2023

OskarStark commented Feb 11, 2023

alexandre-daubois commented Feb 11, 2023

TomasVotruba commented Feb 11, 2023

nicolas-grekas commented Feb 13, 2023

OskarStark commented Feb 13, 2023

OskarStark commented Feb 13, 2023 •

edited

Loading

nicolas-grekas commented Feb 14, 2023

nicolas-grekas commented Feb 14, 2023 •

edited

Loading

alexandre-daubois commented Feb 14, 2023

nicolas-grekas commented Feb 14, 2023

OskarStark commented Feb 14, 2023

Migrate to static data providers using rector/rector #48668

Migrate to static data providers using rector/rector #48668

Conversation

OskarStark commented Dec 15, 2022 • edited Loading

GromNaN left a comment

Choose a reason for hiding this comment

OskarStark commented Dec 16, 2022

OskarStark commented Dec 17, 2022

OskarStark commented Dec 20, 2022

alexandre-daubois commented Jan 12, 2023

OskarStark commented Jan 12, 2023

OskarStark commented Jan 16, 2023

alexandre-daubois commented Feb 7, 2023

OskarStark commented Feb 10, 2023

nicolas-grekas commented Feb 11, 2023

OskarStark commented Feb 11, 2023

OskarStark commented Feb 11, 2023

alexandre-daubois commented Feb 11, 2023

TomasVotruba commented Feb 11, 2023

nicolas-grekas commented Feb 13, 2023

OskarStark commented Feb 13, 2023

OskarStark commented Feb 13, 2023 • edited Loading

nicolas-grekas commented Feb 14, 2023

nicolas-grekas commented Feb 14, 2023 • edited Loading

alexandre-daubois commented Feb 14, 2023

nicolas-grekas commented Feb 14, 2023

OskarStark commented Feb 14, 2023

Migrate to `static` data providers using `rector/rector` #48668

Migrate to `static` data providers using `rector/rector` #48668

OskarStark commented Dec 15, 2022 •

edited

Loading

OskarStark commented Feb 13, 2023 •

edited

Loading

nicolas-grekas commented Feb 14, 2023 •

edited

Loading