Issue 2393 - Add environment check to Performance Module

.changeset/little-cycles-fold.md

@@ -0,0 +1,6 @@
+---
+"firebase": minor
+"@firebase/performance": minor
+---
+
+Issue 2393 - Add environment check to Performance Module

packages/firebase/index.d.ts

@@ -1602,6 +1602,7 @@ declare namespace firebase.performance {
      */
     getAttributes(): { [key: string]: string };
   }
+  function isSupported(): Promise<boolean>;
 }
 
 /**

packages/performance/index.ts

@@ -26,7 +26,10 @@ import { ERROR_FACTORY, ErrorCode } from './src/utils/errors';
 import { FirebasePerformance } from '@firebase/performance-types';
 import { Component, ComponentType } from '@firebase/component';
 import { FirebaseInstallations } from '@firebase/installations-types';
-
+import {
+  isIndexedDBAvailable,
+  validateIndexedDBOpenable
+} from '@firebase/util';
 import { name, version } from './package.json';
 
 const DEFAULT_ENTRY_NAME = '[DEFAULT]';
@@ -48,6 +51,10 @@ export function registerPerformance(instance: FirebaseNamespace): void {
     return new PerformanceController(app);
   };
 
+  const NAMESPACE_EXPORTS = {
+    isSupported
+  };
+
   // Register performance with firebase-app.
   (instance as _FirebaseNamespace).INTERNAL.registerComponent(
     new Component(
@@ -64,7 +71,7 @@ export function registerPerformance(instance: FirebaseNamespace): void {
         return factoryMethod(app, installations);
       },
       ComponentType.PUBLIC
-    )
+    ).setServiceProps(NAMESPACE_EXPORTS)
   );
 
   instance.registerVersion(name, version);
@@ -76,9 +83,28 @@ declare module '@firebase/app-types' {
   interface FirebaseNamespace {
     performance?: {
       (app?: FirebaseApp): FirebasePerformance;
+      isSupprted(): Promise<boolean>;
     };
   }
   interface FirebaseApp {
     performance?(): FirebasePerformance;
   }
 }
+
+async function isSupported(): Promise<boolean> {
+  if (
+    !fetch ||
+    !Promise ||
+    !navigator ||
+    !navigator.cookieEnabled ||
+    !isIndexedDBAvailable()
+  ) {
+    return false;
+  }
+  try {
+    const isDBOpenable: boolean = await validateIndexedDBOpenable();
+    return isDBOpenable;
+  } catch (error) {
+    return false;
+  }
+}

packages/performance/src/controllers/perf.ts

@@ -21,19 +21,18 @@ import { getInitializationPromise } from '../services/initialization_service';
 import { Api } from '../services/api_service';
 import { FirebaseApp } from '@firebase/app-types';
 import { FirebasePerformance } from '@firebase/performance-types';
-import { consoleLogger } from '../utils/console_logger';
 import { setupTransportService } from '../services/transport_service';
-
 export class PerformanceController implements FirebasePerformance {
   constructor(readonly app: FirebaseApp) {
-    if (Api.getInstance().requiredApisAvailable()) {
-      setupTransportService();
-      getInitializationPromise().then(setupOobResources, setupOobResources);
-    } else {
-      consoleLogger.info(
-        'Firebase Performance cannot start if browser does not support fetch and Promise or cookie is disabled.'
-      );
-    }
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+    Api.getInstance()
+      .requiredApisAvailable()
+      .then(isAvailable => {
+        if (isAvailable) {
+          setupTransportService();
+          getInitializationPromise().then(setupOobResources, setupOobResources);
+        }
+      });
   }
 
   trace(name: string): Trace {

packages/performance/src/services/api_service.ts

@@ -16,7 +16,11 @@
  */
 
 import { ERROR_FACTORY, ErrorCode } from '../utils/errors';
-
+import {
+  isIndexedDBAvailable,
+  validateIndexedDBOpenable
+} from '@firebase/util';
+import { consoleLogger } from '../utils/console_logger';
 declare global {
   interface Window {
     PerformanceObserver: typeof PerformanceObserver;
@@ -109,11 +113,34 @@ export class Api {
     );
   }
 
-  requiredApisAvailable(): boolean {
-    if (fetch && Promise && this.navigator && this.navigator.cookieEnabled) {
+  async requiredApisAvailable(): Promise<boolean> {
+    if (
+      !fetch ||
+      !Promise ||
+      !this.navigator ||
+      !this.navigator.cookieEnabled
+    ) {
+      consoleLogger.info(
+        'Firebase Performance cannot start if browser does not support fetch and Promise or cookie is disabled.'
+      );
+      return false;
+    }
+
+    if (!isIndexedDBAvailable()) {
+      consoleLogger.info('IndexedDB is not supported by current browswer');
+      return false;
+    }
+    try {
+      await validateIndexedDBOpenable();
       return true;
+    } catch (error) {
+      consoleLogger.info(
+        `Environment doesn't support IndexedDB: ${error}` +
+          'Wrap initialization of performance in performance.isSupported() ' +
+          'to prevent initialization in unsupported environments'
+      );
+      return false;
     }
-    return false;
   }
 
   setupObserver(