Allow Migration Classes to be in Multiple Namespaces #693

chrisguitarguy · 2018-05-20T02:12:58Z

Q	A
Type	Improvement
BC Break	yes
Fixed issues	#348

Summary

This changes the various MigrationFinder implementations to use reflection and get_declared_classes to load the various migration classes. The code is similar to the doctrine persistence stuff

The end result is that all the code for loading migrations no longer cares about the namespace in the configuration -- it's only for generating new migrations now. Users can nest namespaces as they wish.

Previously the finders would take whatever namespace was given in the findMigrations method. Instead, this switches that to use reflection to both figure out a version number (from the short class name) and the FQCN as well.

With the new finder stuff that uses reflection instead of guessing filenames, the test was failing and not really able to be fixed without breaking the finder stuff. Due to refactoring, it made more sense to move the test into `MigrationRepositoryTest`.

Closes doctrine#348

The previous changes to use reflection and `get_declared_classes` means that this argument is no longer used.

chrisguitarguy · 2018-05-20T02:14:56Z

lib/Doctrine/Migrations/Finder/Finder.php

        }

-        return $migrations;
+        ksort($versions, SORT_STRING);


Do we need this sorting? The MigrationRepository does sorting itself. Maybe its redundant here?

Probably not needed. I would make sure we have test coverage for the sorting and then remove it and see if anything breaks.

chrisguitarguy · 2018-05-20T02:15:20Z

lib/Doctrine/Migrations/Finder/Finder.php

