process: add custom dir support for heapsnapshot-signal

PR-URL: #47854 Refs: #47842 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Joyee Cheung <[email protected]> Reviewed-By: Erick Wendel <[email protected]>

Author: MrJithil

lib/internal/process/pre_execution.js

@@ -2,15 +2,23 @@
 
 const{
  ArrayPrototypeForEach,
+ Date,
+ DatePrototypeGetDate,
+ DatePrototypeGetFullYear,
+ DatePrototypeGetHours,
+ DatePrototypeGetMinutes,
+ DatePrototypeGetMonth,
+ DatePrototypeGetSeconds,
  NumberParseInt,
  ObjectDefineProperties,
  ObjectDefineProperty,
  ObjectGetOwnPropertyDescriptor,
  SafeMap,
+ String,
  StringPrototypeStartsWith,
  Symbol,
- SymbolDispose,
  SymbolAsyncDispose,
+ SymbolDispose,
  globalThis,
 }=primordials;
 
@@ -400,6 +408,7 @@ function initializeReportSignalHandlers(){
 
 functioninitializeHeapSnapshotSignalHandlers(){
 constsignal=getOptionValue('--heapsnapshot-signal');
+constdiagnosticDir=getOptionValue('--diagnostic-dir');
 
 if(!signal)
 return;
@@ -408,7 +417,8 @@ function initializeHeapSnapshotSignalHandlers(){
 const{ writeHeapSnapshot }=require('v8');
 
 functiondoWriteHeapSnapshot(){
-writeHeapSnapshot();
+constheapSnapshotFilename=getHeapSnapshotFilename(diagnosticDir);
+writeHeapSnapshot(heapSnapshotFilename);
 }
 process.on(signal,doWriteHeapSnapshot);
 
@@ -700,6 +710,31 @@ function markBootstrapComplete(){
 internalBinding('performance').markBootstrapComplete();
 }
 
+// Sequence number for diagnostic filenames
+letsequenceNumOfheapSnapshot=0;
+
+// To generate the HeapSnapshotFilename while using custom diagnosticDir
+functiongetHeapSnapshotFilename(diagnosticDir){
+if(!diagnosticDir)returnundefined;
+
+constdate=newDate();
+
+constyear=DatePrototypeGetFullYear(date);
+constmonth=String(DatePrototypeGetMonth(date)+1).padStart(2,'0');
+constday=String(DatePrototypeGetDate(date)).padStart(2,'0');
+consthours=String(DatePrototypeGetHours(date)).padStart(2,'0');
+constminutes=String(DatePrototypeGetMinutes(date)).padStart(2,'0');
+constseconds=String(DatePrototypeGetSeconds(date)).padStart(2,'0');
+
+constdateString=`${year}${month}${day}`;
+consttimeString=`${hours}${minutes}${seconds}`;
+constpid=process.pid;
+constthreadId=internalBinding('worker').threadId;
+constfileSequence=(++sequenceNumOfheapSnapshot).toString().padStart(3,'0');
+
+return`${diagnosticDir}/Heap.${dateString}.${timeString}.${pid}.${threadId}.${fileSequence}.heapsnapshot`;
+}
+
 module.exports={
  setupUserModules,
  prepareMainThreadExecution,

test/sequential/test-heapdump-flag-custom-dir.js

@@ -0,0 +1,50 @@
+'use strict';
+constcommon=require('../common');
+
+
+if(common.isWindows)
+common.skip('test not supported on Windows');
+
+constassert=require('assert');
+
+constvalidateHeapSnapshotFile=()=>{
+constfs=require('fs');
+
+assert.strictEqual(process.listenerCount('SIGUSR2'),1);
+process.kill(process.pid,'SIGUSR2');
+process.kill(process.pid,'SIGUSR2');
+
+// Asynchronously wait for the snapshot. Use an async loop to be a bit more
+// robust in case platform or machine differences throw off the timing.
+(functionvalidate(){
+constfiles=fs.readdirSync(process.cwd());
+
+if(files.length===0)
+returnsetImmediate(validate);
+
+assert.strictEqual(files.length,2);
+
+for(leti=0;i<files.length;i++){
+assert.match(files[i],/^Heap\..+\.heapsnapshot$/);
+
+// Check the file is parsable as JSON
+JSON.parse(fs.readFileSync(files[i]));
+}
+})();
+};
+
+if(process.argv[2]==='child'){
+validateHeapSnapshotFile();
+}else{
+// Modify the timezone. So we can check the file date string still returning correctly.
+process.env.TZ='America/New_York';
+const{ spawnSync }=require('child_process');
+consttmpdir=require('../common/tmpdir');
+
+tmpdir.refresh();
+constargs=['--heapsnapshot-signal','SIGUSR2','--diagnostic-dir',tmpdir.path,__filename,'child'];
+constchild=spawnSync(process.execPath,args,{cwd: tmpdir.path});
+
+assert.strictEqual(child.status,0);
+assert.strictEqual(child.signal,null);
+}