Attempt Manager Refactor and Opt-In Pipeline Refactor

chrome/browser/resources/google_now/background_unittest.gtestjs

 // Copyright 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.
 
 // TODO(robliao,vadimt): Determine the granularity of testing to perform.
 
 /**
  * Test fixture for background.js.
  * @constructor
  * @extends {testing.Test}
@@ skipping 318 matching lines @@
   assertFalse(thenCalled);
   assertTrue(catchCalled);
 });
 
 /**
  * requestAndUpdateOptIn Tests
  */
 TEST_F(TEST_NAME, 'RequestAndUpdateOptInOptedIn', function() {
   this.makeAndRegisterMockApis([
     'chrome.storage.local.set',
-    'onStateChange',
-    'requestFromServer',
-    'scheduleNextPoll'
+    'requestFromServer'
   ]);
 
   this.mockApis.expects(once()).requestFromServer('GET', 'settings/optin')
       .will(returnValue(Promise.resolve({
         status: 200,
         responseText: '{"value": true}'})));
 
   this.mockApis.expects(once())
       .chrome_storage_local_set(eqJSON({googleNowEnabled: true}));
 
-  this.mockApis.expects(once()).onStateChange();
-
-  this.mockApis.expects(never()).scheduleNextPoll();
-
   var thenCalled = false;
   var catchCalled = false;
-  requestAndUpdateOptedIn().then(function() {
+  requestAndUpdateOptedIn().then(function(optedIn) {
     thenCalled = true;
+    assertTrue(optedIn);
   }).catch(function() {
     catchCalled = true;
   });
   assertTrue(thenCalled);
   assertFalse(catchCalled);
 });
 
 TEST_F(TEST_NAME, 'RequestAndUpdateOptInOptedOut', function() {
   this.makeAndRegisterMockApis([
     'chrome.storage.local.set',
-    'onStateChange',
-    'requestFromServer',
-    'scheduleNextPoll'
+    'requestFromServer'
   ]);
 
   this.mockApis.expects(once()).requestFromServer('GET', 'settings/optin')
       .will(returnValue(Promise.resolve({
         status: 200,
         responseText: '{"value": false}'})));
 
-  this.mockApis.expects(never()).chrome_storage_local_set();
-
-  this.mockApis.expects(never()).onStateChange();
-
-  this.mockApis.expects(once()).scheduleNextPoll(eqJSON({}), false);
+  this.mockApis.expects(once())
+      .chrome_storage_local_set(eqJSON({googleNowEnabled: false}));
 
   var thenCalled = false;
   var catchCalled = false;
-  requestAndUpdateOptedIn().then(function() {
+  requestAndUpdateOptedIn().then(function(optedIn) {
     thenCalled = true;
+    assertFalse(optedIn);
   }).catch(function() {
     catchCalled = true;
   });
-  assertFalse(thenCalled);
-  assertTrue(catchCalled);
+  assertTrue(thenCalled);
+  assertFalse(catchCalled);
 });
 
 TEST_F(TEST_NAME, 'RequestAndUpdateOptInFailure', function() {
   this.makeAndRegisterMockApis([
     'chrome.storage.local.set',
-    'onStateChange',
-    'requestFromServer',
-    'scheduleNextPoll'
+    'requestFromServer'
   ]);
 
   this.mockApis.expects(once()).requestFromServer('GET', 'settings/optin')
       .will(returnValue(Promise.reject({status: 404})));
 
   this.mockApis.expects(never()).chrome_storage_local_set();
 
-  this.mockApis.expects(never()).onStateChange();
-
-  this.mockApis.expects(never()).scheduleNextPoll();
-
   var thenCalled = false;
   var catchCalled = false;
   requestAndUpdateOptedIn().then(function() {
     thenCalled = true;
   }).catch(function() {
     catchCalled = true;
   });
   assertFalse(thenCalled);
   assertTrue(catchCalled);
 });
 
 /**
+ * pollOptedInNoImmediateRecheck Tests
+ */
+TEST_F(TEST_NAME, 'pollOptedInNoImmediateRecheckOptedIn', function() {
+  this.makeAndRegisterMockApis([
+    'requestAndUpdateOptedIn',
+    'instrumented.metricsPrivate.getVariationParams',
+    'optInPollAttempts.start'
+  ]);
+
+  this.mockApis.expects(once()).requestAndUpdateOptedIn()
+      .will(returnValue(Promise.resolve(true)));
+
+  this.mockApis.expects(never())
+      .instrumented_metricsPrivate_getVariationParams();
+
+  this.mockApis.expects(never()).optInPollAttempts_start();
+
+  pollOptedInNoImmediateRecheck();
+});
+
+TEST_F(TEST_NAME, 'pollOptedInNoImmediateRecheckOptedOut', function() {
+  this.makeAndRegisterMockApis([
+    'requestAndUpdateOptedIn',
+    'instrumented.metricsPrivate.getVariationParams',
+    'optInPollAttempts.start'
+  ]);
+
+  this.mockApis.expects(once()).requestAndUpdateOptedIn()
+      .will(returnValue(Promise.resolve(false)));
+
+  var getVariationParamsSavedArgs = new SaveMockArguments();
+  this.mockApis.expects(once())
+      .instrumented_metricsPrivate_getVariationParams(
+          getVariationParamsSavedArgs.match(eq('GoogleNow')),
+          getVariationParamsSavedArgs.match(ANYTHING))
+      .will(invokeCallback(getVariationParamsSavedArgs, 1, {}));
+
+  this.mockApis.expects(once())
+      .optInPollAttempts_start(DEFAULT_OPTIN_CHECK_PERIOD_SECONDS);
+
+  pollOptedInNoImmediateRecheck();
+});
+
+TEST_F(TEST_NAME, 'pollOptedInNoImmediateRecheckFailure', function() {
+  this.makeAndRegisterMockApis([
+    'requestAndUpdateOptedIn',
+    'instrumented.metricsPrivate.getVariationParams',
+    'optInPollAttempts.start'
+  ]);
+
+  this.mockApis.expects(once()).requestAndUpdateOptedIn()
+      .will(returnValue(Promise.reject()));
+
+  var getVariationParamsSavedArgs = new SaveMockArguments();
+  this.mockApis.expects(once())
+      .instrumented_metricsPrivate_getVariationParams(
+          getVariationParamsSavedArgs.match(eq('GoogleNow')),
+          getVariationParamsSavedArgs.match(ANYTHING))
+      .will(invokeCallback(getVariationParamsSavedArgs, 1, {}));
+
+  this.mockApis.expects(once())
+      .optInPollAttempts_start(DEFAULT_OPTIN_CHECK_PERIOD_SECONDS);
+
+  pollOptedInNoImmediateRecheck();
+});
+
+/**
  * getGroupsToRequest Tests
  */
 TEST_F(TEST_NAME, 'GetGroupsToRequestNone', function() {
   this.makeAndRegisterMockApis([
     'fillFromChromeLocalStorage',
     'Date.now'
   ]);
 
   this.mockApis.expects(once())
       .fillFromChromeLocalStorage(eqJSON({notificationGroups: {}}))
@@ skipping 88 matching lines @@
       JSON.stringify(expectedCombinedCards),
       JSON.stringify(combinedCards));
 });
 
 /**
  * Mocks global functions and APIs that initialize() depends upon.
  * @param {Test} fixture Test fixture.
  */
 function mockInitializeDependencies(fixture) {
   fixture.makeAndRegisterMockGlobals([
+    'pollOptedInNoImmediateRecheck',
     'recordEvent',
     'removeAllCards',
     'setBackgroundEnable',
     'startPollingCards',
     'stopPollingCards'
   ]);
   fixture.makeAndRegisterMockApis([
     'authenticationManager.isSignedIn',
     'chrome.storage.local.remove',
     'fillFromChromeLocalStorage',
     'instrumented.metricsPrivate.getVariationParams',
     'instrumented.notifications.getAll',
     'instrumented.notifications.getPermissionLevel',
     'instrumented.webstorePrivate.getBrowserLogin',
+    'optInPollAttempts.isRunning',
+    'optInPollAttempts.stop',
     'tasks.add',
     'updateCardsAttempts.isRunning',
     'updateCardsAttempts.stop'
   ]);
 }
 
 /**
  * Sets up the test to expect the state machine calls and send
  * the specified state machine state. Currently used to test initialize().
  * Note that this CAN NOT be used if any of the methods below are called
@@ skipping 42 matching lines @@
       {googleNowEnabled: false},
       {googleNowEnabled: testGoogleNowEnabled});
 
   var updateCardsAttemptsIsRunningSavedArgs = new SaveMockArguments();
   fixture.mockApis.expects(once()).
       updateCardsAttempts_isRunning(
           updateCardsAttemptsIsRunningSavedArgs.match(ANYTHING)).
       will(
           invokeCallback(
               updateCardsAttemptsIsRunningSavedArgs, 0, undefined));
+
+  var optInPollAttemptsIsRunningSavedArgs = new SaveMockArguments();
+  fixture.mockApis.expects(once()).
+      optInPollAttempts_isRunning(
+          optInPollAttemptsIsRunningSavedArgs.match(ANYTHING)).
+      will(
+          invokeCallback(
+              optInPollAttemptsIsRunningSavedArgs, 0, undefined));
 }
 
 /**
  * Sets up the test to expect the initialization calls that
  * initialize() invokes.
  * Note that this CAN NOT be used if any of the methods below are called
  * outside of this context with the same argument matchers.
  * expects() calls cannot be chained with the same argument matchers.
  */
 function expectInitialization(fixture) {
@@ skipping 32 matching lines @@
       this,
       testIdentityToken,
       testExperimentVariationParams,
       testNotificationPermissionLevel,
       testGoogleNowEnabled);
 
   this.mockGlobals.expects(once()).setBackgroundEnable(false);
   this.mockGlobals.expects(never()).startPollingCards();
   this.mockGlobals.expects(once()).stopPollingCards();
   this.mockGlobals.expects(once()).removeAllCards();
+  this.mockGlobals.expects(never()).pollOptedInNoImmediateRecheck();
+  this.mockApis.expects(once()).optInPollAttempts_stop();
 
   // Invoking the tested function.
   initialize();
 });
 
 TEST_F(TEST_NAME,'Initialize_NotificationDisabled', function() {
   // Tests the case when Google Now is disabled in the notifications center.
 
   // Setup and expectations.
   var testIdentityToken = 'some identity token';
   var testExperimentVariationParams = {};
   var testNotificationPermissionLevel = 'denied';
   var testGoogleNowEnabled = undefined;
 
   mockInitializeDependencies(this);
 
   expectInitialization(this);
 
   expectStateMachineCalls(
       this,
       testIdentityToken,
       testExperimentVariationParams,
       testNotificationPermissionLevel,
       testGoogleNowEnabled);
 
   this.mockGlobals.expects(once()).setBackgroundEnable(false);
   this.mockGlobals.expects(never()).startPollingCards();
   this.mockGlobals.expects(once()).stopPollingCards();
   this.mockGlobals.expects(once()).removeAllCards();
+  this.mockGlobals.expects(never()).pollOptedInNoImmediateRecheck();
+  this.mockApis.expects(once()).optInPollAttempts_stop();
 
   // Invoking the tested function.
   initialize();
 });
 
 TEST_F(TEST_NAME, 'Initialize_NoBackground', function() {
   // Tests when the no background variation is received.
 
   // Setup and expectations.
   var testIdentityToken = 'some identity token';
   var testExperimentVariationParams = {canEnableBackground: 'false'};
   var testNotificationPermissionLevel = 'granted';
   var testGoogleNowEnabled = true;
 
   mockInitializeDependencies(this);
 
   expectInitialization(this);
 
   expectStateMachineCalls(
       this,
       testIdentityToken,
       testExperimentVariationParams,
       testNotificationPermissionLevel,
       testGoogleNowEnabled);
 
   this.mockGlobals.expects(once()).setBackgroundEnable(false);
   this.mockGlobals.expects(once()).startPollingCards();
   this.mockGlobals.expects(never()).stopPollingCards();
   this.mockGlobals.expects(never()).removeAllCards();
+  this.mockGlobals.expects(never()).pollOptedInNoImmediateRecheck();
+  this.mockApis.expects(once()).optInPollAttempts_stop();
 
   // Invoking the tested function.
   initialize();
 });
 
 TEST_F(TEST_NAME, 'Initialize_GoogleNowDisabled', function() {
   // Tests when the user has Google Now disabled.
 
   // Setup and expectations.
   var testIdentityToken = 'some identity token';
   var testExperimentVariationParams = {};
   var testNotificationPermissionLevel = 'granted';
   var testGoogleNowEnabled = false;
 
   mockInitializeDependencies(this);
 
   expectInitialization(this);
 
   expectStateMachineCalls(
       this,
       testIdentityToken,
       testExperimentVariationParams,
       testNotificationPermissionLevel,
       testGoogleNowEnabled);
 
   this.mockGlobals.expects(once()).setBackgroundEnable(false);
-  this.mockGlobals.expects(once()).startPollingCards();
-  this.mockGlobals.expects(never()).stopPollingCards();
+  this.mockGlobals.expects(never()).startPollingCards();
+  this.mockGlobals.expects(once()).stopPollingCards();
   this.mockGlobals.expects(once()).removeAllCards();
+  this.mockGlobals.expects(once()).pollOptedInNoImmediateRecheck();
+  this.mockApis.expects(never()).optInPollAttempts_stop();
 
   // Invoking the tested function.
   initialize();
 });
 
 TEST_F(TEST_NAME, 'Initialize_RunGoogleNow', function() {
   // Tests if Google Now will invoke startPollingCards when all
   // of the required state is fulfilled.
 
   // Setup and expectations.
@@ skipping 10 matching lines @@
       this,
       testIdentityToken,
       testExperimentVariationParams,
       testNotificationPermissionLevel,
       testGoogleNowEnabled);
 
   this.mockGlobals.expects(once()).setBackgroundEnable(true);
   this.mockGlobals.expects(once()).startPollingCards();
   this.mockGlobals.expects(never()).stopPollingCards();
   this.mockGlobals.expects(never()).removeAllCards();
+  this.mockGlobals.expects(never()).pollOptedInNoImmediateRecheck();
+  this.mockApis.expects(once()).optInPollAttempts_stop();
 
   // Invoking the tested function.
   initialize();
 });
 
 /**
  * No Cards Event Recording Tests
  */
 TEST_F(TEST_NAME, 'NoCardsSignedOut', function() {
   var signedIn = false;
   var notificationEnabled = false;
   var googleNowEnabled = false;
   this.makeAndRegisterMockGlobals([
       'recordEvent',
       'removeAllCards',
       'setBackgroundEnable',
-      'setShouldPollCards']);
+      'setShouldPollCards',
+      'setShouldPollOptInStatus']);
 
   this.mockGlobals.stubs().removeAllCards();
   this.mockGlobals.stubs().setBackgroundEnable(ANYTHING);
   this.mockGlobals.stubs().setShouldPollCards(ANYTHING);
+  this.mockGlobals.stubs().setShouldPollOptInStatus(ANYTHING);
 
   this.mockGlobals.expects(once()).recordEvent(
       GoogleNowEvent.STOPPED);
   this.mockGlobals.expects(once()).recordEvent(
       GoogleNowEvent.SIGNED_OUT);
   this.mockGlobals.expects(never()).recordEvent(
       GoogleNowEvent.NOTIFICATION_DISABLED);
   this.mockGlobals.expects(never()).recordEvent(
       GoogleNowEvent.GOOGLE_NOW_DISABLED);
   updateRunningState(signedIn, true, notificationEnabled, googleNowEnabled);
 });
 
 TEST_F(TEST_NAME, 'NoCardsNotificationsDisabled', function() {
   var signedIn = true;
   var notificationEnabled = false;
   var googleNowEnabled = false;
   this.makeAndRegisterMockGlobals([
       'recordEvent',
       'removeAllCards',
       'setBackgroundEnable',
-      'setShouldPollCards']);
+      'setShouldPollCards',
+      'setShouldPollOptInStatus']);
 
   this.mockGlobals.stubs().removeAllCards();
   this.mockGlobals.stubs().setBackgroundEnable(ANYTHING);
   this.mockGlobals.stubs().setShouldPollCards(ANYTHING);
+  this.mockGlobals.stubs().setShouldPollOptInStatus(ANYTHING);
 
   this.mockGlobals.expects(once()).recordEvent(
       GoogleNowEvent.STOPPED);
   this.mockGlobals.expects(never()).recordEvent(
       GoogleNowEvent.SIGNED_OUT);
   this.mockGlobals.expects(once()).recordEvent(
       GoogleNowEvent.NOTIFICATION_DISABLED);
   this.mockGlobals.expects(never()).recordEvent(
       GoogleNowEvent.GOOGLE_NOW_DISABLED);
   updateRunningState(signedIn, true, notificationEnabled, googleNowEnabled);
 });
 
 TEST_F(TEST_NAME, 'NoCardsGoogleNowDisabled', function() {
   var signedIn = true;
   var notificationEnabled = true;
   var googleNowEnabled = false;
   this.makeAndRegisterMockGlobals([
       'recordEvent',
       'removeAllCards',
       'setBackgroundEnable',
-      'setShouldPollCards']);
+      'setShouldPollCards',
+      'setShouldPollOptInStatus']);
 
   this.mockGlobals.stubs().removeAllCards();
   this.mockGlobals.stubs().setBackgroundEnable(ANYTHING);
   this.mockGlobals.stubs().setShouldPollCards(ANYTHING);
