And/or overloads. Pipeline serialization for console.

Author: MarkDuckworth

common/api-review/firestore.api.md

@@ -100,11 +100,15 @@ export class And extends FirestoreFunction implements FilterCondition {
     filterable: true;
 }
 
+// @beta
+export function and(left: FilterExpr, ...right: FilterExpr[]): And;
+
 // @public
 export function and(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;
 
-// @beta
-export function andExpression(left: FilterExpr, ...right: FilterExpr[]): And;
+// @public (undocumented)
+export namespace and {
+}
 
 // @beta (undocumented)
 export class ArrayConcat extends FirestoreFunction {
@@ -1738,9 +1742,16 @@ export class Or extends FirestoreFunction implements FilterCondition {
     filterable: true;
 }
 
+// @beta
+export function or(left: FilterExpr, ...right: FilterExpr[]): Or;
+
 // @public
 export function or(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;
 
+// @public (undocumented)
+export namespace or {
+}
+
 // @public
 export function orderBy(fieldPath: string | FieldPath, directionStr?: OrderByDirection): QueryOrderByConstraint;
 
@@ -1752,9 +1763,6 @@ export class Ordering {
     constructor(expr: Constant, direction: 'ascending' | 'descending');
     }
 
-// @beta
-export function orExpression(left: FilterExpr, ...right: FilterExpr[]): Or;
-
 // @public
 export type PartialWithFieldValue<T> = Partial<T> | (T extends Primitive ? T : T extends {} ? {
     [K in keyof T]?: PartialWithFieldValue<T[K]> | FieldValue;
@@ -2466,8 +2474,8 @@ export function xor(left: FilterExpr, ...right: FilterExpr[]): Xor;
 
 // Warnings were encountered during analysis:
 //
-// /home/runner/work/firebase-js-sdk/firebase-js-sdk/packages/firestore/dist/index.d.ts:10111:9 - (ae-incompatible-release-tags) The symbol "accumulators" is marked as @public, but its signature references "AccumulatorTarget" which is marked as @beta
-// /home/runner/work/firebase-js-sdk/firebase-js-sdk/packages/firestore/dist/index.d.ts:10112:9 - (ae-incompatible-release-tags) The symbol "groups" is marked as @public, but its signature references "Selectable" which is marked as @beta
-// /home/runner/work/firebase-js-sdk/firebase-js-sdk/packages/firestore/dist/index.d.ts:10141:9 - (ae-incompatible-release-tags) The symbol "orderings" is marked as @public, but its signature references "Ordering" which is marked as @beta
+// /Users/markduckworth/projects/firebase-js-sdk/packages/firestore/dist/index.d.ts:10115:9 - (ae-incompatible-release-tags) The symbol "accumulators" is marked as @public, but its signature references "AccumulatorTarget" which is marked as @beta
+// /Users/markduckworth/projects/firebase-js-sdk/packages/firestore/dist/index.d.ts:10116:9 - (ae-incompatible-release-tags) The symbol "groups" is marked as @public, but its signature references "Selectable" which is marked as @beta
+// /Users/markduckworth/projects/firebase-js-sdk/packages/firestore/dist/index.d.ts:10145:9 - (ae-incompatible-release-tags) The symbol "orderings" is marked as @public, but its signature references "Ordering" which is marked as @beta
 
 ```

packages/firestore/src/api.ts

@@ -61,8 +61,6 @@ export {
   arrayLength,
   inAny,
   notInAny,
-  and as andExpression,
-  or as orExpression,
   xor,
   ifFunction,
   not,
@@ -183,6 +181,8 @@ export {
   Accumulator
 } from './lite-api/expressions';
 
+export { and, or } from './lite-api/overloads';
+
 export {
   aggregateFieldEqual,
   aggregateQuerySnapshotEqual,
@@ -282,12 +282,10 @@ export {
 } from './api/reference';
 
 export {
-  and,
   endAt,
   endBefore,
   limit,
   limitToLast,
-  or,
   orderBy,
   OrderByDirection,
   query,
@@ -392,7 +390,8 @@ export { isBase64Available as _isBase64Available } from './platform/base64';
 export { DatabaseId as _DatabaseId } from './core/database_info';
 export {
   _internalQueryToProtoQueryTarget,
-  _internalAggregationQueryToProtoRunAggregationQueryRequest
+  _internalAggregationQueryToProtoRunAggregationQueryRequest,
+  _internalPipelineToExecutePipelineRequestProto
 } from './remote/internal_serializer';
 export {
   cast as _cast,

packages/firestore/src/api/database.ts

@@ -46,6 +46,7 @@ import {
   connectFirestoreEmulator,
   Firestore as LiteFirestore
 } from '../lite-api/database';
+import type { PipelineSource } from '../lite-api/pipeline-source';
 import { Query } from '../lite-api/reference';
 import {
   indexedDbClearPersistence,
@@ -128,17 +129,16 @@ export class Firestore extends LiteFirestore {
       await terminate;
     }
   }
-}
 
-// Undocumented method of Firestore. This is only
-// in place to give developers a runtime error suggesting
-// how to correctly initialize Firestore for use with Pipelines.
-// @ts-ignore
-Firestore.prototype.pipeline = function (): unknown {
-  throw new Error(
-    'Pipelines not initialized. Your application must call `useFirestorePipelines()` before using Firestore Pipeline features.'
-  );
-};
+  /**
+   * Pipeline query.
+   */
+  pipeline(): PipelineSource {
+    throw new Error(
+      'Pipelines not initialized. Your application must call `useFirestorePipelines()` before using Firestore Pipeline features.'
+    );
+  }
+}
 
 /**
  * Initializes a new instance of {@link Firestore} with the provided settings.

packages/firestore/src/api/database_augmentation.ts

@@ -1,3 +1,5 @@
+import { And, FilterExpr, Or } from '../lite-api/expressions';
+import { and, or } from '../lite-api/overloads';
 import { Pipeline } from '../lite-api/pipeline';
 import { PipelineSource } from '../lite-api/pipeline-source';
 import { newUserDataReader } from '../lite-api/user_data_reader';
@@ -37,4 +39,12 @@ export function useFirestorePipelines(): void {
 
     return pipeline;
   };
+
+  and._andFunction = function (left: FilterExpr, ...right: FilterExpr[]): And {
+    return new And([left, ...right]);
+  };
+
+  or._orFunction = function (left: FilterExpr, ...right: FilterExpr[]): Or {
+    return new Or([left, ...right]);
+  };
 }

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

@@ -4517,44 +4517,6 @@ export function notInAny(element: Expr | string, others: any[]): Not {
   return new Not(new In(elementExpr, exprOthers));
 }
 
-/**
- * @beta
- *
- * Creates an expression that performs a logical 'AND' operation on multiple filter conditions.
- *
- * ```typescript
- * // Check if the 'age' field is greater than 18 AND the 'city' field is "London" AND
- * // the 'status' field is "active"
- * const condition = and(gt("age", 18), eq("city", "London"), eq("status", "active"));
- * ```
- *
- * @param left The first filter condition.
- * @param right Additional filter conditions to 'AND' together.
- * @return A new {@code Expr} representing the logical 'AND' operation.
- */
-export function and(left: FilterExpr, ...right: FilterExpr[]): And {
-  return new And([left, ...right]);
-}
-
-/**
- * @beta
- *
- * Creates an expression that performs a logical 'OR' operation on multiple filter conditions.
- *
- * ```typescript
- * // Check if the 'age' field is greater than 18 OR the 'city' field is "London" OR
- * // the 'status' field is "active"
- * const condition = or(gt("age", 18), eq("city", "London"), eq("status", "active"));
- * ```
- *
- * @param left The first filter condition.
- * @param right Additional filter conditions to 'OR' together.
- * @return A new {@code Expr} representing the logical 'OR' operation.
- */
-export function or(left: FilterExpr, ...right: FilterExpr[]): Or {
-  return new Or([left, ...right]);
-}
-
 /**
  * @beta
  *

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

@@ -367,54 +367,6 @@ export type QueryFilterConstraint =
   | QueryFieldFilterConstraint
   | QueryCompositeFilterConstraint;
 
-/**
- * Creates a new {@link QueryCompositeFilterConstraint} that is a disjunction of
- * the given filter constraints. A disjunction filter includes a document if it
- * satisfies any of the given filters.
- *
- * @param queryConstraints - Optional. The list of
- * {@link QueryFilterConstraint}s to perform a disjunction for. These must be
- * created with calls to {@link where}, {@link or}, or {@link and}.
- * @returns The newly created {@link QueryCompositeFilterConstraint}.
- */
-export function or(
-  ...queryConstraints: QueryFilterConstraint[]
-): QueryCompositeFilterConstraint {
-  // Only support QueryFilterConstraints
-  queryConstraints.forEach(queryConstraint =>
-    validateQueryFilterConstraint('or', queryConstraint)
-  );
-
-  return QueryCompositeFilterConstraint._create(
-    CompositeOperator.OR,
-    queryConstraints as QueryFilterConstraint[]
-  );
-}
-
-/**
- * Creates a new {@link QueryCompositeFilterConstraint} that is a conjunction of
- * the given filter constraints. A conjunction filter includes a document if it
- * satisfies all of the given filters.
- *
- * @param queryConstraints - Optional. The list of
- * {@link QueryFilterConstraint}s to perform a conjunction for. These must be
- * created with calls to {@link where}, {@link or}, or {@link and}.
- * @returns The newly created {@link QueryCompositeFilterConstraint}.
- */
-export function and(
-  ...queryConstraints: QueryFilterConstraint[]
-): QueryCompositeFilterConstraint {
-  // Only support QueryFilterConstraints
-  queryConstraints.forEach(queryConstraint =>
-    validateQueryFilterConstraint('and', queryConstraint)
-  );
-
-  return QueryCompositeFilterConstraint._create(
-    CompositeOperator.AND,
-    queryConstraints as QueryFilterConstraint[]
-  );
-}
-
 /**
  * A `QueryOrderByConstraint` is used to sort the set of documents returned by a
  * Firestore query. `QueryOrderByConstraint`s are created by invoking

packages/firestore/src/remote/internal_serializer.ts

@@ -19,6 +19,7 @@ import { ensureFirestoreConfigured, Firestore } from '../api/database';
 import { AggregateImpl } from '../core/aggregate';
 import { queryToAggregateTarget, queryToTarget } from '../core/query';
 import { AggregateSpec } from '../lite-api/aggregate_types';
+import { Pipeline } from '../lite-api/pipeline';
 import { Query } from '../lite-api/reference';
 import { cast } from '../util/input_validation';
 import { mapToArray } from '../util/obj';
@@ -87,3 +88,28 @@ export function _internalAggregationQueryToProtoRunAggregationQueryRequest<
     /* skipAliasing= */ true
   ).request;
 }
+
+/**
+ * @internal
+ * @private
+ *
+ * This function is for internal use only.
+ *
+ * Returns the `ExecutePipelineRequest` representation of the given query.
+ * Returns `null` if the Firestore client associated with the given query has
+ * not been initialized or has been terminated.
+ *
+ * @param pipeline - The Pipeline to convert to proto representation.
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function _internalPipelineToExecutePipelineRequestProto(
+  pipeline: Pipeline
+): any {
+  const firestore = cast(pipeline._db, Firestore);
+  const client = ensureFirestoreConfigured(firestore);
+  const serializer = client._onlineComponents?.datastore.serializer;
+  if (serializer === undefined) {
+    return null;
+  }
+  return pipeline._toProto(serializer);
+}

packages/firestore/test/integration/api/pipeline.test.ts

@@ -18,8 +18,9 @@ import chaiAsPromised from 'chai-as-promised';
 import { addEqualityMatcher } from '../../util/equality_matcher';
 import { Deferred } from '../../util/promise';
 import {
+  _internalPipelineToExecutePipelineRequestProto,
   add,
-  andExpression,
+  and,
   arrayContains,
   arrayContainsAny,
   avg,
@@ -42,7 +43,7 @@ import {
   mapGet,
   neq,
   not,
-  orExpression,
+  or,
   PipelineResult,
   regexContains,
   regexMatch,
@@ -384,15 +385,15 @@ apiDescribe.only('Pipelines', persistence => {
   it('where with and', async () => {
     const results = await randomCol
       .pipeline()
-      .where(andExpression(gt('rating', 4.5), eq('genre', 'Science Fiction')))
+      .where(and(gt('rating', 4.5), eq('genre', 'Science Fiction')))
       .execute();
     expectResults(results, 'book10');
   });
 
   it('where with or', async () => {
     const results = await randomCol
       .pipeline()
-      .where(orExpression(eq('genre', 'Romance'), eq('genre', 'Dystopian')))
+      .where(or(eq('genre', 'Romance'), eq('genre', 'Dystopian')))
       .select('title')
       .execute();
     expectResults(
@@ -637,7 +638,7 @@ apiDescribe.only('Pipelines', persistence => {
     const results = await randomCol
       .pipeline()
       .where(
-        andExpression(
+        and(
           gt('rating', 4.2),
           lte(Field.of('rating'), 4.5),
           neq('genre', 'Science Fiction')
@@ -661,8 +662,8 @@ apiDescribe.only('Pipelines', persistence => {
     const results = await randomCol
       .pipeline()
       .where(
-        orExpression(
-          andExpression(gt('rating', 4.5), eq('genre', 'Science Fiction')),
+        or(
+          and(gt('rating', 4.5), eq('genre', 'Science Fiction')),
           lt('published', 1900)
         )
       )
@@ -793,6 +794,21 @@ apiDescribe.only('Pipelines', persistence => {
     );
   });
 
+  it('supports internal serialization to proto', async () => {
+    const pipeline = firestore
+      .pipeline()
+      .collection('books')
+      .where(eq('awards.hugo', true))
+      .select(
+        'title',
+        Field.of('nestedField.level.1'),
+        mapGet('nestedField', 'level.1').mapGet('level.2').as('nested')
+      );
+
+    const proto = _internalPipelineToExecutePipelineRequestProto(pipeline);
+    expect(proto).not.to.be.null;
+  });
+
   // TODO(pipeline) support converter
   // it('pipeline converter works', async () => {
   //   interface AppModel {myTitle: string; myAuthor: string; myPublished: number}