Merge pull request #8197 from nextcloud/stable13-8144

[stable13] Repair step to clear frontend related caches

lib/composer/composer/autoload_classmap.php

@@ -804,6 +804,7 @@
     'OC\\Repair' => $baseDir . '/lib/private/Repair.php',
     'OC\\RepairException' => $baseDir . '/lib/private/RepairException.php',
     'OC\\Repair\\CleanTags' => $baseDir . '/lib/private/Repair/CleanTags.php',
+    'OC\\Repair\\ClearFrontendCaches' => $baseDir . '/lib/private/Repair/ClearFrontendCaches.php',
     'OC\\Repair\\Collation' => $baseDir . '/lib/private/Repair/Collation.php',
     'OC\\Repair\\MoveUpdaterStepFile' => $baseDir . '/lib/private/Repair/MoveUpdaterStepFile.php',
     'OC\\Repair\\NC11\\CleanPreviews' => $baseDir . '/lib/private/Repair/NC11/CleanPreviews.php',

lib/composer/composer/autoload_static.php

@@ -828,6 +828,7 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c
         'OC\\Repair' => __DIR__ . '/../../..' . '/lib/private/Repair.php',
         'OC\\RepairException' => __DIR__ . '/../../..' . '/lib/private/RepairException.php',
         'OC\\Repair\\CleanTags' => __DIR__ . '/../../..' . '/lib/private/Repair/CleanTags.php',
+        'OC\\Repair\\ClearFrontendCaches' => __DIR__ . '/../../..' . '/lib/private/Repair/ClearFrontendCaches.php',
         'OC\\Repair\\Collation' => __DIR__ . '/../../..' . '/lib/private/Repair/Collation.php',
         'OC\\Repair\\MoveUpdaterStepFile' => __DIR__ . '/../../..' . '/lib/private/Repair/MoveUpdaterStepFile.php',
         'OC\\Repair\\NC11\\CleanPreviews' => __DIR__ . '/../../..' . '/lib/private/Repair/NC11/CleanPreviews.php',

lib/private/Repair.php

@@ -33,6 +33,7 @@
 use OC\App\AppStore\Bundles\BundleFetcher;
 use OC\Files\AppData\Factory;
 use OC\Repair\CleanTags;
+use OC\Repair\ClearFrontendCaches;
 use OC\Repair\Collation;
 use OC\Repair\MoveUpdaterStepFile;
 use OC\Repair\NC11\CleanPreviews;
@@ -50,6 +51,8 @@
 use OC\Repair\SqliteAutoincrement;
 use OC\Repair\RepairMimeTypes;
 use OC\Repair\RepairInvalidShares;
+use OC\Template\JSCombiner;
+use OC\Template\SCSSCacher;
 use OCP\AppFramework\QueryException;
 use OCP\Migration\IOutput;
 use OCP\Migration\IRepairStep;
@@ -152,6 +155,7 @@ public static function getRepairSteps() {
 			new RepairInvalidPaths(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig()),
 			new RepairIdentityProofKeyFolders(\OC::$server->getConfig(), \OC::$server->query(Factory::class), \OC::$server->getRootFolder()),
 			new AddLogRotateJob(\OC::$server->getJobList()),
+			new ClearFrontendCaches(\OC::$server->getMemCacheFactory(), \OC::$server->query(SCSSCacher::class), \OC::$server->query(JSCombiner::class))
 		];
 	}
 

lib/private/Repair/ClearFrontendCaches.php

@@ -0,0 +1,70 @@
+<?php
+/**
+ * @copyright Copyright (c) 2018 Julius Härtl <jus@bitgrid.net>
+ *
+ * @author Julius Härtl <jus@bitgrid.net>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ *  This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU Affero General Public License as
+ *  published by the Free Software Foundation, either version 3 of the
+ *  License, or (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU Affero General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Affero General Public License
+ *  along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OC\Repair;
+
+use OC\Template\JSCombiner;
+use OC\Template\SCSSCacher;
+use OCP\ICacheFactory;
+use OCP\Migration\IOutput;
+use OCP\Migration\IRepairStep;
+
+class ClearFrontendCaches implements IRepairStep {
+
+	/** @var ICacheFactory */
+	protected $cacheFactory;
+
+	/** @var SCSSCacher */
+	protected $scssCacher;
+
+	/** @var JSCombiner */
+	protected $jsCombiner;
+
+	public function __construct(ICacheFactory $cacheFactory,
+								SCSSCacher $SCSSCacher,
+								JSCombiner $JSCombiner) {
+		$this->cacheFactory = $cacheFactory;
+		$this->scssCacher = $SCSSCacher;
+		$this->jsCombiner = $JSCombiner;
+	}
+
+	public function getName() {
+		return 'Clear frontend caches';
+	}
+
+	public function run(IOutput $output) {
+		try {
+			$c = $this->cacheFactory->createDistributed('imagePath');
+			$c->clear();
+			$output->info('Image cache cleared');
+
+			$this->scssCacher->resetCache();
+			$output->info('SCSS cache cleared');
+
+			$this->jsCombiner->resetCache();
+			$output->info('JS cache cleared');
+		} catch (\Exception $e) {
+			$output->warning('Unable to clear the frontend cache');
+		}
+	}
+}

