app-compat impl

Author: Feiyang1

common/api-review/app-exp.api.md

@@ -29,6 +29,9 @@ export function _clearComponents(): void;
 // @internal
 export const _components: Map<string, Component<any>>;
 
+// @internal
+export const _DEFAULT_ENTRY_NAME = "[DEFAULT]";
+
 // @public
 export function deleteApp(app: FirebaseApp): Promise<void>;
 

packages-exp/app-compat/package.json

@@ -3,11 +3,10 @@
   "version": "0.0.800",
   "description": "The primary entrypoint to the Firebase JS SDK",
   "author": "Firebase <[email protected]> (https://firebase.google.com/)",
-  "main": "dist/index.node.cjs.js",
-  "browser": "dist/cjs/index.js",
-  "module": "dist/esm5/index.js",
-  "react-native": "dist/index.rn.cjs.js",
-  "esm2017": "dist/esm2017/index.js",
+  "main": "dist/index.cjs.js",
+  "browser": "dist/index.esm5.js",
+  "module": "dist/index.esm5.js",
+  "esm2017": "dist/index.esm2017.js",
   "lite": "dist/index.lite.js",
   "lite-esm2017": "dist/index.lite.esm2017.js",
   "files": [
@@ -27,11 +26,11 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@firebase/app-types": "0.5.2",
-    "@firebase/util": "0.2.41",
-    "@firebase/logger": "0.1.36",
-    "@firebase/component": "0.1.6",
-    "tslib": "1.11.1",
+    "@firebase/app-exp": "0.0.800",
+    "@firebase/util": "0.3.0",
+    "@firebase/logger": "0.2.6",
+    "@firebase/component": "0.1.17",
+    "tslib": "^1.11.1",
     "dom-storage": "2.1.0",
     "xmlhttprequest": "1.8.0"
   },
@@ -50,11 +49,11 @@
   "bugs": {
     "url": "https://github.com/firebase/firebase-js-sdk/issues"
   },
-  "typings": "dist/packages/app/index.d.ts",
+  "typings": "dist/src/index.d.ts",
   "nyc": {
     "extension": [
       ".ts"
     ],
     "reportDir": "./coverage/node"
   }
-}
+}

packages-exp/app-compat/rollup.config.js

