issue firebase#2393, first fix on performance module and remote-config module

XuechunHou · XuechunHou · commit 5afb5889265a · 2020-06-02T11:24:39.000-06:00
diff --git a/packages/firebase/index.d.ts b/packages/firebase/index.d.ts
@@ -1602,6 +1602,7 @@ declare namespace firebase.performance {
      */
     getAttributes(): { [key: string]: string };
   }
+  function isSupported(): boolean;
 }
 
 /**
@@ -1771,6 +1772,8 @@ declare namespace firebase.remoteConfig {
    * Defines levels of Remote Config logging.
    */
   export type LogLevel = 'debug' | 'error' | 'silent';
+
+  function isSupported(): boolean;
 }
 
 declare namespace firebase.functions {
diff --git a/packages/performance/index.ts b/packages/performance/index.ts
@@ -42,12 +42,20 @@ export function registerPerformance(instance: FirebaseNamespace): void {
     if (typeof window === 'undefined') {
       throw ERROR_FACTORY.create(ErrorCode.NO_WINDOW);
     }
+    if (!isSupported()) {
+      throw ERROR_FACTORY.create(ErrorCode.UNSUPPORTED_BROWSER);
+    }
+
     setupApi(window);
     SettingsService.getInstance().firebaseAppInstance = app;
     SettingsService.getInstance().installationsService = installations;
     return new PerformanceController(app);
   };
 
+  const NAMESPACE_EXPORTS = {
+    isSupported
+  };
+
   // Register performance with firebase-app.
   (instance as _FirebaseNamespace).INTERNAL.registerComponent(
     new Component(
@@ -64,7 +72,7 @@ export function registerPerformance(instance: FirebaseNamespace): void {
         return factoryMethod(app, installations);
       },
       ComponentType.PUBLIC
-    )
+    ).setServiceProps(NAMESPACE_EXPORTS)
   );
 
   instance.registerVersion(name, version);
@@ -76,9 +84,51 @@ declare module '@firebase/app-types' {
   interface FirebaseNamespace {
     performance?: {
       (app?: FirebaseApp): FirebasePerformance;
+      isSupprted(): boolean;
     };
   }
   interface FirebaseApp {
     performance?(): FirebasePerformance;
   }
 }
