Non-Local Join for Media Router and Presentation API

extensions/renderer/resources/media_router_bindings.js

 // Copyright 2015 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 var mediaRouter;
 
 define('media_router_bindings', [
     'mojo/public/js/bindings',
     'mojo/public/js/core',
     'content/public/renderer/service_provider',
@@ skipping 261 matching lines @@
       'default_action': issueActionToMojo_(issue.defaultAction),
       'secondary_actions': secondaryActions,
       'help_url': issue.helpUrl,
       'is_blocking': issue.isBlocking
     }));
   };
 
   /**
    * Called by the provider manager when the set of active routes
    * has been updated.
+   * @param {!string} sourceUrn The sourUrn associated with this route query.
    * @param {!Array<MediaRoute>} routes The active set of media routes.
+   * @param {!Array<string>} joinableRoutes The active set of joinable media
+   *     routes.
    */
-  MediaRouter.prototype.onRoutesUpdated = function(routes) {
-    this.service_.onRoutesUpdated(routes.map(routeToMojo_));
+  MediaRouter.prototype.onRoutesUpdated =
+      function(sourceUrn, routes, joinableRouteIds) {
+    this.service_.onRoutesUpdated(
+        sourceUrn, routes.map(routeToMojo_), joinableRouteIds);

[imcheng, 2015/12/29 00:24:42]

You can make this backwards compatible if you check if joinableRouteIds is
undefined and if so use an empty array. See comment below.

[matt.boetger, 2016/01/05 00:19:48]

Done.

   };
 
   /**
    * Called by the provider manager when sink availability has been updated.
    * @param {!mediaRouterMojom.MediaRouter.SinkAvailability} availability
    *     The new sink availability.
    */
   MediaRouter.prototype.onSinkAvailabilityUpdated = function(availability) {
     this.service_.onSinkAvailabilityUpdated(availability);
   };
@@ skipping 195 matching lines @@
     return this.handlers_.joinRoute(sourceUrn, presentationId, origin, tabId)
         .then(function(newRoute) {
           return {route: routeToMojo_(newRoute)};
         },
         function(err) {
           return {error_text: 'Error joining route: ' + err.message};
         });
   };
 
   /**
+   * Handles a request via the Presentation API to join an existing route given
+   * by |sourceUrn| and |routeId|. |origin| and |tabId| are used for
+   * validating same-origin/tab scope.
+   * @param {!string} sourceUrn Media source to render.
+   * @param {!string} routeId Route ID to join.
+   * @param {!string} presentationId Presentation ID to join.
+   * @param {!string} origin Origin of site requesting join.
+   * @param {!number} tabId ID of tab requesting join.
+   * @return {!Promise.<!Object>} A Promise resolving to an object describing
+   *     the newly created media route, or rejecting with an error message on
+   *     failure.
+   */
+  MediaRouteProvider.prototype.connectRouteByRouteId =
+      function(sourceUrn, routeId, presentationId, origin, tabId) {
+    return this.handlers_.connectRouteByRouteId(
+            sourceUrn, routeId, presentationId, origin, tabId)

[apacible, 2015/12/18 22:34:19]

nit: fix indentation for L521-527.

[matt.boetger, 2015/12/18 23:37:15]

I fixed the parameter list indentation - not sure what's wrong with the rest. 
I'm following the formatting that's in the CreateRoute function.

+        .then(function(newRoute) {
+          return {route: routeToMojo_(newRoute)};
+        },
+        function(err) {
+          return {error_text: 'Error joining route: ' + err.message};
+        });
+  };
+
+  /**
    * Closes the route specified by |routeId|.
    * @param {!string} routeId
    */
   MediaRouteProvider.prototype.closeRoute = function(routeId) {
     this.handlers_.closeRoute(routeId);
   };
 
   /**
    * Posts a message to the route designated by |routeId|.
    * @param {!string} routeId
@@ skipping 60 matching lines @@
    * @param {!string} routeId
    */
   MediaRouteProvider.prototype.onPresentationSessionDetached = function(
       routeId) {
     this.handlers_.onPresentationSessionDetached(routeId);
   };
 
   /**
    * Requests that the provider manager start sending information about active
    * media routes to the Media Router.
+   * @param {!string} sourceUrn
    */
-  MediaRouteProvider.prototype.startObservingMediaRoutes = function() {
-    this.handlers_.startObservingMediaRoutes();
+  MediaRouteProvider.prototype.startObservingMediaRoutes = function(sourceUrn) {
+    this.handlers_.startObservingMediaRoutes(sourceUrn);
   };
 
   /**
    * Requests that the provider manager stop sending information about active
    * media routes to the Media Router.
+   * @param {!string} sourceUrn

[mark a. foltz, 2015/12/16 07:17:35]

Adding a new required parameter is specifically not compatible with older
versions of the component extension.    So you'll want to ensure there is an
extension release before this hits dev channel.

[matt.boetger, 2015/12/18 23:37:15]

The changes to onRouteUpdated also means that the extension will need to be up
to date.  Not sure if I can make the extension work with both - so there will be
bit of time where things will be broken with the component extension until the
patch hits the dev channel.  

[imcheng, 2015/12/29 00:24:42]

It should be able to make this change backwards compatible.

Old MR + New MRPM:
sourceUrn not provided to MRPM; thus MRPM need to treat undefined as empty
joinableRouteIds (which should be empty) will get dropped when it reaches
media_router_bindings.js

New MR + Old MRPM:
sourceUrn will get dropped in MRPM
joinableRouteIds not provided to media_router_bindings.js; this file should
check if joinableRouteIds is undefined and send an empty array back to browser
if that's the case.

[matt.boetger, 2016/01/05 00:19:48]

In order to make this backwards compatible, I needed to change the
onRoutesUpdated method signature so that it continues to take the route list as
the first parameter.   

    */
-  MediaRouteProvider.prototype.stopObservingMediaRoutes = function() {
-    this.handlers_.stopObservingMediaRoutes();
+  MediaRouteProvider.prototype.stopObservingMediaRoutes = function(sourceUrn) {
+    this.handlers_.stopObservingMediaRoutes(sourceUrn);
   };
 
   mediaRouter = new MediaRouter(connector.bindHandleToProxy(
       serviceProvider.connectToService(
           mediaRouterMojom.MediaRouter.name),
       mediaRouterMojom.MediaRouter));
 
   return mediaRouter;
 });