GODRIVER-3704 Fix search index failure on empty "Options". #2247

qingyang-hu · 2025-11-26T16:37:41Z

GODRIVER-3704

Summary

Fix search index failure on empty "Options".
Fix "test-search-index".

Background & Motivation

mongodb-drivers-pr-bot · 2025-11-26T16:42:00Z

🧪 Performance Results

Commit SHA: 0508d4b

There were no significant changes to the performance to report for version 693370dd89f67600071024af.

For a comprehensive view of all microbenchmark results for this PR's commit, please check out the Evergreen perf task for this patch.

mongodb-drivers-pr-bot · 2025-11-26T16:52:09Z

API Change Report

No changes found!

qingyang-hu · 2025-11-26T23:36:15Z

.evergreen/config.yml

-  assume-test-secrets-ec2-role: 
-    - command: ec2.assume_role
-      params:
-        role_arn: ${aws_test_secrets_role}
-


Duplicate of L175

Copilot

Pull request overview

This PR fixes a bug where search index creation failed when SearchIndexModel.Options is nil. The fix ensures that the document element is always started before checking for optional fields.

Key changes:

Moved AppendDocumentElementStart call outside the Options != nil check to ensure proper BSON document construction
Added integration test to verify search index creation with empty options
Standardized environment variable naming from TEST_INDEX_URI to SEARCH_INDEX_URI

Reviewed changes

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

Show a summary per file

File	Description
`mongo/search_index_view.go`	Fixed bug by moving `AppendDocumentElementStart` before the `Options != nil` check, ensuring proper BSON document structure regardless of Options value
`internal/integration/search_index_test.go`	Added new integration test to verify search index creation with empty Options
`internal/integration/search_index_prose_test.go`	Updated environment variable name from `TEST_INDEX_URI` to `SEARCH_INDEX_URI` for consistency
`Taskfile.yml`	Updated test runner to execute both `TestSearchIndex` and `TestSearchIndexProse` tests
`.evergreen/config.yml`	Updated environment variable naming to `SEARCH_INDEX_URI` and removed duplicate `assume-test-secrets-ec2-role` function definition

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

prestonvasquez · 2025-12-01T20:09:24Z

Taskfile.yml


  evg-test-search-index:
    # Use the long timeout to wait for the responses from the server.
-    - go test ./internal/integration -run TestSearchIndexProse -v -timeout {{.LONG_TEST_TIMEOUT}}s >> test.suite


[blocking] We should define TestSearchIndexProse explicitly rather than relying on regex. Also note that the prose tests are being skipped since TEST_SEARCH_INDEX no longer is set.

TestSearchIndexProse need to be manually triggered under test-search-index because it's time consuming.

prestonvasquez · 2025-12-01T20:14:15Z

.evergreen/config.yml

+          working_dir: src/go.mongodb.org/mongo-driver
+          shell: bash
+          script: |-
+            echo "SEARCH_INDEX_URI: ${MONGODB_URI}" > atlas-expansion.yml


[blocking] The EG changes seem to be trying to avoid using TEST_SEARCH_INDEX: "${MONGODB_URI}". If that's the case, we should keep the existing behavior for simplicity and roll TestSearchIndex into TestSearchIndexProse.

TestSearchIndexProse only runs when SEARCH_INDEX_URI is set. This test requires being manually triggered here because it's time consuming. However, it was corrupted since 78b0f61

It seems that TestSearchIndexProse passes under the current TEST_SEARCH_INDEX paradigm, given the example you shared. So why do we need to add the SEARCH_INDEX_URI changes?

The current codebase completely skips TestSearchIndexProse because MONGODB_URI is not set even in the test-search-index. The patch here is to set MONGODB_URI in the atlas env.

I also changed the value name from TEST_SEARCH_INDEX to SEARCH_INDEX_URI to avoid the misunderstandings in 78b0f61.

prestonvasquez · 2025-12-01T20:18:31Z

internal/integration/search_index_test.go

