Remove Cyclic Dependencies

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

@@ -15,7 +15,6 @@
  * limitations under the License.
  */
 
-import { DocumentKey } from '../../../src/model/document_key';
 import { Document } from '../../../src/model/document';
 import { AbstractUserDataWriter } from '../../../src/api/user_data_writer';
 import {
@@ -38,6 +37,7 @@ import { SnapshotListenOptions } from './reference';
 import { UntypedFirestoreDataConverter } from '../../../src/api/user_data_reader';
 import { debugAssert, fail } from '../../../src/util/assert';
 import { newQueryComparator } from '../../../src/core/query';
+import { DocumentKey } from '../../../src/model/path';
 
 /**
  * Converter used by `withConverter()` to transform user objects of type `T`
@@ -176,9 +176,9 @@ export interface DocumentChange<T = DocumentData> {
  * access will return 'undefined'. You can use the `exists()` method to
  * explicitly verify a document's existence.
  */
-export class DocumentSnapshot<
-  T = DocumentData
-> extends LiteDocumentSnapshot<T> {
+export class DocumentSnapshot<T = DocumentData> extends LiteDocumentSnapshot<
+  T
+> {
   private readonly _firestoreImpl: FirebaseFirestore;
 
   /**
@@ -291,9 +291,9 @@ export class DocumentSnapshot<
  * `exists` property will always be true and `data()` will never return
  * 'undefined'.
  */
-export class QueryDocumentSnapshot<
-  T = DocumentData
-> extends DocumentSnapshot<T> {
+export class QueryDocumentSnapshot<T = DocumentData> extends DocumentSnapshot<
+  T
+> {
   /**
    * Retrieves all fields in the document as an `Object`.
    *

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

@@ -18,7 +18,6 @@
 import { Value as ProtoValue } from '../../../src/protos/firestore_proto_api';
 
 import { Document } from '../../../src/model/document';
-import { DocumentKey } from '../../../src/model/document_key';
 import { FirebaseFirestore } from './database';
 import {
   ParsedUpdateData,
@@ -47,6 +46,7 @@ import {
   queryWithStartAt
 } from '../../../src/core/query';
 import {
+  DocumentKey,
   FieldPath as InternalFieldPath,
   ResourcePath
 } from '../../../src/model/path';

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

@@ -24,10 +24,12 @@ import {
   SetOptions
 } from './reference';
 import { FieldPath } from './field_path';
-import { DocumentKey } from '../../../src/model/document_key';
 import { Document } from '../../../src/model/document';
 import { AbstractUserDataWriter } from '../../../src/api/user_data_writer';
-import { FieldPath as InternalFieldPath } from '../../../src/model/path';
+import {
+  DocumentKey,
+  FieldPath as InternalFieldPath
+} from '../../../src/model/path';
 import {
   fieldPathFromDotSeparatedString,
   UntypedFirestoreDataConverter
@@ -211,9 +213,9 @@ export class DocumentSnapshot<T = DocumentData> {
  * `exists` property will always be true and `data()` will never return
  * 'undefined'.
  */
-export class QueryDocumentSnapshot<
-  T = DocumentData
-> extends DocumentSnapshot<T> {
+export class QueryDocumentSnapshot<T = DocumentData> extends DocumentSnapshot<
+  T
+> {
   /**
    * Retrieves all fields in the document as an `Object`.
    *

packages/firestore/src/api/database.ts

@@ -23,8 +23,7 @@ import {
   firestoreClientGetNamedQuery,
   firestoreClientLoadBundle
 } from '../core/firestore_client';
-import { DocumentKey } from '../model/document_key';
-import { FieldPath, ResourcePath } from '../model/path';
+import { DocumentKey, FieldPath, ResourcePath } from '../model/path';
 import { debugAssert } from '../util/assert';
 import { Code, FirestoreError } from '../util/error';
 import {

packages/firestore/src/api/user_data_reader.ts

@@ -27,7 +27,6 @@ import {
 } from '../protos/firestore_proto_api';
 import { Timestamp } from './timestamp';
 import { DatabaseId } from '../core/database_info';
-import { DocumentKey } from '../model/document_key';
 import {
   FieldTransform,
   Mutation,
@@ -36,7 +35,7 @@ import {
   SetMutation,
   TransformMutation
 } from '../model/mutation';
-import { FieldPath as InternalFieldPath } from '../model/path';
+import { DocumentKey, FieldPath as InternalFieldPath } from '../model/path';
 import { debugAssert, fail } from '../util/assert';
 import { Code, FirestoreError } from '../util/error';
 import { isPlainObject, valueDescription } from '../util/input_validation';

packages/firestore/src/api/user_data_writer.ts

@@ -27,15 +27,14 @@ import {
 import { GeoPoint } from './geo_point';
 import { Timestamp } from './timestamp';
 import { DatabaseId } from '../core/database_info';
-import { DocumentKey } from '../model/document_key';
 import { typeOrder } from '../model/values';
 import {
   getLocalWriteTime,
   getPreviousValue
 } from '../model/server_timestamps';
 import { fail, hardAssert } from '../util/assert';
 import { forEach } from '../util/obj';
-import { ResourcePath } from '../model/path';
+import { DocumentKey, ResourcePath } from '../model/path';
 import { isValidResourceName } from '../remote/serializer';
 import { logError } from '../util/log';
 import { ByteString } from '../util/byte_string';

packages/firestore/src/core/firestore_client.ts

@@ -24,7 +24,6 @@ import {
 import { User } from '../auth/user';
 import { LocalStore } from '../local/local_store';
 import { Document, NoDocument } from '../model/document';
-import { DocumentKey } from '../model/document_key';
 import { Mutation } from '../model/mutation';
 import {
   RemoteStore,
@@ -84,6 +83,7 @@ import {
   readLocalDocument
 } from '../local/local_store_impl';
 import { newBundleReader } from '../util/bundle_reader_impl';
+import { DocumentKey } from '../model/path';
 
 const LOG_TAG = 'FirestoreClient';
 export const MAX_CONCURRENT_LIMBO_RESOLUTIONS = 100;

packages/firestore/src/core/query.ts

@@ -16,8 +16,7 @@
  */
 
 import { compareDocumentsByField, Document } from '../model/document';
-import { DocumentKey } from '../model/document_key';
-import { FieldPath, ResourcePath } from '../model/path';
+import { DocumentKey, FieldPath, ResourcePath } from '../model/path';
 import { debugAssert, debugCast, fail } from '../util/assert';
 import { isNullOrUndefined } from '../util/types';
 import {

packages/firestore/src/core/sync_engine.ts

@@ -26,7 +26,6 @@ import {
   MaybeDocumentMap
 } from '../model/collections';
 import { MaybeDocument, NoDocument } from '../model/document';
-import { DocumentKey } from '../model/document_key';
 import { Mutation } from '../model/mutation';
 import { BATCHID_UNKNOWN, MutationBatchResult } from '../model/mutation_batch';
 import { RemoteEvent, TargetChange } from '../remote/remote_event';
@@ -107,6 +106,7 @@ import {
   removeCachedMutationBatchMetadata,
   saveBundle
 } from '../local/local_store_impl';
+import { DocumentKey } from '../model/path';
 
 const LOG_TAG = 'SyncEngine';
 

packages/firestore/src/core/target.ts

@@ -15,8 +15,7 @@
  * limitations under the License.
  */
 
-import { DocumentKey } from '../model/document_key';
-import { FieldPath, ResourcePath } from '../model/path';
+import { DocumentKey, FieldPath, ResourcePath } from '../model/path';
 import { isNullOrUndefined } from '../util/types';
 import { debugAssert, debugCast, fail } from '../util/assert';
 import { Value as ProtoValue } from '../protos/firestore_proto_api';

packages/firestore/src/core/transaction.ts

@@ -18,7 +18,6 @@
 import { ParsedSetData, ParsedUpdateData } from '../api/user_data_reader';
 import { Document, MaybeDocument, NoDocument } from '../model/document';
 
-import { DocumentKey } from '../model/document_key';
 import {
   DeleteMutation,
   Mutation,
@@ -33,6 +32,7 @@ import {
 import { fail, debugAssert } from '../util/assert';
 import { Code, FirestoreError } from '../util/error';
 import { SnapshotVersion } from './snapshot_version';
+import { DocumentKey } from '../model/path';
 
 /**
  * Internal transaction object responsible for accumulating the mutations to

packages/firestore/src/core/view.ts

@@ -21,7 +21,6 @@ import {
   MaybeDocumentMap
 } from '../model/collections';
 import { Document, MaybeDocument } from '../model/document';
-import { DocumentKey } from '../model/document_key';
 import { DocumentSet } from '../model/document_set';
 import { TargetChange } from '../remote/remote_event';
 import { debugAssert, fail } from '../util/assert';
@@ -41,6 +40,7 @@ import {
   ViewSnapshot
 } from './view_snapshot';
 import { QueryResult } from '../local/local_store_impl';
+import { DocumentKey } from '../model/path';
 
 export type LimboDocumentChange = AddedLimboDocument | RemovedLimboDocument;
 export class AddedLimboDocument {

packages/firestore/src/core/view_snapshot.ts

@@ -16,13 +16,13 @@
  */
 
 import { Document } from '../model/document';
-import { DocumentKey } from '../model/document_key';
 import { DocumentSet } from '../model/document_set';
 import { fail } from '../util/assert';
 import { SortedMap } from '../util/sorted_map';
 
 import { DocumentKeySet } from '../model/collections';
 import { Query, queryEquals } from './query';
+import { DocumentKey } from '../model/path';
 
 export const enum ChangeType {
   Added,

packages/firestore/src/local/indexeddb_lru_delegate_impl.ts

@@ -15,7 +15,6 @@
  * limitations under the License.
  */
 
-import { DocumentKey } from '../model/document_key';
 import { ListenSequenceNumber, TargetId } from '../core/types';
 import { DbTargetDocument } from './indexeddb_schema';
 import {
@@ -40,6 +39,7 @@ import { TargetData } from './target_data';
 import { mutationQueuesContainKey } from './indexeddb_mutation_queue';
 import { ListenSequence } from '../core/listen_sequence';
 import { IndexedDbLruDelegate } from './indexeddb_lru_delegate';
+import { DocumentKey } from '../model/path';
 
 /** Provides LRU functionality for IndexedDB persistence. */
 export class IndexedDbLruDelegateImpl implements IndexedDbLruDelegate {

packages/firestore/src/local/indexeddb_mutation_queue.ts

@@ -20,10 +20,9 @@ import { User } from '../auth/user';
 import { isCollectionGroupQuery, isDocumentQuery, Query } from '../core/query';
 import { BatchId } from '../core/types';
 import { DocumentKeySet } from '../model/collections';
-import { DocumentKey } from '../model/document_key';
 import { Mutation } from '../model/mutation';
 import { BATCHID_UNKNOWN, MutationBatch } from '../model/mutation_batch';
-import { ResourcePath } from '../model/path';
+import { DocumentKey, ResourcePath } from '../model/path';
 import { debugAssert, fail, hardAssert } from '../util/assert';
 import { primitiveComparator } from '../util/misc';
 import { SortedMap } from '../util/sorted_map';
@@ -36,7 +35,8 @@ import {
   DbMutationBatch,
   DbMutationBatchKey,
   DbMutationQueue,
-  DbMutationQueueKey
+  DbMutationQueueKey,
+  removeMutationBatch
 } from './indexeddb_schema';
 import {
   fromDbMutationBatch,
@@ -46,7 +46,7 @@ import {
 import { MutationQueue } from './mutation_queue';
 import { ReferenceDelegate } from './persistence';
 import { PersistencePromise } from './persistence_promise';
-import { SimpleDbStore, SimpleDbTransaction } from './simple_db';
+import { SimpleDbStore } from './simple_db';
 import { PersistenceTransaction } from './persistence_transaction';
 import { IndexedDbTransaction } from './indexeddb_transaction';
 
@@ -613,54 +613,6 @@ export function mutationQueuesContainKey(
     .next(() => found);
 }
 
-/**
- * Delete a mutation batch and the associated document mutations.
- * @returns A PersistencePromise of the document mutations that were removed.
- */
-export function removeMutationBatch(
-  txn: SimpleDbTransaction,
-  userId: string,
-  batch: MutationBatch
-): PersistencePromise<DocumentKey[]> {
-  const mutationStore = txn.store<DbMutationBatchKey, DbMutationBatch>(
-    DbMutationBatch.store
-  );
-  const indexTxn = txn.store<DbDocumentMutationKey, DbDocumentMutation>(
-    DbDocumentMutation.store
-  );
-  const promises: Array<PersistencePromise<void>> = [];
-
-  const range = IDBKeyRange.only(batch.batchId);
-  let numDeleted = 0;
-  const removePromise = mutationStore.iterate(
-    { range },
-    (key, value, control) => {
-      numDeleted++;
-      return control.delete();
-    }
-  );
-  promises.push(
-    removePromise.next(() => {
-      hardAssert(
-        numDeleted === 1,
-        'Dangling document-mutation reference found: Missing batch ' +
-          batch.batchId
-      );
-    })
-  );
-  const removedDocuments: DocumentKey[] = [];
-  for (const mutation of batch.mutations) {
-    const indexKey = DbDocumentMutation.key(
-      userId,
-      mutation.key.path,
-      batch.batchId
-    );
-    promises.push(indexTxn.delete(indexKey));
-    removedDocuments.push(mutation.key);
-  }
-  return PersistencePromise.waitFor(promises).next(() => removedDocuments);
-}
-
 /**
  * Helper to get a typed SimpleDbStore for the mutations object store.
  */

packages/firestore/src/local/indexeddb_remote_document_cache.ts

@@ -28,16 +28,15 @@ import {
   NullableMaybeDocumentMap
 } from '../model/collections';
 import { Document, MaybeDocument, NoDocument } from '../model/document';
-import { DocumentKey } from '../model/document_key';
-import { ResourcePath } from '../model/path';
+import { DocumentKey, ResourcePath } from '../model/path';
 import { primitiveComparator } from '../util/misc';
 import { SortedMap } from '../util/sorted_map';
 import { SortedSet } from '../util/sorted_set';
-
 import { SnapshotVersion } from '../core/snapshot_version';
-import { debugAssert, debugCast, fail, hardAssert } from '../util/assert';
+import { debugAssert, debugCast, hardAssert } from '../util/assert';
 import { IndexManager } from './index_manager';
 import {
+  dbDocumentSize,
   DbRemoteDocument,
   DbRemoteDocumentGlobal,
   DbRemoteDocumentGlobalKey,
@@ -601,20 +600,3 @@ function remoteDocumentsStore(
 function dbKey(docKey: DocumentKey): DbRemoteDocumentKey {
   return docKey.path.toArray();
 }
-
-/**
- * Retrusn an approximate size for the given document.
- */
-export function dbDocumentSize(doc: DbRemoteDocument): number {
-  let value: unknown;
-  if (doc.document) {
-    value = doc.document;
-  } else if (doc.unknownDocument) {
-    value = doc.unknownDocument;
-  } else if (doc.noDocument) {
-    value = doc.noDocument;
-  } else {
-    throw fail('Unknown remote document type');
-  }
-  return JSON.stringify(value).length;
-}