Changeset 40364

Timestamp:

04/02/2017 07:40:37 PM (8 years ago)

Author:

adamsilverstein

Message:

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 #39683.

Location:

trunk

Files:

• src/wp-includes/js/wp-api.js (modified) (5 diffs)
• tests/qunit/fixtures/wp-api.js (modified) (1 diff)
• tests/qunit/wp-includes/js/wp-api.js (modified) (2 diffs)

trunk/src/wp-includes/js/wp-api.js

@@ -1127 +1127 @@
              * Tracking objects for models and collections.
              */
-            loadingObjects.models      = routeModel.get( 'models' );
-            loadingObjects.collections = routeModel.get( 'collections' );
+            loadingObjects.models      = {};
+            loadingObjects.collections = {};
 
             _.each( routeModel.schemaModel.get( 'routes' ), function( route, index ) {
@@ -1311 +1311 @@
 
                         // For the url of a root level collection, use a string.
-                        url: routeModel.get( 'apiRoot' ) + routeModel.get( 'versionString' ) + routeName,
+                        url: function() {
+                            return routeModel.get( 'apiRoot' ) + routeModel.get( 'versionString' ) + routeName;
+                        },
 
                         // Specify the model that this collection contains.
@@ -1338 +1340 @@
             } );
 
+            // Set the routeModel models and collections.
+            routeModel.set( 'models', loadingObjects.models );
+            routeModel.set( 'collections', loadingObjects.collections );
+
         }
 
     } );
 
-    wp.api.endpoints = new Backbone.Collection( {
-        model: Endpoint
-    } );
+    wp.api.endpoints = new Backbone.Collection();
 
     /**
@@ -1358 +1362 @@
 
         args                     = args || {};
-        attributes.apiRoot       = args.apiRoot || wpApiSettings.root;
-        attributes.versionString = args.versionString || wpApiSettings.versionString;
+        attributes.apiRoot       = args.apiRoot || wpApiSettings.root || '/wp-json';
+        attributes.versionString = args.versionString || wpApiSettings.versionString || 'wp/v2/';
         attributes.schema        = args.schema || null;
         if ( ! attributes.schema && attributes.apiRoot === wpApiSettings.root && attributes.versionString === wpApiSettings.versionString ) {
@@ -1366 +1370 @@
 
         if ( ! initializedDeferreds[ attributes.apiRoot + attributes.versionString ] ) {
-            endpoint = wp.api.endpoints.findWhere( { apiRoot: attributes.apiRoot, versionString: attributes.versionString } );
+
+            // Look for an existing copy of this endpoint
+            endpoint = wp.api.endpoints.findWhere( { 'apiRoot': attributes.apiRoot, 'versionString': attributes.versionString } );
             if ( ! endpoint ) {
                 endpoint = new Endpoint( attributes );
-                wp.api.endpoints.add( endpoint );
             }
             deferred = jQuery.Deferred();
             promise = deferred.promise();
 
-            endpoint.schemaConstructed.done( function( endpoint ) {
+            endpoint.schemaConstructed.done( function( resolvedEndpoint ) {
+                wp.api.endpoints.add( resolvedEndpoint );
 
                 // Map the default endpoints, extending any already present items (including Schema model).
-                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 ] );
+                wp.api.models      = _.extend( wp.api.models, resolvedEndpoint.get( 'models' ) );
+                wp.api.collections = _.extend( wp.api.collections, resolvedEndpoint.get( 'collections' ) );
+                deferred.resolve( resolvedEndpoint );
             } );
             initializedDeferreds[ attributes.apiRoot + attributes.versionString ] = promise;

trunk/tests/qunit/fixtures/wp-api.js

@@ -33 +33 @@
  * @param  {object} param The parameters sent to the ajax request.
  *
- * @return {Object}       A jQuery defered object that resolves with the mapped data.
+ * @return {Object}       A jQuery deferred object that resolves with the mapped data.
  */
 Backbone.ajax = function ( param ) {
 
     var data,
-        request = param.url.replace( 'http://localhost/', '' );
+        request = param.url
+            .replace( 'http://remotehost/', '' )
+            .replace( 'http://localhost/', '' );
 
     if ( pathToData[ request ] ) {

trunk/tests/qunit/wp-includes/js/wp-api.js

@@ -193 +193 @@
     } );
 
-// Test the jswidget custom namespace and endpoints.
-wp.api.init( {
-    'versionString': 'js-widgets/v1/'
-} ).done( function() {
+    // Test the jswidget custom namespace and endpoints.
+    wp.api.init( {
+        'versionString': 'js-widgets/v1/'
+    } ).done( function() {
         var customClasses = [
             'WidgetsArchives',
@@ -233 +233 @@
     } );
 
+    // 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();
+                } );
+            } );
+        } );
+    });
+
 } )( window.QUnit );