Fair use of push notifications

We want to keep offering our push notification service for free, but large users overload our infrastructure. For this reason we have to rate-limit the use of push notifications. If you need this feature, consider setting up your own push server or using Nextcloud Enterprise. Signed-off-by: Joas Schilling <coding@schilljs.com>
nextcloud · Oct 23, 2021 · 6c5b01e · 6c5b01e
1 parent 2d5f4ef
commit 6c5b01e
Show file tree

Hide file tree

Showing 3 changed files with 101 additions and 0 deletions.
diff --git a/lib/Command/TestPush.php b/lib/Command/TestPush.php
@@ -85,6 +85,14 @@ protected function configure(): void {
 	 * @return int
 	 */
 	protected function execute(InputInterface $input, OutputInterface $output): int {
+		if (!$this->notificationManager->isFairUseOfFreePushService()) {
+			$output->writeln('<error>We want to keep offering our push notification service for free, but large</error>');
+			$output->writeln('<error>users overload our infrastructure. For this reason we have to rate-limit the</error>');
+			$output->writeln('<error>use of push notifications. If you need this feature, consider setting up your</error>');
+			$output->writeln('<error>own push server or using Nextcloud Enterprise.</error>');
+			return 1;
+		}
+
 		$userId = $input->getArgument('user-id');
 		$subject = 'Testing push notifications';
 

diff --git a/lib/Push.php b/lib/Push.php
@@ -295,6 +295,16 @@ protected function sendNotificationsToProxies(): void {
 			return;
 		}
 
+		if (!$this->notificationManager->isFairUseOfFreePushService()) {
+			/**
+			 * We want to keep offering our push notification service for free, but large
+			 * users overload our infrastructure. For this reason we have to rate-limit the
+			 * use of push notifications. If you need this feature, consider setting up your
+			 * own push server or using Nextcloud Enterprise.
+			 */
+			return;
+		}
+
 		$client = $this->clientService->newClient();
 		foreach ($pushNotifications as $proxyServer => $notifications) {
 			try {

diff --git a/tests/Unit/PushTest.php b/tests/Unit/PushTest.php
@@ -394,6 +394,83 @@ public function testPushToDeviceEncryptionError() {
 
 		$push->pushToDevice(1970, $notification);
 	}
+	public function testPushToDeviceNoFairUse() {
+		$push = $this->getPush(['getDevicesForUser', 'encryptAndSign', 'deletePushToken', 'validateToken', 'deletePushTokenByDeviceIdentifier']);
+
+		/** @var INotification|MockObject $notification */
+		$notification = $this->createMock(INotification::class);
+		$notification
+			->method('getUser')
+			->willReturn('valid');
+
+		/** @var IUser|MockObject $user */
+		$user = $this->createMock(IUser::class);
+
+		$this->userManager->expects($this->once())
+			->method('get')
+			->with('valid')
+			->willReturn($user);
+
+		$push->expects($this->once())
+			->method('getDevicesForUser')
+			->willReturn([
+				[
+					'proxyserver' => 'proxyserver',
+					'token' => 16,
+					'apptype' => 'other',
+				],
+			]);
+
+		$this->config
+			->method('getSystemValue')
+			->with('debug', false)
+			->willReturn(false);
+
+		$this->l10nFactory
+			->method('getUserLanguage')
+			->with($user)
+			->willReturn('ru');
+
+		$this->notificationManager->expects($this->once())
+			->method('prepare')
+			->with($notification, 'ru')
+			->willReturnArgument(0);
+
+		/** @var Key|MockObject $key */
+		$key = $this->createMock(Key::class);
+
+		$this->keyManager->expects($this->once())
+			->method('getKey')
+			->with($user)
+			->willReturn($key);
+
+		$push->expects($this->exactly(1))
+			->method('validateToken')
+			->willReturn(true);
+
+		$push->expects($this->exactly(1))
+			->method('encryptAndSign')
+			->willReturn(['Payload']);
+
+		$push->expects($this->never())
+			->method('deletePushToken');
+
+		$this->clientService->expects($this->never())
+			->method('newClient');
+
+		$this->config->expects($this->once())
+			->method('getSystemValueBool')
+			->with('has_internet_connection', true)
+			->willReturn(true);
+
+		$this->notificationManager->method('isFairUseOfFreePushService')
+			->willReturn(false);
+
+		$push->method('deletePushTokenByDeviceIdentifier')
+			->with('123456');
+
+		$push->pushToDevice(207787, $notification);
+	}
 
 	public function dataPushToDeviceSending() {
 		return [
@@ -631,6 +708,9 @@ public function testPushToDeviceSending($isDebug) {
 			])
 			->willThrowException($e);
 
+		$this->notificationManager->method('isFairUseOfFreePushService')
+			->willReturn(true);
+
 		$push->method('deletePushTokenByDeviceIdentifier')
 			->with('123456');
 
@@ -762,6 +842,9 @@ public function testPushToDeviceTalkNotification(array $deviceTypes, $isTalkNoti
 			->with('has_internet_connection', true)
 			->willReturn(true);
 
+		$this->notificationManager->method('isFairUseOfFreePushService')
+			->willReturn(true);
+
 		$push->pushToDevice(200718, $notification);
 	}
 }