Skip to content

Commit 9e999ea

Browse files
greg0iregreg0ire
authored
Merge pull request doctrine#11792 from dbannik/11783-failure-with-indexed-relation
11783 failure with indexed relation
2 parents c2a4932 + 6755bb0 commit 9e999ea

File tree

11 files changed

+235
-15
lines changed

11 files changed

+235
-15
lines changed

‎src/Cache/CollectionCacheKey.php‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,14 +43,16 @@ class CollectionCacheKey extends CacheKey
4343
* @param string $association The field name that represents the association.
4444
* @param array<string, mixed> $ownerIdentifier The identifier of the owning entity.
4545
*/
46-
public function __construct($entityClass, $association, array $ownerIdentifier)
46+
public function __construct($entityClass, $association, array $ownerIdentifier, string $filterHash = '')
4747
{
4848
ksort($ownerIdentifier);
4949

5050
$this->ownerIdentifier = $ownerIdentifier;
5151
$this->entityClass = (string) $entityClass;
5252
$this->association = (string) $association;
5353

54-
parent::__construct(str_replace('\\', '.', strtolower($entityClass)) . '_' . implode(' ', $ownerIdentifier) . '__' . $association);
54+
$filterHash = $filterHash === '' ? '' : '_' . $filterHash;
55+
56+
parent::__construct(str_replace('\\', '.', strtolower($entityClass)) . '_' . implode(' ', $ownerIdentifier) . '__' . $association . $filterHash);
5557
}
5658
}

‎src/Cache/Persister/Collection/AbstractCollectionPersister.php‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
use Doctrine\ORM\PersistentCollection;
2020
use Doctrine\ORM\Persisters\Collection\CollectionPersister;
2121
use Doctrine\ORM\Proxy\DefaultProxyClassNameResolver;
22+
use Doctrine\ORM\Query\FilterCollection;
2223
use Doctrine\ORM\UnitOfWork;
2324

2425
use function array_values;
@@ -55,6 +56,9 @@ abstract class AbstractCollectionPersister implements CachedCollectionPersister
5556
/** @var string */
5657
protected $regionName;
5758

59+
/** @var FilterCollection */
60+
protected $filters;
61+
5862
/** @var CollectionHydrator */
5963
protected $hydrator;
6064

