Skip to content

feat(firestore, web): Web implementation for Pipeline APIs#18100

Draft
SelaseKay wants to merge 12 commits intofirestore-pipelines-dart-api-v2from
firestore-pipelines-web
Draft

feat(firestore, web): Web implementation for Pipeline APIs#18100
SelaseKay wants to merge 12 commits intofirestore-pipelines-dart-api-v2from
firestore-pipelines-web

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.

.toUpper();
case 'trim':
return (_expr(argsMap, _kExpression) as interop.ExpressionJsImpl)
.toLower();
Copy link
Contributor

Choose a reason for hiding this comment

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

case 'trim':
  return (_expr(argsMap, _kExpression) as interop.ExpressionJsImpl)
      .toLower();  // BUG: should be .trim()

Copy-paste bug. This will silently produce wrong results — a trim() call will lowercase the string instead of trimming whitespace.

Comment on lines +217 to +227
const firestoreServiceName = 'firestore';

if (service.name == firestoreServiceName) {
// Inject the Firestore Pipelines script. This bundle supports both
// Pipeline operations (Enterprise edition) and standard Firestore queries.
return injectSrcScript(
'https://www.gstatic.com/firebasejs/$version/firebase-firestore-pipelines.js',
'firebase_$firestoreServiceName',
);
}

Copy link
Contributor

Choose a reason for hiding this comment

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

We need to add a TODO or something? is it normal to inject it this way? Will it be supported in the normal bundle?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

https://www.gstatic.com/firebasejs/$version/firebase-firestore-pipelines.js bundle has support for both standard queries and Pipeline Operations. The previous bundle had support for only standard queries.

/// Converts Dart serialized pipeline expressions/stage args into JS pipeline
/// types by calling the pipelines interop API (field, constant, equal, and,
/// ascending, etc.) that mirrors the Firebase JS SDK.
class PipelineExpressionParserWeb {
Copy link
Contributor

Choose a reason for hiding this comment

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

Are we missing those?

  • negate
  • as_boolean
  • to_string_with_format
  • bit_and, bit_or, bit_xor, bit_not, bit_left_shift, bit_right_shift
  • document_id_from_ref
  • array_reverse
  • array_slice
  • distance
  • timestamp_diff
  • map_from_pairs

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Besides array_reverse, document_id_from_ref, and as_boolean the others are not supported on Web

return pipeline.union(otherPipeline);
default:
// Ignore unknown stages
return pipeline;
Copy link
Contributor

Choose a reason for hiding this comment

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

default:
  // Ignore unknown stages
  return pipeline;

If a stage type is unrecognized, it's silently skipped. This could produce subtly wrong query results that are extremely hard to debug. This should throw an error instead, like:

default:
  throw FirebaseException(
    plugin: 'cloud_firestore',
    message: 'Unknown pipeline stage: ${stage['stage']}',
  );

Comment on lines +80 to +84
interop.PipelineResultJsImpl jsResult) {
final d = jsResult.data();
return d != null
? Map<String, dynamic>.from(dartify(d) as Map<Object?, Object?>)
: null;
Copy link
Contributor

Choose a reason for hiding this comment

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

If dartify(d) returns null even when d is non-null (e.g. a JS object that can't be converted), the as Map<Object?, Object?> cast will throw. The version in firestore.dart handles this more safely:

final parsed = dartify(d);
return parsed != null ? Map<String, dynamic>.from(parsed as Map<Object?, Object?>) : null;

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.

2 participants