Enable FCM Integration Test

integration/messaging/download-browsers.js

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2017 Google Inc.
+ * Copyright 2017 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -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,15 +4,15 @@
   "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": {
     "firebase": "7.14.6"
   },
   "devDependencies": {
     "chai": "4.2.0",
-    "chromedriver": "80.0.2",
+    "chromedriver": "^83.0.0",
     "express": "4.17.1",
     "geckodriver": "1.19.1",
     "mocha": "7.1.2",

integration/messaging/test/static/app.js

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2017 Google Inc.
+ * Copyright 2017 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -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,49 @@ class DemoApp {
     this._triggerDeleteToken = this.triggerDeleteToken;
     this._triggerGetToken = this.triggerGetToken;
     this._triggerTimeForward = this.triggerTimeForward;
+    this._clearInstanceForTest = this.clearInstanceForTest;
+    this.appendMessage = this.appendMessage;
 
     // 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);
+    this._messaging.onMessage(message => {
+      this.appendMessage(message);
     });
 
-    // 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;
+      }
+    );
+  }
+
+  appendMessage(payload) {
+    this._messages.push(payload);
   }
 
   async triggerDeleteToken(token) {
@@ -95,10 +102,15 @@ class DemoApp {
     return this._token;
   }
 
-  async triggerTimeForward() {
+  triggerTimeForward() {
     this._clock.tick(EIGHT_DAYS_IN_MS);
   }
 
+  clearInstanceForTest() {
+    this._errors = [];
+    this._messages = [];
+  }
+
   get token() {
     return this._token;
   }

integration/messaging/test/static/constants.js

@@ -0,0 +1,35 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// Test project managed by the FCM team
+const PUBLIC_VAPID_KEY =
+  'BNjjus3nz38aYtbDLVfunY3VULg0Yq5T4GXWd7iDDmeqWCUNqfrK1eiKVdoT0VncLuCjfJ1GmdfmNZz-AjHfkxM';
+const FIREBASE_CONFIG = {
+  apiKey: 'AIzaSyBpIe0xyUNHOwtE_go32NmUJF4acsc6S6c',
+  projectId: 'fcm-web-sdk-test',
+  messagingSenderId: '750970317741',
+  appId: '1:750970317741:web:f382be3155e250906a4f24'
+};
+
+const TAG = 'FCM_INTEGRATION_TEST: ';
+const EIGHT_DAYS_IN_MS = 8 * 86400000;
+const TEST_DB = 'FCM_INTEGRATION_TEST_DB';
+const TEST_DB_VERSION = 1;
+const BACKGROUND_MESSAGES_OBJECT_STORE = 'background_messages';
+// indexDb object store creation require a "primary key", "ndx" is used.
+const BACKGROUND_MESSAGES_OBJECT_STORE_PRIMARY_KEY = 'ndx';
+const BACKGROUND_MESSAGES_OBJECT_STORE_DEFAULT_NDX = 'default_ndx';

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

@@ -1,17 +1,19 @@
 <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="/firebase-app.js"></script>
+    <script src="/firebase-messaging.js"></script>
+    <script src="../app.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

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2017 Google Inc.
+ * Copyright 2017 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,13 +15,4 @@
  * limitations under the License.
  */
 
-importScripts('/sw-shared.js');
-importScripts('/valid-no-vapid-key/firebaseConfig.js');
-
-firebase.initializeApp(self.firebaseConfig);
-
-const messaging = firebase.messaging();
-messaging.setBackgroundMessageHandler(data => {
-  const title = 'Background Notification';
-  return self.registration.showNotification(title, {});
-});
+importScripts('./sw-base.js');

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

@@ -0,0 +1,71 @@
+/**
+ * @license
+ * Copyright 2017 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+importScripts('../constants.js');
+
+// HEAD targets served through express
+importScripts('/firebase-app.js');
+importScripts('/firebase-messaging.js');
+
+firebase.initializeApp(FIREBASE_CONFIG);
+const messaging = firebase.messaging();
+
+messaging.setBackgroundMessageHandler(payload => {
+  console.log(
+    TAG +
+      'a background message is received: ' +
+      JSON.stringify(payload) +
+      '. Storing it into idb for tests to read...'
+  );
+
+  addPayloadToDb(payload);
+});
+
+async function addPayloadToDb(payload) {
+  const dbOpenReq = indexedDB.open(TEST_DB);
+
+  dbOpenReq.onupgradeneeded = () => {
+    const db = dbOpenReq.result;
+
+    // store creation is a synchronized call
+    console.log('creating object store...');
+    db.createObjectStore(BACKGROUND_MESSAGES_OBJECT_STORE, {
+      keyPath: BACKGROUND_MESSAGES_OBJECT_STORE_PRIMARY_KEY
+    });
+  };
+
+  dbOpenReq.onsuccess = () => {
+    const db = dbOpenReq.result;
+
+    addPayloadToDbInternal(db, {
+      ...payload,
+      // ndx is required as the primary key of the store. It doesn't have any other testing purpose
+      ndx: BACKGROUND_MESSAGES_OBJECT_STORE_DEFAULT_NDX
+    });
+  };
+}
+
+async function addPayloadToDbInternal(db, payload) {
+  // onsuccess might race with onupgradeneeded. Consequently causing " object stores was not found" error. Therefore, wait briefly for db.createObjectStore to complete
+  const delay = ms => new Promise(res => setTimeout(res, ms));
+  await delay(/* milliseconds= */ 30000);
+
+  tx = db.transaction(BACKGROUND_MESSAGES_OBJECT_STORE, 'readwrite');
+
+  console.log('adding message payload to db: ' + JSON.stringify(payload));
+  addReq = tx.objectStore(BACKGROUND_MESSAGES_OBJECT_STORE).add(payload);
+}

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

@@ -1,18 +1,18 @@
 <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="/firebase-app.js"></script>
+    <script src="/firebase-messaging.js"></script>
+    <script src="../app.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, {});
+    </script>
+  </body>
+</html>

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

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