Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions src/node.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -844,6 +844,16 @@ NODE_EXTERN void SetProcessExitHandler(
std::function<void(Environment*, int)>&& handler);
NODE_EXTERN void DefaultProcessExitHandler(Environment* env, int exit_code);

// Sets a process-global handler invoked when Node.js programmatically aborts.
// Nullable strings representing the location and reason for the abort may or
// may not be passed as a parameter to the handler. The handler should not
// return, but node will ensure that the process exits after the handler is
// called regardless of whether or not it returns. Passing nullptr restores the
// default handler. This is process-global and may be invoked before any Isolate
// or Environment exists.
using AbortHandler = void (*)(const char* location, const char* message);
NODE_EXTERN void SetAbortHandler(AbortHandler handler);

// This may return nullptr if context is not associated with a Node instance.
NODE_EXTERN Environment* GetCurrentEnvironment(v8::Local<v8::Context> context);
NODE_EXTERN IsolateData* GetEnvironmentIsolateData(Environment* env);
Expand Down
30 changes: 27 additions & 3 deletions src/node_errors.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -393,6 +393,30 @@ void AppendExceptionLine(Environment* env,
.FromMaybe(false));
}

namespace {
// Default handler: Dumps native + JS backtraces to stderr and exits. This
// indirectly calls backtrace so it can not be marked as [[noreturn]] (see the
// comment on node::Assert() below). `message` and `location` are ignored
// because the assertion/fatal-error message, if any, is already printed to
// stderr by the caller (Assert()/OnFatalError()) before this handler runs.
void DefaultAbortHandler(const char* /*location*/, const char* /*message*/) {
DumpNativeBacktrace(stderr);
DumpJavaScriptBacktrace(stderr);
fflush(stderr);
ABORT_NO_BACKTRACE();
}
// Constant-initialized, so this is valid from load time, safe even for a
// CHECK() during early startup, before any SetAbortHandler call.
AbortHandler g_abort_handler = DefaultAbortHandler;
} // namespace

void SetAbortHandler(AbortHandler handler) {
g_abort_handler = handler ? handler : DefaultAbortHandler;
}
AbortHandler GetAbortHandler() {
return g_abort_handler;
}

void Assert(const AssertionInfo& info) {
std::string name = GetHumanReadableProcessName();

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

fflush(stderr);
ABORT();
ABORT_WITH_DETAILS(info.file_line, info.message);
}

enum class EnhanceFatalException { kEnhance, kDontEnhance };
Expand DownExpand Up@@ -584,7 +608,7 @@ static void ReportFatalException(Environment* env,
}

fflush(stderr);
ABORT();
ABORT_WITH_DETAILS(location, message);
}

void OOMErrorHandler(const char* location, const v8::OOMDetails& details) {
Expand DownExpand Up@@ -620,7 +644,7 @@ void OOMErrorHandler(const char* location, const v8::OOMDetails& details) {
}

fflush(stderr);
ABORT();
ABORT_WITH_DETAILS(location, message);
}

v8::ModifyCodeGenerationFromStringsResult ModifyCodeGenerationFromStrings(
Expand Down
14 changes: 8 additions & 6 deletions src/util.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -126,6 +126,9 @@ void NODE_EXTERN_PRIVATE Assert(const AssertionInfo& info);
void DumpNativeBacktrace(FILE* fp);
void DumpJavaScriptBacktrace(FILE* fp);

// Returns the currently installed abort handler which is never null.
AbortHandler GetAbortHandler();

// Windows 8+ does not like abort() in Release mode
#ifdef _WIN32
#define ABORT_NO_BACKTRACE() _exit(static_cast<int>(node::ExitCode::kAbort))
Expand All@@ -138,13 +141,12 @@ void DumpJavaScriptBacktrace(FILE* fp);
// when generating code for them the compiler can choose not to
// maintain the frame pointers or link registers that are necessary for
// correct backtracing.
// `ABORT` must be a macro and not a [[noreturn]] function to make sure the
// backtrace is correct.
#define ABORT() \
// `ABORT` and `ABORT_WITH_DETAILS` must be a macro and not a [[noreturn]]
// function to make sure the backtrace is correct.
#define ABORT() ABORT_WITH_DETAILS(__FILE__ ":" STRINGIFY(__LINE__), nullptr)
Comment thread
legendecas marked this conversation as resolved.
#define ABORT_WITH_DETAILS(location, message) \
do { \
node::DumpNativeBacktrace(stderr); \
node::DumpJavaScriptBacktrace(stderr); \
fflush(stderr); \
node::GetAbortHandler()(location, message); \
ABORT_NO_BACKTRACE(); \
} while (0)

Expand Down
18 changes: 18 additions & 0 deletions test/addons/abort-handler/binding.cc
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
#include <node.h>
#include <v8.h>
#include <cstdio>

namespace {
void TestAbortHandler(const char* /*location*/, const char* /*message*/) {
fputs("CUSTOM_ABORT_HANDLER_RAN\n", stderr);
fflush(stderr);
}

void InstallAbortHandler(const v8::FunctionCallbackInfo<v8::Value>&) {
node::SetAbortHandler(TestAbortHandler);
}
} // namespace

NODE_MODULE_INIT() {
NODE_SET_METHOD(exports, "installAbortHandler", InstallAbortHandler);
}
9 changes: 9 additions & 0 deletions test/addons/abort-handler/binding.gyp
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
{
'targets': [
{
'target_name': 'binding',
'sources': [ 'binding.cc' ],
'includes': ['../common.gypi'],
}
]
}
45 changes: 45 additions & 0 deletions test/addons/abort-handler/test.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
'use strict';
const common = require('../../common');
const assert = require('assert');
const fs = require('fs');
const path = require('path');
const { exec } = require('child_process');

const bindingPath = path.resolve(
__dirname, 'build', common.buildType, 'binding.node');

if (!fs.existsSync(bindingPath))
common.skip('binding not built yet');

if (process.argv[2] === 'child') {
const binding = require(bindingPath);
binding.installAbortHandler();
process.abort();
return;
}

const escapedArgs =
common.escapePOSIXShell`"${process.execPath}" "${__filename}" child`;
if (!common.isWindows) {
// Do not create core files, as it can take a lot of disk space on
// continuous testing and developers' machines.
escapedArgs[0] = 'ulimit -c 0 && ' + escapedArgs[0];
}

exec(...escapedArgs, common.mustCall((err, stdout, stderr) => {
assert.ok(
stderr.includes('CUSTOM_ABORT_HANDLER_RAN'),
`Expected custom abort handler marker in stderr, got:\n${stderr}`);
assert.ok(
!stderr.includes('Native stack trace'),
`Expected the custom handler to replace the default dump, got:\n${stderr}`);

// The child aborts. Whether that surfaces as the SIGABRT signal or as exit
// code 134 depends on shell wrapping: the `ulimit -c 0 && ...` prefix makes
// /bin/sh wait on (rather than exec-replace itself with) the node grandchild,
// so sh reports the aborted grandchild as a normal exit with code 134.
// common.nodeProcessAborted() accepts both forms.
assert.ok(
err && common.nodeProcessAborted(err.code, err.signal),
`Expected the child to abort, got code=${err?.code} signal=${err?.signal}`);
}));
54 changes: 54 additions & 0 deletions test/cctest/test_environment.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -1201,3 +1201,57 @@ TEST_F(EnvironmentTest, LoadEnvironmentWithCallbackWithESModule) {
printf("Frame: %s\n", *frame_str);
EXPECT_EQ(frame_str.ToString(), " at embedded:esm.mjs:3:15");
}

namespace {
void CustomAbortHandlerForContractTest(const char* location,
const char* message) {}

bool abort_handler_dispatch_flag = false;
const char* abort_handler_received_location = nullptr;
const char* abort_handler_received_message = nullptr;
void AbortHandlerThatSetsDispatchFlag(const char* location,
const char* message) {
abort_handler_dispatch_flag = true;
abort_handler_received_location = location;
abort_handler_received_message = message;
}
} // namespace

TEST(AbortHandlerTest, DefaultIsNonNullAndSetAbortHandlerRoundTrips) {
node::AbortHandler old = node::GetAbortHandler();

// There should always be a non-null default handler installed.
EXPECT_NE(node::GetAbortHandler(), nullptr);

node::SetAbortHandler(CustomAbortHandlerForContractTest);
EXPECT_EQ(node::GetAbortHandler(), CustomAbortHandlerForContractTest);

node::SetAbortHandler(nullptr);
EXPECT_NE(node::GetAbortHandler(), nullptr);
EXPECT_NE(node::GetAbortHandler(), CustomAbortHandlerForContractTest);

node::SetAbortHandler(old);
}

TEST(AbortHandlerTest, InstalledHandlerIsInvokedWhenCalled) {
node::AbortHandler old = node::GetAbortHandler();
abort_handler_dispatch_flag = false;
abort_handler_received_location = nullptr;
abort_handler_received_message = nullptr;

node::SetAbortHandler(AbortHandlerThatSetsDispatchFlag);
node::AbortHandler h = node::GetAbortHandler();
// Fail cleanly (instead of crashing on a null call) if the handler wasn't
// actually installed.
ASSERT_NE(h, nullptr);

// Dispatch through the public GetAbortHandler() accessor directly (not via
// the ABORT() macro, so nothing terminates), and verify the message is
// passed through unchanged.
node::GetAbortHandler()("some-test-location", "some-test-message");
EXPECT_TRUE(abort_handler_dispatch_flag);
EXPECT_STREQ(abort_handler_received_location, "some-test-location");
EXPECT_STREQ(abort_handler_received_message, "some-test-message");

node::SetAbortHandler(old);
}
, '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
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions src/node.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -844,6 +844,16 @@ NODE_EXTERN void SetProcessExitHandler(
std::function<void(Environment*, int)>&& handler);
NODE_EXTERN void DefaultProcessExitHandler(Environment* env, int exit_code);

// Sets a process-global handler invoked when Node.js programmatically aborts.
// Nullable strings representing the location and reason for the abort may or
// may not be passed as a parameter to the handler. The handler should not
// return, but node will ensure that the process exits after the handler is
// called regardless of whether or not it returns. Passing nullptr restores the
// default handler. This is process-global and may be invoked before any Isolate
// or Environment exists.
using AbortHandler = void (*)(const char* location, const char* message);
NODE_EXTERN void SetAbortHandler(AbortHandler handler);

// This may return nullptr if context is not associated with a Node instance.
NODE_EXTERN Environment* GetCurrentEnvironment(v8::Local<v8::Context> context);
NODE_EXTERN IsolateData* GetEnvironmentIsolateData(Environment* env);
Expand Down
30 changes: 27 additions & 3 deletions src/node_errors.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -393,6 +393,30 @@ void AppendExceptionLine(Environment* env,
.FromMaybe(false));
}

namespace {
// Default handler: Dumps native + JS backtraces to stderr and exits. This
// indirectly calls backtrace so it can not be marked as [[noreturn]] (see the
// comment on node::Assert() below). `message` and `location` are ignored
// because the assertion/fatal-error message, if any, is already printed to
// stderr by the caller (Assert()/OnFatalError()) before this handler runs.
void DefaultAbortHandler(const char* /*location*/, const char* /*message*/) {
DumpNativeBacktrace(stderr);
DumpJavaScriptBacktrace(stderr);
fflush(stderr);
ABORT_NO_BACKTRACE();
}
// Constant-initialized, so this is valid from load time, safe even for a
// CHECK() during early startup, before any SetAbortHandler call.
AbortHandler g_abort_handler = DefaultAbortHandler;
} // namespace

void SetAbortHandler(AbortHandler handler) {
g_abort_handler = handler ? handler : DefaultAbortHandler;
}
AbortHandler GetAbortHandler() {
return g_abort_handler;
}

void Assert(const AssertionInfo& info) {
std::string name = GetHumanReadableProcessName();

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

fflush(stderr);
ABORT();
ABORT_WITH_DETAILS(info.file_line, info.message);
}

enum class EnhanceFatalException { kEnhance, kDontEnhance };
Expand DownExpand Up@@ -584,7 +608,7 @@ static void ReportFatalException(Environment* env,
}

fflush(stderr);
ABORT();
ABORT_WITH_DETAILS(location, message);
}

void OOMErrorHandler(const char* location, const v8::OOMDetails& details) {
Expand DownExpand Up@@ -620,7 +644,7 @@ void OOMErrorHandler(const char* location, const v8::OOMDetails& details) {
}

fflush(stderr);
ABORT();
ABORT_WITH_DETAILS(location, message);
}

v8::ModifyCodeGenerationFromStringsResult ModifyCodeGenerationFromStrings(
Expand Down
14 changes: 8 additions & 6 deletions src/util.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -126,6 +126,9 @@ void NODE_EXTERN_PRIVATE Assert(const AssertionInfo& info);
void DumpNativeBacktrace(FILE* fp);
void DumpJavaScriptBacktrace(FILE* fp);

// Returns the currently installed abort handler which is never null.
AbortHandler GetAbortHandler();

// Windows 8+ does not like abort() in Release mode
#ifdef _WIN32
#define ABORT_NO_BACKTRACE() _exit(static_cast<int>(node::ExitCode::kAbort))
Expand All@@ -138,13 +141,12 @@ void DumpJavaScriptBacktrace(FILE* fp);
// when generating code for them the compiler can choose not to
// maintain the frame pointers or link registers that are necessary for
// correct backtracing.
// `ABORT` must be a macro and not a [[noreturn]] function to make sure the
// backtrace is correct.
#define ABORT() \
// `ABORT` and `ABORT_WITH_DETAILS` must be a macro and not a [[noreturn]]
// function to make sure the backtrace is correct.
#define ABORT() ABORT_WITH_DETAILS(__FILE__ ":" STRINGIFY(__LINE__), nullptr)
Comment thread
legendecas marked this conversation as resolved.
#define ABORT_WITH_DETAILS(location, message) \
do { \
node::DumpNativeBacktrace(stderr); \
node::DumpJavaScriptBacktrace(stderr); \
fflush(stderr); \
node::GetAbortHandler()(location, message); \
ABORT_NO_BACKTRACE(); \
} while (0)

Expand Down
18 changes: 18 additions & 0 deletions test/addons/abort-handler/binding.cc
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
#include <node.h>
#include <v8.h>
#include <cstdio>

namespace {
void TestAbortHandler(const char* /*location*/, const char* /*message*/) {
fputs("CUSTOM_ABORT_HANDLER_RAN\n", stderr);
fflush(stderr);
}

void InstallAbortHandler(const v8::FunctionCallbackInfo<v8::Value>&) {
node::SetAbortHandler(TestAbortHandler);
}
} // namespace

NODE_MODULE_INIT() {
NODE_SET_METHOD(exports, "installAbortHandler", InstallAbortHandler);
}
9 changes: 9 additions & 0 deletions test/addons/abort-handler/binding.gyp
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
{
'targets': [
{
'target_name': 'binding',
'sources': [ 'binding.cc' ],
'includes': ['../common.gypi'],
}
]
}
45 changes: 45 additions & 0 deletions test/addons/abort-handler/test.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
'use strict';
const common = require('../../common');
const assert = require('assert');
const fs = require('fs');
const path = require('path');
const { exec } = require('child_process');

const bindingPath = path.resolve(
__dirname, 'build', common.buildType, 'binding.node');

if (!fs.existsSync(bindingPath))
common.skip('binding not built yet');

if (process.argv[2] === 'child') {
const binding = require(bindingPath);
binding.installAbortHandler();
process.abort();
return;
}

const escapedArgs =
common.escapePOSIXShell`"${process.execPath}" "${__filename}" child`;
if (!common.isWindows) {
// Do not create core files, as it can take a lot of disk space on
// continuous testing and developers' machines.
escapedArgs[0] = 'ulimit -c 0 && ' + escapedArgs[0];
}

exec(...escapedArgs, common.mustCall((err, stdout, stderr) => {
assert.ok(
stderr.includes('CUSTOM_ABORT_HANDLER_RAN'),
`Expected custom abort handler marker in stderr, got:\n${stderr}`);
assert.ok(
!stderr.includes('Native stack trace'),
`Expected the custom handler to replace the default dump, got:\n${stderr}`);

// The child aborts. Whether that surfaces as the SIGABRT signal or as exit
// code 134 depends on shell wrapping: the `ulimit -c 0 && ...` prefix makes
// /bin/sh wait on (rather than exec-replace itself with) the node grandchild,
// so sh reports the aborted grandchild as a normal exit with code 134.
// common.nodeProcessAborted() accepts both forms.
assert.ok(
err && common.nodeProcessAborted(err.code, err.signal),
`Expected the child to abort, got code=${err?.code} signal=${err?.signal}`);
}));
54 changes: 54 additions & 0 deletions test/cctest/test_environment.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -1201,3 +1201,57 @@ TEST_F(EnvironmentTest, LoadEnvironmentWithCallbackWithESModule) {
printf("Frame: %s\n", *frame_str);
EXPECT_EQ(frame_str.ToString(), " at embedded:esm.mjs:3:15");
}

namespace {
void CustomAbortHandlerForContractTest(const char* location,
const char* message) {}

bool abort_handler_dispatch_flag = false;
const char* abort_handler_received_location = nullptr;
const char* abort_handler_received_message = nullptr;
void AbortHandlerThatSetsDispatchFlag(const char* location,
const char* message) {
abort_handler_dispatch_flag = true;
abort_handler_received_location = location;
abort_handler_received_message = message;
}
} // namespace

TEST(AbortHandlerTest, DefaultIsNonNullAndSetAbortHandlerRoundTrips) {
node::AbortHandler old = node::GetAbortHandler();

// There should always be a non-null default handler installed.
EXPECT_NE(node::GetAbortHandler(), nullptr);

node::SetAbortHandler(CustomAbortHandlerForContractTest);
EXPECT_EQ(node::GetAbortHandler(), CustomAbortHandlerForContractTest);

node::SetAbortHandler(nullptr);
EXPECT_NE(node::GetAbortHandler(), nullptr);
EXPECT_NE(node::GetAbortHandler(), CustomAbortHandlerForContractTest);

node::SetAbortHandler(old);
}

TEST(AbortHandlerTest, InstalledHandlerIsInvokedWhenCalled) {
node::AbortHandler old = node::GetAbortHandler();
abort_handler_dispatch_flag = false;
abort_handler_received_location = nullptr;
abort_handler_received_message = nullptr;

node::SetAbortHandler(AbortHandlerThatSetsDispatchFlag);
node::AbortHandler h = node::GetAbortHandler();
// Fail cleanly (instead of crashing on a null call) if the handler wasn't
// actually installed.
ASSERT_NE(h, nullptr);

// Dispatch through the public GetAbortHandler() accessor directly (not via
// the ABORT() macro, so nothing terminates), and verify the message is
// passed through unchanged.
node::GetAbortHandler()("some-test-location", "some-test-message");
EXPECT_TRUE(abort_handler_dispatch_flag);
EXPECT_STREQ(abort_handler_received_location, "some-test-location");
EXPECT_STREQ(abort_handler_received_message, "some-test-message");

node::SetAbortHandler(old);
}
, '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
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions src/node.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -844,6 +844,16 @@ NODE_EXTERN void SetProcessExitHandler(
std::function<void(Environment*, int)>&& handler);
NODE_EXTERN void DefaultProcessExitHandler(Environment* env, int exit_code);

// Sets a process-global handler invoked when Node.js programmatically aborts.
// Nullable strings representing the location and reason for the abort may or
// may not be passed as a parameter to the handler. The handler should not
// return, but node will ensure that the process exits after the handler is
// called regardless of whether or not it returns. Passing nullptr restores the
// default handler. This is process-global and may be invoked before any Isolate
// or Environment exists.
using AbortHandler = void (*)(const char* location, const char* message);
NODE_EXTERN void SetAbortHandler(AbortHandler handler);

// This may return nullptr if context is not associated with a Node instance.
NODE_EXTERN Environment* GetCurrentEnvironment(v8::Local<v8::Context> context);
NODE_EXTERN IsolateData* GetEnvironmentIsolateData(Environment* env);
Expand Down
30 changes: 27 additions & 3 deletions src/node_errors.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -393,6 +393,30 @@ void AppendExceptionLine(Environment* env,
.FromMaybe(false));
}

