[civicrm-core.git] / tests / phpunit / CRM / Contact / BAO / GroupContactCacheTest.php

<?php
/*
 +--------------------------------------------------------------------+
 | Copyright CiviCRM LLC. All rights reserved.                        |
 |                                                                    |
 | This work is published under the GNU AGPLv3 license with some      |
 | permitted exceptions and without any warranty. For full license    |
 | and copyright information, see https://civicrm.org/licensing       |
 +--------------------------------------------------------------------+
 */

/**
 * Test class for CRM_Contact_BAO_GroupContact BAO
 *
 * @package   CiviCRM
 * @group headless
 */
class CRM_Contact_BAO_GroupContactCacheTest extends CiviUnitTestCase {

  /**
   * Manually add and remove contacts from a smart group.
   *
   * @throws \API_Exception
   * @throws \CRM_Core_Exception
   * @throws \CiviCRM_API3_Exception
   */
  public function testManualAddRemove(): void {
    [$group, $living, $deceased] = $this->setupSmartGroup();

    // Add $n1 to $g
    $this->callAPISuccess('GroupContact', 'create', [
      'contact_id' => $living[0]->id,
      'group_id' => $group->id,
    ]);

    CRM_Contact_BAO_GroupContactCache::load($group);
    $this->assertCacheMatches(
      [$deceased[0]->id, $deceased[1]->id, $deceased[2]->id, $living[0]->id],
      $group->id
    );

    // Remove $y1 from $g
    $this->callAPISuccess('group_contact', 'create', [
      'contact_id' => $deceased[0]->id,
      'group_id' => $group->id,
      'status' => 'Removed',
    ]);

    CRM_Contact_BAO_GroupContactCache::load($group);
    $this->assertCacheMatches(
      [
        $deceased[1]->id,
        $deceased[2]->id,
        $living[0]->id,
      ],
      $group->id
    );
  }

  /**
   * Allow removing contact from a parent group even if contact is in a child
   * group. (CRM-8858).
   *
   * @throws \CRM_Core_Exception
   */
  public function testRemoveFromParentSmartGroup(): void {
    // Create $c1, $c2, $c3
    $deceased = $this->createTestObject('CRM_Contact_DAO_Contact', ['is_deceased' => 1], 3);

    // Create smart group $parent
    $params = [
      'name' => 'Deceased Contacts',
      'title' => 'Deceased Contacts',
      'is_active' => 1,
      'formValues' => ['is_deceased' => 1],
    ];
    $parent = CRM_Contact_BAO_Group::createSmartGroup($params);
    $this->registerTestObjects([$parent]);

    // Create group $child in $parent
    $params = [
      'name' => 'Child Group',
      'title' => 'Child Group',
      'is_active' => 1,
      'parents' => [$parent->id => 1],
    ];
    $child = CRM_Contact_BAO_Group::create($params);
    $this->registerTestObjects([$child]);

    // Add $c1, $c2, $c3 to $child
    foreach ($deceased as $contact) {
      $this->callAPISuccess('group_contact', 'create', [
        'contact_id' => $contact->id,
        'group_id' => $child->id,
      ]);
    }

    CRM_Contact_BAO_GroupContactCache::load($parent);
    $this->assertCacheMatches(
      [$deceased[0]->id, $deceased[1]->id, $deceased[2]->id],
      $parent->id
    );

    // Remove $c1 from $parent
    $this->callAPISuccess('GroupContact', 'create', [
      'contact_id' => $deceased[0]->id,
      'group_id' => $parent->id,
      'status' => 'Removed',
    ]);

    // Assert $c1 not in $parent
    CRM_Contact_BAO_GroupContactCache::load($parent);
    $this->assertCacheMatches(
      [
        $deceased[1]->id,
        $deceased[2]->id,
      ],
      $parent->id
    );

    // Assert $c1 still in $child
    $this->assertDBQuery(1,
      'select count(*) from civicrm_group_contact where group_id=%1 and contact_id=%2 and status=%3',
      [
        1 => [$child->id, 'Integer'],
        2 => [$deceased[0]->id, 'Integer'],
        3 => ['Added', 'String'],
      ]
    );
  }

