<!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>[10572] sites/trunk/api.wordpress.org/public_html/patterns/1.0: Pattern API: Use `search` param instead of `/search` endpoint.</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="http://meta.trac.wordpress.org/changeset/10572">10572</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/10572","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>iandunn</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-01-12 21:30:56 +0000 (Tue, 12 Jan 2021)</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'>Pattern API: Use `search` param instead of `/search` endpoint.
Only one post type is being searched, so this is much simpler.
See https://github.com/WordPress/gutenberg/pull/26578#issuecomment-745032557</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkapiwordpressorgpublic_htmlpatterns10indexphp">sites/trunk/api.wordpress.org/public_html/patterns/1.0/index.php</a></li>
<li><a href="#sitestrunkapiwordpressorgpublic_htmlpatterns10teststestindexphp">sites/trunk/api.wordpress.org/public_html/patterns/1.0/tests/test-index.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkapiwordpressorgpublic_htmlpatterns10indexphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/api.wordpress.org/public_html/patterns/1.0/index.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/api.wordpress.org/public_html/patterns/1.0/index.php 2021-01-12 06:20:20 UTC (rev 10571)
+++ sites/trunk/api.wordpress.org/public_html/patterns/1.0/index.php 2021-01-12 21:30:56 UTC (rev 10572)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -7,16 +7,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * do any any object caching.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * todo
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * publish caching sysreq once query args settled, etc -- https://make.wordpress.org/systems/wp-admin/post.php?post=1788&action=edit
- *
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * - publish caching sysreq once query args settled, etc -- https://make.wordpress.org/systems/wp-admin/post.php?post=1788&action=edit
+ * - add docs to codex
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
-/*
- * @todo
- *
- */
-
</del><span class="cx" style="display: block; padding: 0 10px"> main( $_SERVER['QUERY_STRING'] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -23,7 +17,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Proxy w.org/patterns API endpoints for reliability.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Core needs to send requests to api.w.org, because it has more resources and better caching than w.org.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Core clients need to send requests to api.w.org, because it has more resources and better caching than w.org.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $query_string
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -30,43 +24,28 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function main( $query_string ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $api_url_base = 'https://wordpress.org/patterns/wp-json';
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_init_query = true;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $endpoint = '/wp/v2/wporg-pattern';
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * Core clients should pass params for the desired action:
+ *
+ * @example Browse all: `/patterns/1.0/`
+ * @example Browse a category: `/patterns/1.0/?pattern-categories={id}`
+ * @example Search: `/patterns/1.0/?search={query}`
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> parse_str( $query_string, $query_args );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- switch ( $query_args['action'] ) {
- // List all patterns, or all with in category.
- // To restrict to a category, the client needs to provide `pattern-categories={id}` param.
- default:
- case 'get_patterns':
- $endpoint = '/wp/v2/wporg-pattern';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * Filter the returned fields down to only the ones Core uses.
+ *
+ * `_links` is necessary for `wp:term` to be embedded, see https://core.trac.wordpress.org/ticket/49985.
+ * Related https://core.trac.wordpress.org/ticket/49538.
+ */
+ $query_args['_fields'] = 'id,title,content,meta,_links';
+ $query_args['_embed'] = 'wp:term';
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // `_links` is a workaround for https://core.trac.wordpress.org/ticket/49985. Related https://core.trac.wordpress.org/ticket/49538.
- $query_args['_fields'] = 'id,title,content,meta,_links';
- $query_args['_embed'] = 'wp:term';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $wp_init_host = $api_url_base . $endpoint . '?' . urldecode( http_build_query( $query_args ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- break;
-
- // Search patterns.
- // Client needs to provide `search={string}` param.
- case 'query_patterns':
- $endpoint = '/wp/v2/search';
- $query_args['subtype'] = 'wporg-pattern';
-
- // `_links` is a workaround for https://core.trac.wordpress.org/ticket/49985. Related https://core.trac.wordpress.org/ticket/49538.
- $query_args['_fields'] = '_links';
- $query_args['_embed'] = 'self';
-
- break;
- }
-
- unset( $query_args['action'] );
-
- $wp_init_host = $api_url_base . $endpoint;
-
- if ( $query_args ) {
- $wp_init_host .= '?' . urldecode( http_build_query( $query_args ) );
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> // Load WordPress to process the request and output the response.
</span><span class="cx" style="display: block; padding: 0 10px"> require_once dirname( dirname( __DIR__ ) ) . '/wp-init.php';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="sitestrunkapiwordpressorgpublic_htmlpatterns10teststestindexphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/api.wordpress.org/public_html/patterns/1.0/tests/test-index.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/api.wordpress.org/public_html/patterns/1.0/tests/test-index.php 2021-01-12 06:20:20 UTC (rev 10571)
+++ sites/trunk/api.wordpress.org/public_html/patterns/1.0/tests/test-index.php 2021-01-12 21:30:56 UTC (rev 10572)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -39,16 +39,120 @@
</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">+ * Asserts that an HTTP response is valid and contains a pattern.
+ *
+ * @param Requests_Response $response
+ */
+ public function assertResponseHasPattern( $response ) {
+ $patterns = json_decode( $response->body );
+
+ $this->assertSame( 200, $response->status_code );
+ $this->assertIsString( $patterns[0]->title->rendered );
+ $this->assertIsInt( $patterns[0]->meta->wpop_viewport_width );
+ }
+
+ /**
+ * Pluck term IDs from a list of patterns.
+ *
+ * @param object[] $patterns
+ *
+ * @return int[]
+ */
+ public function get_term_ids( $patterns ) {
+ $term_ids = array();
+
+ foreach ( $patterns as $pattern ) {
+ $term_ids = array_merge(
+ $term_ids,
+ array_column( $pattern->_embedded->{'wp:term'}[0], 'id' )
+ );
+ }
+
+ return array_unique( $term_ids );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @covers ::main()
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @group e2e
</span><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_get_all_patterns() : void {
- $response = $this->send_request( '/?action=get_patterns' );
- $body = json_decode( $response->body );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_browse_all_patterns() : void {
+ $response = $this->send_request( '/' );
+ $patterns = json_decode( $response->body );
+ $term_ids = $this->get_term_ids( $patterns );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertSame( 200, $response->status_code );
- $this->assertIsString( $body[0]->title->rendered );
- $this->assertIsInt( $body[0]->meta->wpop_viewport_width );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertResponseHasPattern( $response );
+ $this->assertGreaterThan( 1, count( $term_ids ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @covers ::main()
+ *
+ * @group e2e
+ */
+ public function test_browse_category() : void {
+ $query_term_id = 2;
+ $response = $this->send_request( '/?pattern-categories=' . $query_term_id );
+ $patterns = json_decode( $response->body );
+ $term_ids = $this->get_term_ids( $patterns );
+
+ $this->assertResponseHasPattern( $response );
+ $this->assertSame( array( $query_term_id ), $term_ids );
+ }
+
+ /**
+ * @covers ::main()
+ *
+ * @dataProvider data_search_patterns
+ *
+ * @group e2e
+ *
+ * @param string $search_query
+ */
+ public function test_search_patterns( $search_term, $match_expected ) : void {
+ $response = $this->send_request( '/?search=' . $search_term );
+ $patterns = json_decode( $response->body );
+
+ if ( $match_expected ) {
+ $this->assertResponseHasPattern( $response );
+
+ $all_patterns_include_query = true;
+
+ foreach ( $patterns as $pattern ) {
+ $match_in_title = stripos( $pattern->title->rendered, $search_term );
+ $match_in_description = stripos( $pattern->meta->wpop_description, $search_term );;
+
+ if ( ! $match_in_title && ! $match_in_description ) {
+ $all_patterns_include_query = false;
+ break;
+ }
+ }
+
+ $this->assertTrue( $all_patterns_include_query );
+
+ } else {
+ $this->assertSame( 200, $response->status_code );
+ $this->assertSame( '[]', $response->body );
+ }
+ }
+
+ public function data_search_patterns() {
+ return array(
+ 'match title' => array(
+ 'search_term' => 'side by side',
+ 'match_expected' => true,
+ ),
+
+ // todo Enable this once https://github.com/WordPress/pattern-directory/issues/28 is done
+// 'match description' => array(
+// 'search_term' => 'bright gradient background',
+// 'match_expected' => true,
+// ),
+
+ 'no matches' => array(
+ 'search_term' => 'Supercalifragilisticexpialidocious',
+ 'match_expected' => false,
+ ),
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>