namespace {
// Default handler: Dumps native + JS backtraces to stderr and exits. This
// indirectly calls backtrace so it can not be marked as [[noreturn]] (see the
// comment on node::Assert() below). `message` and `location` are ignored
// because the assertion/fatal-error message, if any, is already printed to
// stderr by the caller (Assert()/OnFatalError()) before this handler runs.
void DefaultAbortHandler(const char* /*location*/, const char* /*message*/) {
DumpNativeBacktrace(stderr);
DumpJavaScriptBacktrace(stderr);
fflush(stderr);
ABORT_NO_BACKTRACE();
}
// Constant-initialized, so this is valid from load time, safe even for a
// CHECK() during early startup, before any SetAbortHandler call.
AbortHandler g_abort_handler = DefaultAbortHandler;
} // namespace

void SetAbortHandler(AbortHandler handler) {
g_abort_handler = handler ? handler : DefaultAbortHandler;
}
AbortHandler GetAbortHandler() {
return g_abort_handler;
}

void Assert(const AssertionInfo& info) {
std::string name = GetHumanReadableProcessName();

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

fflush(stderr);
ABORT();
ABORT_WITH_DETAILS(info.file_line, info.message);
}

enum class EnhanceFatalException { kEnhance, kDontEnhance };
Expand DownExpand Up@@ -584,7 +608,7 @@ static void ReportFatalException(Environment* env,
}

fflush(stderr);
ABORT();
ABORT_WITH_DETAILS(location, message);
}

void OOMErrorHandler(const char* location, const v8::OOMDetails& details) {
Expand DownExpand Up@@ -620,7 +644,7 @@ void OOMErrorHandler(const char* location, const v8::OOMDetails& details) {
}

fflush(stderr);
ABORT();
ABORT_WITH_DETAILS(location, message);
}

v8::ModifyCodeGenerationFromStringsResult ModifyCodeGenerationFromStrings(
Expand Down
14 changes: 8 additions & 6 deletions src/util.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -126,6 +126,9 @@ void NODE_EXTERN_PRIVATE Assert(const AssertionInfo& info);
void DumpNativeBacktrace(FILE* fp);
void DumpJavaScriptBacktrace(FILE* fp);

// Returns the currently installed abort handler which is never null.
AbortHandler GetAbortHandler();

// Windows 8+ does not like abort() in Release mode
#ifdef _WIN32
#define ABORT_NO_BACKTRACE() _exit(static_cast<int>(node::ExitCode::kAbort))
Expand All@@ -138,13 +141,12 @@ void DumpJavaScriptBacktrace(FILE* fp);
// when generating code for them the compiler can choose not to
// maintain the frame pointers or link registers that are necessary for
// correct backtracing.
// `ABORT` must be a macro and not a [[noreturn]] function to make sure the
// backtrace is correct.
#define ABORT() \
// `ABORT` and `ABORT_WITH_DETAILS` must be a macro and not a [[noreturn]]
// function to make sure the backtrace is correct.
#define ABORT() ABORT_WITH_DETAILS(__FILE__ ":" STRINGIFY(__LINE__), nullptr)
Comment thread
legendecas marked this conversation as resolved.
#define ABORT_WITH_DETAILS(location, message) \
do { \
node::DumpNativeBacktrace(stderr); \
node::DumpJavaScriptBacktrace(stderr); \
fflush(stderr); \
node::GetAbortHandler()(location, message); \
ABORT_NO_BACKTRACE(); \
} while (0)

Expand Down
18 changes: 18 additions & 0 deletions test/addons/abort-handler/binding.cc
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
#include <node.h>
#include <v8.h>
#include <cstdio>

namespace {
void TestAbortHandler(const char* /*location*/, const char* /*message*/) {
fputs("CUSTOM_ABORT_HANDLER_RAN\n", stderr);
fflush(stderr);
}

void InstallAbortHandler(const v8::FunctionCallbackInfo<v8::Value>&) {
node::SetAbortHandler(TestAbortHandler);
}
} // namespace

NODE_MODULE_INIT() {
NODE_SET_METHOD(exports, "installAbortHandler", InstallAbortHandler);
}
9 changes: 9 additions & 0 deletions test/addons/abort-handler/binding.gyp
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
{
'targets': [
{
'target_name': 'binding',
'sources': [ 'binding.cc' ],
'includes': ['../common.gypi'],
}
]
}
45 changes: 45 additions & 0 deletions test/addons/abort-handler/test.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
'use strict';
const common = require('../../common');
const assert = require('assert');
const fs = require('fs');
const path = require('path');
const { exec } = require('child_process');

const bindingPath = path.resolve(
__dirname, 'build', common.buildType, 'binding.node');

if (!fs.existsSync(bindingPath))
common.skip('binding not built yet');

if (process.argv[2] === 'child') {
const binding = require(bindingPath);
binding.installAbortHandler();
process.abort();
return;
}

const escapedArgs =
common.escapePOSIXShell`"${process.execPath}" "${__filename}" child`;
if (!common.isWindows) {
// Do not create core files, as it can take a lot of disk space on
// continuous testing and developers' machines.
escapedArgs[0] = 'ulimit -c 0 && ' + escapedArgs[0];
}

exec(...escapedArgs, common.mustCall((err, stdout, stderr) => {
assert.ok(
stderr.includes('CUSTOM_ABORT_HANDLER_RAN'),
`Expected custom abort handler marker in stderr, got:\n${stderr}`);
assert.ok(
!stderr.includes('Native stack trace'),
`Expected the custom handler to replace the default dump, got:\n${stderr}`);

// The child aborts. Whether that surfaces as the SIGABRT signal or as exit
// code 134 depends on shell wrapping: the `ulimit -c 0 && ...` prefix makes
// /bin/sh wait on (rather than exec-replace itself with) the node grandchild,
// so sh reports the aborted grandchild as a normal exit with code 134.
// common.nodeProcessAborted() accepts both forms.
assert.ok(
err && common.nodeProcessAborted(err.code, err.signal),
`Expected the child to abort, got code=${err?.code} signal=${err?.signal}`);
}));
54 changes: 54 additions & 0 deletions test/cctest/test_environment.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -1201,3 +1201,57 @@ TEST_F(EnvironmentTest, LoadEnvironmentWithCallbackWithESModule) {
printf("Frame: %s\n", *frame_str);
EXPECT_EQ(frame_str.ToString(), " at embedded:esm.mjs:3:15");
}

namespace {
void CustomAbortHandlerForContractTest(const char* location,
const char* message) {}

bool abort_handler_dispatch_flag = false;
const char* abort_handler_received_location = nullptr;
const char* abort_handler_received_message = nullptr;
void AbortHandlerThatSetsDispatchFlag(const char* location,
const char* message) {
abort_handler_dispatch_flag = true;
abort_handler_received_location = location;
abort_handler_received_message = message;
}
} // namespace

TEST(AbortHandlerTest, DefaultIsNonNullAndSetAbortHandlerRoundTrips) {
node::AbortHandler old = node::GetAbortHandler();

// There should always be a non-null default handler installed.
EXPECT_NE(node::GetAbortHandler(), nullptr);

node::SetAbortHandler(CustomAbortHandlerForContractTest);
EXPECT_EQ(node::GetAbortHandler(), CustomAbortHandlerForContractTest);

node::SetAbortHandler(nullptr);
EXPECT_NE(node::GetAbortHandler(), nullptr);
EXPECT_NE(node::GetAbortHandler(), CustomAbortHandlerForContractTest);

node::SetAbortHandler(old);
}

TEST(AbortHandlerTest, InstalledHandlerIsInvokedWhenCalled) {
node::AbortHandler old = node::GetAbortHandler();
abort_handler_dispatch_flag = false;
abort_handler_received_location = nullptr;
abort_handler_received_message = nullptr;

node::SetAbortHandler(AbortHandlerThatSetsDispatchFlag);
node::AbortHandler h = node::GetAbortHandler();
// Fail cleanly (instead of crashing on a null call) if the handler wasn't
// actually installed.
ASSERT_NE(h, nullptr);

// Dispatch through the public GetAbortHandler() accessor directly (not via
// the ABORT() macro, so nothing terminates), and verify the message is
// passed through unchanged.
node::GetAbortHandler()("some-test-location", "some-test-message");
EXPECT_TRUE(abort_handler_dispatch_flag);
EXPECT_STREQ(abort_handler_received_location, "some-test-location");
EXPECT_STREQ(abort_handler_received_message, "some-test-message");

node::SetAbortHandler(old);
}
, '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
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions src/node.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -844,6 +844,16 @@ NODE_EXTERN void SetProcessExitHandler(
std::function<void(Environment*, int)>&& handler);
NODE_EXTERN void DefaultProcessExitHandler(Environment* env, int exit_code);

// Sets a process-global handler invoked when Node.js programmatically aborts.
// Nullable strings representing the location and reason for the abort may or
// may not be passed as a parameter to the handler. The handler should not
// return, but node will ensure that the process exits after the handler is
// called regardless of whether or not it returns. Passing nullptr restores the
// default handler. This is process-global and may be invoked before any Isolate
// or Environment exists.
using AbortHandler = void (*)(const char* location, const char* message);
NODE_EXTERN void SetAbortHandler(AbortHandler handler);

// This may return nullptr if context is not associated with a Node instance.
NODE_EXTERN Environment* GetCurrentEnvironment(v8::Local<v8::Context> context);
NODE_EXTERN IsolateData* GetEnvironmentIsolateData(Environment* env);
Expand Down
30 changes: 27 additions & 3 deletions src/node_errors.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -393,6 +393,30 @@ void AppendExceptionLine(Environment* env,
.FromMaybe(false));
}

namespace {
// Default handler: Dumps native + JS backtraces to stderr and exits. This
// indirectly calls backtrace so it can not be marked as [[noreturn]] (see the
// comment on node::Assert() below). `message` and `location` are ignored
// because the assertion/fatal-error message, if any, is already printed to
// stderr by the caller (Assert()/OnFatalError()) before this handler runs.
void DefaultAbortHandler(const char* /*location*/, const char* /*message*/) {
DumpNativeBacktrace(stderr);
DumpJavaScriptBacktrace(stderr);
fflush(stderr);
ABORT_NO_BACKTRACE();
}
// Constant-initialized, so this is valid from load time, safe even for a
// CHECK() during early startup, before any SetAbortHandler call.
AbortHandler g_abort_handler = DefaultAbortHandler;
} // namespace

void SetAbortHandler(AbortHandler handler) {
g_abort_handler = handler ? handler : DefaultAbortHandler;
}
AbortHandler GetAbortHandler() {
return g_abort_handler;
}

void Assert(const AssertionInfo& info) {
std::string name = GetHumanReadableProcessName();

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

fflush(stderr);
ABORT();
ABORT_WITH_DETAILS(info.file_line, info.message);
}

enum class EnhanceFatalException { kEnhance, kDontEnhance };
Expand DownExpand Up@@ -584,7 +608,7 @@ static void ReportFatalException(Environment* env,
}

fflush(stderr);
ABORT();
ABORT_WITH_DETAILS(location, message);
}

void OOMErrorHandler(const char* location, const v8::OOMDetails& details) {
Expand DownExpand Up@@ -620,7 +644,7 @@ void OOMErrorHandler(const char* location, const v8::OOMDetails& details) {
}

fflush(stderr);
ABORT();
ABORT_WITH_DETAILS(location, message);
}

v8::ModifyCodeGenerationFromStringsResult ModifyCodeGenerationFromStrings(
Expand Down
14 changes: 8 additions & 6 deletions src/util.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -126,6 +126,9 @@ void NODE_EXTERN_PRIVATE Assert(const AssertionInfo& info);
void DumpNativeBacktrace(FILE* fp);
void DumpJavaScriptBacktrace(FILE* fp);

// Returns the currently installed abort handler which is never null.
AbortHandler GetAbortHandler();

// Windows 8+ does not like abort() in Release mode
#ifdef _WIN32
#define ABORT_NO_BACKTRACE() _exit(static_cast<int>(node::ExitCode::kAbort))
Expand All@@ -138,13 +141,12 @@ void DumpJavaScriptBacktrace(FILE* fp);
// when generating code for them the compiler can choose not to
// maintain the frame pointers or link registers that are necessary for
// correct backtracing.
// `ABORT` must be a macro and not a [[noreturn]] function to make sure the
// backtrace is correct.
#define ABORT() \
// `ABORT` and `ABORT_WITH_DETAILS` must be a macro and not a [[noreturn]]
// function to make sure the backtrace is correct.
#define ABORT() ABORT_WITH_DETAILS(__FILE__ ":" STRINGIFY(__LINE__), nullptr)
Comment thread
legendecas marked this conversation as resolved.
#define ABORT_WITH_DETAILS(location, message) \
do { \
node::DumpNativeBacktrace(stderr); \
node::DumpJavaScriptBacktrace(stderr); \
fflush(stderr); \
node::GetAbortHandler()(location, message); \
ABORT_NO_BACKTRACE(); \
} while (0)

Expand Down
18 changes: 18 additions & 0 deletions test/addons/abort-handler/binding.cc
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
#include <node.h>
#include <v8.h>
#include <cstdio>

namespace {
void TestAbortHandler(const char* /*location*/, const char* /*message*/) {
fputs("CUSTOM_ABORT_HANDLER_RAN\n", stderr);
fflush(stderr);
}

void InstallAbortHandler(const v8::FunctionCallbackInfo<v8::Value>&) {
node::SetAbortHandler(TestAbortHandler);
}
} // namespace

NODE_MODULE_INIT() {
NODE_SET_METHOD(exports, "installAbortHandler", InstallAbortHandler);
}
9 changes: 9 additions & 0 deletions test/addons/abort-handler/binding.gyp
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
{
'targets': [
{
'target_name': 'binding',
'sources': [ 'binding.cc' ],
'includes': ['../common.gypi'],
}
]
}
45 changes: 45 additions & 0 deletions test/addons/abort-handler/test.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
'use strict';
const common = require('../../common');
const assert = require('assert');
const fs = require('fs');
const path = require('path');
const { exec } = require('child_process');

const bindingPath = path.resolve(
__dirname, 'build', common.buildType, 'binding.node');

if (!fs.existsSync(bindingPath))
common.skip('binding not built yet');

if (process.argv[2] === 'child') {
const binding = require(bindingPath);
binding.installAbortHandler();
process.abort();
return;
}

const escapedArgs =
common.escapePOSIXShell`"${process.execPath}" "${__filename}" child`;
if (!common.isWindows) {
// Do not create core files, as it can take a lot of disk space on
// continuous testing and developers' machines.
escapedArgs[0] = 'ulimit -c 0 && ' + escapedArgs[0];
}

exec(...escapedArgs, common.mustCall((err, stdout, stderr) => {
assert.ok(
stderr.includes('CUSTOM_ABORT_HANDLER_RAN'),
`Expected custom abort handler marker in stderr, got:\n${stderr}`);
assert.ok(
!stderr.includes('Native stack trace'),
`Expected the custom handler to replace the default dump, got:\n${stderr}`);

// The child aborts. Whether that surfaces as the SIGABRT signal or as exit
// code 134 depends on shell wrapping: the `ulimit -c 0 && ...` prefix makes
// /bin/sh wait on (rather than exec-replace itself with) the node grandchild,
// so sh reports the aborted grandchild as a normal exit with code 134.
// common.nodeProcessAborted() accepts both forms.
assert.ok(
err && common.nodeProcessAborted(err.code, err.signal),
`Expected the child to abort, got code=${err?.code} signal=${err?.signal}`);
}));
54 changes: 54 additions & 0 deletions test/cctest/test_environment.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -1201,3 +1201,57 @@ TEST_F(EnvironmentTest, LoadEnvironmentWithCallbackWithESModule) {
printf("Frame: %s\n", *frame_str);
EXPECT_EQ(frame_str.ToString(), " at embedded:esm.mjs:3:15");
}

namespace {
void CustomAbortHandlerForContractTest(const char* location,
const char* message) {}

bool abort_handler_dispatch_flag = false;
const char* abort_handler_received_location = nullptr;
const char* abort_handler_received_message = nullptr;
void AbortHandlerThatSetsDispatchFlag(const char* location,
const char* message) {
abort_handler_dispatch_flag = true;
abort_handler_received_location = location;
abort_handler_received_message = message;
}
} // namespace

TEST(AbortHandlerTest, DefaultIsNonNullAndSetAbortHandlerRoundTrips) {
node::AbortHandler old = node::GetAbortHandler();

// There should always be a non-null default handler installed.
EXPECT_NE(node::GetAbortHandler(), nullptr);

node::SetAbortHandler(CustomAbortHandlerForContractTest);
EXPECT_EQ(node::GetAbortHandler(), CustomAbortHandlerForContractTest);

node::SetAbortHandler(nullptr);
EXPECT_NE(node::GetAbortHandler(), nullptr);
EXPECT_NE(node::GetAbortHandler(), CustomAbortHandlerForContractTest);

node::SetAbortHandler(old);
}

TEST(AbortHandlerTest, InstalledHandlerIsInvokedWhenCalled) {
node::AbortHandler old = node::GetAbortHandler();
abort_handler_dispatch_flag = false;
abort_handler_received_location = nullptr;
abort_handler_received_message = nullptr;

node::SetAbortHandler(AbortHandlerThatSetsDispatchFlag);
node::AbortHandler h = node::GetAbortHandler();
// Fail cleanly (instead of crashing on a null call) if the handler wasn't
// actually installed.
ASSERT_NE(h, nullptr);

// Dispatch through the public GetAbortHandler() accessor directly (not via
// the ABORT() macro, so nothing terminates), and verify the message is
// passed through unchanged.
node::GetAbortHandler()("some-test-location", "some-test-message");
EXPECT_TRUE(abort_handler_dispatch_flag);
EXPECT_STREQ(abort_handler_received_location, "some-test-location");
EXPECT_STREQ(abort_handler_received_message, "some-test-message");

node::SetAbortHandler(old);
}
, '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
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions src/node.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -844,6 +844,16 @@ NODE_EXTERN void SetProcessExitHandler(
std::function<void(Environment*, int)>&& handler);
NODE_EXTERN void DefaultProcessExitHandler(Environment* env, int exit_code);

// Sets a process-global handler invoked when Node.js programmatically aborts.
// Nullable strings representing the location and reason for the abort may or
// may not be passed as a parameter to the handler. The handler should not
// return, but node will ensure that the process exits after the handler is
// called regardless of whether or not it returns. Passing nullptr restores the
// default handler. This is process-global and may be invoked before any Isolate
// or Environment exists.
using AbortHandler = void (*)(const char* location, const char* message);
NODE_EXTERN void SetAbortHandler(AbortHandler handler);

// This may return nullptr if context is not associated with a Node instance.
NODE_EXTERN Environment* GetCurrentEnvironment(v8::Local<v8::Context> context);
NODE_EXTERN IsolateData* GetEnvironmentIsolateData(Environment* env);
Expand Down
30 changes: 27 additions & 3 deletions src/node_errors.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -393,6 +393,30 @@ void AppendExceptionLine(Environment* env,
.FromMaybe(false));
}

namespace {
// Default handler: Dumps native + JS backtraces to stderr and exits. This
// indirectly calls backtrace so it can not be marked as [[noreturn]] (see the
// comment on node::Assert() below). `message` and `location` are ignored
// because the assertion/fatal-error message, if any, is already printed to
// stderr by the caller (Assert()/OnFatalError()) before this handler runs.
void DefaultAbortHandler(const char* /*location*/, const char* /*message*/) {
DumpNativeBacktrace(stderr);
DumpJavaScriptBacktrace(stderr);
fflush(stderr);
ABORT_NO_BACKTRACE();
}
// Constant-initialized, so this is valid from load time, safe even for a
// CHECK() during early startup, before any SetAbortHandler call.
AbortHandler g_abort_handler = DefaultAbortHandler;
} // namespace

void SetAbortHandler(AbortHandler handler) {
g_abort_handler = handler ? handler : DefaultAbortHandler;
}
AbortHandler GetAbortHandler() {
return g_abort_handler;
}

void Assert(const AssertionInfo& info) {
std::string name = GetHumanReadableProcessName();

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

fflush(stderr);
ABORT();
ABORT_WITH_DETAILS(info.file_line, info.message);
}

enum class EnhanceFatalException { kEnhance, kDontEnhance };
Expand DownExpand Up@@ -584,7 +608,7 @@ static void ReportFatalException(Environment* env,
}

fflush(stderr);
ABORT();
ABORT_WITH_DETAILS(location, message);
}

void OOMErrorHandler(const char* location, const v8::OOMDetails& details) {
Expand DownExpand Up@@ -620,7 +644,7 @@ void OOMErrorHandler(const char* location, const v8::OOMDetails& details) {
}

fflush(stderr);
ABORT();
ABORT_WITH_DETAILS(location, message);
}

v8::ModifyCodeGenerationFromStringsResult ModifyCodeGenerationFromStrings(
Expand Down
14 changes: 8 additions & 6 deletions src/util.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -126,6 +126,9 @@ void NODE_EXTERN_PRIVATE Assert(const AssertionInfo& info);
void DumpNativeBacktrace(FILE* fp);
void DumpJavaScriptBacktrace(FILE* fp);

// Returns the currently installed abort handler which is never null.
AbortHandler GetAbortHandler();

// Windows 8+ does not like abort() in Release mode
#ifdef _WIN32
#define ABORT_NO_BACKTRACE() _exit(static_cast<int>(node::ExitCode::kAbort))
Expand All@@ -138,13 +141,12 @@ void DumpJavaScriptBacktrace(FILE* fp);
// when generating code for them the compiler can choose not to
// maintain the frame pointers or link registers that are necessary for
// correct backtracing.
// `ABORT` must be a macro and not a [[noreturn]] function to make sure the
// backtrace is correct.
#define ABORT() \
// `ABORT` and `ABORT_WITH_DETAILS` must be a macro and not a [[noreturn]]
// function to make sure the backtrace is correct.
#define ABORT() ABORT_WITH_DETAILS(__FILE__ ":" STRINGIFY(__LINE__), nullptr)
Comment thread
legendecas marked this conversation as resolved.
#define ABORT_WITH_DETAILS(location, message) \
do { \
node::DumpNativeBacktrace(stderr); \
node::DumpJavaScriptBacktrace(stderr); \
fflush(stderr); \
node::GetAbortHandler()(location, message); \
ABORT_NO_BACKTRACE(); \
} while (0)

Expand Down
18 changes: 18 additions & 0 deletions test/addons/abort-handler/binding.cc
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
#include <node.h>
#include <v8.h>
#include <cstdio>

namespace {
void TestAbortHandler(const char* /*location*/, const char* /*message*/) {
fputs("CUSTOM_ABORT_HANDLER_RAN\n", stderr);
fflush(stderr);
}

void InstallAbortHandler(const v8::FunctionCallbackInfo<v8::Value>&) {
node::SetAbortHandler(TestAbortHandler);
}
} // namespace

NODE_MODULE_INIT() {
NODE_SET_METHOD(exports, "installAbortHandler", InstallAbortHandler);
}
9 changes: 9 additions & 0 deletions test/addons/abort-handler/binding.gyp
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
{
'targets': [
{
'target_name': 'binding',
'sources': [ 'binding.cc' ],
'includes': ['../common.gypi'],
}
]
}
45 changes: 45 additions & 0 deletions test/addons/abort-handler/test.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
'use strict';
const common = require('../../common');
const assert = require('assert');
const fs = require('fs');
const path = require('path');
const { exec } = require('child_process');

const bindingPath = path.resolve(
__dirname, 'build', common.buildType, 'binding.node');

if (!fs.existsSync(bindingPath))
common.skip('binding not built yet');

if (process.argv[2] === 'child') {
const binding = require(bindingPath);
binding.installAbortHandler();
process.abort();
return;
}

const escapedArgs =
common.escapePOSIXShell`"${process.execPath}" "${__filename}" child`;
if (!common.isWindows) {
// Do not create core files, as it can take a lot of disk space on
// continuous testing and developers' machines.
escapedArgs[0] = 'ulimit -c 0 && ' + escapedArgs[0];
}

exec(...escapedArgs, common.mustCall((err, stdout, stderr) => {
assert.ok(
stderr.includes('CUSTOM_ABORT_HANDLER_RAN'),
`Expected custom abort handler marker in stderr, got:\n${stderr}`);
assert.ok(
!stderr.includes('Native stack trace'),
`Expected the custom handler to replace the default dump, got:\n${stderr}`);

// The child aborts. Whether that surfaces as the SIGABRT signal or as exit
// code 134 depends on shell wrapping: the `ulimit -c 0 && ...` prefix makes
// /bin/sh wait on (rather than exec-replace itself with) the node grandchild,
// so sh reports the aborted grandchild as a normal exit with code 134.
// common.nodeProcessAborted() accepts both forms.
assert.ok(
err && common.nodeProcessAborted(err.code, err.signal),
`Expected the child to abort, got code=${err?.code} signal=${err?.signal}`);
}));
54 changes: 54 additions & 0 deletions test/cctest/test_environment.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -1201,3 +1201,57 @@ TEST_F(EnvironmentTest, LoadEnvironmentWithCallbackWithESModule) {
printf("Frame: %s\n", *frame_str);
EXPECT_EQ(frame_str.ToString(), " at embedded:esm.mjs:3:15");
}

namespace {
void CustomAbortHandlerForContractTest(const char* location,
const char* message) {}

bool abort_handler_dispatch_flag = false;
const char* abort_handler_received_location = nullptr;
const char* abort_handler_received_message = nullptr;
void AbortHandlerThatSetsDispatchFlag(const char* location,
const char* message) {
abort_handler_dispatch_flag = true;
abort_handler_received_location = location;
abort_handler_received_message = message;
}
} // namespace

TEST(AbortHandlerTest, DefaultIsNonNullAndSetAbortHandlerRoundTrips) {
node::AbortHandler old = node::GetAbortHandler();

// There should always be a non-null default handler installed.
EXPECT_NE(node::GetAbortHandler(), nullptr);

node::SetAbortHandler(CustomAbortHandlerForContractTest);
EXPECT_EQ(node::GetAbortHandler(), CustomAbortHandlerForContractTest);

node::SetAbortHandler(nullptr);
EXPECT_NE(node::GetAbortHandler(), nullptr);
EXPECT_NE(node::GetAbortHandler(), CustomAbortHandlerForContractTest);

node::SetAbortHandler(old);
}

TEST(AbortHandlerTest, InstalledHandlerIsInvokedWhenCalled) {
node::AbortHandler old = node::GetAbortHandler();
abort_handler_dispatch_flag = false;
abort_handler_received_location = nullptr;
abort_handler_received_message = nullptr;

node::SetAbortHandler(AbortHandlerThatSetsDispatchFlag);
node::AbortHandler h = node::GetAbortHandler();
// Fail cleanly (instead of crashing on a null call) if the handler wasn't
// actually installed.
ASSERT_NE(h, nullptr);

// Dispatch through the public GetAbortHandler() accessor directly (not via
// the ABORT() macro, so nothing terminates), and verify the message is
// passed through unchanged.
node::GetAbortHandler()("some-test-location", "some-test-message");
EXPECT_TRUE(abort_handler_dispatch_flag);
EXPECT_STREQ(abort_handler_received_location, "some-test-location");
EXPECT_STREQ(abort_handler_received_message, "some-test-message");

node::SetAbortHandler(old);
}
, '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
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions src/node.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -844,6 +844,16 @@ NODE_EXTERN void SetProcessExitHandler(
std::function<void(Environment*, int)>&& handler);
NODE_EXTERN void DefaultProcessExitHandler(Environment* env, int exit_code);

// Sets a process-global handler invoked when Node.js programmatically aborts.
// Nullable strings representing the location and reason for the abort may or
// may not be passed as a parameter to the handler. The handler should not
// return, but node will ensure that the process exits after the handler is
// called regardless of whether or not it returns. Passing nullptr restores the
// default handler. This is process-global and may be invoked before any Isolate
// or Environment exists.
using AbortHandler = void (*)(const char* location, const char* message);
NODE_EXTERN void SetAbortHandler(AbortHandler handler);

// This may return nullptr if context is not associated with a Node instance.
NODE_EXTERN Environment* GetCurrentEnvironment(v8::Local<v8::Context> context);
NODE_EXTERN IsolateData* GetEnvironmentIsolateData(Environment* env);
Expand Down
30 changes: 27 additions & 3 deletions src/node_errors.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -393,6 +393,30 @@ void AppendExceptionLine(Environment* env,
.FromMaybe(false));
}

