Create a `TypeRegistry` and enable injection of `Type` instances by GromNaN · Pull Request #2966 · doctrine/mongodb-odm

GromNaN · 2025-12-10T00:28:13Z

Q	A
Type	feature
BC Break	no (deprecation)
Fixed issues	Closes #2818

Summary

Introduce a new class TypeRegistry that replace the static method of the Type class. The name is the same as DBAL TypeRegistry, with the same methods (except override because register creates or replace the type, "upsert" is a MongoDB specificity 😉)
Deprecate all the static methods of the Type class
Inject the TypeRegistry into the Configuration and add the public method getTypeRegistry(). This method is used by UnitOfWork, DocumentPersister and the aggregation builder.
Inject the TypeRegistry into ClassMetadata instances.

The Bundle PR: doctrine/DoctrineMongoDBBundle#963

Copilot

Pull request overview

This PR introduces a new TypeRegistry class to manage type instances and enables dependency injection of Type instances, deprecating the static methods on the Type class. This architectural change improves testability and allows for better isolation of type registries per DocumentManager.

Key changes include:

Creating TypeRegistry to replace static Type methods
Injecting TypeRegistry into DocumentManager and ClassMetadata
Deprecating all static methods on the Type class

Reviewed changes

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

Show a summary per file

File	Description
src/Types/TypeRegistry.php	New class implementing type registration and retrieval
src/Types/Type.php	Static methods deprecated in favor of TypeRegistry
src/DocumentManager.php	Integration of TypeRegistry with initialization logic
src/Mapping/ClassMetadata.php	TypeRegistry injection and usage for type operations
src/UnitOfWork.php	Updated to use DocumentManager's TypeRegistry
src/Persisters/*.php	Updated to use DocumentManager's TypeRegistry
src/Hydrator/HydratorFactory.php	Updated to use DocumentManager's TypeRegistry
src/Aggregation/*.php	Updated to use DocumentManager's TypeRegistry
tests/Tests/Types/TypeRegistryTest.php	New test coverage for TypeRegistry
tests/Tests/Types/TypeTest.php	Updated tests for deprecated Type methods
tests/Tests/CaptureDeprecationMessages.php	New trait for capturing deprecation messages in tests
tests/*/Test.php	Test files updated to use TypeRegistry

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

alcaeus

Initial review done. I like the idea of a type registry, but it once again shows that we really need to clean up the dependency mess that we currently have.
The only concern I have is exposing the convertToDatabase method from DocumentPersister. I think we should mark it as @internal to ensure people don't treat it as part of the public API (unless the whole persister is already marked as such).

greg0ire · 2025-12-12T16:10:32Z

+/**
+ * The TypeRegistry is responsible for managing the mapping types supported.
+ */
+class TypeRegistry


Should it be final?

Then I would have to create an interface since it's not internal. Which is more strict for BC than a regular class.

Then I would have to create an interface since it's not internal.

Do you? Is every type supposed to be replacable/mockable? I think it's OK to marks something as final and postpone the decision of making it extensible vs having an interface to when a need for extensibility actually emerges. For something that looks like an map with extra methods, I'm not convinced extensibility is needed.

Feel free to ignore this if you have a hard rule about this in this project.

Agree with making it final. We don't need to mock it for internal tests (yet), and people should definitely be mocking it for their own tests considering it's a registry they can create and inject as they see fit. We can always make the class non-final in a future minor release if necessary.

I've already a use-case for extending the TypeRegistry: in the bundle I add lazy-loading of type instances from the container: https://github.com/doctrine/DoctrineMongoDBBundle/pull/963/changes#diff-b090a1e775d0625ed9280a9140328e118d6ad52fafb71464bf7246ac937e8442

greg0ire · 2025-12-12T16:36:27Z

Some commits look like they should be squashed together.

GromNaN · 2025-12-12T16:53:27Z

Some commits look like they should be squashed together.

Yes, my plan was to have 2 separate commits to ease with rebase and merges, but the implementation changed a lot and that will not help anymore. I'll squash-merge the PR as we usually do on the MongoDB-ODM project.

alcaeus

Code LGTM. Do you want to add the deprecations to the UPGRADE document now or do we do that in the 3.0.x branch when we remove deprecated functionality?

Enable having a distinct list of types for each instance of DocumentManager in 3.0 Enable injecting type instances constructed with parameters, which is necessary for generic embedded object transformations.

MongoDB has 1 ms of precision, we use UTCDateTime object to normalize the timezone and skip the microseconds

…in the bundle

- Fix DocumentPersister::prepareShardKeyQuery() passing $mapping['name'] (DB field name) to getFieldType() which expects the PHP property name; use $mapping['fieldName'] instead, consistent with all other call sites - Move TypeRegistry upgrade instructions from UPGRADE-2.16.md to the new UPGRADE-2.17.md, and fix method names in the migration table (get/has/register/getMap instead of the old static method names)

Covers the bug where getFieldType() received the DB field name ($mapping['name']) instead of the PHP property name ($mapping['fieldName']), causing type conversion to be skipped when the two names differ.

Direct deserialization of ClassMetadata has never been supported, as the factory is responsible for restoring runtime dependencies after cache hits.

…structors Replace method_exists() check (which incorrectly blocked types inheriting a no-arg constructor from a parent) with a try/catch on instantiation. This correctly rejects only classes whose constructor has required parameters, and as a bonus caches the created instance so get() never re-instantiates.

GromNaN requested a review from Copilot December 10, 2025 00:28

GromNaN added the Feature label Dec 10, 2025

Copilot AI reviewed Dec 10, 2025

View reviewed changes

Comment thread tests/Tests/Types/TypeTest.php

Comment thread src/Mapping/ClassMetadata.php Outdated

Comment thread src/DocumentManager.php Outdated

Comment thread src/Persisters/DocumentPersister.php

GromNaN commented Dec 10, 2025

View reviewed changes

Comment thread src/DocumentManager.php Outdated

GromNaN mentioned this pull request Dec 10, 2025

Enable service injection for custom field types and #[AsFieldType] attribute doctrine/DoctrineMongoDBBundle#963

Open

GromNaN force-pushed the 2-type-registry branch from 0375c36 to 232d674 Compare December 10, 2025 06:54

GromNaN mentioned this pull request Dec 10, 2025

Extract the static methods of the Type class into a TypeRegistry service #2818

Open

3 tasks

GromNaN requested review from IonBazan, SenseException, alcaeus, franmomu, jmikola and morozov December 10, 2025 14:15

GromNaN force-pushed the 2-type-registry branch from 232d674 to afd974b Compare December 11, 2025 12:07

GromNaN requested a review from greg0ire December 11, 2025 12:07

alcaeus reviewed Dec 12, 2025

View reviewed changes

GromNaN force-pushed the 2-type-registry branch from afd974b to bba03d6 Compare December 12, 2025 12:55

greg0ire reviewed Dec 12, 2025

View reviewed changes

greg0ire approved these changes Dec 12, 2025

View reviewed changes

GromNaN force-pushed the 2-type-registry branch from 5391b88 to 271963e Compare December 13, 2025 01:14

SenseException approved these changes Dec 13, 2025

View reviewed changes

alcaeus reviewed Dec 16, 2025

View reviewed changes

GromNaN force-pushed the 2-type-registry branch from f06db9a to 6c01907 Compare January 12, 2026 22:04

GromNaN changed the base branch from 2.16.x to 2.17.x March 28, 2026 23:08

GromNaN added 4 commits March 29, 2026 00:30

Replace Type static functions with an instance of TypeRegistry

c4fb9d5

Enable having a distinct list of types for each instance of DocumentManager in 3.0 Enable injecting type instances constructed with parameters, which is necessary for generic embedded object transformations.

Trigger deprecations in legacy Type static methods

c2b7acc

Inject the TypeRegistry into ClassMetadata

2e4d772

Enable injection of Type instance into the TypeRegistry

60ada27

GromNaN added 18 commits March 29, 2026 00:30

Use a shared instance of TypeRegistry by default when none is injected

17ebe98

Update docs

f828199

Update the documentation

07c80d1

Forbids the injection of a type per class name if it has a constructor

fdeb1b0

Rename TypeRegistry::guessTypeFromValue

b1af7a1

Validate the registered class in TypeRegistry

bc45067

Uptimize Date compaison in UOW::computeOrRecomputeChangeSet

c7c948e

MongoDB has 1 ms of precision, we use UTCDateTime object to normalize the timezone and skip the microseconds

Move TypeRegistry to the Configuration class

cdfd2b9

Create TypeRegistry when the DM is not used

3540c7d

Revert date comparison to use field type from ClassMetadata

b12763c

Make TypeRegistry::getMap non-internal, so that it can be overridden …

a812ab8

…in the bundle

Add upgrade instructions

9bb562c

Fix CS

2b6ef1d

Add test for shard key with custom DB field name

8f2aa7f

Covers the bug where getFieldType() received the DB field name ($mapping['name']) instead of the PHP property name ($mapping['fieldName']), causing type conversion to be skipped when the two names differ.

Document that ClassMetadata must be loaded through ClassMetadataFactory

4e4cd91

Direct deserialization of ClassMetadata has never been supported, as the factory is responsible for restoring runtime dependencies after cache hits.

Add test for Configuration::setTypeRegistry() immutability

358c27f

GromNaN force-pushed the 2-type-registry branch from 1cb302e to 358c27f Compare March 28, 2026 23:30

Fix version in deprecation messages

7b9d4e5

GromNaN mentioned this pull request Mar 29, 2026

Add TypeRegistry to Configuration and use it in all internal type resolution doctrine/dbal#7342

Open

GromNaN mentioned this pull request Apr 17, 2026

[RFC] Plan for MongoDB ODM v3 #2762

Open

17 tasks

Uh oh!

Conversation

GromNaN commented Dec 10, 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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

alcaeus left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

greg0ire Dec 12, 2025

Choose a reason for hiding this comment

Uh oh!

GromNaN Dec 12, 2025

Choose a reason for hiding this comment

Uh oh!

greg0ire Dec 12, 2025

Choose a reason for hiding this comment

Uh oh!

alcaeus Dec 16, 2025

Choose a reason for hiding this comment

Uh oh!

GromNaN Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

greg0ire commented Dec 12, 2025

Uh oh!

GromNaN commented Dec 12, 2025

Uh oh!

alcaeus left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

GromNaN commented Dec 10, 2025 •

edited

Loading