keuss 1.6.14 → 1.6.15

package/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,72 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '26 13 * * 1'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+        
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

package/Signal.js

@@ -73,6 +73,12 @@ class Signal {
   }
 
 
+  // to be extended: generic pubsub service
+  subscribe_extra (topic, on_cb) {return false}
+  unsubscribe_extra (subscr) {}
+  emit_extra (topic, ev, cb) {if (cb) cb ();}
+
+
   static _hrtimeAsMSecs (hrtime) {
     return (hrtime[0] * 1000) + (hrtime[1] / 1e6);
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "keuss",
-  "version": "1.6.14",
+  "version": "1.6.15",
   "keywords": [
     "queue",
     "persistent",
@@ -34,7 +34,8 @@
     "lodash": "~4.17.21",
     "mitt": "~3.0.0",
     "mongodb": "~4.5.0",
-    "uuid": "~8.3.2"
+    "uuid": "~8.3.2",
+    "why-is-node-running": "^2.2.2"
   },
   "devDependencies": {
     "chance": "~1.1.8",
@@ -43,6 +44,6 @@
   },
   "scripts": {
     "test": "mocha --reporter spec --check-leaks --no-timeouts --exit test/",
-    "test-with-coverage": "nyc --reporter=text -- mocha --reporter spec --check-leaks --no-timeouts --exit test/"
+    "test-with-coverage": "nyc --reporter=html -- mocha --reporter spec --check-leaks --no-timeouts --exit test/"
   }
 }

package/signal/local.js

@@ -4,6 +4,7 @@ var Signal = require ('../Signal');
 var debug = require('debug')('keuss:Signal:local');
 
 
