<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[59457] trunk: REST API: Remove trailing slashes when preloading requests and there is a query string.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/59457">59457</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/59457","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>swissspidy</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-11-25 10:08:05 +0000 (Mon, 25 Nov 2024)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>REST API: Remove trailing slashes when preloading requests and there is a query string.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/51648">[51648]</a>, see <a href="https://core.trac.wordpress.org/ticket/51636">#51636</a>.
Props antonvlasenko, swissspidy, spacedmonkey.
Fixes <a href="https://core.trac.wordpress.org/ticket/57048">#57048</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiphp">trunk/src/wp-includes/rest-api.php</a></li>
<li><a href="#trunktestsphpunittestsrestapiphp">trunk/tests/phpunit/tests/rest-api.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrestapiphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/rest-api.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api.php 2024-11-24 18:35:44 UTC (rev 59456)
+++ trunk/src/wp-includes/rest-api.php 2024-11-25 10:08:05 UTC (rev 59457)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2935,6 +2935,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Remove trailing slashes at the end of the REST API path (query part).
</ins><span class="cx" style="display: block; padding: 0 10px"> $path = untrailingslashit( $path );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $path ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $path = '/';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2945,6 +2946,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $memo;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( isset( $path_parts['path'] ) && '/' !== $path_parts['path'] ) {
+ // Remove trailing slashes from the "path" part of the REST API path.
+ $path_parts['path'] = untrailingslashit( $path_parts['path'] );
+ $path = str_contains( $path, '?' ) ?
+ $path_parts['path'] . '?' . ( $path_parts['query'] ?? '' ) :
+ $path_parts['path'];
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $request = new WP_REST_Request( $method, $path_parts['path'] );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $path_parts['query'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> parse_str( $path_parts['query'], $query_params );
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapiphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/rest-api.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api.php 2024-11-24 18:35:44 UTC (rev 59456)
+++ trunk/tests/phpunit/tests/rest-api.php 2024-11-25 10:08:05 UTC (rev 59457)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -960,31 +960,47 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @dataProvider data_rest_preload_api_request_removes_trailing_slashes
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 51636
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 57048
+ *
+ * @param string $preload_path The path to preload.
+ * @param array|string $expected_preload_path Expected path after preloading.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function test_rest_preload_api_request_removes_trailing_slashes() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_rest_preload_api_request_removes_trailing_slashes( $preload_path, $expected_preload_path ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $rest_server = $GLOBALS['wp_rest_server'];
</span><span class="cx" style="display: block; padding: 0 10px"> $GLOBALS['wp_rest_server'] = null;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $preload_paths = array(
- '/wp/v2/types//',
- array( '/wp/v2/media///', 'OPTIONS' ),
- '////',
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $actual_preload_path = rest_preload_api_request( array(), $preload_path );
+ if ( '' !== $preload_path ) {
+ $actual_preload_path = key( $actual_preload_path );
+ }
+ $this->assertSame( $expected_preload_path, $actual_preload_path );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $preload_data = array_reduce(
- $preload_paths,
- 'rest_preload_api_request',
- array()
- );
-
- $this->assertSame( array_keys( $preload_data ), array( '/wp/v2/types', 'OPTIONS', '/' ) );
- $this->assertArrayHasKey( '/wp/v2/media', $preload_data['OPTIONS'] );
-
</del><span class="cx" style="display: block; padding: 0 10px"> $GLOBALS['wp_rest_server'] = $rest_server;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Data provider.
+ *
+ * @return array
+ */
+ public static function data_rest_preload_api_request_removes_trailing_slashes() {
+ return array(
+ 'no query part' => array( '/wp/v2/types//', '/wp/v2/types' ),
+ 'no query part, more slashes' => array( '/wp/v2/media///', '/wp/v2/media' ),
+ 'only slashes' => array( '////', '/' ),
+ 'empty path' => array( '', array() ),
+ 'no query parameters' => array( '/wp/v2/types//?////', '/wp/v2/types?' ),
+ 'no query parameters, with slashes' => array( '/wp/v2/types//?fields////', '/wp/v2/types?fields' ),
+ 'query parameters with no values' => array( '/wp/v2/types//?fields=////', '/wp/v2/types?fields=' ),
+ 'single query parameter' => array( '/wp/v2/types//?_fields=foo,bar////', '/wp/v2/types?_fields=foo,bar' ),
+ 'multiple query parameters' => array( '/wp/v2/types////?_fields=foo,bar&limit=1000////', '/wp/v2/types?_fields=foo,bar&limit=1000' ),
+ );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 40614
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_rest_ensure_request_accepts_path_string() {
</span></span></pre>
</div>
</div>
</body>
</html>