PHPLIB-1689 Make the Atlas Search exception more specific #1794

GromNaN · 2025-11-05T19:13:23Z

Conditions imported from https://github.com/mongodb/laravel-mongodb/blob/a2b4ab86dfc9248050b2592d9830773ac335774e/src/Schema/Builder.php#L386-L395

Copilot

Pull Request Overview

This PR introduces a more specific exception (SearchNotSupportedException) to handle Atlas Search-related errors that occur during aggregation operations. The change improves error handling by catching generic server exceptions and re-throwing them as a more specific exception type when they relate to unsupported search functionality.

Created a new SearchNotSupportedException class to identify and handle search-related server errors
Modified the Aggregate operation to catch and re-throw search-specific exceptions during command execution

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File	Description
src/Exception/SearchNotSupportedException.php	New exception class that extends ServerException and provides logic to identify search-related errors based on error codes
src/Operation/Aggregate.php	Added try-catch block to intercept ServerException and re-throw as SearchNotSupportedException when appropriate

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/Exception/SearchNotSupportedException.php

src/Operation/Aggregate.php

Copilot

Pull Request Overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

codecov-commenter · 2025-11-05T19:21:55Z

Codecov Report

❌ Patch coverage is 76.08696% with 11 lines in your changes missing coverage. Please review.
✅ Project coverage is 87.63%. Comparing base (82719c4) to head (1348e94).
⚠️ Report is 1 commits behind head on v2.x.
✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
src/Exception/SearchNotSupportedException.php	68.96%	9 Missing ⚠️
src/Operation/CreateSearchIndexes.php	80.00%	1 Missing ⚠️
src/Operation/UpdateSearchIndex.php	80.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               v2.x    #1794      +/-   ##
============================================
- Coverage     87.74%   87.63%   -0.11%     
- Complexity     3185     3196      +11     
============================================
  Files           424      425       +1     
  Lines          6289     6332      +43     
============================================
+ Hits           5518     5549      +31     
- Misses          771      783      +12

