Skip to content

[stable28] fix(push): Make testing the push server easier #2087

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 2 commits into from
Oct 28, 2024
Merged

[stable28] fix(push): Make testing the push server easier #2087

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4c672db
fix(push): Make testing the push server easier
nickvergessen Oct 10, 2024
0a35ef2
fix(push): Use fallback keys that look like a real one
nickvergessen Oct 11, 2024
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
25 changes: 20 additions & 5 deletions lib/Push.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
use OCP\L10N\IFactory;
use OCP\Notification\IManager as INotificationManager;
use OCP\Notification\INotification;
use OCP\Security\ISecureRandom;
use OCP\UserStatus\IManager as IUserStatusManager;
use OCP\UserStatus\IUserStatus;
use OCP\Util;
Expand Down Expand Up @@ -131,6 +132,7 @@ public function __construct(
IUserStatusManager $userStatusManager,
IFactory $l10nFactory,
protected ITimeFactory $timeFactory,
protected ISecureRandom $random,
LoggerInterface $log,
) {
$this->db = $connection;
Expand Down Expand Up @@ -482,6 +484,17 @@ protected function sendNotificationsToProxies(): void {
return;
}

$subscriptionAwareServer = rtrim($this->config->getAppValue(Application::APP_ID, 'subscription_aware_server', 'https://push-notifications.nextcloud.com'), '/');
if ($subscriptionAwareServer === 'https://push-notifications.nextcloud.com') {
$subscriptionKey = $this->config->getAppValue('support', 'subscription_key');
} else {
$subscriptionKey = $this->config->getAppValue(Application::APP_ID, 'push_subscription_key');
if ($subscriptionKey === '') {
$subscriptionKey = $this->createPushSubscriptionKey();
$this->config->setAppValue(Application::APP_ID, 'push_subscription_key', $subscriptionKey);
}
}

$client = $this->clientService->newClient();
foreach ($pushNotifications as $proxyServer => $notifications) {
try {
Expand All @@ -491,11 +504,8 @@ protected function sendNotificationsToProxies(): void {
],
];

if ($proxyServer === 'https://push-notifications.nextcloud.com') {
$subscriptionKey = $this->config->getAppValue('support', 'subscription_key');
if ($subscriptionKey) {
$requestData['headers']['X-Nextcloud-Subscription-Key'] = $subscriptionKey;
}
if ($subscriptionKey !== '' && $proxyServer === $subscriptionAwareServer) {
$requestData['headers']['X-Nextcloud-Subscription-Key'] = $subscriptionKey;
}

$response = $client->post($proxyServer . '/notifications', $requestData);
Expand Down Expand Up @@ -781,4 +791,9 @@ protected function deletePushTokenByDeviceIdentifier(string $deviceIdentifier):
protected function createFakeUserObject(string $userId): IUser {
return new FakeUser($userId);
}

protected function createPushSubscriptionKey(): string {
$key = $this->random->generate(25, ISecureRandom::CHAR_ALPHANUMERIC);
return implode('-', str_split($key, 5));
}
}
23 changes: 22 additions & 1 deletion tests/Unit/PushTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
use OCP\L10N\IFactory;
use OCP\Notification\IManager as INotificationManager;
use OCP\Notification\INotification;
use OCP\Security\ISecureRandom;
use OCP\UserStatus\IManager as IUserStatusManager;
use PHPUnit\Framework\MockObject\MockObject;
use Psr\Http\Message\ResponseInterface;
Expand Down Expand Up @@ -77,6 +78,8 @@ class PushTest extends TestCase {
protected $l10nFactory;
/** @var ITimeFactory|MockObject */
protected $timeFactory;
/** @var ISecureRandom|MockObject */
protected $random;
/** @var LoggerInterface|MockObject */
protected $logger;

Expand All @@ -94,6 +97,7 @@ protected function setUp(): void {
$this->userStatusManager = $this->createMock(IUserStatusManager::class);
$this->l10nFactory = $this->createMock(IFactory::class);
$this->timeFactory = $this->createMock(ITimeFactory::class);
$this->random = $this->createMock(ISecureRandom::class);
$this->logger = $this->createMock(LoggerInterface::class);

$this->cacheFactory->method('createDistributed')
Expand All @@ -119,6 +123,7 @@ protected function getPush(array $methods = []) {
$this->userStatusManager,
$this->l10nFactory,
$this->timeFactory,
$this->random,
$this->logger,
])
->setMethods($methods)
Expand All @@ -135,7 +140,9 @@ protected function getPush(array $methods = []) {
$this->cacheFactory,
$this->userStatusManager,
$this->l10nFactory,
$this->logger
$this->timeFactory,
$this->random,
$this->logger,
);
}

Expand Down Expand Up @@ -513,6 +520,13 @@ public function testPushToDeviceSending($isDebug) {
->with('debug', false)
->willReturn($isDebug);

$this->config
->method('getAppValue')
->willReturnMap([
['notifications', 'subscription_aware_server', 'https://push-notifications.nextcloud.com', 'https://push-notifications.nextcloud.com'],
['support', 'subscription_key', '', ''],
]);

$this->l10nFactory
->method('getUserLanguage')
->with($user)
Expand Down Expand Up @@ -821,6 +835,13 @@ public function testPushToDeviceTalkNotification(array $deviceTypes, $isTalkNoti
->with('has_internet_connection', true)
->willReturn(true);

$this->config
->method('getAppValue')
->willReturnMap([
['notifications', 'subscription_aware_server', 'https://push-notifications.nextcloud.com', 'https://push-notifications.nextcloud.com'],
['support', 'subscription_key', '', ''],
]);

$this->notificationManager->method('isFairUseOfFreePushService')
->willReturn(true);

Expand Down