node-oom-heapdump 3.1.0 → 3.2.1

package/CHANGELOG.md

@@ -1,4 +1,9 @@
-26-10-2023 Paul Rütter
+27-10-2023 Paul Rütter
+- 3.2.0
+- https://github.com/blueconic/node-oom-heapdump/issues/31: Node20 support
+- Change native code to use different method signature for Node20 and above, remain compatible for Node18 and below.
+
+26-10-2023 Paul Rütter
 - 3.1.0
 - https://github.com/blueconic/node-oom-heapdump/issues/28: only build prebuilt binaries for > 16.x, as Github Actions no longer supports older versions.
 

package/README.md

@@ -9,6 +9,7 @@ Tested on Node.js 10.x, 11.x, 12.x, 13.x, 14.x, 15.x, 16.x, 17.x and 18.x.
 No support for Node.js < 10.x at the moment in version 3.0.0, use version 2.2.0 for if needed.  
 
 Also comes with prebuilt binaries (hosted on Github releases), thanks to Stuart Miller (https://github.com/spmiller).
+From 3.1.0, prebuilt binaries are only shipped for Node.js 16.x and upwards.
 
 ## Node.js 14.18.x
 https://github.com/nodejs/node/pull/33010 landed in Node.js 14.18.0, which makes this module no longer needed for heapdumps on out of memory.

package/build/binding.sln

@@ -4,14 +4,14 @@ Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "node_oom_heapdump_native",
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
-		Release|x64 = Release|x64
 		Debug|x64 = Debug|x64
+		Release|x64 = Release|x64
 	EndGlobalSection
 	GlobalSection(ProjectConfigurationPlatforms) = postSolution
-		{B44BD8E7-8AB3-68F6-9D96-154D16CEC9C0}.Release|x64.ActiveCfg = Release|x64
-		{B44BD8E7-8AB3-68F6-9D96-154D16CEC9C0}.Release|x64.Build.0 = Release|x64
 		{B44BD8E7-8AB3-68F6-9D96-154D16CEC9C0}.Debug|x64.ActiveCfg = Debug|x64
 		{B44BD8E7-8AB3-68F6-9D96-154D16CEC9C0}.Debug|x64.Build.0 = Debug|x64
+		{B44BD8E7-8AB3-68F6-9D96-154D16CEC9C0}.Release|x64.ActiveCfg = Release|x64
+		{B44BD8E7-8AB3-68F6-9D96-154D16CEC9C0}.Release|x64.Build.0 = Release|x64
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE

package/build/node_oom_heapdump_native.vcxproj

@@ -48,7 +48,7 @@
   </PropertyGroup>
   <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
     <ClCompile>
-      <AdditionalIncludeDirectories>C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\18.16.1\include\node;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\18.16.1\src;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\18.16.1\deps\openssl\config;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\18.16.1\deps\openssl\openssl\include;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\18.16.1\deps\uv\include;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\18.16.1\deps\zlib;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\18.16.1\deps\v8\include;..\node_modules\nan;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
+      <AdditionalIncludeDirectories>C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\20.9.0\include\node;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\20.9.0\src;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\20.9.0\deps\openssl\config;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\20.9.0\deps\openssl\openssl\include;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\20.9.0\deps\uv\include;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\20.9.0\deps\zlib;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\20.9.0\deps\v8\include;..\node_modules\nan;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
       <AdditionalOptions>/Zc:__cplusplus -std:c++17 %(AdditionalOptions)</AdditionalOptions>
       <BasicRuntimeChecks>EnableFastChecks</BasicRuntimeChecks>
       <BufferSecurityCheck>true</BufferSecurityCheck>
@@ -72,7 +72,7 @@
       <AdditionalOptions>/LTCG:INCREMENTAL %(AdditionalOptions)</AdditionalOptions>
     </Lib>
     <Link>
-      <AdditionalDependencies>kernel32.lib;user32.lib;gdi32.lib;winspool.lib;comdlg32.lib;advapi32.lib;shell32.lib;ole32.lib;oleaut32.lib;uuid.lib;odbc32.lib;DelayImp.lib;&quot;C:\\Users\\paul.BLUECONIC\\AppData\\Local\\node-gyp\\Cache\\18.16.1\\x64\\node.lib&quot;</AdditionalDependencies>
+      <AdditionalDependencies>kernel32.lib;user32.lib;gdi32.lib;winspool.lib;comdlg32.lib;advapi32.lib;shell32.lib;ole32.lib;oleaut32.lib;uuid.lib;odbc32.lib;DelayImp.lib;&quot;C:\\Users\\paul.BLUECONIC\\AppData\\Local\\node-gyp\\Cache\\20.9.0\\x64\\node.lib&quot;</AdditionalDependencies>
       <AdditionalOptions>/LTCG:INCREMENTAL %(AdditionalOptions)</AdditionalOptions>
       <EnableCOMDATFolding>true</EnableCOMDATFolding>
       <GenerateDebugInformation>true</GenerateDebugInformation>
@@ -83,13 +83,13 @@
       <TargetMachine>MachineX64</TargetMachine>
     </Link>
     <ResourceCompile>
-      <AdditionalIncludeDirectories>C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\18.16.1\include\node;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\18.16.1\src;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\18.16.1\deps\openssl\config;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\18.16.1\deps\openssl\openssl\include;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\18.16.1\deps\uv\include;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\18.16.1\deps\zlib;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\18.16.1\deps\v8\include;..\node_modules\nan;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
+      <AdditionalIncludeDirectories>C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\20.9.0\include\node;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\20.9.0\src;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\20.9.0\deps\openssl\config;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\20.9.0\deps\openssl\openssl\include;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\20.9.0\deps\uv\include;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\20.9.0\deps\zlib;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\20.9.0\deps\v8\include;..\node_modules\nan;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
       <PreprocessorDefinitions>NODE_GYP_MODULE_NAME=node_oom_heapdump_native;USING_UV_SHARED=1;USING_V8_SHARED=1;V8_DEPRECATION_WARNINGS=1;V8_DEPRECATION_WARNINGS;V8_IMMINENT_DEPRECATION_WARNINGS;_GLIBCXX_USE_CXX11_ABI=1;WIN32;_CRT_SECURE_NO_DEPRECATE;_CRT_NONSTDC_NO_DEPRECATE;_HAS_EXCEPTIONS=0;OPENSSL_NO_PINSHARED;OPENSSL_THREADS;BUILDING_NODE_EXTENSION;DEBUG;_DEBUG;V8_ENABLE_CHECKS;%(PreprocessorDefinitions);%(PreprocessorDefinitions)</PreprocessorDefinitions>
     </ResourceCompile>
   </ItemDefinitionGroup>
   <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
     <ClCompile>
-      <AdditionalIncludeDirectories>C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\18.16.1\include\node;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\18.16.1\src;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\18.16.1\deps\openssl\config;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\18.16.1\deps\openssl\openssl\include;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\18.16.1\deps\uv\include;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\18.16.1\deps\zlib;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\18.16.1\deps\v8\include;..\node_modules\nan;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
+      <AdditionalIncludeDirectories>C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\20.9.0\include\node;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\20.9.0\src;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\20.9.0\deps\openssl\config;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\20.9.0\deps\openssl\openssl\include;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\20.9.0\deps\uv\include;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\20.9.0\deps\zlib;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\20.9.0\deps\v8\include;..\node_modules\nan;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
       <AdditionalOptions>/Zc:__cplusplus -std:c++17 %(AdditionalOptions)</AdditionalOptions>
       <BufferSecurityCheck>true</BufferSecurityCheck>
       <DebugInformationFormat>OldStyle</DebugInformationFormat>
@@ -116,7 +116,7 @@
       <AdditionalOptions>/LTCG:INCREMENTAL %(AdditionalOptions)</AdditionalOptions>
     </Lib>
     <Link>
-      <AdditionalDependencies>kernel32.lib;user32.lib;gdi32.lib;winspool.lib;comdlg32.lib;advapi32.lib;shell32.lib;ole32.lib;oleaut32.lib;uuid.lib;odbc32.lib;DelayImp.lib;&quot;C:\\Users\\paul.BLUECONIC\\AppData\\Local\\node-gyp\\Cache\\18.16.1\\x64\\node.lib&quot;</AdditionalDependencies>
+      <AdditionalDependencies>kernel32.lib;user32.lib;gdi32.lib;winspool.lib;comdlg32.lib;advapi32.lib;shell32.lib;ole32.lib;oleaut32.lib;uuid.lib;odbc32.lib;DelayImp.lib;&quot;C:\\Users\\paul.BLUECONIC\\AppData\\Local\\node-gyp\\Cache\\20.9.0\\x64\\node.lib&quot;</AdditionalDependencies>
       <AdditionalOptions>/LTCG:INCREMENTAL %(AdditionalOptions)</AdditionalOptions>
       <EnableCOMDATFolding>true</EnableCOMDATFolding>
       <GenerateDebugInformation>true</GenerateDebugInformation>
@@ -127,7 +127,7 @@
       <TargetMachine>MachineX64</TargetMachine>
     </Link>
     <ResourceCompile>
-      <AdditionalIncludeDirectories>C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\18.16.1\include\node;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\18.16.1\src;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\18.16.1\deps\openssl\config;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\18.16.1\deps\openssl\openssl\include;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\18.16.1\deps\uv\include;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\18.16.1\deps\zlib;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\18.16.1\deps\v8\include;..\node_modules\nan;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
+      <AdditionalIncludeDirectories>C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\20.9.0\include\node;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\20.9.0\src;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\20.9.0\deps\openssl\config;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\20.9.0\deps\openssl\openssl\include;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\20.9.0\deps\uv\include;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\20.9.0\deps\zlib;C:\Users\paul.BLUECONIC\AppData\Local\node-gyp\Cache\20.9.0\deps\v8\include;..\node_modules\nan;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
       <PreprocessorDefinitions>NODE_GYP_MODULE_NAME=node_oom_heapdump_native;USING_UV_SHARED=1;USING_V8_SHARED=1;V8_DEPRECATION_WARNINGS=1;V8_DEPRECATION_WARNINGS;V8_IMMINENT_DEPRECATION_WARNINGS;_GLIBCXX_USE_CXX11_ABI=1;WIN32;_CRT_SECURE_NO_DEPRECATE;_CRT_NONSTDC_NO_DEPRECATE;_HAS_EXCEPTIONS=0;OPENSSL_NO_PINSHARED;OPENSSL_THREADS;BUILDING_NODE_EXTENSION;%(PreprocessorDefinitions);%(PreprocessorDefinitions)</PreprocessorDefinitions>
     </ResourceCompile>
   </ItemDefinitionGroup>

package/lib/node_oom_heapdump_native.cc

@@ -2,10 +2,10 @@
 #include <v8-profiler.h>
 #include <stdlib.h>
 #if defined(_WIN32)
-  #include <time.h>
-  #define snprintf _snprintf
+#include <time.h>
+#define snprintf _snprintf
 #else
-  #include <sys/time.h>
+#include <sys/time.h>
 #endif
 
 using namespace v8;
@@ -14,47 +14,54 @@ char filename[256];
 bool addTimestamp;
 bool processingOOM = false;
 
-class FileOutputStream: public OutputStream {
-  public:
-    FileOutputStream(FILE* stream): stream_(stream) { }
-    virtual int GetChunkSize() {
-      return 65536;
-    }
-    virtual void EndOfStream() { }
-    virtual WriteResult WriteAsciiChunk(char* data, int size) {
-      const size_t len = static_cast<size_t>(size);
-      size_t off = 0;
-      while (off < len && !feof(stream_) && !ferror(stream_))
-        off += fwrite(data + off, 1, len - off, stream_);
-      return off == len ? kContinue : kAbort;
-    }
-
-  private:
-    FILE* stream_;
+class FileOutputStream : public OutputStream
+{
+public:
+  FileOutputStream(FILE *stream) : stream_(stream) {}
+  virtual int GetChunkSize()
+  {
+    return 65536;
+  }
+  virtual void EndOfStream() {}
+  virtual WriteResult WriteAsciiChunk(char *data, int size)
+  {
+    const size_t len = static_cast<size_t>(size);
+    size_t off = 0;
+    while (off < len && !feof(stream_) && !ferror(stream_))
+      off += fwrite(data + off, 1, len - off, stream_);
+    return off == len ? kContinue : kAbort;
+  }
+
+private:
+  FILE *stream_;
 };
 
-size_t RaiseLimit(void* data, size_t current_heap_limit, size_t initial_heap_limit) {
+size_t RaiseLimit(void *data, size_t current_heap_limit, size_t initial_heap_limit)
+{
   return current_heap_limit + 10u * 1024 * 1024; // 10MiB
 }
 
-void OnOOMError(const char *location, bool is_heap_oom) {
-  if (processingOOM) {
+void OnOOMErrorHandler()
+{
+  if (processingOOM)
+  {
     fprintf(stderr, "FATAL: OnOOMError called more than once.\n");
     exit(2);
   }
   processingOOM = true;
 
-  if (addTimestamp) {
+  if (addTimestamp)
+  {
     // Add timestamp to filename
     time_t rawtime;
-    struct tm* timeinfo;
+    struct tm *timeinfo;
     time(&rawtime);
     timeinfo = localtime(&rawtime);
 
-    char * pch;
-    pch = strstr (filename,".heapsnapshot");
-    strncpy (pch,"",1);
-    strcat (filename, "-%Y%m%dT%H%M%S.heapsnapshot");
+    char *pch;
+    pch = strstr(filename, ".heapsnapshot");
+    strncpy(pch, "", 1);
+    strcat(filename, "-%Y%m%dT%H%M%S.heapsnapshot");
 
     char newFilename[256];
     strftime(newFilename, sizeof(filename), filename, timeinfo);
@@ -62,10 +69,11 @@ void OnOOMError(const char *location, bool is_heap_oom) {
   }
 
   fprintf(stderr, "Generating Heapdump to '%s' now...\n", filename);
-  FILE* fp = fopen(filename, "w");
-  if (fp == NULL) abort();
+  FILE *fp = fopen(filename, "w");
+  if (fp == NULL)
+    abort();
 
-  auto* isolate = v8::Isolate::GetCurrent();
+  auto *isolate = v8::Isolate::GetCurrent();
 
   // Capturing a heap snapshot forces a garbage collection which can, in turn,
   // trigger the OOM flow which causes recursion. To prevent this, this callback
@@ -76,7 +84,7 @@ void OnOOMError(const char *location, bool is_heap_oom) {
 
   // Create heapdump, depending on which Node.js version this can differ
   // for now, just support Node.js 7 and higher
-  const HeapSnapshot* snap = isolate->GetHeapProfiler()->TakeHeapSnapshot();
+  const HeapSnapshot *snap = isolate->GetHeapProfiler()->TakeHeapSnapshot();
 
   FileOutputStream stream(fp);
   snap->Serialize(&stream, HeapSnapshot::kJSON);
@@ -86,33 +94,55 @@ void OnOOMError(const char *location, bool is_heap_oom) {
   exit(1);
 }
 
-void ParseArgumentsAndSetErrorHandler(const FunctionCallbackInfo<Value>& args) {
-  Isolate* isolate = args.GetIsolate();
-  isolate->SetOOMErrorHandler(OnOOMError);
+#if NODE_VERSION_AT_LEAST(20, 0, 0)
+void OnOOMErrorNode20(const char *location, const OOMDetails &details)
+{
+  // Node20+
+  OnOOMErrorHandler();
+}
+#else
+void OnOOMErrorNode18(const char *location, bool is_heap_oom)
+{
+  // Up until Node18
+  OnOOMErrorHandler();
+}
+#endif
+
+void ParseArgumentsAndSetErrorHandler(const FunctionCallbackInfo<Value> &args)
+{
+  Isolate *isolate = args.GetIsolate();
+#if NODE_VERSION_AT_LEAST(20, 0, 0)
+  // Node20+
+  isolate->SetOOMErrorHandler(OnOOMErrorNode20);
+#else
+  // Up until Node18
+  isolate->SetOOMErrorHandler(OnOOMErrorNode18);
+#endif
 
-  // parse JS arguments
-  // 1: filename
-  // 2: addTimestamp boolean
-  #if NODE_VERSION_AT_LEAST(13, 0, 0)
+// parse JS arguments
+// 1: filename
+// 2: addTimestamp boolean
+#if NODE_VERSION_AT_LEAST(13, 0, 0)
   Local<Context> context = isolate->GetCurrentContext();
   String::Utf8Value fArg(isolate, args[0]->ToString(context).ToLocalChecked());
-  #elif NODE_VERSION_AT_LEAST(12, 0, 0)
+#elif NODE_VERSION_AT_LEAST(12, 0, 0)
   String::Utf8Value fArg(isolate, args[0]->ToString(isolate));
-  #elif NODE_VERSION_AT_LEAST(9, 0, 0)
+#elif NODE_VERSION_AT_LEAST(9, 0, 0)
   String::Utf8Value fArg(isolate, args[0]->ToString());
-  #else
+#else
   String::Utf8Value fArg(args[0]->ToString());
-  #endif
-  strncpy(filename, (const char*)(*fArg), sizeof(filename) - 1);
+#endif
+  strncpy(filename, (const char *)(*fArg), sizeof(filename) - 1);
 
-  #if NODE_VERSION_AT_LEAST(12, 0, 0)
+#if NODE_VERSION_AT_LEAST(12, 0, 0)
   addTimestamp = args[1]->BooleanValue(isolate);
-  #else
+#else
   addTimestamp = args[1]->BooleanValue();
-  #endif
+#endif
 }
 
-void init(Local<Object> exports) {
+void init(Local<Object> exports)
+{
   NODE_SET_METHOD(exports, "call", ParseArgumentsAndSetErrorHandler);
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-oom-heapdump",
-  "version": "3.1.0",
+  "version": "3.2.1",
   "description": "Create a V8 heap snapshot when an \"Out of Memory\" error occurs, or create a heap snapshot or CPU profile on request.",
   "main": "index.js",
   "scripts": {