Issue 2393 - Add environment check to Performance Module (#3424)

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

* added error handler to remote-config and performance modules on indexedDB not supported in some browser situations

* issue #2393 fix for analytics module

* updateDoc()/deleteDoc() signature fix (#3147)

* Transaction/WriteBatch signature fix (#3151)

* Take WriteStream offline when IndexedDB is unavailable (#2995)

* Do not build firestore lite in build because it breaks regular release build (#3156)

* Do not build firestore lite in build because it breaks release build

* add release build script

* add pre script for build:release (#3161)

* Add setLogLevel() (#3154)

* Add DocumentReference (#3123)

* issue #2393 fix for analytics module

* added isSupported method to performance module

* added method signature to firebase/index.d.ts

* reverted unrelated files in remote-config

* Create little-cycles-fold.md

* removed isSupported method from performance

* wrote tests for requiredApisAvailable

* updated isRequiredApiAvailable tests, updated logTrace function to reflect changes of isRequiredApiAvailable

* added Promise existence check before every test of requiredApisAvailable

* took validateIndexedDBOpenable outside of isRequiredApisAvailable

* updated performance constructor test

Co-authored-by: Sebastian Schmidt <[email protected]>
Co-authored-by: Feiyang <[email protected]>

Author: 3 people

.changeset/little-cycles-fold.md

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

packages/performance/index.ts

@@ -26,7 +26,6 @@ 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 { name, version } from './package.json';
 
 const DEFAULT_ENTRY_NAME = '[DEFAULT]';

packages/performance/src/controllers/perf.test.ts

@@ -22,6 +22,7 @@ import { Trace } from '../resources/trace';
 import { Api, setupApi } from '../services/api_service';
 import { FirebaseApp } from '@firebase/app-types';
 import * as initializationService from '../services/initialization_service';
+import * as FirebaseUtil from '@firebase/util';
 import { consoleLogger } from '../utils/console_logger';
 import '../../test/setup';
 
@@ -46,11 +47,36 @@ describe('Firebase Performance Test', () => {
     it('does not initialize performance if the required apis are not available', () => {
       stub(Api.prototype, 'requiredApisAvailable').returns(false);
       stub(initializationService, 'getInitializationPromise');
-      stub(consoleLogger, 'info');
       new PerformanceController(fakeFirebaseApp);
-
       expect(initializationService.getInitializationPromise).not.be.called;
-      expect(consoleLogger.info).be.called;
+    });
+    it('does not initialize performance if validateIndexedDBOpenable return false', async () => {
+      stub(Api.prototype, 'requiredApisAvailable').returns(true);
+      const validateStub = stub(
+        FirebaseUtil,
+        'validateIndexedDBOpenable'
+      ).resolves(false);
+      stub(initializationService, 'getInitializationPromise');
+      new PerformanceController(fakeFirebaseApp);
+      await validateStub;
+      expect(initializationService.getInitializationPromise).not.be.called;
+    });
+
+    it('does not initialize performance if validateIndexedDBOpenable throws an error', async () => {
+      stub(Api.prototype, 'requiredApisAvailable').returns(true);
+      const validateStub = stub(
+        FirebaseUtil,
+        'validateIndexedDBOpenable'
+      ).rejects();
+
+      stub(initializationService, 'getInitializationPromise');
+      stub(consoleLogger, 'info');
+      new PerformanceController(fakeFirebaseApp);
+      try {
+        await validateStub;
+        expect(initializationService.getInitializationPromise).not.be.called;
+        expect(consoleLogger.info).be.called;
+      } catch (ignored) {}
     });
   });
 

packages/performance/src/controllers/perf.ts

@@ -21,18 +21,25 @@ 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';
-
+import { validateIndexedDBOpenable } from '@firebase/util';
+import { consoleLogger } from '../utils/console_logger';
 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.'
-      );
+      validateIndexedDBOpenable()
+        .then(isAvailable => {
+          if (isAvailable) {
+            setupTransportService();
+            getInitializationPromise().then(
+              setupOobResources,
+              setupOobResources
+            );
+          }
+        })
+        .catch(error => {
+          consoleLogger.info(`Environment doesn't support IndexedDB: ${error}`);
+        });
     }
   }
 

packages/performance/src/services/api_service.test.ts

@@ -19,7 +19,6 @@ import { stub } from 'sinon';
 import { expect } from 'chai';
 import { Api, setupApi } from './api_service';
 import '../../test/setup';
-
 describe('Firebase Performance > api_service', () => {
   const PAGE_URL = 'http://www.test.com/abcd?a=2';
   const PERFORMANCE_ENTRY: PerformanceEntry = {
@@ -47,6 +46,7 @@ describe('Firebase Performance > api_service', () => {
     ]);
     // This is to make sure the test page is not changed by changing the href of location object.
     mockWindow.location = { ...self.location, href: PAGE_URL };
+
     setupApi(mockWindow);
     api = Api.getInstance();
   });

packages/performance/src/services/api_service.ts

@@ -16,7 +16,8 @@
  */
 
 import { ERROR_FACTORY, ErrorCode } from '../utils/errors';
-
+import { isIndexedDBAvailable } from '@firebase/util';
+import { consoleLogger } from '../utils/console_logger';
 declare global {
   interface Window {
     PerformanceObserver: typeof PerformanceObserver;
@@ -110,10 +111,23 @@ export class Api {
   }
 
   requiredApisAvailable(): boolean {
-    if (fetch && Promise && this.navigator && this.navigator.cookieEnabled) {
-      return true;
+    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;
     }
-    return false;
+    return true;
   }
 
   setupObserver(

packages/performance/src/services/perf_logger.ts

@@ -114,6 +114,7 @@ export function logTrace(trace: Trace): void {
   if (!Api.getInstance().requiredApisAvailable()) {
     return;
   }
+
   // Only log the page load auto traces if page is visible.
   if (trace.isAuto && getVisibilityState() !== VisibilityState.VISIBLE) {
     return;