+	"go.mongodb.org/mongo-driver/v2/x/bsonx/bsoncore"
+)
+
+func TestSearchIndex(t *testing.T) {


[Blocking] We should roll this test into TestSearchIndexProse and open a DRIVERS ticket to extend the Search Index Management Helpers prose tests to include this gap case:

#### Case 9: Drivers use server default for unspecified name (`default`) and type (`search`)

prestonvasquez · 2025-12-01T21:28:55Z

internal/integration/search_index_test.go

+	opts := options.Client().ApplyURI(uri).SetTimeout(timeout)
+	mt := mtest.New(t, mtest.NewOptions().ClientOptions(opts).MinServerVersion("7.0").Topologies(mtest.ReplicaSet))
+
+	mt.Run("search indexes with empty option", func(mt *mtest.T) {


[blocking] The prose test should ensure that not specifying the name and type when creating a search index will result in the name being "default" and the type being "search". See this test for example: https://github.com/prestonvasquez/go-playground/blob/827f1733956815d63bf6de702384c59c89a868f1/mgd_search_index_test.go#L17

👍 Good point! Filed a DRIVERS ticket and a PR.

prestonvasquez · 2025-12-02T01:28:28Z

@qingyang-hu Should this PR be targeting release/2.4?

prestonvasquez · 2025-12-02T19:06:05Z

.evergreen/config.yml

+          working_dir: src/go.mongodb.org/mongo-driver
+          shell: bash
+          script: |-
+            echo "SEARCH_INDEX_URI: ${MONGODB_URI}" > atlas-expansion.yml


It seems that TestSearchIndexProse passes under the current TEST_SEARCH_INDEX paradigm, given the example you shared. So why do we need to add the SEARCH_INDEX_URI changes?

prestonvasquez · 2025-12-02T19:08:13Z

internal/integration/search_index_prose_test.go

+		require.Equal(mt, "default", indexName)
+
+		var doc bson.Raw
+		for doc == nil {


This will run for the 10 minute default testing timeout. Suggest defining a context with a timeout to pass to view.List(). I'm not sure what a good value would be. Perhaps 1 minute?

Taskfile.yml

internal/integration/search_index_prose_test.go

prestonvasquez

LGTM 👍

) Co-authored-by: Preston Vasquez <[email protected]>

github-actions bot added the review-priority-normal Medium Priority PR for Review: within 1 business day label Nov 26, 2025

qingyang-hu force-pushed the godriver3704 branch 5 times, most recently from 1c96085 to ee65456 Compare November 26, 2025 23:07

qingyang-hu added the bug label Nov 26, 2025

qingyang-hu force-pushed the godriver3704 branch from ee65456 to 86957b1 Compare November 26, 2025 23:34

qingyang-hu commented Nov 26, 2025

View reviewed changes

qingyang-hu requested a review from prestonvasquez November 26, 2025 23:55

qingyang-hu marked this pull request as ready for review November 26, 2025 23:55

qingyang-hu requested a review from a team as a code owner November 26, 2025 23:55

Copilot AI review requested due to automatic review settings November 26, 2025 23:55

Copilot started reviewing on behalf of qingyang-hu November 26, 2025 23:55 View session

Copilot finished reviewing on behalf of qingyang-hu November 26, 2025 23:57

Copilot AI reviewed Nov 26, 2025

View reviewed changes

qingyang-hu marked this pull request as draft December 1, 2025 14:54

qingyang-hu force-pushed the godriver3704 branch from 58bc4c2 to 1373cf2 Compare December 1, 2025 16:25

qingyang-hu marked this pull request as ready for review December 1, 2025 16:26

prestonvasquez requested changes Dec 1, 2025

View reviewed changes

qingyang-hu force-pushed the godriver3704 branch from d3ab891 to 5b8e7cc Compare December 2, 2025 00:54

qingyang-hu changed the base branch from master to release/2.4 December 2, 2025 02:49

qingyang-hu added 2 commits December 1, 2025 22:34

Fix search index failure on empty "Options"

d67a451

update prose test

a2fb993

qingyang-hu force-pushed the godriver3704 branch from 5b8e7cc to a2fb993 Compare December 2, 2025 03:37

qingyang-hu requested a review from prestonvasquez December 2, 2025 16:40

prestonvasquez requested changes Dec 2, 2025

View reviewed changes

update view.List() context in prose tests

8b7ac2b

qingyang-hu requested a review from prestonvasquez December 3, 2025 15:06

prestonvasquez requested changes Dec 4, 2025

View reviewed changes

Taskfile.yml Outdated Show resolved Hide resolved

internal/integration/search_index_prose_test.go Outdated Show resolved Hide resolved

Parametrize search index prose test mongodb#9 for nil and empty options

0508d4b

prestonvasquez approved these changes Dec 6, 2025

View reviewed changes

qingyang-hu merged commit c3077a1 into mongodb:release/2.4 Dec 6, 2025
33 of 35 checks passed

mongodb-drivers-pr-bot bot mentioned this pull request Dec 6, 2025

Merge release/2.4 into master #2259

Merged

qingyang-hu added a commit to qingyang-hu/mongo-go-driver that referenced this pull request Dec 11, 2025

GODRIVER-3704 Fix search index failure on empty "Options". (mongodb#2247

1120712

) Co-authored-by: Preston Vasquez <[email protected]>

GODRIVER-3704 Fix search index failure on empty "Options". #2247

GODRIVER-3704 Fix search index failure on empty "Options". #2247

Conversation

qingyang-hu commented Nov 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Background & Motivation

Uh oh!

mongodb-drivers-pr-bot bot commented Nov 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🧪 Performance Results

Uh oh!

mongodb-drivers-pr-bot bot commented Nov 26, 2025

API Change Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

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

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

prestonvasquez commented Dec 2, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

prestonvasquez left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

qingyang-hu commented Nov 26, 2025 •

edited

Loading

mongodb-drivers-pr-bot bot commented Nov 26, 2025 •

edited

Loading

prestonvasquez Dec 1, 2025 •

edited

Loading

prestonvasquez Dec 1, 2025 •

edited

Loading

prestonvasquez Dec 1, 2025 •

edited

Loading