Merge pull request #429 from systopia/permissions-cache-clearing

Fix permissions cache clearing

Author: dontub

Civi/Funding/EventSubscriber/FundingCase/FundingCasePermissionsCacheClearSubscriber.php

@@ -24,6 +24,7 @@
 use Civi\Funding\Database\ChangeSetFactory;
 use Civi\Funding\Entity\FundingCaseContactRelationEntity;
 use Civi\Funding\FundingCase\FundingCasePermissionsCacheManager;
+use Civi\Funding\Permission\ContactRelation\Types\ContactTypeAndGroup;
 use Civi\Funding\Permission\ContactRelation\Types\Relationship;
 use Civi\RemoteTools\Api4\Api4Interface;
 use Civi\RemoteTools\Api4\Query\Comparison;
@@ -35,6 +36,8 @@
  */
 final class FundingCasePermissionsCacheClearSubscriber implements EventSubscriberInterface {
 
+  private const RELATION_TYPES_WITH_GROUP_IDS = [Relationship::NAME, ContactTypeAndGroup::NAME];
+
   private Api4Interface $api4;
 
   private ChangeSetFactory $changeSetFactory;
@@ -231,11 +234,12 @@ public function onPreFundingCaseContactRelation(PreEvent $event): void {
   private function getRelationshipRelationsByGroupId(int $groupId): iterable {
     $relations = FundingCaseContactRelationEntity::allFromApiResult($this->api4->getEntities(
       FundingCaseContactRelation::getEntityName(),
-      Comparison::new('type', '=', Relationship::NAME)
+      Comparison::new('type', 'IN', self::RELATION_TYPES_WITH_GROUP_IDS)
     ));
 
     foreach ($relations as $relation) {
-      if (in_array($groupId, $relation->getProperty('groupIds', []), TRUE)) {
+      $relationGroupIds = $relation->getProperty('groupIds', []);
+      if ([] === $relationGroupIds || in_array($groupId, $relationGroupIds, TRUE)) {
         yield $relation;
       }
     }

tests/phpunit/Civi/Funding/EventSubscriber/FundingCase/FundingCasePermissionsCacheClearSubscriberTest.php

@@ -35,6 +35,8 @@
 use Civi\Funding\Fixtures\FundingProgramFixture;
 use Civi\Funding\Fixtures\GroupContactFixture;
 use Civi\Funding\Fixtures\GroupFixture;
+use Civi\Funding\Permission\ContactRelation\Types\ContactTypeAndGroup;
+use Civi\Funding\Permission\ContactRelation\Types\Relationship as RelationshipType;
 
 /**
  * @covers \Civi\Funding\EventSubscriber\FundingCase\FundingCasePermissionsCacheClearSubscriber
@@ -107,14 +109,15 @@ public function testOnPreGroup(): void {
 
     $group1 = GroupFixture::addFixture();
     $group2 = GroupFixture::addFixture();
+    $group3 = GroupFixture::addFixture();
 
     $fundingCase = FundingCaseFixture::addFixture(
       $fundingProgram->getId(),
       $fundingCaseType->getId(),
       $contact['id'],
       $contact['id']
     );
-    FundingCaseContactRelationFixture::addFixture($fundingCase->getId(), Relationship::getEntityName(), [
+    FundingCaseContactRelationFixture::addFixture($fundingCase->getId(), RelationshipType::NAME, [
       'relationshipTypeIds' => [],
       'contactTypeIds' => [],
       'groupIds' => [$group1['id']],
@@ -146,6 +149,16 @@ public function testOnPreGroup(): void {
     // Deleting group should affect cache.
     Group::delete(FALSE)->addWhere('id', '=', $group1['id'])->execute();
     static::assertNull(FundingCasePermissionsCache::get(FALSE)->execute()->single()['permissions']);
+
+    // Deleting group should affect cache when there is no group restriction.
+    FundingCaseContactRelationFixture::addFixture($fundingCase->getId(), ContactTypeAndGroup::NAME, [
+      'contactTypeIds' => [],
+      'groupIds' => [],
+    ], ['permission']);
+    FundingCasePermissionsCache::delete(FALSE)->addWhere('id', 'IS NOT NULL')->execute();
+    FundingCasePermissionsCacheFixture::add($fundingCase->getId(), $contact['id'], FALSE, ['test']);
+    Group::delete(FALSE)->addWhere('id', '=', $group3['id'])->execute();
+    static::assertNull(FundingCasePermissionsCache::get(FALSE)->execute()->single()['permissions']);
   }
 
   public function testOnPreGroupContact(): void {
@@ -156,6 +169,7 @@ public function testOnPreGroupContact(): void {
 
     $group1 = GroupFixture::addFixture();
     $group2 = GroupFixture::addFixture();
+    $group3 = GroupFixture::addFixture();
 
     $fundingCase1 = FundingCaseFixture::addFixture(
       $fundingProgram->getId(),
@@ -169,12 +183,12 @@ public function testOnPreGroupContact(): void {
       $contact1['id'],
       $contact1['id']
     );
-    FundingCaseContactRelationFixture::addFixture($fundingCase1->getId(), Relationship::getEntityName(), [
+    FundingCaseContactRelationFixture::addFixture($fundingCase1->getId(), RelationshipType::NAME, [
       'relationshipTypeIds' => [],
       'contactTypeIds' => [],
       'groupIds' => [$group1['id']],
     ], ['permission']);
-    FundingCaseContactRelationFixture::addFixture($fundingCase2->getId(), Relationship::getEntityName(), [
+    FundingCaseContactRelationFixture::addFixture($fundingCase2->getId(), RelationshipType::NAME, [
       'relationshipTypeIds' => [],
       'contactTypeIds' => [],
       'groupIds' => [$group2['id']],
@@ -207,6 +221,16 @@ public function testOnPreGroupContact(): void {
     GroupContact::update(FALSE)->setValues($groupContact)->execute();
 
     static::assertSame([NULL, NULL], FundingCasePermissionsCache::get(FALSE)->execute()->column('permissions'));
+
+    // Adding GroupContact should affect cache when there is no group restriction.
+    FundingCaseContactRelationFixture::addFixture($fundingCase1->getId(), ContactTypeAndGroup::NAME, [
+      'contactTypeIds' => [],
+      'groupIds' => [],
+    ], ['permission']);
+    FundingCasePermissionsCache::delete(FALSE)->addWhere('id', 'IS NOT NULL')->execute();
+    FundingCasePermissionsCacheFixture::add($fundingCase1->getId(), $contact1['id'], FALSE, ['test']);
+    GroupContactFixture::addFixtureWithGroupId($group1['id'], $contact1['id']);
+    static::assertNull(FundingCasePermissionsCache::get(FALSE)->execute()->single()['permissions']);
   }
 
   public function testOnPreFundingCaseContactRelation(): void {