ConfigEntityStaticCacheTest.php

<?php

declare (strict_types=1);
namespace Drupal\KernelTests\Core\Config;

use Drupal\config_entity_static_cache_test\ConfigOverrider;
use Drupal\KernelTests\KernelTestBase;

/**
 * Tests the entity static cache when used by config entities.
 *
 * @group config
 */
class ConfigEntityStaticCacheTest extends KernelTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'config_test',
        'config_entity_static_cache_test',
    ];
    
    /**
     * The type ID of the entity under test.
     *
     * @var string
     */
    protected $entityTypeId;
    
    /**
     * The entity ID of the entity under test.
     *
     * @var string
     */
    protected $entityId;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->entityTypeId = 'config_test';
        $this->entityId = 'test_1';
        $this->container
            ->get('entity_type.manager')
            ->getStorage($this->entityTypeId)
            ->create([
            'id' => $this->entityId,
            'label' => 'Original label',
        ])
            ->save();
    }
    
    /**
     * Tests that the static cache is working.
     */
    public function testCacheHit() : void {
        $storage = $this->container
            ->get('entity_type.manager')
            ->getStorage($this->entityTypeId);
        $entity_1 = $storage->load($this->entityId);
        $entity_2 = $storage->load($this->entityId);
        // config_entity_static_cache_test_config_test_load() sets _loadStamp to a
        // random string. If they match, it means $entity_2 was retrieved from the
        // static cache rather than going through a separate load sequence.
        $this->assertSame($entity_1->_loadStamp, $entity_2->_loadStamp);
    }
    
    /**
     * Tests that the static cache is reset on entity save and delete.
     */
    public function testReset() : void {
        $storage = $this->container
            ->get('entity_type.manager')
            ->getStorage($this->entityTypeId);
        $entity = $storage->load($this->entityId);
        // Ensure loading after a save retrieves the updated entity rather than an
        // obsolete cached one.
        $entity->label = 'New label';
        $entity->save();
        $entity = $storage->load($this->entityId);
        $this->assertSame('New label', $entity->label);
        // Ensure loading after a delete retrieves NULL rather than an obsolete
        // cached one.
        $entity->delete();
        $this->assertNull($storage->load($this->entityId));
    }
    
    /**
     * Tests that the static cache is sensitive to config overrides.
     */
    public function testConfigOverride() : void {
        
        /** @var \Drupal\Core\Config\Entity\ConfigEntityStorage $storage */
        $storage = \Drupal::entityTypeManager()->getStorage($this->entityTypeId);
        // Prime the cache prior to adding a config override.
        $storage->load($this->entityId);
        // Add the config override, and ensure that what is loaded is correct
        // despite the prior cache priming.
        \Drupal::configFactory()->addOverride(new ConfigOverrider());
        $entity_override = $storage->load($this->entityId);
        $this->assertSame('Overridden label', $entity_override->label);
        // Load override free to ensure that loading the config entity again does
        // not return the overridden value.
        $entity_no_override = $storage->loadOverrideFree($this->entityId);
        $this->assertNotSame('Overridden label', $entity_no_override->label);
        $this->assertNotSame($entity_override->_loadStamp, $entity_no_override->_loadStamp);
        // Reload the entity and ensure the cache is used.
        $this->assertSame($entity_no_override->_loadStamp, $storage->loadOverrideFree($this->entityId)->_loadStamp);
        // Enable overrides and reload the entity and ensure the cache is used.
        $this->assertSame($entity_override->_loadStamp, $storage->load($this->entityId)->_loadStamp);
    }

}