+  this.mockGlobals.stubs().setShouldPollOptInStatus(ANYTHING);
 
   this.mockGlobals.expects(never()).recordEvent(
       GoogleNowEvent.STOPPED);
   this.mockGlobals.expects(never()).recordEvent(
       GoogleNowEvent.SIGNED_OUT);
   this.mockGlobals.expects(never()).recordEvent(
       GoogleNowEvent.NOTIFICATION_DISABLED);
   this.mockGlobals.expects(once()).recordEvent(
       GoogleNowEvent.GOOGLE_NOW_DISABLED);
   updateRunningState(signedIn, true, notificationEnabled, googleNowEnabled);
 });
 
 TEST_F(TEST_NAME, 'NoCardsEverythingEnabled', function() {
   var signedIn = true;
   var notificationEnabled = true;
   var googleNowEnabled = true;
   this.makeAndRegisterMockGlobals([
       'recordEvent',
       'removeAllCards',
       'setBackgroundEnable',
-      'setShouldPollCards']);
+      'setShouldPollCards',
+      'setShouldPollOptInStatus']);
 
   this.mockGlobals.stubs().removeAllCards();
   this.mockGlobals.stubs().setBackgroundEnable(ANYTHING);
   this.mockGlobals.stubs().setShouldPollCards(ANYTHING);
