Skip to content

[Stable23] Logging, updating status for general error in federation #33103

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.

Sign up for GitHub

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

Merged
blizzz merged 1 commit into from
Aug 1, 2022
Merged

[Stable23] Logging, updating status for general error in federation #33103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 4 additions & 2 deletions apps/dav/lib/CardDAV/SyncService.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,11 @@ public function syncRemoteAddressBook($url, $userName, $addressBookUrl, $sharedS
if ($ex->getCode() === Http::STATUS_UNAUTHORIZED) {
// remote server revoked access to the address book, remove it
$this->backend->deleteAddressBook($addressBookId);
$this->logger->info('Authorization failed, remove address book: ' . $url, ['app' => 'dav']);
throw $ex;
$this->logger->error('Authorization failed, remove address book: ' . $url, ['app' => 'dav']);

Check notice

Code scanning / Psalm

DeprecatedMethod

The method OCP\ILogger::error has been marked as deprecated
} else {
$this->logger->error('Client exception:', ['app' => 'dav', 'exception' => $ex]);

Check notice

Code scanning / Psalm

DeprecatedMethod

The method OCP\ILogger::error has been marked as deprecated
}
throw $ex;
}

// 3. apply changes
Expand Down
20 changes: 14 additions & 6 deletions apps/federation/lib/SyncFederationAddressBooks.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
use OCA\DAV\CardDAV\SyncService;
use OCP\AppFramework\Http;
use OCP\OCS\IDiscoveryService;
use Psr\Log\LoggerInterface;