  /**
   * Assert that the cache for a group contains exactly the listed contacts.
   *
   * @param array $expectedContactIds
   *   Array(int).
   * @param int $groupId
   */
  public function assertCacheMatches($expectedContactIds, $groupId): void {
    $sql = 'SELECT contact_id FROM civicrm_group_contact_cache WHERE group_id = %1';
    $params = [1 => [$groupId, 'Integer']];
    $dao = CRM_Core_DAO::executeQuery($sql, $params);
    $actualContactIds = [];
    while ($dao->fetch()) {
      $actualContactIds[] = $dao->contact_id;
    }

    sort($expectedContactIds);
    sort($actualContactIds);
    $this->assertEquals($expectedContactIds, $actualContactIds);
  }

  /**
   * Test the opportunistic refresh cache function does not touch non-expired entries.
   */
  public function testOpportunisticRefreshCacheNoChangeIfNotExpired() {
    [$group, $living, $deceased] = $this->setupSmartGroup();
    $this->callAPISuccess('Contact', 'create', ['id' => $deceased[0]->id, 'is_deceased' => 0]);
    $this->assertCacheMatches(
      [$deceased[0]->id, $deceased[1]->id, $deceased[2]->id],
      $group->id
    );
    CRM_Contact_BAO_GroupContactCache::opportunisticCacheFlush();

    $this->assertCacheNotRefreshed($deceased, $group);
  }

  /**
   * Test the opportunistic refresh cache function does refresh stale entries.
   */
  public function testOpportunisticRefreshChangeIfCacheDateFieldStale() {
    [$group, $living, $deceased] = $this->setupSmartGroup();
    $this->callAPISuccess('Contact', 'create', ['id' => $deceased[0]->id, 'is_deceased' => 0]);
    CRM_Core_DAO::executeQuery('UPDATE civicrm_group SET cache_date = DATE_SUB(NOW(), INTERVAL 7 MINUTE) WHERE id = ' . $group->id);
    $group->find(TRUE);
    Civi::$statics['CRM_Contact_BAO_GroupContactCache']['is_refresh_init'] = FALSE;
    sleep(1);
    CRM_Contact_BAO_GroupContactCache::opportunisticCacheFlush();

    $this->assertCacheRefreshed($group);
  }

  /**
   * Test the opportunistic refresh cache function does refresh expired entries if mode is deterministic.
   */
  public function testOpportunisticRefreshNoChangeWithDeterministicSetting() {
    [$group, $living, $deceased] = $this->setupSmartGroup();
    $this->callAPISuccess('Setting', 'create', ['smart_group_cache_refresh_mode' => 'deterministic']);
    $this->callAPISuccess('Contact', 'create', ['id' => $deceased[0]->id, 'is_deceased' => 0]);
    $this->makeCacheStale($group);
    CRM_Contact_BAO_GroupContactCache::opportunisticCacheFlush();
    $this->assertCacheNotRefreshed($deceased, $group);
    $this->callAPISuccess('Setting', 'create', ['smart_group_cache_refresh_mode' => 'opportunistic']);
  }

  /**
   * Test the deterministic cache function refreshes with the deterministic setting.
   */
  public function testDeterministicRefreshChangeWithDeterministicSetting() {
    [$group, $living, $deceased] = $this->setupSmartGroup();
    $this->callAPISuccess('Setting', 'create', ['smart_group_cache_refresh_mode' => 'deterministic']);
    $this->callAPISuccess('Contact', 'create', ['id' => $deceased[0]->id, 'is_deceased' => 0]);
    $this->makeCacheStale($group);
    CRM_Contact_BAO_GroupContactCache::deterministicCacheFlush();
    $this->assertCacheRefreshed($group);
    $this->callAPISuccess('Setting', 'create', ['smart_group_cache_refresh_mode' => 'opportunistic']);
  }

  /**
   * Test the deterministic cache function refresh doesn't mess up non-expired.
   */
  public function testDeterministicRefreshChangeDoesNotTouchNonExpired() {
    [$group, $living, $deceased] = $this->setupSmartGroup();
    $this->callAPISuccess('Setting', 'create', ['smart_group_cache_refresh_mode' => 'deterministic']);
    $this->callAPISuccess('Contact', 'create', ['id' => $deceased[0]->id, 'is_deceased' => 0]);
    CRM_Contact_BAO_GroupContactCache::deterministicCacheFlush();
    $this->assertCacheNotRefreshed($deceased, $group);
    $this->callAPISuccess('Setting', 'create', ['smart_group_cache_refresh_mode' => 'opportunistic']);
  }

