4.x New Dispatcher & Routing Results #2405

l0gicgate · 2018-02-23T22:20:28Z

As discussed on Slack, there are a few issues with the way FastRoute\Dispatcher returns information after a route has been dispatched.

Issues

FastRoute\Dispatcher::dispatch() returns an array with an inconsistent structure
It only appends allowed methods to the return value when no allowed methods have been found on the dispatched route.

Changes

routeInfo now deprecated and replaced with routingResults
RoutingResults is an immutable object instantiated by the Slim Dispatcher which now offers a way to get all a route's allowed methods which was not accessible before via FastRoute\GroupCountBased\Dispatcher

Usage

use Slim\App;

$app = new App();
$app->get('/foo', function (Request $request, Response $response) {
    $routingResults = $request->getAttribute('routingResults');
    $uri = $routingResults->getUri();
    $method = $routingResults->getMethod();
    $routeArguments = $routingResults->getRouteArguments();
    $allowedMethods = $routingResults->getAllowedMethods();
});

Status

Implement new Dispatcher & Routing Results
Implement FastRoute test suite for Dispatcher
Code Review & Discussion

coveralls · 2018-02-23T22:22:28Z

Coverage increased (+0.2%) to 96.262% when pulling c58a2bb on l0gicgate:4.x-DispatcherResults into 77daca6 on slimphp:4.x.

geggleto · 2018-05-16T18:54:53Z

Slim/Router.php

