Skip to content

Commit 3863c3a

Browse files
addaleaxjasnell
authored andcommitted
async_hooks: rename AsyncEvent to AsyncResource
`AsyncEvent` is not a good name given its semantics. PR-URL: #13192 Reviewed-By: Andreas Madsen <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
1 parent b8b6c2c commit 3863c3a

6 files changed

+18
-18
lines changed

lib/async_hooks.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ const { kInit, kBefore, kAfter, kDestroy, kCurrentAsyncId, kCurrentTriggerId,
4343

4444
const { async_id_symbol, trigger_id_symbol } = async_wrap;
4545

46-
// Used in AsyncHook and AsyncEvent.
46+
// Used in AsyncHook and AsyncResource.
4747
const init_symbol = Symbol('init');
4848
const before_symbol = Symbol('before');
4949
const after_symbol = Symbol('after');
@@ -192,7 +192,7 @@ function triggerId() {
192192

193193
// Embedder API //
194194

195-
class AsyncEvent {
195+
class AsyncResource {
196196
constructor(type, triggerId) {
197197
this[async_id_symbol] = ++async_uid_fields[kAsyncUidCntr];
198198
// Read and reset the current kInitTriggerId so that when the constructor
@@ -480,7 +480,7 @@ module.exports = {
480480
currentId,
481481
triggerId,
482482
// Embedder API
483-
AsyncEvent,
483+
AsyncResource,
484484
runInAsyncIdScope,
485485
// Sensitive Embedder API
486486
newUid,

test/async-hooks/test-embedder.api.async-event.after-on-destroyed.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
const common = require('../common');
44
const assert = require('assert');
55
const async_hooks = require('async_hooks');
6-
const { AsyncEvent } = async_hooks;
6+
const { AsyncResource } = async_hooks;
77
const { spawn } = require('child_process');
88
const corruptedMsg = /async hook stack has become corrupted/;
99
const heartbeatMsg = /heartbeat: still alive/;
@@ -17,13 +17,13 @@ if (process.argv[2] === 'child') {
1717
// once 'destroy' has been emitted, we can no longer emit 'after'
1818

1919
// Emitting 'before', 'after' and then 'destroy'
20-
const event1 = new AsyncEvent('event1', async_hooks.currentId());
20+
const event1 = new AsyncResource('event1', async_hooks.currentId());
2121
event1.emitBefore();
2222
event1.emitAfter();
2323
event1.emitDestroy();
2424

2525
// Emitting 'after' after 'destroy'
26-
const event2 = new AsyncEvent('event2', async_hooks.currentId());
26+
const event2 = new AsyncResource('event2', async_hooks.currentId());
2727
event2.emitDestroy();
2828

2929
console.log('heartbeat: still alive');

test/async-hooks/test-embedder.api.async-event.before-on-destroyed.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
const common = require('../common');
44
const assert = require('assert');
55
const async_hooks = require('async_hooks');
6-
const { AsyncEvent } = async_hooks;
6+
const { AsyncResource } = async_hooks;
77
const { spawn } = require('child_process');
88
const corruptedMsg = /async hook stack has become corrupted/;
99
const heartbeatMsg = /heartbeat: still alive/;
@@ -17,13 +17,13 @@ if (process.argv[2] === 'child') {
1717
// once 'destroy' has been emitted, we can no longer emit 'before'
1818

1919
// Emitting 'before', 'after' and then 'destroy'
20-
const event1 = new AsyncEvent('event1', async_hooks.currentId());
20+
const event1 = new AsyncResource('event1', async_hooks.currentId());
2121
event1.emitBefore();
2222
event1.emitAfter();
2323
event1.emitDestroy();
2424

2525
// Emitting 'before' after 'destroy'
26-
const event2 = new AsyncEvent('event2', async_hooks.currentId());
26+
const event2 = new AsyncResource('event2', async_hooks.currentId());
2727
event2.emitDestroy();
2828

2929
console.log('heartbeat: still alive');

test/async-hooks/test-embedder.api.async-event.improper-order.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
const common = require('../common');
44
const assert = require('assert');
55
const async_hooks = require('async_hooks');
6-
const { AsyncEvent } = async_hooks;
6+
const { AsyncResource } = async_hooks;
77
const { spawn } = require('child_process');
88
const corruptedMsg = /async hook stack has become corrupted/;
99
const heartbeatMsg = /heartbeat: still alive/;
@@ -17,13 +17,13 @@ if (process.argv[2] === 'child') {
1717
// async hooks enforce proper order of 'before' and 'after' invocations
1818

1919
// Proper ordering
20-
const event1 = new AsyncEvent('event1', async_hooks.currentId());
20+
const event1 = new AsyncResource('event1', async_hooks.currentId());
2121
event1.emitBefore();
2222
event1.emitAfter();
2323

2424
// Improper ordering
2525
// Emitting 'after' without 'before' which is illegal
26-
const event2 = new AsyncEvent('event2', async_hooks.currentId());
26+
const event2 = new AsyncResource('event2', async_hooks.currentId());
2727

2828
console.log('heartbeat: still alive');
2929
event2.emitAfter();

test/async-hooks/test-embedder.api.async-event.improper-unwind.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
const common = require('../common');
44
const assert = require('assert');
55
const async_hooks = require('async_hooks');
6-
const { AsyncEvent } = async_hooks;
6+
const { AsyncResource } = async_hooks;
77
const { spawn } = require('child_process');
88
const corruptedMsg = /async hook stack has become corrupted/;
99
const heartbeatMsg = /heartbeat: still alive/;
@@ -21,8 +21,8 @@ if (process.argv[2] === 'child') {
2121
// The first test of the two below follows that rule,
2222
// the second one doesnt.
2323

24-
const event1 = new AsyncEvent('event1', async_hooks.currentId());
25-
const event2 = new AsyncEvent('event2', async_hooks.currentId());
24+
const event1 = new AsyncResource('event1', async_hooks.currentId());
25+
const event2 = new AsyncResource('event2', async_hooks.currentId());
2626

2727
// Proper unwind
2828
event1.emitBefore();

test/async-hooks/test-embedder.api.async-event.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ const common = require('../common');
44
const assert = require('assert');
55
const tick = require('./tick');
66
const async_hooks = require('async_hooks');
7-
const { AsyncEvent } = async_hooks;
7+
const { AsyncResource } = async_hooks;
88

99
const initHooks = require('./init-hooks');
1010
const { checkInvocations } = require('./hook-checks');
@@ -15,7 +15,7 @@ hooks.enable();
1515
// create first custom event 'alcazares' with triggerId derived
1616
// from async_hooks currentId
1717
const alcaTriggerId = async_hooks.currentId();
18-
const alcaEvent = new AsyncEvent('alcazares', alcaTriggerId);
18+
const alcaEvent = new AsyncResource('alcazares', alcaTriggerId);
1919
const alcazaresActivities = hooks.activitiesOfTypes([ 'alcazares' ]);
2020

2121
// alcazares event was constructed and thus only has an `init` call
@@ -49,7 +49,7 @@ function tick1() {
4949

5050
// The below shows that we can pass any number as a trigger id
5151
const pobTriggerId = 111;
52-
const pobEvent = new AsyncEvent('poblado', pobTriggerId);
52+
const pobEvent = new AsyncResource('poblado', pobTriggerId);
5353
const pobladoActivities = hooks.activitiesOfTypes([ 'poblado' ]);
5454
const poblado = pobladoActivities[0];
5555
assert.strictEqual(poblado.type, 'poblado', 'poblado');

0 commit comments

Comments
 (0)