Switching getting/dismissing cards to new protocol

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.
 
 /**
  * Test fixture for background.js.
  * @constructor
  * @extends {testing.Test}
  */
 function GoogleNowBackgroundUnitTest () {
@@ skipping 31 matching lines @@
   testTaskPair(RETRY_DISMISS_TASK_NAME, DISMISS_CARD_TASK_NAME, true);
   testTaskPair(RETRY_DISMISS_TASK_NAME, RETRY_DISMISS_TASK_NAME, true);
   testTaskPair(RETRY_DISMISS_TASK_NAME, STATE_CHANGED_TASK_NAME, false);
 
   testTaskPair(STATE_CHANGED_TASK_NAME, UPDATE_CARDS_TASK_NAME, false);
   testTaskPair(STATE_CHANGED_TASK_NAME, DISMISS_CARD_TASK_NAME, false);
   testTaskPair(STATE_CHANGED_TASK_NAME, RETRY_DISMISS_TASK_NAME, false);
   testTaskPair(STATE_CHANGED_TASK_NAME, STATE_CHANGED_TASK_NAME, false);
 });
 
+var testNotificationId = 'TEST GROUP-SOME TEST ID';
+var testChromeNotificationId = 'TEST CARD ID';
+var testNotification1 =
+    {testNotificationField: 'TEST NOTIFICATION VALUE1', priority: -1};
+var testNotification2 =
+    {testNotificationField: 'TEST NOTIFICATION VALUE2', priority: 0};
+var testActionUrls1 = {testField: 'TEST VALUE1'};
+var testActionUrls2 = {testField: 'TEST VALUE2'};
+var testDismissal1 = {testDismissalField: 'TEST DISMISSAL VALUE 1'};
+var testDismissal2 = {testDismissalField: 'TEST DISMISSAL VALUE 2'};
+var testVersion = 7;
+var testTimestamp1 = 300000;
+var testTimestamp2 = 600000;
+var testGroupRank1 = 19;
+var testGroupRank2 = 23;
+var testTriggerWire = {showTimeSec: 100, hideTimeSec: 200};
+var testTriggerMerged = {showTime: 300007, hideTime: 300011};
+var testVersion1 = 29;
+var testVersion2 = 31;
+
+TEST_F(
+    'GoogleNowBackgroundUnitTest',
+    'MergeCardsEmptyNoTrigger',
+    function() {
+      // Tests merging a card with an empty trigger into an 'undefined' merged
+      // card. This should start a new card.
+
+      // Invoking the tested function.
+      var resultingMergedCard = mergeCards(undefined, {
+        notificationId: testNotificationId,
+        chromeNotificationId: testChromeNotificationId,
+        version: testVersion1,
+        chromeNotificationOptions: testNotification1,
+        actionUrls: testActionUrls1,
+        dismissal: testDismissal1
+      }, testTimestamp1, testGroupRank1);
+
+      // Check the return value.
+      assertEquals(
+          JSON.stringify({
+            dismissals: [{notificationId: testNotificationId, parameters: testDismissal1}],

[robliao, 2013/09/27 19:41:55]

Add Linebreak

[vadimt, 2013/09/27 21:06:00]

Done.

+            groupRank: testGroupRank1,
+            trigger: {},
+            timestamp: testTimestamp1,
+            notification: testNotification1,
+            actionUrls: testActionUrls1,
+            version: testVersion1
+          }),
+        JSON.stringify(resultingMergedCard));
+    });
+
+TEST_F(
+    'GoogleNowBackgroundUnitTest',
+    'MergeCards1',
+    function() {
+      // Tests merging a wire card into a merged card.
+      // Wire card priority is greater than merged card one. Wire card rank is

[robliao, 2013/09/27 19:41:55]

Do we have a case where wire card priority == merged card priority

[vadimt, 2013/09/27 21:06:00]

No; I just didn't think it's an interesting case to test. We need to stop at
some point :)

[robliao, 2013/09/27 21:17:22]

It may be interesting if the merged card changed in an unexpected way with a
wire card of an equal priority.
On 2013/09/27 21:06:00, vadimt wrote:

[vadimt, 2013/09/30 17:07:04]

Well, here we know that priority is not used for decision making. We cannot
pretend we know nothing about the tested algorithm. Otherwise, we could ask "why
not test for the case where priority is the 10-th prime number"? You Never Can
Tell With Bees.

So, we just get max of 2 priorities, and I believe that 2 cases (> and <) is
sufficient.

+      // less than merged card one, and it's older.
+
+      // Setup.
+      var mergedCard = {
+        trigger: testTriggerMerged,
+        version: testVersion1,
+        timestamp: testTimestamp2,
+        notification: testNotification1,
+        actionUrls: testActionUrls1,
+        groupRank: testGroupRank2,
+        dismissals:
+            [{notificationId: testNotificationId, parameters: testDismissal1}]
+      };
+
+      var unmergedNotification = {
+        notificationId: testNotificationId,
+        chromeNotificationId: testChromeNotificationId,
+        version: testVersion2,
+        chromeNotificationOptions: testNotification2,
+        actionUrls: testActionUrls2,
+        dismissal: testDismissal2,
+        trigger: testTriggerWire
+      };
+
+      // Invoking the tested function.
+      var resultingMergedCard = mergeCards(
+          mergedCard, unmergedNotification, testTimestamp1, testGroupRank1);
+
+      // Check the return value.
+      assertEquals(
+          JSON.stringify({
+            trigger: testTriggerMerged,
+            version: testVersion1,
+            timestamp: testTimestamp2,
+            notification: {
+                testNotificationField: 'TEST NOTIFICATION VALUE1',
+                priority: 0
+             },
+            actionUrls: testActionUrls1,
+            groupRank: testGroupRank2,
+            dismissals: [
+              {notificationId: testNotificationId, parameters: testDismissal1},
+              {notificationId: testNotificationId, parameters: testDismissal2}
+            ]
+          }),
+        JSON.stringify(resultingMergedCard));
+    });
+
+TEST_F(
+    'GoogleNowBackgroundUnitTest',
+    'MergeCards2',
+    function() {
+      // Tests merging a wire card into a merged card.
+      // Wire card priority is less than merged card one. Wire card rank is
+      // greater than merged card one, and it's older.
+
+      // Setup.
+      var mergedCard = {
+        trigger: testTriggerMerged,
+        version: testVersion1,
+        timestamp: testTimestamp2,
+        notification: testNotification2,
+        actionUrls: testActionUrls1,
+        groupRank: testGroupRank1,
+        dismissals:
+            [{notificationId: testNotificationId, parameters: testDismissal1}]
+      };
+
+      var unmergedNotification = {
+        notificationId: testNotificationId,
+        chromeNotificationId: testChromeNotificationId,
+        version: testVersion2,
+        chromeNotificationOptions: testNotification1,
+        actionUrls: testActionUrls2,
+        dismissal: testDismissal2,
+        trigger: testTriggerWire
+      };
+
+      // Invoking the tested function.
+      var resultingMergedCard = mergeCards(
+          mergedCard, unmergedNotification, testTimestamp1, testGroupRank2);
+
+      // Check the return value.
+      assertEquals(
+          JSON.stringify({
+            trigger: {showTime: 400000, hideTime: 500000},
+            version: testVersion1,
+            timestamp: testTimestamp2,
+            notification: {
+                testNotificationField: 'TEST NOTIFICATION VALUE2',
+                priority: 0
+             },
+            actionUrls: testActionUrls1,
+            groupRank: testGroupRank2,
+            dismissals: [
+              {notificationId: testNotificationId, parameters: testDismissal1},
+              {notificationId: testNotificationId, parameters: testDismissal2}
+            ]
+          }),
+        JSON.stringify(resultingMergedCard));
+    });
+
+TEST_F(
+    'GoogleNowBackgroundUnitTest',
+    'MergeCards3',
+    function() {
+      // Tests merging a wire card into a merged card.
+      // Wire card priority is less than merged card one. Wire card rank is
+      // less than merged card one, and it's newer.
+
+      // Setup.
+      var mergedCard = {
+        trigger: testTriggerMerged,
+        version: testVersion1,
+        timestamp: testTimestamp1,
+        notification: testNotification2,
+        actionUrls: testActionUrls1,
+        groupRank: testGroupRank2,
+        dismissals:
+            [{notificationId: testNotificationId, parameters: testDismissal1}]
+      };
+
+      var unmergedNotification = {
+        notificationId: testNotificationId,
+        chromeNotificationId: testChromeNotificationId,
+        version: testVersion2,
+        chromeNotificationOptions: testNotification1,
+        actionUrls: testActionUrls2,
+        dismissal: testDismissal2,
+        trigger: testTriggerWire
+      };
+
+      // Invoking the tested function.
+      var resultingMergedCard = mergeCards(
+          mergedCard, unmergedNotification, testTimestamp2, testGroupRank1);
+
+      // Check the return value.
+      assertEquals(
+          JSON.stringify({
+            trigger: testTriggerMerged,
+            version: testVersion2,
+            timestamp: testTimestamp2,
+            notification: {
+                testNotificationField: 'TEST NOTIFICATION VALUE1',
+                priority: 0
+             },
+            actionUrls: testActionUrls2,
+            groupRank: testGroupRank2,
+            dismissals: [
+              {notificationId: testNotificationId, parameters: testDismissal1},
+              {notificationId: testNotificationId, parameters: testDismissal2}
+            ]
+          }),
+        JSON.stringify(resultingMergedCard));
+    });
+
+TEST_F(
+    'GoogleNowBackgroundUnitTest',
+    'MergeGroup',
+    function() {
+      // Tests mergeGroup method.
+
+      // Setup.
+      this.makeAndRegisterMockGlobals(['mergeCards']);
+
+      this.mockGlobals.expects(once()).
+          mergeCards(
+              undefined,
+              eqJSON({chromeNotificationId: 'ID 1', testField: 'TEST_FIELD1'}),
+              300000,
+              17).
+          will(returnValue({testField: 'RESULT 1'}));
+      this.mockGlobals.expects(once()).
+          mergeCards(
+              eqJSON({testField: 'TEST_FIELD22'}),
+              eqJSON({chromeNotificationId: 'ID 2', testField: 'TEST_FIELD2'}),
+              300000,
+              17).
+          will(returnValue({testField: 'RESULT 2'}));
+
+      var group = {
+        cards: [
+          {chromeNotificationId: 'ID 1', testField: 'TEST_FIELD1'},
+          {chromeNotificationId: 'ID 2', testField: 'TEST_FIELD2'}
+        ],
+        cardsTimestamp: 300000,
+        nextPollTime: 600000,
+        rank: 17
+      };
+
+      var mergedCards = {
+        'ID 2': { testField: 'TEST_FIELD22' },
+        'ID 3': { testField: 'TEST_FIELD3' }
+      };
+
+      // Invoking the tested function.
+      mergeGroup(mergedCards, group);
+
+      // Check the output parameter.
+      assertEquals(
+          JSON.stringify({
+            'ID 2': { testField: 'RESULT 2' },
+            'ID 3': { testField: 'TEST_FIELD3'},
+            'ID 1': { testField: 'RESULT 1' }}),
+          JSON.stringify(mergedCards));
+    });
+
 /**
  * Mocks global functions and APIs that initialize() depends upon.
  * @param {Test} fixture Test fixture.
  */
 function mockInitializeDependencies(fixture) {
   fixture.makeAndRegisterMockGlobals([
     'recordEvent',
     'setBackgroundEnable',
     'showWelcomeToast',
     'startPollingCards'
   ]);
   fixture.makeAndRegisterMockApis([
     'authenticationManager.isSignedIn',
     'chrome.location.clearWatch',
-    'chrome.storage.local.set',
+    'chrome.storage.local.remove',
     'instrumented.metricsPrivate.getVariationParams',
     'instrumented.notifications.getAll',
     'instrumented.preferencesPrivate.googleGeolocationAccessEnabled.get',
     'instrumented.storage.local.get',
     'tasks.add',
     'updateCardsAttempts.isRunning',
     'updateCardsAttempts.stop'
   ]);
 }
 
