doc: Review and test validation cookbook #2662
Conversation
GromNaN
commented
Jun 28, 2024
GromNaN
commented
| Q | A |
|---|---|
| Type | improvement |
| BC Break | no |
| Fixed issues | - |
| Now validation is performed when you call ``DocumentManager#flush()`` and an | ||
| order is about to be inserted or updated. Any Exception that happens in the | ||
| lifecycle callbacks will stop the flush operation and the exception will be | ||
| propagated. | ||
|
|
||
| You might want to use the ``PrePersist`` instead of ``PreFlush`` to validate | ||
| the document sooner, when you call ``DocumentManager#persist()``. This way you | ||
| can catch validation errors earlier in your application flow. But be aware that | ||
| if the document is modified after the ``PrePersist`` event, the validation | ||
| might not be triggered again and an invalid document can be persisted. |
There was a problem hiding this comment.
I replaced PrePersist and PreUpdate by PreFlush, because the previous events were not equivalent (one is on persist, the other on flush): using preFlush, the validation is always done in the same step. It also removes a vulnerability in the validation if the document is updated after being persisted.
| @@ -181,44 +181,44 @@ the ``odm:schema:create`` or ``odm:schema:update`` command. | |||
| #[ODM\Document] | |||
| #[ODM\Validation( | |||
| validator: self::VALIDATOR, | |||
| action: ClassMetadata::SCHEMA_VALIDATION_ACTION_WARN, | |||
| level: ClassMetadata::SCHEMA_VALIDATION_LEVEL_MODERATE, | |||
| action: ClassMetadata::SCHEMA_VALIDATION_ACTION_ERROR, | |||
There was a problem hiding this comment.
Changing to throw an error. Reading the server logs is totally disconnected from the application code, a developer will prefer having an exception with the context and the stacktrace.
| @@ -1229,7 +1229,7 @@ for the related collection. | |||
| )] | |||
| class SchemaValidated | |||
| { | |||
| public const VALIDATOR = <<<'EOT' | |||
| private const VALIDATOR = <<<'EOT' | |||
There was a problem hiding this comment.
No need to use a public constant when it's read by the attribute on the class, that was required for the doctrine annotation.
| * | ||
| * @see https://www.mongodb.com/docs/manual/core/schema-validation/handle-invalid-documents/#option-2--allow-invalid-documents--but-record-them-in-the-log | ||
| */ | ||
| public const SCHEMA_VALIDATION_ACTION_WARN = 'warn'; |
There was a problem hiding this comment.
I only updated comments to have a better tooltip in the IDE. The constant definition haven't been modified.
|
|
||
| try { | ||
| $this->dm->persist($order1); | ||
| $this->dm->flush(); |
There was a problem hiding this comment.
The phpdoc for DocumentManager::flush() is incorrect as any exception can be thrown by lifecycle events.
mongodb-odm/lib/Doctrine/ODM/MongoDB/DocumentManager.php
Lines 577 to 579 in e40c8b1
There was a problem hiding this comment.
I updated the @throws annotation of DocumentManager::flush.
| @@ -128,11 +131,8 @@ can register multiple methods for validation in "PrePersist" or | |||
| "PreUpdate" or mix and share them in any combinations between those | |||
| two events. | |||
|
|
|||
| There is no limit to what you can and can't validate in | |||
| "PrePersist" and "PreUpdate" as long as you don't create new document | |||
| instances. This was already discussed in the previous blog post on | |||
There was a problem hiding this comment.
It seems that this cookbook was copied from a blog post.
Co-authored-by: Andreas Braun <git@alcaeus.org>
* 2.9.x: (24 commits) Fix typo in code example (#2670) Label PRs about GH actions with "CI" (#2632) Review basic mapping (#2668) Fix wording (#2667) Add native type to private properties and final classes (#2666) Review and add tests on `ResolveTargetDocumentListener` (#2660) Remove soft-delete-cookbook (#2657) doc: Remove wakeup and clone cookbook (#2663) Modernize generated code for Hydrators (#2665) Add tests for introduction (#2664) doc: Review mapping ORM and ODM cookbook (#2658) doc: Review cookbook on blending ORM and ODM (#2656) doc: Review and test validation cookbook (#2662) Update custom mapping example (#2654) doc: Review Simple Search Engine Cookbook (#2659) doc: Add cookbook about embedding referenced documents using $lookup (#2655) doc: Add type to properties (#2652) doc: Review custom collections and repository docs (#2653) doc: Review Getting Started (#2650) Move annotations-reference to attributes-reference (#2651) ...
