Issue 2393 - Add environment check to Analytics Module

packages/analytics/index.ts

@@ -45,6 +45,9 @@ declare global {
  * Type constant for Firebase Analytics.
  */
 const ANALYTICS_TYPE = 'analytics';
+const NAMESPACE_EXPORTS = {
+  isSupported
+};
 export function registerAnalytics(instance: _FirebaseNamespace): void {
   instance.INTERNAL.registerComponent(
     new Component(
@@ -56,12 +59,15 @@ export function registerAnalytics(instance: _FirebaseNamespace): void {
           .getProvider('installations')
           .getImmediate();
 
+        validateBrowserContext();
+
         return factory(app, installations);
       },
       ComponentType.PUBLIC
     ).setServiceProps({
       settings,
-      EventName
+      EventName,
+      NAMESPACE_EXPORTS
     })
   );
 
@@ -97,8 +103,52 @@ registerAnalytics(firebase as _FirebaseNamespace);
 declare module '@firebase/app-types' {
   interface FirebaseNamespace {
     analytics(app?: FirebaseApp): FirebaseAnalytics;
+    isSupported(): boolean;
   }
   interface FirebaseApp {
     analytics(): FirebaseAnalytics;
   }
 }
+function validateBrowserContext(): void {
+  if ('indexedDB' in window && indexedDB !== null && navigator.cookieEnabled) {
+    try {
+      let preExist: boolean = true;
+      const DUMMYDBNAME =
+        'a-dummy-database-for-testing-browser-context-firebase';
+      const request = window.indexedDB.open(DUMMYDBNAME);
+      request.onsuccess = () => {
+        //console.log('successfully opend dummy indexedDB');
+        request.result.close();
+        // delete database only when it doesn't pre-exist
+        if (!preExist) {
+          //console.log("deleting database");
+          window.indexedDB.deleteDatabase(DUMMYDBNAME);
+        }
+      };
+      request.onupgradeneeded = () => {
+        preExist = false;
+        //console.log('database needs to be upgraded');
+      };
+
+      request.onerror = () => {
+        throw ERROR_FACTORY.create(AnalyticsError.INVALID_INDEXED_DB_CONTEXT, {
+          errorInfo: request.error!.message
+        });
+      };
+    } catch (error) {
+      throw ERROR_FACTORY.create(AnalyticsError.INVALID_INDEXED_DB_CONTEXT, {
+        errorInfo: error
+      });
+    }
+  } else {
+    throw ERROR_FACTORY.create(AnalyticsError.INDEXED_DB_UNSUPPORTED);
+  }
+}
+function isSupported(): boolean {
+  try {
+    validateBrowserContext();
+    return true;
+  } catch (e) {
+    return false;
+  }
+}

packages/analytics/src/errors.ts

@@ -22,7 +22,9 @@ export const enum AnalyticsError {
   NO_GA_ID = 'no-ga-id',
   ALREADY_EXISTS = 'already-exists',
   ALREADY_INITIALIZED = 'already-initialized',
-  INTEROP_COMPONENT_REG_FAILED = 'interop-component-reg-failed'
+  INTEROP_COMPONENT_REG_FAILED = 'interop-component-reg-failed',
+  INDEXED_DB_UNSUPPORTED = 'indexedDB-unsupported',
+  INVALID_INDEXED_DB_CONTEXT = 'invalid-indexedDB-context'
 }
 
 const ERRORS: ErrorMap<AnalyticsError> = {
@@ -39,12 +41,17 @@ const ERRORS: ErrorMap<AnalyticsError> = {
     'settings() must be called before initializing any Analytics instance' +
     'or it will have no effect.',
   [AnalyticsError.INTEROP_COMPONENT_REG_FAILED]:
-    'Firebase Analytics Interop Component failed to instantiate'
+    'Firebase Analytics Interop Component failed to instantiate',
+  [AnalyticsError.INDEXED_DB_UNSUPPORTED]:
+    'IndexedDB is not supported by current browswer',
+  [AnalyticsError.INVALID_INDEXED_DB_CONTEXT]:
+    "Environment doesn't support IndexedDB functionality with error message: {$errorInfo}"
 };
 
 interface ErrorParams {
   [AnalyticsError.ALREADY_EXISTS]: { id: string };
   [AnalyticsError.INTEROP_COMPONENT_REG_FAILED]: { reason: Error };
+  [AnalyticsError.INVALID_INDEXED_DB_CONTEXT]: { errorInfo: string };
 }
 
 export const ERROR_FACTORY = new ErrorFactory<AnalyticsError, ErrorParams>(

packages/firebase/index.d.ts

@@ -5083,6 +5083,7 @@ declare namespace firebase.analytics {
     id?: string;
     name?: string;
   }
+  function isSupported(): boolean;
 }
 
 declare namespace firebase.auth.Auth {

scripts/exp/extract-deps.helpers.ts

@@ -48,6 +48,7 @@ export async function extractDependencies(
     exportName,
     jsBundle
   );
+  console.log(dependencies);
   return dependencies;
 }
 
@@ -61,11 +62,17 @@ export async function extractDependenciesAndSize(
 ): Promise<ExportData> {
   const input = tmp.fileSync().name + '.js';
   const output = tmp.fileSync().name + '.js';
+  console.log(input);
+  console.log(output);
+  // jsBundle : /Users/xuechunhou/Desktop/Google/firebase-js-sdk/packages/firestore/dist/exp/index.js
 
   // JavaScript content that exports a single API from the bundle
+  //beforeCOntent: export { Blob } from '/Users/xuechunhou/Desktop/Google/firebase-js-sdk/packages/firestore/dist/exp/index.js';
   const beforeContent = `export { ${exportName} } from '${path.resolve(
     jsBundle
   )}';`;
+  console.log('beforeContent\n');
+  console.log(beforeContent);
   fs.writeFileSync(input, beforeContent);
 
   // Run Rollup on the JavaScript above to produce a tree-shaken build
@@ -76,6 +83,7 @@ export async function extractDependenciesAndSize(
   await bundle.write({ file: output, format: 'es' });
 
   const dependencies = extractDeclarations(output);
+  console.log(dependencies);
 
   // Extract size of minified build
   const afterContent = fs.readFileSync(output, 'utf-8');
@@ -99,6 +107,7 @@ export async function extractDependenciesAndSize(
  */
 export function extractDeclarations(jsFile: string): MemberList {
   const program = ts.createProgram([jsFile], { allowJs: true });
+
   const sourceFile = program.getSourceFile(jsFile);
   if (!sourceFile) {
     throw new Error('Failed to parse file: ' + jsFile);

scripts/exp/extract-deps.sh

@@ -27,5 +27,8 @@ GENERATE_DEPS_JS="$DIR/extract-deps.ts"
 export TS_NODE_CACHE=NO 
 export TS_NODE_COMPILER_OPTIONS='{"module":"commonjs"}' 
 export TS_NODE_PROJECT="$DIR/../../config/tsconfig.base.json"
-
+echo $TSNODE
+echo $GENERATE_DEPS_JS
+#Users/xuechunhou/Desktop/Google/firebase-js-sdk/node_modules/.bin/ts-node
+#/Users/xuechunhou/Desktop/Google/firebase-js-sdk/scripts/exp/extract-deps.ts
 $TSNODE $GENERATE_DEPS_JS "$@"

scripts/report_binary_size.js

@@ -29,6 +29,8 @@ const METRICS_SERVICE_URL = process.env.METRICS_SERVICE_URL;
 function generateReportForCDNScripts() {
   const reports = [];
   const firebaseRoot = resolve(__dirname, '../packages/firebase');
+  // console.log(__dirname); // /Users/xuechunhou/Desktop/Google/firebase-js-sdk/scripts
+  // console.log(firebaseRoot); // /Users/xuechunhou/Desktop/Google/firebase-js-sdk/packages/firebase
   const pkgJson = require(`${firebaseRoot}/package.json`);
 
   const special_files = [
@@ -44,6 +46,7 @@ function generateReportForCDNScripts() {
       component => `${firebaseRoot}/firebase-${component}.js`
     )
   ];
+  //console.log(files);
 
   for (const file of files) {
     const { size } = fs.statSync(file);
@@ -70,7 +73,7 @@ function generateReportForNPMPackages() {
   const packageInfo = JSON.parse(
     execSync('npx lerna ls --json --scope @firebase/*').toString()
   );
-
+  //console.log(packageInfo);
   for (const package of packageInfo) {
     // we traverse the dir in order to include binaries for submodules, e.g. @firebase/firestore/memory
     // Currently we only traverse 1 level deep because we don't have any submodule deeper than that.
@@ -84,7 +87,7 @@ function generateReportForNPMPackages() {
     }
 
     const packageJson = require(packageJsonPath);
-
+    console.log(packageJson);
     for (const field of fields) {
       if (packageJson[field]) {
         const filePath = `${path}/${packageJson[field]}`;