Add Finch Checks to the State Machine

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 110 matching lines @@
 
 // Add error processing to API calls.
 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(chrome.permissions, 'contains', 1);
+tasks.instrumentApiFunction(chrome.permissions, 'remove', 1);
+tasks.instrumentApiFunction(chrome.permissions, 'request', 1);
+tasks.instrumentApiFunction(chrome.runtime.onInstalled, 'addListener', 0);
+tasks.instrumentApiFunction(chrome.runtime.onStartup, 'addListener', 0);
+tasks.instrumentApiFunction(chrome.tabs, 'create', 1);

[vadimt, 2013/08/03 02:07:53]

Please sync, build and run Chrome. Run you functionality, and you'll have
auto-detection of still uninstrumented callbacks (if any).

 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,
@@ skipping 554 matching lines @@
 function setShouldPollCards(shouldPollCardsRequest, onSuccess) {
   tasks.debugSetStepName(
         'setShouldRun-shouldRun-updateCardsAttemptsIsRunning');
   updateCardsAttempts.isRunning(function(currentValue) {
     if (shouldPollCardsRequest != currentValue) {
       console.log('Action Taken setShouldPollCards=' + shouldPollCardsRequest);
       if (shouldPollCardsRequest)
         startPollingCards();
       else
         stopPollingCards();
+    } else {
+      console.log(
+          'Action Ignored setShouldPollCards=' + shouldPollCardsRequest);
     }
     onSuccess();
   });
 }
 
 /**
  * Shows or hides the toast.
  * @param {boolean} visibleRequest true to show the toast and
  *     false to hide the toast.
  * @param {function} onSuccess Called on completion.
  */
 function setToastVisible(visibleRequest, onSuccess) {
   tasks.debugSetStepName(
       'setToastVisible-shouldSetToastVisible-getAllNotifications');
   chrome.notifications.getAll(function(notifications) {
     // TODO(vadimt): Figure out what to do when notifications are disabled for
     // our extension.
     notifications = notifications || {};
 
     if (visibleRequest != !!notifications[WELCOME_TOAST_NOTIFICATION_ID]) {
       console.log('Action Taken setToastVisible=' + visibleRequest);
       if (visibleRequest)
         showWelcomeToast();
       else
         hideWelcomeToast();
+    } else {
+      console.log('Action Ignored setToastVisible=' + visibleRequest);
     }
 
     onSuccess();
   });
 }
 
 /**
+ * Enables or disables the Google Now background permission.
+ * @param {boolean} backgroundEnable true to run in the background.
+ *     false to not run in the background.
+ * @param {function} onSuccess Called on completion.
+ */
+function setBackgroundEnable(backgroundEnable, onSuccess) {
+  chrome.permissions.contains({permissions: ['background']},
+      function(hasPermission) {
+        if (backgroundEnable != hasPermission) {
+          console.log('Action Taken setBackgroundEnable=' + backgroundEnable);
+          if (backgroundEnable)
+            chrome.permissions.request(
+                {permissions: ['background']},
+                function() {
+                  onSuccess();
+                });
+          else
+            chrome.permissions.remove(
+                {permissions: ['background']},
+                function() {
+                  onSuccess();
+                });
+        } else {
+          console.log('Action Ignored setBackgroundEnable=' + backgroundEnable);
+          onSuccess();
+        }
+      });
+}
+
+/**
  * Does the actual work of deciding what Google Now should do
  * based off of the current state of Chrome.
  * @param {boolean} signedIn true if the user is signed in.
  * @param {boolean} geolocationEnabled true if
  *     the geolocation option is enabled.
  * @param {boolean} userRespondedToToast true if
  *     the user has responded to the toast.
+ * @param {boolean} enableExperiment true if
+ *     this extension should be running.
  * @param {function()} callback Call this function on completion.
  */
 function updateRunningState(
     signedIn,
     geolocationEnabled,
     userRespondedToToast,
+    enableExperiment,
     callback) {
 
   console.log(
       'State Update signedIn=' + signedIn + ' ' +
       'geolocationEnabled=' + geolocationEnabled + ' ' +
-      'userRespondedToToast=' + userRespondedToToast);
+      'userRespondedToToast=' + userRespondedToToast + ' ' +
+      'enableExperiment=' + enableExperiment);
 
   var shouldSetToastVisible = false;
   var shouldPollCards = false;
+  var shouldSetBackground = false;
 
-  if (signedIn) {
+  if (signedIn && enableExperiment) {
     if (geolocationEnabled) {
       if (!userRespondedToToast) {
         // If the user enabled geolocation independently of Google Now,
         // the user has implicitly responded to the toast.
         // We do not want to show it again.
         storage.set({userRespondedToToast: true});
       }
 
       shouldPollCards = true;
+      shouldSetBackground = true;
     } else {
       if (userRespondedToToast) {
         recordEvent(GoogleNowEvent.USER_SUPPRESSED);
       } else {
         shouldSetToastVisible = true;
       }
     }
   } else {
     recordEvent(GoogleNowEvent.STOPPED);
   }
 
   console.log(
-      'Requested Actions setToastVisible=' + shouldSetToastVisible + ' ' +
+      'Requested Actions shouldSetBackground=' + shouldSetBackground + ' ' +
+      'setToastVisible=' + shouldSetToastVisible + ' ' +
       'setShouldPollCards=' + shouldPollCards);
 
-  setToastVisible(shouldSetToastVisible, function() {
-    setShouldPollCards(shouldPollCards, callback);
+  setBackgroundEnable(shouldSetBackground, function() {
+    setToastVisible(shouldSetToastVisible, function() {
+      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-isSignedIn');
     authenticationManager.isSignedIn(function(token) {
       var signedIn = !!token && !!NOTIFICATION_CARDS_URL;
-      tasks.debugSetStepName(
-          'onStateChange-get-googleGeolocationAccessEnabledPref');
-      googleGeolocationAccessEnabledPref.get({}, function(prefValue) {
-        var geolocationEnabled = !!prefValue.value;
+      chrome.metricsPrivate.getFieldTrial('GoogleNow', function(response) {
+        // '' means we were enabled via the flags, but
+        // the experiment is not running.
+        var enableExperiment = (response == 'Enable' ||

[vadimt, 2013/08/03 02:07:53]

You need to check for "EnableWithBackground", "EnabledViaFlag" or ""

+                               (response == 'EnabledViaFlag') ||
+                               (response == ''));
         tasks.debugSetStepName(
-          'onStateChange-get-userRespondedToToast');
-        storage.get('userRespondedToToast', function(items) {
-          var userRespondedToToast = !!items.userRespondedToToast;
-          updateRunningState(
-              signedIn,
-              geolocationEnabled,
-              userRespondedToToast,
-              callback);
+            '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,
+                geolocationEnabled,
+                userRespondedToToast,
+                enableExperiment,
+                callback);
+          });
         });
       });
     });
   });
 }
 
 /**
  * Displays a toast to the user asking if they want to opt in to receiving
  * Google Now cards.
  */
@@ skipping 74 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();
 });