Compare commits
No commits in common. "master" and "v1.0.0" have entirely different histories.
37
.gitignore
vendored
37
.gitignore
vendored
@ -1,37 +0,0 @@
|
||||
# Logs
|
||||
logs
|
||||
*.log
|
||||
npm-debug.log*
|
||||
|
||||
# Runtime data
|
||||
pids
|
||||
*.pid
|
||||
*.seed
|
||||
|
||||
# Directory for instrumented libs generated by jscoverage/JSCover
|
||||
lib-cov
|
||||
|
||||
# Coverage directory used by tools like istanbul
|
||||
coverage
|
||||
|
||||
# nyc test coverage
|
||||
.nyc_output
|
||||
|
||||
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
|
||||
.grunt
|
||||
|
||||
# node-waf configuration
|
||||
.lock-wscript
|
||||
|
||||
# Compiled binary addons (http://nodejs.org/api/addons.html)
|
||||
build/Release
|
||||
|
||||
# Dependency directories
|
||||
node_modules
|
||||
jspm_packages
|
||||
|
||||
# Optional npm cache directory
|
||||
.npm
|
||||
|
||||
# Optional REPL history
|
||||
.node_repl_history
|
||||
21
LICENSE
21
LICENSE
@ -1,21 +0,0 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2016 AJ ONeal
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
14
README.md
14
README.md
@ -19,8 +19,8 @@ you're trying to use (for example express-session/session/memory, sqlite3, level
|
||||
and then you will supply the names of the methods you wish to export to **worker**
|
||||
processes.
|
||||
|
||||
By default each worker will be added when `cluster` emits a `fork` event.
|
||||
If needed you can set `addOnFork` to `false` and call `addWorker(worker)` manually.
|
||||
You must pass each worker via `addWorker()` so that it signals the worker to creates
|
||||
its own rpc-wrapped instance.
|
||||
|
||||
### master
|
||||
|
||||
@ -32,15 +32,14 @@ var db = require('level')('./mydb')
|
||||
|
||||
// Wrap the instance
|
||||
var crpc = require('cluster-rpc/master').create({
|
||||
addOnFork: true // default
|
||||
, instance: db
|
||||
instance: db
|
||||
, methods: [ 'get', 'put' ]
|
||||
, name: 'foo-level'
|
||||
});
|
||||
|
||||
|
||||
// If you set addOnFork to false, You must manually add each worker
|
||||
// crpc.addWorker(cluster.fork());
|
||||
// You must add each worker
|
||||
crpc.addWorker(cluster.fork());
|
||||
|
||||
|
||||
crpc.then(function (db) {
|
||||
@ -78,8 +77,7 @@ if (cluster.isMaster) {
|
||||
|
||||
|
||||
crpc = require('cluster-rpc/master').create({
|
||||
addOnFork: false
|
||||
, instance: require('level')('./mydb')
|
||||
instance: require('level')('./mydb')
|
||||
, methods: [ 'get', 'put' ]
|
||||
, name: 'foo-level'
|
||||
});
|
||||
|
||||
45
master.js
45
master.js
@ -26,25 +26,29 @@ function getMethods(inst, keys) {
|
||||
});
|
||||
}
|
||||
|
||||
function setup(opts) {
|
||||
module.exports.create = function (opts) {
|
||||
var PromiseA = opts.PromiseA || global.Promise;
|
||||
var crypto = require('crypto');
|
||||
var inst = opts.instance;
|
||||
var methods = getMethods(opts.instance, opts.methods);
|
||||
var token = crypto.randomBytes(16).toString('hex');
|
||||
var inst = opts.instance;
|
||||
var prefixes = require('./prefixes.js').create(opts); // uses opts.name
|
||||
var msgPrefix = 'cluster-rpc.' + opts.name;
|
||||
var rpcPrefix = msgPrefix + '.rpc';
|
||||
var resultPrefix = msgPrefix + '.result';
|
||||
var initPrefix = msgPrefix + '.init';
|
||||
|
||||
opts.master = opts.master || require('./process/master').create(prefixes);
|
||||
opts.master = opts.master || require('./process/master').create();
|
||||
|
||||
opts.master.on('connection', function (w) {
|
||||
if (opts.debug) { console.log('[cluster-rpc] [master] worker connected'); }
|
||||
//console.log('debug w: worker connection');
|
||||
w.send({
|
||||
methods: methods
|
||||
, _token: token
|
||||
, type: prefixes.init
|
||||
, type: initPrefix
|
||||
});
|
||||
|
||||
w.on('message', function (cmd) {
|
||||
if (0 !== (cmd.type||'').indexOf(prefixes.root)) {
|
||||
if (0 !== (cmd.type||'').indexOf(msgPrefix)) {
|
||||
//console.log('debug w: got unknown message type');
|
||||
return;
|
||||
}
|
||||
@ -59,7 +63,7 @@ function setup(opts) {
|
||||
}
|
||||
|
||||
switch (cmd.type) {
|
||||
case prefixes.rpc:
|
||||
case rpcPrefix:
|
||||
cmd.args.push(function callback() {
|
||||
// args is probably err, data in most cases
|
||||
var args = Array.prototype.slice.call(arguments);
|
||||
@ -69,7 +73,7 @@ function setup(opts) {
|
||||
, id: cmd.id
|
||||
//, this: this
|
||||
, _token: token
|
||||
, type: prefixes.result
|
||||
, type: resultPrefix
|
||||
});
|
||||
});
|
||||
|
||||
@ -83,28 +87,9 @@ function setup(opts) {
|
||||
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
module.exports.create = function (opts) {
|
||||
if (opts.debug) { console.log('[cluster-rpc] [master] create'); }
|
||||
var cluster = require('cluster');
|
||||
var PromiseA = opts.PromiseA || global.Promise || require('bluebird');
|
||||
var init = false;
|
||||
|
||||
opts._promise = PromiseA.resolve(opts.instance);
|
||||
opts._promise.addWorker = function (w) {
|
||||
if (opts.debug) { console.log('[cluster-rpc] [master] addWorker wrapper'); }
|
||||
if (!init) {
|
||||
init = true;
|
||||
setup(opts);
|
||||
}
|
||||
return opts.master.addWorker(w);
|
||||
};
|
||||
|
||||
if (false !== opts.addOnFork) {
|
||||
if (opts.debug) { console.log('[cluster-rpc] [master] -- will call addWorker on each fork'); }
|
||||
cluster.on('fork', opts._promise.addWorker);
|
||||
}
|
||||
opts._promise = PromiseA.resolve(inst);
|
||||
opts._promise.addWorker = opts.master.addWorker;
|
||||
|
||||
return opts._promise;
|
||||
};
|
||||
|
||||
10
package.json
10
package.json
@ -1,15 +1,14 @@
|
||||
{
|
||||
"name": "cluster-rpc",
|
||||
"version": "1.0.7",
|
||||
"version": "1.0.0",
|
||||
"description": "A simple way to wrap a single-instance module to enable it to work with node cluster.",
|
||||
"homepage": "https://git.coolaj86.com/coolaj86/cluster-rpc.js",
|
||||
"main": "index.js",
|
||||
"scripts": {
|
||||
"test": "node test.js"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://git.coolaj86.com/coolaj86/cluster-rpc.js.git"
|
||||
"url": "git+ssh://git@github.com/coolaj86/cluster-rpc.git"
|
||||
},
|
||||
"keywords": [
|
||||
"cluster",
|
||||
@ -18,6 +17,7 @@
|
||||
"author": "AJ ONeal <coolaj86@gmail.com> (https://coolaj86.com/)",
|
||||
"license": "(MIT OR Apache-2.0)",
|
||||
"bugs": {
|
||||
"url": "https://git.coolaj86.com/coolaj86/cluster-rpc.js/issues"
|
||||
}
|
||||
"url": "https://github.com/coolaj86/cluster-rpc/issues"
|
||||
},
|
||||
"homepage": "https://github.com/coolaj86/cluster-rpc#readme"
|
||||
}
|
||||
|
||||
18
prefixes.js
18
prefixes.js
@ -1,18 +0,0 @@
|
||||
'use strict';
|
||||
|
||||
module.exports.create = function (opts) {
|
||||
//var msgPrefix = 'cluster-rpc.' + opts.name;
|
||||
//var rpcPrefix = msgPrefix + '.rpc';
|
||||
//var resultPrefix = msgPrefix + '.result';
|
||||
//var initPrefix = msgPrefix + '.init';
|
||||
var root = 'com.daplie.cluster-rpc.' + (opts.name ? opts.name + '.' : '');
|
||||
return {
|
||||
root: root
|
||||
, rpc: root + 'rpc'
|
||||
, result: root + 'result'
|
||||
, init: root + 'init'
|
||||
, connect: root + 'connect'
|
||||
// TODO the things that are using this should probably accept opts
|
||||
, debug: opts.debug
|
||||
};
|
||||
};
|
||||
@ -1,45 +1,27 @@
|
||||
'use strict';
|
||||
|
||||
module.exports.create = function (prefixes) {
|
||||
if (prefixes.debug) { console.log('[cluster-rpc] master created'); }
|
||||
module.exports.create = function () {
|
||||
var m = new (require('events').EventEmitter)();
|
||||
|
||||
m.addWorker = function (worker) {
|
||||
if (prefixes.debug) { console.log('[cluster-rpc] [master] adding worker'); }
|
||||
m._workers = [];
|
||||
|
||||
var w = new (require('events').EventEmitter)();
|
||||
|
||||
function emitConnection() {
|
||||
if (w.__online) {
|
||||
return;
|
||||
}
|
||||
|
||||
w.__online = true;
|
||||
m.emit('connection', w);
|
||||
}
|
||||
|
||||
worker.on('online', function () {
|
||||
if (prefixes.debug) { console.log('[cluster-rpc] [master] worker came online, at fork'); }
|
||||
emitConnection();
|
||||
//console.log('debug mw: worker is up')
|
||||
m.emit('connection', w);
|
||||
});
|
||||
|
||||
worker.on('message', function (data) {
|
||||
if (prefixes.connect === data.type) {
|
||||
if (prefixes.debug) { console.log('[cluster-rpc] [master] worker connected, manually'); }
|
||||
emitConnection();
|
||||
return;
|
||||
}
|
||||
if (prefixes.debug) { console.log('[cluster-rpc] [master] worker sent message', data); }
|
||||
//console.log('debug mw: worker sends message', data)
|
||||
w.emit('message', data);
|
||||
});
|
||||
|
||||
w.send = function (data) {
|
||||
if (prefixes.debug) { console.log('[cluster-rpc] [master] sending', data); }
|
||||
worker.send(data);
|
||||
};
|
||||
|
||||
// TODO remove workers that exit
|
||||
m._workers.push(w);
|
||||
};
|
||||
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
'use strict';
|
||||
|
||||
module.exports.create = function (process, prefixes) {
|
||||
if (prefixes.debug) { console.log('[cluster-rpc] worker created'); }
|
||||
module.exports.create = function (process) {
|
||||
var w = new (require('events').EventEmitter)();
|
||||
|
||||
process.on('message', function (data) {
|
||||
@ -12,10 +11,5 @@ module.exports.create = function (process, prefixes) {
|
||||
process.send(data);
|
||||
};
|
||||
|
||||
// if this were a web / unix socket there would be a 'connection' event
|
||||
// emulating this is useful since the worker may create its cluster rpc
|
||||
// at any time, (which means it may miss the 'fork' event)
|
||||
w.send({ type: prefixes.connect });
|
||||
|
||||
return w;
|
||||
};
|
||||
|
||||
37
test.js
37
test.js
@ -2,32 +2,34 @@
|
||||
|
||||
var cluster = require('cluster');
|
||||
var crpc;
|
||||
var db = {
|
||||
get: function (key, cb) {
|
||||
cb(null, db[key]);
|
||||
}
|
||||
, put: function (key, val, cb) {
|
||||
db[key] = val;
|
||||
cb(null);
|
||||
}
|
||||
};
|
||||
|
||||
function runMaster() {
|
||||
|
||||
var db = {
|
||||
get: function (key, cb) {
|
||||
cb(null, db[key]);
|
||||
}
|
||||
, put: function (key, val, cb) {
|
||||
db[key] = val;
|
||||
if (cb) { cb(null); }
|
||||
}
|
||||
};
|
||||
if (cluster.isMaster) {
|
||||
|
||||
|
||||
crpc = require('./master').create({
|
||||
instance: db
|
||||
, methods: [ 'get', 'put' ]
|
||||
, name: 'foo-level'
|
||||
});
|
||||
crpc.addWorker(cluster.fork());
|
||||
crpc.then(function () {
|
||||
db.put('foo', 'bar');
|
||||
});
|
||||
cluster.fork();
|
||||
|
||||
|
||||
}
|
||||
else {
|
||||
|
||||
function runWorker() {
|
||||
|
||||
crpc = require('./worker').create({
|
||||
name: 'foo-level'
|
||||
@ -36,17 +38,6 @@ function runWorker() {
|
||||
|
||||
}
|
||||
|
||||
if (cluster.isMaster) {
|
||||
|
||||
runMaster();
|
||||
|
||||
}
|
||||
else {
|
||||
|
||||
runWorker();
|
||||
|
||||
}
|
||||
|
||||
|
||||
crpc.then(function (db) {
|
||||
setTimeout(function () {
|
||||
|
||||
24
worker.js
24
worker.js
@ -5,12 +5,15 @@
|
||||
// com.daplie.ipc.result - receive results and callback id
|
||||
|
||||
module.exports.create = function (opts) {
|
||||
var PromiseA = opts.PromiseA || global.Promise || require('bluebird');
|
||||
var PromiseA = opts.PromiseA || global.Promise;
|
||||
var crypto = require('crypto');
|
||||
var token = null;
|
||||
var inst = {};
|
||||
var prefixes = require('./prefixes.js').create(opts);
|
||||
var ws = opts.worker = opts.worker || require('./process/worker').create(process, prefixes);
|
||||
var ws = opts.worker = opts.worker || require('./process/worker').create(process);
|
||||
var msgPrefix = 'cluster-rpc.' + opts.name;
|
||||
var rpcPrefix = msgPrefix + '.rpc';
|
||||
var resultPrefix = msgPrefix + '.result';
|
||||
var initPrefix = msgPrefix + '.init';
|
||||
|
||||
ws.___listeners = [];
|
||||
|
||||
@ -27,7 +30,7 @@ module.exports.create = function (opts) {
|
||||
args: args
|
||||
, func: fname
|
||||
, id: id
|
||||
, type: prefixes.rpc
|
||||
, type: rpcPrefix
|
||||
, _token: token
|
||||
});
|
||||
|
||||
@ -93,21 +96,24 @@ module.exports.create = function (opts) {
|
||||
|
||||
return new PromiseA(function (resolve) {
|
||||
ws.on('message', function (cmd) {
|
||||
if (opts.debug) { console.log('[cluster-rpc] [worker] message received', cmd); }
|
||||
|
||||
if (0 !== (cmd.type||'').indexOf(prefixes.root)) {
|
||||
//console.log('debug m: mesage', cmd);
|
||||
if (0 !== (cmd.type||'').indexOf(msgPrefix)) {
|
||||
//console.log('debug m: ignore msg', cmd);
|
||||
//console.log(cmd.type, msgPrefix);
|
||||
//console.log(cmd.type.indexOf(msgPrefix));
|
||||
return;
|
||||
}
|
||||
if (token && token !== cmd._token) {
|
||||
//console.log('debug m: ignore msg', cmd);
|
||||
return;
|
||||
}
|
||||
|
||||
switch (cmd.type) {
|
||||
case prefixes.init:
|
||||
case initPrefix:
|
||||
onInit(cmd);
|
||||
resolve(inst);
|
||||
break;
|
||||
case prefixes.result:
|
||||
case resultPrefix:
|
||||
onResult(cmd);
|
||||
break;
|
||||
default:
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user