<!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>[40364] trunk: REST API: JS Client - Enable connecting to multiple endpoints.</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 { 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/40364">40364</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/40364","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>adamsilverstein</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-04-02 19:40:37 +0000 (Sun, 02 Apr 2017)</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: JS Client - Enable connecting to multiple endpoints.
Enable connecting to multiple wp-api `endpoints`. Calling `wp.api.init` with a new `apiRoot` will parse the new endpoint's schema and store a new set of models and collections. A collection of connected endpoints is stored in `wp.api.endpoints`.
Props lucasstark.
Fixes <a href="https://core.trac.wordpress.org/ticket/39683">#39683</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesjswpapijs">trunk/src/wp-includes/js/wp-api.js</a></li>
<li><a href="#trunktestsqunitfixtureswpapijs">trunk/tests/qunit/fixtures/wp-api.js</a></li>
<li><a href="#trunktestsqunitwpincludesjswpapijs">trunk/tests/qunit/wp-includes/js/wp-api.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesjswpapijs"></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/js/wp-api.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/js/wp-api.js 2017-04-01 14:33:59 UTC (rev 40363)
+++ trunk/src/wp-includes/js/wp-api.js 2017-04-02 19:40:37 UTC (rev 40364)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1126,8 +1126,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Tracking objects for models and collections.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- loadingObjects.models = routeModel.get( 'models' );
- loadingObjects.collections = routeModel.get( 'collections' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ loadingObjects.models = {};
+ loadingObjects.collections = {};
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> _.each( routeModel.schemaModel.get( 'routes' ), function( route, index ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1310,7 +1310,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> loadingObjects.collections[ collectionClassName ] = wp.api.WPApiBaseCollection.extend( {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // For the url of a root level collection, use a string.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- url: routeModel.get( 'apiRoot' ) + routeModel.get( 'versionString' ) + routeName,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ url: function() {
+ return routeModel.get( 'apiRoot' ) + routeModel.get( 'versionString' ) + routeName;
+ },
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Specify the model that this collection contains.
</span><span class="cx" style="display: block; padding: 0 10px"> model: function( attrs, options ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1337,13 +1339,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> loadingObjects.models[ index ] = wp.api.utils.addMixinsAndHelpers( model, index, loadingObjects );
</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">+ // Set the routeModel models and collections.
+ routeModel.set( 'models', loadingObjects.models );
+ routeModel.set( 'collections', loadingObjects.collections );
+
</ins><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><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp.api.endpoints = new Backbone.Collection( {
- model: Endpoint
- } );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp.api.endpoints = new Backbone.Collection();
</ins><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"> * Initialize the wp-api, optionally passing the API root.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1357,28 +1361,30 @@
</span><span class="cx" style="display: block; padding: 0 10px"> var endpoint, attributes = {}, deferred, promise;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> args = args || {};
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- attributes.apiRoot = args.apiRoot || wpApiSettings.root;
- attributes.versionString = args.versionString || wpApiSettings.versionString;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ attributes.apiRoot = args.apiRoot || wpApiSettings.root || '/wp-json';
+ attributes.versionString = args.versionString || wpApiSettings.versionString || 'wp/v2/';
</ins><span class="cx" style="display: block; padding: 0 10px"> attributes.schema = args.schema || null;
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! attributes.schema && attributes.apiRoot === wpApiSettings.root && attributes.versionString === wpApiSettings.versionString ) {
</span><span class="cx" style="display: block; padding: 0 10px"> attributes.schema = wpApiSettings.schema;
</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"> if ( ! initializedDeferreds[ attributes.apiRoot + attributes.versionString ] ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- endpoint = wp.api.endpoints.findWhere( { apiRoot: attributes.apiRoot, versionString: attributes.versionString } );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Look for an existing copy of this endpoint
+ endpoint = wp.api.endpoints.findWhere( { 'apiRoot': attributes.apiRoot, 'versionString': attributes.versionString } );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! endpoint ) {
</span><span class="cx" style="display: block; padding: 0 10px"> endpoint = new Endpoint( attributes );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp.api.endpoints.add( endpoint );
</del><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> deferred = jQuery.Deferred();
</span><span class="cx" style="display: block; padding: 0 10px"> promise = deferred.promise();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- endpoint.schemaConstructed.done( function( endpoint ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ endpoint.schemaConstructed.done( function( resolvedEndpoint ) {
+ wp.api.endpoints.add( resolvedEndpoint );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Map the default endpoints, extending any already present items (including Schema model).
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp.api.models = _.extend( endpoint.get( 'models' ), wp.api.models );
- wp.api.collections = _.extend( endpoint.get( 'collections' ), wp.api.collections );
- deferred.resolveWith( wp.api, [ endpoint ] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp.api.models = _.extend( wp.api.models, resolvedEndpoint.get( 'models' ) );
+ wp.api.collections = _.extend( wp.api.collections, resolvedEndpoint.get( 'collections' ) );
+ deferred.resolve( resolvedEndpoint );
</ins><span class="cx" style="display: block; padding: 0 10px"> } );
</span><span class="cx" style="display: block; padding: 0 10px"> initializedDeferreds[ attributes.apiRoot + attributes.versionString ] = promise;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsqunitfixtureswpapijs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/qunit/fixtures/wp-api.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/qunit/fixtures/wp-api.js 2017-04-01 14:33:59 UTC (rev 40363)
+++ trunk/tests/qunit/fixtures/wp-api.js 2017-04-02 19:40:37 UTC (rev 40364)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -32,12 +32,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param {object} param The parameters sent to the ajax request.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return {Object} A jQuery defered object that resolves with the mapped data.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return {Object} A jQuery deferred object that resolves with the mapped data.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> Backbone.ajax = function ( param ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> var data,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- request = param.url.replace( 'http://localhost/', '' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ request = param.url
+ .replace( 'http://remotehost/', '' )
+ .replace( 'http://localhost/', '' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( pathToData[ request ] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> data = pathToData[ request ];
</span></span></pre></div>
<a id="trunktestsqunitwpincludesjswpapijs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/qunit/wp-includes/js/wp-api.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/qunit/wp-includes/js/wp-api.js 2017-04-01 14:33:59 UTC (rev 40363)
+++ trunk/tests/qunit/wp-includes/js/wp-api.js 2017-04-02 19:40:37 UTC (rev 40364)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -192,10 +192,10 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-// Test the jswidget custom namespace and endpoints.
-wp.api.init( {
- 'versionString': 'js-widgets/v1/'
-} ).done( function() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Test the jswidget custom namespace and endpoints.
+ wp.api.init( {
+ 'versionString': 'js-widgets/v1/'
+ } ).done( function() {
</ins><span class="cx" style="display: block; padding: 0 10px"> var customClasses = [
</span><span class="cx" style="display: block; padding: 0 10px"> 'WidgetsArchives',
</span><span class="cx" style="display: block; padding: 0 10px"> 'WidgetsCalendar',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -232,4 +232,33 @@
</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">+ // Check connecting to a second URL.
+ wp.api.loadPromise.done( function() {
+ QUnit.test( 'Checking connecting to a remote url.' , function( assert ) {
+ var done = assert.async();
+
+ wp.api.init({
+ 'apiRoot': 'http://remotehost/wp-json/'
+ } ).done( function(){
+ var lastEndpoint = wp.api.endpoints.last(),
+ models = lastEndpoint.get( 'models' ),
+ post = new models.Post();
+
+ assert.equal( 'http://remotehost/wp-json/wp/v2/posts', post.url(), 'The remote API objects should have their own URLs' );
+
+ wp.api.init({
+ 'apiRoot': 'http://localhost/wp-json/'
+ } ).done( function(){
+ var lastEndpoint = wp.api.endpoints.first(),
+ models = lastEndpoint.get( 'models' ),
+ post = new models.Post();
+
+ assert.equal( 'http://localhost/wp-json/wp/v2/posts', post.url(), 'The local API objects should have their own URLs' );
+
+ done();
+ } );
+ } );
+ } );
+ });
+
</ins><span class="cx" style="display: block; padding: 0 10px"> } )( window.QUnit );
</span></span></pre>
</div>
</div>
</body>
</html>