feat(webpush): Delete expired web push subscriptions

Signed-off-by: sim <[email protected]>

lib/Push.php

@@ -15,6 +15,7 @@
 use OC\Security\IdentityProof\Key;
 use OC\Security\IdentityProof\Manager;
 use OCA\Notifications\AppInfo\Application;
+use OCA\Notifications\Vendor\Minishlink\WebPush\MessageSentReport;
 use OCP\AppFramework\Http;
 use OCP\AppFramework\Utility\ITimeFactory;
 use OCP\Authentication\Exceptions\InvalidTokenException;
@@ -175,7 +176,7 @@ public function flushPayloads(): void {
 		}
 
 		$this->deferPayloads = false;
-		$this->wpClient->flush();
+		$this->wpClient->flush(fn ($r) => $this->webPushCallback($r));
 		$this->sendNotificationsToProxies();
 	}
 
@@ -329,6 +330,7 @@ public function webPushToDevice(int $id, IUser $user, array $devices, INotificat
 
 			if (!$this->validateToken($device['token'], $maxAge)) {
 				// Token does not exist anymore
+				$this->deleteWebPushToken($device['token']);
 				continue;
 			}
 
@@ -339,13 +341,13 @@ public function webPushToDevice(int $id, IUser $user, array $devices, INotificat
 				$this->log->error('JSON error while encoding push notification: ' . $e->getMessage(), ['exception' => $e]);
 			} catch (\InvalidArgumentException) {
 				// Failed to encrypt message for device: public key is invalid
-				//TODO $this->deletePushToken($device['token']);
+				$this->deleteWebPushToken($device['token']);
 			}
 		}
 		$this->printInfo('');
 
 		if (!$this->deferPayloads) {
-			$this->wpClient->flush();
+			$this->wpClient->flush(fn ($r) => $this->webPushCallback($r));
 		}
 	}
 
@@ -381,6 +383,7 @@ public function proxyPushToDevice(int $id, IUser $user, array $devices, INotific
 
 			if (!$this->validateToken($device['token'], $maxAge)) {
 				// Token does not exist anymore
+				$this->deleteProxyPushToken($device['token']);
 				continue;
 			}
 
@@ -396,7 +399,7 @@ public function proxyPushToDevice(int $id, IUser $user, array $devices, INotific
 				$this->log->error('JSON error while encoding push notification: ' . $e->getMessage(), ['exception' => $e]);
 			} catch (\InvalidArgumentException) {
 				// Failed to encrypt message for device: public key is invalid
-				$this->deletePushToken($device['token']);
+				$this->deleteProxyPushToken($device['token']);
 			}
 		}
 		$this->printInfo('');
@@ -501,6 +504,7 @@ public function proxyPushDeleteToDevice(string $userId, IUser $user, array $devi
 			$device['token'] = (int)$device['token'];
 			if (!$this->validateToken($device['token'], $maxAge)) {
 				// Token does not exist anymore
+				$this->deleteProxyPushToken($device['token']);
 				continue;
 			}
 
@@ -532,7 +536,7 @@ public function proxyPushDeleteToDevice(string $userId, IUser $user, array $devi
 				}
 			} catch (\InvalidArgumentException) {
 				// Failed to encrypt message for device: public key is invalid
-				$this->deletePushToken($device['token']);
+				$this->deleteProxyPushToken($device['token']);
 			}
 		}
 
@@ -541,6 +545,15 @@ public function proxyPushDeleteToDevice(string $userId, IUser $user, array $devi
 		}
 	}
 