namespace {
// Default handler: Dumps native + JS backtraces to stderr and exits. This
// indirectly calls backtrace so it can not be marked as [[noreturn]] (see the
// comment on node::Assert() below). `message` and `location` are ignored
// because the assertion/fatal-error message, if any, is already printed to
// stderr by the caller (Assert()/OnFatalError()) before this handler runs.
void DefaultAbortHandler(const char* /*location*/, const char* /*message*/) {
DumpNativeBacktrace(stderr);
DumpJavaScriptBacktrace(stderr);
fflush(stderr);
ABORT_NO_BACKTRACE();
}
// Constant-initialized, so this is valid from load time, safe even for a
// CHECK() during early startup, before any SetAbortHandler call.
AbortHandler g_abort_handler = DefaultAbortHandler;
} // namespace

void SetAbortHandler(AbortHandler handler) {
g_abort_handler = handler ? handler : DefaultAbortHandler;
}
AbortHandler GetAbortHandler() {
return g_abort_handler;
}

void Assert(const AssertionInfo& info) {
std::string name = GetHumanReadableProcessName();

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

fflush(stderr);
ABORT();
ABORT_WITH_DETAILS(info.file_line, info.message);
}

enum class EnhanceFatalException { kEnhance, kDontEnhance };
Expand DownExpand Up@@ -584,7 +608,7 @@ static void ReportFatalException(Environment* env,
}

fflush(stderr);
ABORT();
ABORT_WITH_DETAILS(location, message);
}

void OOMErrorHandler(const char* location, const v8::OOMDetails& details) {
Expand DownExpand Up@@ -620,7 +644,7 @@ void OOMErrorHandler(const char* location, const v8::OOMDetails& details) {
}

fflush(stderr);
ABORT();
ABORT_WITH_DETAILS(location, message);
}

v8::ModifyCodeGenerationFromStringsResult ModifyCodeGenerationFromStrings(
Expand Down
14 changes: 8 additions & 6 deletions src/util.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -126,6 +126,9 @@ void NODE_EXTERN_PRIVATE Assert(const AssertionInfo& info);
void DumpNativeBacktrace(FILE* fp);
void DumpJavaScriptBacktrace(FILE* fp);

// Returns the currently installed abort handler which is never null.
AbortHandler GetAbortHandler();

// Windows 8+ does not like abort() in Release mode
#ifdef _WIN32
#define ABORT_NO_BACKTRACE() _exit(static_cast<int>(node::ExitCode::kAbort))
Expand All@@ -138,13 +141,12 @@ void DumpJavaScriptBacktrace(FILE* fp);
// when generating code for them the compiler can choose not to
// maintain the frame pointers or link registers that are necessary for
// correct backtracing.
// `ABORT` must be a macro and not a [[noreturn]] function to make sure the
// backtrace is correct.
#define ABORT() \
// `ABORT` and `ABORT_WITH_DETAILS` must be a macro and not a [[noreturn]]
// function to make sure the backtrace is correct.
#define ABORT() ABORT_WITH_DETAILS(__FILE__ ":" STRINGIFY(__LINE__), nullptr)
Comment thread
legendecas marked this conversation as resolved.
#define ABORT_WITH_DETAILS(location, message) \
do { \
node::DumpNativeBacktrace(stderr); \
node::DumpJavaScriptBacktrace(stderr); \
fflush(stderr); \
node::GetAbortHandler()(location, message); \
ABORT_NO_BACKTRACE(); \
} while (0)

Expand Down
18 changes: 18 additions & 0 deletions test/addons/abort-handler/binding.cc
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
#include <node.h>
#include <v8.h>
#include <cstdio>

namespace {
void TestAbortHandler(const char* /*location*/, const char* /*message*/) {
fputs("CUSTOM_ABORT_HANDLER_RAN\n", stderr);
fflush(stderr);
}

void InstallAbortHandler(const v8::FunctionCallbackInfo<v8::Value>&) {
node::SetAbortHandler(TestAbortHandler);
}
} // namespace

NODE_MODULE_INIT() {
NODE_SET_METHOD(exports, "installAbortHandler", InstallAbortHandler);
}
9 changes: 9 additions & 0 deletions test/addons/abort-handler/binding.gyp
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
{
'targets': [
{
'target_name': 'binding',
'sources': [ 'binding.cc' ],
'includes': ['../common.gypi'],
}
]
}
45 changes: 45 additions & 0 deletions test/addons/abort-handler/test.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
'use strict';
const common = require('../../common');
const assert = require('assert');
const fs = require('fs');
const path = require('path');
const { exec } = require('child_process');

const bindingPath = path.resolve(
__dirname, 'build', common.buildType, 'binding.node');

if (!fs.existsSync(bindingPath))
common.skip('binding not built yet');

if (process.argv[2] === 'child') {
const binding = require(bindingPath);
binding.installAbortHandler();
process.abort();
return;
}

const escapedArgs =
common.escapePOSIXShell`"${process.execPath}" "${__filename}" child`;
if (!common.isWindows) {
// Do not create core files, as it can take a lot of disk space on
// continuous testing and developers' machines.
escapedArgs[0] = 'ulimit -c 0 && ' + escapedArgs[0];
}

exec(...escapedArgs, common.mustCall((err, stdout, stderr) => {
assert.ok(
stderr.includes('CUSTOM_ABORT_HANDLER_RAN'),
`Expected custom abort handler marker in stderr, got:\n${stderr}`);
assert.ok(
!stderr.includes('Native stack trace'),
`Expected the custom handler to replace the default dump, got:\n${stderr}`);

// The child aborts. Whether that surfaces as the SIGABRT signal or as exit
// code 134 depends on shell wrapping: the `ulimit -c 0 && ...` prefix makes
// /bin/sh wait on (rather than exec-replace itself with) the node grandchild,
// so sh reports the aborted grandchild as a normal exit with code 134.
// common.nodeProcessAborted() accepts both forms.
assert.ok(
err && common.nodeProcessAborted(err.code, err.signal),
`Expected the child to abort, got code=${err?.code} signal=${err?.signal}`);
}));
54 changes: 54 additions & 0 deletions test/cctest/test_environment.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -1201,3 +1201,57 @@ TEST_F(EnvironmentTest, LoadEnvironmentWithCallbackWithESModule) {
printf("Frame: %s\n", *frame_str);
EXPECT_EQ(frame_str.ToString(), " at embedded:esm.mjs:3:15");
}

namespace {
void CustomAbortHandlerForContractTest(const char* location,
const char* message) {}

bool abort_handler_dispatch_flag = false;
const char* abort_handler_received_location = nullptr;
const char* abort_handler_received_message = nullptr;
void AbortHandlerThatSetsDispatchFlag(const char* location,
const char* message) {
abort_handler_dispatch_flag = true;
abort_handler_received_location = location;
abort_handler_received_message = message;
}
} // namespace

TEST(AbortHandlerTest, DefaultIsNonNullAndSetAbortHandlerRoundTrips) {
node::AbortHandler old = node::GetAbortHandler();

// There should always be a non-null default handler installed.
EXPECT_NE(node::GetAbortHandler(), nullptr);

node::SetAbortHandler(CustomAbortHandlerForContractTest);
EXPECT_EQ(node::GetAbortHandler(), CustomAbortHandlerForContractTest);

node::SetAbortHandler(nullptr);
EXPECT_NE(node::GetAbortHandler(), nullptr);
EXPECT_NE(node::GetAbortHandler(), CustomAbortHandlerForContractTest);

node::SetAbortHandler(old);
}

TEST(AbortHandlerTest, InstalledHandlerIsInvokedWhenCalled) {
node::AbortHandler old = node::GetAbortHandler();
abort_handler_dispatch_flag = false;
abort_handler_received_location = nullptr;
abort_handler_received_message = nullptr;

node::SetAbortHandler(AbortHandlerThatSetsDispatchFlag);
node::AbortHandler h = node::GetAbortHandler();
// Fail cleanly (instead of crashing on a null call) if the handler wasn't
// actually installed.
ASSERT_NE(h, nullptr);

// Dispatch through the public GetAbortHandler() accessor directly (not via
// the ABORT() macro, so nothing terminates), and verify the message is
// passed through unchanged.
node::GetAbortHandler()("some-test-location", "some-test-message");
EXPECT_TRUE(abort_handler_dispatch_flag);
EXPECT_STREQ(abort_handler_received_location, "some-test-location");
EXPECT_STREQ(abort_handler_received_message, "some-test-message");

node::SetAbortHandler(old);
}
, '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
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions src/node.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -844,6 +844,16 @@ NODE_EXTERN void SetProcessExitHandler(
std::function<void(Environment*, int)>&& handler);
NODE_EXTERN void DefaultProcessExitHandler(Environment* env, int exit_code);

// Sets a process-global handler invoked when Node.js programmatically aborts.
// Nullable strings representing the location and reason for the abort may or
// may not be passed as a parameter to the handler. The handler should not
// return, but node will ensure that the process exits after the handler is
// called regardless of whether or not it returns. Passing nullptr restores the
// default handler. This is process-global and may be invoked before any Isolate
// or Environment exists.
using AbortHandler = void (*)(const char* location, const char* message);
NODE_EXTERN void SetAbortHandler(AbortHandler handler);

// This may return nullptr if context is not associated with a Node instance.
NODE_EXTERN Environment* GetCurrentEnvironment(v8::Local<v8::Context> context);
NODE_EXTERN IsolateData* GetEnvironmentIsolateData(Environment* env);
Expand Down
30 changes: 27 additions & 3 deletions src/node_errors.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -393,6 +393,30 @@ void AppendExceptionLine(Environment* env,
.FromMaybe(false));
}