@@ -36,43 +36,16 @@ const es5BuildPlugins = [
 
 const es5Builds = [
   {
-    input: {
-      index: 'index.ts',
-      next: 'src/next/index.ts',
-      'next/internal': 'src/next/internal.ts'
-    },
+    input: 'src/index.ts',
     output: [
-      { dir: 'dist/cjs', format: 'cjs', sourcemap: true },
-      { dir: 'dist/esm5', format: 'es', sourcemap: true }
+      { file: pkg.main, format: 'cjs', sourcemap: true },
+      { file: pkg.module, format: 'es', sourcemap: true }
     ],
     plugins: es5BuildPlugins,
     external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
   },
   {
-    input: 'index.node.ts',
-    output: {
-      file: pkg.main,
-      format: 'cjs',
-      sourcemap: true
-    },
-    plugins: es5BuildPlugins,
-    external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
-  },
-  {
-    input: 'index.rn.ts',
-    output: {
-      file: pkg['react-native'],
-      format: 'cjs',
-      sourcemap: true
-    },
-    plugins: es5BuildPlugins,
-    external: id =>
-      [...deps, 'react-native'].some(
-        dep => id === dep || id.startsWith(`${dep}/`)
-      )
-  },
-  {
-    input: 'index.lite.ts',
+    input: 'src/index.lite.ts',
     output: {
       file: pkg.lite,
       format: 'es',
@@ -105,21 +78,17 @@ const es2017Builds = [
    *  Browser Builds
    */
   {
-    input: {
-      index: 'index.ts',
-      next: 'src/next/index.ts',
-      'next/internal': 'src/next/internal.ts'
-    },
+    input: 'src/index.ts',
     output: {
-      dir: 'dist/esm2017',
+      file: pkg.esm2017,
       format: 'es',
       sourcemap: true
     },
     plugins: es2017BuildPlugins,
     external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
   },
   {
-    input: 'index.lite.ts',
+    input: 'src/index.lite.ts',
     output: {
       file: pkg['lite-esm2017'],
       format: 'es',

packages-exp/app-compat/src/errors.ts

@@ -0,0 +1,40 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { ErrorFactory, ErrorMap } from '@firebase/util';
+
+export const enum AppError {
+  NO_APP = 'no-app',
+  INVALID_APP_ARGUMENT = 'invalid-app-argument'
+}
+
+const ERRORS: ErrorMap<AppError> = {
+  [AppError.NO_APP]:
+    "No Firebase App '{$appName}' has been created - " +
+    'call Firebase App.initializeApp()',
+  [AppError.INVALID_APP_ARGUMENT]:
+    'firebase.{$appName}() takes either no argument or a ' +
+    'Firebase App instance.'
+};
+
+type ErrorParams = { [key in AppError]: { appName: string } };
+
+export const ERROR_FACTORY = new ErrorFactory<AppError, ErrorParams>(
+  'app-compat',
+  'Firebase',
+  ERRORS
+);

packages-exp/app-compat/src/firebaseApp.ts

@@ -0,0 +1,145 @@
+/**
+ * @license
+ * Copyright 2017 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { FirebaseApp, FirebaseOptions } from '@firebase/app-types';
+import {
+  _FirebaseApp,
+  _FirebaseNamespace,
+  FirebaseService
+} from '@firebase/app-types/private';
+import {
+  Component,
+  ComponentType,
+  Name,
+  ComponentContainer
+} from '@firebase/component';
+import { _FirebaseAppInternal } from '@firebase/app-types-exp';
+import {
+  deleteApp,
+  _addComponent,
+  _addOrOverwriteComponent,
+  _DEFAULT_ENTRY_NAME
+} from '@firebase/app-exp';
+
+/**
+ * Global context object for a collection of services using
+ * a shared authentication state.
+ */
+export class FirebaseAppImpl implements FirebaseApp {
+  private readonly container: ComponentContainer;
+
+  constructor(
+    private readonly app: _FirebaseAppInternal,
+    private readonly firebase: _FirebaseNamespace
+  ) {
+    // add itself to container
+    // TODO: change the component name to 'app-compat' before the official release
+    _addComponent(app, new Component('app', () => this, ComponentType.PUBLIC));
+    this.container = app.container;
+  }
+
+  get automaticDataCollectionEnabled(): boolean {
+    return this.app.automaticDataCollectionEnabled;
+  }
+
+  set automaticDataCollectionEnabled(val) {
+    this.app.automaticDataCollectionEnabled = val;
+  }
+
+  get name(): string {
+    return this.app.name;
+  }
+
+  get options(): FirebaseOptions {
+    return this.app.options;
+  }
+
+  delete(): Promise<void> {
+    return new Promise(resolve => {
+      this.app.checkDestroyed();
+      resolve();
+    }).then(() => {
+      this.firebase.INTERNAL.removeApp(this.name);
+      return deleteApp(this.app);
+    });
+  }
+
+  /**
+   * Return a service instance associated with this app (creating it
+   * on demand), identified by the passed instanceIdentifier.
+   *
+   * NOTE: Currently storage and functions are the only ones that are leveraging this
+   * functionality. They invoke it by calling:
+   *
+   * ```javascript
+   * firebase.app().storage('STORAGE BUCKET ID')
+   * ```
+   *
+   * The service name is passed to this already
+   * @internal
+   */
+  _getService(
+    name: string,
+    instanceIdentifier: string = _DEFAULT_ENTRY_NAME
+  ): FirebaseService {
+    this.app.checkDestroyed();
+
+    // getImmediate will always succeed because _getService is only called for registered components.
+    return (this.app.container.getProvider(name as Name).getImmediate({
+      identifier: instanceIdentifier
+    }) as unknown) as FirebaseService;
+  }
+
+  /**
+   * Remove a service instance from the cache, so we will create a new instance for this service
+   * when people try to get it again.
+   *
+   * NOTE: currently only firestore uses this functionality to support firestore shutdown.
+   *
+   * @param name The service name
+   * @param instanceIdentifier instance identifier in case multiple instances are allowed
+   * @internal
+   */
+  _removeServiceInstance(
+    name: string,
+    instanceIdentifier: string = _DEFAULT_ENTRY_NAME
+  ): void {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    this.app.container
+      .getProvider(name as any)
+      .clearInstance(instanceIdentifier);
+  }
+
+  /**
+   * @param component the component being added to this app's container
+   * @internal
+   */
+  _addComponent(component: Component): void {
+    _addComponent(this.app, component);
+  }
+
+  _addOrOverwriteComponent(component: Component): void {
+    _addOrOverwriteComponent(this.app, component);
+  }
+}
+
+// TODO: investigate why the following needs to be commented out
+// Prevent dead-code elimination of these methods w/o invalid property
+// copying.
+// (FirebaseAppImpl.prototype.name && FirebaseAppImpl.prototype.options) ||
+//   FirebaseAppImpl.prototype.delete ||
+//   console.log('dc');

packages-exp/app-compat/src/firebaseNamespace.ts

@@ -0,0 +1,54 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { FirebaseNamespace } from '@firebase/app-types';
+import { _FirebaseApp, _FirebaseNamespace } from '@firebase/app-types/private';
+import { createSubscribe, deepExtend, ErrorFactory } from '@firebase/util';
+import { FirebaseAppImpl } from './firebaseApp';
+import { createFirebaseNamespaceCore } from './firebaseNamespaceCore';
+
+/**
+ * Return a firebase namespace object.
+ *
+ * In production, this will be called exactly once and the result
+ * assigned to the 'firebase' global.  It may be called multiple times
+ * in unit tests.
+ */
+export function createFirebaseNamespace(): FirebaseNamespace {
+  const namespace = createFirebaseNamespaceCore(FirebaseAppImpl);
+  (namespace as _FirebaseNamespace).INTERNAL = {
+    ...(namespace as _FirebaseNamespace).INTERNAL,
+    createFirebaseNamespace,
+    extendNamespace,
+    createSubscribe,
+    ErrorFactory,
+    deepExtend
+  };
+
+  /**
+   * Patch the top-level firebase namespace with additional properties.
+   *
+   * firebase.INTERNAL.extendNamespace()
+   */
+  function extendNamespace(props: { [prop: string]: unknown }): void {
+    deepExtend(namespace, props);
+  }
+
+  return namespace;
+}
+
+export const firebase = createFirebaseNamespace();