Node: child_process: Add child_processes.isRootProcess flag

[arei]

• Version: Future
• Platform: All
• Subsystem: child_process

This is a new feature request to add a flag (boolean) to child_process, called something along the lines of child_process.isRootProcess that would return true if the current process is the "root" of the child_process.fork tree or false if the current process was a forked process and has an upstream ipc channel.

In essence this is a simple one-liner inside of child_process:

child_process.isRootProcess = !!process.channel;

or something similar.

[Ginden]

Why put it in child_process instead of using directly !!process.channel?

[mscdex]

I don't see the usefulness in adding this when you can just do if (process.send) or similar as you pointed out.

[cjihrig]

I'm -1 on this. You should be able to check for process.send or process.connected.

[sindresorhus]

Readability is a good reason to add this. It's much clearer what if (child_process.isRootProcess) { checks than if (process.send) {.

[arei]

We have cluster.isMaster and cluster.isWorker and this feature request is along the same lines. This is about providing readability into child_process as stated by @sindresorhus. I had to discover that I could do !!process.channel through web search and my own experimentation. Having the flag makes things much more accessible.

[sindresorhus]

I also had no idea you could check process.send or process.connected, and I've been using Node.js for 5 years.

[joyeecheung]

Maybe a tip in the documentation would suffice?

[sindresorhus]

That doesn't really solve the readability concern though.

[bnoordhuis]

We have cluster.isMaster and cluster.isWorker and this feature request is along the same lines.

For background: when cluster was introduced, there was no other way to feature-detect the type of process. It wasn't until v0.8 that you could do if (cluster.worker) { /* ... */ }

That rationale doesn't apply here. if (process.send) { /* ... */ } has worked from day one. (Well, at least since the day support was added for sending handles after spawning.)

Aside: .isRootProcess is a terrible name, it's bound to trip up UNIX users.

[refack]

Welcome @arei, and thanks for the feedback. Based on the above comments I think it's a bit complicated to achieve. AFAICT a process.send or process.connected are both based on an IPC channel open between the processes, which is not guaranteed.
If you (or anyone wanting to help) could think of a more encompassing way to know this state, then opening a PR is probably the best way to get the most constructive reviews.

[arei]

@bnoordhuis don’t disagree that the name could be better.

[EnoahNetzach]

I run into this problem once, and having to discover about the process.send/process. channel was kinda painful.
If then, as @refack says, it's not even guaranteed, that looks just as a workaround to me.

Would an API like child_process.isMaster, .isChild and possibly .isParent be better suited than the "root" one?

[apapirovski]

I'm not seeing much movement but more importantly, the request basically seems to be for an alias of process.connected which is definitely documented: https://nodejs.org/dist/latest-v9.x/docs/api/process.html#process_process_connected

Unless someone has a proposal on how to proceed in the next few days, I'm going to close this out.

[arei]

I would be disappointed if this was closed. This absolutely boils down to a more succinct, documented approach to finding out if there is a parent node process or not. Yes, there is a way to do this already, but it is not clearly expressed. This feature request aims to solve that. And shouldn’t we be striving to make node more clearly express its intents?

[apapirovski]

There's no point to keeping issues open that are stale unless there's a clear path forward or there's great demand (with no dissent). Right now neither of those is true. Issues were brought up, e.g.

AFAICT a process.send or process.connected are both based on an IPC channel open between the processes, which is not guaranteed. If you (or anyone wanting to help) could think of a more encompassing way to know this state, then opening a PR is probably the best way to get the most constructive reviews.

and have not been addressed. As it is, we can't even put a label on this such as "help wanted" or "good first issue" because there's no path forward.

As @refack mentioned, if someone wants to open a PR or move this conversation forward then great but in the absence of that it just makes it really hard to manage the issue tracker.

[arei]

Here's my proposed solution...

Any time a child_process is spawned, it adds an environment variable called NODE_TOP_LEVEL_PROCESS_PID. This will have the value of the top level node process.pid.

Add a function to process called isTopLevelNodeProcess() which will return true if NODE_TOP_LEVEL_PROCESS_PID is not found or null or matches the current process.pid value. Otherwise it will return false.

Thus all downstream spawned processes will return false, but the master process will return true.

I will submit a PR if I can ever get the project to build and test under windows.

[arei]

Given the consensus is that this is not really a problem worth solving, I am closing it. I have also implemented this out in userland, although it is far from pretty. I mention it here for others whom may have the same problem or if anyone is interested in seeing: https://www.npmjs.com/package/toplevelprocess