  /**
   * Test the deterministic cache function refreshes with the opportunistic setting.
   *
   * (hey it's an opportunity!).
   */
  public function testDeterministicRefreshChangeWithOpportunisticSetting() {
    [$group, $living, $deceased] = $this->setupSmartGroup();
    $this->callAPISuccess('Setting', 'create', ['smart_group_cache_refresh_mode' => 'opportunistic']);
    $this->callAPISuccess('Contact', 'create', ['id' => $deceased[0]->id, 'is_deceased' => 0]);
    $this->makeCacheStale($group);
    CRM_Contact_BAO_GroupContactCache::deterministicCacheFlush();
    $this->assertCacheRefreshed($group);
  }

  /**
   * Test the api job wrapper around the deterministic refresh works.
   */
  public function testJobWrapper() {
    [$group, $living, $deceased] = $this->setupSmartGroup();
    $this->callAPISuccess('Setting', 'create', ['smart_group_cache_refresh_mode' => 'opportunistic']);
    $this->callAPISuccess('Contact', 'create', ['id' => $deceased[0]->id, 'is_deceased' => 0]);
    $this->makeCacheStale($group);
    $this->callAPISuccess('Job', 'group_cache_flush', []);
    $this->assertCacheRefreshed($group);
  }

  // *** Everything below this should be moved to parent class ****

  /**
   * @var array
   * (DAO_Name => array(int)) List of items to garbage-collect during tearDown
   */
  private $_testObjects;

  /**
   * Tears down the fixture, for example, closes a network connection.
   *
   * This method is called after a test is executed.
   */
  protected function tearDown(): void {
    parent::tearDown();
    $this->deleteTestObjects();
  }

  /**
   * This is a wrapper for CRM_Core_DAO::createTestObject which tracks created entities.
   *
   * @see CRM_Core_DAO::createTestObject
   *
   * @param string $daoName
   * @param array $params
   * @param int $numObjects
   * @param bool $createOnly
   *
   * @return array|NULL|object
   */
  public function createTestObject($daoName, $params = [], $numObjects = 1, $createOnly = FALSE) {
    $objects = CRM_Core_DAO::createTestObject($daoName, $params, $numObjects, $createOnly);
    if (is_array($objects)) {
      $this->registerTestObjects($objects);
    }
    else {
      $this->registerTestObjects([$objects]);
    }
    return $objects;
  }

  /**
   * Register test objects.
   *
   * @param array $objects
   *   DAO or BAO objects.
   */
  public function registerTestObjects($objects) {
    foreach ($objects as $object) {
      $daoName = preg_replace('/_BAO_/', '_DAO_', get_class($object));
      $this->_testObjects[$daoName][] = $object->id;
    }
  }

  /**
   * Delete test objects.
   *
   * Note: You might argue that the FK relations between test
   * objects could make this problematic; however, it should
   * behave intuitively as long as we mentally split our
   *  test-objects between the "manual/primary records"
   * and the "automatic/secondary records"
   */
  public function deleteTestObjects() {
    foreach ($this->_testObjects as $daoName => $daoIds) {
      foreach ($daoIds as $daoId) {
        CRM_Core_DAO::deleteTestObjects($daoName, ['id' => $daoId]);
      }
    }
    $this->_testObjects = [];
  }

  /**
   * Set up a smart group testing scenario.
   *
   * @return array
   */
  protected function setupSmartGroup(): array {
    // Create contacts $y1, $y2, $y3 which do match $g; create $n1, $n2, $n3 which do not match $g
    $living = $this->createTestObject('CRM_Contact_DAO_Contact', ['is_deceased' => 0], 3);
    $deceased = $this->createTestObject('CRM_Contact_DAO_Contact', ['is_deceased' => 1], 3);
    $this->assertCount(3, $deceased);
    $this->assertCount(3, $living);

    $params = [
      'name' => 'Deceased Contacts',
      'title' => 'Deceased Contacts',
      'is_active' => 1,
      'formValues' => ['is_deceased' => 1],
    ];
    $group = CRM_Contact_BAO_Group::createSmartGroup($params);
    $this->registerTestObjects([$group]);

    // Assert: $g cache has exactly $y1, $y2, $y3
    CRM_Contact_BAO_GroupContactCache::load($group);
    $group->find(TRUE);
    $this->assertCacheMatches(
      [$deceased[0]->id, $deceased[1]->id, $deceased[2]->id],
      $group->id
    );
    // Reload the group so we have the cache_date & refresh_date.
    return [$group, $living, $deceased];
  }

