Commit b7a2342

Browse files
maxhfisheraduh95
authored andcommitted
src: add SetAbortHandler
Signed-off-by: Max H Fisher <mfisher187@bloomberg.net> PR-URL: #64684 Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
1 parent 4abd1c8 commit b7a2342

7 files changed

Lines changed: 171 additions & 9 deletions

File tree

β€Žsrc/node.hβ€Ž

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -853,6 +853,16 @@ NODE_EXTERN void SetProcessExitHandler(
853853
std::function<void(Environment*, int)>&& handler);
854854
NODE_EXTERNvoidDefaultProcessExitHandler(Environment* env, int exit_code);
855855

856+
// Sets a process-global handler invoked when Node.js programmatically aborts.
857+
// Nullable strings representing the location and reason for the abort may or
858+
// may not be passed as a parameter to the handler. The handler should not
859+
// return, but node will ensure that the process exits after the handler is
860+
// called regardless of whether or not it returns. Passing nullptr restores the
861+
// default handler. This is process-global and may be invoked before any Isolate
862+
// or Environment exists.
863+
using AbortHandler = void (*)(constchar* location, constchar* message);
864+
NODE_EXTERNvoidSetAbortHandler(AbortHandler handler);
865+
856866
// This may return nullptr if context is not associated with a Node instance.
857867
NODE_EXTERN Environment* GetCurrentEnvironment(v8::Local<v8::Context> context);
858868
NODE_EXTERN IsolateData* GetEnvironmentIsolateData(Environment* env);

β€Žsrc/node_errors.ccβ€Ž

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -393,6 +393,30 @@ void AppendExceptionLine(Environment* env,
393393
.FromMaybe(false));
394394
}
395395

396+
namespace {
397+
// Default handler: Dumps native + JS backtraces to stderr and exits. This
398+
// indirectly calls backtrace so it can not be marked as [[noreturn]] (see the
399+
// comment on node::Assert() below). `message` and `location` are ignored
400+
// because the assertion/fatal-error message, if any, is already printed to
401+
// stderr by the caller (Assert()/OnFatalError()) before this handler runs.
402+
voidDefaultAbortHandler(constchar* /*location*/, constchar* /*message*/) {
403+
DumpNativeBacktrace(stderr);
404+
DumpJavaScriptBacktrace(stderr);
405+
fflush(stderr);
406+
ABORT_NO_BACKTRACE();
407+
}
408+
// Constant-initialized, so this is valid from load time, safe even for a
409+
// CHECK() during early startup, before any SetAbortHandler call.
410+
AbortHandler g_abort_handler = DefaultAbortHandler;
411+
} // namespace
412+
413+
voidSetAbortHandler(AbortHandler handler) {
414+
g_abort_handler = handler ? handler : DefaultAbortHandler;
415+
}
416+
AbortHandler GetAbortHandler() {
417+
return g_abort_handler;
418+
}
419+
396420
voidAssert(const AssertionInfo& info) {
397421
std::string name = GetHumanReadableProcessName();
398422

@@ -406,7 +430,7 @@ void Assert(const AssertionInfo& info) {
406430
info.message);
407431

408432
fflush(stderr);
409-
ABORT();
433+
ABORT_WITH_DETAILS(info.file_line, info.message);
410434
}
411435

412436
enumclassEnhanceFatalException { kEnhance, kDontEnhance };
@@ -584,7 +608,7 @@ static void ReportFatalException(Environment* env,
584608
}
585609

586610
fflush(stderr);
587-
ABORT();
611+
ABORT_WITH_DETAILS(location, message);
588612
}
589613

590614
voidOOMErrorHandler(constchar* location, const v8::OOMDetails& details) {
@@ -620,7 +644,7 @@ void OOMErrorHandler(const char* location, const v8::OOMDetails& details) {
620644
}
621645

622646
fflush(stderr);
623-
ABORT();
647+
ABORT_WITH_DETAILS(location, message);
624648
}
625649

626650
v8::ModifyCodeGenerationFromStringsResult ModifyCodeGenerationFromStrings(

β€Žsrc/util.hβ€Ž

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,9 @@ void NODE_EXTERN_PRIVATE Assert(const AssertionInfo& info);
128128
voidDumpNativeBacktrace(FILE* fp);
129129
voidDumpJavaScriptBacktrace(FILE* fp);
130130

131+
// Returns the currently installed abort handler which is never null.
132+
AbortHandler GetAbortHandler();
133+
131134
// Windows 8+ does not like abort() in Release mode
132135
#ifdef _WIN32
133136
#defineABORT_NO_BACKTRACE() _exit(static_cast<int>(node::ExitCode::kAbort))
@@ -140,13 +143,12 @@ void DumpJavaScriptBacktrace(FILE* fp);
140143
// when generating code for them the compiler can choose not to
141144
// maintain the frame pointers or link registers that are necessary for
142145
// correct backtracing.
143-
// `ABORT` must be a macro and not a [[noreturn]] function to make sure the
144-
// backtrace is correct.
145-
#defineABORT() \
146+
// `ABORT` and `ABORT_WITH_DETAILS` must be a macro and not a [[noreturn]]
147+
// function to make sure the backtrace is correct.
148+
#defineABORT() ABORT_WITH_DETAILS(__FILE__ ":"STRINGIFY(__LINE__), nullptr)
149+
#defineABORT_WITH_DETAILS(location, message) \
146150
do { \
147-
node::DumpNativeBacktrace(stderr); \
148-
node::DumpJavaScriptBacktrace(stderr); \
149-
fflush(stderr); \
151+
node::GetAbortHandler()(location, message); \
150152
ABORT_NO_BACKTRACE(); \
151153
} while (0)
152154

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
#include<node.h>
2+
#include<v8.h>
3+
#include<cstdio>
4+
5+
namespace {
6+
voidTestAbortHandler(constchar* /*location*/, constchar* /*message*/) {
7+
fputs("CUSTOM_ABORT_HANDLER_RAN\n", stderr);
8+
fflush(stderr);
9+
}
10+
11+
voidInstallAbortHandler(const v8::FunctionCallbackInfo<v8::Value>&) {
12+
node::SetAbortHandler(TestAbortHandler);
13+
}
14+
} // namespace
15+
16+
NODE_MODULE_INIT() {
17+
NODE_SET_METHOD(exports, "installAbortHandler", InstallAbortHandler);
18+
}
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
'targets': [
3+
{
4+
'target_name': 'binding',
5+
'sources': [ 'binding.cc' ],
6+
'includes': ['../common.gypi'],
7+
}
8+
]
9+
}
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
'use strict';
2+
constcommon=require('../../common');
3+
constassert=require('assert');
4+
constfs=require('fs');
5+
constpath=require('path');
6+
const{ exec }=require('child_process');
7+
8+
constbindingPath=path.resolve(
9+
__dirname,'build',common.buildType,'binding.node');
10+
11+
if(!fs.existsSync(bindingPath))
12+
common.skip('binding not built yet');
13+
14+
if(process.argv[2]==='child'){
15+
constbinding=require(bindingPath);
16+
binding.installAbortHandler();
17+
process.abort();
18+
return;
19+
}
20+
21+
constescapedArgs=
22+
common.escapePOSIXShell`"${process.execPath}" "${__filename}" child`;
23+
if(!common.isWindows){
24+
// Do not create core files, as it can take a lot of disk space on
25+
// continuous testing and developers' machines.
26+
escapedArgs[0]='ulimit -c 0 && '+escapedArgs[0];
27+
}
28+
29+
exec(...escapedArgs,common.mustCall((err,stdout,stderr)=>{
30+
assert.ok(
31+
stderr.includes('CUSTOM_ABORT_HANDLER_RAN'),
32+
`Expected custom abort handler marker in stderr, got:\n${stderr}`);
33+
assert.ok(
34+
!stderr.includes('Native stack trace'),
35+
`Expected the custom handler to replace the default dump, got:\n${stderr}`);
36+
37+
// The child aborts. Whether that surfaces as the SIGABRT signal or as exit
38+
// code 134 depends on shell wrapping: the `ulimit -c 0 && ...` prefix makes
39+
// /bin/sh wait on (rather than exec-replace itself with) the node grandchild,
40+
// so sh reports the aborted grandchild as a normal exit with code 134.
41+
// common.nodeProcessAborted() accepts both forms.
42+
assert.ok(
43+
err&&common.nodeProcessAborted(err.code,err.signal),
44+
`Expected the child to abort, got code=${err?.code} signal=${err?.signal}`);
45+
}));

β€Žtest/cctest/test_environment.ccβ€Ž

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1201,3 +1201,57 @@ TEST_F(EnvironmentTest, LoadEnvironmentWithCallbackWithESModule) {
12011201
printf("Frame: %s\n", *frame_str);
12021202
EXPECT_EQ(frame_str.ToString(), " at embedded:esm.mjs:3:15");
12031203
}
1204+
1205+
namespace {
1206+
voidCustomAbortHandlerForContractTest(constchar* location,
1207+
constchar* message) {}
1208+
1209+
bool abort_handler_dispatch_flag = false;
1210+
constchar* abort_handler_received_location = nullptr;
1211+
constchar* abort_handler_received_message = nullptr;
1212+
voidAbortHandlerThatSetsDispatchFlag(constchar* location,
1213+
constchar* message) {
1214+
abort_handler_dispatch_flag = true;
1215+
abort_handler_received_location = location;
1216+
abort_handler_received_message = message;
1217+
}
1218+
} // namespace
1219+
1220+
TEST(AbortHandlerTest, DefaultIsNonNullAndSetAbortHandlerRoundTrips) {
1221+
node::AbortHandler old = node::GetAbortHandler();
1222+
1223+
// There should always be a non-null default handler installed.
1224+
EXPECT_NE(node::GetAbortHandler(), nullptr);
1225+
1226+
node::SetAbortHandler(CustomAbortHandlerForContractTest);
1227+
EXPECT_EQ(node::GetAbortHandler(), CustomAbortHandlerForContractTest);
1228+
1229+
node::SetAbortHandler(nullptr);
1230+
EXPECT_NE(node::GetAbortHandler(), nullptr);
1231+
EXPECT_NE(node::GetAbortHandler(), CustomAbortHandlerForContractTest);
1232+
1233+
node::SetAbortHandler(old);
1234+
}
1235+
1236+
TEST(AbortHandlerTest, InstalledHandlerIsInvokedWhenCalled) {
1237+
node::AbortHandler old = node::GetAbortHandler();
1238+
abort_handler_dispatch_flag = false;
1239+
abort_handler_received_location = nullptr;
1240+
abort_handler_received_message = nullptr;
1241+
1242+
node::SetAbortHandler(AbortHandlerThatSetsDispatchFlag);
1243+
node::AbortHandler h = node::GetAbortHandler();
1244+
// Fail cleanly (instead of crashing on a null call) if the handler wasn't
1245+
// actually installed.
1246+
ASSERT_NE(h, nullptr);
1247+
1248+
// Dispatch through the public GetAbortHandler() accessor directly (not via
1249+
// the ABORT() macro, so nothing terminates), and verify the message is
1250+
// passed through unchanged.
1251+
node::GetAbortHandler()("some-test-location", "some-test-message");
1252+
EXPECT_TRUE(abort_handler_dispatch_flag);
1253+
EXPECT_STREQ(abort_handler_received_location, "some-test-location");
1254+
EXPECT_STREQ(abort_handler_received_message, "some-test-message");
1255+
1256+
node::SetAbortHandler(old);
1257+
}

0 commit comments

