Head

GCC Code Coverage Report

Directory:	./		Exec	Total	Coverage
File:	node_task_queue.cc	Lines:	104	113	92.0 %
Date:	2022-08-14 04:19:53	Branches:	50	74	67.6 %


#include "async_wrap.h"
#include "env-inl.h"
#include "node.h"
#include "node_errors.h"
#include "node_external_reference.h"
#include "node_internals.h"
#include "node_process-inl.h"
#include "util-inl.h"
#include "v8.h"

#include <atomic>

namespace node {

using errors::TryCatchScope;
using v8::Context;
using v8::Function;
using v8::FunctionCallbackInfo;
using v8::Isolate;
using v8::Just;
using v8::kPromiseHandlerAddedAfterReject;
using v8::kPromiseRejectAfterResolved;
using v8::kPromiseRejectWithNoHandler;
using v8::kPromiseResolveAfterResolved;
using v8::Local;
using v8::Maybe;
using v8::Number;
using v8::Object;
using v8::Promise;
using v8::PromiseRejectEvent;
using v8::PromiseRejectMessage;
using v8::Value;

static Maybe<double> GetAssignedPromiseAsyncId(Environment* env,
                                               Local<Promise> promise,
                                               Local<Value> id_symbol) {
  Local<Value> maybe_async_id;
  if (!promise->Get(env->context(), id_symbol).ToLocal(&maybe_async_id)) {
    return v8::Just(AsyncWrap::kInvalidAsyncId);
  }
  return maybe_async_id->IsNumber()
      ? maybe_async_id->NumberValue(env->context())
      : v8::Just(AsyncWrap::kInvalidAsyncId);
}

static Maybe<double> GetAssignedPromiseWrapAsyncId(Environment* env,
                                                   Local<Promise> promise,
                                                   Local<Value> id_symbol) {
  // This check is imperfect. If the internal field is set, it should
  // be an object. If it's not, we just ignore it. Ideally v8 would
  // have had GetInternalField returning a MaybeLocal but this works
  // for now.
  Local<Value> promiseWrap = promise->GetInternalField(0);
  if (promiseWrap->IsObject()) {
        Local<Value> maybe_async_id;
    if (!promiseWrap.As<Object>()->Get(env->context(), id_symbol)
        .ToLocal(&maybe_async_id)) {
      return v8::Just(AsyncWrap::kInvalidAsyncId);
    }
    return maybe_async_id->IsNumber()
        ? maybe_async_id->NumberValue(env->context())
        : v8::Just(AsyncWrap::kInvalidAsyncId);
  } else {
      return v8::Just(AsyncWrap::kInvalidAsyncId);
  }
}

void PromiseRejectCallback(PromiseRejectMessage message) {
  static std::atomic<uint64_t> unhandledRejections{0};
  static std::atomic<uint64_t> rejectionsHandledAfter{0};

  Local<Promise> promise = message.GetPromise();
  Isolate* isolate = promise->GetIsolate();
  PromiseRejectEvent event = message.GetEvent();

  Environment* env = Environment::GetCurrent(isolate);

  if (env == nullptr || !env->can_call_into_js()) return;

  Local<Function> callback = env->promise_reject_callback();
  // The promise is rejected before JS land calls SetPromiseRejectCallback
  // to initializes the promise reject callback during bootstrap.
  CHECK(!callback.IsEmpty());

  Local<Value> value;
  Local<Value> type = Number::New(env->isolate(), event);

  if (event == kPromiseRejectWithNoHandler) {
    value = message.GetValue();
    unhandledRejections++;
    TRACE_COUNTER2(TRACING_CATEGORY_NODE2(promises, rejections),
                  "rejections",
                  "unhandled", unhandledRejections,
                  "handledAfter", rejectionsHandledAfter);
  } else if (event == kPromiseHandlerAddedAfterReject) {
    value = Undefined(isolate);
    rejectionsHandledAfter++;
    TRACE_COUNTER2(TRACING_CATEGORY_NODE2(promises, rejections),
                  "rejections",
                  "unhandled", unhandledRejections,
                  "handledAfter", rejectionsHandledAfter);
  } else if (event == kPromiseResolveAfterResolved) {
    value = message.GetValue();
  } else if (event == kPromiseRejectAfterResolved) {
    value = message.GetValue();
  } else {
    return;
  }

  if (value.IsEmpty()) {
    value = Undefined(isolate);
  }

  Local<Value> args[] = { type, promise, value };

  double async_id = AsyncWrap::kInvalidAsyncId;
  double trigger_async_id = AsyncWrap::kInvalidAsyncId;
  TryCatchScope try_catch(env);

  if (!GetAssignedPromiseAsyncId(env, promise, env->async_id_symbol())
          .To(&async_id)) return;
  if (!GetAssignedPromiseAsyncId(env, promise, env->trigger_async_id_symbol())
          .To(&trigger_async_id)) return;

  if (async_id == AsyncWrap::kInvalidAsyncId &&
      trigger_async_id == AsyncWrap::kInvalidAsyncId) {
    // That means that promise might be a PromiseWrap, so we'll
    // check there as well.
    if (!GetAssignedPromiseWrapAsyncId(env, promise, env->async_id_symbol())
              .To(&async_id)) return;
    if (!GetAssignedPromiseWrapAsyncId(
          env, promise, env->trigger_async_id_symbol())
              .To(&trigger_async_id)) return;
  }

  if (async_id != AsyncWrap::kInvalidAsyncId &&
      trigger_async_id != AsyncWrap::kInvalidAsyncId) {
    env->async_hooks()->push_async_context(
        async_id, trigger_async_id, promise);
  }

  USE(callback->Call(
      env->context(), Undefined(isolate), arraysize(args), args));

  if (async_id != AsyncWrap::kInvalidAsyncId &&
      trigger_async_id != AsyncWrap::kInvalidAsyncId &&
      env->execution_async_id() == async_id) {
    // This condition might not be true if async_hooks was enabled during
    // the promise callback execution.
    env->async_hooks()->pop_async_context(async_id);
  }

  // V8 does not expect this callback to have a scheduled exceptions once it
  // returns, so we print them out in a best effort to do something about it
  // without failing silently and without crashing the process.
  if (try_catch.HasCaught() && !try_catch.HasTerminated()) {
    fprintf(stderr, "Exception in PromiseRejectCallback:\n");
    PrintCaughtException(isolate, env->context(), try_catch);
  }
}
namespace task_queue {

static void EnqueueMicrotask(const FunctionCallbackInfo<Value>& args) {
  Environment* env = Environment::GetCurrent(args);
  Isolate* isolate = env->isolate();

  CHECK(args[0]->IsFunction());

  isolate->GetCurrentContext()->GetMicrotaskQueue()
      ->EnqueueMicrotask(isolate, args[0].As<Function>());
}

static void RunMicrotasks(const FunctionCallbackInfo<Value>& args) {
  Environment* env = Environment::GetCurrent(args);
  env->context()->GetMicrotaskQueue()->PerformCheckpoint(env->isolate());
}

static void SetTickCallback(const FunctionCallbackInfo<Value>& args) {
  Environment* env = Environment::GetCurrent(args);
  CHECK(args[0]->IsFunction());
  env->set_tick_callback_function(args[0].As<Function>());
}

static void SetPromiseRejectCallback(
    const FunctionCallbackInfo<Value>& args) {
  Environment* env = Environment::GetCurrent(args);

  CHECK(args[0]->IsFunction());
  env->set_promise_reject_callback(args[0].As<Function>());
}

static void Initialize(Local<Object> target,
                       Local<Value> unused,
                       Local<Context> context,
                       void* priv) {
  Environment* env = Environment::GetCurrent(context);
  Isolate* isolate = env->isolate();

  SetMethod(context, target, "enqueueMicrotask", EnqueueMicrotask);
  SetMethod(context, target, "setTickCallback", SetTickCallback);
  SetMethod(context, target, "runMicrotasks", RunMicrotasks);
  target->Set(env->context(),
              FIXED_ONE_BYTE_STRING(isolate, "tickInfo"),
              env->tick_info()->fields().GetJSArray()).Check();

  Local<Object> events = Object::New(isolate);
  NODE_DEFINE_CONSTANT(events, kPromiseRejectWithNoHandler);
  NODE_DEFINE_CONSTANT(events, kPromiseHandlerAddedAfterReject);
  NODE_DEFINE_CONSTANT(events, kPromiseResolveAfterResolved);
  NODE_DEFINE_CONSTANT(events, kPromiseRejectAfterResolved);

  target->Set(env->context(),
              FIXED_ONE_BYTE_STRING(isolate, "promiseRejectEvents"),
              events).Check();
  SetMethod(
      context, target, "setPromiseRejectCallback", SetPromiseRejectCallback);
}

void RegisterExternalReferences(ExternalReferenceRegistry* registry) {
  registry->Register(EnqueueMicrotask);
  registry->Register(SetTickCallback);
  registry->Register(RunMicrotasks);
  registry->Register(SetPromiseRejectCallback);
}

}  // namespace task_queue
}  // namespace node

