perf: Add details to error message in Parse.Query.aggregate

[dplewis]

Pull Request

• Report security issues confidentially.
• Any contribution is under this license.
• Link this pull request to an issue.

Issue

Returns Internal Server Error

Approach

Returns Invalid Query error with message

Tasks

• Add tests
• Add changes to documentation (guides, repository pages, code comments)
• Add security check
• Add new Parse Error codes to Parse JS SDK

Summary by CodeRabbit

• Bug Fixes

  • Improved error handling for MongoDB aggregation errors, ensuring users receive clear and standardized error messages for invalid queries.

• Tests

  • Added a test to verify that MongoDB aggregation errors are correctly caught and reported as invalid queries.
  • Marked an additional test as flaky to improve test reporting reliability.

[parse-github-assistant]

🚀 Thanks for opening this pull request!

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.16%. Comparing base (9d8d494) to head (5ee3f11).
Report is 22 commits behind head on alpha.

Additional details and impacted files

@@            Coverage Diff             @@
##            alpha    #9689      +/-   ##
==========================================
- Coverage   93.17%   93.16%   -0.01%     
==========================================
  Files         187      187              
  Lines       15066    15068       +2     
==========================================
+ Hits        14037    14038       +1     
- Misses       1029     1030       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[parseplatformorg]

🎉 This change has been released in version 8.1.1-alpha.1

[parseplatformorg]

🎉 This change has been released in version 8.2.0

[coderabbitai]

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

The changes introduce a new test to verify that MongoDB aggregation errors are properly handled and mapped to standardized Parse error codes. The handleFind method in the AggregateRouter is refactored to use async/await and improved error handling, ensuring that aggregation errors are caught and rethrown as Parse.Error with an INVALID_QUERY code. Additionally, a new test name is added to the list of flaky tests in the test reporter configuration.

Changes

File(s)	Change Summary
spec/ParseQuery.Aggregate.spec.js	Added a test to check that MongoDB aggregation errors are caught and mapped to Parse.Error.INVALID_QUERY.
spec/support/CurrentSpecReporter.js	Added a new test name to the flakyTests array with a comment about its expected failure.
src/Routers/AggregateRouter.js	Refactored handleFind to be async, use try-catch for error handling, and throw standardized Parse errors.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant AggregateRouter
    participant rest

    Client->>AggregateRouter: handleFind(request)
    AggregateRouter->>rest: find(request)
    alt Success
        rest-->>AggregateRouter: response
        AggregateRouter-->>Client: response (with processed results)
    else Error
        rest-->>AggregateRouter: error
        AggregateRouter-->>Client: Parse.Error(INVALID_QUERY, error.message)
    end

Loading

sequenceDiagram
    participant Test
    participant ParseQuery
    participant MongoDB

    Test->>ParseQuery: aggregate(pipeline with $search)
    ParseQuery->>MongoDB: execute aggregation
    MongoDB-->>ParseQuery: error (unsupported stage)
    ParseQuery-->>Test: throw Parse.Error.INVALID_QUERY

Loading

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9d8d494 and 5ee3f11.

📒 Files selected for processing (3)

• spec/ParseQuery.Aggregate.spec.js (1 hunks)
• spec/support/CurrentSpecReporter.js (1 hunks)
• src/Routers/AggregateRouter.js (2 hunks)

---

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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 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.