Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[stable25] Move avatar clearing in the background #34192

Merged
merged 1 commit into from
Sep 22, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions lib/composer/composer/autoload_classmap.php
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
1 change: 1 addition & 0 deletions lib/composer/composer/autoload_static.php
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
20 changes: 10 additions & 10 deletions lib/private/Repair.php
Original file line number Diff line number Diff line change
Expand Up @@ -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),
];
}

Expand Down
9 changes: 6 additions & 3 deletions lib/private/Repair/ClearGeneratedAvatarCache.php
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand All @@ -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');
}
Expand Down
38 changes: 38 additions & 0 deletions lib/private/Repair/ClearGeneratedAvatarCacheJob.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<?php
/**
* @copyright 2022 Carl Schwan <carl@carlschwan.eu>
*
* @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 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();
}
}
10 changes: 7 additions & 3 deletions tests/lib/Repair/ClearGeneratedAvatarCacheTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@

use OC\Avatar\AvatarManager;
use OC\Repair\ClearGeneratedAvatarCache;
use OCP\BackgroundJob\IJobList;
use OCP\IConfig;
use OCP\Migration\IOutput;

Expand All @@ -39,17 +40,20 @@ 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();

$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() {
Expand Down