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

Add logging of general exception to error log in federated share polling #37200

Closed
wants to merge 1 commit into from
Closed
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 apps/federatedfilesharing/lib/AppInfo/Application.php
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,7 @@ function ($c) use ($server) {
$server->getDatabaseConnection(),
$server->getUserManager(),
\OC\Files\Filesystem::getLoader(),
$server->getLogger(),
$externalManager,
$externalMountProvider
);
Expand Down
22 changes: 18 additions & 4 deletions apps/federatedfilesharing/lib/Command/PollIncomingShares.php
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
use OCP\Files\StorageInvalidException;
use OCP\Files\StorageNotAvailableException;
use OCP\IDBConnection;
use OCP\ILogger;
use OCP\IUserManager;
use OCP\Lock\LockedException;
use Symfony\Component\Console\Command\Command;
Expand All @@ -48,6 +49,9 @@ class PollIncomingShares extends Command {
/** @var IStorageFactory */
private $loader;

/** @var ILogger */
private $logger;

/** @var Manager */
private $externalManager;

Expand All @@ -60,14 +64,17 @@ class PollIncomingShares extends Command {
*
* @param IDBConnection $dbConnection
* @param IUserManager $userManager
* @param MountProvider $externalMountProvider
* @param IStorageFactory $loader
* @param ILogger $logger
* @param Manager|null $externalManager
* @param MountProvider|null $externalMountProvider
*/
public function __construct(IDBConnection $dbConnection, IUserManager $userManager, IStorageFactory $loader, Manager $externalManager = null, MountProvider $externalMountProvider = null) {
public function __construct(IDBConnection $dbConnection, IUserManager $userManager, IStorageFactory $loader, ILogger $logger, Manager $externalManager = null, MountProvider $externalMountProvider = null) {
parent::__construct();
$this->dbConnection = $dbConnection;
$this->userManager = $userManager;
$this->loader = $loader;
$this->logger = $logger;
$this->externalManager = $externalManager;
$this->externalMountProvider = $externalMountProvider;
}
Expand Down Expand Up @@ -124,13 +131,20 @@ public function execute(InputInterface $input, OutputInterface $output) {
$output->writeln(
"Remote \"$remote\" reports that external share with id \"$entryId\" no longer exists. Removing it.."
);
} catch (\Exception $e) {
} catch (StorageNotAvailableException $e) {
$entryId = $shareData['id'];
$remote = $shareData['remote'];
$reason = $e->getMessage();
$output->writeln(
"Skipping external share with id \"$entryId\" from remote \"$remote\". Reason: \"$reason\""
"Skipping external share with id \"$entryId\" from remote \"$remote\" as share is unreachable. Reason: \"$reason\""
);
} catch (\Exception $e) {
$entryId = $shareData['id'];
$remote = $shareData['remote'];
$output->writeln(
"Skipping external share with id \"$entryId\" from remote \"$remote\" due to internal server error"
);
$this->logger->logException($e, ['app' => 'federatedfilesharing']);
}
}
}
Expand Down
51 changes: 48 additions & 3 deletions apps/federatedfilesharing/tests/Command/PollIncomingSharesTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
use OCP\Files\Storage\IStorageFactory;
use OCP\Files\StorageNotAvailableException;
use OCP\IDBConnection;
use OCP\ILogger;
use OCP\IUser;
use OCP\IUserManager;
use PHPUnit\Framework\MockObject\MockObject;
Expand Down Expand Up @@ -61,6 +62,9 @@ class PollIncomingSharesTest extends TestCase {
/** @var IStorageFactory | MockObject */
private $loader;

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

/**
* @var Manager | MockObject
*/
Expand All @@ -71,9 +75,10 @@ protected function setUp(): void {
$this->dbConnection = $this->createMock(IDBConnection::class);
$this->userManager = $this->createMock(IUserManager::class);
$this->loader = $this->createMock(IStorageFactory::class);
$this->logger = $this->createMock(ILogger::class);
$this->externalManager = $this->createMock(Manager::class);
$this->externalMountProvider = $this->createMock(MountProvider::class);
$command = new PollIncomingShares($this->dbConnection, $this->userManager, $this->loader, $this->externalManager, $this->externalMountProvider);
$command = new PollIncomingShares($this->dbConnection, $this->userManager, $this->loader, $this->logger, $this->externalManager, $this->externalMountProvider);
$this->commandTester = new CommandTester($command);
}

Expand Down Expand Up @@ -103,7 +108,7 @@ public function testNoSharesPoll() {
}

public function testWithFilesSharingDisabled() {
$command = new PollIncomingShares($this->dbConnection, $this->userManager, $this->loader, $this->externalManager, null);
$command = new PollIncomingShares($this->dbConnection, $this->userManager, $this->loader, $this->logger, $this->externalManager, null);
$this->commandTester = new CommandTester($command);
$this->commandTester->execute([]);
$output = $this->commandTester->getDisplay();
Expand Down Expand Up @@ -148,7 +153,47 @@ public function testUnavailableStorage() {
$this->commandTester->execute([]);
$output = $this->commandTester->getDisplay();
$this->assertStringContainsString(
'Skipping external share with id "50" from remote "example.org". Reason: "Ooops"',
'Skipping external share with id "50" from remote "example.org" as share is unreachable. Reason: "Ooops"',
$output
);
}

public function testInternalServerError() {
$uid = 'foo';
$exprBuilder = $this->createMock(IExpressionBuilder::class);
$statementMock = $this->createMock(Statement::class);
$statementMock->method('fetch')->willReturnOnConsecutiveCalls(
['user' => $uid],
['id' => 50, 'remote' => 'example.org'],
false
);
$qbMock = $this->createMock(IQueryBuilder::class);
$qbMock->method('select')->willReturnSelf();
$qbMock->method('selectDistinct')->willReturnSelf();
$qbMock->method('from')->willReturnSelf();
$qbMock->method('where')->willReturnSelf();
$qbMock->method('expr')->willReturn($exprBuilder);
$qbMock->method('execute')->willReturn($statementMock);

$userMock = $this->createMock(IUser::class);
$this->userManager->expects($this->once())->method('get')
->with($uid)->willReturn($userMock);

$storage = $this->createMock(Storage::class);
$storage->method('hasUpdated')->willThrowException(new \Exception(''));
$storage->method('getRemote')->willReturn('example.org');

$mount = $this->createMock(\OCA\Files_Sharing\External\Mount::class);
$mount->method('getStorage')->willReturn($storage);
$mount->method('getMountPoint')->willReturn("/$uid/files/point");
$this->externalMountProvider->expects($this->once())->method('getMountsForUser')
->willReturn([$mount]);

$this->dbConnection->method('getQueryBuilder')->willReturn($qbMock);
$this->commandTester->execute([]);
$output = $this->commandTester->getDisplay();
$this->assertStringContainsString(
'Skipping external share with id "50" from remote "example.org" due to internal server error',
$output
);
}
Expand Down