Remove Cyclic Dependencies

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

@@ -35,10 +35,7 @@ import {
   OfflineComponentProvider,
   OnlineComponentProvider
 } from '../../../src/core/component_provider';
-import {
-  FirebaseFirestore as LiteFirestore,
-  Settings as LiteSettings
-} from '../../../lite/src/api/database';
+import { FirebaseFirestore as LiteFirestore } from '../../../lite/src/api/database';
 import { DatabaseId } from '../../../src/core/database_info';
 import { Code, FirestoreError } from '../../../src/util/error';
 import { Deferred } from '../../../src/util/promise';
@@ -53,6 +50,7 @@ import {
   indexedDbStoragePrefix
 } from '../../../src/local/indexeddb_persistence';
 import { cast } from '../../../src/util/input_validation';
+import { Settings as LiteSettings } from '../../../lite/src/api/components';
 
 /** DOMException error code constants. */
 const DOM_EXCEPTION_INVALID_STATE = 11;

packages/firestore/lite/index.ts

@@ -20,7 +20,6 @@ import { registerFirestore } from './register';
 registerFirestore();
 
 export {
-  Settings,
   FirebaseFirestore,
   initializeFirestore,
   getFirestore,
@@ -94,3 +93,4 @@ export { Timestamp } from '../src/api/timestamp';
 
 export { FirestoreErrorCode, FirestoreError } from '../src/util/error';
 export { FieldValue } from '../src/api/field_value';
+export { Settings } from './src/api/components';

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

@@ -18,32 +18,141 @@
 import { Datastore, newDatastore } from '../../../src/remote/datastore';
 import { newConnection } from '../../../src/platform/connection';
 import { newSerializer } from '../../../src/platform/serializer';
-import { FirebaseFirestore, makeDatabaseInfo } from './database';
 import { logDebug } from '../../../src/util/log';
 import { Code, FirestoreError } from '../../../src/util/error';
+import { _FirebaseService } from '@firebase/app-types-exp';
+import { DatabaseId, DatabaseInfo } from '../../../src/core/database_info';
+import {
+  LRU_COLLECTION_DISABLED,
+  LRU_DEFAULT_CACHE_SIZE_BYTES
+} from '../../../src/local/lru_garbage_collector';
+import { LRU_MINIMUM_CACHE_SIZE_BYTES } from '../../../src/local/lru_garbage_collector_impl';
+import { validateIsNotUsedTogether } from '../../../src/util/input_validation';
+import {
+  CredentialsProvider,
+  CredentialsSettings
+} from '../../../src/api/credentials';
 
 export const LOG_TAG = 'ComponentProvider';
 
 // settings() defaults:
 export const DEFAULT_HOST = 'firestore.googleapis.com';
 export const DEFAULT_SSL = true;
 
+/** Undocumented, private additional settings not exposed in our public API. */
+export interface PrivateSettings extends Settings {
+  // Can be a google-auth-library or gapi client.
+  credentials?: CredentialsSettings;
+}
+
+/**
+ * A concrete type describing all the values that can be applied via a
+ * user-supplied firestore.Settings object. This is a separate type so that
+ * defaults can be supplied and the value can be checked for equality.
+ */
+export class FirestoreSettings {
+  /** The hostname to connect to. */
+  readonly host: string;
+
+  /** Whether to use SSL when connecting. */
+  readonly ssl: boolean;
+
+  readonly cacheSizeBytes: number;
+
+  readonly experimentalForceLongPolling: boolean;
+
+  readonly experimentalAutoDetectLongPolling: boolean;
+
+  readonly ignoreUndefinedProperties: boolean;
+
+  // Can be a google-auth-library or gapi client.
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  credentials?: any;
+
+  constructor(settings: PrivateSettings) {
+    if (settings.host === undefined) {
+      if (settings.ssl !== undefined) {
+        throw new FirestoreError(
+          Code.INVALID_ARGUMENT,
+          "Can't provide ssl option if host option is not set"
+        );
+      }
+      this.host = DEFAULT_HOST;
+      this.ssl = DEFAULT_SSL;
+    } else {
+      this.host = settings.host;
+      this.ssl = settings.ssl ?? DEFAULT_SSL;
+    }
+
+    this.credentials = settings.credentials;
+    this.ignoreUndefinedProperties = !!settings.ignoreUndefinedProperties;
+
+    if (settings.cacheSizeBytes === undefined) {
+      this.cacheSizeBytes = LRU_DEFAULT_CACHE_SIZE_BYTES;
+    } else {
+      if (
+        settings.cacheSizeBytes !== LRU_COLLECTION_DISABLED &&
+        settings.cacheSizeBytes < LRU_MINIMUM_CACHE_SIZE_BYTES
+      ) {
+        throw new FirestoreError(
+          Code.INVALID_ARGUMENT,
+          `cacheSizeBytes must be at least ${LRU_MINIMUM_CACHE_SIZE_BYTES}`
+        );
+      } else {
+        this.cacheSizeBytes = settings.cacheSizeBytes;
+      }
+    }
+
+    this.experimentalForceLongPolling = !!settings.experimentalForceLongPolling;
+    this.experimentalAutoDetectLongPolling = !!settings.experimentalAutoDetectLongPolling;
+
+    validateIsNotUsedTogether(
+      'experimentalForceLongPolling',
+      settings.experimentalForceLongPolling,
+      'experimentalAutoDetectLongPolling',
+      settings.experimentalAutoDetectLongPolling
+    );
+  }
+
+  isEqual(other: FirestoreSettings): boolean {
+    return (
+      this.host === other.host &&
+      this.ssl === other.ssl &&
+      this.credentials === other.credentials &&
+      this.cacheSizeBytes === other.cacheSizeBytes &&
+      this.experimentalForceLongPolling ===
+        other.experimentalForceLongPolling &&
+      this.experimentalAutoDetectLongPolling ===
+        other.experimentalAutoDetectLongPolling &&
+      this.ignoreUndefinedProperties === other.ignoreUndefinedProperties
+    );
+  }
+}
+
 // The components module manages the lifetime of dependencies of the Firestore
 // client. Dependencies can be lazily constructed and only one exists per
 // Firestore instance.
 
+export interface FirestoreService extends _FirebaseService {
+  _credentials: CredentialsProvider;
+  _persistenceKey: string;
+  _databaseId: DatabaseId;
+  _terminated: boolean;
+
+  _freezeSettings(): FirestoreSettings;
+}
 /**
  * An instance map that ensures only one Datastore exists per Firestore
  * instance.
  */
-const datastoreInstances = new Map<FirebaseFirestore, Datastore>();
+const datastoreInstances = new Map<FirestoreService, Datastore>();
 
 /**
  * Returns an initialized and started Datastore for the given Firestore
  * instance. Callers must invoke removeComponents() when the Firestore
  * instance is terminated.
  */
-export function getDatastore(firestore: FirebaseFirestore): Datastore {
+export function getDatastore(firestore: FirestoreService): Datastore {
   if (firestore._terminated) {
     throw new FirestoreError(
       Code.FAILED_PRECONDITION,
@@ -74,11 +183,35 @@ export function getDatastore(firestore: FirebaseFirestore): Datastore {
  * Removes all components associated with the provided instance. Must be called
  * when the `Firestore` instance is terminated.
  */
-export function removeComponents(firestore: FirebaseFirestore): void {
+export function removeComponents(firestore: FirestoreService): void {
   const datastore = datastoreInstances.get(firestore);
   if (datastore) {
     logDebug(LOG_TAG, 'Removing Datastore');
     datastoreInstances.delete(firestore);
     datastore.terminate();
   }
 }
+
+export interface Settings {
+  host?: string;
+  ssl?: boolean;
+  ignoreUndefinedProperties?: boolean;
+  cacheSizeBytes?: number;
+  experimentalForceLongPolling?: boolean;
+  experimentalAutoDetectLongPolling?: boolean;
+}
+
+export function makeDatabaseInfo(
+  databaseId: DatabaseId,
+  persistenceKey: string,
+  settings: FirestoreSettings
+): DatabaseInfo {
+  return new DatabaseInfo(
+    databaseId,
+    persistenceKey,
+    settings.host,
+    settings.ssl,
+    settings.experimentalForceLongPolling,
+    settings.experimentalAutoDetectLongPolling
+  );
+}

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

@@ -16,145 +16,39 @@
  */
 
 import { _getProvider, _removeServiceInstance } from '@firebase/app-exp';
-import { _FirebaseService, FirebaseApp } from '@firebase/app-types-exp';
+import { FirebaseApp } from '@firebase/app-types-exp';
 import { Provider } from '@firebase/component';
 
 import { Code, FirestoreError } from '../../../src/util/error';
-import { DatabaseId, DatabaseInfo } from '../../../src/core/database_info';
+import { DatabaseId } from '../../../src/core/database_info';
 import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
 import {
   CredentialsProvider,
-  FirebaseCredentialsProvider,
-  CredentialsSettings,
   EmptyCredentialsProvider,
+  FirebaseCredentialsProvider,
   makeCredentialsProvider
 } from '../../../src/api/credentials';
-import { removeComponents } from './components';
-import { LRU_MINIMUM_CACHE_SIZE_BYTES } from '../../../src/local/lru_garbage_collector_impl';
-import {
-  cast,
-  validateIsNotUsedTogether
-} from '../../../src/util/input_validation';
 import {
-  LRU_COLLECTION_DISABLED,
-  LRU_DEFAULT_CACHE_SIZE_BYTES
-} from '../../../src/local/lru_garbage_collector';
+  FirestoreService,
+  FirestoreSettings,
+  PrivateSettings,
+  removeComponents,
+  Settings
+} from './components';
+import { cast } from '../../../src/util/input_validation';
 
 declare module '@firebase/component' {
   interface NameServiceMapping {
     'firestore/lite': FirebaseFirestore;
   }
 }
 
-// settings() defaults:
-const DEFAULT_HOST = 'firestore.googleapis.com';
-const DEFAULT_SSL = true;
-
-export interface Settings {
-  host?: string;
-  ssl?: boolean;
-  ignoreUndefinedProperties?: boolean;
-  cacheSizeBytes?: number;
-  experimentalForceLongPolling?: boolean;
-  experimentalAutoDetectLongPolling?: boolean;
-}
-
-/** Undocumented, private additional settings not exposed in our public API. */
-interface PrivateSettings extends Settings {
-  // Can be a google-auth-library or gapi client.
-  credentials?: CredentialsSettings;
-}
-
-/**
- * A concrete type describing all the values that can be applied via a
- * user-supplied firestore.Settings object. This is a separate type so that
- * defaults can be supplied and the value can be checked for equality.
- */
-export class FirestoreSettings {
-  /** The hostname to connect to. */
-  readonly host: string;
-
-  /** Whether to use SSL when connecting. */
-  readonly ssl: boolean;
-
-  readonly cacheSizeBytes: number;
-
-  readonly experimentalForceLongPolling: boolean;
-
-  readonly experimentalAutoDetectLongPolling: boolean;
-
-  readonly ignoreUndefinedProperties: boolean;
-
-  // Can be a google-auth-library or gapi client.
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  credentials?: any;
-
-  constructor(settings: PrivateSettings) {
-    if (settings.host === undefined) {
-      if (settings.ssl !== undefined) {
-        throw new FirestoreError(
-          Code.INVALID_ARGUMENT,
-          "Can't provide ssl option if host option is not set"
-        );
-      }
-      this.host = DEFAULT_HOST;
-      this.ssl = DEFAULT_SSL;
-    } else {
-      this.host = settings.host;
-      this.ssl = settings.ssl ?? DEFAULT_SSL;
-    }
-
-    this.credentials = settings.credentials;
-    this.ignoreUndefinedProperties = !!settings.ignoreUndefinedProperties;
-
-    if (settings.cacheSizeBytes === undefined) {
-      this.cacheSizeBytes = LRU_DEFAULT_CACHE_SIZE_BYTES;
-    } else {
-      if (
-        settings.cacheSizeBytes !== LRU_COLLECTION_DISABLED &&
-        settings.cacheSizeBytes < LRU_MINIMUM_CACHE_SIZE_BYTES
-      ) {
-        throw new FirestoreError(
-          Code.INVALID_ARGUMENT,
-          `cacheSizeBytes must be at least ${LRU_MINIMUM_CACHE_SIZE_BYTES}`
-        );
-      } else {
-        this.cacheSizeBytes = settings.cacheSizeBytes;
-      }
-    }
-
-    this.experimentalForceLongPolling = !!settings.experimentalForceLongPolling;
-    this.experimentalAutoDetectLongPolling = !!settings.experimentalAutoDetectLongPolling;
-
-    validateIsNotUsedTogether(
-      'experimentalForceLongPolling',
-      settings.experimentalForceLongPolling,
-      'experimentalAutoDetectLongPolling',
-      settings.experimentalAutoDetectLongPolling
-    );
-  }
-
-  isEqual(other: FirestoreSettings): boolean {
-    return (
-      this.host === other.host &&
-      this.ssl === other.ssl &&
-      this.credentials === other.credentials &&
-      this.cacheSizeBytes === other.cacheSizeBytes &&
-      this.experimentalForceLongPolling ===
-        other.experimentalForceLongPolling &&
-      this.experimentalAutoDetectLongPolling ===
-        other.experimentalAutoDetectLongPolling &&
-      this.ignoreUndefinedProperties === other.ignoreUndefinedProperties
-    );
-  }
-}
-
 /**
  * The Cloud Firestore service interface.
  *
  * Do not call this constructor directly. Instead, use {@link getFirestore}.
  */
-export class FirebaseFirestore implements _FirebaseService {
+export class FirebaseFirestore implements FirestoreService {
   readonly _databaseId: DatabaseId;
   readonly _persistenceKey: string = '(lite)';
   _credentials: CredentialsProvider;
@@ -324,18 +218,3 @@ export function terminate(firestore: FirebaseFirestore): Promise<void> {
   _removeServiceInstance(firestore.app, 'firestore/lite');
   return firestore._delete();
 }
-
-export function makeDatabaseInfo(
-  databaseId: DatabaseId,
-  persistenceKey: string,
-  settings: FirestoreSettings
-): DatabaseInfo {
-  return new DatabaseInfo(
-    databaseId,
-    persistenceKey,
-    settings.host,
-    settings.ssl,
-    settings.experimentalForceLongPolling,
-    settings.experimentalAutoDetectLongPolling
-  );
-}