worldstate-emitter 1.0.4 → 1.0.8

package/README.md

@@ -1,4 +1,4 @@
-# Worldstate Emitter [![Build Status](https://travis-ci.com/WFCD/worldstate-emitter.svg?branch=master)](https://travis-ci.com/WFCD/worldstate-emitter)
+# Worldstate Emitter
 
 Suuuper simple emitter for worldstate events.
 
@@ -6,11 +6,11 @@ Very opinionated decisions on what events and event names, as well as
 
 ## Emitter Events
 
-Emitter Event | Emit key | description
-:-- | --- | --
-RSS | `rss` | New forum post from DE
-Worldstate | `ws:update` |  New Worldstate event
-Tweet | `tweet` | New tweet from one of the selected accounts
+| Emitter Event | Emit key    | description                                 |
+|:--------------|-------------|---------------------------------------------|
+| RSS           | `rss`       | New forum post from DE                      |
+| Worldstate    | `ws:update` | New Worldstate event                        |
+| Tweet         | `tweet`     | New tweet from one of the selected accounts |
 
 
 <details>

package/SECURITY.md

@@ -0,0 +1,17 @@
+# Security Policy
+
+## Supported Versions
+
+All versions are supported, but it's recommended to stay on the always current version.
+There may be known vulnerabilities in development dependencies that are avoidable.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.x+    | :white_check_mark: |
+| < 1.0   | :x:
+
+## Reporting a Vulnerability
+
+Vulnerabilities from version updates should have automated PRs from dependabot.
+
+If there is a vulnerability in the code itself, please submit an issue (or also a PR if you have the solution), mentioning the vulnerability.

package/handlers/Twitter.js

@@ -123,7 +123,7 @@ class TwitterCache {
 
   /**
    * Get data able to be parsed from twitter.
-   * @returns {Promise.<Array.<Object>>} Twieets
+   * @returns {Promise.<Array.<Object>>} Tweets
    */
   async getParseableData() {
     logger.silly('Starting Twitter update...');
@@ -151,7 +151,7 @@ class TwitterCache {
 
   /**
    * Handle errors that arise while fetching data from twitter
-   * @param  {[type]} error twitter error
+   * @param  {Error} error twitter error
    */
   onError(error) {
     if (error[0] && error[0].code === 32) {

package/handlers/Worldstate.js

@@ -5,7 +5,9 @@ const { locales } = require('warframe-worldstate-data');
 
 const WSCache = require('../utilities/WSCache');
 
-const { logger, groupBy, lastUpdated } = require('../utilities');
+const { logger, lastUpdated } = require('../utilities');
+
+const parseNew = require('./events/parse');
 
 const wsTimeout = process.env.CACHE_TIMEOUT || 60000;
 const platforms = ['pc', 'ps4', 'xb1', 'swi'];
@@ -13,161 +15,10 @@ const worldStates = {};
 const wsRawCaches = {};
 
 const debugEvents = ['arbitration', 'kuva', 'nightwave'];
-
 const smTimeout = process.env.SEMLAR_TIMEOUT || 300000;
 const kuvaCache = new Cache('https://10o.io/arbitrations.json', smTimeout, { logger, maxRetry: 0 });
 const sentientCache = new Cache('https://semlar.com/anomaly.json', smTimeout, { logger });
 
-const fissureKey = (fissure) => `fissures.t${fissure.tierNum}.${(fissure.missionType || '').toLowerCase()}`;
-const acolyteKey = (acolyte) => ({
-  eventKey: `enemies${acolyte.isDiscovered ? '' : '.departed'}`,
-  activation: acolyte.lastDiscoveredAt,
-});
-const arbiKey = (arbitration) => {
-  if (!(arbitration && arbitration.enemy)) return '';
-
-  let k;
-  try {
-    k = `arbitration.${arbitration.enemy.toLowerCase()}.${arbitration.type.replace(/\s/g, '').toLowerCase()}`;
-  } catch (e) {
-    logger.error(`Unable to parse arbitraion: ${JSON.stringify(arbitration)}\n${e}`);
-  }
-  return k;
-};
-
-const eKeyOverrides = {
-  events: 'operations',
-  persistentEnemies: 'enemies',
-  fissures: fissureKey,
-  enemies: acolyteKey,
-  arbitration: arbiKey,
-};
-
-/**
- * Find overrides for the provided key
- * @param  {string} key  worldsate field to find overrides
- * @param  {Object} data data corresponding to the key from provided worldstate
- * @returns {string}      overrided key
- */
-const checkOverrides = (key, data) => {
-  if (typeof eKeyOverrides[key] === 'string') {
-    return eKeyOverrides[key];
-  }
-  if (typeof eKeyOverrides[key] === 'function') {
-    return eKeyOverrides[key](data);
-  }
-  return key;
-};
-
-/**
- * Process kuva fields
- * @param  {Object} deps    dependencies for processing
- * @param  {Object[]} packets  packets to emit
- * @returns {Object|Object[]}  object(s) to emit from kuva stuff
- */
-const kuvaProcessing = (deps, packets) => {
-  if (!deps.data) {
-    logger.error('no kuva data');
-    return undefined;
-  }
-  const data = groupBy(deps.data, 'type');
-  Object.keys(data).forEach((type) => {
-    deps = {
-      ...deps,
-      data: data[type],
-      id: `kuva.${data[type][0].type.replace(/\s/g, '').toLowerCase()}`,
-      activation: data[type][0].activation,
-      expiry: data[type][0].expiry,
-    };
-    const p = require('./events/objectLike')(deps.data, deps);
-    if (p) {
-      packets.push(p);
-    }
-  });
-  return packets.filter((p) => p);
-};
-
-/**
- * arrayLike are all just arrays of objectLike
- * @param  {Object} deps    dependencies for processing
- * @param  {Object[]} packets  packets to emit
- * @returns {Object|Object[]}  object(s) to emit from arrayLike processing
- */
-const arrayLike = (deps, packets) => {
-  deps.data.forEach((arrayItem) => {
-    const k = checkOverrides(deps.key, arrayItem);
-    packets.push(require('./events/objectLike')(arrayItem, {
-      ...deps,
-      id: k,
-    }));
-  });
-  return packets;
-};
-
-/**
- * Set up current cycle start if it's not been intiated
- * @param  {Object} deps    dependencies for processing
- */
-const initCycleStart = (deps) => {
-  if (!lastUpdated[deps.platform][deps.language]) {
-    lastUpdated[deps.platform][deps.language] = deps.cycleStart;
-  }
-};
-
-/**
- * Parse new events from the provided worldstate
- * @param  {Object} deps dependencies to parse out events
- * @returns {Packet|Packet[]}      packet(s) to emit
- */
-const parseNew = (deps) => {
-  initCycleStart(deps);
-
-  // anything in the eKeyOverrides goes first, then anything uniform
-  const packets = [];
-  switch (deps.key) {
-    case 'kuva':
-      return kuvaProcessing(deps, packets);
-    case 'events':
-      deps = {
-        ...deps,
-        id: eKeyOverrides[deps.key],
-      };
-    case 'alerts':
-    case 'conclaveChallenges':
-    case 'dailyDeals':
-    case 'flashSales':
-    case 'fissures':
-    case 'globalUpgrades':
-    case 'invasions':
-    case 'syndicateMissions':
-    case 'weeklyChallenges':
-      packets.push(...arrayLike(deps, packets));
-      break;
-    case 'cetusCycle':
-    case 'earthCycle':
-    case 'vallisCycle':
-      packets.push(require('./events/cycleLike')(deps.data, deps));
-      break;
-    case 'persistentEnemies':
-      deps = {
-        ...deps,
-        ...checkOverrides(deps.key, deps.data),
-      };
-    case 'sortie':
-    case 'voidTrader':
-    case 'arbitration':
-    case 'sentientOutposts':
-      deps.id = checkOverrides(deps.key, deps.data);
-      packets.push(require('./events/objectLike')(deps.data, deps));
-    case 'nightwave':
-      packets.push(require('./events/nightwave')(deps.data, deps));
-    default:
-      break;
-  }
-
-  return packets;
-};
-
 /**
  * Handler for worldstate data
  */
@@ -201,13 +52,13 @@ class Worldstate {
     platforms.forEach((p) => {
       if (this.platform && this.platform !== p) return;
 
-      const url = `http://content${p === 'pc' ? '' : `.${p}`}.warframe.com/dynamic/worldState.php`;
+      const url = `https://content${p === 'pc' ? '' : `.${p}`}.warframe.com/dynamic/worldState.php`;
       worldStates[p] = {};
 
       locales.forEach(async (locale) => {
         if (!this.locale || this.locale === locale) {
           worldStates[p][locale] = new WSCache({
-            platform: p, locale, kuvaCache, sentientCache, eventEmitter: this.emitter,
+            platform: p, language: locale, kuvaCache, sentientCache, eventEmitter: this.emitter,
           });
         }
       });
@@ -255,16 +106,18 @@ class Worldstate {
     const cycleStart = Date.now();
     const packets = [];
     Object.keys(worldstate).forEach(async (key) => {
-      const packet = parseNew({
-        data: worldstate[key], key, language, platform, cycleStart,
-      });
-
-      if (Array.isArray(packet)) {
-        if (packet.length) {
-          packets.push(...(packet.filter((p) => p && p !== null)));
+      if (worldstate && worldstate[key]) {
+        const packet = parseNew({
+          data: worldstate[key], key, language, platform, cycleStart,
+        });
+
+        if (Array.isArray(packet)) {
+          if (packet.length) {
+            packets.push(...(packet.filter((p) => p && p !== null)));
+          }
+        } else if (packet) {
+          packets.push(packet);
         }
-      } else if (packet) {
-        packets.push(packet);
       }
     });
 

package/handlers/events/arrayLike.js

@@ -0,0 +1,20 @@
+'use strict';
+
+const checkOverrides = require('./checkOverrides');
+
+/**
+ * arrayLike are all just arrays of objectLike
+ * @param  {Object} deps    dependencies for processing
+ * @param  {Object[]} packets  packets to emit
+ * @returns {Object|Object[]}  object(s) to emit from arrayLike processing
+ */
+module.exports = (deps, packets) => {
+  deps.data.forEach((arrayItem) => {
+    const k = checkOverrides(deps.key, arrayItem);
+    packets.push(require('./objectLike')(arrayItem, {
+      ...deps,
+      id: k,
+    }));
+  });
+  return packets;
+};

package/handlers/events/checkOverrides.js

@@ -0,0 +1,19 @@
+'use strict';
+
+const eKeyOverrides = require('./eKeyOverrides');
+
+/**
+ * Find overrides for the provided key
+ * @param  {string} key  worldsate field to find overrides
+ * @param  {Object} data data corresponding to the key from provided worldstate
+ * @returns {string}      overrided key
+ */
+module.exports = (key, data) => {
+  if (typeof eKeyOverrides[key] === 'string') {
+    return eKeyOverrides[key];
+  }
+  if (typeof eKeyOverrides[key] === 'function') {
+    return eKeyOverrides[key](data);
+  }
+  return key;
+};

package/handlers/events/cycleLike.js

@@ -22,6 +22,6 @@ module.exports = (cycleData, deps) => {
     ...packet,
     id: `${packet.id}.${Math.round(fromNow(deps.data.expiry) / 60000)}`,
   };
-  // packets.push(timePacket);
+  packets.push(timePacket);
   return packets;
 };

package/handlers/events/eKeyOverrides.js

@@ -0,0 +1,28 @@
+'use strict';
+
+const { logger } = require('../../utilities');
+
+const fissureKey = (fissure) => `fissures.t${fissure.tierNum}.${(fissure.missionType || '').toLowerCase()}`;
+const acolyteKey = (acolyte) => ({
+  eventKey: `enemies${acolyte.isDiscovered ? '' : '.departed'}`,
+  activation: acolyte.lastDiscoveredAt,
+});
+const arbiKey = (arbitration) => {
+  if (!(arbitration && arbitration.enemy)) return '';
+
+  let k;
+  try {
+    k = `arbitration.${arbitration.enemy.toLowerCase()}.${arbitration.type.replace(/\s/g, '').toLowerCase()}`;
+  } catch (e) {
+    logger.error(`Unable to parse arbitraion: ${JSON.stringify(arbitration)}\n${e}`);
+  }
+  return k;
+};
+
+module.exports = {
+  events: 'operations',
+  persistentEnemies: 'enemies',
+  fissures: fissureKey,
+  enemies: acolyteKey,
+  arbitration: arbiKey,
+};

package/handlers/events/kuva.js

@@ -0,0 +1,31 @@
+'use strict';
+
+const { logger, groupBy } = require('../../utilities');
+
+/**
+ * Process kuva fields
+ * @param  {Object} deps    dependencies for processing
+ * @param  {Object[]} packets  packets to emit
+ * @returns {Object|Object[]}  object(s) to emit from kuva stuff
+ */
+module.exports = (deps, packets) => {
+  if (!deps.data) {
+    logger.error('no kuva data');
+    return undefined;
+  }
+  const data = groupBy(deps.data, 'type');
+  Object.keys(data).forEach((type) => {
+    deps = {
+      ...deps,
+      data: data[type],
+      id: `kuva.${data[type][0].type.replace(/\s/g, '').toLowerCase()}`,
+      activation: data[type][0].activation,
+      expiry: data[type][0].expiry,
+    };
+    const p = require('./objectLike')(deps.data, deps);
+    if (p) {
+      packets.push(p);
+    }
+  });
+  return packets.filter((p) => p);
+};

package/handlers/events/objectLike.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const { between, lastUpdated, logger } = require('../../utilities');
+const { between, lastUpdated } = require('../../utilities');
 
 module.exports = (data, deps) => {
   if (!data) return undefined;

package/handlers/events/parse.js

@@ -0,0 +1,72 @@
+'use strict';
+
+const checkOverrides = require('./checkOverrides');
+const kuvaProcessing = require('./kuva');
+const arrayLike = require('./arrayLike');
+const eKeyOverrides = require('./eKeyOverrides');
+
+const { lastUpdated } = require('../../utilities');
+
+/**
+ * Set up current cycle start if it's not been intiated
+ * @param  {Object} deps    dependencies for processing
+ */
+const initCycleStart = (deps) => {
+  if (!lastUpdated[deps.platform][deps.language]) {
+    lastUpdated[deps.platform][deps.language] = deps.cycleStart;
+  }
+};
+
+/**
+ * Parse new events from the provided worldstate
+ * @param  {Object} deps dependencies to parse out events
+ * @returns {Packet|Packet[]}      packet(s) to emit
+ */
+module.exports = (deps) => {
+  initCycleStart(deps);
+
+  // anything in the eKeyOverrides goes first, then anything uniform
+  const packets = [];
+  switch (deps.key) {
+    case 'kuva':
+      return kuvaProcessing(deps, packets);
+    case 'events':
+      deps = {
+        ...deps,
+        id: eKeyOverrides[deps.key],
+      };
+    case 'alerts':
+    case 'conclaveChallenges':
+    case 'dailyDeals':
+    case 'flashSales':
+    case 'fissures':
+    case 'globalUpgrades':
+    case 'invasions':
+    case 'syndicateMissions':
+    case 'weeklyChallenges':
+      packets.push(...arrayLike(deps, packets));
+      break;
+    case 'cetusCycle':
+    case 'earthCycle':
+    case 'vallisCycle':
+      packets.push(require('./cycleLike')(deps.data, deps));
+      break;
+    case 'persistentEnemies':
+      deps = {
+        ...deps,
+        ...checkOverrides(deps.key, deps.data),
+      };
+    case 'sortie':
+    case 'voidTrader':
+    case 'arbitration':
+    case 'sentientOutposts':
+      deps.id = checkOverrides(deps.key, deps.data);
+      packets.push(require('./objectLike')(deps.data, deps));
+    case 'nightwave':
+      packets.push(require('./nightwave')(deps.data, deps));
+    default:
+      break;
+  }
+
+  return packets;
+};

package/package.json

@@ -1,17 +1,15 @@
 {
   "name": "worldstate-emitter",
-  "version": "1.0.4",
+  "version": "1.0.8",
   "description": "Event emitter for worldstate & other warframe events",
   "main": "index.js",
   "scripts": {
-    "test": "nyc mocha test/specs --exit",
+    "test": "nyc --reporter=lcov mocha test/specs --exit",
     "lint": "eslint index.js handlers/**.js utilities/**.js",
     "lint:fix": "eslint index.js handlers/**.js utilities/**.js --fix",
-    "coverage": "npm test && nyc report --reporter=text-lcov | npx coveralls",
-    "build-docs": "npx jsdoc -c jsdoc-config.json -d docs",
-    "dev": "npx nodemon test/tester.js",
-    "snyk-protect": "npx snyk protect",
-    "prepare": "npm run snyk-protect"
+    "coverage": "npm test && nyc report --reporter=text-lcov | coveralls",
+    "build-docs": "jsdoc -c jsdoc-config.json -d docs",
+    "dev": "nodemon test/tester.js"
   },
   "directories": {
     "test": "test/specs"
@@ -33,27 +31,73 @@
   },
   "homepage": "https://github.com/wfcd/worldstate-emitter#readme",
   "dependencies": {
-    "@sentry/node": "^5.20.1",
+    "@sentry/node": "^6.9.0",
     "colors": "^1.4.0",
     "json-fetch-cache": "^1.2.6",
-    "rss-feed-emitter": "^3.2.0",
+    "rss-feed-emitter": "^3.2.2",
     "twitter": "^1.7.1",
-    "warframe-worldstate-data": "^1.7.10",
-    "warframe-worldstate-parser": "^2.14.2",
+    "warframe-worldstate-data": "^1.18.15",
+    "warframe-worldstate-parser": "^2.19.0",
     "winston": "^3.3.3"
   },
   "devDependencies": {
-    "chai": "^4.2.0",
-    "eslint": "^6.8.0",
-    "eslint-config-airbnb-base": "^14.2.0",
-    "eslint-plugin-import": "^2.22.0",
-    "ink-docstrap": "^1.3.2",
-    "mocha": "^7.2.0",
-    "nyc": "^14.1.1"
+    "chai": "^4.3.4",
+    "coveralls": "^3.1.0",
+    "eslint": "^8.2.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-plugin-import": "^2.22.1",
+    "mocha": "^9.0.2",
+    "nodemon": "^2.0.7",
+    "nyc": "^15.1.0"
   },
   "engines": {
     "node": ">=10.19.0"
   },
+  "eslintIgnore": [
+    ".github/**",
+    "docs/**",
+    "resources/**",
+    "types/**"
+  ],
+  "eslintConfig": {
+    "extends": "airbnb-base",
+    "parserOptions": {
+      "sourceType": "script"
+    },
+    "rules": {
+      "valid-jsdoc": [
+        "error",
+        {
+          "requireReturn": false,
+          "requireReturnDescription": false,
+          "preferType": {
+            "String": "string",
+            "Number": "number",
+            "Boolean": "boolean",
+            "Function": "function",
+            "object": "Object",
+            "date": "Date",
+            "error": "Error"
+          },
+          "prefer": {
+            "return": "returns"
+          }
+        }
+      ],
+      "no-underscore-dangle": "off",
+      "strict": [
+        "error",
+        "safe"
+      ],
+      "linebreak-style": "off",
+      "no-restricted-syntax": "off",
+      "no-await-in-loop": "off",
+      "global-require": "off",
+      "no-fallthrough": "off",
+      "no-param-reassign": "off",
+      "no-case-declarations": "off"
+    }
+  },
   "nodemonConfig": {
     "delay": 5000,
     "env": {
@@ -61,6 +105,5 @@
       "CACHE_TIMEOUT": 60000,
       "SEMLAR_TIMEOUT": 300000
     }
-  },
-  "snyk": true
+  }
 }

package/resources/tweeters.json

@@ -1,7 +1,7 @@
 [
   { "acc_name": "@playwarframe", "plain": "warframe" },
   { "acc_name": "@digitalextremes", "plain": "digitalextremes" },
-  { "acc_name": "@PabloPoon", "plain": "pablo" },
+  { "acc_name": "@PabloMakes", "plain": "pablo" },
   { "acc_name": "@Cam_Rogers", "plain": "cameron" },
   { "acc_name": "@rebbford", "plain": "rebecca" },
   { "acc_name": "@sj_sinclair", "plain": "steve" },
@@ -10,8 +10,8 @@
   { "acc_name": "@GameSoundDesign", "plain": "george" },
   { "acc_name": "@msinilo", "plain": "maciej" },
   { "acc_name": "@sheldoncarter", "plain": "sheldon" },
-  { "acc_name": "@narcbag", "plain": "narc" },
+  { "acc_name": "@MarcusKretz", "plain": "marcus" },
   { "acc_name": "@Helen_Heikkila", "plain": "helen" },
   { "acc_name": "@tobitenno", "plain": "tobiah" },
   { "acc_name": "@wfdiscord", "plain": "wfdiscord" }
-]
+]

package/utilities/WSCache.js

@@ -54,7 +54,11 @@ class WSCache {
       if (!t.timestamp) return;
 
       this.inner = t;
-      this.emitter.emit('ws:update:parsed', { language: this.language, platform: this.platform, data: this.inner });
+      this.emitter.emit('ws:update:parsed', {
+        language: this.language,
+        platform: this.platform,
+        data: this.inner,
+      });
     }, 1000);
   }
 

package/.codeclimate.yml

@@ -1,13 +0,0 @@
-version: 2
-checks:
-  method-lines:
-    config:
-      threshold: 45
-  method-complexity:
-    config:
-      threshold: 10
-  similar-code:
-    enabled: false
-plugins:
-  eslint:
-    enabled: false

package/.eslintrc.json

@@ -1,33 +0,0 @@
-{
-  "extends": "airbnb-base",
-  "parserOptions": {
-    "sourceType": "script"
-  },
-  "rules": {
-    "valid-jsdoc": ["error", {
-      "requireReturn": false,
-      "requireReturnDescription": false,
-      "preferType": {
-        "String": "string",
-        "Number": "number",
-        "Boolean": "boolean",
-        "Function": "function",
-        "object": "Object",
-        "date": "Date",
-        "error": "Error"
-      },
-      "prefer": {
-        "return": "returns"
-      }
-    }],
-    "no-underscore-dangle": "off",
-    "strict": ["error", "safe"],
-    "linebreak-style": "off",
-    "no-restricted-syntax": "off",
-    "no-await-in-loop": "off",
-    "global-require": "off",
-    "no-fallthrough": "off",
-    "no-param-reassign": "off",
-    "no-case-declarations": "off"
-  }
-}

package/.github/.stale.yml

@@ -1,13 +0,0 @@
-daysUntilStale: 60
-daysUntilClose: 7
-exemptLabels:
-  - greenkeeper
-  - 'Status: In Progress'
-  - 'Status: Accepted'
-  - 'Severity1: Critical'
-staleLabel: 'Status: Denied'
-markComment: >
-  This issue has been automatically marked as stale because it has not had
-  recent activity. It will be closed if no further activity occurs. Thank you
-  for your contributions.
-closeComment: false