u-wave-announce 0.5.0 → 0.5.3

package/README.md

@@ -5,28 +5,22 @@ server listing at https://hub.u-wave.net.
 
 ## Usage
 
+The announce plugin is added by default if you use the executable provided
+with üWave Core. If you are using the üWave Core Node.js API, install and
+add it manually:
+
 ```bash
-npm install --save u-wave-announce
+npm install u-wave-announce
 ```
 
 ```js
 import announce from 'u-wave-announce';
 
-uw.use(announce({
-  name: 'Your server name',
-  subtitle: 'Very short description', // Up to about 30 characters.
-  description: `
-    Longer description about your server, perhaps with a list of rules.
-    May include _markdown_, even!
-  `,
-  url: 'https://my-uwave-server.com',
-}));
+uw.use(announce);
 ```
 
-By default, the plugin sends announce messages to the announce server behind
-https://hub.u-wave.net, namely https://announce.u-wave.net.
-
-## Options
+## Runtime Options
+This plugin can be configured at runtime using the admin panel.
 
 ### `name` (required)
 
@@ -51,18 +45,6 @@ including images and links. This can be a good place to put rules, links to
 social media accounts associated with your server, and whatever else you want
 visitors to know.
 
-Indentation is stripped from this option, so template strings can be used like:
-
-```js
-announce({
-  description: `
-    # My Awesome Server
-
-    We play cool stuff, and cool stuff only!
-  `
-});
-```
-
 ### `hub`
 
 The announce server to announce to. Uses https://announce.u-wave.net, the server

package/package.json

@@ -1,13 +1,11 @@
 {
   "name": "u-wave-announce",
   "description": "Announce your üWave server's existence to the world.",
-  "version": "0.5.0",
+  "version": "0.5.3",
   "author": "Renée Kooi <renee@kooi.me>",
   "dependencies": {
-    "debug": "^4.0.0",
-    "find-cache-dir": "^3.0.0",
+    "debug": "^4.3.2",
     "libsodium-wrappers": "^0.7.8",
-    "ms": "^2.0.0",
     "node-fetch": "^2.6.0",
     "strip-indent": "^3.0.0"
   },
@@ -19,5 +17,8 @@
   "repository": {
     "git": "https://github.com/u-wave/hub.git",
     "directory": "plugin"
+  },
+  "scripts": {
+    "test": "node test"
   }
 }

package/src/plugin.js

@@ -1,12 +1,23 @@
-const fs = require('fs').promises;
+'use strict';
+
+const { promisify } = require('util');
+const randomBytes = promisify(require('crypto').randomBytes);
 const fetch = require('node-fetch');
-const ms = require('ms');
 const stripIndent = require('strip-indent');
-const findCacheDir = require('find-cache-dir');
 const debug = require('debug')('uwave:announce');
 const sodium = require('./signatures');
 const pkg = require('../package.json');
 
+/**
+ * Fallback logger implementation for üWave Core versions that do
+ * not come with a logger yet.
+ */
+const debugLogger = {
+  debug,
+  info: debug,
+  error: debug,
+};
+
 const optionsSchema = {
   type: 'object',
   title: 'Announce',
@@ -19,6 +30,14 @@ const optionsSchema = {
       description: 'Whether to announce at all.',
       default: false,
     },
+    seed: {
+      type: 'string',
+      pattern: /^[0-9a-f]{64}$/.source,
+      // Should not be edited by users.
+      readOnly: true,
+      // Should not be exposed to users.
+      writeOnly: true,
+    },
     name: {
       type: 'string',
       title: 'Server Name',
@@ -81,36 +100,6 @@ function stripSlashes(url) {
   return url.replace(/\/+$/, '');
 }
 
-async function getKeyPair(seed) {
-  const keyPairPath = findCacheDir({
-    name: pkg.name,
-    create: true,
-    thunk: true,
-  })('keypair.json');
-  try {
-    const { publicKey, secretKey, forSeed } = JSON.parse(
-      await fs.readFile(keyPairPath, 'utf8'),
-    );
-
-    if (Buffer.compare(Buffer.from(forSeed), Buffer.from(seed)) !== 0) {
-      throw new Error('this error object is unused');
-    }
-
-    return {
-      publicKey: Buffer.from(publicKey, 'base64'),
-      secretKey: Buffer.from(secretKey, 'base64'),
-    };
-  } catch (error) {
-    const { publicKey, secretKey } = await sodium.keyPair(seed);
-    await fs.writeFile(keyPairPath, JSON.stringify({
-      publicKey: publicKey.toString('base64'),
-      secretKey: secretKey.toString('base64'),
-      forSeed: seed,
-    }, null, 2), 'utf8');
-    return { publicKey, secretKey };
-  }
-}
-
 async function getAnnounceData(uw, options) {
   const url = stripSlashes(options.url);
 
@@ -118,8 +107,12 @@ async function getAnnounceData(uw, options) {
   // the relationships.
   const entry = await uw.booth.getCurrentEntry();
   if (entry) {
-    entry.populate('user media.media');
-    await entry.execPopulate();
+    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
@@ -158,25 +151,43 @@ async function getAnnounceData(uw, options) {
   };
 }
 
-async function announcePlugin(uw, staticOptions) {
-  const { publicKey, secretKey } = await getKeyPair(staticOptions.seed);
+async function getOrGenerateSeed(uw) {
+  const options = await uw.config.get(optionsSchema['uw:key']);
+  if (!options.seed) {
+    options.seed = (await randomBytes(32)).toString('hex');
+    await uw.config.set(optionsSchema['uw:key'], options);
+  }
+  return Buffer.from(options.seed, 'hex');
+}
 
+async function announcePlugin(uw, staticOptions) {
   uw.config.register(optionsSchema['uw:key'], optionsSchema);
 
+  // üWave Core 0.5.0 and up have a `pino` logger
+  const logger = uw.logger
+    ? uw.logger.child({ ns: 'uwave:announce' })
+    : debugLogger;
+
+  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
+  // the startup work. For now, we just do the easy thing.
+  const { publicKey, secretKey } = await sodium.keyPair(seed);
+
   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);
@@ -185,6 +196,7 @@ async function announcePlugin(uw, staticOptions) {
     await fetch(announceUrl, {
       method: 'post',
       headers: {
+        'user-agent': `u-wave-announce ${pkg.version}`,
         'content-type': 'application/json',
       },
       body: JSON.stringify({
@@ -194,8 +206,8 @@ async function announcePlugin(uw, staticOptions) {
     });
   }
 
-  function onError(err) {
-    debug(err);
+  function onError(error) {
+    logger.error({ err: error });
   }
 
   let interval;
@@ -208,7 +220,7 @@ async function announcePlugin(uw, staticOptions) {
     // we're still alive.
     interval = setInterval(() => {
       announce().catch(onError);
-    }, ms('1 minute'));
+    }, 60_000);
   });
 
   // Announce again every time the song changes.

package/src/signatures.js

@@ -1,3 +1,5 @@
+'use strict';
+
 // Based on https://github.com/mafintosh/sodium-signatures/blob/master/index.js
 const sodium = require('libsodium-wrappers');
 

package/test.js

@@ -0,0 +1,9 @@
+'use strict';
+
+const assert = require('assert');
+
+assert.doesNotThrow(() => {
+  // Just to make sure it does not crash :)
+  // eslint-disable-next-line global-require
+  require('./src/plugin');
+});