NODE_MODULE_CONTEXT_AWARE_INTERNAL(task_queue, node::task_queue::Initialize)
NODE_MODULE_EXTERNAL_REFERENCE(task_queue,
                               node::task_queue::RegisterExternalReferences)


Generated by: GCOVR (Version 4.2)

Line	Branch	Exec	Source
1			#include "async_wrap.h"
2			#include "env-inl.h"
3			#include "node.h"
4			#include "node_errors.h"
5			#include "node_external_reference.h"
6			#include "node_internals.h"
7			#include "node_process-inl.h"
8			#include "util-inl.h"
9			#include "v8.h"
10
11			#include <atomic>
12
13			namespace node {
14
15			using errors::TryCatchScope;
16			using v8::Context;
17			using v8::Function;
18			using v8::FunctionCallbackInfo;
19			using v8::Isolate;
20			using v8::Just;
21			using v8::kPromiseHandlerAddedAfterReject;
22			using v8::kPromiseRejectAfterResolved;
23			using v8::kPromiseRejectWithNoHandler;
24			using v8::kPromiseResolveAfterResolved;
25			using v8::Local;
26			using v8::Maybe;
27			using v8::Number;
28			using v8::Object;
29			using v8::Promise;
30			using v8::PromiseRejectEvent;
31			using v8::PromiseRejectMessage;
32			using v8::Value;
33
34		103418	static Maybe<double> GetAssignedPromiseAsyncId(Environment* env,
35			Local<Promise> promise,
36			Local<Value> id_symbol) {
37			Local<Value> maybe_async_id;
38	✗✓	206836	if (!promise->Get(env->context(), id_symbol).ToLocal(&maybe_async_id)) {
39			return v8::Just(AsyncWrap::kInvalidAsyncId);
40			}
41		103418	return maybe_async_id->IsNumber()
42		98	? maybe_async_id->NumberValue(env->context())
43	✓✓	103516	: v8::Just(AsyncWrap::kInvalidAsyncId);
44			}
45
46		103320	static Maybe<double> GetAssignedPromiseWrapAsyncId(Environment* env,
47			Local<Promise> promise,
48			Local<Value> id_symbol) {
49			// This check is imperfect. If the internal field is set, it should
50			// be an object. If it's not, we just ignore it. Ideally v8 would
51			// have had GetInternalField returning a MaybeLocal but this works
52			// for now.
53		206640	Local<Value> promiseWrap = promise->GetInternalField(0);
54	✗✓	103320	if (promiseWrap->IsObject()) {
55			Local<Value> maybe_async_id;
56			if (!promiseWrap.As<Object>()->Get(env->context(), id_symbol)
57			.ToLocal(&maybe_async_id)) {
58			return v8::Just(AsyncWrap::kInvalidAsyncId);
59			}
60			return maybe_async_id->IsNumber()
61			? maybe_async_id->NumberValue(env->context())
62			: v8::Just(AsyncWrap::kInvalidAsyncId);
63			} else {
64		103320	return v8::Just(AsyncWrap::kInvalidAsyncId);
65			}
66			}
67
68		51710	void PromiseRejectCallback(PromiseRejectMessage message) {
69			static std::atomic<uint64_t> unhandledRejections{0};
70			static std::atomic<uint64_t> rejectionsHandledAfter{0};
71
72		51710	Local<Promise> promise = message.GetPromise();
73		51710	Isolate* isolate = promise->GetIsolate();
74		51710	PromiseRejectEvent event = message.GetEvent();
75
76		51710	Environment* env = Environment::GetCurrent(isolate);
77
78	✓✗✓✓ ✓✓	51710	if (env == nullptr \|\| !env->can_call_into_js()) return;
79
80		51709	Local<Function> callback = env->promise_reject_callback();
81			// The promise is rejected before JS land calls SetPromiseRejectCallback
82			// to initializes the promise reject callback during bootstrap.
83	✗✓	51709	CHECK(!callback.IsEmpty());
84
85			Local<Value> value;
86		51709	Local<Value> type = Number::New(env->isolate(), event);
87
88	✓✓	51709	if (event == kPromiseRejectWithNoHandler) {
89		23088	value = message.GetValue();
90		23088	unhandledRejections++;
91	✓✓✓✓	23311	TRACE_COUNTER2(TRACING_CATEGORY_NODE2(promises, rejections),
92			"rejections",
93			"unhandled", unhandledRejections,
94			"handledAfter", rejectionsHandledAfter);
95	✓✓	28621	} else if (event == kPromiseHandlerAddedAfterReject) {
96		21573	value = Undefined(isolate);
97		21573	rejectionsHandledAfter++;
98	✓✓✗✓	21771	TRACE_COUNTER2(TRACING_CATEGORY_NODE2(promises, rejections),
99			"rejections",
100			"unhandled", unhandledRejections,
101			"handledAfter", rejectionsHandledAfter);
102	✓✓	7048	} else if (event == kPromiseResolveAfterResolved) {
103		86	value = message.GetValue();
104	✓✗	6962	} else if (event == kPromiseRejectAfterResolved) {
105		6962	value = message.GetValue();
106			} else {
107			return;
108			}
109
110	✗✓	51709	if (value.IsEmpty()) {
111			value = Undefined(isolate);
112			}
113
114		51709	Local<Value> args[] = { type, promise, value };
115
116		51709	double async_id = AsyncWrap::kInvalidAsyncId;
117		51709	double trigger_async_id = AsyncWrap::kInvalidAsyncId;
118		51709	TryCatchScope try_catch(env);
119
120		103418	if (!GetAssignedPromiseAsyncId(env, promise, env->async_id_symbol())
121	✗✓	51709	.To(&async_id)) return;
122		103418	if (!GetAssignedPromiseAsyncId(env, promise, env->trigger_async_id_symbol())
123	✗✓	51709	.To(&trigger_async_id)) return;
124
125	✓✓	51709	if (async_id == AsyncWrap::kInvalidAsyncId &&
126	✓✗	51660	trigger_async_id == AsyncWrap::kInvalidAsyncId) {
127			// That means that promise might be a PromiseWrap, so we'll
128			// check there as well.
129		103320	if (!GetAssignedPromiseWrapAsyncId(env, promise, env->async_id_symbol())
130	✗✓	51660	.To(&async_id)) return;
131		103320	if (!GetAssignedPromiseWrapAsyncId(
132		103320	env, promise, env->trigger_async_id_symbol())
133	✗✓	51660	.To(&trigger_async_id)) return;
134			}
135
136	✓✓	51709	if (async_id != AsyncWrap::kInvalidAsyncId &&
137	✓✗	49	trigger_async_id != AsyncWrap::kInvalidAsyncId) {
138		98	env->async_hooks()->push_async_context(
139			async_id, trigger_async_id, promise);
140			}
141
142		51709	USE(callback->Call(
143		103418	env->context(), Undefined(isolate), arraysize(args), args));
144
145		103467	if (async_id != AsyncWrap::kInvalidAsyncId &&
146	✓✓✓✗ ✓✓	51758	trigger_async_id != AsyncWrap::kInvalidAsyncId &&
147	✓✗	49	env->execution_async_id() == async_id) {
148			// This condition might not be true if async_hooks was enabled during
149			// the promise callback execution.
150		49	env->async_hooks()->pop_async_context(async_id);
151			}
152
153			// V8 does not expect this callback to have a scheduled exceptions once it
154			// returns, so we print them out in a best effort to do something about it
155			// without failing silently and without crashing the process.
156	✓✓✓✗ ✓✓	51709	if (try_catch.HasCaught() && !try_catch.HasTerminated()) {
157		423	fprintf(stderr, "Exception in PromiseRejectCallback:\n");
158		423	PrintCaughtException(isolate, env->context(), try_catch);
159			}
160			}
161			namespace task_queue {
162
163		1339	static void EnqueueMicrotask(const FunctionCallbackInfo<Value>& args) {
164		1339	Environment* env = Environment::GetCurrent(args);
165		1339	Isolate* isolate = env->isolate();
166
167	✗✓	1339	CHECK(args[0]->IsFunction());
168
169		2678	isolate->GetCurrentContext()->GetMicrotaskQueue()
170	✓✗	4017	->EnqueueMicrotask(isolate, args[0].As<Function>());
171		1339	}
172
173		242091	static void RunMicrotasks(const FunctionCallbackInfo<Value>& args) {
174		242091	Environment* env = Environment::GetCurrent(args);
175		484182	env->context()->GetMicrotaskQueue()->PerformCheckpoint(env->isolate());
176		242083	}
177
178		762	static void SetTickCallback(const FunctionCallbackInfo<Value>& args) {
179		762	Environment* env = Environment::GetCurrent(args);
180	✗✓	762	CHECK(args[0]->IsFunction());
181		1524	env->set_tick_callback_function(args[0].As<Function>());
182		762	}
183
184		762	static void SetPromiseRejectCallback(
185			const FunctionCallbackInfo<Value>& args) {
186		762	Environment* env = Environment::GetCurrent(args);
187
188	✗✓	762	CHECK(args[0]->IsFunction());
189		1524	env->set_promise_reject_callback(args[0].As<Function>());
190		762	}
191
192		762	static void Initialize(Local<Object> target,
193			Local<Value> unused,
194			Local<Context> context,
195			void* priv) {
196		762	Environment* env = Environment::GetCurrent(context);
197		762	Isolate* isolate = env->isolate();
198
199		762	SetMethod(context, target, "enqueueMicrotask", EnqueueMicrotask);
200		762	SetMethod(context, target, "setTickCallback", SetTickCallback);
201		762	SetMethod(context, target, "runMicrotasks", RunMicrotasks);
202		762	target->Set(env->context(),
203			FIXED_ONE_BYTE_STRING(isolate, "tickInfo"),
204		2286	env->tick_info()->fields().GetJSArray()).Check();
205
206		762	Local<Object> events = Object::New(isolate);
207		2286	NODE_DEFINE_CONSTANT(events, kPromiseRejectWithNoHandler);
208		2286	NODE_DEFINE_CONSTANT(events, kPromiseHandlerAddedAfterReject);
209		2286	NODE_DEFINE_CONSTANT(events, kPromiseResolveAfterResolved);
210		2286	NODE_DEFINE_CONSTANT(events, kPromiseRejectAfterResolved);
211
212		762	target->Set(env->context(),
213			FIXED_ONE_BYTE_STRING(isolate, "promiseRejectEvents"),
214		1524	events).Check();
215		762	SetMethod(
216			context, target, "setPromiseRejectCallback", SetPromiseRejectCallback);
217		762	}
218
219		5259	void RegisterExternalReferences(ExternalReferenceRegistry* registry) {
220		5259	registry->Register(EnqueueMicrotask);
221		5259	registry->Register(SetTickCallback);
222		5259	registry->Register(RunMicrotasks);
223		5259	registry->Register(SetPromiseRejectCallback);
224		5259	}
225
226			} // namespace task_queue
227			} // namespace node
228
229		5321	NODE_MODULE_CONTEXT_AWARE_INTERNAL(task_queue, node::task_queue::Initialize)
230		5259	NODE_MODULE_EXTERNAL_REFERENCE(task_queue,
231			node::task_queue::RegisterExternalReferences)