feat(firestore): support array_agg(), array_agg_distinct(), first(), last()

[Linchin]

TODO:

• verify docstring
• referred to feat(firestore): add accumulators expressions firebase/firebase-js-sdk#9576 for docstring text

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the Firestore client library by introducing several new aggregation functions. These additions allow users to collect values into arrays, retrieve distinct values, and easily select the first or last elements within a dataset, thereby expanding the analytical capabilities of the query pipeline. The changes are thoroughly tested with both unit and system tests to ensure reliability.

Highlights

• New Aggregation Functions: Added support for array_agg(), array_agg_distinct(), first(), and last() aggregation functions within the Firestore pipeline expressions, enabling more powerful data manipulation.
• System Tests: Introduced comprehensive system-level end-to-end tests for the newly added aggregation functions to ensure their correct behavior in a real-world scenario.
• Unit Tests: Implemented dedicated unit tests for each new aggregation method to verify their individual functionality and integration with the existing expression framework.

Changelog

• packages/google-cloud-firestore/google/cloud/firestore_v1/pipeline_expressions.py
  • Added array_agg method to create an aggregation that collects values into an array.
  • Added array_agg_distinct method to create an aggregation that collects distinct values into an array.
  • Added first method to create an aggregation that selects the first value.
  • Added last method to create an aggregation that selects the last value.
• packages/google-cloud-firestore/tests/system/pipeline_e2e/aggregates.yaml
  • Added a new system test testArrayAgg to verify the array_agg function.
  • Added a new system test testArrayAggDistinct to verify the array_agg_distinct function.
  • Added a new system test testFirst to verify the first function.
  • Added a new system test testLast to verify the last function.
• packages/google-cloud-firestore/tests/unit/v1/test_pipeline_expressions.py
  • Added test_array_agg to validate the array_agg method's behavior.
  • Added test_array_agg_distinct to validate the array_agg_distinct method's behavior.
  • Added test_first to validate the first method's behavior.
  • Added test_last to validate the last method's behavior.

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
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

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.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces support for array_agg(), array_agg_distinct(), first(), and last() aggregation functions. The changes include updates to pipeline expressions and the addition of corresponding unit and system tests. My review found a couple of minor grammatical errors in the docstrings, for which I've provided suggestions. These comments do not conflict with any of the provided rules and are therefore kept as is.

[daniel-sanche]

Looks mostly good to me, but consider improving that test

[daniel-sanche]

Is there a better test example that could be used? It looks like this is finding distinct values out of a fixed array with size 1

Could we make it read genres from the database, and return the distinct values or something?

[Linchin]

This is a really good catch. I removed the filter.

[daniel-sanche]

LGTM