Query to pipeline conversion is performed from the PipelineSource class rather than the Query class

Author: MarkDuckworth

packages/firestore/src/api/pipeline_impl.ts

@@ -17,7 +17,6 @@
 
 import { Pipeline } from '../api/pipeline';
 import { firestoreClientExecutePipeline } from '../core/firestore_client';
-import { toPipeline } from '../core/pipeline-util';
 import { Pipeline as LitePipeline } from '../lite-api/pipeline';
 import { PipelineResult, PipelineSnapshot } from '../lite-api/pipeline-result';
 import { PipelineSource } from '../lite-api/pipeline-source';
@@ -26,7 +25,7 @@ import { newUserDataReader } from '../lite-api/user_data_reader';
 import { cast } from '../util/input_validation';
 
 import { ensureFirestoreConfigured, Firestore } from './database';
-import { DocumentReference, Query } from './reference';
+import { DocumentReference } from './reference';
 import { ExpUserDataWriter } from './user_data_writer';
 
 declare module './database' {
@@ -108,11 +107,3 @@ Firestore.prototype.pipeline = function (): PipelineSource<Pipeline> {
     );
   });
 };
-
-// Augment the Query class with the pipeline() factory method
-Query.prototype.pipeline = function (): Pipeline {
-  const db = cast<Firestore>(this.firestore, Firestore);
-
-  const litePipeline: LitePipeline = toPipeline(this._query, db);
-  return cast<Pipeline>(litePipeline, Pipeline);
-};

packages/firestore/src/core/pipeline-util.ts

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-import { Firestore } from '../api/database';
+import { Firestore } from '../lite-api/database';
 import {
   Constant,
   Field,

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

@@ -16,9 +16,11 @@
  */
 
 import { DatabaseId } from '../core/database_info';
+import { toPipeline } from '../core/pipeline-util';
 import { FirestoreError, Code } from '../util/error';
 
-import { CollectionReference, DocumentReference } from './reference';
+import { Pipeline } from './pipeline';
+import { CollectionReference, DocumentReference, Query } from './reference';
 import {
   CollectionGroupSource,
   CollectionSource,
@@ -105,6 +107,17 @@ export class PipelineSource<PipelineType> {
     return this._createPipeline([DocumentsSource.of(docs)]);
   }
 
+  /**
+   * Convert the given Query into an equivalent Pipeline.
+   *
+   * @param query A Query to be converted into a Pipeline.
+   *
+   * @throws {@FirestoreError} Thrown if any of the provided DocumentReferences target a different project or database than the pipeline.
+   */
+  createFrom(query: Query): Pipeline {
+    return toPipeline(query._query, query.firestore);
+  }
+
   _validateReference(reference: CollectionReference | DocumentReference): void {
     const refDbId = reference.firestore._databaseId;
     if (!refDbId.isEqual(this.databaseId)) {

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

@@ -22,7 +22,7 @@ import { Firestore } from './database';
 import { Pipeline } from './pipeline';
 import { PipelineResult, PipelineSnapshot } from './pipeline-result';
 import { PipelineSource } from './pipeline-source';
-import { DocumentReference, Query } from './reference';
+import { DocumentReference } from './reference';
 import { LiteUserDataWriter } from './reference_impl';
 import { Stage } from './stage';
 import { newUserDataReader } from './user_data_reader';
@@ -33,12 +33,6 @@ declare module './database' {
   }
 }
 
-declare module './reference' {
-  interface Query {
-    pipeline(): Pipeline;
-  }
-}
-
 /**
  * Executes this pipeline and returns a Promise to represent the asynchronous operation.
  *
@@ -107,22 +101,3 @@ Firestore.prototype.pipeline = function (): PipelineSource<Pipeline> {
     return new Pipeline(this, userDataReader, userDataWriter, stages);
   });
 };
-
-Query.prototype.pipeline = function (): Pipeline {
-  let pipeline;
-  const query = this;
-  if (query._query.collectionGroup) {
-    pipeline = query.firestore
-      .pipeline()
-      .collectionGroup(query._query.collectionGroup);
-  } else {
-    pipeline = query.firestore
-      .pipeline()
-      .collection(query._query.path.canonicalString());
-  }
-
-  // TODO(pipeline) convert existing query filters, limits, etc into
-  // pipeline stages
-
-  return pipeline;
-};