+        $classes = [];
+        foreach (get_declared_classes() as $class) {
+            $ref = new ReflectionClass($class);
+            if (in_array($ref->getFileName(), $files)) {


PHP CS is complaining about this line on my local because it doesn't use an early exit.

chrisguitarguy · 2018-05-20T02:18:45Z

tests/Doctrine/Migrations/Tests/Configuration/ConfigurationTest.php

-            MigrationException::class,
-            'Migration class "Migrations\Version123" was not found. Is it placed in "Migrations" namespace?'
-        );
-        $configuration->registerMigrationsFromDirectory($migrationsDir);


This test, to make sure that an exception is thrown when a non-existent migration class is trying to be registered, got moved to MigrationRepositoryTest. Because the finders use reflection now, this stuff doesn't work. This test worked because the namespace for Version123 was different. Now migrations just loads that stuff for you.

Leftovers from before refactoring.

jwage · 2018-05-21T15:53:43Z

@chrisguitarguy Couldn't this change be made BC? Basically, keep on allowing a namespace to be passed optionally and if it is passed, filter the migrations it finds, to only the ones in that namespace.

chrisguitarguy · 2018-05-21T15:58:28Z

Couldn't this change be made BC? Basically, keep on allowing a namespace to be passed optionally and if it is passed, filter the migrations it finds, to only the ones in that namespace.

Probably? It's not really a BC break as it is now: whatever migrations a person has that already exist before this change will still load correctly.

Maybe a better way to make it more BC friendly is to filter out anything that doesn't extend the AbstractMigration so nothing unexpected gets loaded. Maybe also filter out anything that's an abstract class.

jwage · 2018-05-21T16:21:29Z

@chrisguitarguy The reason I ask is because, I think as it is right now, the migration namespace setting goes unused. So we either need to deprecate and remove that setting or keep it there. I think we should keep it there and enforce the filtering with that setting and make sure it is optional everywhere. This way things are guaranteed to just keep working the way they did before.

chrisguitarguy · 2018-05-21T16:31:06Z

I think as it is right now, the migration namespace setting goes unused

It's used in code generation. So another path could be renaming the setting to default_namespace or something like that.

As long as existing migrations load correctly (which they already won't do to void typehints added to AbstractMigration::{up,down}), then I wouldn't add another flag option to enable or disable this stuff.

chrisguitarguy · 2018-05-21T16:37:15Z

Unless you want to target something in a 1.7.x release that deprecates things -- similar to how you have to opt into behavior into new behavior symfony upgrades (thinking specifically of some form stuff).

jwage · 2018-05-21T16:46:53Z

I would prefer to keep it all BC and not remove or rename anything.

jwage · 2018-05-22T20:06:49Z

lib/Doctrine/Migrations/Finder/Finder.php

-    protected function getFileSortCallback() : callable
+    /**
+     * Look up all declared classes and find those classes contained
+     * in the give `$files` array.


Typo give should be given

jwage · 2018-05-22T20:07:27Z

lib/Doctrine/Migrations/Finder/Finder.php

-        };
+        $classes = [];
+        foreach (get_declared_classes() as $class) {
+            $ref = new ReflectionClass($class);


We like to avoid using abbreviations. Please use $reflectionClass as the variable name here.

jwage · 2018-05-22T20:12:47Z

lib/Doctrine/Migrations/Finder/GlobFinder.php

@@ -12,12 +12,12 @@
    /**
     * @return string[]
     */
-    public function findMigrations(string $directory, ?string $namespace = null) : array
+    public function findMigrations(string $directory) : array


As discussed, please reintroduce the $namespace argument as optional and if it is provided, filter the classes returned to only be the ones in that namespace.

When provided this will filter out any classes not in the provided namespace.

chrisguitarguy · 2018-05-26T13:46:56Z

@jwage changes made! Sorry it took me so long to get back to this.

Do we need to add the configuration option here to enable multiple namespaces?

jwage · 2018-05-29T14:08:57Z

@chrisguitarguy We could do that in another PR to allow multiple namespaces to be specified for the filtering. I think this is probably fine for this PR.

chrisguitarguy added 6 commits May 19, 2018 21:13

Put Actual Migration Classes in the Finder Test Files

f72ad74

Use Reflection to Determine Version Number & FQCNs

75b8137

Previously the finders would take whatever namespace was given in the findMigrations method. Instead, this switches that to use reflection to both figure out a version number (from the short class name) and the FQCN as well.

Add Test Cases to Verify Multi Namespaces Can be Used

ea8273f

Closes doctrine#348

Remove Unused $namespace Argument from findMigrations

63960c8

The previous changes to use reflection and `get_declared_classes` means that this argument is no longer used.

Fix CS

c4bb492

chrisguitarguy force-pushed the finder_ns branch from 11e115f to c4bb492 Compare May 20, 2018 02:13

chrisguitarguy commented May 20, 2018

View reviewed changes

chrisguitarguy added 5 commits May 19, 2018 21:20

Fix a Mis-Cased Class Name

6b25838

Fix a Typo Class Name from Some PHP CS Fixes

5395315

Remove an Unused Variable

743726e

Leftovers from before refactoring.

Make an in_array Check in Finder More Strict

88b3c5d

Make the Coding Standards Happy

9c52cdd

jwage added this to the 2.0 milestone May 21, 2018

jwage added the Enhancement label May 21, 2018

jwage assigned jwage and chrisguitarguy and unassigned jwage May 21, 2018

jwage requested changes May 22, 2018

View reviewed changes

chrisguitarguy added 5 commits May 26, 2018 08:37

Re-Add the Namespace to MigrationFinder::findMigrations

19bc5c1

When provided this will filter out any classes not in the provided namespace.

Don't Abbreviate the Reflection Class Variable

02e73c4

Fix a Typo in a Docblock

3d79695

Fix Some Docblock Wording

1289442

Pass the Namespace to Finder in MigrationRepository

10f8558

Fix CS

c41c072

jwage approved these changes May 29, 2018

View reviewed changes

jwage merged commit 956cdf5 into doctrine:master May 29, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow Migration Classes to be in Multiple Namespaces #693

Allow Migration Classes to be in Multiple Namespaces #693

chrisguitarguy commented May 20, 2018

chrisguitarguy May 20, 2018

jwage May 21, 2018

chrisguitarguy May 20, 2018

chrisguitarguy May 20, 2018

jwage commented May 21, 2018

chrisguitarguy commented May 21, 2018

jwage commented May 21, 2018

chrisguitarguy commented May 21, 2018 •

edited

Loading

chrisguitarguy commented May 21, 2018 •

edited

Loading

jwage commented May 21, 2018

jwage May 22, 2018

jwage May 22, 2018

jwage May 22, 2018

chrisguitarguy commented May 26, 2018

jwage commented May 29, 2018

Allow Migration Classes to be in Multiple Namespaces #693

Allow Migration Classes to be in Multiple Namespaces #693

Conversation

chrisguitarguy commented May 20, 2018

Summary

chrisguitarguy May 20, 2018

Choose a reason for hiding this comment

jwage May 21, 2018

Choose a reason for hiding this comment

chrisguitarguy May 20, 2018

Choose a reason for hiding this comment

chrisguitarguy May 20, 2018

Choose a reason for hiding this comment

jwage commented May 21, 2018

chrisguitarguy commented May 21, 2018

jwage commented May 21, 2018

chrisguitarguy commented May 21, 2018 • edited Loading

chrisguitarguy commented May 21, 2018 • edited Loading

jwage commented May 21, 2018

jwage May 22, 2018

Choose a reason for hiding this comment

jwage May 22, 2018

Choose a reason for hiding this comment

jwage May 22, 2018

Choose a reason for hiding this comment

chrisguitarguy commented May 26, 2018

jwage commented May 29, 2018

chrisguitarguy commented May 21, 2018 •

edited

Loading

chrisguitarguy commented May 21, 2018 •

edited

Loading