[2/4] Offline pipeline evaluation and tests #8908

wu-hui · 2025-04-08T22:08:05Z

No description provided.

changeset-bot · 2025-04-08T22:08:08Z

⚠️ No Changeset found

Latest commit: c9fce63

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

github-actions · 2025-04-08T22:08:20Z

Vertex AI Mock Responses Check ⚠️

A newer major version of the mock responses for Vertex AI unit tests is available. update_vertexai_responses.sh should be updated to clone the latest version of the responses: v8.0

MarkDuckworth · 2025-04-11T17:13:51Z

packages/firestore/src/api/realtime_pipeline.ts

+     */
+    public _userDataWriter: AbstractUserDataWriter,
+    readonly stages: Stage[],
+    readonly converter: unknown = {}


not critical, but we've been removing converter from the pipeline constructors.

MarkDuckworth · 2025-04-11T17:14:27Z

packages/firestore/src/api/realtime_pipeline.ts

+import { JsonProtoSerializer } from '../remote/serializer';
+
+/**
+ * Base-class implementation


We should update this comment before the release

Updated, but need some further polishment still.

MarkDuckworth · 2025-04-11T17:23:00Z

packages/firestore/src/api/realtime_pipeline.ts

+   * @param stages
+   * @param converter
+   */
+  newPipeline(


We can keep this pattern in RealtimePipeline, but it's not required. It was useful in Pipeline / LitePipeline. Could be replaced with a direct call to new RealtimePipeline() for simpler code

MarkDuckworth · 2025-04-11T18:13:49Z

packages/firestore/src/api/realtime_pipeline.ts

+        new Sort(
+          this.readUserData(
+            'sort',
+            this.readUserData('sort', optionsOrOrderings.orderings)


This might be a redundant call to readUserData

MarkDuckworth · 2025-04-11T18:25:51Z

packages/firestore/src/core/expressions.ts

+  AggregateFunction,
+  ListOfExprs,
+  isNan,
+  isError


I'm assuming these linter errors are false positives caused by the way the code was split. Either way, I'm sure we will have some formatting and linter fixes when merging to main.

Deleted those for now.

MarkDuckworth · 2025-04-11T18:30:08Z

packages/firestore/src/core/expressions.ts

+    } else if (functionExpr.name === 'timestamp_sub') {
+      return new CoreTimestampSub(functionExpr);
+    }
+  } else if (expr.exprType === 'AggregateFunction') {


Does this still work since AggregateFunction no longer extends Expr?

Let's remove them for now since we are not going to support anytime soon.

MarkDuckworth · 2025-04-11T20:46:43Z

packages/firestore/src/core/expressions.ts

+          return EvaluateResult.newError();
+        }
+      }
+    }


This pattern seems to be repeated often. I wonder if we can refactor this into some shared code to reduce code size

let result = {};
if (evaluateParams(expr.params, [['BOOLEAN']], result) {
// not successful
return result.errorResult; // either newError or newNull
}

// use evaluated params
result.evaluated[0]

I'd like to keep the current pattern, because:

That is how the pattern backend uses, so it would be easier to compare when we want to figure out semantics difference if any.

It might be more verbose, but I found it easy to read by being explicit.

MarkDuckworth · 2025-04-11T21:52:46Z

packages/firestore/src/core/expressions.ts

+    }
+
+    if (foundNullAtLeastOnce) {
+      return EvaluateResult.newNull();


Seems like you will not hit this case, the loop would have already returned

foundNull is the bookkeeper for the inner loop and foundNullAtLeastOnce is keeping track if we have seen any null value.

Consider [1,2,3].arrayContainsAll([null, 1, 2]), this would hit this if block and returns here.

This logic is pretty confusing because of the nested loop, and i do wonder if there is a better way to write this.

Once again, the structure is copied from backend impl, if we decide to change it we should convince backend to adopt the new style. So the new way needs to be significantly better than the current way.

MarkDuckworth · 2025-04-11T21:53:21Z

packages/firestore/src/core/expressions.ts

+          }
+          case 'NULL': {
+            foundNull = true;
+            foundNullAtLeastOnce = true;


These foundNull(.*) seem to be redundant

MarkDuckworth · 2025-04-11T21:57:29Z

packages/firestore/src/core/expressions.ts

+          stringValue: evaluated.value?.stringValue
+            ?.split('')
+            .reverse()
+            .join('')


We should mark this as an implementation to evaluate efficiency, if you have not already. On the surface, this appears like it would be slow.

Implementation changed here.

MarkDuckworth · 2025-04-11T21:59:31Z

packages/firestore/src/core/expressions.ts

+    switch (evaluated.type) {
+      case 'NULL':
+        return EvaluateResult.newNull();
+      case 'STRING': {


Reverse and some other functions support Bytes in addition to string. Are bytes encoded as string somewhere upstream of this call, or will we need to add support for bytes?

Not sure why it was missing, maybe it was not there in the backend when i did this.

Added the support, and fixed unicode support.

MarkDuckworth · 2025-04-14T17:30:26Z

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

@@ -242,41 +288,322 @@ export function toPipeline(query: Query, db: Firestore): Pipeline {
    }
  }

-  return pipeline;
+  return pipeline.stages;
 }

 function whereConditionsFromCursor(


It probably got lost in the merge. But the implementation in feat/pipelines is more performant and easier to read. Consider using that implementation instead.

MarkDuckworth · 2025-04-14T17:49:41Z

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

+      hasOrder = true;
+      // add exists to force sparse semantics
+      // Is this really needed?
+      // newStages.push(new Where(new And(stage.orders.map(order => order.expr.exists()))));


Does sparse semantics need to be enforced? If not, should we remove this commented out code?

MarkDuckworth · 2025-04-14T18:23:17Z

packages/firestore/src/core/pipeline_run.ts

+      'Empty document paths are not allowed in DocumentsSource'
+    );
+  }
+  if (stage.docPaths) {


stage.docPaths will always be truthy since we referenced stage.docPaths.length above

MarkDuckworth · 2025-04-14T18:24:59Z

packages/firestore/src/core/pipeline_run.ts

+  stage: DocumentsSource,
+  input: PipelineInputOutput[]
+): PipelineInputOutput[] {
+  if (stage.docPaths.length === 0) {


if (stage.docPaths && stage.docPaths.length === 0) {

Consider this if ther is ever a condition where docPaths is unset

MarkDuckworth · 2025-04-14T18:29:04Z

packages/firestore/src/core/pipeline_run.ts

+          { serializer: pipeline.serializer },
+          d2 as MutableDocument
+        )
+      );


Would be nice if we could memoize leftValue and rightValue. May be something for a future PR.

MarkDuckworth · 2025-04-14T18:55:45Z

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

-   * @param value The value of the constant.
-   */
-  constructor(private value: unknown) {
+  constructor(


I think at a minimum we want @hideconstructor

MarkDuckworth · 2025-04-14T18:57:22Z

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

+export function currentContext(): FunctionExpr {
+  return new FunctionExpr('current_context', []);
+}
+


We should delete this expression. It will not be exposed in the SDKs. This may have been added back in a merge.

MarkDuckworth · 2025-04-14T18:58:49Z

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

- * // Check if the document has a field named "phoneNumber"
- * exists("phoneNumber");
+ * // Check if the result of a calculation is NaN
+ * isNaN("value");


It appears as if the comments for this and the overload above were reverted in merge. The comments should apply to exists not isNaN

MarkDuckworth · 2025-04-14T18:59:08Z

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

 *
 * ```typescript
 * // Check if the result of a calculation is NaN
 * isNaN(field("value").divide(0));
 * ```
 *
 * @param value The expression to check.
- * @return A new {@code Expr} representing the 'isNaN' check.
+ * @return A new {@code Expr} representing the 'isNull' check.


comment needs fix

MarkDuckworth · 2025-04-14T18:59:14Z

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

- * // Check if the result of a calculation is NaN
- * isNaN("value");
+ * // Check if the result of a calculation is null.
+ * isNull("value");


comment needs fix

MarkDuckworth · 2025-04-14T19:48:28Z

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

+  return new CorePipeline(pipeline.serializer, newStages);
+}
+
+export type QueryOrPipeline = Query | CorePipeline;


Because QueryOrPipeline is a union type that is used throughout the implementation, to support porting to other platforms, we should change this to a common interface between the two types.

I do not think that is necessary?

C++(std::variant) and Kotlin(sealed class) has their own support for union types.

MarkDuckworth · 2025-04-14T19:56:59Z

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

+  return queryEquals(left as Query, right as Query);
+}
+
+export type TargetOrPipeline = Target | CorePipeline;


Question to be covered with the team. But what allows us to skip creating of an equivalent "Pipeline Target" class

Target and Query are almost identical, only difference is query know about limit to last while target does not.

With pipeline, we will no longer need this separation because we do not want to support features like limit to last only in the SDK.

MarkDuckworth · 2025-04-14T20:26:28Z

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

+        stage.orders.some(
+          order =>
+            order.expr instanceof Field &&
+            order.expr.fieldName() === DOCUMENT_KEY_NAME


Does NAME guarantee stable sort on a collection group?

Yeah, I guess it will. This is the full path not just the ID.

wu-hui

Thanks for the review!

wu-hui · 2025-05-28T05:41:40Z

packages/firestore/src/api/realtime_pipeline.ts

+import { JsonProtoSerializer } from '../remote/serializer';
+
+/**
+ * Base-class implementation


Updated, but need some further polishment still.

wu-hui · 2025-05-28T05:43:07Z

packages/firestore/src/api/realtime_pipeline.ts

+     */
+    public _userDataWriter: AbstractUserDataWriter,
+    readonly stages: Stage[],
+    readonly converter: unknown = {}


wu-hui · 2025-05-28T05:44:41Z

packages/firestore/src/api/realtime_pipeline.ts

+   * @param stages
+   * @param converter
+   */
+  newPipeline(


wu-hui · 2025-05-28T05:46:10Z

packages/firestore/src/api/realtime_pipeline.ts

+        new Sort(
+          this.readUserData(
+            'sort',
+            this.readUserData('sort', optionsOrOrderings.orderings)


wu-hui · 2025-05-28T05:47:57Z

packages/firestore/src/core/expressions.ts

+  AggregateFunction,
+  ListOfExprs,
+  isNan,
+  isError


Deleted those for now.

wu-hui · 2025-05-29T01:33:27Z

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

-   * @param value The value of the constant.
-   */
-  constructor(private value: unknown) {
+  constructor(


wu-hui · 2025-05-29T01:34:00Z

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

+export function currentContext(): FunctionExpr {
+  return new FunctionExpr('current_context', []);
+}
+


wu-hui · 2025-05-29T01:36:28Z

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

- * // Check if the document has a field named "phoneNumber"
- * exists("phoneNumber");
+ * // Check if the result of a calculation is NaN
+ * isNaN("value");


wu-hui · 2025-05-29T01:48:47Z

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

 *
 * ```typescript
 * // Check if the result of a calculation is NaN
 * isNaN(field("value").divide(0));
 * ```
 *
 * @param value The expression to check.
- * @return A new {@code Expr} representing the 'isNaN' check.
+ * @return A new {@code Expr} representing the 'isNull' check.


wu-hui · 2025-05-29T01:49:30Z

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

- * // Check if the result of a calculation is NaN
- * isNaN("value");
+ * // Check if the result of a calculation is null.
+ * isNull("value");


tom-andersen · 2025-06-10T17:21:16Z

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

+    // For stages augmenting outputs
+    else if (stage instanceof AddFields || stage instanceof Select) {
+      if (stage instanceof AddFields) {
+        newStages.push(new AddFields(addSystemFields(stage.fields)));


Would it make more sense to validate and reject customer from overwriting system fields?

Also, what about other stages that can overwrite system fields? UNNEST, REPLACE, REMOVE_FIELDS

wu-hui requested review from a team as code owners April 8, 2025 22:08

MarkDuckworth reviewed Apr 11, 2025

View reviewed changes

wu-hui force-pushed the wuandy/RealPpl_2 branch from 6710057 to 0c570ab Compare April 14, 2025 18:34

MarkDuckworth reviewed Apr 14, 2025

View reviewed changes

wu-hui force-pushed the wuandy/RealPpl_2 branch 2 times, most recently from 6f0e635 to 58cfd1d Compare April 29, 2025 19:45

[2/4] Offline pipeline evaluation and tests

c9fce63

wu-hui force-pushed the wuandy/RealPpl_2 branch from 58cfd1d to c9fce63 Compare May 29, 2025 06:05

wu-hui commented May 29, 2025

View reviewed changes

wu-hui assigned MarkDuckworth May 29, 2025

tom-andersen reviewed Jun 10, 2025

View reviewed changes

[2/4] Offline pipeline evaluation and tests #8908

Are you sure you want to change the base?

[2/4] Offline pipeline evaluation and tests #8908

Uh oh!

Conversation

wu-hui commented Apr 8, 2025

Uh oh!

changeset-bot bot commented Apr 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

github-actions bot commented Apr 8, 2025

Vertex AI Mock Responses Check ⚠️

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

changeset-bot bot commented Apr 8, 2025 •

edited

Loading