Skip to content

feat(firestore): introduce pipeline functionality (Dart API)#18096

Draft
SelaseKay wants to merge 64 commits intofeat/firestore-pipelinesfrom
firestore-pipelines-dart-api-v2
Draft

feat(firestore): introduce pipeline functionality (Dart API)#18096
SelaseKay wants to merge 64 commits intofeat/firestore-pipelinesfrom
firestore-pipelines-dart-api-v2

Conversation

@SelaseKay
Copy link
Contributor

Description

Replace this paragraph with a description of what this PR is doing. If you're modifying existing behavior, describe the existing behavior, how this PR is changing it, and what motivated the change.

Related Issues

Replace this paragraph with a list of issues related to this PR from the issue database. Indicate, which of these issues are resolved or fixed by this PR. Note that you'll have to prefix the issue numbers with flutter/flutter#.

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]).
This will ensure a smooth and quick review process. Updating the pubspec.yaml and changelogs is not required.

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • My PR includes unit or integration tests for all changed/updated/fixed behaviors (See Contributor Guide).
  • All existing and new tests are passing.
  • I updated/added relevant documentation (doc comments with ///).
  • The analyzer (melos run analyze) does not report any problems on my PR.
  • I read and followed the Flutter Style Guide.
  • I signed the CLA.
  • I am willing to follow-up on review comments in a timely manner.

Breaking Change

Does your PR require plugin users to manually update their apps to accommodate your change?

  • Yes, this is a breaking change.
  • No, this is not a breaking change.

@gemini-code-assist
Copy link
Contributor

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

Copy link
Contributor

@Lyokone Lyokone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are also missing a lot of unit tests for a lot files.

Comment on lines +99 to +100
if (selectable10 != null) selectables.add(selectable10);
if (selectable21 != null) selectables.add(selectable21);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are missing 11 to 20 here

part of 'cloud_firestore.dart';

/// Result of executing a pipeline
class PipelineResult {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file should be in src.

BooleanExpression tryExpr,
BooleanExpression catchExpr,
) {
return _IfErrorExpression(tryExpr, catchExpr) as BooleanExpression;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure this cast will work?

Copy link

@wu-hui wu-hui left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did a quick skim, and couple nits. Overall my ask is: can we copy Android's refdocs, and verify they have similar APIs, I suppose ask an AI to compare the two, and copy some from Android might do 80% of this rather tedious work.

Also, I take that the E2E integration tests are (will be) in a different PR?

///
/// Example:
/// ```dart
/// pipeline.aggregateStage(
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sample does not match the actual method signature. Or am I reading dart right?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. You're right. I've updated it. Thanks

);
}

/// Gets distinct values based on expressions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing code samples, here and below.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, will add samples.

@SelaseKay
Copy link
Contributor Author

Did a quick skim, and couple nits. Overall my ask is: can we copy Android's refdocs, and verify they have similar APIs, I suppose ask an AI to compare the two, and copy some from Android might do 80% of this rather tedious work.

Also, I take that the E2E integration tests are (will be) in a different PR?

Yes. E2E will be added in a different PR.

}

/// Returns an expression if another errors
static Expression ifErrorStatic(
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

general question, why do we have the "static" suffix for some static functions, but not all of them. Ideally we would have no such suffixes, but i guess they exist because Dart complains?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, Dart does not support function overloading. The goal here is to keep the API style consistent with the native SDKs. For example, on Android, there are multiple overloads of ifError; one as an instance method and another as a static method on the Expression class. To mirror this in Dart, we implemented two methods on the same Expression class and suffixed the static methods with “static,” since Dart does not allow multiple methods with the same name on a single class.

SelaseKay and others added 18 commits March 19, 2026 19:17
…18098)

* feat(firestore): Android implementation for Pipeline APIs

* refactor: improve handling of timestamps and array expressions in pipeline

* chore: add support for more Expression functions in Android

* chore: remove unsupported 'replace' expression from Android Firestore pipeline API

* chore: enhance PipelineParser to support execute options for Firestore pipelines

* chore: remove commented-out button for stringReplaceAll in pipeline example

* trigger CI

* trigger CI

* trigger CI

* refactor: enhance expression parsing logic in ExpressionParsers
* feat(firestore): Web implementation for Pipeline APIs

* chore: fix ci

* chore: inject firestore pipelines script for web

* chore: add comments for Firestore Pipelines script injection in web implementation

* refactor: remove unecessary comment

* chore: add support for missing Expressions and fix bugs

* chore: fix ci

* feat: enhance pipeline expression handling with new expressions and error handling

* refactor: rename 'replace' case to 'string_replace_all' in pipeline expression parser

* chore: update Pipeline execution to accept options for index mode

* fix: resolve failing mapGet test on web

* fix: correctly parse 'not' expression arguments

* trigger CI

* fix tests

* fix tests

* fix: update type casting for boolean expression in PipelineExpressionParserWeb

* fix ci
* feat(firestore): iOS implementation for Pipeline APIs

* fix: conditionally import FIRPipelineBridge.h for iOS

* chore: add macOS support for FLTPipelineParser by linking to iOS implementation

* fix: conditionally include FIRPipelineBridge.h for macOS support in FLTPipelineParser

* chore: add support for missing Expression function

* refactor: clean up formatting in FLTPipelineParser.m for improved readability

* chore: enhance FLTPipelineParser with support for array and map expressions, ensuring proper argument handling

* chore: implement conditional expression and current timestamp handling in FLTPipelineParser

* chore: add 'find_nearest' stage support in FLTPipelineParser with validation for vector_field, vector_value, and distance_measure

* chore: introduce FLTFirebaseFirestoreErrorCodePipelineParse for improved error handling in pipeline parsing

* trigger CI

* fix: update header inclusion logic for FirebaseFirestore in FLTPipelineParser.m

* trigger CI

* chore: enhance FLTPipelineParser with new expression handling
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants