Merge pull request #68 from godaddy/v2

V2

Author: asilvas

.npmrc

@@ -0,0 +1 @@
+registry=http://registry.npmjs.org/

CHANGELOG.md

@@ -1,11 +1,35 @@
+## v2.0.0 - TBD
+
+### Features:
+
+* High worker restart concurrency to speed up upgrades/restarts via `restartConcurrencyRatio`
+* Proxy support with dynamic app versioning
+  * Central proxy config file, promotions persisted to disk to survive service restarts
+  * Isolated worker processes per version
+  * On demand versioning via `x-version` header
+  * Version promotion brings up worker count for desired version and brings down worker count of old version
+* Worker process downgrade from root via `workerGid` & `workerUid`
+* Backward compatibility with `v1.x`! Who does that with a major release?!
+
+### Enhancements:
+
+* Refactored communication between processes
+* Worker processes may now trigger commands (same) and wait for response (new).
+  The new message bus enables RPC and other flows like this between processes
+
+### Fixes:
+
+* Worker process.send crash
+
+
 ## v1.0.0 - 5/8/2014
 
-Features:
+### Features:
 
 * #56. Ability to restart web server gracefully under load with no code
 * No code required to enable net statistics
 
-Fixes:
+### Fixes:
 
 * Prevent additional commands in CLI while in progress to resolve state issues
 * Handle failed `start` command gracefully
@@ -16,17 +40,17 @@ Fixes:
 * Allow numeric accessKey's
 * Fix crash if no command provided in REST call
 * #57. Cannot use '--run' and '--config' together
-* #58. Custom events from master & workers 
+* #58. Custom events from master & workers
 
 
 
 ## v0.10.0 - 5/2/2014
 
-Legacy:
+### Legacy:
 
 * Dropped support for 'ready' flag, was causing support/complexity issues
 
-Features:
+### Features:
 
 * Ability to start without worker
 * Ability to support multiple versions of cservice through shared state
@@ -36,13 +60,13 @@ Features:
 
 ## v0.9.0 - 2/17/2014
 
-Features:
+### Features:
 
 * #51. Lockdown "help" command to "local" by default
 * #49. Support for multiple keys within 'accessKey' option. (Undocumented,experimental)
 * #54. Allow REST command to originate from body
 
-Fixes:
+### Fixes:
 
 * #46. Expect API response even on "shutdown" or "exit"
 * #52. processDetails not returned during message floods
@@ -52,15 +76,15 @@ Fixes:
 
 ## v0.8.0 - 1/13/2014
 
-Features:
+### Features:
 
 * #40. Net statistics support
 
 
 
 ## v0.7.0 - 1/3/2014
 
-Features:
+### Features:
 
 * #39. Support for hidden(internal) commands
 * #38. Option 'commands' support

README.md

@@ -25,8 +25,8 @@ http://x.co/bpnode
 Video:
 
 http://x.co/bpnodevid
- 
- 
+
+
 ## Getting Started
 
 Your existing application, be it console app or service of some kind:
@@ -77,7 +77,7 @@ or for a full list of commands...
 or for help on a specific command:
 
 	help {command}
-	
+
 We can also issue commands from a seperate process, or even a remote machine (assuming proper access):
 
 	npm install -g cluster-service
@@ -144,14 +144,19 @@ Or within your node app:
   (in bytes), the process will be restarted gracefully. Only one worker will be restarted at a time.
 * `restartOnUpTime` (default: disabled) - If a worker process exceeds the specified uptime threshold
   (in seconds), the process will be restarted gracefully. Only one worker will be restarted at a time.
+* `restartConcurrencyRatio` (default `0.33`) - The ratio of workers that can be restarted concurrently
+  during a restart or upgrade process. This can greatly improve the speed of restarts for applications
+  with many concurrent workers and/or slow initializing workers.
 * `commands` - A single directory, an array of directories, or a comma-delimited list of directories
   may be provided to auto-register commands found in the provided folders that match the ".js"
   extension. If the module exposes the "id" property, that will be the name of the command,
   otherwise the filename (minus the extension) will be used as the name of the command. If relative
   paths are provided, they will be resolved from process.cwd().
 * `master` - An optional module to execute for the master process only, once ```start``` has been completed.
-  
-  
+* `proxy` - Optional path to a JSON config file to enable Proxy Support.
+* `workerGid` - Group ID to assign to child worker processes (recommended `nobody`).
+* `workerUid` - User ID to assign to child worker processes (recommended `nobody`).
+
 
 ## Console & REST API
 
@@ -177,7 +182,7 @@ Or better yet, use the ```run``` option to do the work for you:
 	cservice "help" --accessKey "lksjdf982734"
 	// same as
 	cservice --run "help" --accessKey "lksjdf982734"
-	
+
 
 
 ## Cluster Commands
