u-wave-announce 0.5.1 → 0.5.2

package/README.md

@@ -5,6 +5,10 @@ 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 u-wave-announce
 ```

package/package.json

@@ -1,13 +1,11 @@
 {
   "name": "u-wave-announce",
   "description": "Announce your üWave server's existence to the world.",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "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,10 +1,7 @@
-const fs = require('fs').promises;
 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');
@@ -91,36 +88,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: Buffer.from(publicKey).toString('base64'),
-      secretKey: Buffer.from(secretKey).toString('base64'),
-      forSeed: seed,
-    }, null, 2), 'utf8');
-    return { publicKey, secretKey };
-  }
-}
-
 async function getAnnounceData(uw, options) {
   const url = stripSlashes(options.url);
 
@@ -128,8 +95,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
@@ -181,7 +152,10 @@ async function announcePlugin(uw, staticOptions) {
   uw.config.register(optionsSchema['uw:key'], optionsSchema);
 
   const seed = staticOptions.seed || await getOrGenerateSeed(uw);
-  const { publicKey, secretKey } = await getKeyPair(seed);
+  // 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']);
@@ -205,6 +179,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({
@@ -228,7 +203,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/test.js

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