+//////////////////////////////////////////////////////////////////////
 class LocalSignal extends Signal {
   constructor (queue, factory, opts) {
     super (queue, opts);
@@ -39,38 +40,110 @@ class LocalSignal extends Signal {
     debug ('created LocalSignal for channel %s', this._channel);
   }
 
-  type () {return LocalSignalFactory.Type ()}
 
+  //////////////////////////////////////////////////////////////////////
+  type () {
+    return LocalSignalFactory.Type ();
+  }
+
+
+  //////////////////////////////////////////////////////////////////////
   emitInsertion (mature, cb) {
     debug ('got insertion event [%o], relay on local mitt', mature);
     this._factory._emitter.emit (this._channel, mature.getTime () + '');
   }
 
+  //////////////////////////////////////////////////////////////////////
   emitPaused (paused, cb) {
     debug ('got paused event [%d], relay on local mitt', paused);
     this._factory._emitter.emit (this._channel, `p ${paused}`);
   }
+
+
+  //////////////////////////////////////////////////////////////////////
+  subscribe_extra (topic, on_cb) {
+    return this._factory.subscribe_extra (this._master.ns (), topic, on_cb);
+  }
+
+
+  //////////////////////////////////////////////////////////////////////
+  unsubscribe_extra (subscr) {
+    this._factory.unsubscribe_extra (subscr);
+  }
+
+
+  //////////////////////////////////////////////////////////////////////
+  emit_extra (topic, ev, cb) {
+    this._factory.emit_extra (this._master.ns (), topic, ev, cb);
+  }
 }
 
 
+//////////////////////////////////////////////////////////////////////
 class LocalSignalFactory {
   constructor (opts) {
     this._emitter = mitt();
+    debug ('created local factory');
+  }
+
+
+  //////////////////////////////////////////////////////////////////////
+  static Type () {
+    return 'signal:local';
   }
 
-  static Type () {return 'signal:local'}
-  type () {return LocalSignalFactory.Type ()}
 
+  //////////////////////////////////////////////////////////////////////
+  type () {
+    return LocalSignalFactory.Type ();
+  }
+
+
+  //////////////////////////////////////////////////////////////////////
   signal (queue, opts) {
     return new LocalSignal (queue, this, opts);
   }
 
+
+  //////////////////////////////////////////////////////////////////////
+  subscribe_extra (ns, topic, on_cb) {
+    const t = `keuss:signal:${ns}:extra:${topic}`;
+    debug ('subscribing to ns [%s], topic [%s]', ns, t);
+
+    const s = {
+      n: ns,
+      t: t,
+      f: (msg => on_cb (msg))
+    };
+
+    this._emitter.on (s.t, s.f); 
+    return s;
+  }
+
+
+  //////////////////////////////////////////////////////////////////////
+  unsubscribe_extra (s) {
+    this._emitter.off (s.t, s.f); 
+    debug ('unsubscribed on %s', s.t);
+  }
+
+
+  //////////////////////////////////////////////////////////////////////
+  emit_extra (ns, topic, ev, cb) {
+    const t = `keuss:signal:${ns}:extra:${topic}`;
+    debug ('emit extra on topic [%s], value [%j]', t, ev);
+    this._emitter.emit (t, ev);
+  }
+
+
+  //////////////////////////////////////////////////////////////////////
   close (cb) {
     cb ();
   }
 }
 
 
+//////////////////////////////////////////////////////////////////////
 function creator (opts, cb) {
   return cb (null, new LocalSignalFactory (opts));
 }

package/signal/mongo-capped.js

@@ -5,7 +5,7 @@ var Signal = require ('../Signal');
 
 var debug = require('debug')('keuss:Signal:MongoCapped');
 
-
+//////////////////////////////////////////////////////////////////////
 class MCSignal extends Signal {
   constructor (queue, factory, opts) {
     super (queue, opts);
@@ -45,24 +45,52 @@ class MCSignal extends Signal {
     debug ('created mongo-capped signaller for topic %s with opts %o', this._topic_name, opts);
   }
 
+
+  //////////////////////////////////////////////////////////////////////
   type () {return MCSignalFactory.Type ()}
 
+
+  //////////////////////////////////////////////////////////////////////
   emitInsertion (mature, cb) {
     debug ('emit insertion on topic [%s] value [%d])', this._topic_name, mature);
     this._factory._channel.publish (this._topic_name, mature.getTime());
   }
 
+
+  //////////////////////////////////////////////////////////////////////
   emitPaused (paused, cb) {
     debug ('emit paused on topic [%s], value [%b]', this._topic_name, paused);
     this._factory._channel.publish (this._topic_name, `p ${paused}`);
   }
 
+
+  //////////////////////////////////////////////////////////////////////
   _insertionEvent (mature) {
     debug ('got insertion event on ch [%s], mature is %s, calling master.emitInsertion()', this._channel, mature);
     this._master.signalInsertion (new Date (mature));
   }
+
+
+  //////////////////////////////////////////////////////////////////////
+  subscribe_extra (topic, on_cb) {
+    return this._factory.subscribe_extra (this._master.ns (), topic, on_cb);
+  }
+
+
+  //////////////////////////////////////////////////////////////////////
+  unsubscribe_extra (subscr) {
+    this._factory.unsubscribe_extra (subscr);
+  }
+
+
+  //////////////////////////////////////////////////////////////////////
+  emit_extra (topic, ev, cb) {
+    this._factory.emit_extra (this._master.ns (), topic, ev, cb);
+  }
 }
 
+
+//////////////////////////////////////////////////////////////////////
 class MCSignalFactory {
   constructor (opts) {
     var defaults = {
@@ -79,19 +107,56 @@ class MCSignalFactory {
     debug ('created mongo-capped factory with opts %o', opts);
   }
 
-  static Type () {return 'signal:mongo-capped'}
-  type () {return MCSignalFactory.Type ()}
 
+  //////////////////////////////////////////////////////////////////////
+  static Type () {
+    return 'signal:mongo-capped';
+  }
+  
+
+  //////////////////////////////////////////////////////////////////////
+  type () {
+    return MCSignalFactory.Type ();
+  }
+
+
+  //////////////////////////////////////////////////////////////////////
   signal (channel, opts) {
     return new MCSignal (channel, this, opts);
   }
 
+
+  //////////////////////////////////////////////////////////////////////
+  subscribe_extra (ns, topic, on_cb) {
+    const t = `keuss:signal:${ns}:extra:${topic}`;
+    debug ('subscribing to ns [%s], topic [%s]', ns, t);
+    return this._channel.subscribe (t, on_cb);
+  }
+
+
+  //////////////////////////////////////////////////////////////////////
+  unsubscribe_extra (subscr) {
+    subscr.unsubscribe ();
+    debug ('unsubscribed on %j', subscr);
+  }
+
+
+  //////////////////////////////////////////////////////////////////////
+  emit_extra (ns, topic, ev, cb) {
+    const t = `keuss:signal:${ns}:extra:${topic}`;
+    debug ('emit extra on ns [%s], topic [%s], value [%j]', ns, t, ev);
+    this._channel.publish (t, ev);
+  }
+
+
+  //////////////////////////////////////////////////////////////////////
   close (cb) {
     this._mubsub.close (cb);
   }
 }
 
 
+//////////////////////////////////////////////////////////////////////
 function creator (opts, cb) {
   return cb (null, new MCSignalFactory (opts));
 }

package/signal/redis-pubsub.js

@@ -8,6 +8,7 @@ var Signal =    require ('../Signal');
 var debug = require('debug')('keuss:Signal:RedisPubsub');
 
 
+//////////////////////////////////////////////////////////////////////
 class RPSSignal extends Signal {
   constructor (queue, factory, opts) {
     super (queue, opts);
@@ -53,24 +54,54 @@ class RPSSignal extends Signal {
     debug ('created redis-pubsub signaller for topic %s with opts %o', this._topic_name, opts);
   }
 
-  type () {return RPSSignalFactory.Type ()}
 
+  //////////////////////////////////////////////////////////////////////
+  type () {
+    return RPSSignalFactory.Type ();
+  }
+
+
+  //////////////////////////////////////////////////////////////////////
   emitInsertion (mature, cb) {
     debug ('emit insertion on channel [%s] value [%d])', this._channel, mature);
     this._rediscl_pub.publish (this._channel, mature.getTime());
   }
 
+
+  //////////////////////////////////////////////////////////////////////
   emitPaused (paused, cb) {
     debug ('emit paused on channel [%s], value [%b]', this._channel, paused);
     this._rediscl_pub.publish (this._channel, `p ${paused}`);
   }
 
+
+  //////////////////////////////////////////////////////////////////////
   _insertionEvent (mature) {
     debug ('got insertion event on ch [%s], mature is %s, calling master.emitInsertion()', this._channel, mature);
     this._master.signalInsertion (new Date (mature));
   }
+
+
+  //////////////////////////////////////////////////////////////////////
+  subscribe_extra (topic, on_cb) {
+    return this._factory.subscribe_extra (this._master.ns (), topic, on_cb);
+  }
+
+
+  //////////////////////////////////////////////////////////////////////
+  unsubscribe_extra (subscr) {
+    this._factory.unsubscribe_extra (subscr);
+  }
+
+
+  //////////////////////////////////////////////////////////////////////
+  emit_extra (topic, ev, cb) {
+    this._factory.emit_extra (this._master.ns (), topic, ev, cb);
+  }
 }
 
+
+//////////////////////////////////////////////////////////////////////
 class RPSSignalFactory {
   constructor (opts) {
     this._opts = opts || {};
@@ -86,14 +117,61 @@ class RPSSignalFactory {
     debug ('created redis-pubsub factory with opts %o', opts);
   }
 
-  static Type () {return 'signal:redis-pubsub'}
-  type () {return RPSSignalFactory.Type ()}
 
+  //////////////////////////////////////////////////////////////////////
+  static Type () {
+    return 'signal:redis-pubsub';
+  }
+
+
+  //////////////////////////////////////////////////////////////////////
+  type () {
+    return RPSSignalFactory.Type ();
+  }
+
+
+  //////////////////////////////////////////////////////////////////////
   signal (channel, opts) {
     debug ('creating redis-pubsub signaller with opts %o', opts);
     return new RPSSignal (channel, this, opts);
   }
 
+
+  //////////////////////////////////////////////////////////////////////
+  subscribe_extra (ns, topic, on_cb) {
+    const t = `keuss:signal:${ns}:extra:${topic}`;
+    debug ('subscribing to ns [%s], topic [%s]', ns, t);
+
+    const s = {
+      n: ns,
+      t: t,
+      f: (msg => on_cb (JSON.parse (msg)))
+    };
+
+    this._emitter.on (s.t, s.f);
+    this._rediscl_sub.subscribe (s.t);
+    return s;
+  }
+
+
+  //////////////////////////////////////////////////////////////////////
+  unsubscribe_extra (subscr) {
+    this._rediscl_sub.unsubscribe (subscr.t);
+    this._emitter.off (subscr.t, subscr.f); 
+    debug ('unsubscribed on %j', subscr);
+  }
+
+
+  //////////////////////////////////////////////////////////////////////
+  emit_extra (ns, topic, ev, cb) {
+    const t = `keuss:signal:${ns}:extra:${topic}`;
+    const v = JSON.stringify(ev);
+    debug ('emit extra on ns [%s], topic [%s], value [%j]', ns, t, ev);
+    this._rediscl_pub.publish (t, v);
+  }
+
+
+  //////////////////////////////////////////////////////////////////////
   close (cb) {
     async.parallel ([
       cb => this._rediscl_pub.quit (cb),
@@ -103,6 +181,7 @@ class RPSSignalFactory {
 }
 
 
+  //////////////////////////////////////////////////////////////////////
 function creator (opts, cb) {
   return cb (null, new RPSSignalFactory (opts));
 }

package/test/signal.js

@@ -0,0 +1,161 @@
+const should = require ('should');
+const async =  require ('async');
+const _ =      require ('lodash');
+
+const Local = require ('../signal/local');
+const Redis = require ('../signal/redis-pubsub');
+const Mongo = require ('../signal/mongo-capped');
+
+// const whyIsNodeRunning = require('why-is-node-running');
+
+const MongoClient = require ('mongodb').MongoClient;
+
+// setTimeout (() => whyIsNodeRunning(), 9000)
+
+_.forEach ({
+  Local, 
+  Redis, 
+  Mongo
+}, (CL, CLName) => {
+  describe (`${CLName} signaller`, () => {
+
+    before (done => {
+      done();
+    });
+
+    after (done => async.series ([
+      cb => setTimeout (cb, 1000),
+      cb => MongoClient.connect ('mongodb://localhost/keuss_signal', (err, cl) => {
+        if (err) return done (err);
+        cl.db().dropDatabase (() => cl.close (cb))
+      })
+    ], done));
+
+
+    it ('creates ok', done => {
+      CL ({}, (err, factory) => {
+        if (err) return done(err);
+        const q = {ns() {return 'the-ns'}, name () {return 'the-queue'}};
+        const signal = factory.signal (q, {});
+        setTimeout (() => factory.close(done), 500);
+      });
+    });
+
+
+    describe (`extra/generic pubsub`, () => {
+      it ('subscribes and receives info ok on 3 subscribers', done => {
+        CL ({}, (err, factory) => {
+          if (err) return done(err);
+          const q = {ns() {return 'the-ns'}, name () {return 'the-queue'}};
+          const signal1 = factory.signal (q, {});
+          const signal2 = factory.signal (q, {});
+          const signal3 = factory.signal (q, {});
+
+          const evs = [];
+
+          function manage (ev) {
+            evs.push (ev);
+            if (evs.length == 3) {
+              evs.should.eql ([
+                { a: 1, b: 'ertwetr' },
+                { a: 1, b: 'ertwetr' },
+                { a: 1, b: 'ertwetr' }
+              ]);
+
+              factory.close(done);
+            }
+          }
+
+          signal1.subscribe_extra ('the-topic', manage);
+          signal2.subscribe_extra ('the-topic', manage);
+          signal3.subscribe_extra ('the-topic', manage);
+
+          setTimeout (() => signal2.emit_extra ('the-topic', {a:1, b:'ertwetr'}), 100);
+        });
+      });
+
+
+      it ('functions across several queues on the same signaller', done => {
+        CL ({}, (err, factory) => {
+          if (err) return done(err);
+          const signal1 = factory.signal ({ns() {return 'the-ns'}, name () {return 'the-queue-1'}}, {});
+          const signal2 = factory.signal ({ns() {return 'the-ns'}, name () {return 'the-queue-2'}}, {});
+          const signal3 = factory.signal ({ns() {return 'the-ns'}, name () {return 'the-queue-3'}}, {});
+
+          const evs = [];
+
+          function manage (ev) {
+            evs.push (ev);
+            if (evs.length == 3) {
+              evs.should.eql ([
+                { a: 1, b: 'ertwetr' },
+                { a: 1, b: 'ertwetr' },
+                { a: 1, b: 'ertwetr' }
+              ]);
+
+              factory.close(done);
+            }
+          }
+
+          signal1.subscribe_extra ('the-topic', manage);
+          signal2.subscribe_extra ('the-topic', manage);
+          signal3.subscribe_extra ('the-topic', manage);
+
+          setTimeout (() => signal2.emit_extra ('the-topic', {a:1, b:'ertwetr'}), 100);
+        });
+      });
+
+      it ('isolates namespaces', done => {
+        CL ({}, (err, factory) => {
+          if (err) return done(err);
+          const signal1 = factory.signal ({ns() {return 'the-ns-1'}, name () {return 'the-queue'}}, {});
+          const signal2 = factory.signal ({ns() {return 'the-ns-2'}, name () {return 'the-queue'}}, {});
+
+          const evs = [];
+
+          async.series ([
+            cb => {signal1.subscribe_extra ('the-topic', ev => evs.push ({src: 1, ev})); cb ();},
+            cb => {signal2.subscribe_extra ('the-topic', ev => evs.push ({src: 2, ev})); cb ();},
+            cb => setTimeout (() => {signal1.emit_extra ('the-topic', {a:1, b:'qwertyuiop'}); cb ()}, 100),
+            cb => setTimeout (() => {signal2.emit_extra ('the-topic', {a:2, b:'asdfghjkl'}); cb ()}, 100),
+            cb => setTimeout (cb, 100),
+          ], err => {
+            if (err) return done(err);
+            evs.should.eql ([
+              { src: 1, ev: { a: 1, b: 'qwertyuiop' } },
+              { src: 2, ev: { a: 2, b: 'asdfghjkl' } }
+            ]);
+            factory.close(done);
+          });
+        });
+      });
+
+      it ('unsubscribes ok and ceases to receive info', done => {
+        CL ({}, (err, factory) => {
+          if (err) return done(err);
+          const signal1 = factory.signal ({ns() {return 'the-ns'}, name () {return 'the-queue'}}, {});
+
+          const evs = [];
+
+          function manage (ev) { evs.push (ev); }
+
+          let subscr = null;
+          async.series ([
+            cb => {subscr = signal1.subscribe_extra ('the-topic', manage); cb ();},
+            cb => setTimeout (() => {signal1.emit_extra ('the-topic', {a:1, b:'ertwetr'}); cb ()}, 100),
+            cb => setTimeout (cb, 100),
+            cb => {signal1.unsubscribe_extra (subscr); cb (); },
+            cb => setTimeout (() => {signal1.emit_extra ('the-topic', {a:2, b:'asdfghjk'}); cb ()}, 100),
+          ], err => {
+            if (err) return done(err);
+            evs.should.eql ([ { a: 1, b: 'ertwetr' } ]);
+            factory.close(done);
+          });
+        });
+      });
+    
+    });
+
+
+  });
+});