Comments
Β (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Commit b7a2342

Browse files
maxhfisheraduh95
authored andcommitted
src: add SetAbortHandler
Signed-off-by: Max H Fisher <mfisher187@bloomberg.net> PR-URL: #64684 Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
1 parent 4abd1c8 commit b7a2342

7 files changed

Lines changed: 171 additions & 9 deletions

File tree

β€Žsrc/node.hβ€Ž

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -853,6 +853,16 @@ NODE_EXTERN void SetProcessExitHandler(
853853
std::function<void(Environment*, int)>&& handler);
854854
NODE_EXTERNvoidDefaultProcessExitHandler(Environment* env, int exit_code);
855855

856+
// Sets a process-global handler invoked when Node.js programmatically aborts.
857+
// Nullable strings representing the location and reason for the abort may or
858+
// may not be passed as a parameter to the handler. The handler should not
859+
// return, but node will ensure that the process exits after the handler is
860+
// called regardless of whether or not it returns. Passing nullptr restores the
861+
// default handler. This is process-global and may be invoked before any Isolate
862+
// or Environment exists.
863+
using AbortHandler = void (*)(constchar* location, constchar* message);
864+
NODE_EXTERNvoidSetAbortHandler(AbortHandler handler);
865+
856866
// This may return nullptr if context is not associated with a Node instance.
857867
NODE_EXTERN Environment* GetCurrentEnvironment(v8::Local<v8::Context> context);
858868
NODE_EXTERN IsolateData* GetEnvironmentIsolateData(Environment* env);

β€Žsrc/node_errors.ccβ€Ž

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -393,6 +393,30 @@ void AppendExceptionLine(Environment* env,
393393
.FromMaybe(false));
394394
}
395395

396+
namespace {
397+
// Default handler: Dumps native + JS backtraces to stderr and exits. This
398+
// indirectly calls backtrace so it can not be marked as [[noreturn]] (see the
399+
// comment on node::Assert() below). `message` and `location` are ignored
400+
// because the assertion/fatal-error message, if any, is already printed to
401+
// stderr by the caller (Assert()/OnFatalError()) before this handler runs.
402+
voidDefaultAbortHandler(constchar* /*location*/, constchar* /*message*/) {
403+
DumpNativeBacktrace(stderr);
404+
DumpJavaScriptBacktrace(stderr);
405+
fflush(stderr);
406+
ABORT_NO_BACKTRACE();
407+
}
408+
// Constant-initialized, so this is valid from load time, safe even for a
409+
// CHECK() during early startup, before any SetAbortHandler call.
410+
AbortHandler g_abort_handler = DefaultAbortHandler;
411+
} // namespace
412+
413+
voidSetAbortHandler(AbortHandler handler) {
414+
g_abort_handler = handler ? handler : DefaultAbortHandler;
415+
}
416+
AbortHandler GetAbortHandler() {
417+
return g_abort_handler;
418+
}
419+
396420
voidAssert(const AssertionInfo& info) {
397421
std::string name = GetHumanReadableProcessName();
398422

@@ -406,7 +430,7 @@ void Assert(const AssertionInfo& info) {
406430
info.message);
407431

408432
fflush(stderr);
409-
ABORT();
433+
ABORT_WITH_DETAILS(info.file_line, info.message);
410434
}
411435

412436
enumclassEnhanceFatalException { kEnhance, kDontEnhance };
@@ -584,7 +608,7 @@ static void ReportFatalException(Environment* env,
584608
}
585609

586610
fflush(stderr);
587-
ABORT();
611+
ABORT_WITH_DETAILS(location, message);
588612
}
589613

590614
voidOOMErrorHandler(constchar* location, const v8::OOMDetails& details) {
@@ -620,7 +644,7 @@ void OOMErrorHandler(const char* location, const v8::OOMDetails& details) {
620644
}
621645

622646
fflush(stderr);
623-
ABORT();
647+
ABORT_WITH_DETAILS(location, message);
624648
}
625649

626650
v8::ModifyCodeGenerationFromStringsResult ModifyCodeGenerationFromStrings(

β€Žsrc/util.hβ€Ž

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,9 @@ void NODE_EXTERN_PRIVATE Assert(const AssertionInfo& info);
128128
voidDumpNativeBacktrace(FILE* fp);
129129
voidDumpJavaScriptBacktrace(FILE* fp);
130130

131+
// Returns the currently installed abort handler which is never null.
132+
AbortHandler GetAbortHandler();
133+
131134
// Windows 8+ does not like abort() in Release mode
132135
#ifdef _WIN32
133136
#defineABORT_NO_BACKTRACE() _exit(static_cast<int>(node::ExitCode::kAbort))
@@ -140,13 +143,12 @@ void DumpJavaScriptBacktrace(FILE* fp);
140143
// when generating code for them the compiler can choose not to
141144
// maintain the frame pointers or link registers that are necessary for
142145
// correct backtracing.
143-
// `ABORT` must be a macro and not a [[noreturn]] function to make sure the
144-
// backtrace is correct.
145-
#defineABORT() \
146+
// `ABORT` and `ABORT_WITH_DETAILS` must be a macro and not a [[noreturn]]
147+
// function to make sure the backtrace is correct.
148+
#defineABORT() ABORT_WITH_DETAILS(__FILE__ ":"STRINGIFY(__LINE__), nullptr)
149+
#defineABORT_WITH_DETAILS(location, message) \
146150
do { \
147-
node::DumpNativeBacktrace(stderr); \
148-
node::DumpJavaScriptBacktrace(stderr); \
149-
fflush(stderr); \
151+
node::GetAbortHandler()(location, message); \
150152
ABORT_NO_BACKTRACE(); \
151153
} while (0)
152154

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
#include<node.h>
2+
#include<v8.h>
3+
#include<cstdio>
4+
5+
namespace {
6+
voidTestAbortHandler(constchar* /*location*/, constchar* /*message*/) {
7+
fputs("CUSTOM_ABORT_HANDLER_RAN\n", stderr);
8+
fflush(stderr);
9+
}
10+
11+
voidInstallAbortHandler(const v8::FunctionCallbackInfo<v8::Value>&) {
12+
node::SetAbortHandler(TestAbortHandler);
13+
}
14+
} // namespace
15+
16+
NODE_MODULE_INIT() {
17+
NODE_SET_METHOD(exports, "installAbortHandler", InstallAbortHandler);
18+
}
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
'targets': [
3+
{
4+
'target_name': 'binding',
5+
'sources': [ 'binding.cc' ],
6+
'includes': ['../common.gypi'],
7+
}
8+
]
9+
}
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
'use strict';
2+
constcommon=require('../../common');
3+
constassert=require('assert');
4+
constfs=require('fs');
5+
constpath=require('path');
6+
const{ exec }=require('child_process');
7+
8+
constbindingPath=path.resolve(
9+
__dirname,'build',common.buildType,'binding.node');
10+
11+
if(!fs.existsSync(bindingPath))
12+
common.skip('binding not built yet');
13+
14+
if(process.argv[2]==='child'){
15+
constbinding=require(bindingPath);
16+
binding.installAbortHandler();
17+
process.abort();
18+
return;
19+
}
20+
21+
constescapedArgs=
22+
common.escapePOSIXShell`"${process.execPath}" "${__filename}" child`;
23+
if(!common.isWindows){
24+
// Do not create core files, as it can take a lot of disk space on
25+
// continuous testing and developers' machines.
26+
escapedArgs[0]='ulimit -c 0 && '+escapedArgs[0];
27+
}
28+
29+
exec(...escapedArgs,common.mustCall((err,stdout,stderr)=>{
30+
assert.ok(
31+
stderr.includes('CUSTOM_ABORT_HANDLER_RAN'),
32+
`Expected custom abort handler marker in stderr, got:\n${stderr}`);
33+
assert.ok(
34+
!stderr.includes('Native stack trace'),
35+
`Expected the custom handler to replace the default dump, got:\n${stderr}`);
36+
37+
// The child aborts. Whether that surfaces as the SIGABRT signal or as exit
38+
// code 134 depends on shell wrapping: the `ulimit -c 0 && ...` prefix makes
39+
// /bin/sh wait on (rather than exec-replace itself with) the node grandchild,
40+
// so sh reports the aborted grandchild as a normal exit with code 134.
41+
// common.nodeProcessAborted() accepts both forms.
42+
assert.ok(
43+
err&&common.nodeProcessAborted(err.code,err.signal),
44+
`Expected the child to abort, got code=${err?.code} signal=${err?.signal}`);
45+
}));

β€Žtest/cctest/test_environment.ccβ€Ž

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1201,3 +1201,57 @@ TEST_F(EnvironmentTest, LoadEnvironmentWithCallbackWithESModule) {
12011201
printf("Frame: %s\n", *frame_str);
12021202
EXPECT_EQ(frame_str.ToString(), " at embedded:esm.mjs:3:15");
12031203
}
1204+
1205+
namespace {
1206+
voidCustomAbortHandlerForContractTest(constchar* location,
1207+
constchar* message) {}
1208+
1209+
bool abort_handler_dispatch_flag = false;
1210+
constchar* abort_handler_received_location = nullptr;
1211+
constchar* abort_handler_received_message = nullptr;
1212+
voidAbortHandlerThatSetsDispatchFlag(constchar* location,
1213+
constchar* message) {
1214+
abort_handler_dispatch_flag = true;
1215+
abort_handler_received_location = location;
1216+
abort_handler_received_message = message;
1217+
}
1218+
} // namespace
1219+
1220+
TEST(AbortHandlerTest, DefaultIsNonNullAndSetAbortHandlerRoundTrips) {
1221+
node::AbortHandler old = node::GetAbortHandler();
1222+
1223+
// There should always be a non-null default handler installed.
1224+
EXPECT_NE(node::GetAbortHandler(), nullptr);
1225+
1226+
node::SetAbortHandler(CustomAbortHandlerForContractTest);
1227+
EXPECT_EQ(node::GetAbortHandler(), CustomAbortHandlerForContractTest);
1228+
1229+
node::SetAbortHandler(nullptr);
1230+
EXPECT_NE(node::GetAbortHandler(), nullptr);
1231+
EXPECT_NE(node::GetAbortHandler(), CustomAbortHandlerForContractTest);
1232+
1233+
node::SetAbortHandler(old);
1234+
}
1235+
1236+
TEST(AbortHandlerTest, InstalledHandlerIsInvokedWhenCalled) {
1237+
node::AbortHandler old = node::GetAbortHandler();
1238+
abort_handler_dispatch_flag = false;
1239+
abort_handler_received_location = nullptr;
1240+
abort_handler_received_message = nullptr;
1241+
1242+
node::SetAbortHandler(AbortHandlerThatSetsDispatchFlag);
1243+
node::AbortHandler h = node::GetAbortHandler();
1244+
// Fail cleanly (instead of crashing on a null call) if the handler wasn't
1245+
// actually installed.
1246+
ASSERT_NE(h, nullptr);
1247+
1248+
// Dispatch through the public GetAbortHandler() accessor directly (not via
1249+
// the ABORT() macro, so nothing terminates), and verify the message is
1250+
// passed through unchanged.
1251+
node::GetAbortHandler()("some-test-location", "some-test-message");
1252+
EXPECT_TRUE(abort_handler_dispatch_flag);
1253+
EXPECT_STREQ(abort_handler_received_location, "some-test-location");
1254+
EXPECT_STREQ(abort_handler_received_message, "some-test-message");
1255+
1256+
node::SetAbortHandler(old);
1257+
}

0 commit comments

Comments
Β (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Commit b7a2342

Browse files
maxhfisheraduh95
authored andcommitted
src: add SetAbortHandler
Signed-off-by: Max H Fisher <mfisher187@bloomberg.net> PR-URL: #64684 Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
1 parent 4abd1c8 commit b7a2342

7 files changed

Lines changed: 171 additions & 9 deletions

File tree

β€Žsrc/node.hβ€Ž

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -853,6 +853,16 @@ NODE_EXTERN void SetProcessExitHandler(
853853
std::function<void(Environment*, int)>&& handler);
854854
NODE_EXTERNvoidDefaultProcessExitHandler(Environment* env, int exit_code);
855855

856+
// Sets a process-global handler invoked when Node.js programmatically aborts.
857+
// Nullable strings representing the location and reason for the abort may or
858+
// may not be passed as a parameter to the handler. The handler should not
859+
// return, but node will ensure that the process exits after the handler is
860+
// called regardless of whether or not it returns. Passing nullptr restores the
861+
// default handler. This is process-global and may be invoked before any Isolate
862+
// or Environment exists.
863+
using AbortHandler = void (*)(constchar* location, constchar* message);
864+
NODE_EXTERNvoidSetAbortHandler(AbortHandler handler);
865+
856866
// This may return nullptr if context is not associated with a Node instance.
857867
NODE_EXTERN Environment* GetCurrentEnvironment(v8::Local<v8::Context> context);
858868
NODE_EXTERN IsolateData* GetEnvironmentIsolateData(Environment* env);

β€Žsrc/node_errors.ccβ€Ž

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -393,6 +393,30 @@ void AppendExceptionLine(Environment* env,
393393
.FromMaybe(false));
394394
}
395395

396+
namespace {
397+
// Default handler: Dumps native + JS backtraces to stderr and exits. This
398+
// indirectly calls backtrace so it can not be marked as [[noreturn]] (see the
399+
// comment on node::Assert() below). `message` and `location` are ignored
400+
// because the assertion/fatal-error message, if any, is already printed to
401+
// stderr by the caller (Assert()/OnFatalError()) before this handler runs.
402+
voidDefaultAbortHandler(constchar* /*location*/, constchar* /*message*/) {
403+
DumpNativeBacktrace(stderr);
404+
DumpJavaScriptBacktrace(stderr);
405+
fflush(stderr);
406+
ABORT_NO_BACKTRACE();
407+
}
408+
// Constant-initialized, so this is valid from load time, safe even for a
409+
// CHECK() during early startup, before any SetAbortHandler call.
410+
AbortHandler g_abort_handler = DefaultAbortHandler;
411+
} // namespace
412+
413+
voidSetAbortHandler(AbortHandler handler) {
414+
g_abort_handler = handler ? handler : DefaultAbortHandler;
415+
}
416+
AbortHandler GetAbortHandler() {
417+
return g_abort_handler;
418+
}
419+
396420
voidAssert(const AssertionInfo& info) {
397421
std::string name = GetHumanReadableProcessName();
398422

@@ -406,7 +430,7 @@ void Assert(const AssertionInfo& info) {
406430
info.message);
407431

408432
fflush(stderr);
409-
ABORT();
433+
ABORT_WITH_DETAILS(info.file_line, info.message);
410434
}
411435

412436
enumclassEnhanceFatalException { kEnhance, kDontEnhance };
@@ -584,7 +608,7 @@ static void ReportFatalException(Environment* env,
584608
}
585609

586610
fflush(stderr);
587-
ABORT();
611+
ABORT_WITH_DETAILS(location, message);
588612
}
589613

590614
voidOOMErrorHandler(constchar* location, const v8::OOMDetails& details) {
@@ -620,7 +644,7 @@ void OOMErrorHandler(const char* location, const v8::OOMDetails& details) {
620644
}
621645

622646
fflush(stderr);
623-
ABORT();
647+
ABORT_WITH_DETAILS(location, message);
624648
}
625649

626650
v8::ModifyCodeGenerationFromStringsResult ModifyCodeGenerationFromStrings(

β€Žsrc/util.hβ€Ž

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,9 @@ void NODE_EXTERN_PRIVATE Assert(const AssertionInfo& info);
128128
voidDumpNativeBacktrace(FILE* fp);
129129
voidDumpJavaScriptBacktrace(FILE* fp);
130130

131+
// Returns the currently installed abort handler which is never null.
132+
AbortHandler GetAbortHandler();
133+
131134
// Windows 8+ does not like abort() in Release mode
132135
#ifdef _WIN32
133136
#defineABORT_NO_BACKTRACE() _exit(static_cast<int>(node::ExitCode::kAbort))
@@ -140,13 +143,12 @@ void DumpJavaScriptBacktrace(FILE* fp);
140143
// when generating code for them the compiler can choose not to
141144
// maintain the frame pointers or link registers that are necessary for
142145
// correct backtracing.
143-
// `ABORT` must be a macro and not a [[noreturn]] function to make sure the
144-
// backtrace is correct.
145-
#defineABORT() \
146+
// `ABORT` and `ABORT_WITH_DETAILS` must be a macro and not a [[noreturn]]
147+
// function to make sure the backtrace is correct.
148+
#defineABORT() ABORT_WITH_DETAILS(__FILE__ ":"STRINGIFY(__LINE__), nullptr)
149+
#defineABORT_WITH_DETAILS(location, message) \
146150
do { \
147-
node::DumpNativeBacktrace(stderr); \
148-
node::DumpJavaScriptBacktrace(stderr); \
149-
fflush(stderr); \
151+
node::GetAbortHandler()(location, message); \
150152
ABORT_NO_BACKTRACE(); \
151153
} while (0)
152154

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
#include<node.h>
2+
#include<v8.h>
3+
#include<cstdio>
4+
5+
namespace {
6+
voidTestAbortHandler(constchar* /*location*/, constchar* /*message*/) {
7+
fputs("CUSTOM_ABORT_HANDLER_RAN\n", stderr);
8+
fflush(stderr);
9+
}
10+
11+
voidInstallAbortHandler(const v8::FunctionCallbackInfo<v8::Value>&) {
12+
node::SetAbortHandler(TestAbortHandler);
13+
}
14+
} // namespace
15+
16+
NODE_MODULE_INIT() {
17+
NODE_SET_METHOD(exports, "installAbortHandler", InstallAbortHandler);
18+
}
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
'targets': [
3+
{
4+
'target_name': 'binding',
5+
'sources': [ 'binding.cc' ],
6+
'includes': ['../common.gypi'],
7+
}
8+
]
9+
}
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
'use strict';
2+
constcommon=require('../../common');
3+
constassert=require('assert');
4+
constfs=require('fs');
5+
constpath=require('path');
6+
const{ exec }=require('child_process');
7+
8+
constbindingPath=path.resolve(
9+
__dirname,'build',common.buildType,'binding.node');
10+
11+
if(!fs.existsSync(bindingPath))
12+
common.skip('binding not built yet');
13+
14+
if(process.argv[2]==='child'){
15+
constbinding=require(bindingPath);
16+
binding.installAbortHandler();
17+
process.abort();
18+
return;
19+
}
20+
21+
constescapedArgs=
22+
common.escapePOSIXShell`"${process.execPath}" "${__filename}" child`;
23+
if(!common.isWindows){
24+
// Do not create core files, as it can take a lot of disk space on
25+
// continuous testing and developers' machines.
26+
escapedArgs[0]='ulimit -c 0 && '+escapedArgs[0];
27+
}
28+
29+
exec(...escapedArgs,common.mustCall((err,stdout,stderr)=>{
30+
assert.ok(
31+
stderr.includes('CUSTOM_ABORT_HANDLER_RAN'),
32+
`Expected custom abort handler marker in stderr, got:\n${stderr}`);
33+
assert.ok(
34+
!stderr.includes('Native stack trace'),
35+
`Expected the custom handler to replace the default dump, got:\n${stderr}`);
36+
37+
// The child aborts. Whether that surfaces as the SIGABRT signal or as exit
38+
// code 134 depends on shell wrapping: the `ulimit -c 0 && ...` prefix makes
39+
// /bin/sh wait on (rather than exec-replace itself with) the node grandchild,
40+
// so sh reports the aborted grandchild as a normal exit with code 134.
41+
// common.nodeProcessAborted() accepts both forms.
42+
assert.ok(
43+
err&&common.nodeProcessAborted(err.code,err.signal),
44+
`Expected the child to abort, got code=${err?.code} signal=${err?.signal}`);
45+
}));

β€Žtest/cctest/test_environment.ccβ€Ž

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1201,3 +1201,57 @@ TEST_F(EnvironmentTest, LoadEnvironmentWithCallbackWithESModule) {
12011201
printf("Frame: %s\n", *frame_str);
12021202
EXPECT_EQ(frame_str.ToString(), " at embedded:esm.mjs:3:15");
12031203
}
1204+
1205+
namespace {
1206+
voidCustomAbortHandlerForContractTest(constchar* location,
1207+
constchar* message) {}
1208+
1209+
bool abort_handler_dispatch_flag = false;
1210+
constchar* abort_handler_received_location = nullptr;
1211+
constchar* abort_handler_received_message = nullptr;
1212+
voidAbortHandlerThatSetsDispatchFlag(constchar* location,
1213+
constchar* message) {
1214+
abort_handler_dispatch_flag = true;
1215+
abort_handler_received_location = location;
1216+
abort_handler_received_message = message;
1217+
}
1218+
} // namespace
1219+
1220+
TEST(AbortHandlerTest, DefaultIsNonNullAndSetAbortHandlerRoundTrips) {
1221+
node::AbortHandler old = node::GetAbortHandler();
1222+
1223+
// There should always be a non-null default handler installed.
1224+
EXPECT_NE(node::GetAbortHandler(), nullptr);
1225+
1226+
node::SetAbortHandler(CustomAbortHandlerForContractTest);
1227+
EXPECT_EQ(node::GetAbortHandler(), CustomAbortHandlerForContractTest);
1228+
1229+
node::SetAbortHandler(nullptr);
1230+
EXPECT_NE(node::GetAbortHandler(), nullptr);
1231+
EXPECT_NE(node::GetAbortHandler(), CustomAbortHandlerForContractTest);
1232+
1233+
node::SetAbortHandler(old);
1234+
}
1235+
1236+
TEST(AbortHandlerTest, InstalledHandlerIsInvokedWhenCalled) {
1237+
node::AbortHandler old = node::GetAbortHandler();
1238+
abort_handler_dispatch_flag = false;
1239+
abort_handler_received_location = nullptr;
1240+
abort_handler_received_message = nullptr;
1241+
1242+
node::SetAbortHandler(AbortHandlerThatSetsDispatchFlag);
1243+
node::AbortHandler h = node::GetAbortHandler();
1244+
// Fail cleanly (instead of crashing on a null call) if the handler wasn't
1245+
// actually installed.
1246+
ASSERT_NE(h, nullptr);
1247+
1248+
// Dispatch through the public GetAbortHandler() accessor directly (not via
1249+
// the ABORT() macro, so nothing terminates), and verify the message is
1250+
// passed through unchanged.
1251+
node::GetAbortHandler()("some-test-location", "some-test-message");
1252+
EXPECT_TRUE(abort_handler_dispatch_flag);
1253+
EXPECT_STREQ(abort_handler_received_location, "some-test-location");
1254+
EXPECT_STREQ(abort_handler_received_message, "some-test-message");
1255+
1256+
node::SetAbortHandler(old);
1257+
}

0 commit comments