@@ -76,6 +80,7 @@ public function __construct(CollectionPersister $persister, Region $region, Enti
7680
$this->region = $region;
7781
$this->persister = $persister;
7882
$this->association = $association;
83+
$this->filters = $em->getFilters();
7984
$this->regionName = $region->getName();
8085
$this->uow = $em->getUnitOfWork();
8186
$this->metadataFactory = $em->getMetadataFactory();
@@ -189,7 +194,7 @@ public function containsKey(PersistentCollection $collection, $key)
189194
public function count(PersistentCollection $collection)
190195
{
191196
$ownerId = $this->uow->getEntityIdentifier($collection->getOwner());
192-
$key = new CollectionCacheKey($this->sourceEntity->rootEntityName, $this->association['fieldName'], $ownerId);
197+
$key = new CollectionCacheKey($this->sourceEntity->rootEntityName, $this->association['fieldName'], $ownerId, $this->filters->getHash());
193198
$entry = $this->region->get($key);
194199

195200
if ($entry !== null) {
@@ -241,7 +246,8 @@ protected function evictCollectionCache(PersistentCollection $collection)
241246
$key = new CollectionCacheKey(
242247
$this->sourceEntity->rootEntityName,
243248
$this->association['fieldName'],
244-
$this->uow->getEntityIdentifier($collection->getOwner())
249+
$this->uow->getEntityIdentifier($collection->getOwner()),
250+
$this->filters->getHash()
245251
);
246252

247253
$this->region->evict($key);

‎src/Cache/Persister/Collection/NonStrictReadWriteCachedCollectionPersister.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ public function afterTransactionRolledBack()
4545
public function delete(PersistentCollection $collection)
4646
{
4747
$ownerId = $this->uow->getEntityIdentifier($collection->getOwner());
48-
$key = new CollectionCacheKey($this->sourceEntity->rootEntityName, $this->association['fieldName'], $ownerId);
48+
$key = new CollectionCacheKey($this->sourceEntity->rootEntityName, $this->association['fieldName'], $ownerId, $this->filters->getHash());
4949

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

@@ -65,7 +65,7 @@ public function update(PersistentCollection $collection)
6565
}
6666

6767
$ownerId = $this->uow->getEntityIdentifier($collection->getOwner());
68-
$key = new CollectionCacheKey($this->sourceEntity->rootEntityName, $this->association['fieldName'], $ownerId);
68+
$key = new CollectionCacheKey($this->sourceEntity->rootEntityName, $this->association['fieldName'], $ownerId, $this->filters->getHash());
6969

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

‎src/Cache/Persister/Collection/ReadWriteCachedCollectionPersister.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ public function afterTransactionRolledBack()
6868
public function delete(PersistentCollection $collection)
6969
{
7070
$ownerId = $this->uow->getEntityIdentifier($collection->getOwner());
71-
$key = new CollectionCacheKey($this->sourceEntity->rootEntityName, $this->association['fieldName'], $ownerId);
71+
$key = new CollectionCacheKey($this->sourceEntity->rootEntityName, $this->association['fieldName'], $ownerId, $this->filters->getHash());
7272
$lock = $this->region->lock($key);
7373

7474
$this->persister->delete($collection);
@@ -98,7 +98,7 @@ public function update(PersistentCollection $collection)
9898
$this->persister->update($collection);
9999

100100
$ownerId = $this->uow->getEntityIdentifier($collection->getOwner());
101-
$key = new CollectionCacheKey($this->sourceEntity->rootEntityName, $this->association['fieldName'], $ownerId);
101+
$key = new CollectionCacheKey($this->sourceEntity->rootEntityName, $this->association['fieldName'], $ownerId, $this->filters->getHash());
102102
$lock = $this->region->lock($key);
103103

104104
if ($lock === null) {

‎src/Cache/Persister/Entity/AbstractEntityPersister.php‎

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,11 @@
2222
use Doctrine\ORM\PersistentCollection;
2323
use Doctrine\ORM\Persisters\Entity\EntityPersister;
2424
use Doctrine\ORM\Proxy\DefaultProxyClassNameResolver;
25+
use Doctrine\ORM\Query\FilterCollection;
2526
use Doctrine\ORM\UnitOfWork;
2627

2728
use function array_merge;
29+
use function func_get_args;
2830
use function serialize;
2931
use function sha1;
3032

@@ -62,6 +64,9 @@ abstract class AbstractEntityPersister implements CachedEntityPersister
6264
/** @var Cache */
6365
protected $cache;
6466

67+
/** @var FilterCollection */
68+
protected $filters;
69+
6570
/** @var CacheLogger|null */
6671
protected $cacheLogger;
6772

@@ -91,6 +96,7 @@ public function __construct(EntityPersister $persister, Region $region, EntityMa
9196
$this->region = $region;
9297
$this->persister = $persister;
9398
$this->cache = $em->getCache();
99+
$this->filters = $em->getFilters();
94100
$this->regionName = $region->getName();
95101
$this->uow = $em->getUnitOfWork();
96102
$this->metadataFactory = $em->getMetadataFactory();
@@ -261,7 +267,7 @@ protected function getHash($query, $criteria, ?array $orderBy = null, $limit = n
261267
? $this->persister->expandCriteriaParameters($criteria)
262268
: $this->persister->expandParameters($criteria);
263269

264-
return sha1($query . serialize($params) . serialize($orderBy) . $limit . $offset);
270+
return sha1($query . serialize($params) . serialize($orderBy) . $limit . $offset . $this->filters->getHash());
265271
}
266272

267273
/**
@@ -524,7 +530,7 @@ public function loadManyToManyCollection(array $assoc, $sourceEntity, Persistent
524530
}
525531

526532
$ownerId = $this->uow->getEntityIdentifier($collection->getOwner());
527-
$key = $this->buildCollectionCacheKey($assoc, $ownerId);
533+
$key = $this->buildCollectionCacheKey($assoc, $ownerId, $this->filters->getHash());
528534
$list = $persister->loadCollectionCache($collection, $key);
529535

530536
if ($list !== null) {
@@ -559,7 +565,7 @@ public function loadOneToManyCollection(array $assoc, $sourceEntity, PersistentC
559565
}
560566

561567
$ownerId = $this->uow->getEntityIdentifier($collection->getOwner());
562-
$key = $this->buildCollectionCacheKey($assoc, $ownerId);
568+
$key = $this->buildCollectionCacheKey($assoc, $ownerId, $this->filters->getHash());
563569
$list = $persister->loadCollectionCache($collection, $key);
564570

565571
if ($list !== null) {
@@ -611,12 +617,15 @@ public function refresh(array $id, $entity, $lockMode = null)
611617
*
612618
* @return CollectionCacheKey
613619
*/
614-
protected function buildCollectionCacheKey(array $association, $ownerId)
620+
protected function buildCollectionCacheKey(array $association, $ownerId/*, string $filterHash */)
615621
{
622+
$filterHash = (string) (func_get_args()[2] ?? ''); // todo: move to argument in next major release
623+
616624
return new CollectionCacheKey(
617625
$this->metadataFactory->getMetadataFor($association['sourceEntity'])->rootEntityName,
618626
$association['fieldName'],
619-
$ownerId
627+
$ownerId,
628+
$filterHash
620629
);
621630
}
622631
}

‎src/Persisters/Entity/BasicEntityPersister.php‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1560,7 +1560,15 @@ protected function getSelectColumnSQL($field, ClassMetadata $class, $alias = 'r'
15601560
$tableAlias = $this->getSQLTableAlias($class->name, $root);
15611561
$fieldMapping = $class->fieldMappings[$field];
15621562
$sql = sprintf('%s.%s', $tableAlias, $this->quoteStrategy->getColumnName($field, $class, $this->platform));
1563-
$columnAlias = $this->getSQLColumnAlias($fieldMapping['columnName']);
1563+
1564+
$columnAlias = null;
1565+
if ($this->currentPersisterContext->rsm->hasColumnAliasByField($alias, $field)) {
1566+
$columnAlias = $this->currentPersisterContext->rsm->getColumnAliasByField($alias, $field);
1567+
}
1568+
1569+
if ($columnAlias === null) {
1570+
$columnAlias = $this->getSQLColumnAlias($fieldMapping['columnName']);
1571+
}
15641572

15651573
$this->currentPersisterContext->rsm->addFieldResult($alias, $columnAlias, $field);
15661574
if (! empty($fieldMapping['enumType'])) {

‎src/Query/ResultSetMapping.php‎

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,13 @@ class ResultSetMapping
6969
*/
7070
public $fieldMappings = [];
7171

72+
/**
73+
* Map field names for each class to alias
74+
*
75+
* @var array<class-string, array<string, array<string, string>>>
76+
*/
77+
public $columnAliasMappings = [];
78+
7279
/**
7380
* Maps column names in the result set to the alias/field name to use in the mapped result.
7481
*
@@ -335,7 +342,10 @@ public function addFieldResult($alias, $columnName, $fieldName, $declaringClass
335342
// column name => alias of owner
336343
$this->columnOwnerMap[$columnName] = $alias;
337344
// field name => class name of declaring class
338-
$this->declaringClasses[$columnName] = $declaringClass ?: $this->aliasMap[$alias];
345+
$declaringClass = $declaringClass ?: $this->aliasMap[$alias];
346+
$this->declaringClasses[$columnName] = $declaringClass;
347+
348+
$this->columnAliasMappings[$declaringClass][$alias][$fieldName] = $columnName;
339349

340350
if (! $this->isMixed && $this->scalarMappings) {
341351
$this->isMixed = true;
@@ -344,6 +354,20 @@ public function addFieldResult($alias, $columnName, $fieldName, $declaringClass
344354
return $this;
345355
}
346356

357+
public function hasColumnAliasByField(string $alias, string $fieldName): bool
358+
{
359+
$declaringClass = $this->aliasMap[$alias];
360+
361+
return isset($this->columnAliasMappings[$declaringClass][$alias][$fieldName]);
362+
}
363+
364+
public function getColumnAliasByField(string $alias, string $fieldName): string
365+
{
366+
$declaringClass = $this->aliasMap[$alias];
367+
368+
return $this->columnAliasMappings[$declaringClass][$alias][$fieldName];
369+
}
370+
347371
/**
348372
* Adds a joined entity result.
349373
*

‎tests/Tests/ORM/Functional/Ticket/SwitchContextWithFilterAndIndexedRelation/Category.php‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Doctrine\Tests\ORM\Functional\Ticket\SwitchContextWithFilterAndIndexedRelation;
6+
7+
use Doctrine\ORM\Mapping as ORM;
8+
9+
/**
10+
* @ORM\Entity
11+
* @ORM\Table(name="Category_Master")
12+
*/
13+
class Category
14+
{
15+
/**
16+
* @ORM\Id
17+
* @ORM\Column(type="integer")
18+
* @ORM\GeneratedValue(strategy="AUTO")
19+
*
20+
* @var int
21+
*/
22+
public $id;
23+
24+
/**
25+
* @ORM\Column(type="string")
26+
*
27+
* @var string
28+
*/
29+
public $name;
30+
31+
/**
32+
* @ORM\Column(type="string")
33+
*
34+
* @var string
35+
*/
36+
public $type;
37+
38+
public function __construct(string $name, string $type)
39+
{
40+
$this->name = $name;
41+
$this->type = $type;
42+
}
43+
}

‎tests/Tests/ORM/Functional/Ticket/SwitchContextWithFilterAndIndexedRelation/CategoryTypeSQLFilter.php‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Doctrine\Tests\ORM\Functional\Ticket\SwitchContextWithFilterAndIndexedRelation;
6+
7+
use Doctrine\ORM\Mapping\ClassMetadata;
8+
use Doctrine\ORM\Query\Filter\SQLFilter;
9+
10+
use function sprintf;
11+
12+
class CategoryTypeSQLFilter extends SQLFilter
13+
{
14+
public function addFilterConstraint(ClassMetadata $targetEntity, $targetTableAlias): string
15+
{
16+
if ($targetEntity->getName() === Category::class) {
17+
return sprintf('%s.%s = %s', $targetTableAlias, $targetEntity->fieldMappings['type']['fieldName'], $this->getParameter('type'));
18+
}
19+
20+
return '';
21+
}
22+
}

‎tests/Tests/ORM/Functional/Ticket/SwitchContextWithFilterAndIndexedRelation/ChangeFiltersTest.php‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Doctrine\Tests\ORM\Functional\Ticket\SwitchContextWithFilterAndIndexedRelation;
6+
7+
use Doctrine\Tests\OrmFunctionalTestCase;
8+
9+
final class ChangeFiltersTest extends OrmFunctionalTestCase
10+
{
11+
private const COMPANY_A = 'A';
12+
private const CAT_BAR = 'bar';
13+
private const CAT_FOO = 'foo';
14+
15+
public function setUp(): void
16+
{
17+
parent::setUp();
18+
19+
$this->setUpEntitySchema([
20+
Company::class,
21+
Category::class,
22+
]);
23+
}
24+
25+
private function prepareData(): void
26+
{
27+
$cat1 = new Category('cat1', self::CAT_FOO);
28+
$cat2 = new Category('cat2', self::CAT_BAR);
29+
$companyA = new Company(self::COMPANY_A, [$cat1, $cat2]);
30+
31+
$this->_em->persist($cat1);
32+
$this->_em->persist($cat2);
33+
$this->_em->persist($companyA);
34+
$this->_em->flush();
35+
$this->_em->clear();
36+
}
37+
38+
public function testIndexAliasUpdatedWithUpdatedFilter(): void
39+
{
40+
$this->prepareData();
41+
42+
$company = $this->_em->getRepository(Company::class)->findOneBy([]);
43+
44+
self::assertCount(2, $company->categories);
45+
self::assertEquals([self::CAT_FOO, self::CAT_BAR], $company->categories->map(static function (Category $c): string {
46+
return $c->type;
47+
})->getValues());
48+
49+
$this->_em->clear();
50+
$this->_em->getConfiguration()->addFilter(CategoryTypeSQLFilter::class, CategoryTypeSQLFilter::class);
51+
$this->_em->getFilters()->enable(CategoryTypeSQLFilter::class)->setParameter('type', self::CAT_FOO);
52+
53+
$company = $this->_em->getRepository(Company::class)->findOneBy([]);
54+
55+
self::assertCount(1, $company->categories);
56+
self::assertEquals([self::CAT_FOO], $company->categories->map(static function (Category $c): string {
57+
return $c->type;
58+
})->getValues());
59+
}
60+
}

0 commit comments

Comments
 (0)