Merge pull request #3978 from nextcloud/scss_deps_memcache

Cache SCSS dependency file in memcache

3 files changed, 116 insertions, 41 deletions

diff --git a/lib/private/Template/SCSSCacher.php b/lib/private/Template/SCSSCacher.php
index 4f5c66f2409..c12d8771513 100644
--- a/lib/private/Template/SCSSCacher.php
+++ b/lib/private/Template/SCSSCacher.php
@@ -30,6 +30,7 @@ use OCP\Files\IAppData;
 use OCP\Files\NotFoundException;
 use OCP\Files\NotPermittedException;
 use OCP\Files\SimpleFS\ISimpleFolder;
+use OCP\ICache;
 use OCP\IConfig;
 use OCP\ILogger;
 use OCP\IURLGenerator;
@@ -51,23 +52,29 @@ class SCSSCacher {
 	/** @var string */
 	protected $serverRoot;
 
+	/** @var ICache */
+	protected $depsCache;
+
 	/**
 	 * @param ILogger $logger
 	 * @param IAppData $appData
 	 * @param IURLGenerator $urlGenerator
-	 * @param SystemConfig $systemConfig
+	 * @param IConfig $config
 	 * @param string $serverRoot
+	 * @param ICache $depsCache
 	 */
 	public function __construct(ILogger $logger,
 								IAppData $appData,
 								IURLGenerator $urlGenerator,
 								IConfig $config,
-								$serverRoot) {
+								$serverRoot,
+								ICache $depsCache) {
 		$this->logger = $logger;
 		$this->appData = $appData;
 		$this->urlGenerator = $urlGenerator;
 		$this->config = $config;
 		$this->serverRoot = $serverRoot;
+		$this->depsCache = $depsCache;
 	}
 
 	/**
@@ -94,7 +101,7 @@ class SCSSCacher {
 			$folder = $this->appData->newFolder($app);
 		}
 
-		if($this->isCached($fileNameCSS, $fileNameSCSS, $folder, $path)) {
+		if($this->isCached($fileNameCSS, $folder)) {
 			return true;
 		}
 		return $this->cache($path, $fileNameCSS, $fileNameSCSS, $folder, $webDir);
@@ -103,17 +110,22 @@ class SCSSCacher {
 	/**
 	 * Check if the file is cached or not
 	 * @param string $fileNameCSS
-	 * @param string $fileNameSCSS
 	 * @param ISimpleFolder $folder
-	 * @param string $path
 	 * @return boolean
 	 */
-	private function isCached($fileNameCSS, $fileNameSCSS, ISimpleFolder $folder, $path) {
+	private function isCached($fileNameCSS, ISimpleFolder $folder) {
 		try {
 			$cachedFile = $folder->getFile($fileNameCSS);
 			if ($cachedFile->getSize() > 0) {
-				$depFile = $folder->getFile($fileNameCSS . '.deps');
-				$deps = json_decode($depFile->getContent(), true);
+				$depFileName = $fileNameCSS . '.deps';
+				$deps = $this->depsCache->get($folder->getName() . '-' . $depFileName);
+				if ($deps === null) {
+					$depFile = $folder->getFile($depFileName);
+					$deps = $depFile->getContent();
+					//Set to memcache for next run
+					$this->depsCache->set($folder->getName() . '-' . $depFileName, $deps);
+				}
+				$deps = json_decode($deps, true);
 
 				foreach ($deps as $file=>$mtime) {
 					if (!file_exists($file) || filemtime($file) > $mtime) {
diff --git a/lib/private/TemplateLayout.php b/lib/private/TemplateLayout.php
index 33f61e3c3ac..3206a1d3ba8 100644
--- a/lib/private/TemplateLayout.php
+++ b/lib/private/TemplateLayout.php
@@ -213,12 +213,15 @@ class TemplateLayout extends \OC_Template {
 		$theme = \OC_Util::getTheme();
 
 		if($compileScss) {
+			/** @var \OC\Memcache\Factory $cache */
+			$cache = \OC::$server->query('MemCacheFactory');
 			$SCSSCacher = new SCSSCacher(
 				\OC::$server->getLogger(),
 				\OC::$server->getAppDataDir('css'),
 				\OC::$server->getURLGenerator(),
 				\OC::$server->getConfig(),
-				\OC::$SERVERROOT
+				\OC::$SERVERROOT,
+				$cache->createLocal('SCSS')
 			);
 		} else {
 			$SCSSCacher = null;
diff --git a/tests/lib/Template/SCSSCacherTest.php b/tests/lib/Template/SCSSCacherTest.php
index d49f0cdc6a1..898ea89cf40 100644
--- a/tests/lib/Template/SCSSCacherTest.php
+++ b/tests/lib/Template/SCSSCacherTest.php
@@ -28,6 +28,7 @@ use OCP\Files\IAppData;
 use OCP\Files\NotFoundException;
 use OCP\Files\SimpleFS\ISimpleFile;
 use OCP\Files\SimpleFS\ISimpleFolder;
+use OCP\ICache;
 use OCP\IConfig;
 use OCP\ILogger;
 use OCP\IURLGenerator;
@@ -45,6 +46,8 @@ class SCSSCacherTest extends \Test\TestCase {
 	protected $defaults;
 	/** @var SCSSCacher */
 	protected $scssCacher;
+	/** @var ICache|\PHPUnit_Framework_MockObject_MockObject */
+	protected $depsCache;
 
 	protected function setUp() {
 		parent::setUp();
@@ -52,12 +55,14 @@ class SCSSCacherTest extends \Test\TestCase {
 		$this->appData = $this->createMock(IAppData::class);
 		$this->urlGenerator = $this->createMock(IURLGenerator::class);
 		$this->config = $this->createMock(IConfig::class);
+		$this->depsCache = $this->createMock(ICache::class);
 		$this->scssCacher = new SCSSCacher(
 			$this->logger,
 			$this->appData,
 			$this->urlGenerator,
 			$this->config,
-			\OC::$SERVERROOT
+			\OC::$SERVERROOT,
+			$this->depsCache
 		);
 	}
 
@@ -68,11 +73,22 @@ class SCSSCacherTest extends \Test\TestCase {
 		$file = $this->createMock(ISimpleFile::class);
 		$file->expects($this->any())->method('getSize')->willReturn(1);
 		$fileDeps = $this->createMock(ISimpleFile::class);
-		$folder->expects($this->at(0))->method('getFile')->with('styles.css')->willReturn($file);
-		$folder->expects($this->at(1))->method('getFile')->with('styles.css.deps')->willThrowException(new NotFoundException());
-		$folder->expects($this->at(2))->method('getFile')->with('styles.css')->willReturn($file);
-		$folder->expects($this->at(3))->method('getFile')->with('styles.css.deps')->willThrowException(new NotFoundException());
-		$folder->expects($this->at(4))->method('newFile')->with('styles.css.deps')->willReturn($fileDeps);
+
+		$folder->method('getFile')
+			->will($this->returnCallback(function($path) use ($file) {
+				if ($path === 'styles.css') {
+					return $file;
+				} else if ($path === 'styles.css.deps') {
+					throw new NotFoundException();
+				} else {
+					$this->fail();
+				}
+			}));
+		$folder->expects($this->once())
+			->method('newFile')
+			->with('styles.css.deps')
+			->willReturn($fileDeps);
+
 		$actual = $this->scssCacher->process(\OC::$SERVERROOT, '/core/css/styles.scss', 'core');
 		$this->assertTrue($actual);
 	}
@@ -83,66 +99,110 @@ class SCSSCacherTest extends \Test\TestCase {
 		$file = $this->createMock(ISimpleFile::class);
 		$file->expects($this->any())->method('getSize')->willReturn(1);
 		$fileDeps = $this->createMock(ISimpleFile::class);
-		$folder->expects($this->at(0))->method('getFile')->with('styles.css')->willReturn($file);
-		$folder->expects($this->at(1))->method('getFile')->with('styles.css.deps')->willThrowException(new NotFoundException());
-		$folder->expects($this->at(2))->method('getFile')->with('styles.css')->willReturn($file);
-		$folder->expects($this->at(3))->method('getFile')->with('styles.css.deps')->willThrowException(new NotFoundException());
-		$folder->expects($this->at(4))->method('newFile')->with('styles.css.deps')->willReturn($fileDeps);
+
+		$folder->method('getFile')
+			->will($this->returnCallback(function($path) use ($file) {
+				if ($path === 'styles.css') {
+					return $file;
+				} else if ($path === 'styles.css.deps') {
+					throw new NotFoundException();
+				} else {
+					$this->fail();
+				}
+			}));
+		$folder->expects($this->once())
+			->method('newFile')
+			->with('styles.css.deps')
+			->willReturn($fileDeps);
+
 		$actual = $this->scssCacher->process(\OC::$SERVERROOT, '/core/css/styles.scss', 'core');
 		$this->assertTrue($actual);
 	}
 
-	public function testProcessCacheFile() {
+	public function testProcessCachedFile() {
 		$folder = $this->createMock(ISimpleFolder::class);
 		$this->appData->expects($this->once())->method('getFolder')->with('core')->willReturn($folder);
 		$file = $this->createMock(ISimpleFile::class);
-		$file->expects($this->any())->method('getSize')->willReturn(1);
+		$file->expects($this->once())->method('getSize')->willReturn(1);
 		$fileDeps = $this->createMock(ISimpleFile::class);
 		$fileDeps->expects($this->any())->method('getSize')->willReturn(1);
 		$fileDeps->expects($this->once())->method('getContent')->willReturn('{}');
-		$folder->expects($this->at(0))->method('getFile')->with('styles.css')->willReturn($file);
-		$folder->expects($this->at(1))->method('getFile')->with('styles.css.deps')->willReturn($fileDeps);
+
+		$folder->method('getFile')
+			->will($this->returnCallback(function($path) use ($file, $fileDeps) {
+				if ($path === 'styles.css') {
+					return $file;
+				} else if ($path === 'styles.css.deps') {
+					return $fileDeps;
+				} else {
+					$this->fail();
+				}
+			}));
+
 		$actual = $this->scssCacher->process(\OC::$SERVERROOT, '/core/css/styles.scss', 'core');
 		$this->assertTrue($actual);
 	}
 
-	public function testProcessCachedFile() {
+	public function testProcessCachedFileMemcache() {
 		$folder = $this->createMock(ISimpleFolder::class);
-		$this->appData->expects($this->once())->method('getFolder')->with('core')->willReturn($folder);
+		$this->appData->expects($this->once())
+			->method('getFolder')
+			->with('core')
+			->willReturn($folder);
+		$folder->method('getName')
+			->willReturn('core');
+
 		$file = $this->createMock(ISimpleFile::class);
-		$file->expects($this->once())->method('getSize')->willReturn(1);
-		$fileDeps = $this->createMock(ISimpleFile::class);
-		$fileDeps->expects($this->any())->method('getSize')->willReturn(1);
-		$fileDeps->expects($this->once())->method('getContent')->willReturn('{}');
-		$folder->expects($this->at(0))->method('getFile')->with('styles.css')->willReturn($file);
-		$folder->expects($this->at(1))->method('getFile')->with('styles.css.deps')->willReturn($fileDeps);
+		$file->expects($this->once())
+			->method('getSize')
+			->willReturn(1);
+
+		$this->depsCache->method('get')
+			->with('core-styles.css.deps')
+			->willReturn('{}');
+
+		$folder->method('getFile')
+			->will($this->returnCallback(function($path) use ($file) {
+				if ($path === 'styles.css') {
+					return $file;
+				} else if ($path === 'styles.css.deps') {
+					$this->fail();
+				} else {
+					$this->fail();
+				}
+			}));
+
 		$actual = $this->scssCacher->process(\OC::$SERVERROOT, '/core/css/styles.scss', 'core');
 		$this->assertTrue($actual);
 	}
 
 	public function testIsCachedNoFile() {
 		$fileNameCSS = "styles.css";
-		$fileNameSCSS = "styles.scss";
 		$folder = $this->createMock(ISimpleFolder::class);
-		$path = \OC::$SERVERROOT . '/core/css/';
 
 		$folder->expects($this->at(0))->method('getFile')->with($fileNameCSS)->willThrowException(new NotFoundException());
-		$actual = self::invokePrivate($this->scssCacher, 'isCached', [$fileNameCSS, $fileNameSCSS, $folder, $path]);
+		$actual = self::invokePrivate($this->scssCacher, 'isCached', [$fileNameCSS, $folder]);
 		$this->assertFalse($actual);
 	}
 
 	public function testIsCachedNoDepsFile() {
 		$fileNameCSS = "styles.css";
-		$fileNameSCSS = "styles.scss";
 		$folder = $this->createMock(ISimpleFolder::class);
 		$file = $this->createMock(ISimpleFile::class);
-		$path = \OC::$SERVERROOT . '/core/css/';
 
 		$file->expects($this->once())->method('getSize')->willReturn(1);
-		$folder->expects($this->at(0))->method('getFile')->with($fileNameCSS)->willReturn($file);
-		$folder->expects($this->at(1))->method('getFile')->with($fileNameCSS . '.deps')->willThrowException(new NotFoundException());
+		$folder->method('getFile')
+			->will($this->returnCallback(function($path) use ($file) {
+				if ($path === 'styles.css') {
+					return $file;
+				} else if ($path === 'styles.css.deps') {
+					throw new NotFoundException();
+				} else {
+					$this->fail();
+				}
+			}));
 
-		$actual = self::invokePrivate($this->scssCacher, 'isCached', [$fileNameCSS, $fileNameSCSS, $folder, $path]);
+		$actual = self::invokePrivate($this->scssCacher, 'isCached', [$fileNameCSS, $folder]);
 		$this->assertFalse($actual);
 	}
 	public function testCacheNoFile() {
@@ -275,4 +335,4 @@ class SCSSCacherTest extends \Test\TestCase {
 	}
 
 
-}
\ No newline at end of file
+}