Comments
Β (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Commit b7a2342

Browse files
maxhfisheraduh95
authored andcommitted
src: add SetAbortHandler
Signed-off-by: Max H Fisher <mfisher187@bloomberg.net> PR-URL: #64684 Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
1 parent 4abd1c8 commit b7a2342

7 files changed

Lines changed: 171 additions & 9 deletions

File tree

β€Žsrc/node.hβ€Ž

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -853,6 +853,16 @@ NODE_EXTERN void SetProcessExitHandler(
853853
std::function<void(Environment*, int)>&& handler);
854854
NODE_EXTERNvoidDefaultProcessExitHandler(Environment* env, int exit_code);
855855

856+
// Sets a process-global handler invoked when Node.js programmatically aborts.
857+
// Nullable strings representing the location and reason for the abort may or
858+
// may not be passed as a parameter to the handler. The handler should not
859+
// return, but node will ensure that the process exits after the handler is
860+
// called regardless of whether or not it returns. Passing nullptr restores the
861+
// default handler. This is process-global and may be invoked before any Isolate
862+
// or Environment exists.
863+
using AbortHandler = void (*)(constchar* location, constchar* message);
864+
NODE_EXTERNvoidSetAbortHandler(AbortHandler handler);
865+
856866
// This may return nullptr if context is not associated with a Node instance.
857867
NODE_EXTERN Environment* GetCurrentEnvironment(v8::Local<v8::Context> context);
858868
NODE_EXTERN IsolateData* GetEnvironmentIsolateData(Environment* env);

β€Žsrc/node_errors.ccβ€Ž

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -393,6 +393,30 @@ void AppendExceptionLine(Environment* env,
393393
.FromMaybe(false));
394394
}
395395

396+
namespace {
397+
// Default handler: Dumps native + JS backtraces to stderr and exits. This
398+
// indirectly calls backtrace so it can not be marked as [[noreturn]] (see the
399+
// comment on node::Assert() below). `message` and `location` are ignored
400+
// because the assertion/fatal-error message, if any, is already printed to
401+
// stderr by the caller (Assert()/OnFatalError()) before this handler runs.
402+
voidDefaultAbortHandler(constchar* /*location*/, constchar* /*message*/) {
403+
DumpNativeBacktrace(stderr);
404+
DumpJavaScriptBacktrace(stderr);
405+
fflush(stderr);
406+
ABORT_NO_BACKTRACE();
407+
}
408+
// Constant-initialized, so this is valid from load time, safe even for a
409+
// CHECK() during early startup, before any SetAbortHandler call.
410+
AbortHandler g_abort_handler = DefaultAbortHandler;
411+
} // namespace
412+
413+
voidSetAbortHandler(AbortHandler handler) {
414+
g_abort_handler = handler ? handler : DefaultAbortHandler;
415+
}
416+
AbortHandler GetAbortHandler() {
417+
return g_abort_handler;
418+
}
419+
396420
voidAssert(const AssertionInfo& info) {
397421
std::string name = GetHumanReadableProcessName();
398422

@@ -406,7 +430,7 @@ void Assert(const AssertionInfo& info) {
406430
info.message);
407431

408432
fflush(stderr);
409-
ABORT();
433+
ABORT_WITH_DETAILS(info.file_line, info.message);
410434
}
411435

412436
enumclassEnhanceFatalException { kEnhance, kDontEnhance };
@@ -584,7 +608,7 @@ static void ReportFatalException(Environment* env,
584608
}
585609

586610
fflush(stderr);
587-
ABORT();
611+
ABORT_WITH_DETAILS(location, message);
588612
}
589613

590614
voidOOMErrorHandler(constchar* location, const v8::OOMDetails& details) {
@@ -620,7 +644,7 @@ void OOMErrorHandler(const char* location, const v8::OOMDetails& details) {
620644
}
621645

622646
fflush(stderr);
623-
ABORT();
647+
ABORT_WITH_DETAILS(location, message);
624648
}
625649

626650
v8::ModifyCodeGenerationFromStringsResult ModifyCodeGenerationFromStrings(

β€Žsrc/util.hβ€Ž

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,9 @@ void NODE_EXTERN_PRIVATE Assert(const AssertionInfo& info);
128128
voidDumpNativeBacktrace(FILE* fp);
129129
voidDumpJavaScriptBacktrace(FILE* fp);
130130

131+
// Returns the currently installed abort handler which is never null.
132+
AbortHandler GetAbortHandler();
133+
131134
// Windows 8+ does not like abort() in Release mode
132135
#ifdef _WIN32
133136
#defineABORT_NO_BACKTRACE() _exit(static_cast<int>(node::ExitCode::kAbort))
@@ -140,13 +143,12 @@ void DumpJavaScriptBacktrace(FILE* fp);
140143
// when generating code for them the compiler can choose not to
141144
// maintain the frame pointers or link registers that are necessary for
142145
// correct backtracing.
143-
// `ABORT` must be a macro and not a [[noreturn]] function to make sure the
144-
// backtrace is correct.
145-
#defineABORT() \
146+
// `ABORT` and `ABORT_WITH_DETAILS` must be a macro and not a [[noreturn]]
147+
// function to make sure the backtrace is correct.
148+
#defineABORT() ABORT_WITH_DETAILS(__FILE__ ":"STRINGIFY(__LINE__), nullptr)
149+
#defineABORT_WITH_DETAILS(location, message) \
146150
do { \
147-
node::DumpNativeBacktrace(stderr); \
148-
node::DumpJavaScriptBacktrace(stderr); \
149-
fflush(stderr); \
151+
node::GetAbortHandler()(location, message); \
150152
ABORT_NO_BACKTRACE(); \
151153
} while (0)
152154

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
#include<node.h>
2+
#include<v8.h>
3+
#include<cstdio>
4+
5+
namespace {
6+
voidTestAbortHandler(constchar* /*location*/, constchar* /*message*/) {
7+
fputs("CUSTOM_ABORT_HANDLER_RAN\n", stderr);
8+
fflush(stderr);
9+
}
10+
11+
voidInstallAbortHandler(const v8::FunctionCallbackInfo<v8::Value>&) {
12+
node::SetAbortHandler(TestAbortHandler);
13+
}
14+
} // namespace
15+
16+
NODE_MODULE_INIT() {
17+
NODE_SET_METHOD(exports, "installAbortHandler", InstallAbortHandler);
18+
}
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
'targets': [
3+
{
4+
'target_name': 'binding',
5+
'sources': [ 'binding.cc' ],
6+
'includes': ['../common.gypi'],
7+
}
8+
]
9+
}
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
'use strict';
2+
constcommon=require('../../common');
3+
constassert=require('assert');
4+
constfs=require('fs');
5+
constpath=require('path');
6+
const{ exec }=require('child_process');
7+
8+
constbindingPath=path.resolve(
9+
__dirname,'build',common.buildType,'binding.node');
10+
11+
if(!fs.existsSync(bindingPath))
12+
common.skip('binding not built yet');
13+
14+
if(process.argv[2]==='child'){
15+
constbinding=require(bindingPath);
16+
binding.installAbortHandler();
17+
process.abort();
18+
return;
19+
}
20+
21+
constescapedArgs=
22+
common.escapePOSIXShell`"${process.execPath}" "${__filename}" child`;
23+
if(!common.isWindows){
24+
// Do not create core files, as it can take a lot of disk space on
25+
// continuous testing and developers' machines.
26+
escapedArgs[0]='ulimit -c 0 && '+escapedArgs[0];
27+
}
28+
29+
exec(...escapedArgs,common.mustCall((err,stdout,stderr)=>{
30+
assert.ok(
31+
stderr.includes('CUSTOM_ABORT_HANDLER_RAN'),
32+
`Expected custom abort handler marker in stderr, got:\n${stderr}`);
33+
assert.ok(
34+
!stderr.includes('Native stack trace'),
35+
`Expected the custom handler to replace the default dump, got:\n${stderr}`);
36+
37+
// The child aborts. Whether that surfaces as the SIGABRT signal or as exit
38+
// code 134 depends on shell wrapping: the `ulimit -c 0 && ...` prefix makes
39+
// /bin/sh wait on (rather than exec-replace itself with) the node grandchild,
40+
// so sh reports the aborted grandchild as a normal exit with code 134.
41+
// common.nodeProcessAborted() accepts both forms.
42+
assert.ok(
43+
err&&common.nodeProcessAborted(err.code,err.signal),
44+
`Expected the child to abort, got code=${err?.code} signal=${err?.signal}`);
45+
}));

β€Žtest/cctest/test_environment.ccβ€Ž

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1201,3 +1201,57 @@ TEST_F(EnvironmentTest, LoadEnvironmentWithCallbackWithESModule) {
12011201
printf("Frame: %s\n", *frame_str);
12021202
EXPECT_EQ(frame_str.ToString(), " at embedded:esm.mjs:3:15");
12031203
}
1204+
1205+
namespace {
1206+
voidCustomAbortHandlerForContractTest(constchar* location,
1207+
constchar* message) {}
1208+
1209+
bool abort_handler_dispatch_flag = false;
1210+
constchar* abort_handler_received_location = nullptr;
1211+
constchar* abort_handler_received_message = nullptr;
1212+
voidAbortHandlerThatSetsDispatchFlag(constchar* location,
1213+
constchar* message) {
1214+
abort_handler_dispatch_flag = true;
1215+
abort_handler_received_location = location;
1216+
abort_handler_received_message = message;
1217+
}
1218+
} // namespace
1219+
1220+
TEST(AbortHandlerTest, DefaultIsNonNullAndSetAbortHandlerRoundTrips) {
1221+
node::AbortHandler old = node::GetAbortHandler();
1222+
1223+
// There should always be a non-null default handler installed.
1224+
EXPECT_NE(node::GetAbortHandler(), nullptr);
1225+
1226+
node::SetAbortHandler(CustomAbortHandlerForContractTest);
1227+
EXPECT_EQ(node::GetAbortHandler(), CustomAbortHandlerForContractTest);
1228+
1229+
node::SetAbortHandler(nullptr);
1230+
EXPECT_NE(node::GetAbortHandler(), nullptr);
1231+
EXPECT_NE(node::GetAbortHandler(), CustomAbortHandlerForContractTest);
1232+
1233+
node::SetAbortHandler(old);
1234+
}
1235+
1236+
TEST(AbortHandlerTest, InstalledHandlerIsInvokedWhenCalled) {
1237+
node::AbortHandler old = node::GetAbortHandler();
1238+
abort_handler_dispatch_flag = false;
1239+
abort_handler_received_location = nullptr;
1240+
abort_handler_received_message = nullptr;
1241+
1242+
node::SetAbortHandler(AbortHandlerThatSetsDispatchFlag);
1243+
node::AbortHandler h = node::GetAbortHandler();
1244+
// Fail cleanly (instead of crashing on a null call) if the handler wasn't
1245+
// actually installed.
1246+
ASSERT_NE(h, nullptr);
1247+
1248+
// Dispatch through the public GetAbortHandler() accessor directly (not via
1249+
// the ABORT() macro, so nothing terminates), and verify the message is
1250+
// passed through unchanged.
1251+
node::GetAbortHandler()("some-test-location", "some-test-message");
1252+
EXPECT_TRUE(abort_handler_dispatch_flag);
1253+
EXPECT_STREQ(abort_handler_received_location, "some-test-location");
1254+
EXPECT_STREQ(abort_handler_received_message, "some-test-message");
1255+
1256+
node::SetAbortHandler(old);
1257+
}

0 commit comments

