process: stub unsupported worker methods #25587

cjihrig · 2019-01-19T20:23:17Z

Some process methods are not supported in workers. This commit adds stubs that throw more informative errors.

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
commit message follows commit guidelines

nodejs-github-bot · 2019-01-19T20:23:19Z

@cjihrig build started: https://ci.nodejs.org/blue/organizations/jenkins/node-test-pull-request-lite-pipeline/detail/node-test-pull-request-lite-pipeline/2304/pipeline

addaleax · 2019-01-19T20:29:34Z

lib/internal/process/worker_thread_only.js

+function unavailable(name) {
+  return function unavailableInWorker() {
+    throw new ERR_WORKER_UNSUPPORTED_OPERATION(name);
+  };


Just a suggestion, but maybe add a disabled: true property on the function, so that feature detection remains about as easy as it is right now?

I'll add that.

Follow up question. Isn't using isMainThread the preferable way to detect if you're running in a worker though?

Follow up question. Isn't using isMainThread the preferable way to detect if you're running in a worker though?

@cjihrig Yes, I’d say so.

Also, fyi, we may want to provide a way in our embedder API to create a Worker-like environment, i.e. with access to per-process data disabled or restricted like we do for Workers.

@refack I stuck with unavailable() just because it's a bit shorter and required fewer uses to be wrapped across multiple lines.

lib/internal/process/worker_thread_only.js

+function unavailable(name) {
+  return function unavailableInWorker() {
+    throw new ERR_WORKER_UNSUPPORTED_OPERATION(name);
+  };


joyeecheung · 2019-01-19T23:23:06Z

lib/internal/bootstrap/node.js

+      mainThreadSetup.setupChildProcessIpcChannel();
+    } else {
+      process.channel = null;
+      process.connected = false;


I am not sure if these values make sense in the context of workers...what if the process (and the main thread) was spawned with child_process? Maybe we could just throw errors in getters for all these if they just do not make sense (or are too difficult to implement properly) for workers? As far as I can tell, if a user needs to be prepare for the cases where these properties are not available, they are probably just being prepared for the workers, and could use something like require('module').builtinModules.includes('worker_threads') && require('worker_threads').isMainThread as guards instead. Throwing in the getters should also help with debugging issues like #25448 .

Fishrock123 · 2019-01-23T23:00:38Z

Is this semver major? If they didn't exist, could someone be null-checking the properties to see if they can be called? (I doubt anyone is, but...)

addaleax · 2019-01-23T23:05:27Z

@Fishrock123 Workers are still experimental so I think we’re good here

addaleax · 2019-01-28T23:12:46Z

CI: https://ci.nodejs.org/job/node-test-pull-request/20386/

I guess this is technically ready?

cjihrig · 2019-01-29T00:20:01Z

There are some tests to fix here first.

cjihrig · 2019-01-29T00:20:56Z

Oh, and I've also been thinking about if I really want to take the approach in this PR or not.

cjihrig · 2019-02-05T21:35:59Z

Fixed the test issues. Green CI: https://ci.nodejs.org/job/node-test-pull-request/20600/

lib/internal/bootstrap/node.js

cjihrig · 2019-02-05T23:50:55Z

One last green CI: https://ci.nodejs.org/job/node-test-commit/25637/

Some process methods are not supported in workers. This commit adds stubs that throw more informative errors. PR-URL: #25587 Fixes: #25448 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

addaleax · 2019-02-06T15:32:43Z

I’m adding the backport-requested-v11.x label, but other PRs probably just need to be backported first.

Some process methods are not supported in workers. This commit adds stubs that throw more informative errors. PR-URL: #25587 Fixes: #25448 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

nodejs-github-bot added the process Issues and PRs related to the process subsystem. label Jan 19, 2019

addaleax approved these changes Jan 19, 2019

View reviewed changes

refack approved these changes Jan 19, 2019

View reviewed changes

lib/internal/process/worker_thread_only.js Outdated

function unavailable(name) {

return function unavailableInWorker() {

throw new ERR_WORKER_UNSUPPORTED_OPERATION(name);

};

This comment was marked as resolved.

Sign in to view

joyeecheung reviewed Jan 19, 2019

View reviewed changes

fhinkel approved these changes Jan 20, 2019

View reviewed changes

cjihrig force-pushed the workers branch from 8bfba0a to 12e0ccf Compare January 21, 2019 21:53

addaleax added the worker Issues and PRs related to Worker support. label Jan 28, 2019

addaleax added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jan 28, 2019

jasnell approved these changes Jan 29, 2019

View reviewed changes

addaleax removed the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Feb 4, 2019

cjihrig force-pushed the workers branch 3 times, most recently from 886b04b to e5f10ec Compare February 5, 2019 20:00

addaleax approved these changes Feb 5, 2019

View reviewed changes

lib/internal/bootstrap/node.js Outdated Show resolved Hide resolved

cjihrig force-pushed the workers branch from e5f10ec to 1dee229 Compare February 5, 2019 21:43

cjihrig closed this Feb 5, 2019

cjihrig force-pushed the workers branch from 1dee229 to 12b3cfc Compare February 5, 2019 23:56

cjihrig deleted the workers branch February 5, 2019 23:56

addaleax added the backport-requested-v11.x label Feb 6, 2019

targos mentioned this pull request Feb 6, 2019

Help wanted: Backporting to v11.x #25403

Closed

targos removed the backport-requested-v11.x label Feb 10, 2019

targos mentioned this pull request Feb 14, 2019

v11.10.0 proposal #26098

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

process: stub unsupported worker methods #25587

process: stub unsupported worker methods #25587

cjihrig commented Jan 19, 2019

nodejs-github-bot commented Jan 19, 2019

addaleax Jan 19, 2019

cjihrig Jan 19, 2019

This comment was marked as resolved.

addaleax Jan 20, 2019

cjihrig Jan 21, 2019

This comment was marked as resolved.

joyeecheung Jan 19, 2019 •

edited

Loading

Fishrock123 commented Jan 23, 2019

addaleax commented Jan 23, 2019

addaleax commented Jan 28, 2019

cjihrig commented Jan 29, 2019

cjihrig commented Jan 29, 2019

cjihrig commented Feb 5, 2019

cjihrig commented Feb 5, 2019

addaleax commented Feb 6, 2019

process: stub unsupported worker methods #25587

process: stub unsupported worker methods #25587

Conversation

cjihrig commented Jan 19, 2019

Checklist

nodejs-github-bot commented Jan 19, 2019

addaleax Jan 19, 2019

Choose a reason for hiding this comment

cjihrig Jan 19, 2019

Choose a reason for hiding this comment

This comment was marked as resolved.

addaleax Jan 20, 2019

Choose a reason for hiding this comment

cjihrig Jan 21, 2019

Choose a reason for hiding this comment

This comment was marked as resolved.

joyeecheung Jan 19, 2019 • edited Loading

Choose a reason for hiding this comment

Fishrock123 commented Jan 23, 2019

addaleax commented Jan 23, 2019

addaleax commented Jan 28, 2019

cjihrig commented Jan 29, 2019

cjihrig commented Jan 29, 2019

cjihrig commented Feb 5, 2019

cjihrig commented Feb 5, 2019

addaleax commented Feb 6, 2019

joyeecheung Jan 19, 2019 •

edited

Loading