Skip to content

fix: [Auto Routing Improved] feature testing may not find controller/method #7543

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions rector.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
use Rector\CodingStyle\Rector\ClassMethod\MakeInheritedMethodVisibilitySameAsParentRector;
use Rector\CodingStyle\Rector\FuncCall\CountArrayToEmptyArrayComparisonRector;
use Rector\Config\RectorConfig;
use Rector\DeadCode\Rector\ClassMethod\RemoveUnusedConstructorParamRector;
use Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector;
use Rector\DeadCode\Rector\If_\UnwrapFutureCompatibleIfPhpVersionRector;
use Rector\DeadCode\Rector\MethodCall\RemoveEmptyMethodCallRector;
Expand Down Expand Up @@ -88,6 +89,11 @@
__DIR__ . '/tests/system/Test/ReflectionHelperTest.php',
],

RemoveUnusedConstructorParamRector::class => [
// @TODO remove if deprecated $httpVerb is removed
__DIR__ . '/system/Router/AutoRouterImproved.php',
],

// call on purpose for nothing happen check
RemoveEmptyMethodCallRector::class => [
__DIR__ . '/tests',
Expand Down
2 changes: 1 addition & 1 deletion system/Router/AutoRouter.php
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ public function __construct(
*
* @return array [directory_name, controller_name, controller_method, params]
*/
public function getRoute(string $uri): array
public function getRoute(string $uri, string $httpVerb): array
{
$segments = explode('/', $uri);

Expand Down
24 changes: 11 additions & 13 deletions system/Router/AutoRouterImproved.php
Original file line number Diff line number Diff line change
Expand Up @@ -58,11 +58,6 @@ final class AutoRouterImproved implements AutoRouterInterface
*/
private bool $translateURIDashes;

/**
* HTTP verb for the request.
*/
private string $httpVerb;

/**
* The namespace for controllers.
*/
Expand All @@ -74,15 +69,17 @@ final class AutoRouterImproved implements AutoRouterInterface
private string $defaultController;

/**
* The name of the default method
* The name of the default method without HTTP verb prefix.
*/
private string $defaultMethod;

/**
* @param class-string[] $protectedControllers
* @param string $defaultController Short classname
*
* @deprecated $httpVerb is deprecated. No longer used.
*/
public function __construct(
public function __construct(// @phpstan-ignore-line
array $protectedControllers,
string $namespace,
string $defaultController,
Expand All @@ -93,22 +90,23 @@ public function __construct(
$this->protectedControllers = $protectedControllers;
$this->namespace = rtrim($namespace, '\\') . '\\';
$this->translateURIDashes = $translateURIDashes;
$this->httpVerb = $httpVerb;
$this->defaultController = $defaultController;
$this->defaultMethod = $httpVerb . ucfirst($defaultMethod);
$this->defaultMethod = $defaultMethod;

// Set the default values
$this->controller = $this->defaultController;
$this->method = $this->defaultMethod;
}

/**
* Finds controller, method and params from the URI.
*
* @return array [directory_name, controller_name, controller_method, params]
*/
public function getRoute(string $uri): array
public function getRoute(string $uri, string $httpVerb): array
{
$defaultMethod = strtolower($httpVerb) . ucfirst($this->defaultMethod);
$this->method = $defaultMethod;

$segments = explode('/', $uri);

// WARNING: Directories get shifted out of the segments array.
Expand Down Expand Up @@ -144,10 +142,10 @@ public function getRoute(string $uri): array
$methodSegment = $this->translateURIDashes(array_shift($nonDirSegments));

// Prefix HTTP verb
$this->method = $this->httpVerb . ucfirst($methodSegment);
$this->method = $httpVerb . ucfirst($methodSegment);

// Prevent access to default method path
if (strtolower($this->method) === strtolower($this->defaultMethod)) {
if (strtolower($this->method) === strtolower($defaultMethod)) {
throw new PageNotFoundException(
'Cannot access the default method "' . $this->method . '" with the method name URI path.'
);
Expand Down
2 changes: 1 addition & 1 deletion system/Router/AutoRouterInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@ interface AutoRouterInterface
*
* @return array [directory_name, controller_name, controller_method, params]
*/
public function getRoute(string $uri): array;
public function getRoute(string $uri, string $httpVerb): array;
}
6 changes: 4 additions & 2 deletions system/Router/RouteCollection.php
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ class RouteCollection implements RouteCollectionInterface
/**
* The current method that the script is being called by.
*
* @var string
* @var string HTTP verb (lower case) like `get`,`post` or `*`
*/
protected $HTTPVerb = '*';

Expand Down Expand Up @@ -550,11 +550,13 @@ public function getHTTPVerb(): string
* Sets the current HTTP verb.
* Used primarily for testing.
*
* @param string $verb HTTP verb
*
* @return $this
*/
public function setHTTPVerb(string $verb)
{
$this->HTTPVerb = $verb;
$this->HTTPVerb = strtolower($verb);

return $this;
}
Expand Down
4 changes: 2 additions & 2 deletions system/Router/Router.php
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ public function __construct(RouteCollectionInterface $routes, ?Request $request
$this->controller = $this->collection->getDefaultController();
$this->method = $this->collection->getDefaultMethod();

$this->collection->setHTTPVerb(strtolower($request->getMethod() ?? $_SERVER['REQUEST_METHOD']));
$this->collection->setHTTPVerb($request->getMethod() ?? $_SERVER['REQUEST_METHOD']);

$this->translateURIDashes = $this->collection->shouldTranslateURIDashes();

Expand Down Expand Up @@ -504,7 +504,7 @@ protected function checkRoutes(string $uri): bool
public function autoRoute(string $uri)
{
[$this->directory, $this->controller, $this->method, $this->params]
= $this->autoRouter->getRoute($uri);
= $this->autoRouter->getRoute($uri, $this->collection->getHTTPVerb());
}

/**
Expand Down
36 changes: 18 additions & 18 deletions tests/system/Router/AutoRouterImprovedTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ public function testAutoRouteFindsDefaultControllerAndMethodGet()
$router = $this->createNewAutoRouter();

[$directory, $controller, $method, $params]
= $router->getRoute('/');
= $router->getRoute('/', 'get');

$this->assertNull($directory);
$this->assertSame('\\' . Index::class, $controller);
Expand All @@ -72,7 +72,7 @@ public function testAutoRouteFindsDefaultControllerAndMethodPost()
$router = $this->createNewAutoRouter('post');

[$directory, $controller, $method, $params]
= $router->getRoute('/');
= $router->getRoute('/', 'post');

$this->assertNull($directory);
$this->assertSame('\\' . Index::class, $controller);
Expand All @@ -85,7 +85,7 @@ public function testAutoRouteFindsControllerWithFileAndMethod()
$router = $this->createNewAutoRouter();

[$directory, $controller, $method, $params]
= $router->getRoute('mycontroller/somemethod');
= $router->getRoute('mycontroller/somemethod', 'get');

$this->assertNull($directory);
$this->assertSame('\\' . Mycontroller::class, $controller);
Expand All @@ -98,7 +98,7 @@ public function testFindsControllerAndMethodAndParam()
$router = $this->createNewAutoRouter();

[$directory, $controller, $method, $params]
= $router->getRoute('mycontroller/somemethod/a');
= $router->getRoute('mycontroller/somemethod/a', 'get');

$this->assertNull($directory);
$this->assertSame('\\' . Mycontroller::class, $controller);
Expand All @@ -115,15 +115,15 @@ public function testUriParamCountIsGreaterThanMethodParams()

$router = $this->createNewAutoRouter();

$router->getRoute('mycontroller/somemethod/a/b');
$router->getRoute('mycontroller/somemethod/a/b', 'get');
}

public function testAutoRouteFindsControllerWithFile()
{
$router = $this->createNewAutoRouter();

[$directory, $controller, $method, $params]
= $router->getRoute('mycontroller');
= $router->getRoute('mycontroller', 'get');

$this->assertNull($directory);
$this->assertSame('\\' . Mycontroller::class, $controller);
Expand All @@ -136,7 +136,7 @@ public function testAutoRouteFindsControllerWithSubfolder()
$router = $this->createNewAutoRouter();

[$directory, $controller, $method, $params]
= $router->getRoute('subfolder/mycontroller/somemethod');
= $router->getRoute('subfolder/mycontroller/somemethod', 'get');

$this->assertSame('Subfolder/', $directory);
$this->assertSame('\\' . \CodeIgniter\Router\Controllers\Subfolder\Mycontroller::class, $controller);
Expand All @@ -149,7 +149,7 @@ public function testAutoRouteFindsDashedSubfolder()
$router = $this->createNewAutoRouter();

[$directory, $controller, $method, $params]
= $router->getRoute('dash-folder/mycontroller/somemethod');
= $router->getRoute('dash-folder/mycontroller/somemethod', 'get');

$this->assertSame('Dash_folder/', $directory);
$this->assertSame(
Expand All @@ -165,7 +165,7 @@ public function testAutoRouteFindsDashedController()
$router = $this->createNewAutoRouter();

[$directory, $controller, $method, $params]
= $router->getRoute('dash-folder/dash-controller/somemethod');
= $router->getRoute('dash-folder/dash-controller/somemethod', 'get');

$this->assertSame('Dash_folder/', $directory);
$this->assertSame('\\' . Dash_controller::class, $controller);
Expand All @@ -178,7 +178,7 @@ public function testAutoRouteFindsDashedMethod()
$router = $this->createNewAutoRouter();

[$directory, $controller, $method, $params]
= $router->getRoute('dash-folder/dash-controller/dash-method');
= $router->getRoute('dash-folder/dash-controller/dash-method', 'get');

$this->assertSame('Dash_folder/', $directory);
$this->assertSame('\\' . Dash_controller::class, $controller);
Expand All @@ -191,7 +191,7 @@ public function testAutoRouteFindsDefaultDashFolder()
$router = $this->createNewAutoRouter();

[$directory, $controller, $method, $params]
= $router->getRoute('dash-folder');
= $router->getRoute('dash-folder', 'get');

$this->assertSame('Dash_folder/', $directory);
$this->assertSame('\\' . Home::class, $controller);
Expand All @@ -205,7 +205,7 @@ public function testAutoRouteRejectsSingleDot()

$router = $this->createNewAutoRouter();

$router->getRoute('.');
$router->getRoute('.', 'get');
}

public function testAutoRouteRejectsDoubleDot()
Expand All @@ -214,7 +214,7 @@ public function testAutoRouteRejectsDoubleDot()

$router = $this->createNewAutoRouter();

$router->getRoute('..');
$router->getRoute('..', 'get');
}

public function testAutoRouteRejectsMidDot()
Expand All @@ -223,7 +223,7 @@ public function testAutoRouteRejectsMidDot()

$router = $this->createNewAutoRouter();

$router->getRoute('foo.bar');
$router->getRoute('foo.bar', 'get');
}

public function testRejectsDefaultControllerPath()
Expand All @@ -232,7 +232,7 @@ public function testRejectsDefaultControllerPath()

$router = $this->createNewAutoRouter();

$router->getRoute('home');
$router->getRoute('home', 'get');
}

public function testRejectsDefaultControllerAndDefaultMethodPath()
Expand All @@ -241,7 +241,7 @@ public function testRejectsDefaultControllerAndDefaultMethodPath()

$router = $this->createNewAutoRouter();

$router->getRoute('home/index');
$router->getRoute('home/index', 'get');
}

public function testRejectsDefaultMethodPath()
Expand All @@ -250,7 +250,7 @@ public function testRejectsDefaultMethodPath()

$router = $this->createNewAutoRouter();

$router->getRoute('mycontroller/index');
$router->getRoute('mycontroller/index', 'get');
}

public function testRejectsControllerWithRemapMethod()
Expand All @@ -262,6 +262,6 @@ public function testRejectsControllerWithRemapMethod()

$router = $this->createNewAutoRouter();

$router->getRoute('remap/test');
$router->getRoute('remap/test', 'get');
}
}
75 changes: 75 additions & 0 deletions tests/system/Test/FeatureTestAutoRoutingImprovedTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
<?php

/**
* This file is part of CodeIgniter 4 framework.
*
* (c) CodeIgniter Foundation <[email protected]>
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/

namespace CodeIgniter\Test;

use CodeIgniter\Events\Events;
use Config\Feature;
use Config\Services;

/**
* @group Others
*
* @internal
*/
final class FeatureTestAutoRoutingImprovedTest extends CIUnitTestCase
{
use FeatureTestTrait;

public static function setUpBeforeClass(): void
{
parent::setUpBeforeClass();

Events::simulate(true);

self::initializeRouter();
}

public static function tearDownAfterClass(): void
{
parent::tearDownAfterClass();

Events::simulate(false);

Services::reset();
}

private static function initializeRouter(): void
{
$routes = Services::routes();
$routes->resetRoutes();
$routes->loadRoutes();

$routes->setAutoRoute(true);
config(Feature::class)->autoRoutesImproved = true;

$namespace = 'Tests\Support\Controllers';
$routes->setDefaultNamespace($namespace);

$router = Services::router($routes);

Services::injectMock('router', $router);
}

public function testCallGet()
{
$response = $this->get('newautorouting');

$response->assertSee('Hello');
}

public function testCallPost()
{
$response = $this->post('newautorouting/save/1/a/b');

$response->assertSee('Saved');
}
}
Loading