Address comments

Author: mmermerkaya

config/webpack.test.js

@@ -50,7 +50,7 @@ module.exports = {
           options: { esModules: true }
         },
         enforce: 'post',
-        exclude: [/\.test\.ts$/, /test(ing)?\//]
+        exclude: [/\.test\.ts$/, /\btest(ing)?\//]
       },
       {
         test: /\.js$/,

packages/messaging/src/controllers/sw-controller.ts

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2019 Google Inc.
+ * Copyright 2017 Google Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -23,12 +23,13 @@ import {
   MessagePayload,
   NotificationDetails
 } from '../interfaces/message-payload';
-import { FCM_MSG, FN_CAMPAIGN_ID, DEFAULT_VAPID_KEY } from '../util/constants';
+import { FCM_MSG, DEFAULT_VAPID_KEY } from '../util/constants';
 import { MessageType, InternalMessage } from '../interfaces/internal-message';
 import { dbGet } from '../helpers/idb-manager';
 import { Unsubscribe } from '@firebase/util';
 import { sleep } from '../helpers/sleep';
 import { FirebaseApp } from '@firebase/app-types';
+import { isConsoleMessage } from '../helpers/is-console-message';
 
 // Let TS know that this is a service worker
 declare const self: ServiceWorkerGlobalScope;
@@ -355,7 +356,7 @@ function getLink(payload: MessagePayload): string | null {
     return link;
   }
 
-  if (payload.data?.[FN_CAMPAIGN_ID]) {
+  if (isConsoleMessage(payload.data)) {
     // Notification created in the Firebase Console. Redirect to origin.
     return self.location.origin;
   } else {

packages/messaging/src/controllers/window-controller.ts

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2019 Google Inc.
+ * Copyright 2017 Google Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -31,6 +31,8 @@ import {
   DEFAULT_VAPID_KEY
 } from '../util/constants';
 import { FirebaseApp } from '@firebase/app-types';
+import { ConsoleMessageData } from '../interfaces/message-payload';
+import { isConsoleMessage } from '../helpers/is-console-message';
 
 export class WindowController implements FirebaseMessaging {
   private vapidKey: string | null = null;
@@ -187,12 +189,7 @@ export class WindowController implements FirebaseMessaging {
     }
 
     const { data } = payload;
-    if (
-      data &&
-      FN_CAMPAIGN_ID in data &&
-      data[FN_CAMPAIGN_ANALYTICS_ENABLED] === '1'
-    ) {
-      // This message has a campaign id, meaning it was sent using the FN Console.
+    if (isConsoleMessage(data) && data[FN_CAMPAIGN_ANALYTICS_ENABLED] === '1') {
       // Analytics is enabled on this message, so we should log it.
       await this.logEvent(type, data);
     }
@@ -225,11 +222,3 @@ function getEventType(messageType: MessageType): string {
       throw new Error();
   }
 }
-
-/** Additional data of a message sent from the FN Console. */
-interface ConsoleMessageData {
-  [FN_CAMPAIGN_ID]: string;
-  [FN_CAMPAIGN_TIME]: string;
-  [FN_CAMPAIGN_NAME]?: string;
-  [FN_CAMPAIGN_ANALYTICS_ENABLED]?: '1';
-}

packages/messaging/src/core/api.ts

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2017 Google Inc.
+ * Copyright 2019 Google Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,9 +17,8 @@
 
 import { ErrorCode, ERROR_FACTORY } from '../util/errors';
 import { DEFAULT_VAPID_KEY, ENDPOINT } from '../util/constants';
-import { TokenDetails } from '../interfaces/token-details';
+import { TokenDetails, SubscriptionOptions } from '../interfaces/token-details';
 import { FirebaseInternalDependencies } from '../interfaces/internal-dependencies';
-import { SubscriptionOptions } from '../interfaces/subscription-options';
 import { AppConfig } from '../interfaces/app-config';
 
 export interface ApiResponse {

packages/messaging/src/core/token-management.test.ts

@@ -28,9 +28,8 @@ import { dbGet, dbSet } from '../helpers/idb-manager';
 import * as apiModule from './api';
 import { Stub } from '../testing/sinon-types';
 import { getFakeTokenDetails } from '../testing/fakes/token-details';
-import { TokenDetails } from '../interfaces/token-details';
+import { TokenDetails, SubscriptionOptions } from '../interfaces/token-details';
 import { arrayToBase64 } from '../helpers/array-to-base64';
-import { SubscriptionOptions } from '../interfaces/subscription-options';
 
 describe('Token Management', () => {
   let tokenDetails: TokenDetails;

packages/messaging/src/core/token-management.ts

@@ -17,8 +17,7 @@
 
 import { dbGet, dbSet, dbRemove } from '../helpers/idb-manager';
 import { FirebaseInternalDependencies } from '../interfaces/internal-dependencies';
-import { SubscriptionOptions } from '../interfaces/subscription-options';
-import { TokenDetails } from '../interfaces/token-details';
+import { TokenDetails, SubscriptionOptions } from '../interfaces/token-details';
 import { requestUpdateToken, requestGetToken, requestDeleteToken } from './api';
 import { arrayToBase64 } from '../helpers/array-to-base64';
 import { ERROR_FACTORY, ErrorCode } from '../util/errors';

packages/messaging/src/helpers/array-to-base64.test.ts

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2019 Google Inc.
+ * Copyright 2017 Google Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

packages/messaging/src/helpers/idb-manager.ts

@@ -28,15 +28,15 @@ const OBJECT_STORE_NAME = 'firebase-messaging-store';
 let dbPromise: Promise<DB> | null = null;
 function getDbPromise(): Promise<DB> {
   if (!dbPromise) {
-    dbPromise = openDb(DATABASE_NAME, DATABASE_VERSION, upgradeDB => {
+    dbPromise = openDb(DATABASE_NAME, DATABASE_VERSION, upgradeDb => {
       // We don't use 'break' in this switch statement, the fall-through
       // behavior is what we want, because if there are multiple versions between
       // the old version and the current version, we want ALL the migrations
       // that correspond to those versions to run, not only the last one.
       // eslint-disable-next-line default-case
-      switch (upgradeDB.oldVersion) {
+      switch (upgradeDb.oldVersion) {
         case 0:
-          upgradeDB.createObjectStore(OBJECT_STORE_NAME);
+          upgradeDb.createObjectStore(OBJECT_STORE_NAME);
       }
     });
   }

packages/messaging/src/helpers/is-console-message.ts

@@ -0,0 +1,7 @@
+import { ConsoleMessageData } from '../interfaces/message-payload';
+import { FN_CAMPAIGN_ID } from '../util/constants';
+
+export function isConsoleMessage(data: unknown): data is ConsoleMessageData {
+  // This message has a campaign id, meaning it was sent using the FN Console.
+  return typeof data === 'object' && !!data && FN_CAMPAIGN_ID in data;
+}

packages/messaging/src/interfaces/message-payload.ts

@@ -15,6 +15,13 @@
  * limitations under the License.
  */
 
+import {
+  FN_CAMPAIGN_ID,
+  FN_CAMPAIGN_TIME,
+  FN_CAMPAIGN_NAME,
+  FN_CAMPAIGN_ANALYTICS_ENABLED
+} from '../util/constants';
+
 export interface NotificationDetails extends NotificationOptions {
   title: string;
   click_action?: string; // eslint-disable-line camelcase
@@ -27,5 +34,13 @@ export interface FcmOptions {
 export interface MessagePayload {
   fcmOptions?: FcmOptions;
   notification?: NotificationDetails;
-  data?: any; // eslint-disable-line @typescript-eslint/no-explicit-any
+  data?: unknown;
+}
+
+/** Additional data of a message sent from the FN Console. */
+export interface ConsoleMessageData {
+  [FN_CAMPAIGN_ID]: string;
+  [FN_CAMPAIGN_TIME]: string;
+  [FN_CAMPAIGN_NAME]?: string;
+  [FN_CAMPAIGN_ANALYTICS_ENABLED]?: '1';
 }

packages/messaging/src/interfaces/subscription-options.ts

@@ -15,11 +15,20 @@
  * limitations under the License.
  */
 
-import { SubscriptionOptions } from './subscription-options';
-
 export interface TokenDetails {
   token: string;
   createTime: number;
   /** Does not exist in Safari since it's not using Push API. */
   subscriptionOptions?: SubscriptionOptions;
 }
+
+/**
+ * Additional options and values required by a Push API subscription.
+ */
+export interface SubscriptionOptions {
+  vapidKey: string;
+  swScope: string;
+  endpoint: string;
+  auth: string;
+  p256dh: string;
+}