Add error on invalid expiration request and updat documentation

README.md

@@ -65,17 +65,43 @@ Additional fields are specified in square brackets.
 - Output:
   ```
   {
-    data: PushSubscriptionJSON[+clientHash]
+      data: PushSubscriptionJSON[+clientHash]
   }
   ```
+
+#### Expire subscription
+- URL: `http://localhost:8090/expire-subscription/[+clientHash]`
+- Input: None (expect for clientHash in URL)
+- Output:
+  - Status:
+    - 200 for success
+    - 400 on error e.g. when subscription does not exist
+  - Body:
+    - None for success
+    - Error return on error
 
 #### Send push notification
 - URL: `PushSubscriptionJSON.endpoint` (format: `http://localhost:8090/notify/[+clientHash]`)
 - Headers: See e.g. [RFC 8291](https://datatracker.ietf.org/doc/html/rfc8291) on required headers
 - Input: Encrypted payload
 - Output:
-  - Status: 201 for success, 400/410 on errors
-  - No body
+  - Status:
+    - 201 for success
+    - 400 on errors
+    - 410 on expired subscriptions
+  - Body
+    - Error:
+      ```
+      {
+          error: { message: err.message }
+      }
+      ```
+    - Expired subscription:
+      ```
+      {
+          reason: 'Push subscription has unsubscribed or expired.',
+      }
+      ```
 
 #### Get endpoint notifications
 - URL: `http://localhost:8090/get-notifications`

src/PushApiModel.js

@@ -164,6 +164,8 @@ class PushApiModel {
 	expireSubscription(clientHash) {
 		if (typeof this.subscriptions[clientHash] !== 'undefined') {
 			this.subscriptions[clientHash].isExpired = true;
+		} else {
+			throw new RangeError('Subscription with specified client hash does not exist');
 		}
 	}
 

src/server.js

@@ -128,7 +128,15 @@ class WebPushTestingServer {
 	expireSubscription(req, res) {
 		const {clientHash} = req.params;
 
-		apiModel.expireSubscription(clientHash);
+		try {
+			apiModel.expireSubscription(clientHash);
+		} catch (err) {
+			res.status(400).send({
+				error: {
+					message: err.message,
+				}
+			});
+		}
 
 		console.log('Expire subscription for ' + clientHash);
 		res.sendStatus(200);

test/PushApiModelTest.js

@@ -191,13 +191,24 @@ describe('Push API Model tests', () => {
 			assert.hasAllKeys(subscribeReturn.keys, ['p256dh', 'auth']);
 			assert.hasAllKeys(model.subscriptions, [subscribeReturn.clientHash]);
 
-			assert.isFalse(model.isSubscriptionExpired('doesNotExist'));
 			assert.isFalse(model.isSubscriptionExpired(subscribeReturn.clientHash));
 			model.expireSubscription(subscribeReturn.clientHash);
 			assert.isTrue(model.isSubscriptionExpired(subscribeReturn.clientHash));
-			model.expireSubscription('doesNotExist');
-			assert.isFalse(model.isSubscriptionExpired('doesNotExist'));
 		});
+
+		it ('Invalid subscription is properly handled', async () => {
+			const model = new PushApiModel();
+
+			assert.isFalse(model.isSubscriptionExpired('doesNotExist'));
+
+			try {
+				model.expireSubscription('doesNotExist');
+			} catch(err) {
+				assert.instanceOf(err, RangeError);
+				assert.equal(err.message, 'Subscription with specified client hash does not exist');
+			}
+			assert.isFalse(model.isSubscriptionExpired('doesNotExist'));
+		})
 	});
 
 	describe('Validate notification headers', () => {

test/serverTest.js

@@ -240,6 +240,37 @@ describe('Push Server tests', () => {
 		});
 	});
 
+	describe('Expire non-existent subscription', () => {
+		it('Should return 400', async () => {
+			const model = new PushApiModel();
+			const port = 8990;
+
+			const server = new WebPushTestingServer(model, port);
+			startLogging();
+			server.startServer();
+
+			await fetch('http://localhost:' + port + '/status', {
+				method: 'POST',
+			}).then(response => {
+				response.status.should.equal(200);
+				consoleLogs.length.should.equal(1);
+				consoleLogs[0].should.match(/Server running/);
+			});
+
+			// Try expiring a non-existent subscription
+			await fetch('http://localhost:' + port + '/expire-subscription/doesNotExist', {
+				method: 'POST',
+			}).then(async response => {
+				server._server.close();
+				endLogging();
+
+				response.status.should.equal(400);
+				const responseBody = await response.json();
+				responseBody.error.message.should.equal('Subscription with specified client hash does not exist');
+			});
+		});
+	});
+
 	describe('Send notifications', () => {
 		const input = [
 			{