Bug: [Command] `spark routes` for routes containing `{locale}` return unknown filters

[neznaika0]

PHP Version

8.2

CodeIgniter4 Version

4.4.1

CodeIgniter4 Installation Method

Git

Which operating systems have you tested for this bug?

Linux

Which server did you use?

cli-server (PHP built-in webserver)

What happened?

When using placeholder {locale} in Config/Routes.php and $routes->useSupportedLocalesOnly(true), the spark routes command does not output the required result.

// Home page with locale
$routes->get('{locale}/', 'Home::index', ['as' => 'homepage']);

// Home page without locale
$routes->get('/', 'Home::index', ['as' => 'default_homepage']);

Behavior before (<unknown>):

$ ./spark routes

CodeIgniter v4.4.1 Command Line Tool - Server Time: 2023-10-01 10:52:23 UTC+03:00

+--------+-----------------------------+--------------------+-------------------------------------+----------------+---------------+
| Method | Route                       | Name               | Handler                             | Before Filters | After Filters |
+--------+-----------------------------+--------------------+-------------------------------------+----------------+---------------+
| GET    | {locale}                    | homepage           | \App\Controllers\Home::index        | <unknown>      | <unknown>     |
| GET    | /                           | default_homepage   | \App\Controllers\Home::index        | csrf           |               |
+--------+-----------------------------+--------------------+-------------------------------------+----------------+---------------+

Expected:

$ ./spark routes

CodeIgniter v4.4.1 Command Line Tool - Server Time: 2023-10-01 10:52:23 UTC+03:00

+--------+-----------------------------+--------------------+-------------------------------------+----------------+---------------+
| Method | Route                       | Name               | Handler                             | Before Filters | After Filters |
+--------+-----------------------------+--------------------+-------------------------------------+----------------+---------------+
| GET    | {locale}                    | homepage           | \App\Controllers\Home::index        | csrf           |               |
| GET    | /                           | default_homepage   | \App\Controllers\Home::index        | csrf           |               |
+--------+-----------------------------+--------------------+-------------------------------------+----------------+---------------+

Anything else?

I think the solution should be here

CodeIgniter4/system/Router/Router.php

Lines 439 to 457 in 0cd3993

	// Store our locale so CodeIgniter object can
	// assign it to the Request.
	if (strpos($matchedKey, '{locale}') !== false) {
	preg_match(
	'#^' . str_replace('{locale}', '(?<locale>[^/]+)', $matchedKey) . '$#u',
	$uri,
	$matched
	);
	if ($this->collection->shouldUseSupportedLocalesOnly()
	&& ! in_array($matched['locale'], config(App::class)->supportedLocales, true)) {
	// Throw exception to prevent the autorouter, if enabled,
	// from trying to find a route
	throw PageNotFoundException::forLocaleNotSupported($matched['locale']);
	}
	$this->detectedLocale = $matched['locale'];
	unset($matched);
	}

CodeIgniter4/system/Commands/Utilities/Routes.php

Lines 120 to 122 in 0cd3993

	foreach ($definedRouteCollector->collect() as $route) {
	$sampleUri = $uriGenerator->get($route['route']);
	$filters = $filterCollector->get($route['method'], $sampleUri);

During the execution of the command, we get a route. Because {locale} will not be in the allowed

// Route
array(4) {
  'method' =>
  string(3) "get"
  'route' =>
  string(13) "{locale}"
  'name' =>
  string(13) "homepage"
  'handler' =>
  string(28) "\App\Controllers\Home::index"
}

// sample URI
string(8) "{locale}"

[kenjis]

This is a known limitation when a route is defined with regex.
If you can fix it, feel free to send a PR.

[neznaika0]

I have not yet figured out how to separate the command from the working routing. I think it's doable

[kenjis]

However, this is not simple.
This is because a route containing a regular expression may not uniquely determine the filters to be applied.

In the case of locales, the locales are determined when excluding unsupported locales. However, if, for example, a global filter excludes only a specific locale, the filters applied will be different only for that locale.

The worst case scenario is that the filters displayed in spark routes may not actually be applied.
I think it is better to show <unknown> than that.

[neznaika0]

Then the command becomes useless. Especially when ~100 routes have a locale

EDIT: Now I see one problem with this: If the filter excludes /fr/home, but allows /en/home. Can we add details like !csrf !toolbar, if presumably the filter doesn't work for all routes?

[kenjis]

If the filter excludes /fr/home, but allows /en/home. Can we add details like !csrf !toolbar, if presumably the filter doesn't work for all routes?

It may be a solution. At least, !csrf toolbar is better than <unknown>.

[kenjis]

Sorry, I did not understand what was the issue.
$routes->useSupportedLocalesOnly(true) changes the output.
This is a bug.

--- a/app/Config/Routes.php
+++ b/app/Config/Routes.php
@@ -5,4 +5,6 @@ use CodeIgniter\Router\RouteCollection;
 /**
  * @var RouteCollection $routes
  */
-$routes->get('/', 'Home::index');
+$routes->useSupportedLocalesOnly(false);
+$routes->get('/', 'Home::index', ['as' => 'default_homepage']);
+$routes->get('{locale}/', 'Home::index', ['as' => 'homepage']);

$ php spark routes

CodeIgniter v4.4.3 Command Line Tool - Server Time: 2023-11-07 11:23:54 UTC+00:00

+--------+----------+------------------+------------------------------+----------------+---------------+
| Method | Route    | Name             | Handler                      | Before Filters | After Filters |
+--------+----------+------------------+------------------------------+----------------+---------------+
| GET    | /        | default_homepage | \App\Controllers\Home::index |                | toolbar       |
| GET    | {locale} | homepage         | \App\Controllers\Home::index |                | toolbar       |
+--------+----------+------------------+------------------------------+----------------+---------------+

--- a/app/Config/Routes.php
+++ b/app/Config/Routes.php
@@ -5,4 +5,6 @@ use CodeIgniter\Router\RouteCollection;
 /**
  * @var RouteCollection $routes
  */
-$routes->get('/', 'Home::index');
+$routes->useSupportedLocalesOnly(true);
+$routes->get('/', 'Home::index', ['as' => 'default_homepage']);
+$routes->get('{locale}/', 'Home::index', ['as' => 'homepage']);

$ php spark routes

CodeIgniter v4.4.3 Command Line Tool - Server Time: 2023-11-07 11:24:24 UTC+00:00

+--------+----------+------------------+------------------------------+----------------+---------------+
| Method | Route    | Name             | Handler                      | Before Filters | After Filters |
+--------+----------+------------------+------------------------------+----------------+---------------+
| GET    | /        | default_homepage | \App\Controllers\Home::index |                | toolbar       |
| GET    | {locale} | homepage         | \App\Controllers\Home::index | <unknown>      | <unknown>     |
+--------+----------+------------------+------------------------------+----------------+---------------+

[kenjis]

I sent a PR #8167 to fix this.