Comments
Β (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Commit b7a2342

Browse files
maxhfisheraduh95
authored andcommitted
src: add SetAbortHandler
Signed-off-by: Max H Fisher <mfisher187@bloomberg.net> PR-URL: #64684 Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
1 parent 4abd1c8 commit b7a2342

7 files changed

Lines changed: 171 additions & 9 deletions

File tree

β€Žsrc/node.hβ€Ž

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -853,6 +853,16 @@ NODE_EXTERN void SetProcessExitHandler(
853853
std::function<void(Environment*, int)>&& handler);
854854
NODE_EXTERNvoidDefaultProcessExitHandler(Environment* env, int exit_code);
855855

856+
// Sets a process-global handler invoked when Node.js programmatically aborts.
857+
// Nullable strings representing the location and reason for the abort may or
858+
// may not be passed as a parameter to the handler. The handler should not
859+
// return, but node will ensure that the process exits after the handler is
860+
// called regardless of whether or not it returns. Passing nullptr restores the
861+
// default handler. This is process-global and may be invoked before any Isolate
862+
// or Environment exists.
863+
using AbortHandler = void (*)(constchar* location, constchar* message);
864+
NODE_EXTERNvoidSetAbortHandler(AbortHandler handler);
865+
856866
// This may return nullptr if context is not associated with a Node instance.
857867
NODE_EXTERN Environment* GetCurrentEnvironment(v8::Local<v8::Context> context);
858868
NODE_EXTERN IsolateData* GetEnvironmentIsolateData(Environment* env);

β€Žsrc/node_errors.ccβ€Ž

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -393,6 +393,30 @@ void AppendExceptionLine(Environment* env,
393393
.FromMaybe(false));
394394
}
395395

396+
namespace {
397+
// Default handler: Dumps native + JS backtraces to stderr and exits. This
398+
// indirectly calls backtrace so it can not be marked as [[noreturn]] (see the
399+
// comment on node::Assert() below). `message` and `location` are ignored
400+
// because the assertion/fatal-error message, if any, is already printed to
401+
// stderr by the caller (Assert()/OnFatalError()) before this handler runs.
402+
voidDefaultAbortHandler(constchar* /*location*/, constchar* /*message*/) {
403+
DumpNativeBacktrace(stderr);
404+
DumpJavaScriptBacktrace(stderr);
405+
fflush(stderr);
406+
ABORT_NO_BACKTRACE();
407+
}
408+
// Constant-initialized, so this is valid from load time, safe even for a
409+
// CHECK() during early startup, before any SetAbortHandler call.
410+
AbortHandler g_abort_handler = DefaultAbortHandler;
411+
} // namespace
412+
413+
voidSetAbortHandler(AbortHandler handler) {
414+
g_abort_handler = handler ? handler : DefaultAbortHandler;
415+
}
416+
AbortHandler GetAbortHandler() {
417+
return g_abort_handler;
418+
}
419+
396420
voidAssert(const AssertionInfo& info) {
397421
std::string name = GetHumanReadableProcessName();
398422

@@ -406,7 +430,7 @@ void Assert(const AssertionInfo& info) {
406430
info.message);
407431

408432
fflush(stderr);
409-
ABORT();
433+
ABORT_WITH_DETAILS(info.file_line, info.message);
410434
}
411435

412436
enumclassEnhanceFatalException { kEnhance, kDontEnhance };
@@ -584,7 +608,7 @@ static void ReportFatalException(Environment* env,
584608
}
585609

586610
fflush(stderr);
587-
ABORT();
611+
ABORT_WITH_DETAILS(location, message);
588612
}
589613

590614
voidOOMErrorHandler(constchar* location, const v8::OOMDetails& details) {
@@ -620,7 +644,7 @@ void OOMErrorHandler(const char* location, const v8::OOMDetails& details) {
620644
}
621645

622646
fflush(stderr);
623-
ABORT();
647+
ABORT_WITH_DETAILS(location, message);
624648
}
625649

626650
v8::ModifyCodeGenerationFromStringsResult ModifyCodeGenerationFromStrings(

β€Žsrc/util.hβ€Ž

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,9 @@ void NODE_EXTERN_PRIVATE Assert(const AssertionInfo& info);
128128
voidDumpNativeBacktrace(FILE* fp);
129129
voidDumpJavaScriptBacktrace(FILE* fp);
130130

131+
// Returns the currently installed abort handler which is never null.
132+
AbortHandler GetAbortHandler();
133+
131134
// Windows 8+ does not like abort() in Release mode
132135
#ifdef _WIN32
133136
#defineABORT_NO_BACKTRACE() _exit(static_cast<int>(node::ExitCode::kAbort))
@@ -140,13 +143,12 @@ void DumpJavaScriptBacktrace(FILE* fp);
140143
// when generating code for them the compiler can choose not to
141144
// maintain the frame pointers or link registers that are necessary for
142145
// correct backtracing.
143-
// `ABORT` must be a macro and not a [[noreturn]] function to make sure the
144-
// backtrace is correct.
145-
#defineABORT() \
146+
// `ABORT` and `ABORT_WITH_DETAILS` must be a macro and not a [[noreturn]]
147+
// function to make sure the backtrace is correct.
148+
#defineABORT() ABORT_WITH_DETAILS(__FILE__ ":"STRINGIFY(__LINE__), nullptr)
149+
#defineABORT_WITH_DETAILS(location, message) \
146150
do { \
147-
node::DumpNativeBacktrace(stderr); \
148-
node::DumpJavaScriptBacktrace(stderr); \
149-
fflush(stderr); \
151+
node::GetAbortHandler()(location, message); \
150152
ABORT_NO_BACKTRACE(); \
151153
} while (0)
152154

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
#include<node.h>
2+
#include<v8.h>
3+
#include<cstdio>
4+
5+
namespace {
6+
voidTestAbortHandler(constchar* /*location*/, constchar* /*message*/) {
7+
fputs("CUSTOM_ABORT_HANDLER_RAN\n", stderr);
8+
fflush(stderr);
9+
}
10+
11+
voidInstallAbortHandler(const v8::FunctionCallbackInfo<v8::Value>&) {
12+
node::SetAbortHandler(TestAbortHandler);
13+
}
14+
} // namespace
15+
16+
NODE_MODULE_INIT() {
17+
NODE_SET_METHOD(exports, "installAbortHandler", InstallAbortHandler);
18+
}
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
'targets': [
3+
{
4+
'target_name': 'binding',
5+
'sources': [ 'binding.cc' ],
6+
'includes': ['../common.gypi'],
7+
}
8+
]
9+
}
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
'use strict';
2+
constcommon=require('../../common');
3+
constassert=require('assert');
4+
constfs=require('fs');
5+
constpath=require('path');
6+
const{ exec }=require('child_process');
7+
8+
constbindingPath=path.resolve(
9+
__dirname,'build',common.buildType,'binding.node');
10+
11+
if(!fs.existsSync(bindingPath))
12+
common.skip('binding not built yet');
13+
14+
if(process.argv[2]==='child'){
15+
constbinding=require(bindingPath);
16+
binding.installAbortHandler();
17+
process.abort();
18+
return;
19+
}
20+
21+
constescapedArgs=
22+
common.escapePOSIXShell`"${process.execPath}" "${__filename}" child`;
23+
if(!common.isWindows){
24+
// Do not create core files, as it can take a lot of disk space on
25+
// continuous testing and developers' machines.
26+
escapedArgs[0]='ulimit -c 0 && '+escapedArgs[0];
27+
}
28+
29+
exec(...escapedArgs,common.mustCall((err,stdout,stderr)=>{
30+
assert.ok(
31+
stderr.includes('CUSTOM_ABORT_HANDLER_RAN'),
32+
`Expected custom abort handler marker in stderr, got:\n${stderr}`);
33+
assert.ok(
34+
!stderr.includes('Native stack trace'),
35+
`Expected the custom handler to replace the default dump, got:\n${stderr}`);
36+
37+
// The child aborts. Whether that surfaces as the SIGABRT signal or as exit
38+
// code 134 depends on shell wrapping: the `ulimit -c 0 && ...` prefix makes
39+
// /bin/sh wait on (rather than exec-replace itself with) the node grandchild,
40+
// so sh reports the aborted grandchild as a normal exit with code 134.
41+
// common.nodeProcessAborted() accepts both forms.
42+
assert.ok(
43+
err&&common.nodeProcessAborted(err.code,err.signal),
44+
`Expected the child to abort, got code=${err?.code} signal=${err?.signal}`);
45+
}));

β€Žtest/cctest/test_environment.ccβ€Ž

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1201,3 +1201,57 @@ TEST_F(EnvironmentTest, LoadEnvironmentWithCallbackWithESModule) {
12011201
printf("Frame: %s\n", *frame_str);
12021202
EXPECT_EQ(frame_str.ToString(), " at embedded:esm.mjs:3:15");
12031203
}
1204+
1205+
namespace {
1206+
voidCustomAbortHandlerForContractTest(constchar* location,
1207+
constchar* message) {}
1208+
1209+
bool abort_handler_dispatch_flag = false;
1210+
constchar* abort_handler_received_location = nullptr;
1211+
constchar* abort_handler_received_message = nullptr;
1212+
voidAbortHandlerThatSetsDispatchFlag(constchar* location,
1213+
constchar* message) {
1214+
abort_handler_dispatch_flag = true;
1215+
abort_handler_received_location = location;
1216+
abort_handler_received_message = message;
1217+
}
1218+
} // namespace
1219+
1220+
TEST(AbortHandlerTest, DefaultIsNonNullAndSetAbortHandlerRoundTrips) {
1221+
node::AbortHandler old = node::GetAbortHandler();
1222+
1223+
// There should always be a non-null default handler installed.
1224+
EXPECT_NE(node::GetAbortHandler(), nullptr);
1225+
1226+
node::SetAbortHandler(CustomAbortHandlerForContractTest);
1227+
EXPECT_EQ(node::GetAbortHandler(), CustomAbortHandlerForContractTest);
1228+
1229+
node::SetAbortHandler(nullptr);
1230+
EXPECT_NE(node::GetAbortHandler(), nullptr);
1231+
EXPECT_NE(node::GetAbortHandler(), CustomAbortHandlerForContractTest);
1232+
1233+
node::SetAbortHandler(old);
1234+
}
1235+
1236+
TEST(AbortHandlerTest, InstalledHandlerIsInvokedWhenCalled) {
1237+
node::AbortHandler old = node::GetAbortHandler();
1238+
abort_handler_dispatch_flag = false;
1239+
abort_handler_received_location = nullptr;
1240+
abort_handler_received_message = nullptr;
1241+
1242+
node::SetAbortHandler(AbortHandlerThatSetsDispatchFlag);
1243+
node::AbortHandler h = node::GetAbortHandler();
1244+
// Fail cleanly (instead of crashing on a null call) if the handler wasn't
1245+
// actually installed.
1246+
ASSERT_NE(h, nullptr);
1247+
1248+
// Dispatch through the public GetAbortHandler() accessor directly (not via
1249+
// the ABORT() macro, so nothing terminates), and verify the message is
1250+
// passed through unchanged.
1251+
node::GetAbortHandler()("some-test-location", "some-test-message");
1252+
EXPECT_TRUE(abort_handler_dispatch_flag);
1253+
EXPECT_STREQ(abort_handler_received_location, "some-test-location");
1254+
EXPECT_STREQ(abort_handler_received_message, "some-test-message");
1255+
1256+
node::SetAbortHandler(old);
1257+
}

0 commit comments

