async_hooks: clean up comments

With some of the recent work, some of the comments were no longer representative of the code, or were otherwise unclear. This commit fixes some obvious issues I found. Ref: 83e5215 Ref: 0784b04 PR-URL: #18467 Reviewed-By: Andreas Madsen <amwebdk@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
nodejs · Feb 21, 2018 · 0865d11c0828b29de686028f1e215dccd7806a11 · 0865d11
1 parent da0d776
commit 0865d11c0828b29de686028f1e215dccd7806a11
Showing with 14 additions and 13 deletions.

+12 −11 lib/internal/async_hooks.js

+2 −2 src/async_wrap.cc
diff --git a/lib/internal/async_hooks.js b/lib/internal/async_hooks.js
@@ -11,27 +11,28 @@ const async_wrap = process.binding('async_wrap');
  * the various asynchronous states of the application. These are:
  *  kExecutionAsyncId: The async_id assigned to the resource responsible for the
  *    current execution stack.
- *  kTriggerAsyncId: The trigger_async_id of the resource responsible for
- *    the current execution stack.
+ *  kTriggerAsyncId: The async_id of the resource that caused (or 'triggered')
+ *    the resource corresponding to the current execution stack.
  *  kAsyncIdCounter: Incremental counter tracking the next assigned async_id.
  *  kDefaultTriggerAsyncId: Written immediately before a resource's constructor
- *    that sets the value of the init()'s triggerAsyncId. The order of
- *    retrieving the triggerAsyncId value is passing directly to the
- *    constructor -> value set in kDefaultTriggerAsyncId -> executionAsyncId of
- *    the current resource.
+ *    that sets the value of the init()'s triggerAsyncId. The precedence order
+ *    of retrieving the triggerAsyncId value is:
+ *    1. the value passed directly to the constructor
+ *    2. value set in kDefaultTriggerAsyncId
+ *    3. executionAsyncId of the current resource.
  *
- * async_ids_fast_stack is a Float64Array that contains part of the async ID
+ * async_ids_stack is a Float64Array that contains part of the async ID
  * stack. Each pushAsyncIds() call adds two doubles to it, and each
  * popAsyncIds() call removes two doubles from it.
  * It has a fixed size, so if that is exceeded, calls to the native
  * side are used instead in pushAsyncIds() and popAsyncIds().
  */
 const { async_id_symbol, async_hook_fields, async_id_fields } = async_wrap;
 // Store the pair executionAsyncId and triggerAsyncId in a std::stack on
-// Environment::AsyncHooks::ids_stack_ tracks the resource responsible for the
-// current execution stack. This is unwound as each resource exits. In the case
-// of a fatal exception this stack is emptied after calling each hook's after()
-// callback.
+// Environment::AsyncHooks::async_ids_stack_ tracks the resource responsible for
+// the current execution stack. This is unwound as each resource exits. In the
+// case of a fatal exception this stack is emptied after calling each hook's
+// after() callback.
 const { pushAsyncIds: pushAsyncIds_, popAsyncIds: popAsyncIds_ } = async_wrap;
 // For performance reasons, only track Promises when a hook is enabled.
 const { enablePromiseHook, disablePromiseHook } = async_wrap;

diff --git a/src/async_wrap.cc b/src/async_wrap.cc
@@ -532,12 +532,12 @@ void AsyncWrap::Initialize(Local<Object> target,
   // this way to allow JS and C++ to read/write each value as quickly as
   // possible. The fields are represented as follows:
   //
-  // kAsyncUid: Maintains the state of the next unique id to be assigned.
+  // kAsyncIdCounter: Maintains the state of the next unique id to be assigned.
   //
   // kDefaultTriggerAsyncId: Write the id of the resource responsible for a
   //   handle's creation just before calling the new handle's constructor.
   //   After the new handle is constructed kDefaultTriggerAsyncId is set back
-  //   to 0.
+  //   to -1.
   FORCE_SET_TARGET_FIELD(target,
                          "async_id_fields",
                          env->async_hooks()->async_id_fields().GetJSArray());