Add compat packages to firebase-exp (#4648)

* save

* build analytics-compat cdn script

* add auth-compat to firebase-exp

* add functions-compat to firebase-exp

* add messaging-compat to firebase-exp

* update imports

* add performance-compat to firebase-exp

* add remoteconfig-compat to firebase-exp

* update var name

* add firestore-compat to firebase-exp

* fix builds

* add storage-compat to firebase-exp

* add firestore-compat and storage-compat to dependencies

* address comments

* update license

* fix messaging and typings

* update typings path

* typings for compat packages

* minify cdn scripts

* use the right typings for dev

* fix script

* fix typing errors

* fix lint errors

Author: Feiyang1

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

@@ -62,6 +62,11 @@ export interface NotificationPayload {
     title?: string;
 }
 
+// Warning: (ae-internal-missing-underscore) The name "onBackgroundMessage" should be prefixed with an underscore because the declaration is marked as @internal
+//
+// @internal
+export function onBackgroundMessage(messaging: FirebaseMessaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
+
 // @public
 export function onMessage(messaging: FirebaseMessaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
 

packages-exp/analytics-compat/package.json

@@ -42,7 +42,7 @@
     "test:browser": "karma start --single-run",
     "test:browser:debug": "karma start --browsers=Chrome --auto-watch"
   },
-  "typings": "dist/analytics-compat-public.d.ts",
+  "typings": "dist/src/index.d.ts",
   "dependencies": {
     "@firebase/component": "0.2.1",
     "@firebase/analytics-exp": "0.0.900",

packages-exp/analytics-compat/src/index.ts

@@ -15,7 +15,8 @@
  * limitations under the License.
  */
 
-import { firebase, _FirebaseNamespace } from '@firebase/app-compat';
+import firebase, { _FirebaseNamespace } from '@firebase/app-compat';
+import { FirebaseAnalytics } from '@firebase/analytics-types';
 import { name, version } from '../package.json';
 import { AnalyticsService } from './service';
 import {
@@ -26,17 +27,14 @@ import {
 } from '@firebase/component';
 import { FirebaseApp } from '@firebase/app-types';
 import {
-  Analytics as AnalyticsServiceExp,
   settings as settingsExp,
   isSupported as isSupportedExp
 } from '@firebase/analytics-exp';
 import { EventName } from './constants';
 
 declare module '@firebase/component' {
   interface NameServiceMapping {
-    'app-compat': FirebaseApp;
     'analytics-compat': AnalyticsService;
-    'analytics-exp': AnalyticsServiceExp;
   }
 }
 
@@ -69,3 +67,15 @@ export function registerAnalytics(): void {
 
 registerAnalytics();
 firebase.registerVersion(name, version);
+
+/**
+ * Define extension behavior of `registerAnalytics`
+ */
+declare module '@firebase/app-compat' {
+  interface FirebaseNamespace {
+    analytics(app?: FirebaseApp): FirebaseAnalytics;
+  }
+  interface FirebaseApp {
+    analytics(): FirebaseAnalytics;
+  }
+}

packages-exp/analytics-exp/package.json

@@ -15,7 +15,7 @@
     "lint": "eslint -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
     "lint:fix": "eslint --fix -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
     "build": "rollup -c && yarn api-report",
-    "build:release": "rollup -c rollup.config.release.js && yarn api-report",
+    "build:release": "rollup -c rollup.config.release.js && yarn api-report && yarn typings:public",
     "build:deps": "lerna run --scope @firebase/analytics-exp --include-dependencies build",
     "dev": "rollup -c -w",
     "test": "run-p lint test:all",
@@ -26,7 +26,8 @@
     "api-report": "api-extractor run --local --verbose",
     "predoc": "node ../../scripts/exp/remove-exp.js temp",
     "doc": "api-documenter markdown --input temp --output docs",
-    "build:doc": "yarn build && yarn doc"
+    "build:doc": "yarn build && yarn doc",
+    "typings:public": "node ../../scripts/exp/use_typings.js ./dist/analytics-exp-public.d.ts"
   },
   "peerDependencies": {
     "@firebase/app-exp": "0.x"
@@ -56,7 +57,7 @@
   "bugs": {
     "url": "https://github.com/firebase/firebase-js-sdk/issues"
   },
-  "typings": "dist/analytics-exp-public.d.ts",
+  "typings": "dist/src/index.d.ts",
   "nyc": {
     "extension": [
       ".ts"

packages-exp/analytics-exp/rollup.shared.js

@@ -16,9 +16,10 @@
  */
 import pkg from './package.json';
 
-const deps = Object.keys(
-  Object.assign({}, pkg.peerDependencies, pkg.dependencies)
-);
+const deps = [
+  ...Object.keys(Object.assign({}, pkg.peerDependencies, pkg.dependencies)),
+  '@firebase/app'
+];
 
 export const es5BuildsNoPlugin = [
   /**

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

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-import { FirebaseApp, FirebaseOptions } from './public-types';
+import { FirebaseOptions } from './public-types';
 import {
   Component,
   ComponentContainer,
@@ -31,11 +31,34 @@ import {
 } from '@firebase/app-exp';
 import { _FirebaseService, _FirebaseNamespace } from './types';
 
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export interface _FirebaseApp {
+  /**
+   * The (read-only) name (identifier) for this App. '[DEFAULT]' is the default
+   * App.
+   */
+  name: string;
+
+  /**
+   * The (read-only) configuration options from the app initialization.
+   */
+  options: FirebaseOptions;
+
+  /**
+   * The settable config flag for GDPR opt-in/opt-out
+   */
+  automaticDataCollectionEnabled: boolean;
+
+  /**
+   * Make the given App unusable and free resources.
+   */
+  delete(): Promise<void>;
+}
 /**
  * Global context object for a collection of services using
  * a shared authentication state.
  */
-export class FirebaseAppImpl implements FirebaseApp {
+export class FirebaseAppImpl implements _FirebaseApp {
   private container: ComponentContainer;
 
   constructor(

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

@@ -135,6 +135,7 @@ export function createFirebaseNamespaceCore(
     component: Component
   ): FirebaseServiceNamespace<_FirebaseService> | null {
     const componentName = component.name;
+    const componentNameWithoutCompat = componentName.replace('-compat', '');
     if (
       modularAPIs._registerComponent(component) &&
       component.type === ComponentType.PUBLIC
@@ -145,7 +146,7 @@ export function createFirebaseNamespaceCore(
         appArg: FirebaseApp = app()
       ): _FirebaseService => {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        if (typeof (appArg as any)[componentName] !== 'function') {
+        if (typeof (appArg as any)[componentNameWithoutCompat] !== 'function') {
           // Invalid argument.
           // This happens in the following case: firebase.storage('gs:/')
           throw ERROR_FACTORY.create(AppError.INVALID_APP_ARGUMENT, {
@@ -155,7 +156,7 @@ export function createFirebaseNamespaceCore(
 
         // Forward service instance lookup to the FirebaseApp.
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        return (appArg as any)[componentName]();
+        return (appArg as any)[componentNameWithoutCompat]();
       };
 
       // ... and a container for service-level properties.
@@ -164,11 +165,11 @@ export function createFirebaseNamespaceCore(
       }
 
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      (namespace as any)[componentName] = serviceNamespace;
+      (namespace as any)[componentNameWithoutCompat] = serviceNamespace;
 
       // Patch the FirebaseAppImpl prototype
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      (firebaseAppImpl.prototype as any)[componentName] =
+      (firebaseAppImpl.prototype as any)[componentNameWithoutCompat] =
         // TODO: The eslint disable can be removed and the 'ignoreRestArgs'
         // option added to the no-explicit-any rule when ESlint releases it.
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -183,7 +184,7 @@ export function createFirebaseNamespaceCore(
 
     return component.type === ComponentType.PUBLIC
       ? // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        (namespace as any)[componentName]
+        (namespace as any)[componentNameWithoutCompat]
       : null;
   }
 

packages-exp/app-compat/src/public-types.ts

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 import { LogCallback, LogLevelString, LogOptions } from '@firebase/logger';
-import { FirebaseAppImpl } from './firebaseApp';
+import { FirebaseAppImpl, _FirebaseApp } from './firebaseApp';
 
 export interface FirebaseOptions {
   apiKey?: string;
@@ -33,29 +33,17 @@ export interface FirebaseAppConfig {
   automaticDataCollectionEnabled?: boolean;
 }
 
-// used as type only
-export interface FirebaseApp {
-  /**
-   * The (read-only) name (identifier) for this App. '[DEFAULT]' is the default
-   * App.
-   */
-  name: string;
-
-  /**
-   * The (read-only) configuration options from the app initialization.
-   */
-  options: FirebaseOptions;
-
-  /**
-   * The settable config flag for GDPR opt-in/opt-out
-   */
-  automaticDataCollectionEnabled: boolean;
-
-  /**
-   * Make the given App unusable and free resources.
-   */
-  delete(): Promise<void>;
-}
+/**
+ * This interface will be enhanced by other products by adding e.g. firestore(), messaging() methods.
+ * As a result, FirebaseAppImpl can't directly implement it, otherwise there will be typings errors:
+ *
+ * For example, "Class 'FirebaseAppImpl' incorrectly implements interface 'FirebaseApp'.
+ * Property 'installations' is missing in type 'FirebaseAppImpl' but required in type 'FirebaseApp'"
+ *
+ * To workaround this issue, we defined a _FirebaseApp interface which is implemented by FirebaseAppImpl
+ * and let FirebaseApp extends it.
+ */
+export interface FirebaseApp extends _FirebaseApp {}
 
 export interface FirebaseNamespace {
   /**

packages-exp/app-exp/rollup.shared.js

@@ -16,9 +16,10 @@
  */
 import pkg from './package.json';
 
-const deps = Object.keys(
-  Object.assign({}, pkg.peerDependencies, pkg.dependencies)
-);
+const deps = [
+  ...Object.keys(Object.assign({}, pkg.peerDependencies, pkg.dependencies)),
+  '@firebase/app'
+];
 
 export const es5BuildsNoPlugin = [
   /**

packages-exp/auth-compat-exp/index.ts

@@ -50,10 +50,9 @@ import { version } from './package.json';
 import { Auth } from './src/auth';
 import { Persistence } from './src/persistence';
 import { PhoneAuthProvider as CompatAuthProvider } from './src/phone_auth_provider';
-import { _getClientPlatform } from './src/platform';
 import { RecaptchaVerifier as CompatRecaptchaVerifier } from './src/recaptcha_verifier';
 
-const AUTH_TYPE = 'auth';
+const AUTH_TYPE = 'auth-compat';
 
 declare module '@firebase/component' {
   interface NameServiceMapping {
@@ -140,5 +139,4 @@ function registerAuthCompat(instance: _FirebaseNamespace): void {
   instance.registerVersion('auth', version);
 }
 
-impl.registerAuth(_getClientPlatform());
 registerAuthCompat(firebase as _FirebaseNamespace);

packages-exp/auth-compat-exp/package.json

@@ -55,7 +55,7 @@
   "bugs": {
     "url": "https://github.com/firebase/firebase-js-sdk/issues"
   },
-  "typings": "dist/index.d.ts",
+  "typings": "dist/auth-compat-exp/index.d.ts",
   "nyc": {
     "extension": [
       ".ts"

packages-exp/auth-compat-exp/rollup.config.shared.js

@@ -51,7 +51,10 @@ export function getEs5Builds(additionalTypescriptPlugins = {}) {
       input: 'index.ts',
       output: [{ file: pkg.module, format: 'esm', sourcemap: true }],
       plugins: es5BuildPlugins,
-      external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
+      external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`)),
+      treeshake: {
+        moduleSideEffects: false
+      }
     },
     /**
      * Node.js Build
@@ -60,7 +63,10 @@ export function getEs5Builds(additionalTypescriptPlugins = {}) {
       input: 'index.node.ts',
       output: [{ file: pkg.main, format: 'cjs', sourcemap: true }],
       plugins: es5BuildPlugins,
-      external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
+      external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`)),
+      treeshake: {
+        moduleSideEffects: false
+      }
     },
     /**
      * UMD build
@@ -131,7 +137,10 @@ export function getEs2017Builds(additionalTypescriptPlugins = {}) {
         sourcemap: true
       },
       plugins: es2017BuildPlugins,
-      external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
+      external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`)),
+      treeshake: {
+        moduleSideEffects: false
+      }
     }
   ];
 }

packages-exp/auth-compat-exp/src/persistence.ts

@@ -15,7 +15,6 @@
  * limitations under the License.
  */
 
-import { AuthInternal } from '@firebase/auth-exp/dist/esm5/src/model/auth';
 import * as exp from '@firebase/auth-exp/internal';
 import { isIndexedDBAvailable, isNode, isReactNative } from '@firebase/util';
 import { _isWebStorageSupported, _isWorker } from './platform';
@@ -82,7 +81,7 @@ export function _validatePersistenceArgument(
 }
 
 export async function _savePersistenceForRedirect(
-  auth: AuthInternal
+  auth: exp.AuthInternal
 ): Promise<void> {
   await auth._initializationPromise;
 
@@ -98,7 +97,7 @@ export async function _savePersistenceForRedirect(
 }
 
 export function _getPersistenceFromRedirect(
-  auth: AuthInternal
+  auth: exp.AuthInternal
 ): exp.Persistence | null {
   const win = getSelfWindow();
   if (!win?.sessionStorage) {

packages-exp/auth-compat-exp/src/platform.ts

@@ -149,19 +149,6 @@ export function _isPopupRedirectSupported(): boolean {
   );
 }
 
-export function _getClientPlatform(): impl.ClientPlatform {
-  if (isNode()) {
-    return impl.ClientPlatform.NODE;
-  }
-  if (isReactNative()) {
-    return impl.ClientPlatform.REACT_NATIVE;
-  }
-  if (_isWorker()) {
-    return impl.ClientPlatform.WORKER;
-  }
-  return impl.ClientPlatform.BROWSER;
-}
-
 /** Quick check that indicates the platform *may* be Cordova */
 export function _isLikelyCordova(): boolean {
   return _isAndroidOrIosCordovaScheme() && typeof document !== 'undefined';

packages-exp/auth-exp/internal/index.ts

@@ -32,7 +32,7 @@ export {
   AuthEventType
 } from '../src/model/popup_redirect';
 export { UserCredentialInternal, UserParameters } from '../src/model/user';
-export { registerAuth } from '../src/core/auth/register';
+export { AuthInternal } from '../src/model/auth';
 export { DefaultConfig, AuthImpl, _castAuth } from '../src/core/auth/auth_impl';
 
 export { ClientPlatform, _getClientVersion } from '../src/core/util/version';

packages-exp/auth-exp/rollup.config.shared.js

@@ -22,9 +22,10 @@ import typescript from 'typescript';
 import pkg from './package.json';
 import { importPathTransformer } from '../../scripts/exp/ts-transform-import-path';
 
-const deps = Object.keys(
-  Object.assign({}, pkg.peerDependencies, pkg.dependencies)
-);
+const deps = [
+  ...Object.keys(Object.assign({}, pkg.peerDependencies, pkg.dependencies)),
+  '@firebase/app'
+];
 
 /**
  * Common plugins for all builds