Merge pull request #31064 from nextcloud/prune-calendar-changes
Add a background job to prune outdated sync tokenspull/34866/head
Christoph Wurst
GitHub
commit
08e11d7e14
@ -0,0 +1,64 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* @copyright 2022 Thomas Citharel <nextcloud@tcit.fr>
|
||||
*
|
||||
* @author Thomas Citharel <nextcloud@tcit.fr>
|
||||
*
|
||||
* @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 OCA\DAV\BackgroundJob;
|
||||
|
||||
use OCP\AppFramework\Utility\ITimeFactory;
|
||||
use OCP\BackgroundJob\TimedJob;
|
||||
use OCA\DAV\AppInfo\Application;
|
||||
use OCA\DAV\CalDAV\CalDavBackend;
|
||||
use OCA\DAV\CardDAV\CardDavBackend;
|
||||
use OCP\IConfig;
|
||||
use Psr\Log\LoggerInterface;
|
||||
|
||||
class PruneOutdatedSyncTokensJob extends TimedJob {
|
||||
|
||||
private IConfig $config;
|
||||
private LoggerInterface $logger;
|
||||
private CardDavBackend $cardDavBackend;
|
||||
private CalDavBackend $calDavBackend;
|
||||
|
||||
public function __construct(ITimeFactory $timeFactory, CalDavBackend $calDavBackend, CardDavBackend $cardDavBackend, IConfig $config, LoggerInterface $logger) {
|
||||
parent::__construct($timeFactory);
|
||||
$this->calDavBackend = $calDavBackend;
|
||||
$this->cardDavBackend = $cardDavBackend;
|
||||
$this->config = $config;
|
||||
$this->logger = $logger;
|
||||
$this->setInterval(60 * 60 * 24); // One day
|
||||
$this->setTimeSensitivity(self::TIME_INSENSITIVE);
|
||||
}
|
||||
|
||||
public function run($argument) {
|
||||
$limit = max(1, (int) $this->config->getAppValue(Application::APP_ID, 'totalNumberOfSyncTokensToKeep', '10000'));
|
||||
|
||||
$prunedCalendarSyncTokens = $this->calDavBackend->pruneOutdatedSyncTokens($limit);
|
||||
$prunedAddressBookSyncTokens = $this->cardDavBackend->pruneOutdatedSyncTokens($limit);
|
||||
|
||||
$this->logger->info('Pruned {calendarSyncTokensNumber} calendar sync tokens and {addressBooksSyncTokensNumber} address book sync tokens', [
|
||||
'calendarSyncTokensNumber' => $prunedCalendarSyncTokens,
|
||||
'addressBooksSyncTokensNumber' => $prunedAddressBookSyncTokens
|
||||
]);
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,104 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* @copyright 2018, Georg Ehrke <oc.list@georgehrke.com>
|
||||
*
|
||||
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
|
||||
* @author Georg Ehrke <oc.list@georgehrke.com>
|
||||
* @author Joas Schilling <coding@schilljs.com>
|
||||
* @author Morris Jobke <hey@morrisjobke.de>
|
||||
* @author Roeland Jago Douma <roeland@famdouma.nl>
|
||||
*
|
||||
* @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 OCA\DAV\Tests\unit\BackgroundJob;
|
||||
|
||||
use OCA\DAV\AppInfo\Application;
|
||||
use OCA\DAV\BackgroundJob\PruneOutdatedSyncTokensJob;
|
||||
use OCA\DAV\CalDAV\CalDavBackend;
|
||||
use OCA\DAV\CardDAV\CardDavBackend;
|
||||
use OCP\AppFramework\Utility\ITimeFactory;
|
||||
use OCP\DB\Exception;
|
||||
use OCP\IConfig;
|
||||
use PHPUnit\Framework\MockObject\MockObject;
|
||||
use Psr\Log\LoggerInterface;
|
||||
use Test\TestCase;
|
||||
|
||||
class PruneOutdatedSyncTokensJobTest extends TestCase {
|
||||
|
||||
/** @var CalDavBackend | MockObject */
|
||||
private $calDavBackend;
|
||||
|
||||
/** @var CardDavBackend | MockObject */
|
||||
private $cardDavBackend;
|
||||
|
||||
/** @var IConfig|MockObject */
|
||||
private $config;
|
||||
|
||||
/** @var LoggerInterface|MockObject*/
|
||||
private $logger;
|
||||
|
||||
/** @var PruneOutdatedSyncTokensJob */
|
||||
private PruneOutdatedSyncTokensJob $backgroundJob;
|
||||
|
||||
protected function setUp(): void {
|
||||
parent::setUp();
|
||||
|
||||
$this->timeFactory = $this->createMock(ITimeFactory::class);
|
||||
$this->calDavBackend = $this->createMock(CalDavBackend::class);
|
||||
$this->cardDavBackend = $this->createMock(CardDavBackend::class);
|
||||
$this->config = $this->createMock(IConfig::class);
|
||||
$this->logger = $this->createMock(LoggerInterface::class);
|
||||
|
||||
$this->backgroundJob = new PruneOutdatedSyncTokensJob($this->timeFactory, $this->calDavBackend, $this->cardDavBackend, $this->config, $this->logger);
|
||||
}
|
||||
|
||||
/**
|
||||
* @dataProvider dataForTestRun
|
||||
*/
|
||||
public function testRun(string $configValue, int $actualLimit, int $deletedCalendarSyncTokens, int $deletedAddressBookSyncTokens) {
|
||||
$this->config->expects($this->once())
|
||||
->method('getAppValue')
|
||||
->with(Application::APP_ID, 'totalNumberOfSyncTokensToKeep', '10000')
|
||||
->willReturn($configValue);
|
||||
$this->calDavBackend->expects($this->once())
|
||||
->method('pruneOutdatedSyncTokens')
|
||||
->with($actualLimit)
|
||||
->willReturn($deletedCalendarSyncTokens);
|
||||
$this->cardDavBackend->expects($this->once())
|
||||
->method('pruneOutdatedSyncTokens')
|
||||
->with($actualLimit)
|
||||
->willReturn($deletedAddressBookSyncTokens);
|
||||
$this->logger->expects($this->once())
|
||||
->method('info')
|
||||
->with('Pruned {calendarSyncTokensNumber} calendar sync tokens and {addressBooksSyncTokensNumber} address book sync tokens', [
|
||||
'calendarSyncTokensNumber' => $deletedCalendarSyncTokens,
|
||||
'addressBooksSyncTokensNumber' => $deletedAddressBookSyncTokens
|
||||
]);
|
||||
|
||||
$this->backgroundJob->run(null);
|
||||
}
|
||||
|
||||
public function dataForTestRun(): array {
|
||||
return [
|
||||
['100', 100, 2, 3],
|
||||
['0', 1, 0, 0]
|
||||
];
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue