u-wave-announce 0.5.2 → 0.6.0-alpha.1

package/package.json

@@ -1,24 +1,25 @@
 {
   "name": "u-wave-announce",
   "description": "Announce your üWave server's existence to the world.",
-  "version": "0.5.2",
+  "version": "0.6.0-alpha.1",
   "author": "Renée Kooi <renee@kooi.me>",
+  "type": "module",
   "dependencies": {
-    "debug": "^4.3.2",
     "libsodium-wrappers": "^0.7.8",
-    "node-fetch": "^2.6.0",
-    "strip-indent": "^3.0.0"
+    "node-fetch": "^3.3.1",
+    "strip-indent": "^4.0.0"
   },
   "engines": {
-    "node": ">= 12"
+    "node": ">= 14.18.0"
   },
   "license": "MIT",
   "main": "./src/plugin.js",
+  "exports": {
+    ".": "./src/plugin.js",
+    "./package.json": "./package.json"
+  },
   "repository": {
     "git": "https://github.com/u-wave/hub.git",
     "directory": "plugin"
-  },
-  "scripts": {
-    "test": "node test"
   }
 }

package/src/plugin.js

@@ -1,10 +1,8 @@
-const { promisify } = require('util');
-const randomBytes = promisify(require('crypto').randomBytes);
-const fetch = require('node-fetch');
-const stripIndent = require('strip-indent');
-const debug = require('debug')('uwave:announce');
-const sodium = require('./signatures');
-const pkg = require('../package.json');
+import { randomBytes } from 'node:crypto';
+import fetch from 'node-fetch';
+import stripIndent from 'strip-indent';
+import pkg from '../package.json' with { type: 'json' };
+import * as sodium from './signatures.js';
 
 const optionsSchema = {
   type: 'object',
@@ -91,28 +89,14 @@ function stripSlashes(url) {
 async function getAnnounceData(uw, options) {
   const url = stripSlashes(options.url);
 
-  // TODO add something to üWave Core so we don't have to manually populate
-  // the relationships.
   const entry = await uw.booth.getCurrentEntry();
-  if (entry) {
-    if (entry.execPopulate) {
-      entry.populate('user media.media');
-      await entry.execPopulate();
-    } else {
-      await entry.populate('user media.media');
-    }
-  }
 
   // TODO add something to üWave Core so we don't have to manually ask Redis for
   // this information. Currently üWave Core may register duplicates in this
   // list, too, which is a bit annoying!
   // TODO add guest users here too.
   const onlineUserIDs = await uw.redis.lrange('users', 0, -1);
-  const onlineUsersMap = {};
-  onlineUserIDs.forEach((id) => {
-    onlineUsersMap[id] = true;
-  });
-  const usersCount = Object.keys(onlineUsersMap).length;
+  const usersCount = new Set(onlineUserIDs).size;
 
   return {
     name: options.name,
@@ -142,7 +126,7 @@ async function getAnnounceData(uw, options) {
 async function getOrGenerateSeed(uw) {
   const options = await uw.config.get(optionsSchema['uw:key']);
   if (!options.seed) {
-    options.seed = (await randomBytes(32)).toString('hex');
+    options.seed = randomBytes(32).toString('hex');
     await uw.config.set(optionsSchema['uw:key'], options);
   }
   return Buffer.from(options.seed, 'hex');
@@ -151,6 +135,8 @@ async function getOrGenerateSeed(uw) {
 async function announcePlugin(uw, staticOptions) {
   uw.config.register(optionsSchema['uw:key'], optionsSchema);
 
+  const logger = uw.logger.child({ ns: 'uwave:announce' });
+
   const seed = staticOptions.seed || await getOrGenerateSeed(uw);
   // This takes up to a few 100 ms but it is a one-time startup cost…
   // Maybe it makes sense to cache this, or to not block the rest of
@@ -160,17 +146,17 @@ async function announcePlugin(uw, staticOptions) {
   async function announce() {
     const options = await uw.config.get(optionsSchema['uw:key']);
     if (typeof options !== 'object') {
-      debug('announcing not configured, skipping');
+      logger.debug('announcing not configured, skipping');
       return;
     }
     if (!options.enabled) {
-      debug('announcing disabled, skipping');
+      logger.debug('announcing disabled, skipping');
       return;
     }
 
     const hubHost = options.hub || 'https://announce.u-wave.net';
     const announceUrl = `${stripSlashes(hubHost)}/announce/${Buffer.from(publicKey).toString('hex')}`;
-    debug('announcing to', announceUrl);
+    logger.info('announcing to', announceUrl);
 
     const announcement = await getAnnounceData(uw, options);
     const data = JSON.stringify(announcement);
@@ -189,8 +175,8 @@ async function announcePlugin(uw, staticOptions) {
     });
   }
 
-  function onError(err) {
-    debug(err);
+  function onError(error) {
+    logger.error({ err: error });
   }
 
   let interval;
@@ -216,4 +202,4 @@ async function announcePlugin(uw, staticOptions) {
   });
 }
 
-module.exports = announcePlugin;
+export default announcePlugin;

package/src/signatures.js

@@ -1,7 +1,7 @@
 // Based on https://github.com/mafintosh/sodium-signatures/blob/master/index.js
-const sodium = require('libsodium-wrappers');
+import sodium from 'libsodium-wrappers';
 
-async function keyPair(seed) {
+export async function keyPair(seed) {
   await sodium.ready;
 
   const { publicKey, privateKey } = seed
@@ -14,18 +14,12 @@ async function keyPair(seed) {
   return { publicKey, secretKey };
 }
 
-async function sign(message, secretKey) {
+export async function sign(message, secretKey) {
   await sodium.ready;
   return sodium.crypto_sign_detached(message, secretKey);
 }
 
-async function verify(message, signature, publicKey) {
+export async function verify(message, signature, publicKey) {
   await sodium.ready;
   return sodium.crypto_sign_verify_detached(signature, message, publicKey);
 }
-
-module.exports = {
-  keyPair,
-  sign,
-  verify,
-};

package/test.js

@@ -1,7 +1,5 @@
-const assert = require('assert');
+import assert from 'node:assert';
+import plugin from './src/plugin.js';
 
-assert.doesNotThrow(() => {
-  // Just to make sure it does not crash :)
-  // eslint-disable-next-line global-require
-  require('./src/plugin');
-});
+// Just to make sure it does not crash :)
+assert.ok(plugin);