Flag	Coverage Δ
6.0-replica_set	`86.41% <76.08%> (+0.69%)`	⬆️
6.0-server	`82.43% <76.08%> (+0.72%)`	⬆️
6.0-sharded_cluster	`86.21% <76.08%> (+0.69%)`	⬆️
8.0-replica_set	`87.49% <67.39%> (-0.17%)`	⬇️
8.0-server	`83.21% <67.39%> (+0.65%)`	⬆️
8.0-sharded_cluster	`87.33% <67.39%> (-0.17%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

src/Exception/SearchNotSupportedException.php

GromNaN · 2025-12-02T20:14:40Z

Since mongo 6.0.11-ent, the $listSearchIndexes stage returns nothing, while the previous versions threw a server error. This makes it more complicated to test and detect.

jmikola

@GromNaN: Was there anything in this PR you wanted to keep, or should it all be abandoned (given the difficulty in error detection)?

Copilot

Pull request overview

Copilot reviewed 12 out of 12 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/Exception/SearchNotSupportedException.php

tests/Exception/SearchNotSupportedExceptionTest.php

tests/FunctionalTestCase.php

GromNaN · 2025-12-17T17:57:47Z

I found a more reliable way to detect when Search indexes are supported.
And I made the test pass weither search indexes are supported or not: if there is an exception it must be a SearchIndexNotSupportedException.

Also fixed the exception for update and drop search index.

…old server versions

…o Atlas, thanks to Community Search

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 12 out of 12 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/Exception/SearchNotSupportedException.php

paulinevos · 2025-12-19T15:34:23Z

src/Exception/SearchNotSupportedException.php

+            // MongoDB 7-ent: Search index commands are only supported with Atlas.
+            115 => true,
+            // MongoDB 4 to 6, 7-community
+            59 => match ($exception->getMessage()) {


match inception 🤯

A decision tree 🎄

paulinevos · 2025-12-19T15:56:26Z

src/Exception/SearchNotSupportedException.php

+                default => false,
+            },
+            // MongoDB 4 to 6
+            40324 => match ($exception->getMessage()) {


Did you trawl through all the old versions' source code to find all these error codes? 😭

I tried many server versions using mongo-orchestration, m and mongo-launch; Atlas M0 and Atlas Local Docker.
Then our test matrix helped validate all the versions.

paulinevos · 2025-12-19T15:56:59Z

src/Operation/Aggregate.php

+        try {
+            $cursor = $this->executeCommand($server, $command);
+        } catch (ServerException $exception) {
+            if (SearchNotSupportedException::isSearchNotSupportedError($exception)) {


Nice solution

paulinevos · 2025-12-19T15:59:26Z

tests/Exception/SearchNotSupportedExceptionTest.php

+
+        try {
+            $collection->listSearchIndexes();
+        } catch (SearchNotSupportedException) {


Basically are you doing it like these because it's too complex to skip if it is supported? Can't we just do the inverse of the check you do in skipIfSearchIndexIsNotSupported and expect an exception?

This is a way to test even if skipIfSearchIndexIsNotSupported is incomplete. Here, I test each operation one by one to ensure that if there is an exception, it is properly wrapped.

I noticed that not all server versions are consistent. As an example in mongo 6.0.11-ent, the $listSearchIndexes stage returns an empty list but createSearchIndexes returns an error.

Copilot AI review requested due to automatic review settings November 5, 2025 19:13

GromNaN requested a review from a team as a code owner November 5, 2025 19:13

GromNaN requested a review from jmikola November 5, 2025 19:13

Copilot AI reviewed Nov 5, 2025

View reviewed changes

src/Exception/SearchNotSupportedException.php Outdated Show resolved Hide resolved

src/Operation/Aggregate.php Show resolved Hide resolved

GromNaN force-pushed the PHPLIB-1689 branch 2 times, most recently from f9c8674 to 604ef77 Compare November 5, 2025 19:16

GromNaN requested a review from Copilot November 5, 2025 19:16

Copilot AI reviewed Nov 5, 2025

View reviewed changes

GromNaN force-pushed the PHPLIB-1689 branch 2 times, most recently from 9d13244 to 17b1c47 Compare November 10, 2025 09:51

GromNaN commented Nov 10, 2025

View reviewed changes

src/Exception/SearchNotSupportedException.php Outdated Show resolved Hide resolved

GromNaN force-pushed the PHPLIB-1689 branch 2 times, most recently from 14c3251 to 50fbc84 Compare November 18, 2025 17:05

jmikola reviewed Dec 15, 2025

View reviewed changes

GromNaN force-pushed the PHPLIB-1689 branch 2 times, most recently from 088f9ae to 53e56ee Compare December 17, 2025 17:46

GromNaN requested review from Copilot and jmikola December 17, 2025 17:47

Copilot AI reviewed Dec 17, 2025

View reviewed changes

src/Exception/SearchNotSupportedException.php Outdated Show resolved Hide resolved

tests/Exception/SearchNotSupportedExceptionTest.php Outdated Show resolved Hide resolved

tests/FunctionalTestCase.php Show resolved Hide resolved

GromNaN and others added 6 commits December 19, 2025 11:43

PHPLIB-1689 Make the Atlas Search exception more specific

9589a94

Use error message when error code is not specific to atlas search on …

2373027

…old server versions

Rework search index support detection by running a $search pipeline

f14f4a8

Remove Atlas from the exception name, as this is no longer specific t…

b51d375

…o Atlas, thanks to Community Search

Find a reliable way to check for search compatibility

7968831

Apply suggestions from code review

6c73f9d

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

GromNaN force-pushed the PHPLIB-1689 branch 2 times, most recently from 9c70230 to 80a2c92 Compare December 19, 2025 13:44

GromNaN requested a review from Copilot December 19, 2025 13:45

Copilot AI reviewed Dec 19, 2025

View reviewed changes

src/Exception/SearchNotSupportedException.php Outdated Show resolved Hide resolved

GromNaN force-pushed the PHPLIB-1689 branch from 80a2c92 to 310e126 Compare December 19, 2025 13:56

Fix detection for mongodb community 5

caf4013

GromNaN force-pushed the PHPLIB-1689 branch from 310e126 to caf4013 Compare December 19, 2025 13:58

Better detection of search stages not supported

1348e94

paulinevos reviewed Dec 19, 2025

View reviewed changes

PHPLIB-1689 Make the Atlas Search exception more specific #1794

Are you sure you want to change the base?

PHPLIB-1689 Make the Atlas Search exception more specific #1794

Conversation

GromNaN commented Nov 5, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

codecov-commenter commented Nov 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

GromNaN commented Dec 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jmikola left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

GromNaN commented Dec 17, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

paulinevos Dec 19, 2025

Choose a reason for hiding this comment

Uh oh!

GromNaN Dec 19, 2025

Choose a reason for hiding this comment

Uh oh!

paulinevos Dec 19, 2025

Choose a reason for hiding this comment

Uh oh!

GromNaN Dec 19, 2025

Choose a reason for hiding this comment

Uh oh!

paulinevos Dec 19, 2025

Choose a reason for hiding this comment

Uh oh!

paulinevos Dec 19, 2025

Choose a reason for hiding this comment

Uh oh!

GromNaN Dec 19, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov-commenter commented Nov 5, 2025 •

edited

Loading

GromNaN commented Dec 2, 2025 •

edited

Loading