@@ skipping 64 matching lines @@
  * 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(mockApisObj) {
   mockApisObj.expects(once()).
       chrome_location_clearWatch(ANYTHING);
   mockApisObj.expects(once()).
       updateCardsAttempts_stop();
   mockApisObj.expects(once()).
-      chrome_storage_local_set(eqJSON({notificationsData: {}}));
+      chrome_storage_local_remove(
+          eqJSON(['notificationsData', 'notificationGroups']));
   var tasksAddSavedArgs = new SaveMockArguments();
   mockApisObj.expects(once()).
       tasks_add(
           tasksAddSavedArgs.match(ANYTHING),
           tasksAddSavedArgs.match(ANYTHING)).
       will(invokeCallback(tasksAddSavedArgs, 1, function() {}));
   var updateCardsAttemptsIsRunningSavedArgs = new SaveMockArguments();
   mockApisObj.expects(once()).
       updateCardsAttempts_isRunning(
           updateCardsAttemptsIsRunningSavedArgs.match(ANYTHING)).
@@ skipping 357 matching lines @@
               chromeTabsCreateSavedArgs.match(eqJSON({url: testActionUrl})),
               chromeTabsCreateSavedArgs.match(ANYTHING)).
           will(invokeCallback(chromeTabsCreateSavedArgs, 1, testCreatedTab));
       this.mockApis.expects(once()).chrome_windows_create(
           eqJSON({url: testActionUrl, focused: true}));
 
       // Invoking the tested function.
       onNotificationClicked(
           testNotificationId, this.mockLocalFunctions.functions().selector);
     });