class SyncFederationAddressBooks {

Expand All @@ -41,18 +42,18 @@ class SyncFederationAddressBooks {
/** @var DiscoveryService */
private $ocsDiscoveryService;

/**
* @param DbHandler $dbHandler
* @param SyncService $syncService
* @param IDiscoveryService $ocsDiscoveryService
*/
/** @var LoggerInterface */
private $logger;

public function __construct(DbHandler $dbHandler,
SyncService $syncService,
IDiscoveryService $ocsDiscoveryService
IDiscoveryService $ocsDiscoveryService,
LoggerInterface $logger
) {
$this->syncService = $syncService;
$this->dbHandler = $dbHandler;
$this->ocsDiscoveryService = $ocsDiscoveryService;
$this->logger = $logger;
}

/**
Expand All @@ -71,6 +72,7 @@ public function syncThemAll(\Closure $callback) {
$addressBookUrl = isset($endPoints['system-address-book']) ? trim($endPoints['system-address-book'], '/') : 'remote.php/dav/addressbooks/system/system/system';

if (is_null($sharedSecret)) {
$this->logger->error('Shared secret is null');
continue;
}
$targetBookId = $trustedServer['url_hash'];
Expand All @@ -82,10 +84,16 @@ public function syncThemAll(\Closure $callback) {
$newToken = $this->syncService->syncRemoteAddressBook($url, $cardDavUser, $addressBookUrl, $sharedSecret, $syncToken, $targetBookId, $targetPrincipal, $targetBookProperties);
if ($newToken !== $syncToken) {
$this->dbHandler->setServerStatus($url, TrustedServers::STATUS_OK, $newToken);
} else {
$this->logger->info('Token unchanged from previous sync.');
}
} catch (\Exception $ex) {
if ($ex->getCode() === Http::STATUS_UNAUTHORIZED) {
$this->dbHandler->setServerStatus($url, TrustedServers::STATUS_ACCESS_REVOKED);
$this->logger->error('Server sync failed because of revoked access.');
} else {
$this->dbHandler->setServerStatus($url, TrustedServers::STATUS_FAILURE);
$this->logger->error('Server sync failed.');
}
$callback($url, $ex);
}
Expand Down
17 changes: 8 additions & 9 deletions apps/federation/lib/SyncJob.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,21 +26,20 @@
namespace OCA\Federation;

use OC\BackgroundJob\TimedJob;
use OCP\ILogger;
use Psr\Log\LoggerInterface;

class SyncJob extends TimedJob {

/** @var SyncFederationAddressBooks */
protected $syncService;

/** @var ILogger */
/** @var LoggerInterface */
protected $logger;

/**
* @param SyncFederationAddressBooks $syncService
* @param ILogger $logger
*/
public function __construct(SyncFederationAddressBooks $syncService, ILogger $logger) {
public function __construct(SyncFederationAddressBooks $syncService, LoggerInterface $logger) {
// Run once a day
$this->setInterval(24 * 60 * 60);
$this->syncService = $syncService;
Expand All @@ -50,11 +49,11 @@ public function __construct(SyncFederationAddressBooks $syncService, ILogger $lo
protected function run($argument) {
$this->syncService->syncThemAll(function ($url, $ex) {
if ($ex instanceof \Exception) {
$this->logger->logException($ex, [
'message' => "Error while syncing $url.",
'level' => ILogger::INFO,
'app' => 'fed-sync',
]);
$this->logger->error("Error while syncing $url.",
[
'exception' => $ex
]
);
}
});
}
Expand Down
20 changes: 13 additions & 7 deletions apps/federation/tests/SyncFederationAddressbooksTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,25 +31,31 @@
use OC\OCS\DiscoveryService;
use OCA\Federation\DbHandler;
use OCA\Federation\SyncFederationAddressBooks;
use PHPUnit\Framework\MockObject\MockObject;
use Psr\Log\LoggerInterface;

class SyncFederationAddressbooksTest extends \Test\TestCase {

/** @var array */
private $callBacks = [];

/** @var \PHPUnit\Framework\MockObject\MockObject | DiscoveryService */
/** @var MockObject | DiscoveryService */
private $discoveryService;

/** @var MockObject|LoggerInterface */
private $logger;

protected function setUp(): void {
parent::setUp();

$this->discoveryService = $this->getMockBuilder(DiscoveryService::class)
->disableOriginalConstructor()->getMock();
$this->discoveryService->expects($this->any())->method('discover')->willReturn([]);
$this->logger = $this->createMock(LoggerInterface::class);
}

public function testSync() {
/** @var DbHandler | \PHPUnit\Framework\MockObject\MockObject $dbHandler */
/** @var DbHandler | MockObject $dbHandler */
$dbHandler = $this->getMockBuilder('OCA\Federation\DbHandler')->
disableOriginalConstructor()->
getMock();
Expand All @@ -62,24 +68,24 @@ public function testSync() {
'sync_token' => '0'
]
]);
$dbHandler->expects($this->once())->method('setServerStatus')->
with('https://cloud.drop.box', 1, '1');
$dbHandler->expects($this->once())->method('setServerStatus')
->with('https://cloud.drop.box', 1, '1');
$syncService = $this->getMockBuilder('OCA\DAV\CardDAV\SyncService')
->disableOriginalConstructor()
->getMock();
$syncService->expects($this->once())->method('syncRemoteAddressBook')
->willReturn(1);

/** @var \OCA\DAV\CardDAV\SyncService $syncService */
$s = new SyncFederationAddressBooks($dbHandler, $syncService, $this->discoveryService);
$s = new SyncFederationAddressBooks($dbHandler, $syncService, $this->discoveryService, $this->logger);
$s->syncThemAll(function ($url, $ex) {
$this->callBacks[] = [$url, $ex];
});
$this->assertEquals(1, count($this->callBacks));
}

public function testException() {
/** @var DbHandler | \PHPUnit\Framework\MockObject\MockObject $dbHandler */
/** @var DbHandler | MockObject $dbHandler */
$dbHandler = $this->getMockBuilder('OCA\Federation\DbHandler')->
disableOriginalConstructor()->
getMock();
Expand All @@ -99,7 +105,7 @@ public function testException() {
->willThrowException(new \Exception('something did not work out'));

/** @var \OCA\DAV\CardDAV\SyncService $syncService */
$s = new SyncFederationAddressBooks($dbHandler, $syncService, $this->discoveryService);
$s = new SyncFederationAddressBooks($dbHandler, $syncService, $this->discoveryService, $this->logger);
$s->syncThemAll(function ($url, $ex) {
$this->callBacks[] = [$url, $ex];
});
Expand Down