Enable the FCM integration test (IT) for Chrome.

Context: the tests were switched off a couple of years ago due to flakiness. It has not been maintained since then. During the time, Some Selenium API methods used were deprecated and removed; the Firebase projects used are no longer managed or owned by the FCM team. Consequently, the test became unfunctional. In the effort of providing safety for the upcoming FCM releases, this PR is created to fix, deflake, refactor and improve the old tests.

This PR did the following:
- Enabled comprehensive IT for chrome (ver.80). Now we are covering send&foreground recevie for FCM messages (messages with {notification} payload, {data} payload and {notification, data} payload), delete/update token, use default/customized ServiceWorker.

- Defalaked test. The IT is now reasonably stable without retry. Previously we are retrying 1 or 3 times.

- Optimized test. Previously we create a webDriver for each test, which is slow and annoying. Because a window is created and brought to focus and killed frequently, it makes working on other tasks and testing nearly impossible (Probably using a headless browser would work but I haven't found a satisfying solution to have the app in the state of foreground and background which is a requirement for FCM functions). With the way the tests are organized, the IT only spin up a new web driver when necessary. Some data on performance: (old) 'test-send' take 74 seconds (only measured 'test-send' because the other test suites were not functional at the time); (now) 'test-send', 'test-deleteToken', 'test-updateToken', 'test-useDefaultServiceWorker', 'test-useValidManifest' takes in total 33s (10 run average).

- General refactoring. Including refactors on expect blocks, createWebDriver, use const for constants usage, etc. The code should be much easier to understand and maintain.

Future work:
- Enable test on firefox once I get the notification permission working.
- Run the IC against some milestone chrome/firefox version (if it makes sense) to ensure backward compatibility. We should try to avoid #2712 . :)

Author: Kai Wu

integration/messaging/download-browsers.js

@@ -18,14 +18,9 @@
 const seleniumAssistant = require('selenium-assistant');
 
 console.log('Starting browser download - this may take some time.');
-Promise.all([
-  seleniumAssistant.downloadLocalBrowser('chrome', 'stable', 48),
-  seleniumAssistant.downloadLocalBrowser('chrome', 'beta', 48),
-  seleniumAssistant.downloadLocalBrowser('chrome', 'unstable', 48),
-  seleniumAssistant.downloadLocalBrowser('firefox', 'stable', 48),
-  seleniumAssistant.downloadLocalBrowser('firefox', 'beta', 48),
-  seleniumAssistant.downloadLocalBrowser('firefox', 'unstable', 48)
-])
+// TODO: enable firefox testing once figure out how to give notification permission with SE webdriver.
+// TODO: Run the integration test against multiple major chrome versions to ensure backward compatibility
+Promise.all([seleniumAssistant.downloadLocalBrowser('chrome', 'stable', 80)])
   .then(() => {
     console.log('Browser download complete.');
   })

integration/messaging/package.json

@@ -4,7 +4,7 @@
   "version": "0.2.1",
   "scripts": {
     "pretest:manual": "node ./download-browsers.js",
-    "test": "echo 'Tests disabled due to flakiness'",
+    "test": "mocha --exit",
     "test:manual": "mocha --exit"
   },
   "dependencies": {

integration/messaging/test/static/app.js

@@ -15,8 +15,6 @@
  * limitations under the License.
  */
 
-const EIGHT_DAYS_IN_MS = 8 * 86400000;
-
 /**
  * This class just wraps the expected behavior or a demo app that will
  * be orchestrated by selenium tests (Although manual use of the demo will
@@ -36,40 +34,45 @@ class DemoApp {
     this._triggerDeleteToken = this.triggerDeleteToken;
     this._triggerGetToken = this.triggerGetToken;
     this._triggerTimeForward = this.triggerTimeForward;
+    this._clearInstanceForTest = this.clearInstanceForTest;
 
     // Initialize Firebase
     firebase.initializeApp(firebaseConfig);
 
     this._messaging = firebase.messaging();
 
-    if (options.applicationKey) {
-      this._messaging.usePublicVapidKey(options.applicationKey);
+    if (options.vapidKey) {
+      console.debug('VapidKey is provided to the test app. ');
+      this._messaging.usePublicVapidKey(options.vapidKey);
+    } else {
+      console.debug('VapidKey is not specified. Skip setting it');
     }
 
     if (options.swReg) {
+      console.debug('ServiceWorker is provided to the test app');
       this._messaging.useServiceWorker(options.swReg);
+    } else {
+      console.debug(
+        'ServiceWorker is not specified. The default ServiceWorker will be used.'
+      );
     }
 
     this._messaging.onMessage(payload => {
       console.log(`Message received: `, payload);
       this._messages.push(payload);
     });
 
-    // Initializa state of token
-    this._messaging
-      .requestPermission()
-      .then(() => this._messaging.getToken())
-      .then(
-        token => {
-          console.log('getToken() worked: ', token);
-          this._token = token;
-        },
-        err => {
-          console.log('getToken() failed: ', err.message, err.stack);
-          this._errors.push(err);
-          this._token = null;
-        }
-      );
+    this._messaging.getToken().then(
+      token => {
+        console.log('Test app getToken() succeed. Token: ', token);
+        this._token = token;
+      },
+      err => {
+        console.log('Test app getToken() failed: ', err.message, err.stack);
+        this._errors.push(err);
+        this._token = null;
+      }
+    );
   }
 
   async triggerDeleteToken(token) {
@@ -99,6 +102,11 @@ class DemoApp {
     this._clock.tick(EIGHT_DAYS_IN_MS);
   }
 
+  async clearInstanceForTest() {
+    this._errors = [];
+    this._messages = [];
+  }
+
   get token() {
     return this._token;
   }

integration/messaging/test/static/constants.js

@@ -0,0 +1,3 @@
+const EIGHT_DAYS_IN_MS = 8 * 86400000;
+const PUBLIC_VAPID_KEY =
+  'BAN_2QvaSnxnjz-2y1sARN1ErEpZhcb8kaSI08pLxiAtQPB4ja3wg_1T0cGBMpt-vRd_6G1LZeVcVYlQeSPlbt8';

integration/messaging/test/static/default-sw/index.html

@@ -1,17 +1,20 @@
 <html>
-    <head>
-      <title>FCM Demo</title>
-      <meta name="viewport" content="width=device-width,initial-scale=1">
-    </head>
-    <body>
-      <h1>Default SW</h1>
-      <script src="/firebase/firebase-app.js"></script>
-      <script src="/firebase/firebase-messaging.js"></script>
-      <script src="/app.js"></script>
-      <script src="../valid-no-vapid-key/firebaseConfig.js"></script>
-      <script src="https://cdnjs.cloudflare.com/ajax/libs/sinon.js/4.1.3/sinon.min.js"></script>
-      <script>
-        window.__test = new window.DemoApp(window.firebaseConfig);
-      </script>
-    </body>
-    </html>
+  <head>
+    <title>FCM Demo</title>
+    <meta name="viewport" content="width=device-width,initial-scale=1" />
+  </head>
+  <body>
+    <h1>Default SW</h1>
+    <script src="https://www.gstatic.com/firebasejs/7.14.0/firebase-app.js"></script>
+    <script src="https://www.gstatic.com/firebasejs/7.14.0/firebase-messaging.js"></script>
+    <script src="/app.js"></script>
+    <script src="/firebaseConfig.js"></script>
+    <script src="/constants.js"></script>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/sinon.js/4.1.3/sinon.min.js"></script>
+    <script>
+      window.__test = new window.DemoApp(FIREBASE_CONFIG, {
+        vapidKey: PUBLIC_VAPID_KEY
+      });
+    </script>
+  </body>
+</html>

integration/messaging/test/static/firebase-messaging-sw.js

@@ -14,14 +14,38 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+importScripts('https://www.gstatic.com/firebasejs/7.10.0/firebase-app.js');
+importScripts(
+  'https://www.gstatic.com/firebasejs/7.10.0/firebase-messaging.js'
+);
+importScripts('/firebaseConfig.js');
+firebase.initializeApp(FIREBASE_CONFIG);
 
-importScripts('/sw-shared.js');
-importScripts('/valid-no-vapid-key/firebaseConfig.js');
+const messaging = firebase.messaging();
 
-firebase.initializeApp(self.firebaseConfig);
+messaging.setBackgroundMessageHandler(payload => {
+  console.log(
+    'Received a background message: ' +
+      JSON.stringify(payload) +
+      '. Routing the message to the test app messages container to be read'
+  );
 
-const messaging = firebase.messaging();
-messaging.setBackgroundMessageHandler(data => {
-  const title = 'Background Notification';
-  return self.registration.showNotification(title, {});
+  sendMessageToWindowClients(getClients(), markBackgroundMessage(payload));
 });
+
+function getClients() {
+  return self.clients.matchAll({
+    type: 'window',
+    includeUncontrolled: true
+  });
+}
+
+function sendMessageToWindowClients(clientList, payload) {
+  for (const client of clientList) {
+    client.postMessage({ ...message, 'isBackgroundMessage': true });
+  }
+}
+
+function markBackgroundMessage(payload) {
+  return { ...payload, 'isBackgroundMessage': true };
+}

integration/messaging/test/static/valid-vapid-key/firebaseConfig.js renamed to integration/messaging/test/static/firebaseConfig.js

@@ -15,19 +15,20 @@
  * limitations under the License.
  */
 
-const config = {
-  apiKey: 'AIzaSyCaSnFca0oG_b-t-s_p9wRdr9o9aSPmolE',
-  authDomain: 'fcm-sdk-testing-vapid-key.firebaseapp.com',
-  databaseURL: 'https://fcm-sdk-testing-vapid-key.firebaseio.com',
-  projectId: 'fcm-sdk-testing-vapid-key',
-  storageBucket: '',
-  messagingSenderId: '650229866790'
+const FIREBASE_CONFIG = {
+  apiKey: 'AIzaSyBVqFz5vuknTmaVJyRnjxSolqhc8hXx0M4',
+  authDomain: 'android-gcm-test-519bd.firebaseapp.com',
+  databaseURL: 'https://android-gcm-test-519bd.firebaseio.com',
+  projectId: 'android-gcm-test-519bd',
+  storageBucket: 'android-gcm-test-519bd.appspot.com',
+  messagingSenderId: '35006771263',
+  appId: '1:35006771263:web:18cc19582bf589e8c9c88a'
 };
 
 if (this['window']) {
-  window.firebaseConfig = config;
+  window.firebaseConfig = FIREBASE_CONFIG;
 } else if (this['module']) {
-  module.exports = config;
+  module.exports = FIREBASE_CONFIG;
 } else {
-  self.firebaseConfig = config;
+  self.firebaseConfig = FIREBASE_CONFIG;
 }

integration/messaging/test/static/invalid-manifest/index.html

@@ -1,18 +1,19 @@
 <html>
-    <head>
-      <title>FCM Demo</title>
-      <link rel="manifest" href="./manifest.json">
-      <meta name="viewport" content="width=device-width,initial-scale=1">
-    </head>
-    <body>
-      <h1>Valid Manifest</h1>
-      <script src="/firebase/firebase-app.js"></script>
-      <script src="/firebase/firebase-messaging.js"></script>
-      <script src="/app.js"></script>
-      <script src="../valid-no-vapid-key/firebaseConfig.js"></script>
-      <script src="https://cdnjs.cloudflare.com/ajax/libs/sinon.js/4.1.3/sinon.min.js"></script>
-      <script>
-        window.__test = new window.DemoApp(window.firebaseConfig);
-      </script>
-    </body>
-    </html>
+  <head>
+    <title>FCM Demo</title>
+    <link rel="manifest" href="./manifest.json" />
+    <meta name="viewport" content="width=device-width,initial-scale=1" />
+  </head>
+  <body>
+    <h1>Valid Manifest</h1>
+    <script src="https://www.gstatic.com/firebasejs/7.14.0/firebase-app.js"></script>
+    <script src="https://www.gstatic.com/firebasejs/7.14.0/firebase-messaging.js"></script>
+    <script src="/app.js"></script>
+    <script src="/firebaseConfig.js"></script>
+    <script src="/constants.js"></script>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/sinon.js/4.1.3/sinon.min.js"></script>
+    <script>
+      window.__test = new window.DemoApp(window.firebaseConfig, {});
+    </script>
+  </body>
+</html>

integration/messaging/test/static/invalid-manifest/manifest.json

@@ -1,3 +1,3 @@
 {
-  "gcm_sender_id": "103953800507"
+  "gcm_sender_id": "35006771263"
 }