namespace {
// Default handler: Dumps native + JS backtraces to stderr and exits. This
// indirectly calls backtrace so it can not be marked as [[noreturn]] (see the
// comment on node::Assert() below). `message` and `location` are ignored
// because the assertion/fatal-error message, if any, is already printed to
// stderr by the caller (Assert()/OnFatalError()) before this handler runs.
void DefaultAbortHandler(const char* /*location*/, const char* /*message*/) {
DumpNativeBacktrace(stderr);
DumpJavaScriptBacktrace(stderr);
fflush(stderr);
ABORT_NO_BACKTRACE();
}
// Constant-initialized, so this is valid from load time, safe even for a
// CHECK() during early startup, before any SetAbortHandler call.
AbortHandler g_abort_handler = DefaultAbortHandler;
} // namespace

void SetAbortHandler(AbortHandler handler) {
g_abort_handler = handler ? handler : DefaultAbortHandler;
}
AbortHandler GetAbortHandler() {
return g_abort_handler;
}

void Assert(const AssertionInfo& info) {
std::string name = GetHumanReadableProcessName();

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

fflush(stderr);
ABORT();
ABORT_WITH_DETAILS(info.file_line, info.message);
}

enum class EnhanceFatalException { kEnhance, kDontEnhance };
Expand DownExpand Up@@ -584,7 +608,7 @@ static void ReportFatalException(Environment* env,
}

fflush(stderr);
ABORT();
ABORT_WITH_DETAILS(location, message);
}

void OOMErrorHandler(const char* location, const v8::OOMDetails& details) {
Expand DownExpand Up@@ -620,7 +644,7 @@ void OOMErrorHandler(const char* location, const v8::OOMDetails& details) {
}

fflush(stderr);
ABORT();
ABORT_WITH_DETAILS(location, message);
}

v8::ModifyCodeGenerationFromStringsResult ModifyCodeGenerationFromStrings(
Expand Down
14 changes: 8 additions & 6 deletions src/util.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -126,6 +126,9 @@ void NODE_EXTERN_PRIVATE Assert(const AssertionInfo& info);
void DumpNativeBacktrace(FILE* fp);
void DumpJavaScriptBacktrace(FILE* fp);

// Returns the currently installed abort handler which is never null.
AbortHandler GetAbortHandler();

// Windows 8+ does not like abort() in Release mode
#ifdef _WIN32
#define ABORT_NO_BACKTRACE() _exit(static_cast<int>(node::ExitCode::kAbort))
Expand All@@ -138,13 +141,12 @@ void DumpJavaScriptBacktrace(FILE* fp);
// when generating code for them the compiler can choose not to
// maintain the frame pointers or link registers that are necessary for
// correct backtracing.
// `ABORT` must be a macro and not a [[noreturn]] function to make sure the
// backtrace is correct.
#define ABORT() \
// `ABORT` and `ABORT_WITH_DETAILS` must be a macro and not a [[noreturn]]
// function to make sure the backtrace is correct.
#define ABORT() ABORT_WITH_DETAILS(__FILE__ ":" STRINGIFY(__LINE__), nullptr)
Comment thread
legendecas marked this conversation as resolved.
#define ABORT_WITH_DETAILS(location, message) \
do { \
node::DumpNativeBacktrace(stderr); \
node::DumpJavaScriptBacktrace(stderr); \
fflush(stderr); \
node::GetAbortHandler()(location, message); \
ABORT_NO_BACKTRACE(); \
} while (0)

Expand Down
18 changes: 18 additions & 0 deletions test/addons/abort-handler/binding.cc
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
#include <node.h>
#include <v8.h>
#include <cstdio>

namespace {
void TestAbortHandler(const char* /*location*/, const char* /*message*/) {
fputs("CUSTOM_ABORT_HANDLER_RAN\n", stderr);
fflush(stderr);
}

void InstallAbortHandler(const v8::FunctionCallbackInfo<v8::Value>&) {
node::SetAbortHandler(TestAbortHandler);
}
} // namespace

NODE_MODULE_INIT() {
NODE_SET_METHOD(exports, "installAbortHandler", InstallAbortHandler);
}
9 changes: 9 additions & 0 deletions test/addons/abort-handler/binding.gyp
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
{
'targets': [
{
'target_name': 'binding',
'sources': [ 'binding.cc' ],
'includes': ['../common.gypi'],
}
]
}
45 changes: 45 additions & 0 deletions test/addons/abort-handler/test.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
'use strict';
const common = require('../../common');
const assert = require('assert');
const fs = require('fs');
const path = require('path');
const { exec } = require('child_process');

const bindingPath = path.resolve(
__dirname, 'build', common.buildType, 'binding.node');

if (!fs.existsSync(bindingPath))
common.skip('binding not built yet');

if (process.argv[2] === 'child') {
const binding = require(bindingPath);
binding.installAbortHandler();
process.abort();
return;
}

const escapedArgs =
common.escapePOSIXShell`"${process.execPath}" "${__filename}" child`;
if (!common.isWindows) {
// Do not create core files, as it can take a lot of disk space on
// continuous testing and developers' machines.
escapedArgs[0] = 'ulimit -c 0 && ' + escapedArgs[0];
}

exec(...escapedArgs, common.mustCall((err, stdout, stderr) => {
assert.ok(
stderr.includes('CUSTOM_ABORT_HANDLER_RAN'),
`Expected custom abort handler marker in stderr, got:\n${stderr}`);
assert.ok(
!stderr.includes('Native stack trace'),
`Expected the custom handler to replace the default dump, got:\n${stderr}`);

// The child aborts. Whether that surfaces as the SIGABRT signal or as exit
// code 134 depends on shell wrapping: the `ulimit -c 0 && ...` prefix makes
// /bin/sh wait on (rather than exec-replace itself with) the node grandchild,
// so sh reports the aborted grandchild as a normal exit with code 134.
// common.nodeProcessAborted() accepts both forms.
assert.ok(
err && common.nodeProcessAborted(err.code, err.signal),
`Expected the child to abort, got code=${err?.code} signal=${err?.signal}`);
}));
54 changes: 54 additions & 0 deletions test/cctest/test_environment.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -1201,3 +1201,57 @@ TEST_F(EnvironmentTest, LoadEnvironmentWithCallbackWithESModule) {
printf("Frame: %s\n", *frame_str);
EXPECT_EQ(frame_str.ToString(), " at embedded:esm.mjs:3:15");
}

namespace {
void CustomAbortHandlerForContractTest(const char* location,
const char* message) {}

bool abort_handler_dispatch_flag = false;
const char* abort_handler_received_location = nullptr;
const char* abort_handler_received_message = nullptr;
void AbortHandlerThatSetsDispatchFlag(const char* location,
const char* message) {
abort_handler_dispatch_flag = true;
abort_handler_received_location = location;
abort_handler_received_message = message;
}
} // namespace

TEST(AbortHandlerTest, DefaultIsNonNullAndSetAbortHandlerRoundTrips) {
node::AbortHandler old = node::GetAbortHandler();

// There should always be a non-null default handler installed.
EXPECT_NE(node::GetAbortHandler(), nullptr);

node::SetAbortHandler(CustomAbortHandlerForContractTest);
EXPECT_EQ(node::GetAbortHandler(), CustomAbortHandlerForContractTest);

node::SetAbortHandler(nullptr);
EXPECT_NE(node::GetAbortHandler(), nullptr);
EXPECT_NE(node::GetAbortHandler(), CustomAbortHandlerForContractTest);

node::SetAbortHandler(old);
}

TEST(AbortHandlerTest, InstalledHandlerIsInvokedWhenCalled) {
node::AbortHandler old = node::GetAbortHandler();
abort_handler_dispatch_flag = false;
abort_handler_received_location = nullptr;
abort_handler_received_message = nullptr;

node::SetAbortHandler(AbortHandlerThatSetsDispatchFlag);
node::AbortHandler h = node::GetAbortHandler();
// Fail cleanly (instead of crashing on a null call) if the handler wasn't
// actually installed.
ASSERT_NE(h, nullptr);

// Dispatch through the public GetAbortHandler() accessor directly (not via
// the ABORT() macro, so nothing terminates), and verify the message is
// passed through unchanged.
node::GetAbortHandler()("some-test-location", "some-test-message");
EXPECT_TRUE(abort_handler_dispatch_flag);
EXPECT_STREQ(abort_handler_received_location, "some-test-location");
EXPECT_STREQ(abort_handler_received_message, "some-test-message");

node::SetAbortHandler(old);
}
, '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
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions src/node.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -844,6 +844,16 @@ NODE_EXTERN void SetProcessExitHandler(
std::function<void(Environment*, int)>&& handler);
NODE_EXTERN void DefaultProcessExitHandler(Environment* env, int exit_code);

// Sets a process-global handler invoked when Node.js programmatically aborts.
// Nullable strings representing the location and reason for the abort may or
// may not be passed as a parameter to the handler. The handler should not
// return, but node will ensure that the process exits after the handler is
// called regardless of whether or not it returns. Passing nullptr restores the
// default handler. This is process-global and may be invoked before any Isolate
// or Environment exists.
using AbortHandler = void (*)(const char* location, const char* message);
NODE_EXTERN void SetAbortHandler(AbortHandler handler);

// This may return nullptr if context is not associated with a Node instance.
NODE_EXTERN Environment* GetCurrentEnvironment(v8::Local<v8::Context> context);
NODE_EXTERN IsolateData* GetEnvironmentIsolateData(Environment* env);
Expand Down
30 changes: 27 additions & 3 deletions src/node_errors.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -393,6 +393,30 @@ void AppendExceptionLine(Environment* env,
.FromMaybe(false));
}