lib/private/Server.php

@@ -109,6 +109,7 @@
 use OC\Session\CryptoWrapper;
 use OC\Share20\ShareHelper;
 use OC\Tagging\TagMapper;
+use OC\Template\JSCombiner;
 use OC\Template\SCSSCacher;
 use OCA\Theming\ThemingDefaults;
 
@@ -965,6 +966,17 @@ public function __construct($webRoot, \OC\Config $config) {
 				$cacheFactory->createDistributed('SCSS')
 			);
 		});
+		$this->registerService(JSCombiner::class, function (Server $c) {
+			/** @var Factory $cacheFactory */
+			$cacheFactory = $c->query(Factory::class);
+			return new JSCombiner(
+				$c->getAppDataDir('js'),
+				$c->getURLGenerator(),
+				$cacheFactory->createDistributed('JS'),
+				$c->getSystemConfig(),
+				$c->getLogger()
+			);
+		});
 		$this->registerService(EventDispatcher::class, function () {
 			return new EventDispatcher();
 		});

lib/private/Template/JSCombiner.php

@@ -184,9 +184,10 @@ protected function cache($path, $fileName, ISimpleFolder $folder) {
 			$depFile->putContent($deps);
 			$this->depsCache->set($folder->getName() . '-' . $depFileName, $deps);
 			$gzipFile->putContent(gzencode($res, 9));
-
+			$this->logger->debug('JSCombiner: successfully cached: ' . $fileName);
 			return true;
 		} catch (NotPermittedException $e) {
+			$this->logger->error('JSCombiner: unable to cache: ' . $fileName);
 			return false;
 		}
 	}
@@ -227,4 +228,20 @@ public function getContent($root, $file) {
 
 		return $result;
 	}
+
+
+	/**
+	 * Clear cache with combined javascript files
+	 *
+	 * @throws NotFoundException
+	 */
+	public function resetCache() {
+		$this->depsCache->clear();
+		$appDirectory = $this->appData->getDirectoryListing();
+		foreach ($appDirectory as $folder) {
+			foreach ($folder->getDirectoryListing() as $file) {
+				$file->delete();
+			}
+		}
+	}
 }

lib/private/Template/SCSSCacher.php

@@ -242,9 +242,10 @@ private function cache($path, $fileNameCSS, $fileNameSCSS, ISimpleFolder $folder
 			$depFile->putContent($deps);
 			$this->depsCache->set($folder->getName() . '-' . $depFileName, $deps);
 			$gzipFile->putContent(gzencode($data, 9));
-			$this->logger->debug($webDir.'/'.$fileNameSCSS.' compiled and successfully cached', ['app' => 'core']);
+			$this->logger->debug('SCSSCacher: '.$webDir.'/'.$fileNameSCSS.' compiled and successfully cached', ['app' => 'core']);
 			return true;
 		} catch(NotPermittedException $e) {
+			$this->logger->error('SCSSCacher: unable to cache: ' . $fileNameSCSS);
 			return false;
 		}
 	}
