Add test on Atlas Search features using an MongoDB Atlas Local Docker #2829

GromNaN · 2025-09-23T13:28:50Z

Q	A
Type	improvement
BC Break	no
Fixed issues	PHPORM-390

Summary

Run Atlas tests with MongoDB Atlas Local
Add integration test for Vector Search
Add integration test for Search

The configureFailPoint command is not available in Atlas Local. I mark the tests as skipped instead of adding a group to exclude them from atlas.

Copilot

Pull Request Overview

This PR adds Atlas Search feature testing using MongoDB Atlas Local Docker, enabling automated testing of vector search and text search functionality that previously required a full Atlas cluster.

Implements Atlas Local testing infrastructure for search features
Adds comprehensive vector search and text search integration tests
Refactors fail point testing to use a shared helper method

Reviewed Changes

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

Show a summary per file

File	Description
tests/Doctrine/ODM/MongoDB/Tests/Functional/VectorSearchTest.php	New test suite for Atlas Vector Search functionality
tests/Doctrine/ODM/MongoDB/Tests/Functional/AtlasSearchTest.php	New test suite for Atlas text search features
tests/Doctrine/ODM/MongoDB/Tests/BaseTestCase.php	Centralizes fail point testing with shared helper method
lib/Doctrine/ODM/MongoDB/Mapping/ClassMetadata.php	Fixes vector similarity constant value
.github/workflows/atlas-ci.yml	New CI workflow for Atlas Local testing
docker-compose.yaml	Docker configuration for Atlas Local container
.github/workflows/continuous-integration.yml	Excludes atlas tests from regular CI

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-09-23T21:07:39Z

lib/Doctrine/ODM/MongoDB/Mapping/ClassMetadata.php

    public const VECTOR_SIMILARITY_EUCLIDEAN   = 'euclidean';
    public const VECTOR_SIMILARITY_COSINE      = 'cosine';
-    public const VECTOR_SIMILARITY_DOT_PRODUCT = 'dot_product';
+    public const VECTOR_SIMILARITY_DOT_PRODUCT = 'dotProduct';


The constant value was changed from 'dot_product' to 'dotProduct'. This could be a breaking change if existing code relies on the snake_case format. Please verify this matches the expected MongoDB Atlas format and ensure backward compatibility is maintained.

Suggested change

public const VECTOR_SIMILARITY_DOT_PRODUCT = 'dotProduct';

public const VECTOR_SIMILARITY_DOT_PRODUCT = 'dotProduct';

public const VECTOR_SIMILARITY_DOT_PRODUCT_SNAKE_CASE = 'dot_product';

@GromNaN was this not actually a BC break because the constant was introduced in 9a0e994. Here, it looks like you're making the value consistent with what you already had in the documentation from the earlier commit.

Feel free to respond and resolve. I just wanted to confirm.

This code is not released yet. This is a bug fix as dotProduct is the value expected by MongoDB: https://www.mongodb.com/docs/php-library/current/indexes/atlas-search-index/#create-a-search-index

.github/workflows/atlas-ci.yml

tests/Doctrine/ODM/MongoDB/Tests/BaseTestCase.php

GromNaN · 2025-09-24T15:59:51Z

tests/Doctrine/ODM/MongoDB/Tests/Functional/AtlasSearchTest.php

+        // Wait for the search index to be ready (Atlas Local needs time to build the index)
+        sleep(2);


This could be smarter with a method that detect when the indexes are ready: #2830

jmikola

LGTM. I just have some questions but I don't they will warrant further changes.

jmikola · 2025-09-24T19:24:02Z

lib/Doctrine/ODM/MongoDB/Mapping/ClassMetadata.php

    public const VECTOR_SIMILARITY_EUCLIDEAN   = 'euclidean';
    public const VECTOR_SIMILARITY_COSINE      = 'cosine';
-    public const VECTOR_SIMILARITY_DOT_PRODUCT = 'dot_product';
+    public const VECTOR_SIMILARITY_DOT_PRODUCT = 'dotProduct';


@GromNaN was this not actually a BC break because the constant was introduced in 9a0e994. Here, it looks like you're making the value consistent with what you already had in the documentation from the earlier commit.

Feel free to respond and resolve. I just wanted to confirm.

jmikola · 2025-09-24T19:25:39Z

.github/workflows/continuous-integration.yml


      - name: "Run PHPUnit"
-        run: "vendor/bin/phpunit"
+        run: "vendor/bin/phpunit --exclude-group=atlas"


Noted that this will skip the tests with sleep(2).

jmikola · 2025-09-24T19:28:09Z

.github/workflows/atlas-ci.yml

+          composer-options: "--prefer-dist"
+
+      - name: "Run PHPUnit with Atlas Local"
+        run: "vendor/bin/phpunit"


Noted that this will run the entire test suite with Atlas Local. How do you intend to trigger the atlas-ci.yml jobs? Presumably we don't need this entire matrix run on each PR. Would it make more sense to initially restrict test execution to the "atlas" group to compensate for the tests that will be exluded by continuous-integration.yml?

My goal was to run all the tests with Atlas, but that's not possible due to the lack of support of failPoints. So I simplified the test matrix for Atlas.

jmikola · 2025-09-24T19:30:11Z

tests/Doctrine/ODM/MongoDB/Tests/BaseTestCase.php

        return $manager->selectServer()->getType() !== Server::TYPE_STANDALONE;
    }
+
+    protected function createFailPoint(string $failCommand, bool $transient = false, int $times = 1): void


This looks like it was adapted from what we have in PHPLIB, although this method is only useful for the failCommand fail point. That assumption also exists in the tearDown() method.

Just wanted to confirm that this is perfectly suitable for ODM's present needs. In the future, you may want to make this more consistent with PHPLIB's implementation, though.

I forgot about the PHPLIB implementation, this is definitely a simpler approach as we only need to add 1 fail point at a time.

jmikola · 2025-09-24T19:31:17Z

tests/Doctrine/ODM/MongoDB/Tests/UnitOfWorkTransactionalCommitConsistencyTest.php

        $this->uow->persist($friendUser);

-        $this->createFatalFailPoint('insert');
+        $this->createFailPoint('insert');


Noted that createFatalFailPoint and createTransientFailPoint only differ by way of the "TransientTransactionError" error label.

Yes, that's why I added the $transient parameter.

Add GitHub workflow to run Atlas tests

fb5fa0e

GromNaN added this to the 2.13.0 milestone Sep 23, 2025

GromNaN added the Enhancement label Sep 23, 2025

GromNaN added 2 commits September 23, 2025 21:28

Add integration test with vector search

c700b12

Skip tests with failPoint when the server does not provide this feature

9c0ca9f

GromNaN force-pushed the PHPORM-390 branch from 479a9de to 9c0ca9f Compare September 23, 2025 19:48

GromNaN added 2 commits September 23, 2025 22:52

Add integration test for Atlas Search

f38d8cd

Revert QE check

b807b27

GromNaN force-pushed the PHPORM-390 branch from e55b5ae to b807b27 Compare September 23, 2025 21:06

GromNaN requested a review from Copilot September 23, 2025 21:06

Copilot AI reviewed Sep 23, 2025

View reviewed changes

GromNaN requested review from jmikola and paulinevos September 24, 2025 10:50

Fix php-version in the ci matrix and add doc for error code 59

6468e2e

GromNaN force-pushed the PHPORM-390 branch from a509c9e to 6468e2e Compare September 24, 2025 10:53

GromNaN commented Sep 24, 2025

View reviewed changes

GromNaN mentioned this pull request Sep 24, 2025

Prepare field names for search indexes and vector search indexes #2831

Merged

3 tasks

jmikola approved these changes Sep 24, 2025

View reviewed changes

Reduce test matrix and coverage with Atlas

f3bb712

GromNaN force-pushed the PHPORM-390 branch from c9c13cf to f3bb712 Compare September 25, 2025 12:26

GromNaN merged commit 3dfba27 into doctrine:2.13.x Sep 25, 2025
22 of 23 checks passed

GromNaN deleted the PHPORM-390 branch September 25, 2025 13:26

github-actions bot mentioned this pull request Oct 20, 2025

Merge release 2.13.0 into 3.0.x #2863

Merged

	public const VECTOR_SIMILARITY_DOT_PRODUCT = 'dotProduct';
	public const VECTOR_SIMILARITY_DOT_PRODUCT = 'dotProduct';
	public const VECTOR_SIMILARITY_DOT_PRODUCT_SNAKE_CASE = 'dot_product';

		// Wait for the search index to be ready (Atlas Local needs time to build the index)
		sleep(2);

Uh oh!

Uh oh!

Add test on Atlas Search features using an MongoDB Atlas Local Docker #2829

Add test on Atlas Search features using an MongoDB Atlas Local Docker #2829

Uh oh!

Conversation

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

Uh oh!

Summary

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Sep 23, 2025

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!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jmikola left a comment

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!

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!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

GromNaN commented Sep 23, 2025 •

edited

Loading