Replace Platform injection with source preprocessor

Author: schmidt-sebastian

config/webpack.test.js

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2017 Google Inc.
+ * 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.
@@ -52,6 +52,28 @@ module.exports = {
         enforce: 'post',
         exclude: [/\.test\.ts$/, /\btest(ing)?\//]
       },
+      {
+        test: /packages\/firestore\/.*\.tsx?$/,
+        use: {
+          loader: 'string-replace-loader',
+          options: {
+            multiple: [
+              {
+                search: '/platform/platform',
+                replace: '/platform_browser/browser_platform'
+              },
+              {
+                search: '/platform/format_json',
+                replace: '/platform_browser/browser_format_json'
+              },
+              {
+                search: '/platform/random_bytes',
+                replace: '/platform_browser/browser_random_bytes'
+              }
+            ]
+          }
+        }
+      },
       {
         test: /\.js$/,
         include: [/node_modules\/chai-as-promised/],

package.json

@@ -129,6 +129,7 @@
     "sinon": "9.0.2",
     "sinon-chai": "3.5.0",
     "source-map-loader": "0.2.4",
+    "string-replace-loader": "2.3.0",
     "terser": "4.6.13",
     "ts-loader": "6.2.2",
     "ts-node": "8.10.1",

packages/firestore/index.console.ts

@@ -15,7 +15,8 @@
  * limitations under the License.
  */
 
-import './src/platform_browser/browser_init';
+// TODO(mrschmidt): Once imported into Google3, fix
+// third_party/javascript/firebase/src/packages/firestore/tools/console.build.js
 
 export { Firestore, FirestoreDatabase } from './src/api/database';
 export {

packages/firestore/index.memory.ts

@@ -23,7 +23,6 @@ import { MemoryComponentProvider } from './src/core/component_provider';
 import { configureForFirebase } from './src/platform/config';
 
 import './register-module';
-import './src/platform_browser/browser_init';
 
 import { name, version } from './package.json';
 

packages/firestore/index.node.memory.ts

@@ -22,7 +22,6 @@ import { Firestore } from './src/api/database';
 import { MemoryComponentProvider } from './src/core/component_provider';
 import { configureForFirebase } from './src/platform/config';
 import './register-module';
-import './src/platform_node/node_init';
 
 import { name, version } from './package.json';
 

packages/firestore/index.node.ts

@@ -22,7 +22,6 @@ import { IndexedDbComponentProvider } from './src/core/component_provider';
 import { configureForFirebase } from './src/platform/config';
 
 import './register-module';
-import './src/platform_node/node_init';
 
 import { name, version } from './package.json';
 

packages/firestore/index.rn.memory.ts

@@ -23,7 +23,6 @@ import { MemoryComponentProvider } from './src/core/component_provider';
 import { configureForFirebase } from './src/platform/config';
 
 import './register-module';
-import './src/platform_rn/rn_init';
 
 import { name, version } from './package.json';
 

packages/firestore/index.rn.ts

@@ -22,8 +22,6 @@ import { IndexedDbComponentProvider } from './src/core/component_provider';
 import { configureForFirebase } from './src/platform/config';
 
 import './register-module';
-import './src/platform_rn/rn_init';
-
 import { name, version } from './package.json';
 
 /**

packages/firestore/index.ts

@@ -24,7 +24,6 @@ import { configureForFirebase } from './src/platform/config';
 import { name, version } from './package.json';
 
 import './register-module';
-import './src/platform_browser/browser_init';
 
 /**
  * Registers the main Firestore build with the components framework.

packages/firestore/lite/index.node.ts

@@ -20,8 +20,6 @@ import { Firestore } from './src/api/database';
 import { version } from '../package.json';
 import { Component, ComponentType } from '@firebase/component';
 
-import '../src/platform_node/node_init';
-
 export {
   Firestore,
   initializeFirestore,

packages/firestore/lite/src/api/database.ts

@@ -33,7 +33,7 @@ import {
   newDatastore,
   terminateDatastore
 } from '../../../src/remote/datastore';
-import { PlatformSupport } from '../../../src/platform/platform';
+import { loadConnection, newSerializer } from '../../../src/platform/platform';
 import { Deferred } from '../../../src/util/promise';
 import { cast } from './util';
 
@@ -83,19 +83,11 @@ export class Firestore implements firestore.FirebaseFirestore {
 
     // Kick off initializing the datastore but don't actually wait for it.
     // eslint-disable-next-line @typescript-eslint/no-floating-promises
-    PlatformSupport.getPlatform()
-      .loadConnection(databaseInfo)
-      .then(connection => {
-        const serializer = PlatformSupport.getPlatform().newSerializer(
-          databaseInfo.databaseId
-        );
-        const datastore = newDatastore(
-          connection,
-          this._credentials,
-          serializer
-        );
-        this._datastoreDeferred.resolve(datastore);
-      });
+    loadConnection(databaseInfo).then(connection => {
+      const serializer = newSerializer(databaseInfo.databaseId);
+      const datastore = newDatastore(connection, this._credentials, serializer);
+      this._datastoreDeferred.resolve(datastore);
+    });
   }
 
   _ensureClientConfigured(): Promise<Datastore> {

packages/firestore/lite/src/api/reference.ts

@@ -35,7 +35,7 @@ import {
 } from '../../../src/remote/datastore';
 import { hardAssert } from '../../../src/util/assert';
 import { DeleteMutation, Precondition } from '../../../src/model/mutation';
-import { PlatformSupport } from '../../../src/platform/platform';
+import { newSerializer } from '../../../src/platform/platform';
 import { applyFirestoreDataConverter } from '../../../src/api/database';
 import { DatabaseId } from '../../../src/core/database_info';
 import { FieldPath } from './field_path';
@@ -422,7 +422,7 @@ export function newUserDataReader(
   databaseId: DatabaseId,
   settings: firestore.Settings
 ): UserDataReader {
-  const serializer = PlatformSupport.getPlatform().newSerializer(databaseId);
+  const serializer = newSerializer(databaseId);
   return new UserDataReader(
     databaseId,
     !!settings.ignoreUndefinedProperties,

packages/firestore/package.json

@@ -68,6 +68,7 @@
   "devDependencies": {
     "@firebase/app-exp": "0.x",
     "@firebase/app-types-exp": "0.x",
+    "@rollup/plugin-alias": "3.1.1",
     "@types/json-stable-stringify": "1.0.32",
     "json-stable-stringify": "1.0.1",
     "protobufjs": "6.9.0",

packages/firestore/rollup.config.es2017.js

@@ -18,6 +18,7 @@
 import * as path from 'path';
 
 import json from 'rollup-plugin-json';
+import alias from '@rollup/plugin-alias';
 import typescriptPlugin from 'rollup-plugin-typescript2';
 import replace from 'rollup-plugin-replace';
 import copy from 'rollup-plugin-copy-assets';
@@ -31,7 +32,8 @@ import {
   firestoreTransformers,
   manglePrivatePropertiesOptions,
   resolveNodeExterns,
-  resolveBrowserExterns
+  resolveBrowserExterns,
+  generateAliasConfig
 } from './rollup.shared';
 
 // Firestore is released in a number of different build configurations:
@@ -61,6 +63,7 @@ import {
 // MARK: Browser builds
 
 const browserBuildPlugins = [
+  alias(generateAliasConfig('browser')),
   typescriptPlugin({
     typescript,
     tsconfigOverride: {
@@ -100,6 +103,11 @@ const browserBuilds = [
   }
 ];
 
+const reactNativeBuildPlugins = [
+  alias(generateAliasConfig('rn')),
+  ...browserBuildPlugins.slice(1)
+];
+
 const reactNativeBuilds = [
   // Persistence build
   {
@@ -109,7 +117,7 @@ const reactNativeBuilds = [
       format: 'es',
       sourcemap: true
     },
-    plugins: browserBuildPlugins,
+    plugins: reactNativeBuildPlugins,
     external: resolveBrowserExterns
   },
   // Memory-only build
@@ -120,14 +128,15 @@ const reactNativeBuilds = [
       format: 'es',
       sourcemap: true
     },
-    plugins: browserBuildPlugins,
+    plugins: reactNativeBuildPlugins,
     external: resolveBrowserExterns
   }
 ];
 
 // MARK: Node builds
 
 const nodeBuildPlugins = [
+  alias(generateAliasConfig('node')),
   typescriptPlugin({
     typescript,
     tsconfigOverride: {

packages/firestore/rollup.config.lite.js

@@ -16,15 +16,17 @@
  */
 
 import json from 'rollup-plugin-json';
+import alias from '@rollup/plugin-alias';
 import typescriptPlugin from 'rollup-plugin-typescript2';
 import typescript from 'typescript';
 
-import { resolveNodeExterns } from './rollup.shared';
+import { resolveNodeExterns, generateAliasConfig } from './rollup.shared';
 
 import pkg from './lite/package.json';
 import path from 'path';
 
 const defaultPlugins = [
+  alias(generateAliasConfig('node')),
   typescriptPlugin({
     typescript,
     tsconfigOverride: {

packages/firestore/rollup.shared.js

@@ -24,6 +24,30 @@ import { removeAsserts } from './scripts/remove-asserts';
 
 import pkg from './package.json';
 
+/**
+ * Returns an replacement configuration for `@rollup/plugin-alias` that replaces
+ * references to platform-specific files with implementations for the provided
+ * target platform.
+ */
+export function generateAliasConfig(platform) {
+  return {
+    entries: [
+      {
+        find: /(.*)\/platform\/platform(.*)/,
+        replacement: `$1/platform_${platform}/${platform}_platform$2`
+      },
+      {
+        find: /(.*)\/platform\/random_bytes(.*)/,
+        replacement: `$1/platform_${platform}/${platform}_random_bytes$2`
+      },
+      {
+        find: /(.*)\/platform\/format_json(.*)/,
+        replacement: `$1/platform_${platform}/${platform}_format_json$2`
+      }
+    ]
+  };
+}
+
 const browserDeps = Object.keys(
   Object.assign({}, pkg.peerDependencies, pkg.dependencies)
 );

packages/firestore/src/api/blob.ts

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-import { PlatformSupport } from '../platform/platform';
+import { isBase64Available } from '../platform/platform';
 import { Code, FirestoreError } from '../util/error';
 import {
   invalidClassError,
@@ -36,7 +36,7 @@ function assertUint8ArrayAvailable(): void {
 
 /** Helper function to assert Base64 functions are available at runtime. */
 function assertBase64Available(): void {
-  if (!PlatformSupport.getPlatform().base64Available) {
+  if (!isBase64Available()) {
     throw new FirestoreError(
       Code.UNIMPLEMENTED,
       'Blobs are unavailable in Firestore in this environment.'

packages/firestore/src/api/database.ts

@@ -46,7 +46,6 @@ import { DeleteMutation, Mutation, Precondition } from '../model/mutation';
 import { FieldPath, ResourcePath } from '../model/path';
 import { isServerTimestamp } from '../model/server_timestamps';
 import { refValue } from '../model/values';
-import { PlatformSupport } from '../platform/platform';
 import { debugAssert, fail } from '../util/assert';
 import { AsyncObserver } from '../util/async_observer';
 import { AsyncQueue } from '../util/async_queue';
@@ -529,7 +528,6 @@ export class Firestore implements firestore.FirebaseFirestore, FirebaseService {
     const databaseInfo = this.makeDatabaseInfo();
 
     this._firestoreClient = new FirestoreClient(
-      PlatformSupport.getPlatform(),
       databaseInfo,
       this._credentials,
       this._queue

packages/firestore/src/api/user_data_reader.ts

@@ -42,7 +42,7 @@ import { Blob } from './blob';
 import { BaseFieldPath, fromDotSeparatedString } from './field_path';
 import { DeleteFieldValueImpl, SerializableFieldValue } from './field_value';
 import { GeoPoint } from './geo_point';
-import { PlatformSupport } from '../platform/platform';
+import { newSerializer } from '../platform/platform';
 
 const RESERVED_FIELD_REGEX = /^__.*__$/;
 
@@ -302,8 +302,7 @@ export class UserDataReader {
     private readonly ignoreUndefinedProperties: boolean,
     serializer?: JsonProtoSerializer
   ) {
-    this.serializer =
-      serializer || PlatformSupport.getPlatform().newSerializer(databaseId);
+    this.serializer = serializer || newSerializer(databaseId);
   }
 
   /** Parse document data from a set() call. */