Updates to zend-expressive-router 3.0.0alpha2 #551

weierophinney · 2018-02-13T22:25:18Z

zend-expressive-router 3.0.0alpha2 renames middleware it previously defined, defines new middleware, and creates a number of new package-level constants for virtual services.

This patch:

Removes:
- the RouteMiddlewareFactory and DispatchMiddlewareFactory, as these are now provided by the zend-expressive-router package, and registered to the container by that package's config provider.
- the Implicit*Middleware classes and related factories; these are now provided by the zend-expressive-router package.
Renames:
- the Middleware\NotFoundMiddleware to Handler\NotFoundHandler, and renames its factory accordingly. The class was acting as a handler, and can be used in more contexts as a handler than as middleware.
Adds:
- Zend\Expressive\Container\StreamFactory, for producing empty, writable stream instances.
- Package-level constants by which virtual services may be referenced. In all cases, these refer to the FQCN variants previously used to ensure the old values continue to resolve; however, users are encouraged to use the new constants instead, as they will resolve, and because their docblocks will provide context for usage.
Changes:
- The ConfigAggregator was updated to use the new package-level constants, re-map the various aliases to the new services they refer to, and to add entries for various zend-expressive-router virtual services.
- The ApplicationConfigInjectionDelegator now raises an exception if the callback provided to it does not produce an Application instance.
- The ApplicationConfigInjectionDelegator changes on exception message to remove details that are not relevant in the 3.0 branch.

These should likely be the last breaking changes for this package before the 3.0.0 release.

Also ensures we pin to alpha or greater dependencies everywhere `-dev` dependencies were previously used.

…o their middleware These middleware were moved to the `Zend\Expressive\Router\Middleware` namespace, and now have factories defined in that package. As such, their factories can be removed here, and all references to the classes require updates internally. Since the routing middleware no longer handles 405 conditions, the router integration tests were updated to pipe the new `Zend\Expressive\Router\MethodNotAllowedMiddleware`, and the application config injector now pipes it when piping routing and dispatch middleware in order to ensure the same workflow occurs between versions.

These classes are now present in zend-expressive-router, and thus do not need to be here. This also updates references to these middleware in the router integration test to ensure tests continue to pass.

Renames `Zend\Expressive\Middleware\NotFoundMiddleware` to `Zend\Expressive\Handler\NotFoundHandler`. This is done to allow usage in more contexts. Since it was already acting like a handler, by having it explicitly be one, we can use it as one. The MiddlewareFactory will decorate it as middleware when piped, allowing it to be used in that context as well.

Per the discussion on zendframework/zend-expressive-skeleton#220, this commit converts virtual service names to constants. In each case, the original resolved value of the virtual class name is used as the constant value, but the config provider and factories now refer to the constants instead. Additionally, the `RouterResponseInterface` constant was discovered to be no longer needed, due to the extraction of route-related middleware to the zend-expressive-router package.

Adds a StreamFactory, using the ResponseFactory and its tests as a template; this new factory produces a writable zend-diactoros Stream instance backed by a `php://temp` stream. The factory is then mapped to the `Zend\Expressive\Router\IMPLICIT_HEAD_MIDDLEWARE_STREAM_FACTORY` service.

…es not produce an Application instance Instead of just returning the value, we need to raise an exception in order to warn users that they have applied the delegator factory to a service it cannot decorate.

…tor::createCollectionMapper It was refering to a practice from v2 that will not be allowed in v3. Updated the docblock as well.

michalbundyra · 2018-02-13T22:27:30Z

