Authentication Manager for Google Now

chrome/browser/resources/google_now/background.js

 // Copyright (c) 2013 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.
 
 'use strict';
 
 /**
  * @fileoverview The event page for Google Now for Chrome implementation.
  * The Google Now event page gets Google Now cards from the server and shows
  * them as Chrome notifications.
@@ skipping 102 matching lines @@
 
   return false;
 }
 
 var googleGeolocationAccessEnabledPref =
     chrome.preferencesPrivate.googleGeolocationAccessEnabled;
 
 var tasks = buildTaskManager(areTasksConflicting);
 
 // Add error processing to API calls.
-tasks.instrumentApiFunction(chrome.identity, 'getAuthToken', 1);
-tasks.instrumentApiFunction(chrome.identity, 'removeCachedAuthToken', 1);
 tasks.instrumentApiFunction(chrome.location.onLocationUpdate, 'addListener', 0);
 tasks.instrumentApiFunction(chrome.notifications, 'create', 2);
 tasks.instrumentApiFunction(chrome.notifications, 'update', 2);
 tasks.instrumentApiFunction(chrome.notifications, 'getAll', 0);
 tasks.instrumentApiFunction(
     chrome.notifications.onButtonClicked, 'addListener', 0);
 tasks.instrumentApiFunction(chrome.notifications.onClicked, 'addListener', 0);
 tasks.instrumentApiFunction(chrome.notifications.onClosed, 'addListener', 0);
 tasks.instrumentApiFunction(
     googleGeolocationAccessEnabledPref.onChange,
     'addListener',
     0);
 tasks.instrumentApiFunction(chrome.runtime.onInstalled, 'addListener', 0);
 tasks.instrumentApiFunction(chrome.runtime.onStartup, 'addListener', 0);
 tasks.instrumentApiFunction(chrome.tabs, 'create', 1);
 tasks.instrumentApiFunction(storage, 'get', 1);
 
 var updateCardsAttempts = buildAttemptManager(
     'cards-update',
     requestLocation,
     INITIAL_POLLING_PERIOD_SECONDS,
     MAXIMUM_POLLING_PERIOD_SECONDS);
 var dismissalAttempts = buildAttemptManager(
     'dismiss',
     retryPendingDismissals,
     INITIAL_RETRY_DISMISS_PERIOD_SECONDS,
     MAXIMUM_RETRY_DISMISS_PERIOD_SECONDS);
 var cardSet = buildCardSet();
 
+var authenticationManager = buildAuthenticationManager();
+
 /**
  * Google Now UMA event identifier.
  * @enum {number}
  */
 var GoogleNowEvent = {
   REQUEST_FOR_CARDS_TOTAL: 0,
   REQUEST_FOR_CARDS_SUCCESS: 1,
   CARDS_PARSE_SUCCESS: 2,
   DISMISS_REQUEST_TOTAL: 3,
   DISMISS_REQUEST_SUCCESS: 4,
@@ skipping 22 matching lines @@
 
   chrome.metricsPrivate.recordValue(metricDescription, event);
 }
 
 /**
  * Adds authorization behavior to the request.
  * @param {XMLHttpRequest} request Server request.
  * @param {function(boolean)} callbackBoolean Completion callback with 'success'
  *     parameter.
  */
 function setAuthorization(request, callbackBoolean) {

[vadimt, 2013/07/30 23:27:23]

Why not move the whole setAuthorization into authenticationManager?

[robliao, 2013/07/30 23:58:03]

I wanted to keep the HTTP portion out of the identity wrapper. Keeping it
separate made the most sense.

This also allows us to easily go back to chrome.identity should we get a
notification mechanism from them.
On 2013/07/30 23:27:23, vadimt wrote:

-  tasks.debugSetStepName('setAuthorization-getAuthToken');
-  chrome.identity.getAuthToken({interactive: false}, function(token) {
-    var errorMessage =
-        chrome.runtime.lastError && chrome.runtime.lastError.message;
-    console.log('setAuthorization: error=' + errorMessage +
-                ', token=' + (token && 'non-empty'));
-    if (chrome.runtime.lastError || !token) {
+  tasks.debugSetStepName('setAuthorization-isSignedIn');
+  authenticationManager.isSignedIn(function(signedIn, token) {
+    if (!signedIn) {
       callbackBoolean(false);
       return;
     }
 
     request.setRequestHeader('Authorization', 'Bearer ' + token);
 
     // Instrument onloadend to remove stale auth tokens.
     var originalOnLoadEnd = request.onloadend;
     request.onloadend = tasks.wrapCallback(function(event) {
       if (request.status == HTTP_FORBIDDEN ||
           request.status == HTTP_UNAUTHORIZED) {
-        tasks.debugSetStepName('setAuthorization-removeCachedAuthToken');
-        chrome.identity.removeCachedAuthToken({token: token}, function() {
-          // After purging the token cache, call getAuthToken() again to let
-          // Chrome know about the problem with the token.
-          chrome.identity.getAuthToken({interactive: false}, function() {});
+        tasks.debugSetStepName('setAuthorization-removeToken');
+        authenticationManager.removeToken(token, function() {
           originalOnLoadEnd(event);
         });
       } else {
         originalOnLoadEnd(event);
       }
     });
 
     callbackBoolean(true);
   });
 }
@@ skipping 555 matching lines @@
     setShouldPollCards(shouldPollCards, callback);
   });
 }
 
 /**
  * Coordinates the behavior of Google Now for Chrome depending on
  * Chrome and extension state.
  */
 function onStateChange() {
   tasks.add(STATE_CHANGED_TASK_NAME, function(callback) {
-    tasks.debugSetStepName('onStateChange-getAuthToken');
-    chrome.identity.getAuthToken({interactive: false}, function(token) {
-      var signedIn =
-          !chrome.runtime.lastError &&
-          token &&
-          !!NOTIFICATION_CARDS_URL;
+    tasks.debugSetStepName('onStateChange-isSignedIn');
+    authenticationManager.isSignedIn(function(signedIn) {
+      signedIn = signedIn && !!NOTIFICATION_CARDS_URL;
       tasks.debugSetStepName(
           'onStateChange-get-googleGeolocationAccessEnabledPref');
       googleGeolocationAccessEnabledPref.get({}, function(prefValue) {
         var geolocationEnabled = !!prefValue.value;
         tasks.debugSetStepName(
           'onStateChange-get-userRespondedToToast');
         storage.get('userRespondedToToast', function(items) {
           var userRespondedToToast = !!items.userRespondedToToast;
           updateRunningState(
               signedIn,
@@ skipping 47 matching lines @@
 chrome.runtime.onStartup.addListener(function() {
   console.log('onStartup');
   initialize();
 });
 
 googleGeolocationAccessEnabledPref.onChange.addListener(function(prefValue) {
   console.log('googleGeolocationAccessEnabledPref onChange ' + prefValue.value);
   onStateChange();
 });
 
+authenticationManager.addListener(function() {
+  console.log('signIn State Change');
+  onStateChange();
+});
+
 chrome.notifications.onClicked.addListener(
     function(notificationId) {
       chrome.metricsPrivate.recordUserAction('GoogleNow.MessageClicked');
       onNotificationClicked(notificationId, function(actionUrls) {
         return actionUrls.messageUrl;
       });
     });
 
 chrome.notifications.onButtonClicked.addListener(
     function(notificationId, buttonIndex) {
@@ skipping 15 matching lines @@
 
 chrome.location.onLocationUpdate.addListener(function(position) {
   recordEvent(GoogleNowEvent.LOCATION_UPDATE);
   updateNotificationsCards(position);
 });
 
 chrome.omnibox.onInputEntered.addListener(function(text) {
   localStorage['server_url'] = NOTIFICATION_CARDS_URL = text;
   initialize();
 });