Untangle Platform

Author: schmidt-sebastian

packages/firestore/index.console.ts

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-import './src/platform_browser/browser_init';
+// TODO(mrschmidt): Figure out console build
 
 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.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/rollup.shared.js

@@ -31,12 +31,26 @@ const browserDeps = Object.keys(
 const nodeDeps = [...browserDeps, 'util', 'path'];
 
 /** Resolves the external dependencies for the browser build. */
-export function resolveBrowserExterns(id) {
+export function resolveBrowserExterns(id, importedFrom) {
+  const resolvedPath = path.resolve(importedFrom, id);
+  if (resolvedPath.indexOf('src/platform/platform') !== -1) {
+    return id.replace(
+      'src/platform/platform.ts',
+      'src/platform_browser/browser_platform'
+    );
+  }
   return browserDeps.some(dep => id === dep || id.startsWith(`${dep}/`));
 }
 
 /** Resolves the external dependencies for the Node build. */
-export function resolveNodeExterns(id) {
+export function resolveNodeExterns(id, importedFrom) {
+  const resolvedPath = path.resolve(importedFrom, id);
+  if (resolvedPath.indexOf('src/platform/platform') !== -1) {
+    return id.replace(
+      'src/platform/platform.ts',
+      'src/platform_node/node_platform'
+    );
+  }
   return nodeDeps.some(dep => id === dep || id.startsWith(`${dep}/`));
 }
 

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. */

packages/firestore/src/core/component_provider.ts

@@ -27,7 +27,12 @@ import { RemoteStore } from '../remote/remote_store';
 import { EventManager } from './event_manager';
 import { AsyncQueue } from '../util/async_queue';
 import { DatabaseInfo } from './database_info';
-import { Platform } from '../platform/platform';
+import {
+  getDocument,
+  getWindow,
+  newConnectivityMonitor,
+  newSerializer
+} from '../platform/platform';
 import { Datastore } from '../remote/datastore';
 import { User } from '../auth/user';
 import { PersistenceSettings } from './firestore_client';
@@ -51,7 +56,6 @@ const MEMORY_ONLY_PERSISTENCE_ERROR_MESSAGE =
 export interface ComponentConfiguration {
   asyncQueue: AsyncQueue;
   databaseInfo: DatabaseInfo;
-  platform: Platform;
   datastore: Datastore;
   clientId: ClientId;
   initialUser: User;
@@ -152,7 +156,7 @@ export class MemoryComponentProvider implements ComponentProvider {
           onlineState,
           OnlineStateSource.RemoteStore
         ),
-      cfg.platform.newConnectivityMonitor()
+      newConnectivityMonitor()
     );
   }
 
@@ -250,14 +254,15 @@ export class IndexedDbComponentProvider extends MemoryComponentProvider {
     const persistenceKey = IndexedDbPersistence.buildStoragePrefix(
       cfg.databaseInfo
     );
-    const serializer = cfg.platform.newSerializer(cfg.databaseInfo.databaseId);
+    const serializer = newSerializer(cfg.databaseInfo.databaseId);
     return new IndexedDbPersistence(
       cfg.persistenceSettings.synchronizeTabs,
       persistenceKey,
       cfg.clientId,
-      cfg.platform,
       LruParams.withCacheSize(cfg.persistenceSettings.cacheSizeBytes),
       cfg.asyncQueue,
+      getWindow(),
+      getDocument(),
       serializer,
       this.sharedClientState,
       cfg.persistenceSettings.forceOwningTab
@@ -269,7 +274,8 @@ export class IndexedDbComponentProvider extends MemoryComponentProvider {
       cfg.persistenceSettings.durable &&
       cfg.persistenceSettings.synchronizeTabs
     ) {
-      if (!WebStorageSharedClientState.isAvailable(cfg.platform)) {
+      const window = getWindow();
+      if (!WebStorageSharedClientState.isAvailable(window)) {
         throw new FirestoreError(
           Code.UNIMPLEMENTED,
           'IndexedDB persistence is only available on platforms that support LocalStorage.'
@@ -279,8 +285,8 @@ export class IndexedDbComponentProvider extends MemoryComponentProvider {
         cfg.databaseInfo
       );
       return new WebStorageSharedClientState(
+        window,
         cfg.asyncQueue,
-        cfg.platform,
         persistenceKey,
         cfg.clientId,
         cfg.initialUser

packages/firestore/src/core/firestore_client.ts

@@ -22,7 +22,7 @@ import { GarbageCollectionScheduler, Persistence } from '../local/persistence';
 import { Document, NoDocument } from '../model/document';
 import { DocumentKey } from '../model/document_key';
 import { Mutation } from '../model/mutation';
-import { Platform } from '../platform/platform';
+import { loadConnection, newSerializer } from '../platform/platform';
 import { newDatastore } from '../remote/datastore';
 import { RemoteStore } from '../remote/remote_store';
 import { AsyncQueue, wrapInUserErrorIfRecoverable } from '../util/async_queue';
@@ -93,7 +93,6 @@ export class FirestoreClient {
   private readonly clientId = AutoId.newId();
 
   constructor(
-    private platform: Platform,
     private databaseInfo: DatabaseInfo,
     private credentials: CredentialsProvider,
     /**
@@ -235,16 +234,13 @@ export class FirestoreClient {
       // Datastore (without duplicating the initializing logic once per
       // provider).
 
-      const connection = await this.platform.loadConnection(this.databaseInfo);
-      const serializer = this.platform.newSerializer(
-        this.databaseInfo.databaseId
-      );
+      const connection = await loadConnection(this.databaseInfo);
+      const serializer = newSerializer(this.databaseInfo.databaseId);
       const datastore = newDatastore(connection, this.credentials, serializer);
 
       await componentProvider.initialize({
         asyncQueue: this.asyncQueue,
         databaseInfo: this.databaseInfo,
-        platform: this.platform,
         datastore,
         clientId: this.clientId,
         initialUser: user,

packages/firestore/src/local/indexeddb_persistence.ts

@@ -20,7 +20,6 @@ import { DatabaseInfo } from '../core/database_info';
 import { ListenSequence, SequenceNumberSyncer } from '../core/listen_sequence';
 import { ListenSequenceNumber, TargetId } from '../core/types';
 import { DocumentKey } from '../model/document_key';
-import { Platform } from '../platform/platform';
 import { JsonProtoSerializer } from '../remote/serializer';
 import { debugAssert, fail } from '../util/assert';
 import { AsyncQueue, DelayedOperation, TimerId } from '../util/async_queue';
@@ -75,6 +74,7 @@ import {
   SimpleDbStore,
   SimpleDbTransaction
 } from './simple_db';
+import { DocumentLike, WindowLike } from '../util/types';
 
 const LOG_TAG = 'IndexedDbPersistence';
 
@@ -191,9 +191,6 @@ export class IndexedDbPersistence implements Persistence {
    */
   static MAIN_DATABASE = 'main';
 
-  private readonly document: Document | null;
-  private readonly window: Window | null;
-
   // Technically `simpleDb` should be `| undefined` because it is
   // initialized asynchronously by start(), but that would be more misleading
   // than useful.
@@ -239,9 +236,10 @@ export class IndexedDbPersistence implements Persistence {
 
     private readonly persistenceKey: string,
     private readonly clientId: ClientId,
-    platform: Platform,
     lruParams: LruParams,
     private readonly queue: AsyncQueue,
+    private readonly window: WindowLike | null,
+    private readonly document: DocumentLike | null,
     serializer: JsonProtoSerializer,
     private readonly sequenceNumberSyncer: SequenceNumberSyncer,
 
@@ -261,7 +259,6 @@ export class IndexedDbPersistence implements Persistence {
     this.referenceDelegate = new IndexedDbLruDelegate(this, lruParams);
     this.dbName = persistenceKey + IndexedDbPersistence.MAIN_DATABASE;
     this.serializer = new LocalSerializer(serializer);
-    this.document = platform.document;
     this.targetCache = new IndexedDbTargetCache(
       this.referenceDelegate,
       this.serializer
@@ -271,9 +268,8 @@ export class IndexedDbPersistence implements Persistence {
       this.serializer,
       this.indexManager
     );
-    this.window = platform.window;
-    if (platform.window && platform.window.localStorage) {
-      this.webStorage = platform.window.localStorage;
+    if (this.window && this.window.localStorage) {
+      this.webStorage = this.window.localStorage;
     } else {
       this.webStorage = null;
       if (forceOwningTab === false) {