Comments
Β (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Commit b7a2342

Browse files
maxhfisheraduh95
authored andcommitted
src: add SetAbortHandler
Signed-off-by: Max H Fisher <mfisher187@bloomberg.net> PR-URL: #64684 Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
1 parent 4abd1c8 commit b7a2342

7 files changed

Lines changed: 171 additions & 9 deletions

File tree

β€Žsrc/node.hβ€Ž

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -853,6 +853,16 @@ NODE_EXTERN void SetProcessExitHandler(
853853
std::function<void(Environment*, int)>&& handler);
854854
NODE_EXTERNvoidDefaultProcessExitHandler(Environment* env, int exit_code);
855855

856+
// Sets a process-global handler invoked when Node.js programmatically aborts.
857+
// Nullable strings representing the location and reason for the abort may or
858+
// may not be passed as a parameter to the handler. The handler should not
859+
// return, but node will ensure that the process exits after the handler is
860+
// called regardless of whether or not it returns. Passing nullptr restores the
861+
// default handler. This is process-global and may be invoked before any Isolate
862+
// or Environment exists.
863+
using AbortHandler = void (*)(constchar* location, constchar* message);
864+
NODE_EXTERNvoidSetAbortHandler(AbortHandler handler);
865+
856866
// This may return nullptr if context is not associated with a Node instance.
857867
NODE_EXTERN Environment* GetCurrentEnvironment(v8::Local<v8::Context> context);
858868
NODE_EXTERN IsolateData* GetEnvironmentIsolateData(Environment* env);

β€Žsrc/node_errors.ccβ€Ž

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -393,6 +393,30 @@ void AppendExceptionLine(Environment* env,
393393
.FromMaybe(false));
394394
}
395395

396+
namespace {
397+
// Default handler: Dumps native + JS backtraces to stderr and exits. This
398+
// indirectly calls backtrace so it can not be marked as [[noreturn]] (see the
399+
// comment on node::Assert() below). `message` and `location` are ignored
400+
// because the assertion/fatal-error message, if any, is already printed to
401+
// stderr by the caller (Assert()/OnFatalError()) before this handler runs.
402+
voidDefaultAbortHandler(constchar* /*location*/, constchar* /*message*/) {
403+
DumpNativeBacktrace(stderr);
404+
DumpJavaScriptBacktrace(stderr);
405+
fflush(stderr);
406+
ABORT_NO_BACKTRACE();
407+
}
408+
// Constant-initialized, so this is valid from load time, safe even for a
409+
// CHECK() during early startup, before any SetAbortHandler call.
410+
AbortHandler g_abort_handler = DefaultAbortHandler;
411+
} // namespace
412+
413+
voidSetAbortHandler(AbortHandler handler) {
414+
g_abort_handler = handler ? handler : DefaultAbortHandler;
415+
}
416+
AbortHandler GetAbortHandler() {
417+
return g_abort_handler;
418+
}
419+
396420
voidAssert(const AssertionInfo& info) {
397421
std::string name = GetHumanReadableProcessName();
398422

@@ -406,7 +430,7 @@ void Assert(const AssertionInfo& info) {
406430
info.message);
407431

408432
fflush(stderr);
409-
ABORT();
433+
ABORT_WITH_DETAILS(info.file_line, info.message);
410434
}
411435

412436
enumclassEnhanceFatalException { kEnhance, kDontEnhance };
@@ -584,7 +608,7 @@ static void ReportFatalException(Environment* env,
584608
}
585609

586610
fflush(stderr);
587-
ABORT();
611+
ABORT_WITH_DETAILS(location, message);
588612
}
589613

590614
voidOOMErrorHandler(constchar* location, const v8::OOMDetails& details) {
@@ -620,7 +644,7 @@ void OOMErrorHandler(const char* location, const v8::OOMDetails& details) {
620644
}
621645

622646
fflush(stderr);
623-
ABORT();
647+
ABORT_WITH_DETAILS(location, message);
624648
}
625649

626650
v8::ModifyCodeGenerationFromStringsResult ModifyCodeGenerationFromStrings(

β€Žsrc/util.hβ€Ž

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,9 @@ void NODE_EXTERN_PRIVATE Assert(const AssertionInfo& info);
128128
voidDumpNativeBacktrace(FILE* fp);
129129
voidDumpJavaScriptBacktrace(FILE* fp);
130130

131+
// Returns the currently installed abort handler which is never null.
132+
AbortHandler GetAbortHandler();
133+
131134
// Windows 8+ does not like abort() in Release mode
132135
#ifdef _WIN32
133136
#defineABORT_NO_BACKTRACE() _exit(static_cast<int>(node::ExitCode::kAbort))
@@ -140,13 +143,12 @@ void DumpJavaScriptBacktrace(FILE* fp);
140143
// when generating code for them the compiler can choose not to
141144
// maintain the frame pointers or link registers that are necessary for
142145
// correct backtracing.
143-
// `ABORT` must be a macro and not a [[noreturn]] function to make sure the
144-
// backtrace is correct.
145-
#defineABORT() \
146+
// `ABORT` and `ABORT_WITH_DETAILS` must be a macro and not a [[noreturn]]
147+
// function to make sure the backtrace is correct.
148+
#defineABORT() ABORT_WITH_DETAILS(__FILE__ ":"STRINGIFY(__LINE__), nullptr)
149+
#defineABORT_WITH_DETAILS(location, message) \
146150
do { \
147-
node::DumpNativeBacktrace(stderr); \
148-
node::DumpJavaScriptBacktrace(stderr); \
149-
fflush(stderr); \
151+
node::GetAbortHandler()(location, message); \
150152
ABORT_NO_BACKTRACE(); \
151153
} while (0)
152154

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
#include<node.h>
2+
#include<v8.h>
3+
#include<cstdio>
4+
5+
namespace {
6+
voidTestAbortHandler(constchar* /*location*/, constchar* /*message*/) {
7+
fputs("CUSTOM_ABORT_HANDLER_RAN\n", stderr);
8+
fflush(stderr);
9+
}
10+
11+
voidInstallAbortHandler(const v8::FunctionCallbackInfo<v8::Value>&) {
12+
node::SetAbortHandler(TestAbortHandler);
13+
}
14+
} // namespace
15+
16+
NODE_MODULE_INIT() {
17+
NODE_SET_METHOD(exports, "installAbortHandler", InstallAbortHandler);
18+
}
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
'targets': [
3+
{
4+
'target_name': 'binding',
5+
'sources': [ 'binding.cc' ],
6+
'includes': ['../common.gypi'],
7+
}
8+
]
9+
}
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
'use strict';
2+
constcommon=require('../../common');
3+
constassert=require('assert');
4+
constfs=require('fs');
5+
constpath=require('path');
6+
const{ exec }=require('child_process');
7+
8+
constbindingPath=path.resolve(
9+
__dirname,'build',common.buildType,'binding.node');
10+
11+
if(!fs.existsSync(bindingPath))
12+
common.skip('binding not built yet');
13+
14+
if(process.argv[2]==='child'){
15+
constbinding=require(bindingPath);
16+
binding.installAbortHandler();
17+
process.abort();
18+
return;
19+
}
20+
21+
constescapedArgs=
22+
common.escapePOSIXShell`"${process.execPath}" "${__filename}" child`;
23+
if(!common.isWindows){
24+
// Do not create core files, as it can take a lot of disk space on
25+
// continuous testing and developers' machines.
26+
escapedArgs[0]='ulimit -c 0 && '+escapedArgs[0];
27+
}
28+
29+
exec(...escapedArgs,common.mustCall((err,stdout,stderr)=>{
30+
assert.ok(
31+
stderr.includes('CUSTOM_ABORT_HANDLER_RAN'),
32+
`Expected custom abort handler marker in stderr, got:\n${stderr}`);
33+
assert.ok(
34+
!stderr.includes('Native stack trace'),
35+
`Expected the custom handler to replace the default dump, got:\n${stderr}`);
36+
37+
// The child aborts. Whether that surfaces as the SIGABRT signal or as exit
38+
// code 134 depends on shell wrapping: the `ulimit -c 0 && ...` prefix makes
39+
// /bin/sh wait on (rather than exec-replace itself with) the node grandchild,
40+
// so sh reports the aborted grandchild as a normal exit with code 134.
41+
// common.nodeProcessAborted() accepts both forms.
42+
assert.ok(
43+
err&&common.nodeProcessAborted(err.code,err.signal),
44+
`Expected the child to abort, got code=${err?.code} signal=${err?.signal}`);
45+
}));

β€Žtest/cctest/test_environment.ccβ€Ž

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1201,3 +1201,57 @@ TEST_F(EnvironmentTest, LoadEnvironmentWithCallbackWithESModule) {
12011201
printf("Frame: %s\n", *frame_str);
12021202
EXPECT_EQ(frame_str.ToString(), " at embedded:esm.mjs:3:15");
12031203
}
1204+
1205+
namespace {
1206+
voidCustomAbortHandlerForContractTest(constchar* location,
1207+
constchar* message) {}
1208+
1209+
bool abort_handler_dispatch_flag = false;
1210+
constchar* abort_handler_received_location = nullptr;
1211+
constchar* abort_handler_received_message = nullptr;
1212+
voidAbortHandlerThatSetsDispatchFlag(constchar* location,
1213+
constchar* message) {
1214+
abort_handler_dispatch_flag = true;
1215+
abort_handler_received_location = location;
1216+
abort_handler_received_message = message;
1217+
}
1218+
} // namespace
1219+
1220+
TEST(AbortHandlerTest, DefaultIsNonNullAndSetAbortHandlerRoundTrips) {
1221+
node::AbortHandler old = node::GetAbortHandler();
1222+
1223+
// There should always be a non-null default handler installed.
1224+
EXPECT_NE(node::GetAbortHandler(), nullptr);
1225+
1226+
node::SetAbortHandler(CustomAbortHandlerForContractTest);
1227+
EXPECT_EQ(node::GetAbortHandler(), CustomAbortHandlerForContractTest);
1228+
1229+
node::SetAbortHandler(nullptr);
1230+
EXPECT_NE(node::GetAbortHandler(), nullptr);
1231+
EXPECT_NE(node::GetAbortHandler(), CustomAbortHandlerForContractTest);
1232+
1233+
node::SetAbortHandler(old);
1234+
}
1235+
1236+
TEST(AbortHandlerTest, InstalledHandlerIsInvokedWhenCalled) {
1237+
node::AbortHandler old = node::GetAbortHandler();
1238+
abort_handler_dispatch_flag = false;
1239+
abort_handler_received_location = nullptr;
1240+
abort_handler_received_message = nullptr;
1241+
1242+
node::SetAbortHandler(AbortHandlerThatSetsDispatchFlag);
1243+
node::AbortHandler h = node::GetAbortHandler();
1244+
// Fail cleanly (instead of crashing on a null call) if the handler wasn't
1245+
// actually installed.
1246+
ASSERT_NE(h, nullptr);
1247+
1248+
// Dispatch through the public GetAbortHandler() accessor directly (not via
1249+
// the ABORT() macro, so nothing terminates), and verify the message is
1250+
// passed through unchanged.
1251+
node::GetAbortHandler()("some-test-location", "some-test-message");
1252+
EXPECT_TRUE(abort_handler_dispatch_flag);
1253+
EXPECT_STREQ(abort_handler_received_location, "some-test-location");
1254+
EXPECT_STREQ(abort_handler_received_message, "some-test-message");
1255+
1256+
node::SetAbortHandler(old);
1257+
}

0 commit comments