@@ -210,12 +215,12 @@ Or if you prefer to manually do so via code:
 		// can also fire custom events
 		cservice.trigger("on.custom.complete", 1, 2, 3);
 	};
-	
+
 	cservice.on("test", function(evt, cb, testScript, timeout) { // we're overriding the "test" command
 		// arguments
 		// do something, no callback required (events may optionally be triggered)
-	}; 
-	
+	};
+
 	// can also issue commands programatically
 	cservice.trigger("custom", function(err) { /* my callback */ }, "arg1value", "arg2value");
 
@@ -253,8 +258,8 @@ Additionally, a worker may optionally perform cleanup tasks prior to exit, via:
 			process.exit(); // we're responsible for exiting if we register this cb
 		}
 	});
-	
-	
+
+
 
 ## Access Control
 
@@ -275,8 +280,75 @@ Or may be overriden at runtime via:
 require("cluster-service").control({ "exit": "local" });
 ```
 
-	
-  
+## Proxy Support
+
+Proxy mode specifically caters to Web Servers that you want to enable automatic
+versioning of your service. Any version requested (via `versionHeader`) that is
+not yet loaded will automatically have a worker process spun up with the new
+version, and after ready, the proxy will route to that worker.
+
+Every version of your app *must* adhere to the `PROXY_PORT` environment
+variable like so:
+
+	require("http").createServer(function(req, res) {
+	  res.writeHead(200);
+	  res.end("Hello world!");
+	}).listen(process.env.PROXY_PORT || 3000 /* port to use when not running in proxy mode */);
+
+### Proxy Options
+
+* `versionPath` (default: same directory as proxy JSON config) - Can override
+  to point to a new version folder.
+* `defaultVersion` - The version (folder name) that is currently active/live.
+  If you do not initially set this option, making a request to the Proxy without
+	a `versionHeader` will result in a 404 (Not Found) since there is no active/live
+	version.
+  Upgrades will automatically update this option to the latest upgraded version.
+* `versionHeader` (default: `x-version`) - HTTP Header to use when determining
+  non-default version to route to.
+* `workerFilename` (default: `worker.js`) - Filename of worker file.
+* `bindings` (default: `[{ port: 80, workerCount: 2 }]`) - An array of `Proxy Bindings`.
+* `versionPorts` (default: `11000-12000`) - Reserved port range that can be used to
+  assign ports to different App versions via `PROXY_PORT`.
+* `nonDefaultWorkerCount` (default: 1) - If a version is requested that is not
+  a default version, this will be the number of worker processes dedicated to
+	that version.
+* `nonDefaultWorkerIdleTime` (default: 3600) - The number of seconds of inactivity
+  before a non-default version will have its workers shut down.
+
+### Proxy Bindings
+
+Binding options:
+
+* `port` - Proxy port to bind to.
+* `workerCount` (default: 2) - Number of worker processes to use for this
+  binding. Typically more than 2 is unnecessary for a proxy, and less than 2
+	is a potential failure point if a proxy worker ever goes down.
+* `tlsOptions` - TLS Options if binding for HTTPS.
+  * `key` - Filename that contains the Certificate Key.
+	* `cert` - Filename that contains the Certificate.
+	* `pem` - Filename that contains the Certificate PEM if applicable.
+
+A full list of TLS Options: https://nodejs.org/api/tls.html#tls_tls_createserver_options_secureconnectionlistener
+
+### Proxy Commands
+
+Work like any other `Cluster Commands`.
+
+* `proxy start configPath` - Start the proxy using the provided JSON config file.
+* `proxy stop` - Shutdown the proxy service.
+* `proxy version workerVersion workerCount` - Set a given App version to the
+  desired number of worker processes. If the version is not already running,
+	it will be started. If 2 workers for the version are already running, and you
+	request 4, 2 more will be started. If 4 workers for the version are already
+	running, and you request 2, 2 will be stopped.
+* `proxy promote workerVersion workerCount` - Works identical to the
+  `proxy version` command, except this will flag the version as active/live,
+	resulting in the Proxy Config file being updated with the new `defaultVersion`.
+* `proxy info` - Fetch information about the proxy service.
+
+
+
 ## Tests & Code Coverage
 
 Download and install:
@@ -285,20 +357,20 @@ Download and install:
 	cd node-cluster-service
 	npm install
 
-Now test:	
+Now test:
 
 	npm test
 
 View code coverage in any browser:
 
 	coverage/lcov-report/index.html
 
-	
+
 ## Change Log
 
 [Change Log](https://github.com/godaddy/node-cluster-service/blob/master/CHANGELOG.md)
 
-	
+
 
 ## License
 

cluster-service.js

@@ -10,6 +10,8 @@ exports.debug = require("./lib/util").debug;
 exports.log = require("./lib/util").log;
 exports.error = require("./lib/util").error;
 exports.results = require("./lib/util").results;
+exports.processSafeSend = require("./lib/util").processSafeSend;
+exports.msgBus = require("./lib/message-bus");
 
 exports.workerReady = require("./lib/worker-ready");
 
@@ -56,16 +58,22 @@ exports.trigger = require("./lib/trigger");
 exports.start = require("./lib/start");
 exports.netServers = require("./lib/net-servers");
 exports.netStats = require("./lib/net-stats");
+exports.proxy = require('./lib/proxy');
 
 if (
   cluster.isWorker === true
   && typeof (cluster.worker.module) === "undefined"
 ){
   // intermediate state to prevent 2nd call while async in progress
   cluster.worker.module = {};
+  cluster.worker.env = process.env;
+
+  var workers = require("./lib/workers");
+
+  workers.demote();
 
   // load the worker if not already loaded
-  // async, in case worker loads cluster-service, we need to return before 
+  // async, in case worker loads cluster-service, we need to return before
   // it's avail
   setImmediate(function() {
     cluster.worker.module = require(process.env.worker);
@@ -80,5 +88,5 @@ if (
   });
 
   // start worker monitor to establish two-way relationship with master
-  require("./lib/workers").monitor();
+  workers.monitor();
 }

examples/certs/test1-cert.pem

@@ -0,0 +1,21 @@
+-----BEGIN CERTIFICATE-----
+MIIDXTCCAkWgAwIBAgIJAPWc702VeGKyMA0GCSqGSIb3DQEBBQUAMEUxCzAJBgNV
+BAYTAkFVMRMwEQYDVQQIDApTb21lLVN0YXRlMSEwHwYDVQQKDBhJbnRlcm5ldCBX
+aWRnaXRzIFB0eSBMdGQwHhcNMTMxMjE3MjExMzIwWhcNMTQwMTE2MjExMzIwWjBF
+MQswCQYDVQQGEwJBVTETMBEGA1UECAwKU29tZS1TdGF0ZTEhMB8GA1UECgwYSW50
+ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB
+CgKCAQEApEyXSJ43EqU1Xz4UrLzc84AfwX6WPNvldGtucagk0fTWjq0dSt65kJwk
+x3pN+JOA3MjuPP6BUiO4DF02tzAlP/ILia0yANvndZ1C6BsWsZxooFSOYhXEDn3t
+AcYRLa5Y4APomrOLc2oIwCPJrZqfnO3tbCbmumOEuI56ib9ADjvcR0DI7VFQUEJy
+QLZXXF8HUy97UgyRBhUX/6VO5qpjEmTXV6ZjILcpMMNPDTuzPmC49J/6InVaDQih
+R+orRpVYaG2pC+Y4jj5FpcUsCHd/RR6aA7ZPsQHfQfzfjn1YkEIzl3isXZscda9o
+GUEtMwAhOMlwB3N4fSw43850G1ulcQIDAQABo1AwTjAdBgNVHQ4EFgQUo61sHkQA
+/AVAPvGP8XpXzaMgmWAwHwYDVR0jBBgwFoAUo61sHkQA/AVAPvGP8XpXzaMgmWAw
+DAYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQUFAAOCAQEAWEKBAkRkBzS8AiW01SG+
+bC24XgVAsLMbckNlYHr2uIGeCfBIBSQGSmIw18zM5FxEwqIV/U3ps19oGBE+M8PR
+nflsvOMYJcE8if815UAjN3Qo17wtYqT1X48717S/gLBXP2z3XvmIDr+HtjwKgaxf
+WkImDb5qG6H96bwv7mFW7B4r4DIZ8ovVkectaWpvXuK+0pfkYYDJk4ooFkns3dnn
+TZUxtz0LAfOOcAhIrTokOsR7+NgFy+DWtlw/YwRF24Cj+WpKb+/f9UncRM67/wT/
+gzWSoMjWRbA68La0FGyuxPTTYV2PBe+S5TTeSoqdRXub9W+7Wu0Sz656Dc+QSnTN
+RQ==
+-----END CERTIFICATE-----

examples/certs/test1-key.pem

@@ -0,0 +1,27 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIIEowIBAAKCAQEApEyXSJ43EqU1Xz4UrLzc84AfwX6WPNvldGtucagk0fTWjq0d
+St65kJwkx3pN+JOA3MjuPP6BUiO4DF02tzAlP/ILia0yANvndZ1C6BsWsZxooFSO
+YhXEDn3tAcYRLa5Y4APomrOLc2oIwCPJrZqfnO3tbCbmumOEuI56ib9ADjvcR0DI
+7VFQUEJyQLZXXF8HUy97UgyRBhUX/6VO5qpjEmTXV6ZjILcpMMNPDTuzPmC49J/6
+InVaDQihR+orRpVYaG2pC+Y4jj5FpcUsCHd/RR6aA7ZPsQHfQfzfjn1YkEIzl3is
+XZscda9oGUEtMwAhOMlwB3N4fSw43850G1ulcQIDAQABAoIBAFdJoa4g8F1ljD93
+egBzrmdnkHd6S1M1+Gerk9eqXzV0gHD4o/Fc9vVPH3MjFT2VEAc8cOXSyN3cwDFB
+bIpSd9fLPjn82+385rFjxWIO0jW2RRe5FJQjwC9602n30rSURf9t1Cwsa0/76345
+BTLITThQZ6zn1fj8Wky61XtNMjjc1o1W+ZCE8QIU5WAoU4zf4DeNuRd6jxPEChUM
+DvBlbTmCKV+rLOBhurYr0ejggKtdcjmVhZ89jGZS/ostF0LfRnArHJkrb9JYmgff
+lGcv6Z/Ys5iKiTajaLpbEbw5PtDaJi7a3Yy4lSZt7GoZDnEwXgpGCUPq/scNaVbL
+4jv/s0kCgYEA1Q90bavDdkYuQtOnFuPlIni44GjXVdBUrbDfcPzN5Voqhh2tOZz/
+4/uiWljSdUh21WdRj3KlGx0wEw6Qg3YxC916oGRMx9EU0mpHl1Fkv0SYj7ZET89z
+I6XIUX2h5wTmjTTc8taMVra0NH9CHzuz9bCDXT7t/y3RLeGPzqfljtcCgYEAxWlf
+V2RyCIO0dZ7ABfNPwYk7rWLozhxkVVwYOtiUhwVjv+XXe86iNGaBHIzdwN2mQ2+a
+n8QvoBgRk0gDiiO4pvQUN6okoYglqwyZW1DTqNBgfNh7ADXuM96k5phqbXws4VwW
+FRWMbY1unX4LwXf17kBwZdo1qh2bazElAgFhTPcCgYEAwEytqhrAVWzsbhZ4Ffnl
+IqLRQoJ98I8TDp24XlNeRqaGAPyiD4D7mLrSgzbt5TtdPil9fLpd+MX0UQ7xMiYo
+CGyDNGaywhqc73lLWnD1PIjeJb+9kkdLxZ3o2lxJF6jdqg9PaMJqcg1/Qm6lsGkD
+eToypqOYzZt91Cpk0IHLeIsCgYBIehhL4I/ROnF9oWwEg0Dr4DNtw9uPGHNpt2cZ
+67wUGlF1+a90P/fjXyLV1Y3wqi/JoGbXc1K85zlEpnLOO7EmcoQdr7TFLVQPCZAg
+K3uaBe72xw/ZkvNCTeKi2qBwU9+yWXmuAfxNmFhdMBKm1CEReM0LR+Ld8wLFhwR8
+SP9tHwKBgET/wCASds1wvEat2BjjccSyTVwBRaqugwtI+EBN6wJSfpqWUIkcBVtC
+hI71RuP/HzFDHjFP+xCbnWbvHOSUzCBnW8I6KO0L5DOeYKHecwrvQ2CEkr3pA6RQ
+LIJlSft7D73FbrwbhNqQRZHSW0WO3M0wR+h26tDgR1UE9/j5hXdr
+-----END RSA PRIVATE KEY-----

examples/certs/test1-pubkey.pem

@@ -0,0 +1,9 @@
+-----BEGIN PUBLIC KEY-----
+MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEApEyXSJ43EqU1Xz4UrLzc
+84AfwX6WPNvldGtucagk0fTWjq0dSt65kJwkx3pN+JOA3MjuPP6BUiO4DF02tzAl
+P/ILia0yANvndZ1C6BsWsZxooFSOYhXEDn3tAcYRLa5Y4APomrOLc2oIwCPJrZqf
+nO3tbCbmumOEuI56ib9ADjvcR0DI7VFQUEJyQLZXXF8HUy97UgyRBhUX/6VO5qpj
+EmTXV6ZjILcpMMNPDTuzPmC49J/6InVaDQihR+orRpVYaG2pC+Y4jj5FpcUsCHd/
+RR6aA7ZPsQHfQfzfjn1YkEIzl3isXZscda9oGUEtMwAhOMlwB3N4fSw43850G1ul
+cQIDAQAB
+-----END PUBLIC KEY-----

examples/certs/test1.txt

@@ -0,0 +1,18 @@
+Step 1: Create CSR request
+
+openssl  req -x509 -newkey rsa:2048 -keyout test1-key.pem -out test1-cert.pem
+
+pass phrase: test1
+
+
+
+Step 2: Remove passphrase
+
+openssl rsa -in test1-key.pem -out test1-key.pem
+
+
+
+Step 3: Get Public Key
+
+openssl rsa -in test1-key.pem -pubout > test1-pubkey.pem
+