This repository has been archived by the owner on Apr 22, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 7.3k
node: do not print SyntaxError hints to stderr #7049
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -1268,80 +1268,121 @@ ssize_t DecodeWrite(char *buf, | |
return StringBytes::Write(buf, buflen, val, encoding, NULL); | ||
} | ||
|
||
void DisplayExceptionLine(Handle<Message> message) { | ||
// Prevent re-entry into this function. For example, if there is | ||
// a throw from a program in vm.runInThisContext(code, filename, true), | ||
// then we want to show the original failure, not the secondary one. | ||
static bool displayed_error = false; | ||
|
||
if (displayed_error) | ||
void AppendExceptionLine(Environment* env, | ||
Handle<Value> er, | ||
Handle<Message> message) { | ||
static bool printed_error = false; | ||
if (message.IsEmpty()) | ||
return; | ||
displayed_error = true; | ||
|
||
uv_tty_reset_mode(); | ||
HandleScope scope(env->isolate()); | ||
Local<Object> err_obj; | ||
if (!er.IsEmpty() && er->IsObject()) { | ||
err_obj = er.As<Object>(); | ||
|
||
fprintf(stderr, "\n"); | ||
|
||
if (!message.IsEmpty()) { | ||
// Print (filename):(line number): (message). | ||
String::Utf8Value filename(message->GetScriptResourceName()); | ||
const char* filename_string = *filename; | ||
int linenum = message->GetLineNumber(); | ||
fprintf(stderr, "%s:%i\n", filename_string, linenum); | ||
// Print line of source code. | ||
String::Utf8Value sourceline(message->GetSourceLine()); | ||
const char* sourceline_string = *sourceline; | ||
|
||
// Because of how node modules work, all scripts are wrapped with a | ||
// "function (module, exports, __filename, ...) {" | ||
// to provide script local variables. | ||
// | ||
// When reporting errors on the first line of a script, this wrapper | ||
// function is leaked to the user. There used to be a hack here to | ||
// truncate off the first 62 characters, but it caused numerous other | ||
// problems when vm.runIn*Context() methods were used for non-module | ||
// code. | ||
// | ||
// If we ever decide to re-instate such a hack, the following steps | ||
// must be taken: | ||
// | ||
// 1. Pass a flag around to say "this code was wrapped" | ||
// 2. Update the stack frame output so that it is also correct. | ||
// | ||
// It would probably be simpler to add a line rather than add some | ||
// number of characters to the first line, since V8 truncates the | ||
// sourceline to 78 characters, and we end up not providing very much | ||
// useful debugging info to the user if we remove 62 characters. | ||
|
||
int start = message->GetStartColumn(); | ||
int end = message->GetEndColumn(); | ||
|
||
fprintf(stderr, "%s\n", sourceline_string); | ||
// Print wavy underline (GetUnderline is deprecated). | ||
for (int i = 0; i < start; i++) { | ||
fputc((sourceline_string[i] == '\t') ? '\t' : ' ', stderr); | ||
} | ||
for (int i = start; i < end; i++) { | ||
fputc('^', stderr); | ||
} | ||
fputc('\n', stderr); | ||
// Do it only once per message | ||
if (!err_obj->GetHiddenValue(env->processed_string()).IsEmpty()) | ||
return; | ||
err_obj->SetHiddenValue(env->processed_string(), True(env->isolate())); | ||
} | ||
|
||
static char arrow[1024]; | ||
|
||
// Print (filename):(line number): (message). | ||
String::Utf8Value filename(message->GetScriptResourceName()); | ||
const char* filename_string = *filename; | ||
int linenum = message->GetLineNumber(); | ||
// Print line of source code. | ||
String::Utf8Value sourceline(message->GetSourceLine()); | ||
const char* sourceline_string = *sourceline; | ||
|
||
// Because of how node modules work, all scripts are wrapped with a | ||
// "function (module, exports, __filename, ...) {" | ||
// to provide script local variables. | ||
// | ||
// When reporting errors on the first line of a script, this wrapper | ||
// function is leaked to the user. There used to be a hack here to | ||
// truncate off the first 62 characters, but it caused numerous other | ||
// problems when vm.runIn*Context() methods were used for non-module | ||
// code. | ||
// | ||
// If we ever decide to re-instate such a hack, the following steps | ||
// must be taken: | ||
// | ||
// 1. Pass a flag around to say "this code was wrapped" | ||
// 2. Update the stack frame output so that it is also correct. | ||
// | ||
// It would probably be simpler to add a line rather than add some | ||
// number of characters to the first line, since V8 truncates the | ||
// sourceline to 78 characters, and we end up not providing very much | ||
// useful debugging info to the user if we remove 62 characters. | ||
|
||
int start = message->GetStartColumn(); | ||
int end = message->GetEndColumn(); | ||
|
||
int off = snprintf(arrow, | ||
sizeof(arrow), | ||
"%s:%i\n%s\n", | ||
filename_string, | ||
linenum, | ||
sourceline_string); | ||
assert(off >= 0); | ||
|
||
// Print wavy underline (GetUnderline is deprecated). | ||
for (int i = 0; i < start; i++) { | ||
assert(static_cast<size_t>(off) < sizeof(arrow)); | ||
arrow[off++] = (sourceline_string[i] == '\t') ? '\t' : ' '; | ||
} | ||
for (int i = start; i < end; i++) { | ||
assert(static_cast<size_t>(off) < sizeof(arrow)); | ||
arrow[off++] = '^'; | ||
} | ||
assert(static_cast<size_t>(off) < sizeof(arrow) - 1); | ||
arrow[off++] = '\n'; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I know this is as it was before your change, but isn't using There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I have no idea, guess it is displayed properly as we haven't seen any issues about it yet. |
||
arrow[off] = '\0'; | ||
|
||
Local<String> arrow_str = String::NewFromUtf8(env->isolate(), arrow); | ||
Local<Value> msg; | ||
Local<Value> stack; | ||
|
||
// Allocation failed, just print it out | ||
if (arrow_str.IsEmpty() || err_obj.IsEmpty() || !err_obj->IsNativeError()) | ||
goto print; | ||
|
||
msg = err_obj->Get(env->message_string()); | ||
stack = err_obj->Get(env->stack_string()); | ||
|
||
if (msg.IsEmpty() || stack.IsEmpty()) | ||
goto print; | ||
|
||
err_obj->Set(env->message_string(), | ||
String::Concat(arrow_str, msg->ToString())); | ||
err_obj->Set(env->stack_string(), | ||
String::Concat(arrow_str, stack->ToString())); | ||
return; | ||
|
||
print: | ||
if (printed_error) | ||
return; | ||
printed_error = true; | ||
uv_tty_reset_mode(); | ||
fprintf(stderr, "\n%s", arrow); | ||
} | ||
|
||
|
||
static void ReportException(Handle<Value> er, Handle<Message> message) { | ||
HandleScope scope(node_isolate); | ||
static void ReportException(Environment* env, | ||
Handle<Value> er, | ||
Handle<Message> message) { | ||
HandleScope scope(env->isolate()); | ||
|
||
DisplayExceptionLine(message); | ||
AppendExceptionLine(env, er, message); | ||
|
||
Local<Value> trace_value; | ||
|
||
if (er->IsUndefined() || er->IsNull()) { | ||
trace_value = Undefined(node_isolate); | ||
} else { | ||
trace_value = | ||
er->ToObject()->Get(FIXED_ONE_BYTE_STRING(node_isolate, "stack")); | ||
} | ||
if (er->IsUndefined() || er->IsNull()) | ||
trace_value = Undefined(env->isolate()); | ||
else | ||
trace_value = er->ToObject()->Get(env->stack_string()); | ||
|
||
String::Utf8Value trace(trace_value); | ||
|
||
|
@@ -1357,8 +1398,8 @@ static void ReportException(Handle<Value> er, Handle<Message> message) { | |
|
||
if (er->IsObject()) { | ||
Local<Object> err_obj = er.As<Object>(); | ||
message = err_obj->Get(FIXED_ONE_BYTE_STRING(node_isolate, "message")); | ||
name = err_obj->Get(FIXED_ONE_BYTE_STRING(node_isolate, "name")); | ||
message = err_obj->Get(env->message_string()); | ||
name = err_obj->Get(FIXED_ONE_BYTE_STRING(env->isolate(), "name")); | ||
} | ||
|
||
if (message.IsEmpty() || | ||
|
@@ -1379,14 +1420,16 @@ static void ReportException(Handle<Value> er, Handle<Message> message) { | |
} | ||
|
||
|
||
static void ReportException(const TryCatch& try_catch) { | ||
ReportException(try_catch.Exception(), try_catch.Message()); | ||
static void ReportException(Environment* env, const TryCatch& try_catch) { | ||
ReportException(env, try_catch.Exception(), try_catch.Message()); | ||
} | ||
|
||
|
||
// Executes a str within the current v8 context. | ||
Local<Value> ExecuteString(Handle<String> source, Handle<Value> filename) { | ||
HandleScope scope(node_isolate); | ||
static Local<Value> ExecuteString(Environment* env, | ||
Handle<String> source, | ||
Handle<Value> filename) { | ||
HandleScope scope(env->isolate()); | ||
TryCatch try_catch; | ||
|
||
// try_catch must be nonverbose to disable FatalException() handler, | ||
|
@@ -1395,13 +1438,13 @@ Local<Value> ExecuteString(Handle<String> source, Handle<Value> filename) { | |
|
||
Local<v8::Script> script = v8::Script::Compile(source, filename); | ||
if (script.IsEmpty()) { | ||
ReportException(try_catch); | ||
ReportException(env, try_catch); | ||
exit(3); | ||
} | ||
|
||
Local<Value> result = script->Run(); | ||
if (result.IsEmpty()) { | ||
ReportException(try_catch); | ||
ReportException(env, try_catch); | ||
exit(4); | ||
} | ||
|
||
|
@@ -2018,7 +2061,7 @@ void FatalException(Handle<Value> error, Handle<Message> message) { | |
if (!fatal_exception_function->IsFunction()) { | ||
// failed before the process._fatalException function was added! | ||
// this is probably pretty bad. Nothing to do but report and exit. | ||
ReportException(error, message); | ||
ReportException(env, error, message); | ||
exit(6); | ||
} | ||
|
||
|
@@ -2033,12 +2076,12 @@ void FatalException(Handle<Value> error, Handle<Message> message) { | |
|
||
if (fatal_try_catch.HasCaught()) { | ||
// the fatal exception function threw, so we must exit | ||
ReportException(fatal_try_catch); | ||
ReportException(env, fatal_try_catch); | ||
exit(7); | ||
} | ||
|
||
if (false == caught->BooleanValue()) { | ||
ReportException(error, message); | ||
ReportException(env, error, message); | ||
exit(1); | ||
} | ||
} | ||
|
@@ -2698,10 +2741,10 @@ void Load(Environment* env) { | |
// are not safe to ignore. | ||
try_catch.SetVerbose(false); | ||
|
||
Local<String> script_name = FIXED_ONE_BYTE_STRING(node_isolate, "node.js"); | ||
Local<Value> f_value = ExecuteString(MainSource(), script_name); | ||
Local<String> script_name = FIXED_ONE_BYTE_STRING(env->isolate(), "node.js"); | ||
Local<Value> f_value = ExecuteString(env, MainSource(), script_name); | ||
if (try_catch.HasCaught()) { | ||
ReportException(try_catch); | ||
ReportException(env, try_catch); | ||
exit(10); | ||
} | ||
assert(f_value->IsFunction()); | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,4 @@ | ||
before | ||
|
||
*test*message*throw_in_line_with_tabs.js:32 | ||
throw ({ foo: 'bar' }); | ||
^ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,4 @@ | ||
before | ||
|
||
*test*message*throw_non_error.js:31 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is because error was appended to the exception without |
||
throw ({ foo: 'bar' }); | ||
^ | ||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the case
NODE_MODULE_CONTEXT_AWARE()
is used, should the error for one script propagate across all the others?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see what you mean, yeah better do it as an env property.