Comments
Β (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Commit b7a2342

Browse files
maxhfisheraduh95
authored andcommitted
src: add SetAbortHandler
Signed-off-by: Max H Fisher <mfisher187@bloomberg.net> PR-URL: #64684 Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
1 parent 4abd1c8 commit b7a2342

7 files changed

Lines changed: 171 additions & 9 deletions

File tree

β€Žsrc/node.hβ€Ž

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -853,6 +853,16 @@ NODE_EXTERN void SetProcessExitHandler(
853853
std::function<void(Environment*, int)>&& handler);
854854
NODE_EXTERNvoidDefaultProcessExitHandler(Environment* env, int exit_code);
855855

856+
// Sets a process-global handler invoked when Node.js programmatically aborts.
857+
// Nullable strings representing the location and reason for the abort may or
858+
// may not be passed as a parameter to the handler. The handler should not
859+
// return, but node will ensure that the process exits after the handler is
860+
// called regardless of whether or not it returns. Passing nullptr restores the
861+
// default handler. This is process-global and may be invoked before any Isolate
862+
// or Environment exists.
863+
using AbortHandler = void (*)(constchar* location, constchar* message);
864+
NODE_EXTERNvoidSetAbortHandler(AbortHandler handler);
865+
856866
// This may return nullptr if context is not associated with a Node instance.
857867
NODE_EXTERN Environment* GetCurrentEnvironment(v8::Local<v8::Context> context);
858868
NODE_EXTERN IsolateData* GetEnvironmentIsolateData(Environment* env);

β€Žsrc/node_errors.ccβ€Ž

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -393,6 +393,30 @@ void AppendExceptionLine(Environment* env,
393393
.FromMaybe(false));
394394
}
395395

396+
namespace {
397+
// Default handler: Dumps native + JS backtraces to stderr and exits. This
398+
// indirectly calls backtrace so it can not be marked as [[noreturn]] (see the
399+
// comment on node::Assert() below). `message` and `location` are ignored
400+
// because the assertion/fatal-error message, if any, is already printed to
401+
// stderr by the caller (Assert()/OnFatalError()) before this handler runs.
402+
voidDefaultAbortHandler(constchar* /*location*/, constchar* /*message*/) {
403+
DumpNativeBacktrace(stderr);
404+
DumpJavaScriptBacktrace(stderr);
405+
fflush(stderr);
406+
ABORT_NO_BACKTRACE();
407+
}
408+
// Constant-initialized, so this is valid from load time, safe even for a
409+
// CHECK() during early startup, before any SetAbortHandler call.
410+
AbortHandler g_abort_handler = DefaultAbortHandler;
411+
} // namespace
412+
413+
voidSetAbortHandler(AbortHandler handler) {
414+
g_abort_handler = handler ? handler : DefaultAbortHandler;
415+
}
416+
AbortHandler GetAbortHandler() {
417+
return g_abort_handler;
418+
}
419+
396420
voidAssert(const AssertionInfo& info) {
397421
std::string name = GetHumanReadableProcessName();
398422

@@ -406,7 +430,7 @@ void Assert(const AssertionInfo& info) {
406430
info.message);
407431

408432
fflush(stderr);
409-
ABORT();
433+
ABORT_WITH_DETAILS(info.file_line, info.message);
410434
}
411435

412436
enumclassEnhanceFatalException { kEnhance, kDontEnhance };
@@ -584,7 +608,7 @@ static void ReportFatalException(Environment* env,
584608
}
585609

586610
fflush(stderr);
587-
ABORT();
611+
ABORT_WITH_DETAILS(location, message);
588612
}
589613

590614
voidOOMErrorHandler(constchar* location, const v8::OOMDetails& details) {
@@ -620,7 +644,7 @@ void OOMErrorHandler(const char* location, const v8::OOMDetails& details) {
620644
}
621645

622646
fflush(stderr);
623-
ABORT();
647+
ABORT_WITH_DETAILS(location, message);
624648
}
625649

626650
v8::ModifyCodeGenerationFromStringsResult ModifyCodeGenerationFromStrings(

β€Žsrc/util.hβ€Ž

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,9 @@ void NODE_EXTERN_PRIVATE Assert(const AssertionInfo& info);
128128
voidDumpNativeBacktrace(FILE* fp);
129129
voidDumpJavaScriptBacktrace(FILE* fp);
130130

131+
// Returns the currently installed abort handler which is never null.
132+
AbortHandler GetAbortHandler();
133+
131134
// Windows 8+ does not like abort() in Release mode
132135
#ifdef _WIN32
133136
#defineABORT_NO_BACKTRACE() _exit(static_cast<int>(node::ExitCode::kAbort))
@@ -140,13 +143,12 @@ void DumpJavaScriptBacktrace(FILE* fp);
140143
// when generating code for them the compiler can choose not to
141144
// maintain the frame pointers or link registers that are necessary for
142145
// correct backtracing.
143-
// `ABORT` must be a macro and not a [[noreturn]] function to make sure the
144-
// backtrace is correct.
145-
#defineABORT() \
146+
// `ABORT` and `ABORT_WITH_DETAILS` must be a macro and not a [[noreturn]]
147+
// function to make sure the backtrace is correct.
148+
#defineABORT() ABORT_WITH_DETAILS(__FILE__ ":"STRINGIFY(__LINE__), nullptr)
149+
#defineABORT_WITH_DETAILS(location, message) \
146150
do { \
147-
node::DumpNativeBacktrace(stderr); \
148-
node::DumpJavaScriptBacktrace(stderr); \
149-
fflush(stderr); \
151+
node::GetAbortHandler()(location, message); \
150152
ABORT_NO_BACKTRACE(); \
151153
} while (0)
152154

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
#include<node.h>
2+
#include<v8.h>
3+
#include<cstdio>
4+
5+
namespace {
6+
voidTestAbortHandler(constchar* /*location*/, constchar* /*message*/) {
7+
fputs("CUSTOM_ABORT_HANDLER_RAN\n", stderr);
8+
fflush(stderr);
9+
}
10+
11+
voidInstallAbortHandler(const v8::FunctionCallbackInfo<v8::Value>&) {
12+
node::SetAbortHandler(TestAbortHandler);
13+
}
14+
} // namespace
15+
16+
NODE_MODULE_INIT() {
17+
NODE_SET_METHOD(exports, "installAbortHandler", InstallAbortHandler);
18+
}
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
'targets': [
3+
{
4+
'target_name': 'binding',
5+
'sources': [ 'binding.cc' ],
6+
'includes': ['../common.gypi'],
7+
}
8+
]
9+
}
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
'use strict';
2+
constcommon=require('../../common');
3+
constassert=require('assert');
4+
constfs=require('fs');
5+
constpath=require('path');
6+
const{ exec }=require('child_process');
7+
8+
constbindingPath=path.resolve(
9+
__dirname,'build',common.buildType,'binding.node');
10+
11+
if(!fs.existsSync(bindingPath))
12+
common.skip('binding not built yet');
13+
14+
if(process.argv[2]==='child'){
15+
constbinding=require(bindingPath);
16+
binding.installAbortHandler();
17+
process.abort();
18+
return;
19+
}
20+
21+
constescapedArgs=
22+
common.escapePOSIXShell`"${process.execPath}" "${__filename}" child`;
23+
if(!common.isWindows){
24+
// Do not create core files, as it can take a lot of disk space on
25+
// continuous testing and developers' machines.
26+
escapedArgs[0]='ulimit -c 0 && '+escapedArgs[0];
27+
}
28+
29+
exec(...escapedArgs,common.mustCall((err,stdout,stderr)=>{
30+
assert.ok(
31+
stderr.includes('CUSTOM_ABORT_HANDLER_RAN'),
32+
`Expected custom abort handler marker in stderr, got:\n${stderr}`);
33+
assert.ok(
34+
!stderr.includes('Native stack trace'),
35+
`Expected the custom handler to replace the default dump, got:\n${stderr}`);
36+
37+
// The child aborts. Whether that surfaces as the SIGABRT signal or as exit
38+
// code 134 depends on shell wrapping: the `ulimit -c 0 && ...` prefix makes
39+
// /bin/sh wait on (rather than exec-replace itself with) the node grandchild,
40+
// so sh reports the aborted grandchild as a normal exit with code 134.
41+
// common.nodeProcessAborted() accepts both forms.
42+
assert.ok(
43+
err&&common.nodeProcessAborted(err.code,err.signal),
44+
`Expected the child to abort, got code=${err?.code} signal=${err?.signal}`);
45+
}));

β€Žtest/cctest/test_environment.ccβ€Ž

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1201,3 +1201,57 @@ TEST_F(EnvironmentTest, LoadEnvironmentWithCallbackWithESModule) {
12011201
printf("Frame: %s\n", *frame_str);
12021202
EXPECT_EQ(frame_str.ToString(), " at embedded:esm.mjs:3:15");
12031203
}
1204+
1205+
namespace {
1206+
voidCustomAbortHandlerForContractTest(constchar* location,
1207+
constchar* message) {}
1208+
1209+
bool abort_handler_dispatch_flag = false;
1210+
constchar* abort_handler_received_location = nullptr;
1211+
constchar* abort_handler_received_message = nullptr;
1212+
voidAbortHandlerThatSetsDispatchFlag(constchar* location,
1213+
constchar* message) {
1214+
abort_handler_dispatch_flag = true;
1215+
abort_handler_received_location = location;
1216+
abort_handler_received_message = message;
1217+
}
1218+
} // namespace
1219+
1220+
TEST(AbortHandlerTest, DefaultIsNonNullAndSetAbortHandlerRoundTrips) {
1221+
node::AbortHandler old = node::GetAbortHandler();
1222+
1223+
// There should always be a non-null default handler installed.
1224+
EXPECT_NE(node::GetAbortHandler(), nullptr);
1225+
1226+
node::SetAbortHandler(CustomAbortHandlerForContractTest);
1227+
EXPECT_EQ(node::GetAbortHandler(), CustomAbortHandlerForContractTest);
1228+
1229+
node::SetAbortHandler(nullptr);
1230+
EXPECT_NE(node::GetAbortHandler(), nullptr);
1231+
EXPECT_NE(node::GetAbortHandler(), CustomAbortHandlerForContractTest);
1232+
1233+
node::SetAbortHandler(old);
1234+
}
1235+
1236+
TEST(AbortHandlerTest, InstalledHandlerIsInvokedWhenCalled) {
1237+
node::AbortHandler old = node::GetAbortHandler();
1238+
abort_handler_dispatch_flag = false;
1239+
abort_handler_received_location = nullptr;
1240+
abort_handler_received_message = nullptr;
1241+
1242+
node::SetAbortHandler(AbortHandlerThatSetsDispatchFlag);
1243+
node::AbortHandler h = node::GetAbortHandler();
1244+
// Fail cleanly (instead of crashing on a null call) if the handler wasn't
1245+
// actually installed.
1246+
ASSERT_NE(h, nullptr);
1247+
1248+
// Dispatch through the public GetAbortHandler() accessor directly (not via
1249+
// the ABORT() macro, so nothing terminates), and verify the message is
1250+
// passed through unchanged.
1251+
node::GetAbortHandler()("some-test-location", "some-test-message");
1252+
EXPECT_TRUE(abort_handler_dispatch_flag);
1253+
EXPECT_STREQ(abort_handler_received_location, "some-test-location");
1254+
EXPECT_STREQ(abort_handler_received_message, "some-test-message");
1255+
1256+
node::SetAbortHandler(old);
1257+
}

0 commit comments