  /**
   * @param $deceased
   * @param $group
   *
   * @throws \Exception
   */
  protected function assertCacheNotRefreshed($deceased, $group) {
    $this->assertCacheMatches(
      [$deceased[0]->id, $deceased[1]->id, $deceased[2]->id],
      $group->id
    );
    $afterGroup = $this->callAPISuccessGetSingle('Group', ['id' => $group->id]);
    $this->assertEquals($group->cache_date, $afterGroup['cache_date']);
  }

  /**
   * Make the cache for the group stale, resetting it to before the timeout period.
   *
   * @param CRM_Contact_BAO_Group $group
   */
  protected function makeCacheStale(&$group) {
    CRM_Core_DAO::executeQuery('UPDATE civicrm_group SET cache_date = DATE_SUB(NOW(), INTERVAL 7 MINUTE) WHERE id = ' . $group->id);
    unset($group->cache_date);
    $group->find(TRUE);
    Civi::$statics['CRM_Contact_BAO_GroupContactCache']['is_refresh_init'] = FALSE;
  }

  /**
   * @param $group
   *
   * @throws \Exception
   */
  protected function assertCacheRefreshed($group) {
    $this->assertCacheMatches(
      [],
      $group->id
    );

    $afterGroup = $this->callAPISuccessGetSingle('Group', ['id' => $group->id]);
    $this->assertTrue(empty($afterGroup['cache_date']), 'cache date should not be set as the cache is not built');
  }

  /**
   * Test Smart group search
   */
  public function testSmartGroupSearchBuilder() {
    $returnProperties = [
      'contact_type' => 1,
      'contact_sub_type' => 1,
      'sort_name' => 1,
      'group' => 1,
    ];
    [$group, $living, $deceased] = $this->setupSmartGroup();

    $params = [
      'name' => 'Living Contacts',
      'title' => 'Living Contacts',
      'is_active' => 1,
      'formValues' => ['is_deceased' => 0],
    ];
    $group2 = CRM_Contact_BAO_Group::createSmartGroup($params);

    //Filter on smart group with =, !=, IN and NOT IN operator.
    $params = [['group', '=', $group2->id, 1, 0]];
    $query = new CRM_Contact_BAO_Query(
      $params, $returnProperties,
      NULL, FALSE, FALSE, CRM_Contact_BAO_Query::MODE_CONTACTS,
      FALSE,
      FALSE, FALSE
    );
    $ids = $query->searchQuery(0, 0, NULL,
      FALSE, FALSE, FALSE,
      TRUE, FALSE
    );
    $key = $query->getGroupCacheTableKeys()[0];
    $expectedWhere = "civicrm_group_contact_cache_{$key}.group_id IN (\"{$group2->id}\")";
    $this->assertStringContainsString($expectedWhere, $query->_whereClause);
    $this->_assertContactIds($query, "group_id = {$group2->id}");

    $params = [['group', '!=', $group->id, 1, 0]];
    $query = new CRM_Contact_BAO_Query(
      $params, $returnProperties,
      NULL, FALSE, FALSE, CRM_Contact_BAO_Query::MODE_CONTACTS,
      FALSE,
      FALSE, FALSE
    );
    $key = $query->getGroupCacheTableKeys()[0];
    //Assert if proper where clause is present.
    $expectedWhere = "civicrm_group_contact_{$key}.group_id != {$group->id} AND civicrm_group_contact_cache_{$key}.group_id IS NULL OR  ( civicrm_group_contact_cache_{$key}.contact_id NOT IN (SELECT contact_id FROM civicrm_group_contact_cache cgcc WHERE cgcc.group_id IN ( {$group->id} ) ) )";
    $this->assertStringContainsString($expectedWhere, $query->_whereClause);
    $this->_assertContactIds($query, "group_id != {$group->id}");

    $params = [['group', 'IN', [$group->id, $group2->id], 1, 0]];
    $query = new CRM_Contact_BAO_Query(
      $params, $returnProperties,
      NULL, FALSE, FALSE, CRM_Contact_BAO_Query::MODE_CONTACTS,
      FALSE,
      FALSE, FALSE
    );
    $key = $query->getGroupCacheTableKeys()[0];
    $expectedWhere = "civicrm_group_contact_cache_{$key}.group_id IN (\"{$group->id}\", \"{$group2->id}\")";
    $this->assertStringContainsString($expectedWhere, $query->_whereClause);
    $this->_assertContactIds($query, "group_id IN ({$group->id}, {$group2->id})");

    $params = [['group', 'NOT IN', [$group->id], 1, 0]];
    $query = new CRM_Contact_BAO_Query(
      $params, $returnProperties,
      NULL, FALSE, FALSE, CRM_Contact_BAO_Query::MODE_CONTACTS,
      FALSE,
      FALSE, FALSE
    );
    $key = $query->getGroupCacheTableKeys()[0];
    $expectedWhere = "civicrm_group_contact_{$key}.group_id NOT IN ( {$group->id} ) AND civicrm_group_contact_cache_{$key}.group_id IS NULL OR  ( civicrm_group_contact_cache_{$key}.contact_id NOT IN (SELECT contact_id FROM civicrm_group_contact_cache cgcc WHERE cgcc.group_id IN ( {$group->id} ) ) )";
    $this->assertStringContainsString($expectedWhere, $query->_whereClause);
    $this->_assertContactIds($query, "group_id NOT IN ({$group->id})");
    $this->callAPISuccess('group', 'delete', ['id' => $group->id]);
    $this->callAPISuccess('group', 'delete', ['id' => $group2->id]);
  }

