add api/pipelinesource and setup basic listen test

Author: wu-hui

packages/firestore/.idea/runConfigurations/Integration_Tests__Emulator_w__Mock_Persistence_.xml

@@ -46,7 +46,7 @@ import {
   connectFirestoreEmulator,
   Firestore as LiteFirestore
 } from '../lite-api/database';
-import { PipelineSource } from '../lite-api/pipeline-source';
+import { PipelineSource } from './pipeline_source';
 import { DocumentReference, Query } from '../lite-api/reference';
 import { newUserDataReader } from '../lite-api/user_data_reader';
 import {

packages/firestore/src/api/database.ts

@@ -5,7 +5,7 @@ import {
 import { Pipeline as LitePipeline } from '../lite-api/pipeline';
 import { PipelineResult } from '../lite-api/pipeline-result';
 import { DocumentData, DocumentReference } from '../lite-api/reference';
-import { AddFields, Stage } from '../lite-api/stage';
+import {AddFields, Sort, Stage, Where} from '../lite-api/stage';
 import { UserDataReader } from '../lite-api/user_data_reader';
 import { AbstractUserDataWriter } from '../lite-api/user_data_writer';
 import { DocumentKey } from '../model/document_key';
@@ -15,6 +15,8 @@ import { DocumentSnapshot, PipelineSnapshot } from './snapshot';
 import { FirestoreError } from '../util/error';
 import { Unsubscribe } from './reference_impl';
 import { cast } from '../util/input_validation';
+import {Field, FilterCondition} from '../api';
+import {Expr} from '../lite-api/expressions';
 
 export class Pipeline<
   AppModelType = DocumentData
@@ -49,6 +51,20 @@ export class Pipeline<
     );
   }
 
+  where(condition: FilterCondition & Expr): Pipeline<AppModelType> {
+    const copy = this.stages.map(s => s);
+    super.readUserData('where', condition);
+    copy.push(new Where(condition));
+    return new Pipeline(
+      this.db,
+      this.userDataReader,
+      this.userDataWriter,
+      this.documentReferenceFactory,
+      copy,
+      this.converter
+    );
+  }
+
   /**
    * Executes this pipeline and returns a Promise to represent the asynchronous operation.
    *
@@ -106,23 +122,30 @@ export class Pipeline<
    * @internal
    * @private
    */
