nodebb-plugin-web-push 0.2.1 → 0.4.0

package/library.js

@@ -85,6 +85,18 @@ plugin.addRoutes = async ({ router, middleware, helpers }) => {
 		await subscriptions.remove(req.uid, subscription);
 		helpers.formatApiResponse(200, res);
 	});
+
+	routeHelpers.setupApiRoute(router, 'post', '/web-push/test', middlewares, async (req, res) => {
+		if (!req.uid) {
+			return helpers.notAllowed(req, res);
+		}
+
+		const { subscription } = req.body;
+		await webPush.sendNotification(subscription, JSON.stringify({
+			title: 'Test notification',
+			body: 'This is a test message sent from NodeBB',
+		}));
+	});
 };
 
 plugin.addAdminNavigation = (header) => {
@@ -115,7 +127,8 @@ plugin.onNotificationPush = async ({ notification, uidsNotified: uids }) => {
 				await webPush.sendNotification(subscription, JSON.stringify(payload));
 			} catch (e) {
 				// Errored — remove subscription from user
-				subscriptions.remove(uid, subscription);
+				winston.info(`[plugins/web-push] Push failed: ${e.code}; ${e.message}; statusCode: ${e.statusCode}`);
+				// subscriptions.remove(uid, subscription);
 			}
 		});
 	});
@@ -141,6 +154,9 @@ plugin.addProfileItem = async (data) => {
 };
 
 async function constructPayload({ bodyShort, bodyLong, path }, language) {
+	let { maxLength } = await meta.settings.get('web-push');
+	maxLength = parseInt(maxLength, 10) || 256;
+
 	if (!language) {
 		language = meta.config.defaultLang || 'en-GB';
 	}
@@ -155,6 +171,11 @@ async function constructPayload({ bodyShort, bodyLong, path }, language) {
 		title = meta.config.title || 'NodeBB';
 	}
 
+	// Truncate body if needed
+	if (body.length > maxLength) {
+		body = `${body.slice(0, maxLength)}…`;
+	}
+
 	return {
 		title,
 		body,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodebb-plugin-web-push",
-  "version": "0.2.1",
+  "version": "0.4.0",
   "description": "A starter kit for quickly creating NodeBB plugins",
   "main": "library.js",
   "repository": {

package/public/languages/en-GB/web-push.json

@@ -3,5 +3,9 @@
 	"profile.introduction": "In addition to in-application and email notifications, you may opt-in to receive push notifications as well. This will allow you to be notified even if the app is not open on your device.",
 	"profile.option": "Enable push notifications on this device",
 	"profile.devices": "Currently notifying <strong>%1</strong> device(s).",
-	"profile.permissionBlocked": "Your device is currently disallowing notifications from this site. Please grant the notification permission to continue."
+	"profile.permissionBlocked": "Your device is currently disallowing notifications from this site. Please grant the notification permission to continue.",
+	"profile.send-test": "Send Test Notification",
+
+	"toast.test_success": "Test notification sent.",
+	"toast.test_unavailable": "Cannot send test notification as push notifications are not enabled on this device."
 }

package/public/lib/settings.js

@@ -1,7 +1,9 @@
+/* eslint-disable import/no-unresolved */
+
 'use strict';
 
 import { post, del } from 'api';
-import { success } from 'alerts';
+import { success, warning } from 'alerts';
 
 // eslint-disable-next-line import/prefer-default-export
 export async function init() {
@@ -16,11 +18,15 @@ export async function init() {
 			const action = e.target.getAttribute('data-action');
 
 			switch (action) {
-				// case 'test': {
-				// 	await post('/plugins/ntfy/test');
-				// 	success('[[ntfy:toast.test_success]]');
-				// 	break;
-				// }
+				case 'test': {
+					if (subscription) {
+						await post('/plugins/web-push/test', { subscription });
+						success('[[web-push:toast.test_success]]');
+					} else {
+						warning('[[web-push:toast.test_unavailable]]');
+					}
+					break;
+				}
 
 				case 'toggle': {
 					const countEl = document.querySelector('#deviceCount strong');
@@ -77,7 +83,7 @@ export async function init() {
 function urlBase64ToUint8Array(base64String) {
 	var padding = '='.repeat((4 - (base64String.length % 4)) % 4);
 	var base64 = (base64String + padding)
-		.replace(/\-/g, '+')
+		.replace(/-/g, '+')
 		.replace(/_/g, '/');
 
 	var rawData = window.atob(base64);

package/templates/account/web-push.tpl

@@ -7,11 +7,14 @@
 <div class="alert alert-warning d-none" id="permission-warning">[[web-push:profile.permissionBlocked]]</div>
 
 <form role="form">
-	<div class="form-check form-switch">
+	<div class="form-check form-switch mb-3">
 		<input type="checkbox" class="form-check-input" id="enabled" name="enabled" autocomplete="off" data-action="toggle">
 		<label for="enabled" class="form-check-label">[[web-push:profile.option]]</label>
 		<p class="form-text" id="deviceCount">[[web-push:profile.devices, {count}]]</p>
 	</div>
+	<div class="mb-3">
+		<button type="button" class="btn btn-primary" data-action="test">[[web-push:profile.send-test]]</button>
+	</div>
 </form>
 
 <!-- IMPORT partials/account/footer.tpl -->

package/templates/admin/plugins/web-push.tpl

@@ -7,9 +7,14 @@
 				<div class="mb-4">
 					<h5 class="fw-bold tracking-tight settings-header">Settings</h5>
 
-					<p class="fst-italic">
-						There are no settings to adjust for this plugin — at this time.
-					</p>
+					<div class="mb-3">
+						<label class="form-label" for="maxLength">Maximum length</label>
+						<input type="number" min="0" max="4096" id="maxLength" name="maxLength" title="Maximum message length" class="form-control" placeholder="256">
+						<p class="form-text">
+							Additional characters beyond this specified length will be truncated.
+							Due to a software limitation, if the message body is greater than 4096 bytes, the message itself will be an attachment in the push notification.
+						</p>
+					</div>
 				</div>
 			</form>