Comments
Β (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Commit b7a2342

Browse files
maxhfisheraduh95
authored andcommitted
src: add SetAbortHandler
Signed-off-by: Max H Fisher <mfisher187@bloomberg.net> PR-URL: #64684 Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
1 parent 4abd1c8 commit b7a2342

7 files changed

Lines changed: 171 additions & 9 deletions

File tree

β€Žsrc/node.hβ€Ž

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -853,6 +853,16 @@ NODE_EXTERN void SetProcessExitHandler(
853853
std::function<void(Environment*, int)>&& handler);
854854
NODE_EXTERNvoidDefaultProcessExitHandler(Environment* env, int exit_code);
855855

856+
// Sets a process-global handler invoked when Node.js programmatically aborts.
857+
// Nullable strings representing the location and reason for the abort may or
858+
// may not be passed as a parameter to the handler. The handler should not
859+
// return, but node will ensure that the process exits after the handler is
860+
// called regardless of whether or not it returns. Passing nullptr restores the
861+
// default handler. This is process-global and may be invoked before any Isolate
862+
// or Environment exists.
863+
using AbortHandler = void (*)(constchar* location, constchar* message);
864+
NODE_EXTERNvoidSetAbortHandler(AbortHandler handler);
865+
856866
// This may return nullptr if context is not associated with a Node instance.
857867
NODE_EXTERN Environment* GetCurrentEnvironment(v8::Local<v8::Context> context);
858868
NODE_EXTERN IsolateData* GetEnvironmentIsolateData(Environment* env);

β€Žsrc/node_errors.ccβ€Ž

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -393,6 +393,30 @@ void AppendExceptionLine(Environment* env,
393393
.FromMaybe(false));
394394
}
395395

396+
namespace {
397+
// Default handler: Dumps native + JS backtraces to stderr and exits. This
398+
// indirectly calls backtrace so it can not be marked as [[noreturn]] (see the
399+
// comment on node::Assert() below). `message` and `location` are ignored
400+
// because the assertion/fatal-error message, if any, is already printed to
401+
// stderr by the caller (Assert()/OnFatalError()) before this handler runs.
402+
voidDefaultAbortHandler(constchar* /*location*/, constchar* /*message*/) {
403+
DumpNativeBacktrace(stderr);
404+
DumpJavaScriptBacktrace(stderr);
405+
fflush(stderr);
406+
ABORT_NO_BACKTRACE();
407+
}
408+
// Constant-initialized, so this is valid from load time, safe even for a
409+
// CHECK() during early startup, before any SetAbortHandler call.
410+
AbortHandler g_abort_handler = DefaultAbortHandler;
411+
} // namespace
412+
413+
voidSetAbortHandler(AbortHandler handler) {
414+
g_abort_handler = handler ? handler : DefaultAbortHandler;
415+
}
416+
AbortHandler GetAbortHandler() {
417+
return g_abort_handler;
418+
}
419+
396420
voidAssert(const AssertionInfo& info) {
397421
std::string name = GetHumanReadableProcessName();
398422

@@ -406,7 +430,7 @@ void Assert(const AssertionInfo& info) {
406430
info.message);
407431

408432
fflush(stderr);
409-
ABORT();
433+
ABORT_WITH_DETAILS(info.file_line, info.message);
410434
}
411435

412436
enumclassEnhanceFatalException { kEnhance, kDontEnhance };
@@ -584,7 +608,7 @@ static void ReportFatalException(Environment* env,
584608
}
585609

586610
fflush(stderr);
587-
ABORT();
611+
ABORT_WITH_DETAILS(location, message);
588612
}
589613

590614
voidOOMErrorHandler(constchar* location, const v8::OOMDetails& details) {
@@ -620,7 +644,7 @@ void OOMErrorHandler(const char* location, const v8::OOMDetails& details) {
620644
}
621645

622646
fflush(stderr);
623-
ABORT();
647+
ABORT_WITH_DETAILS(location, message);
624648
}
625649

626650
v8::ModifyCodeGenerationFromStringsResult ModifyCodeGenerationFromStrings(

β€Žsrc/util.hβ€Ž

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,9 @@ void NODE_EXTERN_PRIVATE Assert(const AssertionInfo& info);
128128
voidDumpNativeBacktrace(FILE* fp);
129129
voidDumpJavaScriptBacktrace(FILE* fp);
130130

131+
// Returns the currently installed abort handler which is never null.
132+
AbortHandler GetAbortHandler();
133+
131134
// Windows 8+ does not like abort() in Release mode
132135
#ifdef _WIN32
133136
#defineABORT_NO_BACKTRACE() _exit(static_cast<int>(node::ExitCode::kAbort))
@@ -140,13 +143,12 @@ void DumpJavaScriptBacktrace(FILE* fp);
140143
// when generating code for them the compiler can choose not to
141144
// maintain the frame pointers or link registers that are necessary for
142145
// correct backtracing.
143-
// `ABORT` must be a macro and not a [[noreturn]] function to make sure the
144-
// backtrace is correct.
145-
#defineABORT() \
146+
// `ABORT` and `ABORT_WITH_DETAILS` must be a macro and not a [[noreturn]]
147+
// function to make sure the backtrace is correct.
148+
#defineABORT() ABORT_WITH_DETAILS(__FILE__ ":"STRINGIFY(__LINE__), nullptr)
149+
#defineABORT_WITH_DETAILS(location, message) \
146150
do { \
147-
node::DumpNativeBacktrace(stderr); \
148-
node::DumpJavaScriptBacktrace(stderr); \
149-
fflush(stderr); \
151+
node::GetAbortHandler()(location, message); \
150152
ABORT_NO_BACKTRACE(); \
151153
} while (0)
152154

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
#include<node.h>
2+
#include<v8.h>
3+
#include<cstdio>
4+
5+
namespace {
6+
voidTestAbortHandler(constchar* /*location*/, constchar* /*message*/) {
7+
fputs("CUSTOM_ABORT_HANDLER_RAN\n", stderr);
8+
fflush(stderr);
9+
}
10+
11+
voidInstallAbortHandler(const v8::FunctionCallbackInfo<v8::Value>&) {
12+
node::SetAbortHandler(TestAbortHandler);
13+
}
14+
} // namespace
15+
16+
NODE_MODULE_INIT() {
17+
NODE_SET_METHOD(exports, "installAbortHandler", InstallAbortHandler);
18+
}
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
'targets': [
3+
{
4+
'target_name': 'binding',
5+
'sources': [ 'binding.cc' ],
6+
'includes': ['../common.gypi'],
7+
}
8+
]
9+
}
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
'use strict';
2+
constcommon=require('../../common');
3+
constassert=require('assert');
4+
constfs=require('fs');
5+
constpath=require('path');
6+
const{ exec }=require('child_process');
7+
8+
constbindingPath=path.resolve(
9+
__dirname,'build',common.buildType,'binding.node');
10+
11+
if(!fs.existsSync(bindingPath))
12+
common.skip('binding not built yet');
13+
14+
if(process.argv[2]==='child'){
15+
constbinding=require(bindingPath);
16+
binding.installAbortHandler();
17+
process.abort();
18+
return;
19+
}
20+
21+
constescapedArgs=
22+
common.escapePOSIXShell`"${process.execPath}" "${__filename}" child`;
23+
if(!common.isWindows){
24+
// Do not create core files, as it can take a lot of disk space on
25+
// continuous testing and developers' machines.
26+
escapedArgs[0]='ulimit -c 0 && '+escapedArgs[0];
27+
}
28+
29+
exec(...escapedArgs,common.mustCall((err,stdout,stderr)=>{
30+
assert.ok(
31+
stderr.includes('CUSTOM_ABORT_HANDLER_RAN'),
32+
`Expected custom abort handler marker in stderr, got:\n${stderr}`);
33+
assert.ok(
34+
!stderr.includes('Native stack trace'),
35+
`Expected the custom handler to replace the default dump, got:\n${stderr}`);
36+
37+
// The child aborts. Whether that surfaces as the SIGABRT signal or as exit
38+
// code 134 depends on shell wrapping: the `ulimit -c 0 && ...` prefix makes
39+
// /bin/sh wait on (rather than exec-replace itself with) the node grandchild,
40+
// so sh reports the aborted grandchild as a normal exit with code 134.
41+
// common.nodeProcessAborted() accepts both forms.
42+
assert.ok(
43+
err&&common.nodeProcessAborted(err.code,err.signal),
44+
`Expected the child to abort, got code=${err?.code} signal=${err?.signal}`);
45+
}));

β€Žtest/cctest/test_environment.ccβ€Ž

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1201,3 +1201,57 @@ TEST_F(EnvironmentTest, LoadEnvironmentWithCallbackWithESModule) {
12011201
printf("Frame: %s\n", *frame_str);
12021202
EXPECT_EQ(frame_str.ToString(), " at embedded:esm.mjs:3:15");
12031203
}
1204+
1205+
namespace {
1206+
voidCustomAbortHandlerForContractTest(constchar* location,
1207+
constchar* message) {}
1208+
1209+
bool abort_handler_dispatch_flag = false;
1210+
constchar* abort_handler_received_location = nullptr;
1211+
constchar* abort_handler_received_message = nullptr;
1212+
voidAbortHandlerThatSetsDispatchFlag(constchar* location,
1213+
constchar* message) {
1214+
abort_handler_dispatch_flag = true;
1215+
abort_handler_received_location = location;
1216+
abort_handler_received_message = message;
1217+
}
1218+
} // namespace
1219+
1220+
TEST(AbortHandlerTest, DefaultIsNonNullAndSetAbortHandlerRoundTrips) {
1221+
node::AbortHandler old = node::GetAbortHandler();
1222+
1223+
// There should always be a non-null default handler installed.
1224+
EXPECT_NE(node::GetAbortHandler(), nullptr);
1225+
1226+
node::SetAbortHandler(CustomAbortHandlerForContractTest);
1227+
EXPECT_EQ(node::GetAbortHandler(), CustomAbortHandlerForContractTest);
1228+
1229+
node::SetAbortHandler(nullptr);
1230+
EXPECT_NE(node::GetAbortHandler(), nullptr);
1231+
EXPECT_NE(node::GetAbortHandler(), CustomAbortHandlerForContractTest);
1232+
1233+
node::SetAbortHandler(old);
1234+
}
1235+
1236+
TEST(AbortHandlerTest, InstalledHandlerIsInvokedWhenCalled) {
1237+
node::AbortHandler old = node::GetAbortHandler();
1238+
abort_handler_dispatch_flag = false;
1239+
abort_handler_received_location = nullptr;
1240+
abort_handler_received_message = nullptr;
1241+
1242+
node::SetAbortHandler(AbortHandlerThatSetsDispatchFlag);
1243+
node::AbortHandler h = node::GetAbortHandler();
1244+
// Fail cleanly (instead of crashing on a null call) if the handler wasn't
1245+
// actually installed.
1246+
ASSERT_NE(h, nullptr);
1247+
1248+
// Dispatch through the public GetAbortHandler() accessor directly (not via
1249+
// the ABORT() macro, so nothing terminates), and verify the message is
1250+
// passed through unchanged.
1251+
node::GetAbortHandler()("some-test-location", "some-test-message");
1252+
EXPECT_TRUE(abort_handler_dispatch_flag);
1253+
EXPECT_STREQ(abort_handler_received_location, "some-test-location");
1254+
EXPECT_STREQ(abort_handler_received_message, "some-test-message");
1255+
1256+
node::SetAbortHandler(old);
1257+
}

0 commit comments

Comments
Β (0)