Context Navigation

Back to Ticket #39473

Ticket #39473: 39473.diff

File 39473.diff, 3.8 KB (added by motylanogha, 4 months ago)
Refreshed patch for current trunk with route map caching and 4 unit tests. Cache is invalidated on register_route(). All 1052 REST API tests pass

src/wp-includes/rest-api/class-wp-rest-server.php

diff --git a/src/wp-includes/rest-api/class-wp-rest-server.php b/src/wp-includes/rest-api/class-wp-rest-server.php
index dbf605523d..ff03765b43 100644

a	b	class WP_REST_Server {
87	87	*/
88	88	protected $embed_cache = array();
89	89
	90	/**
	91	* Cached route maps keyed by namespace.
	92	*
	93	* @since 6.9.0
	94	* @var array
	95	*/
	96	protected $route_map_cache = array();
	97
90	98	/**
91	99	* Stores request objects that are currently being handled.
92	100	*
…	…	class WP_REST_Server {
924	932	} else {
925	933	$this->endpoints[ $route ] = array_merge( $this->endpoints[ $route ], $route_args );
926	934	}
	935
	936	// Invalidate the route map cache when routes change.
	937	$this->route_map_cache = array();
927	938	}
928	939
929	940	/**
…	…	class WP_REST_Server {
949	960	* `'/path/regex' => array( array( $callback, $bitmask ), ...)`.
950	961	*/
951	962	public function get_routes( $route_namespace = '' ) {
	963	$cache_key = $route_namespace ? $route_namespace : '';
	964
	965	if ( isset( $this->route_map_cache[ $cache_key ] ) ) {
	966	return $this->route_map_cache[ $cache_key ];
	967	}
	968
952	969	$endpoints = $this->endpoints;
953	970
954	971	if ( $route_namespace ) {
…	…	class WP_REST_Server {
1016	1033	}
1017	1034	}
1018	1035
	1036	$this->route_map_cache[ $cache_key ] = $endpoints;
	1037
1019	1038	return $endpoints;
1020	1039	}
1021	1040

tests/phpunit/tests/rest-api/rest-server.php

diff --git a/tests/phpunit/tests/rest-api/rest-server.php b/tests/phpunit/tests/rest-api/rest-server.php
index 57b7bbb38a..92770e5c04 100644

                class Tests_REST_Server extends WP_Test_REST_TestCase {
                 $this->assertSame( 204, $response->get_status(), '/test-ns/v1/test' );
+        }
+        /**
+         * @ticket 39473
+         */
+        public function test_get_routes_caches_result() {
+                $filter_count = 0;
+                $counting_filter = static function ( $endpoints ) use ( &$filter_count ) {
+                        ++$filter_count;
+                        return $endpoints;
+                };
+                add_filter( 'rest_endpoints', $counting_filter );
+                $server = rest_get_server();
+                $server->get_routes();
+                $server->get_routes();
+                $server->get_routes();
+                remove_filter( 'rest_endpoints', $counting_filter );
+                $this->assertSame( 1, $filter_count, 'The rest_endpoints filter should only fire once when get_routes() is called multiple times.' );
+        }
+        /**
+         * @ticket 39473
+         */
+        public function test_get_routes_cache_is_keyed_by_namespace() {
+                $server = rest_get_server();
+                $all_routes       = $server->get_routes();
+                $namespaced_routes = $server->get_routes( 'oembed/1.0' );
+                $this->assertNotEquals( $all_routes, $namespaced_routes, 'Cached routes for different namespaces should differ.' );
+                foreach ( $namespaced_routes as $route => $handlers ) {
+                        $this->assertStringStartsWith( '/oembed/1.0', $route );
+                }
+        }
+        /**
+         * @ticket 39473
+         */
+        public function test_get_routes_cache_invalidated_on_register() {
+                $server = rest_get_server();
+                $routes_before = $server->get_routes();
+                register_rest_route(
+                        'test-cache-ns',
+                        '/test-cache',
+                        array(
+                                'methods'             => array( 'GET' ),
+                                'callback'            => '__return_true',
+                                'permission_callback' => '__return_true',
+                        )
+                );
+                $routes_after = $server->get_routes();
+                $this->assertArrayNotHasKey( '/test-cache-ns/test-cache', $routes_before );
+                $this->assertArrayHasKey( '/test-cache-ns/test-cache', $routes_after );
+        }
+        /**
+         * @ticket 39473
+         */
+        public function test_get_routes_cached_result_matches_uncached() {
+                $server = rest_get_server();
+                // First call populates cache.
+                $first_call = $server->get_routes();
+                // Second call returns from cache.
+                $second_call = $server->get_routes();
+                $this->assertSame( $first_call, $second_call, 'Cached routes should be identical to the initial result.' );
+        }
         /**
          * @ticket 50244
          */

Download in other formats:

Original Format

Make WordPress Core

Context Navigation

Ticket #39473: 39473.diff

src/wp-includes/rest-api/class-wp-rest-server.php

tests/phpunit/tests/rest-api/rest-server.php

Download in other formats: