SecondCacheLevel association and inheritance update problem #5108

New Issue

Closed

opened 2026-01-22 14:58:28 +01:00 by admin · 11 comments

admin commented 2026-01-22 14:58:28 +01:00

Owner

Copy Link

Originally created by @mpoiriert on GitHub (Apr 19, 2016).

Originally assigned to: @lcobucci on GitHub.

I have a entities like this (I just document the minimum needed):

/**
 * @Entity
 * @Cache("NONSTRICT_READ_WRITE")
 * @DiscriminatorColumn(name="type", type="string")
 * @DiscriminatorMap({"child" = "ChildClass"})
 */
class BaseClass
{
}

/**
 * @Entity
 * @Cache("NONSTRICT_READ_WRITE")
 */
class ChildClass extends BaseClass
{
  /**
  * @Cache("NONSTRICT_READ_WRITE")
  */
  private $associations;
}

When changing the ChildClass->associations value and persisting it the data in the cache is not removed.

Investigating I found that the Doctrine\ORM\Cache\Persister\Entity\AbstractEntityPersister is using the entityName (that will be ChildClass) but that the Doctrine\ORM\Cache\Persister\Collection\NonStrictReadWriteCachedCollectionPersister is using the $this->sourceEntity->rootEntityName (that will be BaseClass) So it doesn't clear the proper key entry.

Pretty easy to change but might be risky...

If you consider that I am on the good track I can give it a try to make the unit test for it.

Originally created by @mpoiriert on GitHub (Apr 19, 2016). Originally assigned to: @lcobucci on GitHub. I have a entities like this (I just document the minimum needed): ``` php /** * @Entity * @Cache("NONSTRICT_READ_WRITE") * @DiscriminatorColumn(name="type", type="string") * @DiscriminatorMap({"child" = "ChildClass"}) */ class BaseClass { } /** * @Entity * @Cache("NONSTRICT_READ_WRITE") */ class ChildClass extends BaseClass { /** * @Cache("NONSTRICT_READ_WRITE") */ private $associations; } ``` When changing the ChildClass->associations value and persisting it the data in the cache is not removed. Investigating I found that the **Doctrine\ORM\Cache\Persister\Entity\AbstractEntityPersister** is using the **entityName** (that will be **ChildClass**) but that the **Doctrine\ORM\Cache\Persister\Collection\NonStrictReadWriteCachedCollectionPersister** is using the **$this->sourceEntity->rootEntityName** (that will be **BaseClass**) So it doesn't clear the proper key entry. Pretty easy to change but might be risky... If you consider that I am on the good track I can give it a try to make the unit test for it.

admin added the BugDuplicate labels 2026-01-22 14:58:28 +01:00

admin closed this issue 2026-01-22 14:58:28 +01:00

admin commented 2026-01-22 14:58:30 +01:00

Author

Owner

Copy Link

@Metabor commented on GitHub (May 9, 2016):

Looks for me similar to the problem reported here:
https://github.com/doctrine/doctrine2/issues/5562

@Metabor commented on GitHub (May 9, 2016): Looks for me similar to the problem reported here: https://github.com/doctrine/doctrine2/issues/5562

admin commented 2026-01-22 14:58:30 +01:00

Author

Owner

Copy Link

@mpoiriert commented on GitHub (May 9, 2016):

Yes i think the the problem is the same thing since both is related to inheritance and second level cache.

@mpoiriert commented on GitHub (May 9, 2016): Yes i think the the problem is the same thing since both is related to inheritance and second level cache.

admin commented 2026-01-22 14:58:30 +01:00

Author

Owner

Copy Link

@duytbp commented on GitHub (Sep 27, 2016):

Hi all, is there any update on this bug?

@duytbp commented on GitHub (Sep 27, 2016): Hi all, is there any update on this bug?

admin commented 2026-01-22 14:58:30 +01:00

Author

Owner

Copy Link

@lcobucci commented on GitHub (Sep 27, 2016):

I believe that #6028 fixes this.

@lcobucci commented on GitHub (Sep 27, 2016): I believe that #6028 fixes this.

admin commented 2026-01-22 14:58:30 +01:00

Author

Owner

Copy Link

@mpoiriert commented on GitHub (Sep 27, 2016):

No it doesn't

@mpoiriert commented on GitHub (Sep 27, 2016): No it doesn't

admin commented 2026-01-22 14:58:31 +01:00

Author

Owner

Copy Link

@lcobucci commented on GitHub (Sep 27, 2016):

@mpoiriert weird, what kind of associations do you have? I can investigate this today.

@lcobucci commented on GitHub (Sep 27, 2016): @mpoiriert weird, what kind of associations do you have? I can investigate this today.

admin commented 2026-01-22 14:58:34 +01:00

Author

Owner

Copy Link

@mpoiriert commented on GitHub (Nov 1, 2016):

Sorry for the delay really busy at the time.

This is the class override I have to fix the issue on my side

use Doctrine\ORM\Cache\CollectionCacheKey;
use Doctrine\ORM\PersistentCollection;

/**
 * This is to fix this bug:
 * @see https://github.com/doctrine/doctrine2/issues/5793
 */
class NonStrictReadWriteCachedCollectionPersister extends \Doctrine\ORM\Cache\Persister\Collection\NonStrictReadWriteCachedCollectionPersister
{
    /**
     * {@inheritdoc}
     */
    public function delete(PersistentCollection $collection)
    {
        $ownerId = $this->uow->getEntityIdentifier($collection->getOwner());
        $key     = new CollectionCacheKey($this->sourceEntity->name, $this->association['fieldName'], $ownerId);

        $this->persister->delete($collection);

        $this->queuedCache['delete'][spl_object_hash($collection)] = $key;
    }

    /**
     * {@inheritdoc}
     */
    public function update(PersistentCollection $collection)
    {
        $isInitialized = $collection->isInitialized();
        $isDirty       = $collection->isDirty();

        if ( ! $isInitialized && ! $isDirty) {
            return;
        }

        $ownerId = $this->uow->getEntityIdentifier($collection->getOwner());
        $key     = new CollectionCacheKey($this->sourceEntity->name, $this->association['fieldName'], $ownerId);

       // Invalidate non initialized collections OR ordered collection
        if ($isDirty && ! $isInitialized || isset($this->association['orderBy'])) {
            $this->persister->update($collection);

            $this->queuedCache['delete'][spl_object_hash($collection)] = $key;

            return;
        }

        $this->persister->update($collection);

        $this->queuedCache['update'][spl_object_hash($collection)] = array(
            'key'   => $key,
            'list'  => $collection
        );
    }
}

and

use Doctrine\ORM\Cache\CollectionCacheKey;
use Doctrine\ORM\PersistentCollection;

/**
 * This is to fix this bug:
 * @see https://github.com/doctrine/doctrine2/issues/5793
 */
class ReadWriteCachedCollectionPersister extends \Doctrine\ORM\Cache\Persister\Collection\ReadWriteCachedCollectionPersister
{
    /**
     * {@inheritdoc}
     */
    public function delete(PersistentCollection $collection)
    {
        $ownerId = $this->uow->getEntityIdentifier($collection->getOwner());
        $key     = new CollectionCacheKey($this->sourceEntity->name, $this->association['fieldName'], $ownerId);
        $lock    = $this->region->lock($key);

        $this->persister->delete($collection);

        if ($lock === null) {
            return;
        }

        $this->queuedCache['delete'][spl_object_hash($collection)] = array(
            'key'   => $key,
            'lock'  => $lock
        );
    }

    /**
     * {@inheritdoc}
     */
    public function update(PersistentCollection $collection)
    {
        $isInitialized = $collection->isInitialized();
        $isDirty       = $collection->isDirty();

        if ( ! $isInitialized && ! $isDirty) {
            return;
        }

        $this->persister->update($collection);

        $ownerId = $this->uow->getEntityIdentifier($collection->getOwner());
        $key     = new CollectionCacheKey($this->sourceEntity->name, $this->association['fieldName'], $ownerId);
        $lock    = $this->region->lock($key);

        if ($lock === null) {
            return;
        }

        $this->queuedCache['update'][spl_object_hash($collection)] = array(
            'key'   => $key,
            'lock'  => $lock
        );
    }
}

As you can see the only thing I had to change is to use

$this->sourceEntity->name

instead of

$this->sourceEntity->rootEntityName

I never did a pull request with that fix since I didn't have time to follow protocol and I did want to make sure it's working. We are using this fix since the 20th April

@mpoiriert commented on GitHub (Nov 1, 2016): Sorry for the delay really busy at the time. This is the class override I have to fix the issue on my side ``` use Doctrine\ORM\Cache\CollectionCacheKey; use Doctrine\ORM\PersistentCollection; /** * This is to fix this bug: * @see https://github.com/doctrine/doctrine2/issues/5793 */ class NonStrictReadWriteCachedCollectionPersister extends \Doctrine\ORM\Cache\Persister\Collection\NonStrictReadWriteCachedCollectionPersister { /** * {@inheritdoc} */ public function delete(PersistentCollection $collection) { $ownerId = $this->uow->getEntityIdentifier($collection->getOwner()); $key = new CollectionCacheKey($this->sourceEntity->name, $this->association['fieldName'], $ownerId); $this->persister->delete($collection); $this->queuedCache['delete'][spl_object_hash($collection)] = $key; } /** * {@inheritdoc} */ public function update(PersistentCollection $collection) { $isInitialized = $collection->isInitialized(); $isDirty = $collection->isDirty(); if ( ! $isInitialized && ! $isDirty) { return; } $ownerId = $this->uow->getEntityIdentifier($collection->getOwner()); $key = new CollectionCacheKey($this->sourceEntity->name, $this->association['fieldName'], $ownerId); // Invalidate non initialized collections OR ordered collection if ($isDirty && ! $isInitialized || isset($this->association['orderBy'])) { $this->persister->update($collection); $this->queuedCache['delete'][spl_object_hash($collection)] = $key; return; } $this->persister->update($collection); $this->queuedCache['update'][spl_object_hash($collection)] = array( 'key' => $key, 'list' => $collection ); } } ``` and ``` use Doctrine\ORM\Cache\CollectionCacheKey; use Doctrine\ORM\PersistentCollection; /** * This is to fix this bug: * @see https://github.com/doctrine/doctrine2/issues/5793 */ class ReadWriteCachedCollectionPersister extends \Doctrine\ORM\Cache\Persister\Collection\ReadWriteCachedCollectionPersister { /** * {@inheritdoc} */ public function delete(PersistentCollection $collection) { $ownerId = $this->uow->getEntityIdentifier($collection->getOwner()); $key = new CollectionCacheKey($this->sourceEntity->name, $this->association['fieldName'], $ownerId); $lock = $this->region->lock($key); $this->persister->delete($collection); if ($lock === null) { return; } $this->queuedCache['delete'][spl_object_hash($collection)] = array( 'key' => $key, 'lock' => $lock ); } /** * {@inheritdoc} */ public function update(PersistentCollection $collection) { $isInitialized = $collection->isInitialized(); $isDirty = $collection->isDirty(); if ( ! $isInitialized && ! $isDirty) { return; } $this->persister->update($collection); $ownerId = $this->uow->getEntityIdentifier($collection->getOwner()); $key = new CollectionCacheKey($this->sourceEntity->name, $this->association['fieldName'], $ownerId); $lock = $this->region->lock($key); if ($lock === null) { return; } $this->queuedCache['update'][spl_object_hash($collection)] = array( 'key' => $key, 'lock' => $lock ); } } ``` As you can see the only thing I had to change is to use `$this->sourceEntity->name` instead of `$this->sourceEntity->rootEntityName` I never did a pull request with that fix since I didn't have time to follow protocol and I did want to make sure it's working. We are using this fix since the 20th April

admin commented 2026-01-22 14:58:34 +01:00

Author

Owner

Copy Link

@lcobucci commented on GitHub (Jan 19, 2017):

@mpoiriert did you try your mapping with 2.6.x-dev?
The persisters must use the rootEntityName so your fix might break something else we build.

You could also send us the mapping you have so we can try it out and find the problem.

@lcobucci commented on GitHub (Jan 19, 2017): @mpoiriert did you try your mapping with `2.6.x-dev`? The persisters must use the `rootEntityName` so your fix might break something else we build. You could also send us the mapping you have so we can try it out and find the problem.

admin commented 2026-01-22 14:58:34 +01:00

Author

Owner

Copy Link

@lcobucci commented on GitHub (Jan 19, 2017):

@mpoiriert sorry, you were right that the problem wasn't solved.
I'm sending a PR today that fixes it for good 😉

@lcobucci commented on GitHub (Jan 19, 2017): @mpoiriert sorry, you were right that the problem wasn't solved. I'm sending a PR today that fixes it for good 😉

admin commented 2026-01-22 14:58:34 +01:00

Author

Owner

Copy Link

@mpoiriert commented on GitHub (Jan 19, 2017):

Great thanks. We are planning to upgrade all our stack in the next couples of months so I'll be glad to remove all my factory/override when I'll pass to 2.6.0

@mpoiriert commented on GitHub (Jan 19, 2017): Great thanks. We are planning to upgrade all our stack in the next couples of months so I'll be glad to remove all my factory/override when I'll pass to 2.6.0

admin commented 2026-01-22 14:58:35 +01:00

Author

Owner

Copy Link

@lcobucci commented on GitHub (Jan 19, 2017):

@mpoiriert nice, I'll close this issue since we merged #6244.
Would be amazing if you could test your mapping using 2.6.x-dev and report us any other issue.

@lcobucci commented on GitHub (Jan 19, 2017): @mpoiriert nice, I'll close this issue since we merged #6244. Would be amazing if you could test your mapping using `2.6.x-dev` and report us any other issue.

Sign in to join this conversation.

No Branch/Tag Specified

Branches Tags

3.6.x

2.20.x

dependabot/github_actions/2.20.x/doctrine/dot-github/dot-github/workflows/composer-lint.yml-14.0.0

3.7.x

4.0.x

2.21.x

old-prototype-3.x

3.6.2

3.6.1

3.6.0

2.20.9

3.5.8

3.5.7

3.5.6

3.5.5

2.20.8

3.5.4

3.5.3

2.20.7

3.5.2

2.20.6

3.5.1

3.5.0

3.4.4

3.4.3

3.4.2

2.20.5

3.4.1

3.4.0

3.3.4

2.20.4

3.3.3

2.20.3

3.3.2

2.20.2

3.3.1

2.20.1

3.3.0

3.2.3

2.20.0

2.19.8

3.2.2

2.19.7

3.2.1

2.19.6

3.2.0

3.1.4

3.1.3

2.19.5

3.1.2

2.19.4

3.1.1

2.19.3

2.19.2

2.19.1

3.1.0

2.19.0

3.0.3

2.18.3

3.0.2

2.18.2

3.0.1

2.18.1

3.0.0

2.18.0

2.17.5

3.0.0-RC1

2.17.4

2.17.3

2.17.2

2.17.1

3.0.0-beta2

2.17.0

2.16.3

3.0.0-beta1

2.16.2

2.16.1

2.16.0

2.15.5

2.15.4

2.15.3

2.15.2

2.15.1

2.15.0

2.14.3

2.14.2

2.14.1

2.14.0

2.13.5

2.13.4

2.13.3

2.13.2

2.13.1

2.13.0

2.12.4

2.12.3

2.12.2

2.12.1

2.12.0

2.11.3

2.11.2

2.11.1

2.11.0

2.10.5

2.10.4

2.10.3

2.10.2

2.10.1

2.10.0

2.9.6

2.9.5

2.9.4

2.9.3

2.9.2

2.9.1

2.9.0

2.8.5

2.8.4

2.8.3

2.8.2

2.8.1

2.8.0

2.7.5

2.7.4

v2.7.3

v2.7.2

v2.7.1

v2.7.0

v2.6.6

v2.6.5

v2.6.4

v2.6.3

v2.6.2

v2.6.1

v2.6.0

v2.5.14

v2.5.13

v2.5.12

v2.5.11

v2.5.10

v2.5.9

v2.5.8

v2.5.7

v2.5.6

v2.5.5

v2.5.4

v2.5.3

v2.5.2

v2.4.8

v2.5.1

v2.5.0

v2.5.0-RC2

v2.5.0-RC1

v2.5.0-beta1

v2.5.0-alpha2

v2.5.0-alpha1

v2.4.7

v2.4.6

v2.4.5

v2.4.4

v2.4.3

v2.3.6

v2.4.2

2.3.5

v2.4.1

v2.4.0

2.4.0-RC2

2.4.0-RC1

2.4.0-BETA2

2.3.4

2.3.3

2.4.0-BETA1

2.3.2

2.3.1

2.3.0

2.3.0-RC4

2.3.0-RC3

2.3.0-RC2

2.2.3

2.3.0-RC1

2.3.0-BETA1

2.1.7

2.2.2

2.2.1

2.1.6

2.2.0

2.2.0-RC1

2.2.0-BETA2

2.2.0-BETA1

2.1.5

2.1.4

2.1.3

2.1.2

2.1.1

2.0.7

2.1.0

2.1.0RC3

2.1.0RC2

2.1.0RC1

2.0.6

2.1.0BETA1

2.0.5

2.0.4

2.0.3

2.0.2

2.0.1

2.0.0

2.0.0RC2

2.0.0RC1

2.0.0-BETA4

2.0.0-BETA3

2.0.0-BETA2

2.0.0-BETA1

Labels

Clear labels

BC Break

Bug

Can't Fix

Deprecation

Documentation

DQL

Duplicate

Failing Test

Hacktoberfest

Improvement

Improvement

Incomplete

Invalid

Missing Tests

New Feature

PR Created

pull-request

Mirrored from GitHub Pull Request

Question

Regression

Status: Waiting feedback

Waiting feedback

WIP

Won't Fix

No Label Bug Duplicate

Milestone

No items

No Milestone

Projects

Clear projects

No project

Assignees

Clear assignees

admin

No Assignees

1 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: doctrine/archived-orm#5108