@@ -266,11 +263,13 @@ protected function createDispatcher()

        if ($this->cacheFile) {
            $this->dispatcher = \FastRoute\cachedDispatcher($routeDefinitionCallback, [
+                'dispatcher' => '\\Slim\\Dispatcher',


We should use the class constant here

This however makes the app not extendable and a user cannot replace the dispatcher

Actually the Router can be extended and this method overridden. When instantiating the RoutingMiddleware you can pass a router to it which could be the router of your choice. An alternative would be to pass settings to the Router constructor.

damianopetrungaro · 2018-05-16T18:58:14Z

Slim/DispatcherResults.php

+    /**
+     * @var int
+     *
+     * Not Found = 0


What do you think about using an Enum for this $routeStatus or if it's an overhead use constants instead of comments for valid statuses?

It probably should be a class constant

The routeStatus is what comes from Fastroute. We can convert those to constants. Should the constants be on the Dispatcher or Dispatcher results and what should they be named? FOUND, NOT_FOUND, NOT_ALLOWED?

Yup, class constant or Enum will be more explicit so for me both are good.

1: FOUND, NOT_FOUND, NOT_ALLOWED sounds good to me.
2: You use them in DispatcherResults so it may be the right place (imho use an Enum and inject it is the best approach)

Actually, no need to make changes. This PR extends FastRoute\Dispatcher\GroupCountBased class which implements FastRoute\Dispatcher interface which has those constants. They can be used as Slim\Dispatcher::FOUND, Slim\Dispatcher::NOT_FOUND, Slim\Dispatcher::NOT_ALLOWED

I will amend the comment in DispatcherResults to reference where those integers come from.

damianopetrungaro · 2018-05-16T18:59:58Z

Slim/DispatcherResults.php

+     */
+    public function getRouteArguments($urlDecode = true)
+    {
+        if ($urlDecode) {


Avoid nested statement:

if (!$urlDecode) { return $this->routeArguments; } $routeArguments = []; foreach ($this->routeArguments as $key => $value) { $routeArguments[$key] = urldecode($value); } return $routeArguments;

damianopetrungaro · 2018-05-16T19:02:52Z

Slim/Dispatcher.php

+        }
+
+        // For HEAD requests, attempt fallback to GET
+        if ($httpMethod === 'HEAD') {


Wdyt about adding https://github.com/php-fig/http-message-util to avoid hardcoded HTTP methods?

HTTP Methods don't change. I dont think we need to include a package for constants, we aren't javascript.

I always include it in for descriptive HTTP status codes and it contains have HTTP methods too.
Seen that is a FIG package I'm ok with it.
But I get your point of view so it's not a big deal 😄

If anywhere, this should be on the Slim\Http package.

damianopetrungaro · 2018-05-16T19:52:10Z

tests/RouterTest.php

    }

    public function testSetDispatcher()
    {
        $this->router->setDispatcher(\FastRoute\simpleDispatcher(function ($r) {
            $r->addRoute('GET', '/', function () {
            });
-        }));
+        }, ['dispatcher' => '\\Slim\\Dispatcher']));


Use Dispatcher::class instead of hardcoded namespace, if it will change we have to change it in a lot of places

damianopetrungaro · 2018-05-16T21:32:58Z

tests/RouterTest.php

@@ -362,7 +364,7 @@ public function testRouteCacheFileCanBeDispatched()
        $method->setAccessible(true);

        $dispatcher = $method->invoke($this->router);
-        $this->assertInstanceOf('\FastRoute\Dispatcher', $dispatcher);
+        $this->assertInstanceOf('\Slim\Dispatcher', $dispatcher);


@l0gicgate Here namespace too 😄

damianopetrungaro · 2018-05-16T21:33:05Z

tests/RouterTest.php

        $class = new \ReflectionClass($this->router);
        $prop = $class->getProperty('dispatcher');
        $prop->setAccessible(true);
-        $this->assertInstanceOf('\FastRoute\Dispatcher', $prop->getValue($this->router));
+        $this->assertInstanceOf('\Slim\Dispatcher', $prop->getValue($this->router));


@l0gicgate Here namespace too 😄

damianopetrungaro · 2018-05-16T21:33:10Z

tests/RouterTest.php

@@ -205,19 +207,19 @@ public function testCreateDispatcher()
        $class = new \ReflectionClass($this->router);
        $method = $class->getMethod('createDispatcher');
        $method->setAccessible(true);
-        $this->assertInstanceOf('\FastRoute\Dispatcher', $method->invoke($this->router));
+        $this->assertInstanceOf('\Slim\Dispatcher', $method->invoke($this->router));


@l0gicgate Here namespace too 😄

damianopetrungaro · 2018-05-16T21:34:32Z

tests/DispatcherTest.php

+
+    protected function getDataGeneratorClass()
+    {
+        return 'FastRoute\\DataGenerator\\GroupCountBased';


Are we including it as dependency?
We may use namespace here too instead of hardcoded 😄

damianopetrungaro · 2018-05-16T21:34:38Z

tests/DispatcherTest.php

+{
+    protected function getDispatcherClass()
+    {
+        return 'Slim\\Dispatcher';


@l0gicgate Here namespace too 😄

akrabat · 2018-05-07T14:50:00Z

Slim/Middleware/RoutingMiddleware.php

-                $routeArguments[$k] = urldecode($v);
-            }
+        switch ($routeStatus) {
+            default:


default should be last in a switch statement. Arguably, it should throw an Exception as it should never happen.

What kind of exception would you like to be thrown here? Just a regular exception or RuntimeException

Runtime is fine as it should never happen :)

akrabat · 2018-05-07T15:04:08Z

Slim/Dispatcher.php

+            }
+        }
+
+        return $allowedMethods;


Should we be caching the list of allowed methods in an instance variable keyed by the function's parameters? It appears that we currently have to do this same work twice when we're in a method not allowed scenario.

As per one of our previous discussions, this avoids the initial performance hit of looping through every single route. It is being returned on demand instead of initially doing it every time we dispatch. This is also the way Fastroute does it.

I understand that.

Given getAllowedMethods() has been called, why don't we keep a copy of the calculated $allowedMethods in a local member variable, so that we don' have to do all the work again if getAllowedMethods() is called again with exactly the same parameters?

From what I can tell if we're in a Method Not Allowed situation, we call getAllowedMethods() on line 68 of Dispatcher.php and then again in line 83 of RoutingMiddleware.php, so it appears to me that we're doing the same work twice.

akrabat · 2018-05-07T15:23:53Z

Slim/DispatcherResults.php

+     * @param bool $urlDecode
+     * @return array
+     */
+    public function getRouteArguments($urlDecode = true)


Why would we not want to url decode the route arguments?

This is what is currently being done https://github.com/slimphp/Slim/blob/4.x/Slim/Middleware/RoutingMiddleware.php#L66

What I mean is that currently in Slim 3 it's not optional. Why is the choice a method parameter here?

As per our discussion on slack, we're leaving this as is.

akrabat · 2018-05-17T08:36:14Z

Slim/Router.php

-     * @return array
-     *
-     * @link   https://github.com/nikic/FastRoute/blob/master/src/Dispatcher.php
+     * @return DispatcherResults


We need to add

$uri = rawurldecode($uri);

before calling the dispatcher's dispatch() in this method. Not sure if it should be a separate PR or not.

This commit cc0c0b3 applies the requested change.

damianopetrungaro · 2018-05-17T20:29:00Z

@l0gicgate btw before merging could you please squash all your commits?

l0gicgate · 2018-05-17T20:33:03Z

@damianopetrungaro I'm not the one merging, @akrabat will take care of that!

damianopetrungaro · 2018-05-17T21:32:55Z

You can do it also on your local branch:
git rebase -i HEAD~{number of commit to squash} and clean a little bit the history for this PR 😄

Fix rebase merge conflict

Add url decoding functionality to getRouteArguments() method

Fix copyright year

Reference $routeStatus constant origin and fix nested conditional Use class constant instead of string reference Use class constant instead of string reference Use class constant instead of string reference Fix switch default case in RoutingMiddleware

Add allowed methods caching in Dispatcher Add test case for routes with international characters Add test case for international characters in route arguments

akrabat · 2018-05-18T07:37:01Z

FWiW, I am not a fan of rebasing to clean history. Rebasing to remove a commit that's a typo fix is fine, but I personally prefer to see the route that was taken to get to where we are now.

akrabat · 2018-05-18T08:18:15Z

Slim/Dispatcher.php

+     */
+    public function getAllowedMethods($httpMethod, $uri)
+    {
+        if ($this->allowedMethods !== null) {


This will give the wrong answer if I do this:

$methods1 = $o->getAllowedMethods('POST', '/foo'); $methods2 = $o->getAllowedMethods('GET', '/bar');

At least, I think that $methods2 will be the allowed methods for /foo

You are correct, I made a mistake. I fixed this logic in latest commit. Good find!

Closes #2405 Fixes #2399

damianopetrungaro · 2018-05-24T19:56:41Z

Great work @l0gicgate !

RyanNerd mentioned this pull request Feb 24, 2018

Custom Dispatcher Implementation for 3.x (work around) #2406

Closed

akrabat added the Slim 4 label Feb 25, 2018

RyanNerd mentioned this pull request Feb 28, 2018

Should Slim 4 switch to Symfony 4 Router? #2410

Closed

l0gicgate force-pushed the 4.x-DispatcherResults branch from 0704f28 to e2d52a2 Compare March 13, 2018 21:09

l0gicgate force-pushed the 4.x-DispatcherResults branch from e2d52a2 to 4ffbf27 Compare May 15, 2018 20:41

geggleto requested changes May 16, 2018

View reviewed changes

damianopetrungaro reviewed May 16, 2018

View reviewed changes

akrabat reviewed May 17, 2018

View reviewed changes

l0gicgate added 9 commits May 17, 2018 15:59

Introduce custom Dispatcher and DispatcherResults

e9f6cbe

Fix rebase merge conflict

Refactor Router and RouterInterface to use Slim Dispatcher

c0132fa

Refactor RoutingMiddleware to use Slim Dispatcher

eaf27ed

Refactor Router tests to reference Slim Dispatcher

1156ae9

Rename & refactor RoutingMiddlewareTest to reference Slim Dispatcher

79fd2ef

Implement FastRoute test suite on Slim Dispatcher

05e3a9a

Fix DispatcherTest line length warning and increase test coverage

04f3816

Add url decoding functionality to getRouteArguments() method

Refactor routing middleware reflecting changes from slimphp#2398

ad2e7ce

Fix copyright year

Use rawurldecode() on URI before dispatching in Router

9c50cb9

Add allowed methods caching in Dispatcher Add test case for routes with international characters Add test case for international characters in route arguments

l0gicgate force-pushed the 4.x-DispatcherResults branch from 99144ab to 9c50cb9 Compare May 17, 2018 22:02

akrabat reviewed May 18, 2018

View reviewed changes

Fix dispatcher caching logic

10da1c4

akrabat approved these changes May 24, 2018

View reviewed changes

l0gicgate changed the title ~~4.x New Dispatcher & Dispatcher Results~~ 4.x New Dispatcher & Routing Results May 24, 2018

Rename DispatcherResults to RoutingResults

c58a2bb

akrabat merged commit c58a2bb into slimphp:4.x May 24, 2018

akrabat added a commit that referenced this pull request May 24, 2018

Update CHANGELOG for #2405

a553976

akrabat added a commit that referenced this pull request May 24, 2018

Merge branch 'l0gicgate-4.x-DispatcherResults' into 4.x

2bb40a7

Closes #2405 Fixes #2399

l0gicgate deleted the 4.x-DispatcherResults branch July 13, 2018 18:02

akrabat added this to the 4.0 milestone Aug 24, 2018

l0gicgate mentioned this pull request Apr 25, 2019

Slim 4 Alpha Release #2665

Merged

l0gicgate mentioned this pull request Aug 1, 2019

Slim 4 Release #2769

Merged

4.x New Dispatcher & Routing Results #2405

4.x New Dispatcher & Routing Results #2405

Conversation

l0gicgate commented Feb 23, 2018 • edited Loading

coveralls commented Feb 23, 2018 • edited Loading

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

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

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

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

damianopetrungaro commented May 17, 2018

l0gicgate commented May 17, 2018

damianopetrungaro commented May 17, 2018

akrabat commented May 18, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

damianopetrungaro commented May 24, 2018

l0gicgate commented Feb 23, 2018 •

edited

Loading

coveralls commented Feb 23, 2018 •

edited

Loading