namespace {
// Default handler: Dumps native + JS backtraces to stderr and exits. This
// indirectly calls backtrace so it can not be marked as [[noreturn]] (see the
// comment on node::Assert() below). `message` and `location` are ignored
// because the assertion/fatal-error message, if any, is already printed to
// stderr by the caller (Assert()/OnFatalError()) before this handler runs.
void DefaultAbortHandler(const char* /*location*/, const char* /*message*/) {
DumpNativeBacktrace(stderr);
DumpJavaScriptBacktrace(stderr);
fflush(stderr);
ABORT_NO_BACKTRACE();
}
// Constant-initialized, so this is valid from load time, safe even for a
// CHECK() during early startup, before any SetAbortHandler call.
AbortHandler g_abort_handler = DefaultAbortHandler;
} // namespace

void SetAbortHandler(AbortHandler handler) {
g_abort_handler = handler ? handler : DefaultAbortHandler;
}
AbortHandler GetAbortHandler() {
return g_abort_handler;
}

void Assert(const AssertionInfo& info) {
std::string name = GetHumanReadableProcessName();

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

fflush(stderr);
ABORT();
ABORT_WITH_DETAILS(info.file_line, info.message);
}

enum class EnhanceFatalException { kEnhance, kDontEnhance };
Expand DownExpand Up@@ -584,7 +608,7 @@ static void ReportFatalException(Environment* env,
}

fflush(stderr);
ABORT();
ABORT_WITH_DETAILS(location, message);
}

void OOMErrorHandler(const char* location, const v8::OOMDetails& details) {
Expand DownExpand Up@@ -620,7 +644,7 @@ void OOMErrorHandler(const char* location, const v8::OOMDetails& details) {
}

fflush(stderr);
ABORT();
ABORT_WITH_DETAILS(location, message);
}

v8::ModifyCodeGenerationFromStringsResult ModifyCodeGenerationFromStrings(
Expand Down
14 changes: 8 additions & 6 deletions src/util.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -126,6 +126,9 @@ void NODE_EXTERN_PRIVATE Assert(const AssertionInfo& info);
void DumpNativeBacktrace(FILE* fp);
void DumpJavaScriptBacktrace(FILE* fp);

// Returns the currently installed abort handler which is never null.
AbortHandler GetAbortHandler();

// Windows 8+ does not like abort() in Release mode
#ifdef _WIN32
#define ABORT_NO_BACKTRACE() _exit(static_cast<int>(node::ExitCode::kAbort))
Expand All@@ -138,13 +141,12 @@ void DumpJavaScriptBacktrace(FILE* fp);
// when generating code for them the compiler can choose not to
// maintain the frame pointers or link registers that are necessary for
// correct backtracing.
// `ABORT` must be a macro and not a [[noreturn]] function to make sure the
// backtrace is correct.
#define ABORT() \
// `ABORT` and `ABORT_WITH_DETAILS` must be a macro and not a [[noreturn]]
// function to make sure the backtrace is correct.
#define ABORT() ABORT_WITH_DETAILS(__FILE__ ":" STRINGIFY(__LINE__), nullptr)
Comment thread
legendecas marked this conversation as resolved.
#define ABORT_WITH_DETAILS(location, message) \
do { \
node::DumpNativeBacktrace(stderr); \
node::DumpJavaScriptBacktrace(stderr); \
fflush(stderr); \
node::GetAbortHandler()(location, message); \
ABORT_NO_BACKTRACE(); \
} while (0)

Expand Down
18 changes: 18 additions & 0 deletions test/addons/abort-handler/binding.cc
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
#include <node.h>
#include <v8.h>
#include <cstdio>

namespace {
void TestAbortHandler(const char* /*location*/, const char* /*message*/) {
fputs("CUSTOM_ABORT_HANDLER_RAN\n", stderr);
fflush(stderr);
}

void InstallAbortHandler(const v8::FunctionCallbackInfo<v8::Value>&) {
node::SetAbortHandler(TestAbortHandler);
}
} // namespace

NODE_MODULE_INIT() {
NODE_SET_METHOD(exports, "installAbortHandler", InstallAbortHandler);
}
9 changes: 9 additions & 0 deletions test/addons/abort-handler/binding.gyp
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
{
'targets': [
{
'target_name': 'binding',
'sources': [ 'binding.cc' ],
'includes': ['../common.gypi'],
}
]
}
45 changes: 45 additions & 0 deletions test/addons/abort-handler/test.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
'use strict';
const common = require('../../common');
const assert = require('assert');
const fs = require('fs');
const path = require('path');
const { exec } = require('child_process');

const bindingPath = path.resolve(
__dirname, 'build', common.buildType, 'binding.node');

if (!fs.existsSync(bindingPath))
common.skip('binding not built yet');

if (process.argv[2] === 'child') {
const binding = require(bindingPath);
binding.installAbortHandler();
process.abort();
return;
}

const escapedArgs =
common.escapePOSIXShell`"${process.execPath}" "${__filename}" child`;
if (!common.isWindows) {
// Do not create core files, as it can take a lot of disk space on
// continuous testing and developers' machines.
escapedArgs[0] = 'ulimit -c 0 && ' + escapedArgs[0];
}

exec(...escapedArgs, common.mustCall((err, stdout, stderr) => {
assert.ok(
stderr.includes('CUSTOM_ABORT_HANDLER_RAN'),
`Expected custom abort handler marker in stderr, got:\n${stderr}`);
assert.ok(
!stderr.includes('Native stack trace'),
`Expected the custom handler to replace the default dump, got:\n${stderr}`);

// The child aborts. Whether that surfaces as the SIGABRT signal or as exit
// code 134 depends on shell wrapping: the `ulimit -c 0 && ...` prefix makes
// /bin/sh wait on (rather than exec-replace itself with) the node grandchild,
// so sh reports the aborted grandchild as a normal exit with code 134.
// common.nodeProcessAborted() accepts both forms.
assert.ok(
err && common.nodeProcessAborted(err.code, err.signal),
`Expected the child to abort, got code=${err?.code} signal=${err?.signal}`);
}));
54 changes: 54 additions & 0 deletions test/cctest/test_environment.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -1201,3 +1201,57 @@ TEST_F(EnvironmentTest, LoadEnvironmentWithCallbackWithESModule) {
printf("Frame: %s\n", *frame_str);
EXPECT_EQ(frame_str.ToString(), " at embedded:esm.mjs:3:15");
}

namespace {
void CustomAbortHandlerForContractTest(const char* location,
const char* message) {}

bool abort_handler_dispatch_flag = false;
const char* abort_handler_received_location = nullptr;
const char* abort_handler_received_message = nullptr;
void AbortHandlerThatSetsDispatchFlag(const char* location,
const char* message) {
abort_handler_dispatch_flag = true;
abort_handler_received_location = location;
abort_handler_received_message = message;
}
} // namespace

TEST(AbortHandlerTest, DefaultIsNonNullAndSetAbortHandlerRoundTrips) {
node::AbortHandler old = node::GetAbortHandler();

// There should always be a non-null default handler installed.
EXPECT_NE(node::GetAbortHandler(), nullptr);

node::SetAbortHandler(CustomAbortHandlerForContractTest);
EXPECT_EQ(node::GetAbortHandler(), CustomAbortHandlerForContractTest);

node::SetAbortHandler(nullptr);
EXPECT_NE(node::GetAbortHandler(), nullptr);
EXPECT_NE(node::GetAbortHandler(), CustomAbortHandlerForContractTest);

node::SetAbortHandler(old);
}

TEST(AbortHandlerTest, InstalledHandlerIsInvokedWhenCalled) {
node::AbortHandler old = node::GetAbortHandler();
abort_handler_dispatch_flag = false;
abort_handler_received_location = nullptr;
abort_handler_received_message = nullptr;

node::SetAbortHandler(AbortHandlerThatSetsDispatchFlag);
node::AbortHandler h = node::GetAbortHandler();
// Fail cleanly (instead of crashing on a null call) if the handler wasn't
// actually installed.
ASSERT_NE(h, nullptr);

// Dispatch through the public GetAbortHandler() accessor directly (not via
// the ABORT() macro, so nothing terminates), and verify the message is
// passed through unchanged.
node::GetAbortHandler()("some-test-location", "some-test-message");
EXPECT_TRUE(abort_handler_dispatch_flag);
EXPECT_STREQ(abort_handler_received_location, "some-test-location");
EXPECT_STREQ(abort_handler_received_message, "some-test-message");

node::SetAbortHandler(old);
}