Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions doc/api/process.md
Original file line number Diff line number Diff line change
Expand Up @@ -4308,6 +4308,30 @@ Assigning a value to `process.title` might not result in an accurate label
within process manager applications such as macOS Activity Monitor or Windows
Services Manager.

## `process.setTitle(title)`

<!-- YAML
added: REPLACEME
-->

* `title` {string}

Sets the process title. This is equivalent to assigning a string to
[`process.title`][]. See [`process.title`][] for restrictions and platform
limitations.

```mjs
import { setTitle } from 'node:process';

setTitle('my-service');
```

```cjs
const { setTitle } = require('node:process');

setTitle('my-service');
```

## `process.traceDeprecation`

<!-- YAML
Expand Down Expand Up @@ -4627,6 +4651,7 @@ cases:
[`process.hrtime.bigint()`]: #processhrtimebigint
[`process.kill()`]: #processkillpid-signal
[`process.setUncaughtExceptionCaptureCallback()`]: #processsetuncaughtexceptioncapturecallbackfn
[`process.title`]: #processtitle
[`promise.catch()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/catch
[`queueMicrotask()`]: globals.md#queuemicrotaskcallback
[`readable.read()`]: stream.md#readablereadsize
Expand Down
9 changes: 9 additions & 0 deletions lib/internal/bootstrap/switches/does_not_own_process_state.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ const { unavailable } = require('internal/process/worker_thread_only');

process.abort = unavailable('process.abort()');
process.chdir = unavailable('process.chdir()');
process.setTitle = wrappedSetTitle;
process.umask = wrappedUmask;
process.cwd = rawMethods.cwd;

Expand All @@ -27,6 +28,9 @@ const {
ERR_WORKER_UNSUPPORTED_OPERATION,
},
} = require('internal/errors');
const {
validateString,
} = require('internal/validators');

function wrappedUmask(mask) {
// process.umask() is a read-only operation in workers.
Expand All @@ -36,3 +40,8 @@ function wrappedUmask(mask) {

return rawMethods.umask(mask);
}

function wrappedSetTitle(title) {
validateString(title, 'title');
process.title = title;
}
6 changes: 6 additions & 0 deletions lib/internal/bootstrap/switches/does_own_process_state.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ process.abort = rawMethods.abort;
process.umask = wrappedUmask;
process.chdir = wrappedChdir;
process.cwd = wrappedCwd;
process.setTitle = wrappedSetTitle;

if (credentials.implementsPosixCredentials) {
const wrapped = wrapPosixCredentialSetters(credentials);
Expand Down Expand Up @@ -142,3 +143,8 @@ function wrappedCwd() {
cachedCwd = rawMethods.cwd();
return cachedCwd;
}

function wrappedSetTitle(title) {
validateString(title, 'title');
process.title = title;
}
27 changes: 27 additions & 0 deletions test/es-module/test-esm-process-set-title.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
import { isIBMi, isSunOS, isWindows, skip } from '../common/index.mjs';
import assert from 'node:assert';
import process, { setTitle } from 'node:process';
import { isMainThread } from 'node:worker_threads';
import { describe, it } from 'node:test';

// FIXME add sunos support
if (isSunOS || isIBMi || isWindows) {
skip(`Unsupported platform [${process.platform}]`);
}

if (!isMainThread) {
skip('Setting the process title from Workers is not supported');
}

describe('ESM named import setTitle', () => {
it('sets process title through node:process', () => {
const title = String(process.pid);

setTitle(title);
assert.strictEqual(process.title, title);

assert.throws(() => setTitle(1), {
code: 'ERR_INVALID_ARG_TYPE',
});
});
});
12 changes: 11 additions & 1 deletion test/parallel/test-setproctitle.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,26 @@ if (!isMainThread) {
const assert = require('assert');
const { exec, execSync } = require('child_process');
const path = require('path');
const { setTitle } = require('node:process');

// The title shouldn't be too long; libuv's uv_set_process_title() out of
// security considerations no longer overwrites envp, only argv, so the
// maximum title length is possibly quite short.
let title = String(process.pid);

assert.notStrictEqual(process.title, title);
process.title = title;
setTitle(title);
assert.strictEqual(process.title, title);

assert.throws(() => setTitle(1), {
code: 'ERR_INVALID_ARG_TYPE',
});

const legacyTitle = `${title}-legacy`;
process.title = legacyTitle;
assert.strictEqual(process.title, legacyTitle);
title = legacyTitle;

try {
execSync('command -v ps');
} catch (err) {
Expand Down
3 changes: 3 additions & 0 deletions test/parallel/test-worker-unsupported-things.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ if (!process.env.HAS_STARTED_WORKER) {
const after = before + ' in worker';
process.title = after;
assert.strictEqual(process.title, after);

process.setTitle(`${after} via function`);
assert.strictEqual(process.title, `${after} via function`);
}

{
Expand Down