nextcloud-server/tests/lib/Files/Cache/PropagatorTest.php

<?php
/**
 * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
 * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

namespace Test\Files\Cache;

use OC\Files\Storage\Temporary;
use OCP\Files\Cache\ICacheEntry;
use OCP\Files\Storage\IStorage;
use Test\TestCase;

/**
 * @group DB
 */
class PropagatorTest extends TestCase {
	/** @var IStorage */
	private $storage;

	protected function setUp(): void {
		parent::setUp();
		$this->storage = new Temporary();
		$this->storage->mkdir('foo/bar');
		$this->storage->file_put_contents('foo/bar/file.txt', 'bar');
		$this->storage->getScanner()->scan('');
	}

	/**
	 * @param $paths
	 * @return ICacheEntry[]
	 */
	private function getFileInfos($paths) {
		$values = array_map(function ($path) {
			return $this->storage->getCache()->get($path);
		}, $paths);
		return array_combine($paths, $values);
	}

	public function testEtagPropagation(): void {
		$paths = ['', 'foo', 'foo/bar'];
		$oldInfos = $this->getFileInfos($paths);
		$this->storage->getPropagator()->propagateChange('foo/bar/file.txt', time());
		$newInfos = $this->getFileInfos($paths);

		foreach ($oldInfos as $i => $oldInfo) {
			$this->assertNotEquals($oldInfo->getEtag(), $newInfos[$i]->getEtag());
		}
	}

	public function testTimePropagation(): void {
		$paths = ['', 'foo', 'foo/bar'];
		$oldTime = time() - 200;
		$targetTime = time() - 100;
		$now = time();
		$cache = $this->storage->getCache();
		$cache->put('', ['mtime' => $now]);
		$cache->put('foo', ['mtime' => $now]);
		$cache->put('foo/bar', ['mtime' => $oldTime]);
		$cache->put('foo/bar/file.txt', ['mtime' => $oldTime]);
		$this->storage->getPropagator()->propagateChange('foo/bar/file.txt', $targetTime);
		$newInfos = $this->getFileInfos($paths);

		$this->assertEquals($targetTime, $newInfos['foo/bar']->getMTime());

		// dont lower mtimes
		$this->assertEquals($now, $newInfos['foo']->getMTime());
		$this->assertEquals($now, $newInfos['']->getMTime());
	}

	public function testSizePropagation(): void {
		$paths = ['', 'foo', 'foo/bar'];
		$oldInfos = $this->getFileInfos($paths);
		$this->storage->getPropagator()->propagateChange('foo/bar/file.txt', time(), 10);
		$newInfos = $this->getFileInfos($paths);

		foreach ($oldInfos as $i => $oldInfo) {
			$this->assertEquals($oldInfo->getSize() + 10, $newInfos[$i]->getSize());
		}
	}

	public function testSizePropagationNoNegative(): void {
		$paths = ['', 'foo', 'foo/bar'];
		$oldInfos = $this->getFileInfos($paths);
		$this->storage->getPropagator()->propagateChange('foo/bar/file.txt', time(), -100);
		$newInfos = $this->getFileInfos($paths);

		foreach ($oldInfos as $i => $oldInfo) {
			$this->assertEquals(-1, $newInfos[$i]->getSize());
		}
	}

	public function testBatchedPropagation(): void {
		$this->storage->mkdir('foo/baz');
		$this->storage->mkdir('asd');
		$this->storage->file_put_contents('asd/file.txt', 'bar');
		$this->storage->file_put_contents('foo/baz/file.txt', 'bar');
		$this->storage->getScanner()->scan('');

		$paths = ['', 'foo', 'foo/bar', 'asd', 'foo/baz'];

		$oldInfos = $this->getFileInfos($paths);
		$propagator = $this->storage->getPropagator();

		$propagator->beginBatch();
		$propagator->propagateChange('asd/file.txt', time(), 10);
		$propagator->propagateChange('foo/bar/file.txt', time(), 2);

		$newInfos = $this->getFileInfos($paths);

		// no changes until we finish the batch
		foreach ($oldInfos as $i => $oldInfo) {
			$this->assertEquals($oldInfo->getSize(), $newInfos[$i]->getSize());
			$this->assertEquals($oldInfo->getEtag(), $newInfos[$i]->getEtag());
			$this->assertEquals($oldInfo->getMTime(), $newInfos[$i]->getMTime());
		}

		$propagator->commitBatch();

		$newInfos = $this->getFileInfos($paths);

		foreach ($oldInfos as $i => $oldInfo) {
			if ($oldInfo->getPath() !== 'foo/baz') {
				$this->assertNotEquals($oldInfo->getEtag(), $newInfos[$i]->getEtag(), "etag for {$oldInfo->getPath()} not updated");
			}
		}

		$this->assertEquals($oldInfos['']->getSize() + 12, $newInfos['']->getSize());
		$this->assertEquals($oldInfos['asd']->getSize() + 10, $newInfos['asd']->getSize());
		$this->assertEquals($oldInfos['foo']->getSize() + 2, $newInfos['foo']->getSize());
		$this->assertEquals($oldInfos['foo/bar']->getSize() + 2, $newInfos['foo/bar']->getSize());
		$this->assertEquals($oldInfos['foo/baz']->getSize(), $newInfos['foo/baz']->getSize());
	}
}