Add Aggregate Query Support to Parse Flutter SDK

[mskayali]

Pull Request

Add Aggregate Query Support to Parse Flutter SDK

Issue

Closes: #664

Approach

This pull request introduces support for aggregate queries in the Parse Flutter SDK by implementing the ParseAggregate class. This enhancement allows developers to perform complex data aggregations directly within their Flutter applications, leveraging the Parse Server's /aggregate endpoint.​

Key Features:

​ParseAggregate Class: A new class that facilitates the construction and execution of aggregation pipelines.

​Pipeline Validation: Ensures that the provided aggregation pipeline is not empty, throwing an ArgumentError if validation fails.

​Seamless Integration: Utilizes existing ParseHTTPClient and handleResponse methods for consistent request handling and response parsing.

​Debug Support: Optional debug logging to assist developers during development and troubleshooting.​ Parse Community

Usage Example:

final res = await ParseAggregate('DietPlan', pipeline: {
  r'$match': {'Name': 'Ketogenic'}
}).execute();

print(res.result);

Notes:

This implementation aligns with the Parse REST API's aggregate query specifications.

Comprehensive documentation and unit tests have been included to ensure reliability and ease of use.

• [ ] Add tests
• [ ] Add changes to documentation (guides, repository pages, code comments)

Summary by CodeRabbit

• New Features
  • Introduced support for aggregation queries, enabling advanced data analysis on Parse Server data.
  • Added a new data structure for URL component handling.
• Bug Fixes
  • Improved handling and validation of aggregation query inputs.
• Chores
  • Updated several package dependencies to their latest versions.
  • Expanded ignored files in the Flutter example to prevent unnecessary files from being tracked.
• Style
  • Minor adjustments to import order and code formatting for consistency.

[parse-github-assistant[bot]]

🚀 Thanks for opening this pull request!

[coderabbitai[bot]]

📝 Walkthrough

Walkthrough

The changes introduce support for aggregate queries in the Dart/Flutter Parse SDK. This includes a new ParseAggregate class for executing aggregation pipelines, updates to endpoint constants, dependency version bumps, and example usage in the main Dart example. Supporting infrastructure such as response handling and job execution classes are also added or updated.

Changes

File(s)	Change Summary
packages/dart/lib/src/objects/parse_aggregate.dart	Added ParseAggregate class for aggregation queries.
packages/dart/example/main.dart	Demonstrates aggregation query usage after saving a DietPlan object.
packages/dart/lib/parse_server_sdk.dart	Updated part directives: added parse_aggregate.dart and parse_jobs.dart, commented old part.
packages/dart/lib/src/objects/parse_jobs.dart	Added ParseJobs class for cloud function execution.
packages/dart/lib/src/objects/parse_response.dart	Added ParseResponse class for standardized response handling.
packages/dart/lib/src/base/parse_constants.dart	Added endpoint constants for functions and jobs.
packages/dart/lib/src/objects/parse_function.dart	Changed _path initialization to use new endpoint constant.
packages/dart/lib/src/utils/url_replace.dart	Introduced UrlReplace class for URL component storage.
packages/dart/lib/src/network/parse_http_client.dart	Minor import order change and blank line addition.
packages/dart/pubspec.yaml, packages/flutter/pubspec.yaml	Updated dependency versions.
packages/flutter/example/.gitignore	Added .build/ and .swiftpm/ to ignored paths.

Sequence Diagram(s)

sequenceDiagram
    participant App
    participant ParseAggregate
    participant ParseServer

    App->>ParseAggregate: Create with functionName
    App->>ParseAggregate: execute(pipeline)
    ParseAggregate->>ParseServer: GET /aggregate/{functionName}?pipeline=...
    ParseServer-->>ParseAggregate: Response (results/error)
    ParseAggregate-->>App: ParseResponse (success/results/error)

Assessment against linked issues

Objective (Issue #)	Addressed	Explanation
Support aggregate queries in SDK (#664)	✅
Provide example/documentation for usage (#664)	✅

Assessment against linked issues: Out-of-scope changes

Code Change	Explanation
Introduced UrlReplace class (packages/dart/lib/src/utils/url_replace.dart)	Not directly related to aggregate queries or their usage.
Added ParseJobs class (packages/dart/lib/src/objects/parse_jobs.dart)	Provides job/cloud function execution, unrelated to aggregates.
Minor import/blank line change (packages/dart/lib/src/network/parse_http_client.dart)	No direct connection to aggregate query support.
Dependency version updates (pubspec.yaml files)	Not specific to aggregate query feature.
.gitignore updates (packages/flutter/example/.gitignore)	Not related to aggregate queries or SDK features.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai auto-generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[mskayali]

I've complete the updates

[mtrezza]

@mskayali Could you please comment on each of the open review feedbacks - if you make a commit to address them, they will be automatically closed by coderabbit; if you want to dispute them you can just start a discussion there.