+  this.mockGlobals.stubs().setShouldPollOptInStatus(ANYTHING);
 
   this.mockGlobals.expects(never()).recordEvent(
       GoogleNowEvent.STOPPED);
   this.mockGlobals.expects(never()).recordEvent(
       GoogleNowEvent.SIGNED_OUT);
   this.mockGlobals.expects(never()).recordEvent(
       GoogleNowEvent.NOTIFICATION_DISABLED);
   this.mockGlobals.expects(never()).recordEvent(
       GoogleNowEvent.GOOGLE_NOW_DISABLED);
   updateRunningState(signedIn, true, notificationEnabled, googleNowEnabled);
@@ skipping 303 matching lines @@
       cards: [],
       cardsTimestamp: 3000000
     }
   };
 
   var expectedUpdatedRecentDismissals = {
     c5: 1800001
   };
 
   this.makeAndRegisterMockGlobals([
-    'scheduleNextPoll'
+    'scheduleNextCardsPoll'
   ]);
 
   this.makeAndRegisterMockApis([
     'fillFromChromeLocalStorage',
   ]);
 
   expectChromeLocalStorageGet(
       this,
       {
         notificationGroups: {},
         recentDismissals: {}
       },
       {
         notificationGroups: storedGroups,
         recentDismissals: recentDismissals
       });
 
-  this.mockGlobals.expects(once()).
-      scheduleNextPoll(eqJSON(expectedUpdatedGroups), true);
+  this.mockGlobals.expects(once())
+      .scheduleNextCardsPoll(eqJSON(expectedUpdatedGroups));
 
   // Invoking the tested function.
   processServerResponse(serverResponse);
 });
 
 TEST_F(TEST_NAME, 'ProcessServerResponseGoogleNowDisabled', function() {
   // Tests processServerResponse function for the case when the response
   // indicates that Google Now is disabled.
 
   // Setup and expectations.
   var serverResponse = {
     googleNowDisabled: true,
     groups: {}
   };
 
   this.makeAndRegisterMockGlobals([
-    'onStateChange',
-    'scheduleNextPoll',
+    'scheduleNextCardsPoll'
   ]);
 
   this.makeAndRegisterMockApis([
     'chrome.storage.local.set',
     'fillFromChromeLocalStorage'
   ]);
 
   this.mockApis.expects(once()).
       chrome_storage_local_set(eqJSON({googleNowEnabled: false}));
 
-  this.mockGlobals.expects(once()).onStateChange();
-
-  this.mockGlobals.expects(once()).scheduleNextPoll(eqJSON({}), false);
+  this.mockGlobals.expects(never()).scheduleNextCardsPoll();
 
   // Invoking the tested function.
   processServerResponse(serverResponse);
 });