Skip to content

[stable19] Also check responses of 400 errors and so delete unknown devices #760

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
nickvergessen merged 4 commits into from
Oct 1, 2020
Merged

[stable19] Also check responses of 400 errors and so delete unknown devices #760

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1384dab
Also check responses of 400 errors and so delete unknown devices
nickvergessen Sep 29, 2020
3c2a74f
Fix unit tests
nickvergessen Sep 30, 2020
0e66c05
Add test for the new code
nickvergessen Sep 30, 2020
938c005
Add a comment for the array check
nickvergessen Sep 30, 2020
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
68 changes: 47 additions & 21 deletions lib/Push.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@
namespace OCA\Notifications;


use GuzzleHttp\Exception\ClientException;
use GuzzleHttp\Exception\ServerException;
use OC\Authentication\Exceptions\InvalidTokenException;
use OC\Authentication\Token\IProvider;
use OC\Security\IdentityProof\Key;
Expand Down Expand Up @@ -263,44 +265,68 @@ protected function sendNotificationsToProxies(): void {
'notifications' => $notifications,
],
]);
} catch (\Exception $e) {
$this->log->logException($e, [
} catch (ClientException $e) {
// Server responded with 4xx (400 Bad Request mostlikely)
$response = $e->getResponse();
} catch (ServerException $e) {
// Server responded with 5xx
$response = $e->getResponse();
$body = $response->getBody();
$error = \is_string($body) ? $body : ('no reason given (' . $response->getStatusCode() . ')');

$this->log->debug('Could not send notification to push server [{url}]: {error}', [
'error' => $error,
'url' => $proxyServer,
'app' => 'notifications',
'level' => $e->getCode() === Http::STATUS_BAD_REQUEST ? ILogger::INFO : ILogger::WARN,
]);
continue;
}

$status = $response->getStatusCode();
if ($status === Http::STATUS_SERVICE_UNAVAILABLE && $this->config->getSystemValue('debug', false)) {
$body = $response->getBody();
$this->log->debug('Could not send notification to push server [{url}]: {error}',[
'error' => \is_string($body) ? $body : 'no reason given',
'url' => $proxyServer,
$this->printInfo('Could not send notification to push server [' . $proxyServer . ']: ' . $error);
continue;
} catch (\Exception $e) {
$this->log->logException($e, [
'app' => 'notifications',
'level' => ILogger::ERROR,
]);

$error = $e->getMessage() ?: 'no reason given';
$this->printInfo('Could not send notification to push server [' . get_class($e) . ']: ' . $error);
continue;
}

$status = $response->getStatusCode();
$body = $response->getBody();
$bodyData = json_decode($body, true);
if ($status !== Http::STATUS_OK) {

if (is_array($bodyData) && isset($bodyData['unknown'], $bodyData['failed'])) {
if (is_array($bodyData['unknown'])) {
// Proxy returns null when the array is empty
foreach ($bodyData['unknown'] as $unknownDevice) {
$this->printInfo('Deleting device because it is unknown by the push server: ' . $unknownDevice);
$this->deletePushTokenByDeviceIdentifier($unknownDevice);
}
}

if ($bodyData['failed'] !== 0) {
$this->printInfo('Push notification sent, but ' . $bodyData['failed'] . ' failed');
} else {
$this->printInfo('Push notification sent successfully');
}
} elseif ($status !== Http::STATUS_OK) {
$error = \is_string($body) && $bodyData === null ? $body : 'no reason given';
$this->printInfo('Could not send notification to push server [' . $proxyServer . ']: ' . $error);
$this->log->error('Could not send notification to push server [{url}]: {error}', [
$this->log->warning('Could not send notification to push server [{url}]: {error}', [
'error' => $error,
'url' => $proxyServer,
'app' => 'notifications',
]);
} else {
$this->printInfo('Push notification sent');
}

if (is_array($bodyData) && !empty($bodyData['unknown']) && is_array($bodyData['unknown'])) {
foreach ($bodyData['unknown'] as $unknownDevice) {
$this->printInfo('Deleting device because it is unknown by the push server: ' . $unknownDevice);
$this->deletePushTokenByDeviceIdentifier($unknownDevice);
}
$error = \is_string($body) && $bodyData === null ? $body : 'no reason given';
$this->printInfo('Push notification sent but response was not parsable, using an outdated push proxy? [' . $proxyServer . ']: ' . $error);
$this->log->info('Push notification sent but response was not parsable, using an outdated push proxy? [{url}]: {error}', [
'error' => $error,
'url' => $proxyServer,
'app' => 'notifications',
]);
}
}
}
Expand Down
97 changes: 67 additions & 30 deletions tests/Unit/PushTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@
namespace OCA\Notifications\Tests\Unit;


use GuzzleHttp\Exception\ClientException;
use GuzzleHttp\Exception\ServerException;
use OC\Authentication\Exceptions\InvalidTokenException;
use OC\Authentication\Token\IProvider;
use OC\Security\IdentityProof\Key;
Expand Down Expand Up @@ -403,11 +405,11 @@ public function dataPushToDeviceSending() {
* @param bool $isDebug
*/
public function testPushToDeviceSending($isDebug) {
$push = $this->getPush(['getDevicesForUser', 'encryptAndSign', 'deletePushToken', 'validateToken']);
$push = $this->getPush(['getDevicesForUser', 'encryptAndSign', 'deletePushToken', 'validateToken', 'deletePushTokenByDeviceIdentifier']);

/** @var INotification|MockObject $notification */
$notification = $this->createMock(INotification::class);
$notification->expects($this->exactly(3))
$notification
->method('getUser')
->willReturn('valid');

Expand Down Expand Up @@ -447,12 +449,16 @@ public function testPushToDeviceSending($isDebug) {
'token' => 64,
'apptype' => 'other',
],
[
'proxyserver' => 'badrequest-with-devices',
'token' => 128,
'apptype' => 'other',
],
]);

$this->config->expects($this->exactly(2))
$this->config->expects($this->exactly(1))
->method('getSystemValue')
->willReturnMap([
['debug', false, $isDebug],
['force_language', false, false],
]);

Expand All @@ -474,11 +480,11 @@ public function testPushToDeviceSending($isDebug) {
->with($user)
->willReturn($key);

$push->expects($this->exactly(5))
$push->expects($this->exactly(6))
->method('validateToken')
->willReturn(true);

$push->expects($this->exactly(5))
$push->expects($this->exactly(6))
->method('encryptAndSign')
->willReturn(['Payload']);

Expand All @@ -501,17 +507,17 @@ public function testPushToDeviceSending($isDebug) {
$client->expects($this->at(0))
->method('post')
->with('proxyserver1/notifications', [
'body' => [
'notifications' => ['["Payload"]', '["Payload"]'],
],
])
'body' => [
'notifications' => ['["Payload"]', '["Payload"]'],
],
])
->willThrowException($e);

$this->logger->expects($this->at(0))
->method('logException')
->with($e, [
'app' => 'notifications',
'level' => ILogger::WARN,
'level' => ILogger::ERROR,
]);

/** @var IResponse|MockObject $response1 */
Expand All @@ -522,17 +528,20 @@ public function testPushToDeviceSending($isDebug) {
$response1->expects($this->once())
->method('getBody')
->willReturn(null);
$e = $this->createMock(ClientException::class);
$e->method('getResponse')
->willReturn($response1);
$client->expects($this->at(1))
->method('post')
->with('badrequest/notifications', [
'body' => [
'notifications' => ['["Payload"]'],
],
])
->willReturn($response1);
'body' => [
'notifications' => ['["Payload"]'],
],
])
->willThrowException($e);

$this->logger->expects($this->at(1))
->method('error')
->method('warning')
->with('Could not send notification to push server [{url}]: {error}', [
'error' => 'no reason given',
'url' => 'badrequest',
Expand All @@ -541,22 +550,22 @@ public function testPushToDeviceSending($isDebug) {

/** @var IResponse|MockObject $response1 */
$response2 = $this->createMock(IResponse::class);
$response2->expects($this->once())
->method('getStatusCode')
->willReturn(Http::STATUS_SERVICE_UNAVAILABLE);
$response2->expects($this->once())
->method('getBody')
->willReturn('Maintenance');
$e = $this->createMock(ServerException::class);
$e->method('getResponse')
->willReturn($response2);
$client->expects($this->at(2))
->method('post')
->with('unavailable/notifications', [
'body' => [
'notifications' => ['["Payload"]'],
],
])
->willReturn($response2);
'body' => [
'notifications' => ['["Payload"]'],
],
])
->willThrowException($e);

$this->logger->expects($isDebug ? $this->at(2) : $this->never())
$this->logger->expects($this->at(2))
->method('debug')
->with('Could not send notification to push server [{url}]: {error}', [
'error' => 'Maintenance',
Expand All @@ -572,12 +581,40 @@ public function testPushToDeviceSending($isDebug) {
$client->expects($this->at(3))
->method('post')
->with('ok/notifications', [
'body' => [
'notifications' => ['["Payload"]'],
],
])
'body' => [
'notifications' => ['["Payload"]'],
],
])
->willReturn($response3);

/** @var IResponse|MockObject $response1 */
$response4 = $this->createMock(IResponse::class);
$response4->expects($this->once())
->method('getStatusCode')
->willReturn(Http::STATUS_BAD_REQUEST);
$response4->expects($this->once())
->method('getBody')
->willReturn(json_encode([
'failed' => 1,
'unknown' => [
'123456'
]
]));
$e = $this->createMock(ClientException::class);
$e->method('getResponse')
->willReturn($response4);
$client->expects($this->at(4))
->method('post')
->with('badrequest-with-devices/notifications', [
'body' => [
'notifications' => ['["Payload"]'],
],
])
->willThrowException($e);

$push->method('deletePushTokenByDeviceIdentifier')
->with('123456');

$push->pushToDevice(207787, $notification);
}

Expand Down