-  _onSnapshot(observer: {
-    next?: (snapshot: PipelineSnapshot) => void;
-    error?: (error: FirestoreError) => void;
-    complete?: () => void;
-  }): Unsubscribe {
+  _onSnapshot(
+    next: (snapshot: PipelineSnapshot) => void,
+    error?: (error: FirestoreError) => void,
+    complete?: () => void
+  ): Unsubscribe {
+    // this.stages.push(
+    //   new AddFields(
+    //     this.selectablesToMap([
+    //       '__name__',
+    //       '__create_time__',
+    //       '__update_time__'
+    //     ])
+    //   )
+    // );
+
     this.stages.push(
-      new AddFields(
-        this.selectablesToMap([
-          '__name__',
-          '__create_time__',
-          '__update_time__'
-        ])
+      new Sort([
+        Field.of('__name__').ascending()
+        ]
       )
     );
 
     const client = ensureFirestoreConfigured(this.db);
-    firestoreClientListenPipeline(client, this, observer);
+    firestoreClientListenPipeline(client, this, {next, error, complete});
 
     return () => {};
   }

packages/firestore/src/api/pipeline.ts

@@ -0,0 +1,91 @@
+// 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 { DocumentKey } from '../model/document_key';
+
+import { Firestore } from './database';
+import { Pipeline } from './pipeline';
+import { DocumentReference } from './reference';
+import {
+  CollectionGroupSource,
+  CollectionSource,
+  DatabaseSource,
+  DocumentsSource
+} from '../lite-api/stage';
+import {PipelineSource as LitePipelineSource} from '../lite-api/pipeline-source';
+import { UserDataReader } from '../lite-api/user_data_reader';
+import { AbstractUserDataWriter } from '../lite-api/user_data_writer';
+
+/**
+ * Represents the source of a Firestore {@link Pipeline}.
+ * @beta
+ */
+export class PipelineSource extends LitePipelineSource{
+  /**
+   * @internal
+   * @private
+   * @param db
+   * @param userDataReader
+   * @param userDataWriter
+   * @param documentReferenceFactory
+   */
+  constructor(
+    db: Firestore,
+    userDataReader: UserDataReader,
+    userDataWriter: AbstractUserDataWriter,
+    documentReferenceFactory: (id: DocumentKey) => DocumentReference
+  ) {
+    super(db, userDataReader, userDataWriter, documentReferenceFactory);
+  }
+
+  collection(collectionPath: string): Pipeline {
+    return new Pipeline(
+      this.db as Firestore,
+      this.userDataReader,
+      this.userDataWriter,
+      this.documentReferenceFactory,
+      [new CollectionSource(collectionPath)]
+    );
+  }
+
+  collectionGroup(collectionId: string): Pipeline {
+    return new Pipeline(
+      this.db as Firestore,
+      this.userDataReader,
+      this.userDataWriter,
+      this.documentReferenceFactory,
+      [new CollectionGroupSource(collectionId)]
+    );
+  }
+
+  database(): Pipeline {
+    return new Pipeline(
+      this.db as Firestore,
+      this.userDataReader,
+      this.userDataWriter,
+      this.documentReferenceFactory,
+      [new DatabaseSource()]
+    );
+  }
+
+  documents(docs: DocumentReference[]): Pipeline {
+    return new Pipeline(
+      this.db as Firestore,
+      this.userDataReader,
+      this.userDataWriter,
+      this.documentReferenceFactory,
+      [DocumentsSource.of(docs)]
+    );
+  }
+}

packages/firestore/src/api/pipeline_source.ts

@@ -999,6 +999,11 @@ function removeAndCleanupTarget(
 ): void {
   syncEngineImpl.sharedClientState.removeLocalQueryTarget(targetId);
 
+  // TODO(pipeline): REMOVE this hack.
+  if(!syncEngineImpl.queriesByTarget.has(targetId)||syncEngineImpl.queriesByTarget.get(targetId)!.length !== 0){
+    return;
+  }
+
   debugAssert(
     syncEngineImpl.queriesByTarget.has(targetId) &&
       syncEngineImpl.queriesByTarget.get(targetId)!.length !== 0,

packages/firestore/src/core/sync_engine_impl.ts

@@ -40,10 +40,10 @@ export class PipelineSource {
    * @param documentReferenceFactory
    */
   constructor(
-    private db: Firestore,
-    private userDataReader: UserDataReader,
-    private userDataWriter: AbstractUserDataWriter,
-    private documentReferenceFactory: (id: DocumentKey) => DocumentReference
+    protected db: Firestore,
+    protected userDataReader: UserDataReader,
+    protected userDataWriter: AbstractUserDataWriter,
+    protected documentReferenceFactory: (id: DocumentKey) => DocumentReference
   ) {}
 
   collection(collectionPath: string): Pipeline {

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

@@ -130,7 +130,7 @@ export class Pipeline<AppModelType = DocumentData> implements ProtoSerializable<
    */
   constructor(
     private liteDb: Firestore,
-    private userDataReader: UserDataReader,
+    protected userDataReader: UserDataReader,
     /**
      * @internal
      * @private
@@ -144,7 +144,7 @@ export class Pipeline<AppModelType = DocumentData> implements ProtoSerializable<
     protected stages: Stage[],
     // TODO(pipeline) support converter
     //private converter:  FirestorePipelineConverter<AppModelType> = defaultPipelineConverter()
-    private converter: unknown = {}
+    protected converter: unknown = {}
   ) {}
 
   /**
@@ -265,7 +265,7 @@ export class Pipeline<AppModelType = DocumentData> implements ProtoSerializable<
    * @return the expressionMap argument.
    * @private
    */
-  private readUserData<
+  protected readUserData<
     T extends
       | Map<string, ReadableUserData>
       | ReadableUserData[]

packages/firestore/src/lite-api/pipeline.ts

@@ -1050,6 +1050,13 @@ export async function localStoreReleaseTarget(
 ): Promise<void> {
   const localStoreImpl = debugCast(localStore, LocalStoreImpl);
   const targetData = localStoreImpl.targetDataByTarget.get(targetId);
+
+  // TODO(pipeline): this is a hack that only works because pipelines are the only ones returning nulls here.
+  // REMOVE ASAP.
+  if(targetData === null) {
+    return;
+  }
+
   debugAssert(
     targetData !== null,
     `Tried to release nonexistent target: ${targetId}`