GCC Code Coverage Report
Directory: ./ Exec Total Coverage
File: node_task_queue.cc Lines: 104 113 92.0 %
Date: 2022-06-15 16:51:59 Branches: 50 74 67.6 %

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
62828
static Maybe<double> GetAssignedPromiseAsyncId(Environment* env,
35
                                               Local<Promise> promise,
36
                                               Local<Value> id_symbol) {
37
  Local<Value> maybe_async_id;
38
125656
  if (!promise->Get(env->context(), id_symbol).ToLocal(&maybe_async_id)) {
39
    return v8::Just(AsyncWrap::kInvalidAsyncId);
40
  }
41
62828
  return maybe_async_id->IsNumber()
42
52
      ? maybe_async_id->NumberValue(env->context())
43
62880
      : v8::Just(AsyncWrap::kInvalidAsyncId);
44
}
45
46
62776
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
125552
  Local<Value> promiseWrap = promise->GetInternalField(0);
54
62776
  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
62776
      return v8::Just(AsyncWrap::kInvalidAsyncId);
65
  }
66
}
67
68
31415
void PromiseRejectCallback(PromiseRejectMessage message) {
69
  static std::atomic<uint64_t> unhandledRejections{0};
70
  static std::atomic<uint64_t> rejectionsHandledAfter{0};
71
72
31415
  Local<Promise> promise = message.GetPromise();
73
31415
  Isolate* isolate = promise->GetIsolate();
74
31415
  PromiseRejectEvent event = message.GetEvent();
75
76
31415
  Environment* env = Environment::GetCurrent(isolate);
77
78

31415
  if (env == nullptr || !env->can_call_into_js()) return;
79
80
31414
  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
31414
  CHECK(!callback.IsEmpty());
84
85
  Local<Value> value;
86
31414
  Local<Value> type = Number::New(env->isolate(), event);
87
88
31414
  if (event == kPromiseRejectWithNoHandler) {
89
13202
    value = message.GetValue();
90
13202
    unhandledRejections++;
91

13438
    TRACE_COUNTER2(TRACING_CATEGORY_NODE2(promises, rejections),
92
                  "rejections",
93
                  "unhandled", unhandledRejections,
94
                  "handledAfter", rejectionsHandledAfter);
95
18212
  } else if (event == kPromiseHandlerAddedAfterReject) {
96
11682
    value = Undefined(isolate);
97
11682
    rejectionsHandledAfter++;
98

11880
    TRACE_COUNTER2(TRACING_CATEGORY_NODE2(promises, rejections),
99
                  "rejections",
100
                  "unhandled", unhandledRejections,
101
                  "handledAfter", rejectionsHandledAfter);
102
6530
  } else if (event == kPromiseResolveAfterResolved) {
103
80
    value = message.GetValue();
104
6450
  } else if (event == kPromiseRejectAfterResolved) {
105
6450
    value = message.GetValue();
106
  } else {
107
    return;
108
  }
109
110
31414
  if (value.IsEmpty()) {
111
    value = Undefined(isolate);
112
  }
113
114
31414
  Local<Value> args[] = { type, promise, value };
115
116
31414
  double async_id = AsyncWrap::kInvalidAsyncId;
117
31414
  double trigger_async_id = AsyncWrap::kInvalidAsyncId;
118
31414
  TryCatchScope try_catch(env);
119
120
62828
  if (!GetAssignedPromiseAsyncId(env, promise, env->async_id_symbol())
121
31414
          .To(&async_id)) return;
122
62828
  if (!GetAssignedPromiseAsyncId(env, promise, env->trigger_async_id_symbol())
123
31414
          .To(&trigger_async_id)) return;
124
125
31414
  if (async_id == AsyncWrap::kInvalidAsyncId &&
126
31388
      trigger_async_id == AsyncWrap::kInvalidAsyncId) {
127
    // That means that promise might be a PromiseWrap, so we'll
128
    // check there as well.
129
62776
    if (!GetAssignedPromiseWrapAsyncId(env, promise, env->async_id_symbol())
130
31388
              .To(&async_id)) return;
131
62776
    if (!GetAssignedPromiseWrapAsyncId(
132
62776
          env, promise, env->trigger_async_id_symbol())
133
31388
              .To(&trigger_async_id)) return;
134
  }
135
136
31414
  if (async_id != AsyncWrap::kInvalidAsyncId &&
137
26
      trigger_async_id != AsyncWrap::kInvalidAsyncId) {
138
52
    env->async_hooks()->push_async_context(
139
        async_id, trigger_async_id, promise);
140
  }
141
142
31414
  USE(callback->Call(
143
62828
      env->context(), Undefined(isolate), arraysize(args), args));
144
145
62854
  if (async_id != AsyncWrap::kInvalidAsyncId &&
146

31440
      trigger_async_id != AsyncWrap::kInvalidAsyncId &&
147
26
      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
26
    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

31414
  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
710
static void EnqueueMicrotask(const FunctionCallbackInfo<Value>& args) {
164
710
  Environment* env = Environment::GetCurrent(args);
165
710
  Isolate* isolate = env->isolate();
166
167
710
  CHECK(args[0]->IsFunction());
168
169
1420
  isolate->GetCurrentContext()->GetMicrotaskQueue()
170
2130
      ->EnqueueMicrotask(isolate, args[0].As<Function>());
171
710
}
172
173
229576
static void RunMicrotasks(const FunctionCallbackInfo<Value>& args) {
174
229576
  Environment* env = Environment::GetCurrent(args);
175
459152
  env->context()->GetMicrotaskQueue()->PerformCheckpoint(env->isolate());
176
229574
}
177
178
848
static void SetTickCallback(const FunctionCallbackInfo<Value>& args) {
179
848
  Environment* env = Environment::GetCurrent(args);
180
848
  CHECK(args[0]->IsFunction());
181
1696
  env->set_tick_callback_function(args[0].As<Function>());
182
848
}
183
184
848
static void SetPromiseRejectCallback(
185
    const FunctionCallbackInfo<Value>& args) {
186
848
  Environment* env = Environment::GetCurrent(args);
187
188
848
  CHECK(args[0]->IsFunction());
189
1696
  env->set_promise_reject_callback(args[0].As<Function>());
190
848
}
191
192
848
static void Initialize(Local<Object> target,
193
                       Local<Value> unused,
194
                       Local<Context> context,
195
                       void* priv) {
196
848
  Environment* env = Environment::GetCurrent(context);
197
848
  Isolate* isolate = env->isolate();
198
199
848
  env->SetMethod(target, "enqueueMicrotask", EnqueueMicrotask);
200
848
  env->SetMethod(target, "setTickCallback", SetTickCallback);
201
848
  env->SetMethod(target, "runMicrotasks", RunMicrotasks);
202
848
  target->Set(env->context(),
203
              FIXED_ONE_BYTE_STRING(isolate, "tickInfo"),
204
2544
              env->tick_info()->fields().GetJSArray()).Check();
205
206
848
  Local<Object> events = Object::New(isolate);
207
2544
  NODE_DEFINE_CONSTANT(events, kPromiseRejectWithNoHandler);
208
2544
  NODE_DEFINE_CONSTANT(events, kPromiseHandlerAddedAfterReject);
209
2544
  NODE_DEFINE_CONSTANT(events, kPromiseResolveAfterResolved);
210
2544
  NODE_DEFINE_CONSTANT(events, kPromiseRejectAfterResolved);
211
212
848
  target->Set(env->context(),
213
              FIXED_ONE_BYTE_STRING(isolate, "promiseRejectEvents"),
214
1696
              events).Check();
215
848
  env->SetMethod(target,
216
                 "setPromiseRejectCallback",
217
                 SetPromiseRejectCallback);
218
848
}
219
220
5205
void RegisterExternalReferences(ExternalReferenceRegistry* registry) {
221
5205
  registry->Register(EnqueueMicrotask);
222
5205
  registry->Register(SetTickCallback);
223
5205
  registry->Register(RunMicrotasks);
224
5205
  registry->Register(SetPromiseRejectCallback);
225
5205
}
226
227
}  // namespace task_queue
228
}  // namespace node
229
230
5273
NODE_MODULE_CONTEXT_AWARE_INTERNAL(task_queue, node::task_queue::Initialize)
231
5205
NODE_MODULE_EXTERNAL_REFERENCE(task_queue,
232
                               node::task_queue::RegisterExternalReferences)