src/Container/ApplicationConfigInjectionDelegator.php

    {
        $application = $callback();
        if (! $application instanceof Application) {
-            return $application;
+            throw new Exception\InvalidServiceException(sprintf(


Why not static method in exception?

This one hasn't had one defined ever. I can add some later, but in most cases, we'll have different messages for every single factory, making it less viable.

michalbundyra · 2018-02-13T22:28:13Z

src/Container/ApplicationConfigInjectionDelegator.php

-     *         // - entry \Zend\Expressive\Router\DispatchMiddleware::class
+     *         // - entry for \Zend\Expressive\Router\Middleware\PathBasedRoutingMiddleware::class
+     *         // - entry for \Zend\Expressive\Router\Middleware\MethodNotAllowedMiddleware::class
+     *         // - entry \Zend\Expressive\Router\Middleware\DispatchMiddleware::class


For consistency should we have entry for... ?

michalbundyra · 2018-02-13T22:30:11Z

src/constants.php

+ *
+ * @var string
+ */
+const SERVER_REQUEST_ERROR_RESPONSE_GENERATOR = __NAMESPACE__ . '\Expressive\ServerRequestErrorResponseGenerator';


__NAMESPACE__ is Zend\Expressive, should we have \Expressive part twice here?

Good catch; fixing!

michalbundyra · 2018-02-13T22:30:17Z

src/constants.php

+ *
+ * @var string
+ */
+const SERVER_REQUEST_FACTORY = __NAMESPACE__ . '\Expressive\ServerRequestFactory';


michalbundyra · 2018-02-13T22:32:25Z

test/Router/IntegrationTest.php

@@ -103,6 +106,7 @@ private function createApplicationWithGetPost($adapter, $getName = null, $postNa
        $router = new $adapter();
        $app = $this->createApplicationFromRouter($router);
        $app->pipe(new RouteMiddleware($router, $this->response));


Here and in many other usages - the second parameter should be remove, RouteMiddleware::__construct has now one parameter.

Another nice catch! Fixing!

Only accepts the router instance as of 3.0.0alpha2

michalbundyra

LGTM 👍

Close #551

weierophinney added 8 commits February 13, 2018 15:12

Updates zend-expressive-router dependency to 3.0.0alpha2

91f2180

Also ensures we pin to alpha or greater dependencies everywhere `-dev` dependencies were previously used.

Removes the Implicit*Middleware classes

36bb27d

These classes are now present in zend-expressive-router, and thus do not need to be here. This also updates references to these middleware in the router integration test to ensure tests continue to pass.

Raise exception in ApplicationConfigInjectionDelegator if callback do…

a6a39f9

…es not produce an Application instance Instead of just returning the value, we need to raise an exception in order to warn users that they have applied the delegator factory to a service it cannot decorate.

Corrects exception message thrown by ApplicationConfigInjectionDelega…

320479a

…tor::createCollectionMapper It was refering to a practice from v2 that will not be allowed in v3. Updated the docblock as well.

weierophinney added this to the 3.0.0alpha6 milestone Feb 13, 2018

weierophinney added enhancement BC Break labels Feb 13, 2018

michalbundyra reviewed Feb 13, 2018

View reviewed changes

weierophinney added 4 commits February 13, 2018 16:39

Remove redundant sub-namespace from constant values

3364335

Adds missing word in description

721fd6a

Remove unused argument to routing middleware

75967a2

Only accepts the router instance as of 3.0.0alpha2

Removes unused test trait

ffbe7b7

michalbundyra approved these changes Feb 13, 2018

View reviewed changes

weierophinney mentioned this pull request Feb 13, 2018

Suggestion for '<Dispatch|Route>Middleware::class' in 3.0alpha zendframework/zend-expressive-skeleton#220

Closed

weierophinney merged commit ffbe7b7 into zendframework:release-3.0.0 Feb 13, 2018

weierophinney added a commit that referenced this pull request Feb 13, 2018

Adds CHANGELOG entries for #551 to new 3.0.0alpha6 entry

5d9bafc

weierophinney added a commit that referenced this pull request Feb 13, 2018

Merge branch 'feature/zend-expressive-router-alpha2' into release-3.0.0

cc74dad

Close #551

weierophinney deleted the feature/zend-expressive-router-alpha2 branch February 15, 2018 15:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updates to zend-expressive-router 3.0.0alpha2 #551

Updates to zend-expressive-router 3.0.0alpha2 #551

weierophinney commented Feb 13, 2018

michalbundyra Feb 13, 2018

weierophinney Feb 13, 2018

michalbundyra Feb 13, 2018

michalbundyra Feb 13, 2018

weierophinney Feb 13, 2018

michalbundyra Feb 13, 2018

michalbundyra Feb 13, 2018

weierophinney Feb 13, 2018

michalbundyra left a comment

Updates to zend-expressive-router 3.0.0alpha2 #551

Updates to zend-expressive-router 3.0.0alpha2 #551

Conversation

weierophinney commented Feb 13, 2018

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

Choose a reason for hiding this comment

michalbundyra left a comment

Choose a reason for hiding this comment