Skip to content

trace_events: use private fields instead of symbols for Tracing #51180

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 28, 2023
Merged

trace_events: use private fields instead of symbols for Tracing #51180

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
29 changes: 14 additions & 15 deletions lib/trace_events.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,9 @@
const {
ArrayPrototypeJoin,
SafeSet,
Symbol,
} = primordials;

const { hasTracing } = internalBinding('config');
const kHandle = Symbol('handle');
const kEnabled = Symbol('enabled');
const kCategories = Symbol('categories');

const kMaxTracingCount = 10;

Expand All @@ -33,16 +29,19 @@ const {
const enabledTracingObjects = new SafeSet();

class Tracing {
#handle;
#categories;
#enabled = false;

constructor(categories) {
this[kHandle] = new CategorySet(categories);
this[kCategories] = categories;
this[kEnabled] = false;
this.#handle = new CategorySet(categories);
this.#categories = categories;
}

enable() {
if (!this[kEnabled]) {
this[kEnabled] = true;
this[kHandle].enable();
if (!this.#enabled) {
this.#enabled = true;
this.#handle.enable();
enabledTracingObjects.add(this);
if (enabledTracingObjects.size > kMaxTracingCount) {
process.emitWarning(
Expand All @@ -54,19 +53,19 @@ class Tracing {
}

disable() {
if (this[kEnabled]) {
this[kEnabled] = false;
this[kHandle].disable();
if (this.#enabled) {
this.#enabled = false;
this.#handle.disable();
enabledTracingObjects.delete(this);
}
}

get enabled() {
return this[kEnabled];
return this.#enabled;
}

get categories() {
return ArrayPrototypeJoin(this[kCategories], ',');
return ArrayPrototypeJoin(this.#categories, ',');
}

[customInspectSymbol](depth, opts) {
Expand Down
2 changes: 1 addition & 1 deletion test/parallel/test-util-inspect.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2920,7 +2920,7 @@ assert.strictEqual(
try {
const trace = require('trace_events').createTracing({ categories: ['fo'] });
const actualDepth0 = util.inspect({ trace }, { depth: 0 });
assert.strictEqual(actualDepth0, '{ trace: [Tracing] }');
assert.strictEqual(actualDepth0, '{ trace: Tracing {} }');
const actualDepth1 = util.inspect({ trace }, { depth: 1 });
assert.strictEqual(
actualDepth1,
Expand Down