@@ -253,17 +254,13 @@ private function cache($path, $fileNameCSS, $fileNameSCSS, ISimpleFolder $folder
 	 * Reset scss cache by deleting all generated css files
 	 * We need to regenerate all files when variables change
 	 */
-	private function resetCache() {
+	public function resetCache() {
 		$this->injectedVariables = null;
+		$this->depsCache->clear();
 		$appDirectory = $this->appData->getDirectoryListing();
-		if(empty($appDirectory)){
-			return;
-		}
 		foreach ($appDirectory as $folder) {
 			foreach ($folder->getDirectoryListing() as $file) {
-				if (substr($file->getName(), -3) === "css" || substr($file->getName(), -4) === "deps") {
-					$file->delete();
-				}
+				$file->delete();
 			}
 		}
 	}

tests/lib/Repair/ClearFrontendCachesTest.php

@@ -0,0 +1,78 @@
+<?php
+/**
+ * @copyright Copyright (c) 2018 Julius Härtl <jus@bitgrid.net>
+ *
+ * @author Julius Härtl <jus@bitgrid.net>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace Test\Repair;
+use OC\Template\JSCombiner;
+use OC\Template\SCSSCacher;
+use OCP\ICache;
+use OCP\ICacheFactory;
+use OCP\Migration\IOutput;
+
+class ClearFrontendCachesTest extends \Test\TestCase {
+
+	/** @var ICacheFactory */
+	private $cacheFactory;
+
+	/** @var SCSSCacher */
+	private $scssCacher;
+
+	/** @var JSCombiner */
+	private $jsCombiner;
+
+	/** @var \OC\Repair\ClearFrontendCaches */
+	protected $repair;
+
+	/** @var IOutput */
+	private $outputMock;
+
+	protected function setUp() {
+		parent::setUp();
+
+		$this->outputMock = $this->createMock(IOutput::class);
+
+		$this->cacheFactory = $this->createMock(ICacheFactory::class);
+		$this->scssCacher = $this->createMock(SCSSCacher::class);
+		$this->jsCombiner = $this->createMock(JSCombiner::class);
+
+		$this->repair = new \OC\Repair\ClearFrontendCaches($this->cacheFactory, $this->scssCacher, $this->jsCombiner);
+	}
+
+
+	public function testRun() {
+		$imagePathCache = $this->createMock(ICache::class);
+		$imagePathCache->expects($this->once())
+			->method('clear')
+			->with('');
+		$this->jsCombiner->expects($this->once())
+			->method('resetCache');
+		$this->scssCacher->expects($this->once())
+			->method('resetCache');
+		$this->cacheFactory->expects($this->at(0))
+			->method('createDistributed')
+			->with('imagePath')
+			->willReturn($imagePathCache);
+
+		$this->repair->run($this->outputMock);
+		$this->assertTrue(true);
+	}
+}

tests/lib/Template/JSCombinerTest.php

@@ -511,4 +511,25 @@ public function testGetContentInvalidJson() {
 		$expected = [];
 		$this->assertEquals($expected, $this->jsCombiner->getContent($pathInfo['dirname'], $pathInfo['basename']));
 	}
+
+	public function testResetCache() {
+		$file = $this->createMock(ISimpleFile::class);
+		$file->expects($this->once())
+			->method('delete');
+
+		$folder = $this->createMock(ISimpleFolder::class);
+		$folder->expects($this->once())
+			->method('getDirectoryListing')
+			->willReturn([$file]);
+
+		$this->depsCache->expects($this->once())
+			->method('clear')
+			->with('');
+		$this->appData->expects($this->once())
+			->method('getDirectoryListing')
+			->willReturn([$folder]);
+
+		$this->jsCombiner->resetCache();
+	}
+
 }

tests/lib/Template/SCSSCacherTest.php

@@ -85,6 +85,7 @@ public function testProcessUncachedFileNoAppDataFolder() {
 
 		$this->appData->expects($this->once())->method('getFolder')->with('core')->willThrowException(new NotFoundException());
 		$this->appData->expects($this->once())->method('newFolder')->with('core')->willReturn($folder);
+		$this->appData->method('getDirectoryListing')->willReturn([]);
 
 		$fileDeps = $this->createMock(ISimpleFile::class);
 		$gzfile = $this->createMock(ISimpleFile::class);
@@ -118,6 +119,7 @@ public function testProcessUncachedFileNoAppDataFolder() {
 	public function testProcessUncachedFile() {
 		$folder = $this->createMock(ISimpleFolder::class);
 		$this->appData->expects($this->once())->method('getFolder')->with('core')->willReturn($folder);
+		$this->appData->method('getDirectoryListing')->willReturn([]);
 		$file = $this->createMock(ISimpleFile::class);
 		$file->expects($this->any())->method('getSize')->willReturn(1);
 		$fileDeps = $this->createMock(ISimpleFile::class);
@@ -148,6 +150,7 @@ public function testProcessUncachedFile() {
 	public function testProcessCachedFile() {
 		$folder = $this->createMock(ISimpleFolder::class);
 		$this->appData->expects($this->once())->method('getFolder')->with('core')->willReturn($folder);
+		$this->appData->method('getDirectoryListing')->willReturn([]);
 		$file = $this->createMock(ISimpleFile::class);
 		$fileDeps = $this->createMock(ISimpleFile::class);
 		$fileDeps->expects($this->any())->method('getSize')->willReturn(1);
@@ -178,6 +181,7 @@ public function testProcessCachedFileMemcache() {
 			->willReturn($folder);
 		$folder->method('getName')
 			->willReturn('core');
+		$this->appData->method('getDirectoryListing')->willReturn([]);
 
 		$file = $this->createMock(ISimpleFile::class);
 
@@ -445,4 +449,25 @@ public function testgetWebDir($path, $appName, $webRoot, $serverRoot, $correctWe
 		$this->rrmdir($tmpDir.$path);
 	}
 
+	public function testResetCache() {
+		$file = $this->createMock(ISimpleFile::class);
+		$file->expects($this->once())
+			->method('delete');
+
+		$folder = $this->createMock(ISimpleFolder::class);
+		$folder->expects($this->once())
+			->method('getDirectoryListing')
+			->willReturn([$file]);
+
+		$this->depsCache->expects($this->once())
+			->method('clear')
+			->with('');
+		$this->appData->expects($this->once())
+			->method('getDirectoryListing')
+			->willReturn([$folder]);
+
+		$this->scssCacher->resetCache();
+	}
+
+
 }