Merge pull request #9064 from kenjis/fix-route-group-filters

fix: filters passed to the ``$routes->group()`` are not merged into the filters passed to the inner routes
codeigniter4 · Jul 26, 2024 · f18b8f2 · f18b8f2
2 parents 3e88f85 + e580856
commit f18b8f2
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 0 deletions.
diff --git a/system/Router/RouteCollection.php b/system/Router/RouteCollection.php
@@ -1456,6 +1456,12 @@ protected function create(string $verb, string $from, $to, ?array $options = nul
  $to = $this->processArrayCallableSyntax($from, $to);
  }
 
+ // Merge group filters.
+ if (isset($options['filter'])) {
+ $currentFilter = (array) ($this->currentOptions['filter'] ?? []);
+ $options['filter'] = array_merge($currentFilter, (array) $options['filter']);
+ }
+
  $options = array_merge($this->currentOptions ?? [], $options ?? []);
 
  // Route priority detect

diff --git a/tests/system/Router/RouteCollectionTest.php b/tests/system/Router/RouteCollectionTest.php
@@ -440,6 +440,22 @@ static function ($routes): void {
  $this->assertSame($expected, $routes->getRoutesOptions());
  }
 
+ public function testGroupFilterAndRouteFilter(): void
+ {
+ $routes = $this->getCollector();
+
+ $routes->group('admin', ['filter' => ['csrf']], static function ($routes): void {
+ $routes->get('profile', 'Admin\Profile::index', ['filter' => ['honeypot']]);
+ });
+
+ $expected = [
+ 'admin/profile' => [
+ 'filter' => ['csrf', 'honeypot'],
+ ],
+ ];
+ $this->assertSame($expected, $routes->getRoutesOptions());
+ }
+
  public function testGroupingWorksWithEmptyStringPrefix(): void
  {
  $routes = $this->getCollector();

diff --git a/user_guide_src/source/changelogs/v4.5.4.rst b/user_guide_src/source/changelogs/v4.5.4.rst
@@ -30,6 +30,8 @@ Deprecations
 Bugs Fixed
 **********
 
+- **Routing:** Fixed a bug that filters passed to ``$routes->group()`` were not
+ merged into filters passed to the inner routes.
 - **CURLRequest:** Fixed a bug preventing the use of strings for ``version`` in the config array
  when making requests.
 

diff --git a/user_guide_src/source/incoming/routing.rst b/user_guide_src/source/incoming/routing.rst
@@ -564,6 +564,9 @@ run the filter before or after the controller. This is especially handy during a
 
 The value for the filter must match one of the aliases defined within **app/Config/Filters.php**.
 
+.. note:: Prior to v4.5.4, due to a bug, filters passed to the ``group()`` were
+ not merged into the filters passed to the inner routes.
+
 Setting Other Options
 =====================