  public function testMultipleGroupWhereClause() {
    $returnProperties = [
      'contact_type' => 1,
      'contact_sub_type' => 1,
      'sort_name' => 1,
      'group' => 1,
    ];
    [$group, $living, $deceased] = $this->setupSmartGroup();

    $params = [
      'name' => 'Living Contacts',
      'title' => 'Living Contacts',
      'is_active' => 1,
      'formValues' => ['is_deceased' => 0],
    ];
    $group2 = CRM_Contact_BAO_Group::createSmartGroup($params);

    //Filter on smart group with =, !=, IN and NOT IN operator.
    $params = [['group', '=', $group2->id, 1, 0], ['group', '=', $group->id, 1, 0]];
    $query = new CRM_Contact_BAO_Query(
      $params, $returnProperties,
      NULL, FALSE, FALSE, CRM_Contact_BAO_Query::MODE_CONTACTS,
      FALSE,
      FALSE, FALSE
    );
    $ids = $query->searchQuery(0, 0, NULL,
      FALSE, FALSE, FALSE,
      TRUE, FALSE
    );
    $key1 = $query->getGroupCacheTableKeys()[0];
    $key2 = $query->getGroupCacheTableKeys()[1];
    $expectedWhere = 'civicrm_group_contact_cache_' . $key1 . '.group_id IN ("' . $group2->id . '") )  )  AND  (  ( civicrm_group_contact_cache_' . $key2 . '.group_id IN ("' . $group->id . '")';
    $this->assertStringContainsString($expectedWhere, $query->_whereClause);
    // Check that we have 3 joins to the group contact cache 1 for each of the group where clauses and 1 for the fact we are returning groups in the select.
    $expectedFrom1 = 'LEFT JOIN civicrm_group_contact_cache civicrm_group_contact_cache_' . $key1 . ' ON contact_a.id = civicrm_group_contact_cache_' . $key1 . '.contact_id';
    $this->assertStringContainsString($expectedFrom1, $query->_fromClause);
    $expectedFrom2 = 'LEFT JOIN civicrm_group_contact_cache civicrm_group_contact_cache_' . $key2 . ' ON contact_a.id = civicrm_group_contact_cache_' . $key2 . '.contact_id';
    $this->assertStringContainsString($expectedFrom2, $query->_fromClause);
    $expectedFrom3 = 'LEFT JOIN civicrm_group_contact_cache ON contact_a.id = civicrm_group_contact_cache.contact_id';
    $this->assertStringContainsString($expectedFrom3, $query->_fromClause);
  }

  /**
   * Check if contact ids are fetched correctly.
   *
   * @param object $query
   * @param string $groupWhereClause
   */
  public function _assertContactIds($query, $groupWhereClause) {
    $contactIds = explode(',', $query->searchQuery(0, 0, NULL,
      FALSE, FALSE, FALSE,
      TRUE, FALSE
    ));
    $expectedContactIds = [];
    $groupDAO = CRM_Core_DAO::executeQuery("SELECT contact_id FROM civicrm_group_contact_cache WHERE {$groupWhereClause}");
    while ($groupDAO->fetch()) {
      $expectedContactIds[] = $groupDAO->contact_id;
    }
    $this->assertEquals(sort($expectedContactIds), sort($contactIds));
  }

}