mbk-lab
/
nextcloud
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #23504 from nextcloud/backport/23490/stable19 

[stable19] Provide log statements for SCSS cache
This commit is contained in:
Morris Jobke 2020-10-16 13:23:54 +02:00 committed by GitHub
parent 5ce47c8e31 6a1540dd98
commit 6f21fd14bf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
lib/private/Template/SCSSCacher.php
View File

@ -146,6 +146,7 @@ class SCSSCacher {
$path = implode('/', $path); $path = implode('/', $path);
$webDir = $this->getWebDir($path, $app, $this->serverRoot, \OC::$WEBROOT); $webDir = $this->getWebDir($path, $app, $this->serverRoot, \OC::$WEBROOT);
$this->logger->debug('SCSSCacher::process ordinary check follows', ['app' => 'scss_cacher']);
if (!$this->variablesChanged() && $this->isCached($fileNameCSS, $app)) { if (!$this->variablesChanged() && $this->isCached($fileNameCSS, $app)) {
// Inject icons vars css if any // Inject icons vars css if any
return $this->injectCssVariablesIfAny(); return $this->injectCssVariablesIfAny();
@ -161,23 +162,25 @@ class SCSSCacher {
$lockKey = $webDir . '/' . $fileNameSCSS; $lockKey = $webDir . '/' . $fileNameSCSS;
if (!$this->lockingCache->add($lockKey, 'locked!', 120)) { if (!$this->lockingCache->add($lockKey, 'locked!', 120)) {
$this->logger->debug('SCSSCacher::process could not get lock for ' . $lockKey . ' and will wait 10 seconds for cached file to be available', ['app' => 'scss_cacher']);
$retry = 0; $retry = 0;
sleep(1); sleep(1);
while ($retry < 10) { while ($retry < 10) {
$this->logger->debug('SCSSCacher::process check in while loop follows', ['app' => 'scss_cacher']);
if (!$this->variablesChanged() && $this->isCached($fileNameCSS, $app)) { if (!$this->variablesChanged() && $this->isCached($fileNameCSS, $app)) {
// Inject icons vars css if any // Inject icons vars css if any
$this->lockingCache->remove($lockKey); $this->lockingCache->remove($lockKey);
$this->logger->debug('SCSSCacher: ' .$lockKey.' is now available after '.$retry.'s. Moving on...', ['app' => 'core']); $this->logger->debug("SCSSCacher::process cached file for app '$app' and file '$fileNameCSS' is now available after $retry s. Moving on...", ['app' => 'scss_cacher']);
return $this->injectCssVariablesIfAny(); return $this->injectCssVariablesIfAny();
} }
$this->logger->debug('SCSSCacher: scss cache file locked for '.$lockKey, ['app' => 'core']);
sleep(1); sleep(1);
$retry++; $retry++;
} }
$this->logger->debug('SCSSCacher: Giving up scss caching for '.$lockKey, ['app' => 'core']); $this->logger->debug('SCSSCacher::process Giving up scss caching for ' . $lockKey, ['app' => 'scss_cacher']);
return false; return false;
} }
$this->logger->debug('SCSSCacher::process Lock acquired for ' . $lockKey, ['app' => 'scss_cacher']);
try { try {
$cached = $this->cache($path, $fileNameCSS, $fileNameSCSS, $folder, $webDir); $cached = $this->cache($path, $fileNameCSS, $fileNameSCSS, $folder, $webDir);
} catch (\Exception $e) { } catch (\Exception $e) {
@ -187,6 +190,7 @@ class SCSSCacher {
// Cleaning lock // Cleaning lock
$this->lockingCache->remove($lockKey); $this->lockingCache->remove($lockKey);
$this->logger->debug('SCSSCacher::process Lock removed for ' . $lockKey, ['app' => 'scss_cacher']);
// Inject icons vars css if any // Inject icons vars css if any
if ($this->iconsCacher->getCachedCSS() && $this->iconsCacher->getCachedCSS()->getSize() > 0) { if ($this->iconsCacher->getCachedCSS() && $this->iconsCacher->getCachedCSS()->getSize() > 0) {
@ -224,11 +228,13 @@ class SCSSCacher {
return true; return true;
} }
} }
$this->logger->debug("SCSSCacher::isCached $fileNameCSS isCachedCache is expired or unset", ['app' => 'scss_cacher']);
// Creating file cache if none for further checks // Creating file cache if none for further checks
try { try {
$folder = $this->appData->getFolder($app); $folder = $this->appData->getFolder($app);
} catch (NotFoundException $e) { } catch (NotFoundException $e) {
$this->logger->debug("SCSSCacher::isCached app data folder for $app could not be fetched", ['app' => 'scss_cacher']);
return false; return false;
} }
@ -249,16 +255,20 @@ class SCSSCacher {
foreach ((array) $deps as $file => $mtime) { foreach ((array) $deps as $file => $mtime) {
if (!file_exists($file) || filemtime($file) > $mtime) { if (!file_exists($file) || filemtime($file) > $mtime) {
$this->logger->debug("SCSSCacher::isCached $fileNameCSS is not considered as cached due to deps file $file", ['app' => 'scss_cacher']);
return false; return false;
} }
} }
$this->logger->debug("SCSSCacher::isCached $fileNameCSS dependencies successfully cached for 5 minutes", ['app' => 'scss_cacher']);
// It would probably make sense to adjust this timeout to something higher and see if that has some effect then
$this->isCachedCache->set($key, $this->timeFactory->getTime() + 5 * 60); $this->isCachedCache->set($key, $this->timeFactory->getTime() + 5 * 60);
return true; return true;
} }
$this->logger->debug("SCSSCacher::isCached $fileNameCSS is not considered as cached cacheValue: $cacheValue", ['app' => 'scss_cacher']);
return false; return false;
} catch (NotFoundException $e) { } catch (NotFoundException $e) {
$this->logger->debug("SCSSCacher::isCached NotFoundException " . $e->getMessage(), ['app' => 'scss_cacher']);
return false; return false;
} }
} }
@ -270,6 +280,7 @@ class SCSSCacher {
private function variablesChanged(): bool { private function variablesChanged(): bool {
$injectedVariables = $this->getInjectedVariables(); $injectedVariables = $this->getInjectedVariables();
if ($this->config->getAppValue('core', 'theming.variables') !== md5($injectedVariables)) { if ($this->config->getAppValue('core', 'theming.variables') !== md5($injectedVariables)) {
$this->logger->debug('SCSSCacher::variablesChanged storedVariables: ' . json_encode($this->config->getAppValue('core', 'theming.variables')) . ' currentInjectedVariables: ' . json_encode($injectedVariables), ['app' => 'scss_cacher']);
$this->config->setAppValue('core', 'theming.variables', md5($injectedVariables)); $this->config->setAppValue('core', 'theming.variables', md5($injectedVariables));
$this->resetCache(); $this->resetCache();
return true; return true;
@ -328,7 +339,7 @@ class SCSSCacher {
'@import "functions.scss";' . '@import "functions.scss";' .
'@import "' . $fileNameSCSS . '";'); '@import "' . $fileNameSCSS . '";');
} catch (ParserException $e) { } catch (ParserException $e) {
$this->logger->logException($e, ['app' => 'core']); $this->logger->logException($e, ['app' => 'scss_cacher']);
return false; return false;
} }
@ -350,11 +361,11 @@ class SCSSCacher {
$depFile->putContent($deps); $depFile->putContent($deps);
$this->depsCache->set($folder->getName() . '-' . $depFileName, $deps); $this->depsCache->set($folder->getName() . '-' . $depFileName, $deps);
$gzipFile->putContent(gzencode($data, 9)); $gzipFile->putContent(gzencode($data, 9));
$this->logger->debug('SCSSCacher: ' . $webDir . '/' . $fileNameSCSS . ' compiled and successfully cached', ['app' => 'core']); $this->logger->debug('SCSSCacher::cache ' . $webDir . '/' . $fileNameSCSS . ' compiled and successfully cached', ['app' => 'scss_cacher']);
return true; return true;
} catch (NotPermittedException $e) { } catch (NotPermittedException $e) {
$this->logger->error('SCSSCacher: unable to cache: ' . $fileNameSCSS); $this->logger->error('SCSSCacher::cache unable to cache: ' . $fileNameSCSS, ['app' => 'scss_cacher']);
return false; return false;
} }
@ -365,9 +376,12 @@ class SCSSCacher {
* We need to regenerate all files when variables change * We need to regenerate all files when variables change
*/ */
public function resetCache() { public function resetCache() {
$this->logger->debug('SCSSCacher::resetCache', ['app' => 'scss_cacher']);
if (!$this->lockingCache->add('resetCache', 'locked!', 120)) { if (!$this->lockingCache->add('resetCache', 'locked!', 120)) {
$this->logger->debug('SCSSCacher::resetCache Locked', ['app' => 'scss_cacher']);
return; return;
} }
$this->logger->debug('SCSSCacher::resetCache Lock acquired', ['app' => 'scss_cacher']);
$this->injectedVariables = null; $this->injectedVariables = null;
// do not clear locks // do not clear locks
@ -380,12 +394,13 @@ class SCSSCacher {
try { try {
$file->delete(); $file->delete();
} catch (NotPermittedException $e) { } catch (NotPermittedException $e) {
$this->logger->logException($e, ['message' => 'SCSSCacher: unable to delete file: ' . $file->getName()]); $this->logger->logException($e, ['message' => 'SCSSCacher::resetCache unable to delete file: ' . $file->getName(), 'app' => 'scss_cacher']);
} }
} }
} }
$this->logger->debug('SCSSCacher: css cache cleared!'); $this->logger->debug('SCSSCacher::resetCache css cache cleared!', ['app' => 'scss_cacher']);
$this->lockingCache->remove('resetCache'); $this->lockingCache->remove('resetCache');
$this->logger->debug('SCSSCacher::resetCache Locking removed', ['app' => 'scss_cacher']);
} }
/** /**
@ -406,7 +421,7 @@ class SCSSCacher {
$scss->compile($variables); $scss->compile($variables);
$this->injectedVariables = $variables; $this->injectedVariables = $variables;
} catch (ParserException $e) { } catch (ParserException $e) {
$this->logger->logException($e, ['app' => 'core']); $this->logger->logException($e, ['app' => 'scss_cacher']);
} }
return $variables; return $variables;