REST API: Fix namespace shadowing issue in route matching logic.

kadamwhite · kadamwhite · commit 4e18f78ced78 · 2020-02-24T18:05:12.000Z
Following [47260] a namespace such as "test-ns" prevents any namespace such as "test-ns/v1" from being found when matching routes. While not best practice, this was an unintentional back-compat break; this patch restores the original behavior. Props david.binda, TimothyBlynJacobs. Fixes #48530. git-svn-id: https://develop.svn.wordpress.org/trunk@47351 602fd350-edb4-49c9-b593-d223f7449a82
diff --git a/src/wp-includes/rest-api/class-wp-rest-server.php b/src/wp-includes/rest-api/class-wp-rest-server.php
@@ -879,16 +879,17 @@ public function dispatch( $request ) {
 		$method = $request->get_method();
 		$path   = $request->get_route();
 
-		$routes = array();
+		$with_namespace = array();
 
 		foreach ( $this->get_namespaces() as $namespace ) {
-			if ( 0 === strpos( ltrim( $path, '/' ), $namespace ) ) {
-				$routes = $this->get_routes( $namespace );
-				break;
+			if ( 0 === strpos( trailingslashit( ltrim( $path, '/' ) ), $namespace ) ) {
+				$with_namespace[] = $this->get_routes( $namespace );
 			}
 		}
 
-		if ( ! $routes ) {
+		if ( $with_namespace ) {
+			$routes = array_merge( ...$with_namespace );
+		} else {
 			$routes = $this->get_routes();
 		}
 
diff --git a/tests/phpunit/tests/rest-api/rest-server.php b/tests/phpunit/tests/rest-api/rest-server.php
@@ -1465,6 +1465,37 @@ public function test_get_routes_respects_namespace_parameter() {
 		}
 	}
 
+	/**
+	 * @ticket 48530
+	 */
+	public function test_get_routes_no_namespace_overriding() {
+		register_rest_route(
+			'test-ns',
+			'/test',
+			array(
+				'methods'  => array( 'GET' ),
+				'callback' => function() {
+					return new WP_REST_Response( 'data', 204 );
+				},
+			)
+		);
+		register_rest_route(
+			'test-ns/v1',
+			'/test',
+			array(
+				'methods'  => array( 'GET' ),
+				'callback' => function() {
+					return new WP_REST_Response( 'data', 204 );
+				},
+			)
+		);
+
+		$request  = new WP_REST_Request( 'GET', '/test-ns/v1/test' );
+		$response = rest_get_server()->dispatch( $request );
+
+		$this->assertEquals( 204, $response->get_status(), '/test-ns/v1/test' );
+	}
+
 	public function _validate_as_integer_123( $value, $request, $key ) {
 		if ( ! is_int( $value ) ) {
 			return new WP_Error( 'some-error', 'This is not valid!' );

Original file line number	Diff line number	Diff line change
`@@ -879,16 +879,17 @@ public function dispatch( $request ) {`
`879`	`879`	`$method = $request->get_method();`
`880`	`880`	`$path = $request->get_route();`
`881`	`881`
`882`		`- $routes = array();`
	`882`	`+ $with_namespace = array();`
`883`	`883`
`884`	`884`	`foreach ( $this->get_namespaces() as $namespace ) {`
`885`		`- if ( 0 === strpos( ltrim( $path, '/' ), $namespace ) ) {`
`886`		`- $routes = $this->get_routes( $namespace );`
`887`		`- break;`
	`885`	`+ if ( 0 === strpos( trailingslashit( ltrim( $path, '/' ) ), $namespace ) ) {`
	`886`	`+ $with_namespace[] = $this->get_routes( $namespace );`
`888`	`887`	`}`
`889`	`888`	`}`
`890`	`889`
`891`		`- if ( ! $routes ) {`
	`890`	`+ if ( $with_namespace ) {`
	`891`	`+ $routes = array_merge( ...$with_namespace );`
	`892`	`+ } else {`
`892`	`893`	`$routes = $this->get_routes();`
`893`	`894`	`}`
`894`	`895`