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

dplewis · 2025-04-01T14:28:27Z

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 · 2025-04-01T14:28:30Z

🚀 Thanks for opening this pull request!

codecov · 2025-04-01T14:34:08Z

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.

## [8.1.1-alpha.1](8.1.0...8.1.1-alpha.1) (2025-04-07) ### Performance Improvements * Add details to error message in `Parse.Query.aggregate` ([#9689](#9689)) ([9de6999](9de6999))

parseplatformorg · 2025-04-07T19:55:17Z

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

# [8.2.0](8.1.0...8.2.0) (2025-05-01) ### Features * Add TypeScript definitions ([#9693](#9693)) ([e86718f](e86718f)) ### Performance Improvements * Add details to error message in `Parse.Query.aggregate` ([#9689](#9689)) ([9de6999](9de6999))

parseplatformorg · 2025-05-01T10:11:38Z

🎉 This change has been released in version 8.2.0

coderabbitai · 2025-05-01T10:11:47Z

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

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

📜 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.

feat: Improve handling aggregate query errors

9433c00

dplewis added 2 commits April 1, 2025 09:48

simplify tests

8b54a05

flaky test

1c584e7

dplewis requested a review from a team April 1, 2025 15:28

mtrezza added 2 commits April 7, 2025 09:40

Merge branch 'alpha' into aggregate-errors

854954a

Merge branch 'alpha' into aggregate-errors

5ee3f11

mtrezza changed the title ~~feat: Improve handling aggregate query errors~~ feat: Improve error handling in Parse.Query.aggregate Apr 7, 2025

mtrezza changed the title ~~feat: Improve error handling in Parse.Query.aggregate~~ perf: Improve error handling in Parse.Query.aggregate Apr 7, 2025

mtrezza changed the title ~~perf: Improve error handling in Parse.Query.aggregate~~ perf: Improve error handling in Parse.Query.aggregate with more meaningful error message Apr 7, 2025

mtrezza changed the title ~~perf: Improve error handling in Parse.Query.aggregate with more meaningful error message~~ perf: Add details to error message in Parse.Query.aggregate Apr 7, 2025

mtrezza merged commit 9de6999 into parse-community:alpha Apr 7, 2025
24 checks passed

parseplatformorg added the state:released-alpha Released as alpha version label Apr 7, 2025

parseplatformorg added the state:released Released as stable version label May 1, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

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

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

Uh oh!

dplewis commented Apr 1, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

parse-github-assistant bot commented Apr 1, 2025 •

edited

Loading

Uh oh!

codecov bot commented Apr 1, 2025 •

edited

Loading

Uh oh!

Uh oh!

parseplatformorg commented Apr 7, 2025

Uh oh!

parseplatformorg commented May 1, 2025

Uh oh!

coderabbitai bot commented May 1, 2025 •

edited

Loading

Review failed

Walkthrough

Changes

Sequence Diagram(s)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Uh oh!

Uh oh!

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

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

Uh oh!

Conversation

dplewis commented Apr 1, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request

Issue

Approach

Tasks

Summary by CodeRabbit

Uh oh!

parse-github-assistant bot commented Apr 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Apr 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

parseplatformorg commented Apr 7, 2025

Uh oh!

parseplatformorg commented May 1, 2025

Uh oh!

coderabbitai bot commented May 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review failed

Walkthrough

Changes

Sequence Diagram(s)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Uh oh!

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

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

dplewis commented Apr 1, 2025 •

edited by coderabbitai bot

Loading

parse-github-assistant bot commented Apr 1, 2025 •

edited

Loading

codecov bot commented Apr 1, 2025 •

edited

Loading

coderabbitai bot commented May 1, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)