Fix circular deps

Author: MarkDuckworth

common/api-review/firestore.api.md

@@ -1076,7 +1076,7 @@ export class Firestore {
     // Warning: (ae-incompatible-release-tags) The symbol "pipeline" is marked as @public, but its signature references "PipelineSource" which is marked as @beta
     //
     // (undocumented)
-    pipeline: () => PipelineSource | undefined;
+    pipeline: () => PipelineSource;
     toJSON(): object;
     type: 'firestore-lite' | 'firestore';
 }
@@ -1815,7 +1815,6 @@ export type PersistentTabManager = PersistentSingleTabManager | PersistentMultip
 
 // @beta
 export class Pipeline<AppModelType = DocumentData> {
-    constructor(db: Firestore, stages: Stage[], converter?: unknown);
     addFields(...fields: Selectable[]): Pipeline<AppModelType>;
     aggregate(...accumulators: AccumulatorTarget[]): Pipeline<AppModelType>;
     aggregate(options: {
@@ -1854,7 +1853,6 @@ export class PipelineResult<AppModelType = DocumentData> {
 
 // @beta
 export class PipelineSource {
-    constructor(db: Firestore);
     // (undocumented)
     collection(collectionPath: string): Pipeline;
     // (undocumented)
@@ -1863,7 +1861,7 @@ export class PipelineSource {
     database(): Pipeline;
     // (undocumented)
     documents(docs: DocumentReference[]): Pipeline;
-}
+    }
 
 // @public
 export type Primitive = string | number | boolean | undefined | null;

packages/firestore/src/api/aggregate.ts

@@ -25,7 +25,7 @@ import { cast } from '../util/input_validation';
 import { mapToArray } from '../util/obj';
 
 import { ensureFirestoreConfigured, Firestore } from './database';
-import { ExpUserDataWriter } from './reference_impl';
+import { ExpUserDataWriter } from './user_data_writer';
 
 export {
   aggregateQuerySnapshotEqual,

packages/firestore/src/api/database.ts

@@ -46,13 +46,16 @@ import {
   connectFirestoreEmulator,
   Firestore as LiteFirestore
 } from '../lite-api/database';
-import { Query } from '../lite-api/reference';
+import { DocumentReference, Query } from '../lite-api/reference';
+import { newUserDataReader } from '../lite-api/user_data_reader';
 import {
   indexedDbClearPersistence,
   indexedDbStoragePrefix
 } from '../local/indexeddb_persistence';
 import { LRU_COLLECTION_DISABLED } from '../local/lru_garbage_collector';
 import { LRU_MINIMUM_CACHE_SIZE_BYTES } from '../local/lru_garbage_collector_impl';
+import { DocumentKey } from '../model/document_key';
+import { PipelineSource } from '../pipelines/api/pipeline-source';
 import { debugAssert } from '../util/assert';
 import { AsyncQueue } from '../util/async_queue';
 import { AsyncQueueImpl } from '../util/async_queue_impl';
@@ -64,7 +67,7 @@ import { Deferred } from '../util/promise';
 import { LoadBundleTask } from './bundle';
 import { CredentialsProvider } from './credentials';
 import { FirestoreSettings, PersistenceSettings } from './settings';
-import type {PipelineSource} from "../pipelines/api/pipeline-source";
+import { ExpUserDataWriter } from './user_data_writer';
 
 export {
   connectFirestoreEmulator,
@@ -105,9 +108,18 @@ export class Firestore extends LiteFirestore {
     _online: OnlineComponentProviderFactory;
   };
 
-  pipeline = function(): PipelineSource {
-    return new PipelineSource(this);
-  }
+  pipeline = (): PipelineSource => {
+    const client = ensureFirestoreConfigured(this);
+    const firestore = this;
+    return new PipelineSource(
+      client,
+      newUserDataReader(firestore),
+      new ExpUserDataWriter(firestore),
+      (key: DocumentKey) => {
+        return new DocumentReference(firestore, null, key);
+      }
+    );
+  };
 
   /** @hideconstructor */
   constructor(

packages/firestore/src/api/reference_impl.ts

@@ -36,7 +36,6 @@ import {
 } from '../core/firestore_client';
 import { newQueryForPath, Query as InternalQuery } from '../core/query';
 import { ViewSnapshot } from '../core/view_snapshot';
-import { Bytes } from '../lite-api/bytes';
 import { FieldPath } from '../lite-api/field_path';
 import { validateHasExplicitOrderByForLimitToLast } from '../lite-api/query';
 import {
@@ -58,15 +57,14 @@ import {
   parseUpdateData,
   parseUpdateVarargs
 } from '../lite-api/user_data_reader';
-import { AbstractUserDataWriter } from '../lite-api/user_data_writer';
 import { DeleteMutation, Mutation, Precondition } from '../model/mutation';
 import { debugAssert } from '../util/assert';
-import { ByteString } from '../util/byte_string';
 import { FirestoreError } from '../util/error';
 import { cast } from '../util/input_validation';
 
 import { ensureFirestoreConfigured, Firestore } from './database';
 import { DocumentSnapshot, QuerySnapshot, SnapshotMetadata } from './snapshot';
+import { ExpUserDataWriter } from './user_data_writer';
 
 /**
  * An options object that can be passed to {@link (onSnapshot:1)} and {@link
@@ -123,21 +121,6 @@ export function getDoc<AppModelType, DbModelType extends DocumentData>(
   ).then(snapshot => convertToDocSnapshot(firestore, reference, snapshot));
 }
 
-export class ExpUserDataWriter extends AbstractUserDataWriter {
-  constructor(protected firestore: Firestore) {
-    super();
-  }
-
-  protected convertBytes(bytes: ByteString): Bytes {
-    return new Bytes(bytes);
-  }
-
-  protected convertReference(name: string): DocumentReference {
-    const key = this.convertDocumentKey(name, this.firestore._databaseId);
-    return new DocumentReference(this.firestore, /* converter= */ null, key);
-  }
-}
-
 /**
  * Reads the document referred to by this `DocumentReference` from cache.
  * Returns an error if the document is not currently cached.

packages/firestore/src/api/transaction.ts

@@ -28,9 +28,9 @@ import { validateReference } from '../lite-api/write_batch';
 import { cast } from '../util/input_validation';
 
 import { ensureFirestoreConfigured, Firestore } from './database';
-import { ExpUserDataWriter } from './reference_impl';
 import { DocumentSnapshot, SnapshotMetadata } from './snapshot';
 import { TransactionOptions } from './transaction_options';
+import { ExpUserDataWriter } from './user_data_writer';
 
 /**
  * A reference to a transaction.

packages/firestore/src/api/user_data_writer.ts

@@ -0,0 +1,21 @@
+import { Bytes } from '../lite-api/bytes';
+import { DocumentReference } from '../lite-api/reference';
+import { AbstractUserDataWriter } from '../lite-api/user_data_writer';
+import { ByteString } from '../util/byte_string';
+
+import { Firestore } from './database';
+
+export class ExpUserDataWriter extends AbstractUserDataWriter {
+  constructor(protected firestore: Firestore) {
+    super();
+  }
+
+  protected convertBytes(bytes: ByteString): Bytes {
+    return new Bytes(bytes);
+  }
+
+  protected convertReference(name: string): DocumentReference {
+    const key = this.convertDocumentKey(name, this.firestore._databaseId);
+    return new DocumentReference(this.firestore, /* converter= */ null, key);
+  }
+}

packages/firestore/src/model/aggregate_result_value.ts

@@ -0,0 +1,42 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import {
+  MapValue as ProtoMapValue,
+  Value as ProtoValue
+} from '../protos/firestore_proto_api';
+
+import { valueEquals } from './values';
+
+/**
+ * An AggregateResultValue represents a MapValue in the Firestore Proto.
+ */
+export class AggregateResultValue {
+  constructor(readonly value: { mapValue: ProtoMapValue }) {}
+
+  static empty(): AggregateResultValue {
+    return new AggregateResultValue({ mapValue: {} });
+  }
+
+  aggregate(alias: string): ProtoValue | null {
+    return this.value.mapValue.fields?.[alias] ?? null;
+  }
+
+  isEqual(other: AggregateResultValue): boolean {
+    return valueEquals(this.value, other.value);
+  }
+}

packages/firestore/src/pipelines/api/expressions.ts

@@ -2412,7 +2412,10 @@ export class ArrayReverse extends FirestoreFunction {
 /**
  * @beta
  */
-export class ArrayContains extends FirestoreFunction implements FilterCondition {
+export class ArrayContains
+  extends FirestoreFunction
+  implements FilterCondition
+{
   constructor(private array: Expr, private element: Expr) {
     super('array_contains', [array, element]);
   }
@@ -2422,7 +2425,10 @@ export class ArrayContains extends FirestoreFunction implements FilterCondition
 /**
  * @beta
  */
-export class ArrayContainsAll extends FirestoreFunction implements FilterCondition {
+export class ArrayContainsAll
+  extends FirestoreFunction
+  implements FilterCondition
+{
   constructor(private array: Expr, private values: Expr[]) {
     super('array_contains_all', [array, new ListOfExprs(values)]);
   }
@@ -2432,7 +2438,10 @@ export class ArrayContainsAll extends FirestoreFunction implements FilterConditi
 /**
  * @beta
  */
-export class ArrayContainsAny extends FirestoreFunction implements FilterCondition {
+export class ArrayContainsAny
+  extends FirestoreFunction
+  implements FilterCondition
+{
   constructor(private array: Expr, private values: Expr[]) {
     super('array_contains_any', [array, new ListOfExprs(values)]);
   }
@@ -2618,7 +2627,10 @@ export class Like extends FirestoreFunction implements FilterCondition {
 /**
  * @beta
  */
-export class RegexContains extends FirestoreFunction implements FilterCondition {
+export class RegexContains
+  extends FirestoreFunction
+  implements FilterCondition
+{
   constructor(private expr: Expr, private pattern: Expr) {
     super('regex_contains', [expr, pattern]);
   }
@@ -6642,7 +6654,10 @@ export function timestampSub(
  * @param params The arguments to pass to the function.
  * @return A new {@code Function} representing the function call.
  */
-export function genericFunction(name: string, params: Expr[]): FirestoreFunction {
+export function genericFunction(
+  name: string,
+  params: Expr[]
+): FirestoreFunction {
   return new FirestoreFunction(name, params);
 }
 

packages/firestore/src/pipelines/api/pipeline-source.ts

@@ -12,6 +12,12 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+import { FirestoreClient } from '../../core/firestore_client';
+import { DocumentReference } from '../../lite-api/reference';
+import { UserDataReader } from '../../lite-api/user_data_reader';
+import { AbstractUserDataWriter } from '../../lite-api/user_data_writer';
+import { DocumentKey } from '../../model/document_key';
+
 import { Pipeline } from './pipeline';
 import {
   CollectionGroupSource,
@@ -20,29 +26,63 @@ import {
   DocumentsSource
 } from './stage';
 
-import { Firestore } from '../../api/database';
-import { DocumentReference } from '../../lite-api/reference';
-
 /**
  * Represents the source of a Firestore {@link Pipeline}.
  * @beta
  */
 export class PipelineSource {
-  constructor(private db: Firestore) {}
+  /**
+   * @internal
+   * @private
+   * @param db
+   * @param userDataReader
+   * @param userDataWriter
+   * @param documentReferenceFactory
+   */
+  constructor(
+    private db: FirestoreClient,
+    private userDataReader: UserDataReader,
+    private userDataWriter: AbstractUserDataWriter,
+    private documentReferenceFactory: (id: DocumentKey) => DocumentReference
+  ) {}
 
   collection(collectionPath: string): Pipeline {
-    return new Pipeline(this.db, [new CollectionSource(collectionPath)]);
+    return new Pipeline(
+      this.db,
+      this.userDataReader,
+      this.userDataWriter,
+      this.documentReferenceFactory,
+      [new CollectionSource(collectionPath)]
+    );
   }
 
   collectionGroup(collectionId: string): Pipeline {
-    return new Pipeline(this.db, [new CollectionGroupSource(collectionId)]);
+    return new Pipeline(
+      this.db,
+      this.userDataReader,
+      this.userDataWriter,
+      this.documentReferenceFactory,
+      [new CollectionGroupSource(collectionId)]
+    );
   }
 
   database(): Pipeline {
-    return new Pipeline(this.db, [new DatabaseSource()]);
+    return new Pipeline(
+      this.db,
+      this.userDataReader,
+      this.userDataWriter,
+      this.documentReferenceFactory,
+      [new DatabaseSource()]
+    );
   }
 
   documents(docs: DocumentReference[]): Pipeline {
-    return new Pipeline(this.db, [DocumentsSource.of(docs)]);
+    return new Pipeline(
+      this.db,
+      this.userDataReader,
+      this.userDataWriter,
+      this.documentReferenceFactory,
+      [DocumentsSource.of(docs)]
+    );
   }
 }

packages/firestore/src/pipelines/api/pipeline-util.ts

@@ -12,7 +12,6 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-
 import {
   CompositeFilter as CompositeFilterInternal,
   CompositeOperator,