LockFunctionalTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\system\Functional\Lock;

use Drupal\Tests\BrowserTestBase;

/**
 * Confirm locking works between two separate requests.
 *
 * @group Lock
 */
class LockFunctionalTest extends BrowserTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'system_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * Confirms that we can acquire and release locks in two parallel requests.
     */
    public function testLockAcquire() : void {
        $lock = $this->container
            ->get('lock');
        $lock_acquired = 'TRUE: Lock successfully acquired in \\Drupal\\system_test\\Controller\\SystemTestController::lockAcquire()';
        $lock_not_acquired = 'FALSE: Lock not acquired in \\Drupal\\system_test\\Controller\\SystemTestController::lockAcquire()';
        $this->assertTrue($lock->acquire('system_test_lock_acquire'), 'Lock acquired by this request.');
        $this->assertTrue($lock->acquire('system_test_lock_acquire'), 'Lock extended by this request.');
        $lock->release('system_test_lock_acquire');
        // Cause another request to acquire the lock.
        $this->drupalGet('system-test/lock-acquire');
        $this->assertSession()
            ->pageTextContains($lock_acquired);
        // The other request has finished, thus it should have released its lock.
        $this->assertTrue($lock->acquire('system_test_lock_acquire'), 'Lock acquired by this request.');
        // This request holds the lock, so the other request cannot acquire it.
        $this->drupalGet('system-test/lock-acquire');
        $this->assertSession()
            ->pageTextContains($lock_not_acquired);
        $lock->release('system_test_lock_acquire');
        // Try a very short timeout and lock breaking.
        $this->assertTrue($lock->acquire('system_test_lock_acquire', 0.5), 'Lock acquired by this request.');
        sleep(1);
        // The other request should break our lock.
        $this->drupalGet('system-test/lock-acquire');
        $this->assertSession()
            ->pageTextContains($lock_acquired);
        // We cannot renew it, since the other thread took it.
        $this->assertFalse($lock->acquire('system_test_lock_acquire'), 'Lock cannot be extended by this request.');
        // Check the shut-down function.
        $lock_acquired_exit = 'TRUE: Lock successfully acquired in \\Drupal\\system_test\\Controller\\SystemTestController::lockExit()';
        $this->drupalGet('system-test/lock-exit');
        $this->assertSession()
            ->pageTextContains($lock_acquired_exit);
        $this->assertTrue($lock->acquire('system_test_lock_exit'), 'Lock acquired by this request after the other request exits.');
    }
    
    /**
     * Tests that the persistent lock is persisted between requests.
     */
    public function testPersistentLock() : void {
        $persistent_lock = $this->container
            ->get('lock.persistent');
        // Get a persistent lock.
        $this->drupalGet('system-test/lock-persist/lock1');
        $this->assertSession()
            ->pageTextContains('TRUE: Lock successfully acquired in SystemTestController::lockPersist()');
        // Ensure that a shutdown function has not released the lock.
        $this->assertFalse($persistent_lock->lockMayBeAvailable('lock1'));
        $this->drupalGet('system-test/lock-persist/lock1');
        $this->assertSession()
            ->pageTextContains('FALSE: Lock not acquired in SystemTestController::lockPersist()');
        // Get another persistent lock.
        $this->drupalGet('system-test/lock-persist/lock2');
        $this->assertSession()
            ->pageTextContains('TRUE: Lock successfully acquired in SystemTestController::lockPersist()');
        $this->assertFalse($persistent_lock->lockMayBeAvailable('lock2'));
        // Release the first lock and try getting it again.
        $persistent_lock->release('lock1');
        $this->drupalGet('system-test/lock-persist/lock1');
        $this->assertSession()
            ->pageTextContains('TRUE: Lock successfully acquired in SystemTestController::lockPersist()');
    }

}