nodebb-plugin-web-push 0.3.0 → 0.5.0

package/library.js

@@ -5,6 +5,7 @@ const winston = require.main.require('winston');
 const webPush = require('web-push');
 const validator = require('validator');
 
+const db = require.main.require('./src/database');
 const user = require.main.require('./src/user');
 const meta = require.main.require('./src/meta');
 const utils = require.main.require('./src/utils');
@@ -114,6 +115,11 @@ plugin.onNotificationPush = async ({ notification, uidsNotified: uids }) => {
 	uids = uids.filter(uid => subs.get(uid).size);
 	const userSettings = await user.getMultipleUserSettings(uids);
 
+	// Save recipients by nid (for use by .rescind)
+	const refKey = `web-push:nid:${notification.mergeId || notification.nid}:uids`;
+	await db.setAdd(refKey, uids);
+	db.pexpire(refKey, 1000 * 60 * 60 * 48); // only track last 48 hours
+
 	let payloads = await Promise.all(uids.map(async (uid, idx) => {
 		const payload = await constructPayload(notification, userSettings[idx].userLang);
 		return [uid, payload];
@@ -127,12 +133,34 @@ 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);
 			}
 		});
 	});
 };
 
+plugin.onNotificationRescind = async ({ nids }) => {
+	const notificationKeys = nids.map(nid => `notifications:${nid}`);
+	let mergeIds = await db.getObjectsFields(notificationKeys, ['mergeId']);
+	mergeIds = mergeIds.map(o => o.mergeId);
+
+	// Favour mergeIds over nids, then eliminate dupes
+	const tags = new Set(notificationKeys.map((key, i) => mergeIds[i] || key));
+	const recipients = await db.getSetsMembers(Array.from(tags).map(tag => `web-push:nid:${tag}:uids`));
+
+	Promise.all(Array.from(tags).map(async (tag, idx) => {
+		let subs = await subscriptions.list(recipients[idx]);
+		subs = new Set(...Object.values(Object.fromEntries(subs))); // wtf
+
+		if (subs.size) {
+			subs.forEach(async (subscription) => {
+				await webPush.sendNotification(subscription, JSON.stringify({ tag }));
+			});
+		}
+	}));
+};
+
 plugin.addProfileItem = async (data) => {
 	const title = await translator.translate('[[web-push:profile.label]]');
 	data.links.push({
@@ -152,13 +180,17 @@ plugin.addProfileItem = async (data) => {
 	return data;
 };
 
-async function constructPayload({ bodyShort, bodyLong, path }, language) {
+async function constructPayload({ nid, mergeId, 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';
 	}
 
 	let [title, body] = await translator.translateKeys([bodyShort, bodyLong], language);
 	([title, body] = [title, body].map(str => validator.unescape(utils.stripHTMLTags(str))));
+	const tag = mergeId || nid;
 	const url = `${nconf.get('url')}${path}`;
 
 	// Handle empty bodyLong
@@ -167,9 +199,15 @@ 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,
+		tag,
 		data: { url },
 	};
 }

package/package.json

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

package/plugin.json

@@ -8,6 +8,7 @@
 		{ "hook": "filter:admin.header.build", "method": "addAdminNavigation" },
 		{ "hook": "filter:config.get", "method": "appendConfig" },
 		{ "hook": "action:notification.pushed", "method": "onNotificationPush" },
+		{ "hook": "static:notifications.rescind", "method": "onNotificationRescind" },
 		{ "hook": "filter:user.profileMenu", "method": "addProfileItem" }
 	],
 	"languages": "public/languages",

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>