feat: support reusePort on server listen #115
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,3 +9,4 @@ run | |
| .nyc_output | ||
| package-lock.json | ||
| .package-lock.json | ||
| pnpm-lock.yaml | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -34,6 +34,7 @@ class Master extends EventEmitter { | |
| * - {Object} [plugins] - customized plugins, for unittest | ||
| * - {Number} [workers] numbers of app workers, default to `os.cpus().length` | ||
| * - {Number} [port] listening port, default to 7001(http) or 8443(https) | ||
| * - {Boolean} [reusePort] setting `reusePort` to `true` allows multiple sockets on the same host to bind to the same port. Incoming connections are distributed by the operating system to listening sockets. This option is available only on some platforms, such as Linux 3.9+, DragonFlyBSD 3.6+, FreeBSD 12.0+, Solaris 11.4, and AIX 7.2.5+. **Default:** `false`. | ||
| * - {Number} [debugPort] listening a debug port on http protocol | ||
| * - {Object} [https] https options, { key, cert, ca }, full path | ||
| * - {Array|String} [require] will inject into worker/agent process | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -41,8 +41,15 @@ class AppWorker extends BaseAppWorker { | |
| process.on(event, callback); | ||
| } | ||
|
|
||
| static send(message) { | ||
| if (message && message.action === 'listening' && message.reusePort) { | ||
| // cluster won't get `listening` event when reusePort is true, use cluster `message` event instead | ||
| // rewrite message.action to 'reuse-port-listening' | ||
| message.action = 'reuse-port-listening'; | ||
| cluster.worker.send(message); | ||
| return; | ||
| } | ||
| process.send(message); | ||
| } | ||
|
|
||
| static kill() { | ||
|
|
@@ -124,6 +131,25 @@ class AppUtils extends BaseAppUtils { | |
| }); | ||
| cluster.on('listening', (worker, address) => { | ||
| const appWorker = new AppWorker(worker); | ||
| this.logger.info('[master] app_worker#%s:%s listening on %j', appWorker.id, appWorker.workerId, address); | ||
| this.messenger.send({ | ||
| action: 'app-start', | ||
| data: { | ||
| workerId: appWorker.workerId, | ||
| address, | ||
| }, | ||
| to: 'master', | ||
| from: 'app', | ||
| }); | ||
| }); | ||
| // handle 'reuse-port-listening' message: { action: 'reuse-port-listening', data: { port: 3000 } } | ||
| cluster.on('message', (worker, message) => { | ||
| if (!message || message.action !== 'reuse-port-listening') { | ||
| return; | ||
| } | ||
| const address = message.data; | ||
| const appWorker = new AppWorker(worker); | ||
| this.logger.info('[master] app_worker#%s:%s reuse-port listening on %j', appWorker.id, appWorker.workerId, address); | ||
| this.messenger.send({ | ||
| action: 'app-start', | ||
| data: { | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -71,15 +71,14 @@ class AppWorker extends BaseAppWorker { | |
| } | ||
|
|
||
| class AppUtils extends BaseAppUtils { | ||
| #appWorkers = []; | ||
|
|
||
| #forkSingle(appPath, options, id) { | ||
| // start app worker | ||
| const worker = new workerThreads.Worker(appPath, options); | ||
| // wrap app worker | ||
| const appWorker = new AppWorker(worker, id); | ||
| this.#appWorkers.push(appWorker); | ||
| this.emit('worker_forked', appWorker); | ||
| appWorker.disableRefork = true; | ||
| worker.on('message', msg => { | ||
|
|
@@ -129,23 +128,40 @@ class AppUtils extends BaseAppUtils { | |
| to: 'master', | ||
| from: 'app', | ||
| }); | ||
| }); | ||
|
|
||
| // handle worker exit | ||
| worker.on('exit', async code => { | ||
| this.log('[master] app_worker#%s (tid:%s) exit with code: %s', appWorker.id, appWorker.workerId, code); | ||
| // remove worker from workers array | ||
| const idx = this.#appWorkers.indexOf(appWorker); | ||
| if (idx !== -1) { | ||
| this.#appWorkers.splice(idx, 1); | ||
| } | ||
| // remove all listeners to avoid memory leak | ||
| worker.removeAllListeners(); | ||
|
|
||
| appWorker.state = 'dead'; | ||
| try { | ||
| this.messenger.send({ | ||
| action: 'app-exit', | ||
| data: { | ||
| workerId: appWorker.workerId, | ||
| code, | ||
| }, | ||
| to: 'master', | ||
| from: 'app', | ||
| }); | ||
| } catch (err) { | ||
| this.log('[master][warning] app_worker#%s (tid:%s) send "app-exit" message error: %s', | ||
| appWorker.id, appWorker.workerId, err); | ||
| } | ||
|
|
||
| if (appWorker.disableRefork) { | ||
| return; | ||
| } | ||
| // refork app worker | ||
| this.log('[master] app_worker#%s (tid:%s) refork after 1s', appWorker.id, appWorker.workerId); | ||
| await sleep(1000); | ||
| this.#forkSingle(appPath, options, id); | ||
| }); | ||
fengmk2 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
@@ -155,26 +171,38 @@ class AppUtils extends BaseAppUtils { | |
| this.startTime = Date.now(); | ||
| this.startSuccessCount = 0; | ||
|
|
||
| if (this.options.reusePort) { | ||
| if (!this.options.port) { | ||
| throw new Error('options.port must be specified when reusePort is enabled'); | ||
| } | ||
| for (let i = 0; i < this.options.workers; i++) { | ||
| const argv = [ JSON.stringify(this.options) ]; | ||
| const appWorkerId = i + 1; | ||
| this.#forkSingle(this.getAppWorkerFile(), { argv }, appWorkerId); | ||
| } | ||
| } else { | ||
| const ports = this.options.ports; | ||
| if (!ports.length) { | ||
| ports.push(this.options.port); | ||
| } | ||
fengmk2 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| this.options.workers = ports.length; | ||
| let i = 0; | ||
| do { | ||
| const options = Object.assign({}, this.options, { port: ports[i] }); | ||
| const argv = [ JSON.stringify(options) ]; | ||
| this.#forkSingle(this.getAppWorkerFile(), { argv }, ++i); | ||
| } while (i < ports.length); | ||
|
Comment on lines
+189
to
+194
There was a problem hiding this comment. The for (let i = 0; i < ports.length; i++) {
const options = Object.assign({}, this.options, { port: ports[i] });
const argv = [ JSON.stringify(options) ];
this.#forkSingle(this.getAppWorkerFile(), { argv }, i + 1);
} |
||
| } | ||
|
|
||
| return this; | ||
| } | ||
|
|
||
| async kill() { | ||
| for (const appWorker of this.#appWorkers) { | ||
| this.log('[master] kill app_worker#%s (tid:%s) (worker_threads) by worker.terminate()', appWorker.id, appWorker.workerId); | ||
| appWorker.disableRefork = true; | ||
| appWorker.instance.removeAllListeners(); | ||
| appWorker.instance.terminate(); | ||
| } | ||
| } | ||
| } | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,6 +12,7 @@ module.exports = function(options) { | |
| framework: '', | ||
| baseDir: process.cwd(), | ||
| port: options.https ? 8443 : null, | ||
| reusePort: false, | ||
| workers: null, | ||
| plugins: null, | ||
| https: false, | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,22 +1,22 @@ | ||
| { | ||
| "name": "egg-cluster", | ||
| "version": "2.5.0-beta.3", | ||
| "description": "cluster manager for egg", | ||
| "main": "index.js", | ||
| "scripts": { | ||
| "lint": "eslint .", | ||
| "test": "npm run lint -- --fix && npm run test-local", | ||
| "test-local": "egg-bin test --ts false", | ||
| "cov": "egg-bin cov --prerequire --timeout 100000 --ts false", | ||
| "ci": "npm run lint && node test/reuseport_cluster.js && npm run cov" | ||
fengmk2 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| }, | ||
| "files": [ | ||
| "index.js", | ||
| "lib" | ||
| ], | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "git+https://github.com/eggjs/cluster.git" | ||
| }, | ||
| "keywords": [ | ||
| "egg", | ||
|
|
@@ -26,9 +26,9 @@ | |
| "author": "dead-horse <[email protected]>", | ||
| "license": "MIT", | ||
| "bugs": { | ||
| "url": "https://github.com/eggjs/cluster/issues" | ||
| }, | ||
| "homepage": "https://github.com/eggjs/cluster#readme", | ||
| "dependencies": { | ||
| "await-event": "^2.1.0", | ||
| "cfork": "^1.7.1", | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -232,6 +232,36 @@ describe('test/app_worker.test.js', () => { | |
| .expect(200); | ||
| }); | ||
|
|
||
| it('should set reusePort=true in config', async () => { | ||
| app = utils.cluster('apps/app-listen-reusePort'); | ||
| app.debug(); | ||
| await app.ready(); | ||
|
|
||
| app.expect('code', 0); | ||
| // IPv6 first: http://:::17010 | ||
| app.expect('stdout', /egg started on http:\/\/.+?:17010/); | ||
|
|
||
| await request('http://0.0.0.0:17010') | ||
| .get('/') | ||
| .expect('done') | ||
| .expect(200); | ||
|
|
||
| await request('http://127.0.0.1:17010') | ||
| .get('/') | ||
| .expect('done') | ||
| .expect(200); | ||
|
|
||
| await request('http://localhost:17010') | ||
| .get('/') | ||
| .expect('done') | ||
| .expect(200); | ||
|
|
||
| await request('http://127.0.0.1:17010') | ||
| .get('/port') | ||
| .expect('17010') | ||
| .expect(200); | ||
| }); | ||
|
|
||
| it('should use hostname in config', async () => { | ||
| const url = address.ip() + ':17010'; | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| 'use strict'; | ||
|
|
||
| module.exports = app => { | ||
| // don't use the port that egg-mock defined | ||
| app._options.port = undefined; | ||
| }; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| module.exports = app => { | ||
| app.get('/', ctx => { | ||
| ctx.body = 'done'; | ||
| }); | ||
|
|
||
| app.get('/port', ctx => { | ||
| ctx.body = ctx.app._options.port; | ||
| }); | ||
| }; |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.