+	/**
+	 * Delete expired web push subscriptions
+	 */
+	protected function webPushCallback (MessageSentReport $report): void {
+		if ($report->isSubscriptionExpired()) {
+			$this->deleteWebPushTokenByEndpoint($report->getEndpoint());
+		}
+	}
+
 	protected function sendNotificationsToProxies(): void {
 		$pushNotifications = $this->payloadsToSend;
 		$this->payloadsToSend = [];
@@ -628,7 +641,7 @@ protected function sendNotificationsToProxies(): void {
 					// Proxy returns null when the array is empty
 					foreach ($bodyData['unknown'] as $unknownDevice) {
 						$this->printInfo('<comment>Deleting device because it is unknown by the push server: ' . $unknownDevice . '</comment>');
-						$this->deletePushTokenByDeviceIdentifier($unknownDevice);
+						$this->deleteProxyPushTokenByDeviceIdentifier($unknownDevice);
 					}
 				}
 
@@ -671,7 +684,6 @@ protected function validateToken(int $tokenId, int $maxAge): bool {
 				if ($type === IToken::WIPE_TOKEN) {
 					// Token does not exist any more, should drop the push device entry
 					$this->printInfo('Device token is marked for remote wipe');
-					$this->deletePushToken($tokenId);
 					$this->cache->set('t' . $tokenId, 0, 600);
 					return false;
 				}
@@ -685,7 +697,6 @@ protected function validateToken(int $tokenId, int $maxAge): bool {
 			} catch (InvalidTokenException) {
 				// Token does not exist any more, should drop the push device entry
 				$this->printInfo('<error>InvalidTokenException is thrown</error>');
-				$this->deletePushToken($tokenId);
 				$this->cache->set('t' . $tokenId, 0, 600);
 				return false;
 			}
@@ -939,7 +950,31 @@ protected function getWebPushDevicesForUsers(array $userIds): array {
 	 * @param int $tokenId
 	 * @return bool
 	 */
-	protected function deletePushToken(int $tokenId): bool {
+	protected function deleteWebPushToken(int $tokenId): bool {
+		$query = $this->db->getQueryBuilder();
+		$query->delete('notifications_webpush')
+			->where($query->expr()->eq('token', $query->createNamedParameter($tokenId, IQueryBuilder::PARAM_INT)));
+
+		return $query->executeStatement() !== 0;
+	}
+
+	/**
+	 * @param string $endpoint
+	 * @return bool
+	 */
+	protected function deleteWebPushTokenByEndpoint(string $endpoint): bool {
+		$query = $this->db->getQueryBuilder();
+		$query->delete('notifications_webpush')
+			->where($query->expr()->eq('endpoint', $query->createNamedParameter($endpoint)));
+
+		return $query->executeStatement() !== 0;
+	}
+
+	/**
+	 * @param int $tokenId
+	 * @return bool
+	 */
+	protected function deleteProxyPushToken(int $tokenId): bool {
 		$query = $this->db->getQueryBuilder();
 		$query->delete('notifications_pushhash')
 			->where($query->expr()->eq('token', $query->createNamedParameter($tokenId, IQueryBuilder::PARAM_INT)));
@@ -951,7 +986,7 @@ protected function deletePushToken(int $tokenId): bool {
 	 * @param string $deviceIdentifier
 	 * @return bool
 	 */
-	protected function deletePushTokenByDeviceIdentifier(string $deviceIdentifier): bool {
+	protected function deleteProxyPushTokenByDeviceIdentifier(string $deviceIdentifier): bool {
 		$query = $this->db->getQueryBuilder();
 		$query->delete('notifications_pushhash')
 			->where($query->expr()->eq('deviceidentifier', $query->createNamedParameter($deviceIdentifier)));

lib/WebPushClient.php

@@ -10,9 +10,10 @@
 namespace OCA\Notifications;
 
 use OCA\Notifications\Vendor\Base64Url\Base64Url;
+use OCA\Notifications\Vendor\Minishlink\WebPush\MessageSentReport;
+use OCA\Notifications\Vendor\Minishlink\WebPush\Subscription;
 use OCA\Notifications\Vendor\Minishlink\WebPush\Utils;
 use OCA\Notifications\Vendor\Minishlink\WebPush\WebPush;
-use OCA\Notifications\Vendor\Minishlink\WebPush\Subscription;
 use Psr\Log\LoggerInterface;
 
 class WebPushClient {
@@ -81,10 +82,12 @@ public function enqueue(string $endpoint, string $uaPublicKey, string $auth, str
         );
     }
 
-    // TODO remove 404 and others
-    public function flush(): void {
+    /**
+     * @param callable $callback
+     * @psalm-param $callback callable(MessageSentReport): void
+     */
+    public function flush(callable $callback): void {
         $c = $this->getClient();
-        $callback = function($r) {};
         $c->flushPooled($callback);
     }
 }