Method getLockVersion of ModelManager does not return correct value

[ZZromanZZ]

Environment

Sonata packages

show

$ composer show --latest 'sonata-project/*'
Direct dependencies required in composer.json:
sonata-project/admin-bundle              4.25.0 4.26.0 The missing Symfony Admin Generator
sonata-project/doctrine-orm-admin-bundle 4.13.0 4.13.0 Integrate Doctrine ORM into the SonataAdminBundle
sonata-project/exporter                  2.14.0 3.2.0  Lightweight Exporter library

Transitive dependencies not required in composer.json:
sonata-project/block-bundle              4.21.0 5.0.1  Symfony SonataBlockBundle
sonata-project/cache                     2.2.0  2.2.0  Cache library
Package sonata-project/cache is abandoned, you should avoid using it. No replacement was suggested.
sonata-project/doctrine-extensions       2.3.0  2.3.0  Doctrine2 behavioral extensions
sonata-project/form-extensions           1.19.1 2.0.0  Symfony form extensions
sonata-project/twig-extensions           2.1.0  2.3.0  Sonata twig extensions

Symfony packages

show

$ composer show --latest 'symfony/*'
Direct dependencies required in composer.json:
symfony/asset                      v5.4.21 v6.3.0  Manages URL generation and versioning of web assets such as CSS stylesheets, JavaScript files and image files
symfony/browser-kit                v5.4.21 v6.3.2  Simulates the behavior of a web browser, allowing you to make requests, click on links and submit forms programmatically
symfony/console                    v5.4.24 v6.3.2  Eases the creation of beautiful and testable command line interfaces
symfony/css-selector               v5.4.21 v6.3.2  Converts CSS selectors to XPath expressions
symfony/debug-bundle               v5.4.21 v6.3.2  Provides a tight integration of the Symfony VarDumper component and the ServerLogCommand from MonologBridge into the Symfony full-stack framework
symfony/dotenv                     v5.4.22 v6.3.0  Registers environment variables from a .env file
symfony/expression-language        v5.4.21 v6.3.0  Provides an engine that can compile and evaluate expressions
symfony/flex                       v1.20.0 v2.3.3  Composer plugin for Symfony
symfony/form                       v5.4.24 v6.3.2  Allows to easily create, process and reuse HTML forms
symfony/framework-bundle           v5.4.24 v6.3.2  Provides a tight integration between Symfony components and the Symfony full-stack framework
symfony/http-client                v5.4.24 v6.3.2  Provides powerful methods to fetch HTTP resources synchronously or asynchronously
symfony/intl                       v5.4.23 v6.3.2  Provides a PHP replacement layer for the C intl extension that includes additional data from the ICU library
symfony/mailer                     v5.4.22 v6.3.0  Helps sending emails
symfony/maker-bundle               v1.49.0 v1.50.0 Symfony Maker helps you create empty commands, controllers, form classes, tests and more so you can forget about writing boilerplate code.
symfony/messenger                  v5.4.24 v6.3.3  Helps applications send and receive messages to/from other applications or via message queues
symfony/monolog-bundle             v3.8.0  v3.8.0  Symfony MonologBundle
symfony/notifier                   v5.4.22 v6.3.0  Sends notifications via one or more channels (email, SMS, ...)
symfony/phpunit-bridge             v5.4.23 v6.3.2  Provides utilities for PHPUnit, especially user deprecation notices management
symfony/process                    v5.4.24 v6.3.2  Executes commands in sub-processes
symfony/property-access            v5.4.22 v6.3.2  Provides functions to read and write from/to an object or array using a simple string notation
symfony/property-info              v5.4.24 v6.3.0  Extracts information about PHP class' properties using metadata of popular sources
symfony/proxy-manager-bridge       v5.4.21 v6.3.0  Provides integration for ProxyManager with various Symfony components
symfony/runtime                    v5.4.22 v6.3.2  Enables decoupling PHP applications from global state
symfony/security-bundle            v5.4.22 v6.3.3  Provides a tight integration of the Security component into the Symfony full-stack framework
symfony/serializer                 v5.4.24 v6.3.3  Handles serializing and deserializing data structures, including object graphs, into array structures or other formats like XML and JSON.
symfony/stopwatch                  v5.4.21 v6.3.0  Provides a way to profile code
symfony/translation                v5.4.24 v6.3.3  Provides tools to internationalize your application
symfony/twig-bundle                v5.4.21 v6.3.0  Provides a tight integration of Twig into the Symfony full-stack framework
symfony/uid                        v5.4.21 v6.3.0  Provides an object-oriented API to generate and represent UIDs
symfony/validator                  v5.4.24 v6.3.2  Provides tools to validate values
symfony/var-dumper                 v5.4.24 v6.3.3  Provides mechanisms for walking through any arbitrary PHP variable
symfony/web-link                   v5.4.21 v6.3.0  Manages links between resources
symfony/web-profiler-bundle        v5.4.24 v6.3.2  Provides a development tool that gives detailed information about the execution of any request
symfony/webpack-encore-bundle      v1.17.1 v2.0.1  Integration with your Symfony app & Webpack Encore!
symfony/yaml                       v5.4.23 v6.3.3  Loads and dumps YAML files

Transitive dependencies not required in composer.json:
symfony/amqp-messenger             v5.4.22 v6.3.0  Symfony AMQP extension Messenger Bridge
symfony/cache                      v5.4.23 v6.3.2  Provides extended PSR-6, PSR-16 (and tags) implementations
symfony/cache-contracts            v2.5.2  v3.3.0  Generic abstractions related to caching
symfony/config                     v5.4.21 v6.3.2  Helps you find, load, combine, autofill and validate configuration values of any kind
symfony/dependency-injection       v5.4.24 v6.3.2  Allows you to standardize and centralize the way objects are constructed in your application
symfony/deprecation-contracts      v3.3.0  v3.3.0  A generic function and convention to trigger deprecation notices
symfony/doctrine-bridge            v5.4.24 v6.3.2  Provides integration for Doctrine with various Symfony components
symfony/doctrine-messenger         v5.4.23 v6.3.1  Symfony Doctrine Messenger Bridge
symfony/dom-crawler                v5.4.23 v6.3.1  Eases DOM navigation for HTML and XML documents
symfony/error-handler              v5.4.24 v6.3.2  Provides tools to manage errors and ease debugging PHP code
symfony/event-dispatcher           v5.4.22 v6.3.2  Provides tools that allow your application components to communicate with each other by dispatching events and listening to them
symfony/event-dispatcher-contracts v3.3.0  v3.3.0  Generic abstractions related to dispatching event
symfony/filesystem                 v5.4.23 v6.3.1  Provides basic utilities for the filesystem
symfony/finder                     v5.4.21 v6.3.3  Finds files and directories via an intuitive fluent interface
symfony/http-client-contracts      v2.5.2  v3.3.0  Generic abstractions related to HTTP clients
symfony/http-foundation            v5.4.24 v6.3.2  Defines an object-oriented layer for the HTTP specification
symfony/http-kernel                v5.4.24 v6.3.3  Provides a structured process for converting a Request into a Response
symfony/lock                       v5.4.22 v6.3.2  Creates and manages locks, a mechanism to provide exclusive access to a shared resource
symfony/mime                       v5.4.23 v6.3.3  Allows manipulating MIME messages
symfony/monolog-bridge             v5.4.22 v6.3.1  Provides integration for Monolog with various Symfony components
symfony/options-resolver           v5.4.21 v6.3.0  Provides an improved replacement for the array_replace PHP function
symfony/password-hasher            v5.4.21 v6.3.0  Provides password hashing utilities
symfony/polyfill-intl-grapheme     v1.27.0 v1.27.0 Symfony polyfill for intl's grapheme_* functions
symfony/polyfill-intl-icu          v1.27.0 v1.27.0 Symfony polyfill for intl's ICU-related data and classes
symfony/polyfill-intl-idn          v1.27.0 v1.27.0 Symfony polyfill for intl's idn_to_ascii and idn_to_utf8 functions
symfony/polyfill-intl-normalizer   v1.27.0 v1.27.0 Symfony polyfill for intl's Normalizer class and related functions
symfony/polyfill-mbstring          v1.27.0 v1.27.0 Symfony polyfill for the Mbstring extension
symfony/polyfill-uuid              v1.27.0 v1.27.0 Symfony polyfill for uuid functions
symfony/psr-http-message-bridge    v2.2.0  v2.3.1  PSR HTTP message bridge
symfony/redis-messenger            v5.4.23 v6.3.2  Symfony Redis extension Messenger Bridge
symfony/routing                    v5.4.22 v6.3.3  Maps an HTTP request to a set of configuration variables
symfony/security-acl               v3.3.2  v3.3.2  Symfony Security Component - ACL (Access Control List)
symfony/security-core              v5.4.22 v6.3.3  Symfony Security Component - Core Library
symfony/security-csrf              v5.4.21 v6.3.2  Symfony Security Component - CSRF Library
symfony/security-guard             v5.4.22 v5.4.27 Symfony Security Component - Guard
symfony/security-http              v5.4.23 v6.3.2  Symfony Security Component - HTTP Integration
symfony/service-contracts          v2.5.2  v3.3.0  Generic abstractions related to writing services
symfony/string                     v5.4.22 v6.3.2  Provides an object-oriented API to strings and deals with bytes, UTF-8 code points and grapheme clusters in a unified way
symfony/translation-contracts      v2.5.2  v3.3.0  Generic abstractions related to translation
symfony/twig-bridge                v5.4.22 v6.3.2  Provides integration for Twig with various Symfony components
symfony/var-exporter               v6.3.0  v6.3.2  Allows exporting any serializable PHP data structure to plain PHP code

PHP version

$ php -v
PHP 8.1.16 (cli) (built: Feb 16 2023 01:31:00) (NTS)
Copyright (c) The PHP Group
Zend Engine v4.1.16, Copyright (c) Zend Technologies
    with Zend OPcache v8.1.16, Copyright (c), by Zend Technologies

Subject

When editing entity via form with version property (and optimistic locking enabled), false-positive flash message "Another user has modifed item ..." occurs.

After small investigation, I noticed:

• to build hidden form input with entity version, method getLockVersion() of ModelManager accesses version field via reflection
• in this moment, entity is not yet initialized and its default value is 0
• 0 is passed to hidden input and after submit lock version check fails

Quicky and dirty workaround is to call getter of your version field to begin of configureFormMapper() method to initialize entity from database:

protected function configureFormFields(FormMapper $formMapper): void
{
    $this->getSubject()->getVersion(); // depends on name of your version field
    ...
}

In situations when entity is for some reason already initialized in method configureFormFields(), of course, this is not the case.

Minimal repository with the bug

Steps to reproduce

Expected results

Actual results

[VincentLanglet]

I never used this feature, but what is wrong with the current implementation:

SonataDoctrineORMAdminBundle/src/Model/ModelManager.php

Lines 122 to 131 in 258ba41

	public function getLockVersion(object $object)
	{
	$metadata = $this->getMetadata($object::class);
	if (!$metadata->isVersioned || !isset($metadata->reflFields[$metadata->versionField])) {
	return null;
	}
	return $metadata->reflFields[$metadata->versionField]->getValue($object);
	}

?

[ZZromanZZ]

Can this be conceptual problem ? Accessing version field via reflection bypasses Doctrine proxy classes and does not trigger initiation. What was the point behind reflection anyway?

[VincentLanglet]

No idea, it was implemented long time ago #478

Do you have another implementation in mind ?

[ZZromanZZ]

Another implementation in my mind is accessing version field directly. Of course, we cannot call getter like bellow, and we should access via some property accessor probably

public function getLockVersion(object $object)
{
    $metadata = $this->getMetadata($object::class);

    if (!$metadata->isVersioned) {
        return null;
    }

    return $object->{'get' . ucfirst($metadata->versionField)}(); // some property accessor should be used here
}

And from another point of view, I am not currently sure why this issue is happening only for some versioned entities. Meaning, some my entities are not initialized when configureFormFields() takes place and some are. When they are initialized, everything works flawlessly

[ZZromanZZ]

IMHO, I think get locking version should be transparent and shoudn't bypass Doctrine proxy classes, I currently see no reason for this.

[VincentLanglet]

You can try a PR with PropertyAccessor.

But maybe Doctrine has a better way to do this, since lock is a "doctrine feature"

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.