+
+function isSupported(): boolean {
+  if (self && 'ServiceWorkerGlobalScope' in self) {
+    // Running in ServiceWorker context
+    return isSWControllerSupported();
+  } else {
+    // Assume we are in the window context.
+    return isWindowControllerSupported();
+  }
+}
+
+/**
+ * Checks to see if the required APIs exist.
+ */
+function isWindowControllerSupported(): boolean {
+  return (
+    'indexedDB' in window &&
+    indexedDB !== null &&
+    navigator.cookieEnabled &&
+    'serviceWorker' in navigator &&
+    'PushManager' in window &&
+    'Notification' in window &&
+    'fetch' in window &&
+    ServiceWorkerRegistration.prototype.hasOwnProperty('showNotification') &&
+    PushSubscription.prototype.hasOwnProperty('getKey')
+  );
+}
+
+/**
+ * Checks to see if the required APIs exist within SW Context.
+ */
+function isSWControllerSupported(): boolean {
+  return (
+    'indexedDB' in self &&
+    indexedDB !== null &&
+    'PushManager' in self &&
+    'Notification' in self &&
+    ServiceWorkerRegistration.prototype.hasOwnProperty('showNotification') &&
+    PushSubscription.prototype.hasOwnProperty('getKey')
+  );
+}
diff --git a/packages/performance/src/utils/errors.ts b/packages/performance/src/utils/errors.ts
@@ -31,7 +31,8 @@ export const enum ErrorCode {
   INVALID_ATTRIBUTE_NAME = 'invalid attribute name',
   INVALID_ATTRIBUTE_VALUE = 'invalid attribute value',
   INVALID_CUSTOM_METRIC_NAME = 'invalid custom metric name',
-  INVALID_STRING_MERGER_PARAMETER = 'invalid String merger input'
+  INVALID_STRING_MERGER_PARAMETER = 'invalid String merger input',
+  UNSUPPORTED_BROWSER = 'unsupported-browser'
 }
 
 const ERROR_DESCRIPTION_MAP: { readonly [key in ErrorCode]: string } = {
@@ -52,7 +53,9 @@ const ERROR_DESCRIPTION_MAP: { readonly [key in ErrorCode]: string } = {
   [ErrorCode.INVALID_CUSTOM_METRIC_NAME]:
     'Custom metric name {$customMetricName} is invalid',
   [ErrorCode.INVALID_STRING_MERGER_PARAMETER]:
-    'Input for String merger is invalid, contact support team to resolve.'
+    'Input for String merger is invalid, contact support team to resolve.',
+  [ErrorCode.UNSUPPORTED_BROWSER]:
+    "This browser doesn't support the API's required to use the firebase SDK."
 };
 
 interface ErrorParams {
diff --git a/packages/remote-config/index.ts b/packages/remote-config/index.ts
@@ -44,15 +44,17 @@ declare global {
   }
 }
 
+const NAMESPACE_EXPORTS = {
+  isSupported
+};
+
 export function registerRemoteConfig(
   firebaseInstance: _FirebaseNamespace
 ): void {
   firebaseInstance.INTERNAL.registerComponent(
-    new Component(
-      'remoteConfig',
-      remoteConfigFactory,
-      ComponentType.PUBLIC
-    ).setMultipleInstances(true)
+    new Component('remoteConfig', remoteConfigFactory, ComponentType.PUBLIC)
+      .setMultipleInstances(true)
+      .setServiceProps(NAMESPACE_EXPORTS)
   );
 
   firebaseInstance.registerVersion(packageName, version);
@@ -72,6 +74,10 @@ export function registerRemoteConfig(
       throw ERROR_FACTORY.create(ErrorCode.REGISTRATION_WINDOW);
     }
 
+    if (!isSupported()) {
+      throw ERROR_FACTORY.create(ErrorCode.UNSUPPORTED_BROWSER);
+    }
+
     // Normalizes optional inputs.
     const { projectId, apiKey, appId } = app.options;
     if (!projectId) {
@@ -133,9 +139,51 @@ declare module '@firebase/app-types' {
   interface FirebaseNamespace {
     remoteConfig?: {
       (app?: FirebaseApp): RemoteConfigType;
+      isSupported(): boolean;
     };
   }
   interface FirebaseApp {
     remoteConfig(): RemoteConfigType;
   }
 }
+
+function isSupported(): boolean {
+  if (self && 'ServiceWorkerGlobalScope' in self) {
+    // Running in ServiceWorker context
+    return isSWControllerSupported();
+  } else {
+    // Assume we are in the window context.
+    return isWindowControllerSupported();
+  }
+}
+
+/**
+ * Checks to see if the required APIs exist.
+ */
+function isWindowControllerSupported(): boolean {
+  return (
+    'indexedDB' in window &&
+    indexedDB !== null &&
+    navigator.cookieEnabled &&
+    'serviceWorker' in navigator &&
+    'PushManager' in window &&
+    'Notification' in window &&
+    'fetch' in window &&
+    ServiceWorkerRegistration.prototype.hasOwnProperty('showNotification') &&
+    PushSubscription.prototype.hasOwnProperty('getKey')
+  );
+}
+
+/**
+ * Checks to see if the required APIs exist within SW Context.
+ */
+function isSWControllerSupported(): boolean {
+  return (
+    'indexedDB' in self &&
+    indexedDB !== null &&
+    'PushManager' in self &&
+    'Notification' in self &&
+    ServiceWorkerRegistration.prototype.hasOwnProperty('showNotification') &&
+    PushSubscription.prototype.hasOwnProperty('getKey')
+  );
+}
diff --git a/packages/remote-config/src/errors.ts b/packages/remote-config/src/errors.ts
@@ -30,7 +30,8 @@ export const enum ErrorCode {
   FETCH_TIMEOUT = 'fetch-timeout',
   FETCH_THROTTLE = 'fetch-throttle',
   FETCH_PARSE = 'fetch-client-parse',
-  FETCH_STATUS = 'fetch-status'
+  FETCH_STATUS = 'fetch-status',
+  UNSUPPORTED_BROWSER = 'unsupported-browser'
 }
 
 const ERROR_DESCRIPTION_MAP: { readonly [key in ErrorCode]: string } = {
@@ -64,7 +65,9 @@ const ERROR_DESCRIPTION_MAP: { readonly [key in ErrorCode]: string } = {
     'Fetch client could not parse response.' +
     ' Original error: {$originalErrorMessage}.',
   [ErrorCode.FETCH_STATUS]:
-    'Fetch server returned an HTTP error status. HTTP status: {$httpStatus}.'
+    'Fetch server returned an HTTP error status. HTTP status: {$httpStatus}.',
+  [ErrorCode.UNSUPPORTED_BROWSER]:
+    "This browser doesn't support the API's required to use the firebase SDK."
 };
 
 // Note this is effectively a type system binding a code to params. This approach overlaps with the

Original file line number	Diff line number	Diff line change
`@@ -1602,6 +1602,7 @@ declare namespace firebase.performance {`
`1602`	`1602`	`*/`
`1603`	`1603`	`getAttributes(): { [key: string]: string };`
`1604`	`1604`	`}`
	`1605`	`+ function isSupported(): boolean;`
`1605`	`1606`	`}`
`1606`	`1607`
`1607`	`1608`	`/**`
`@@ -1771,6 +1772,8 @@ declare namespace firebase.remoteConfig {`
`1771`	`1772`	`* Defines levels of Remote Config logging.`
`1772`	`1773`	`*/`
`1773`	`1774`	`export type LogLevel = 'debug' \| 'error' \| 'silent';`
	`1775`	`+`
	`1776`	`+ function isSupported(): boolean;`
`1774`	`1777`	`}`
`1775`	`1778`
`1776`	`1779`	`declare namespace firebase.functions {`