Skip to content

Commit 7f6d0ae

Browse files
committed
Add warning for ill-use of non-corked responses in "async" place
1 parent 66fd03a commit 7f6d0ae

4 files changed

Lines changed: 42 additions & 5 deletions

File tree

‎examples/AsyncFunction.js‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,15 @@
11
/* SSL/non-SSL example with async/await functions */
22

3+
function delay(t, val) {
4+
return new Promise(function(resolve) {
5+
setTimeout(function() {
6+
resolve(val);
7+
}, t);
8+
});
9+
}
10+
311
async function someAsyncTask() {
4-
return 'Hey wait for me!';
12+
return delay(500, 'Hey wait for me!');
513
}
614

715
const uWS = require('../dist/uws.js');
@@ -22,7 +30,9 @@ const app = uWS./*SSL*/App({
2230

2331
/* If we were aborted, you cannot respond */
2432
if (!res.aborted) {
25-
res.end(r);
33+
res.cork(() => {
34+
res.end(r);
35+
});
2636
}
2737
}).listen(port, (token) => {
2838
if (token) {

‎examples/Headers.js‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ const app = uWS./*SSL*/App({
1212

1313
res.write('<h2>Hello, your headers are:</h2><ul>');
1414

15+
console.log("yolo!");
16+
process.nextTick(() => {console.log("second tolo!")});
17+
1518
req.forEach((k, v) => {
1619
res.write('<li>');
1720
res.write(k);

‎src/HttpResponseWrapper.h‎

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,16 @@
2121
#include <v8.h>
2222
using namespace v8;
2323

24+
thread_local int insideCorkCallback = 0;
25+
2426
struct HttpResponseWrapper {
2527

28+
static void assumeCorked() {
29+
if (!insideCorkCallback) {
30+
std::cerr << "Critical warning: Calling uWS.HttpResponse [.writeStatus, .writeHeader, .end, .write, .tryEnd, .upgrade, .endWithoutBody, or similar] outside of uWS.HttpResponse.cork callback is highly discouraged due to major performance loss! Read the user manual and make the fix." << std::endl;
31+
}
32+
}
33+
2634
template <int PROTOCOL>
2735
static inline constexpr decltype(auto) getHttpResponse(const FunctionCallbackInfo<Value> &args) {
2836
Isolate *isolate = args.GetIsolate();
@@ -219,7 +227,8 @@ struct HttpResponseWrapper {
219227
if (data.isInvalid(args)) {
220228
return;
221229
}
222-
230+
231+
assumeCorked();
223232
res->writeStatus(data.getString());
224233

225234
args.GetReturnValue().Set(args.Holder());
@@ -242,6 +251,7 @@ struct HttpResponseWrapper {
242251
}
243252

244253
invalidateResObject(args);
254+
assumeCorked();
245255
res->endWithoutBody(reportedContentLength, closeConnection);
246256

247257
args.GetReturnValue().Set(args.Holder());
@@ -265,6 +275,7 @@ struct HttpResponseWrapper {
265275

266276
invalidateResObject(args);
267277

278+
assumeCorked();
268279
res->end(data.getString(), closeConnection);
269280

270281
args.GetReturnValue().Set(args.Holder());
@@ -287,6 +298,7 @@ struct HttpResponseWrapper {
287298
totalSize = (size_t) args[1]->NumberValue(isolate->GetCurrentContext()).ToChecked();
288299
}
289300

301+
assumeCorked();
290302
auto [ok, hasResponded] = res->tryEnd(data.getString(), totalSize);
291303

292304
/* Invalidate this object if we responded completely */
@@ -313,6 +325,7 @@ struct HttpResponseWrapper {
313325
if (data.isInvalid(args)) {
314326
return;
315327
}
328+
assumeCorked();
316329
bool ok = res->write(data.getString());
317330

318331
args.GetReturnValue().Set(Boolean::New(isolate, ok));
@@ -333,6 +346,7 @@ struct HttpResponseWrapper {
333346
if (value.isInvalid(args)) {
334347
return;
335348
}
349+
assumeCorked();
336350
res->writeHeader(header.getString(), value.getString());
337351

338352
args.GetReturnValue().Set(args.Holder());
@@ -347,8 +361,10 @@ struct HttpResponseWrapper {
347361
if (res) {
348362

349363
res->cork([cb = Local<Function>::Cast(args[0]), isolate]() {
364+
insideCorkCallback++;
350365
/* This one is called from JS so we don't need CallJS */
351366
cb->Call(isolate->GetCurrentContext(), isolate->GetCurrentContext()->Global(), 0, nullptr).IsEmpty();
367+
insideCorkCallback--;
352368
});
353369

354370
args.GetReturnValue().Set(args.Holder());
@@ -390,6 +406,7 @@ struct HttpResponseWrapper {
390406
userData.Reset(isolate, Local<Object>::Cast(args[0]));
391407

392408
/* Immediately calls open handler */
409+
assumeCorked();
393410
res->template upgrade<PerSocketData>({
394411
std::move(userData)
395412
}, secWebSocketKey.getString(), secWebSocketProtocol.getString(),

‎src/Utilities.h‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,20 @@ using namespace v8;
2727
MaybeLocal<Value> CallJS(Isolate *isolate, Local<Function> f, int argc, Local<Value> *argv) {
2828
extern struct us_loop_t *us_loop;
2929
extern int calledIntoJS;
30+
extern thread_local int insideCorkCallback;
31+
/* All calls we do into JS are properly corked, except for res.cork, where we increase the counter explicitly */
32+
insideCorkCallback++;
3033
if (us_loop) {
3134
calledIntoJS = 1;
3235
/* Fast path */
33-
return f->Call(isolate->GetCurrentContext(), isolate->GetCurrentContext()->Global(), argc, argv);
36+
auto ret = f->Call(isolate->GetCurrentContext(), isolate->GetCurrentContext()->Global(), argc, argv);
37+
insideCorkCallback--;
38+
return ret;
3439
} else {
3540
/* Slow path */
36-
return node::MakeCallback(isolate, isolate->GetCurrentContext()->Global(), f, argc, argv, {0, 0});
41+
auto ret = node::MakeCallback(isolate, isolate->GetCurrentContext()->Global(), f, argc, argv, {0, 0});
42+
insideCorkCallback--;
43+
return ret;
3744
}
3845
}
3946

0 commit comments

Comments
 (0)