feat: Deprecation - return MongoDB explain results as an array via databaseOptions.explainResultsAsArray - #10552
Conversation
…ray via `databaseOptions.explainResultsAsArray` Closes parse-community#7442
|
🚀 Thanks for opening this pull request! We appreciate your effort in improving the project. Please let us know once your pull request is ready for review. Tip
Note Please respond to review comments from AI agents just like you would to comments from a human reviewer. Let the reviewer resolve their own comments, unless they have reviewed and accepted your commit, or agreed with your explanation for why the feedback was incorrect. Caution Pull requests must be written using an AI agent with human supervision. Pull requests written entirely by a human will likely be rejected, because of lower code quality, higher review effort and the higher risk of introducing bugs. Please note that AI review comments on this pull request alone do not satisfy this requirement. Our CI and AI review are safeguards, not development tools. If many issues are flagged, rethink your development approach. Invest more effort in planning and design rather than using review cycles to fix low-quality code. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (4)
🚧 Files skipped from review as they are similar to previous changes (3)
📝 WalkthroughWalkthroughThe change adds ChangesMongoDB explain result shape
Estimated code review effort: 3 (Moderate) | ~20 minutes Sequence Diagram(s)sequenceDiagram
participant ParseQueryExplain
participant DatabaseControllerFind
participant MongoAdapter
ParseQueryExplain->>DatabaseControllerFind: request explain query
DatabaseControllerFind->>MongoAdapter: execute find with explain
MongoAdapter-->>DatabaseControllerFind: return explain object
DatabaseControllerFind-->>ParseQueryExplain: return array when option is enabled
Possibly related PRs
Suggested reviewers: Caution Pre-merge checks failedPlease resolve all errors before merging. Addressing warnings is optional.
❌ Failed checks (1 error, 1 inconclusive)
✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 Biome (2.5.3)src/Options/index.jsFile contains syntax errors that prevent linting: Line 18: Expected a type but instead found '?'.; Line 18: Expected a property, or a signature but instead found ';'.; Line 21: Expected a statement but instead found '?'.; Line 24: Expected a statement but instead found '?'.; Line 27: Expected a statement but instead found '?'.; Line 30: Expected a statement but instead found '?'.; Line 32: Expected a statement but instead found '?'.; Line 34: Expected a statement but instead found '?'.; Line 35: Expected a statement but instead found '}'.; Line 37: type alias are a TypeScript only feature. Convert your file to a TypeScript file or remove the syntax.; Line 38: type alias are a TypeScript only feature. Convert your file to a TypeScript file or remove the syntax.; Line 39: type alias are a TypeScript only feature. Convert your file to a TypeScript file or remove the syntax.; Line 40: type alias are a TypeScript only feature. Convert your file to a TypeScript file or remove the syntax.; Li ... [truncated 16812 characters] ... found '?'.; Line 915: Expected a statement but instead found '?'.; Line 917: Expected a statement but instead found '?'.; Line 918: Expected a statement but instead found '}'.; Line 932: Expected a type but instead found '?'.; Line 932: Expected a property, or a signature but instead found ';'.; Line 933: Expected a statement but instead found '}'.; Line 939: Expected a type but instead found '?'.; Line 939: Expected a property, or a signature but instead found ';'.; Line 943: Expected a statement but instead found '?'.; Line 947: Expected a statement but instead found '?'.; Line 951: Expected a statement but instead found '?'.; Line 955: Expected a statement but instead found '?'.; Line 959: Expected a statement but instead found '?'.; Line 960: Expected a statement but instead found '}'. 🔧 ast-grep (0.44.1)spec/ParseQuery.spec.jsast-grep timed out on this file 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. Comment |
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## alpha #10552 +/- ##
==========================================
- Coverage 93.78% 93.78% -0.01%
==========================================
Files 192 192
Lines 16832 16837 +5
Branches 248 248
==========================================
+ Hits 15786 15790 +4
- Misses 1025 1026 +1
Partials 21 21 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
@coderabbitai full review |
✅ Action performedFull review finished. |
2 participants
Closes #7442
This revives #7440 (closed back in 2023 as a breaking change) but phases it in via the deprecation policy rather than breaking outright.
MongoDB's
explainon a find returns a single object, whereasfindand the Postgres adapter always return an array - which breaks strongly-typed SDKs (Swift etc) that decoderesultsas an array. This normalises Mongo's explain result to an array so it's consistent.Since that's a breaking change it's opt-in for now behind a new
databaseOptions.explainResultsAsArray(defaultfalse= current object behaviour), plus a deprecation warning that the default flips totruein the next major (DEPPS25, id is just the next free one - happy to renumber). Postgres already returns an array so theArray.isArrayguard leaves it untouched, no double-wrap.Existing explain tests stay green untouched (proof it's non-breaking today); new opt-in test added. Verified on both Mongo and Postgres via specs and a live server.
Summary by CodeRabbit
New Features
explainResultsAsArray) to return MongoDBQuery.explain()results as an array, aligning output with other adapters.Bug Fixes
Deprecations
Documentation