From e21e53670c60b74ca2c49c01bf510ccdc5115b0d Mon Sep 17 00:00:00 2001 From: Carl Schwan Date: Mon, 19 Sep 2022 19:03:27 +0200 Subject: [PATCH] Move avatar clearing in the background Signed-off-by: Carl Schwan --- lib/composer/composer/autoload_classmap.php | 1 + lib/composer/composer/autoload_static.php | 1 + lib/private/Repair.php | 20 +++++----- .../Repair/ClearGeneratedAvatarCache.php | 9 +++-- .../Repair/ClearGeneratedAvatarCacheJob.php | 38 +++++++++++++++++++ .../Repair/ClearGeneratedAvatarCacheTest.php | 10 +++-- 6 files changed, 63 insertions(+), 16 deletions(-) create mode 100644 lib/private/Repair/ClearGeneratedAvatarCacheJob.php diff --git a/lib/composer/composer/autoload_classmap.php b/lib/composer/composer/autoload_classmap.php index 40a5efea3478c..1e1c5bd91d571 100644 --- a/lib/composer/composer/autoload_classmap.php +++ b/lib/composer/composer/autoload_classmap.php @@ -1434,6 +1434,7 @@ 'OC\\Repair\\CleanTags' => $baseDir . '/lib/private/Repair/CleanTags.php', 'OC\\Repair\\ClearFrontendCaches' => $baseDir . '/lib/private/Repair/ClearFrontendCaches.php', 'OC\\Repair\\ClearGeneratedAvatarCache' => $baseDir . '/lib/private/Repair/ClearGeneratedAvatarCache.php', + 'OC\\Repair\\ClearGeneratedAvatarCacheJob' => $baseDir . '/lib/private/Repair/ClearGeneratedAvatarCacheJob.php', 'OC\\Repair\\Collation' => $baseDir . '/lib/private/Repair/Collation.php', 'OC\\Repair\\Events\\RepairAdvanceEvent' => $baseDir . '/lib/private/Repair/Events/RepairAdvanceEvent.php', 'OC\\Repair\\Events\\RepairErrorEvent' => $baseDir . '/lib/private/Repair/Events/RepairErrorEvent.php', diff --git a/lib/composer/composer/autoload_static.php b/lib/composer/composer/autoload_static.php index 50a2406a8d105..cd3a75eff1e1e 100644 --- a/lib/composer/composer/autoload_static.php +++ b/lib/composer/composer/autoload_static.php @@ -1467,6 +1467,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2 'OC\\Repair\\CleanTags' => __DIR__ . '/../../..' . '/lib/private/Repair/CleanTags.php', 'OC\\Repair\\ClearFrontendCaches' => __DIR__ . '/../../..' . '/lib/private/Repair/ClearFrontendCaches.php', 'OC\\Repair\\ClearGeneratedAvatarCache' => __DIR__ . '/../../..' . '/lib/private/Repair/ClearGeneratedAvatarCache.php', + 'OC\\Repair\\ClearGeneratedAvatarCacheJob' => __DIR__ . '/../../..' . '/lib/private/Repair/ClearGeneratedAvatarCacheJob.php', 'OC\\Repair\\Collation' => __DIR__ . '/../../..' . '/lib/private/Repair/Collation.php', 'OC\\Repair\\Events\\RepairAdvanceEvent' => __DIR__ . '/../../..' . '/lib/private/Repair/Events/RepairAdvanceEvent.php', 'OC\\Repair\\Events\\RepairErrorEvent' => __DIR__ . '/../../..' . '/lib/private/Repair/Events/RepairErrorEvent.php', diff --git a/lib/private/Repair.php b/lib/private/Repair.php index e2e5da79216b5..a59e9409d69e1 100644 --- a/lib/private/Repair.php +++ b/lib/private/Repair.php @@ -200,22 +200,22 @@ public static function getRepairSteps() { ), new AddLogRotateJob(\OC::$server->getJobList()), new ClearFrontendCaches(\OC::$server->getMemCacheFactory(), \OC::$server->query(JSCombiner::class)), - new ClearGeneratedAvatarCache(\OC::$server->getConfig(), \OC::$server->query(AvatarManager::class)), + \OCP\Server::get(ClearGeneratedAvatarCache::class), new AddPreviewBackgroundCleanupJob(\OC::$server->getJobList()), new AddCleanupUpdaterBackupsJob(\OC::$server->getJobList()), new CleanupCardDAVPhotoCache(\OC::$server->getConfig(), \OC::$server->getAppDataDir('dav-photocache'), \OC::$server->get(LoggerInterface::class)), new AddClenupLoginFlowV2BackgroundJob(\OC::$server->getJobList()), new RemoveLinkShares(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig(), \OC::$server->getGroupManager(), \OC::$server->getNotificationManager(), \OC::$server->query(ITimeFactory::class)), new ClearCollectionsAccessCache(\OC::$server->getConfig(), \OC::$server->query(IManager::class)), - \OC::$server->query(ResetGeneratedAvatarFlag::class), - \OC::$server->query(EncryptionLegacyCipher::class), - \OC::$server->query(EncryptionMigration::class), - \OC::$server->get(ShippedDashboardEnable::class), - \OC::$server->get(AddBruteForceCleanupJob::class), - \OC::$server->get(AddCheckForUserCertificatesJob::class), - \OC::$server->get(RepairDavShares::class), - \OC::$server->get(LookupServerSendCheck::class), - \OC::$server->get(AddTokenCleanupJob::class), + \OCP\Server::get(ResetGeneratedAvatarFlag::class), + \OCP\Server::get(EncryptionLegacyCipher::class), + \OCP\Server::get(EncryptionMigration::class), + \OCP\Server::get(ShippedDashboardEnable::class), + \OCP\Server::get(AddBruteForceCleanupJob::class), + \OCP\Server::get(AddCheckForUserCertificatesJob::class), + \OCP\Server::get(RepairDavShares::class), + \OCP\Server::get(LookupServerSendCheck::class), + \OCP\Server::get(AddTokenCleanupJob::class), ]; } diff --git a/lib/private/Repair/ClearGeneratedAvatarCache.php b/lib/private/Repair/ClearGeneratedAvatarCache.php index 1c1be4f789327..db86d92cd87d7 100644 --- a/lib/private/Repair/ClearGeneratedAvatarCache.php +++ b/lib/private/Repair/ClearGeneratedAvatarCache.php @@ -26,16 +26,19 @@ use OC\Avatar\AvatarManager; use OCP\IConfig; +use OCP\BackgroundJob\IJobList; use OCP\Migration\IOutput; use OCP\Migration\IRepairStep; class ClearGeneratedAvatarCache implements IRepairStep { protected AvatarManager $avatarManager; private IConfig $config; + private IJobList $jobList; - public function __construct(IConfig $config, AvatarManager $avatarManager) { + public function __construct(IConfig $config, AvatarManager $avatarManager, IJobList $jobList) { $this->config = $config; $this->avatarManager = $avatarManager; + $this->jobList = $jobList; } public function getName(): string { @@ -55,8 +58,8 @@ private function shouldRun(): bool { public function run(IOutput $output): void { if ($this->shouldRun()) { try { - $this->avatarManager->clearCachedAvatars(); - $output->info('Avatar cache cleared'); + $this->jobList->add(ClearGeneratedAvatarCacheJob::class, []); + $output->info('Avatar cache clearing job added'); } catch (\Exception $e) { $output->warning('Unable to clear the avatar cache'); } diff --git a/lib/private/Repair/ClearGeneratedAvatarCacheJob.php b/lib/private/Repair/ClearGeneratedAvatarCacheJob.php new file mode 100644 index 0000000000000..e8513e7a933d7 --- /dev/null +++ b/lib/private/Repair/ClearGeneratedAvatarCacheJob.php @@ -0,0 +1,38 @@ + + * + * @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 . + * + */ +namespace OC\Repair; + +use OCP\BackgroundJob\QueuedJob; +use OCP\AppFramework\Utility\ITimeFactory; +use OC\Avatar\AvatarManager; + +class ClearGeneratedAvatarCacheJob extends QueuedJob { + protected AvatarManager $avatarManager; + + public function __construct(ITimeFactory $timeFactory, AvatarManager $avatarManager) { + parent::__construct($timeFactory); + $this->avatarManager = $avatarManager; + } + + public function run($argument) { + $this->avatarManager->clearCachedAvatars(); + } +} diff --git a/tests/lib/Repair/ClearGeneratedAvatarCacheTest.php b/tests/lib/Repair/ClearGeneratedAvatarCacheTest.php index de4c617961032..71842547462d7 100644 --- a/tests/lib/Repair/ClearGeneratedAvatarCacheTest.php +++ b/tests/lib/Repair/ClearGeneratedAvatarCacheTest.php @@ -25,6 +25,7 @@ use OC\Avatar\AvatarManager; use OC\Repair\ClearGeneratedAvatarCache; +use OCP\BackgroundJob\IJobList; use OCP\IConfig; use OCP\Migration\IOutput; @@ -39,8 +40,10 @@ class ClearGeneratedAvatarCacheTest extends \Test\TestCase { /** @var IConfig */ private $config; - /** @var ClearGeneratedAvatarCache */ - protected $repair; + /** @var IJobList */ + private $jobList; + + protected ClearGeneratedAvatarCache $repair; protected function setUp(): void { parent::setUp(); @@ -48,8 +51,9 @@ protected function setUp(): void { $this->outputMock = $this->createMock(IOutput::class); $this->avatarManager = $this->createMock(AvatarManager::class); $this->config = $this->createMock(IConfig::class); + $this->jobList = $this->createMock(IJobList::class); - $this->repair = new ClearGeneratedAvatarCache($this->config, $this->avatarManager); + $this->repair = new ClearGeneratedAvatarCache($this->config, $this->avatarManager, $this->jobList); } public function shouldRunDataProvider() {