Fix Windows home path: use os.homedir() instead of HOMEPATH/HOMEDRIVE env vars #6106

Author: Unitech

CHANGELOG.md

@@ -23,6 +23,7 @@
 - CVE-2025-5891 Fix ReDoS in Config.js string-to-array split regex #6075
 - Fix [object Object] env vars leaked to fork mode subprocesses #6073
 - Rewrite TreeKill: single ps call + in-memory tree build, eliminates race conditions #6084
+- Fix Windows home path: use os.homedir() instead of HOMEPATH/HOMEDRIVE env vars #6106
 
 ## 6.0.14
 

paths.js

@@ -9,22 +9,19 @@ var p     = require('path');
 var fs    = require('fs')
 
 function getDefaultPM2Home() {
-  var PM2_ROOT_PATH;
-
   if (process.env.PM2_HOME)
-    PM2_ROOT_PATH = process.env.PM2_HOME;
-  else if (process.env.HOME && !process.env.HOMEPATH)
-    PM2_ROOT_PATH = p.resolve(process.env.HOME, '.pm2');
-  else if (process.env.HOME || process.env.HOMEPATH)
-    PM2_ROOT_PATH = p.resolve(process.env.HOMEDRIVE, process.env.HOME || process.env.HOMEPATH, '.pm2');
-  else {
-    console.error('[PM2][Initialization] Environment variable HOME (Linux) or HOMEPATH (Windows) are not set!');
-    console.error('[PM2][Initialization] Defaulting to /etc/.pm2');
-    PM2_ROOT_PATH = p.resolve('/etc', '.pm2');
+    return process.env.PM2_HOME;
+
+  var home = require('os').homedir();
+  if (home) {
+    var resolved = p.resolve(home, '.pm2');
+    debug('pm2 home resolved to %s', resolved);
+    return resolved;
   }
 
-  debug('pm2 home resolved to %s', PM2_ROOT_PATH, process.env.HOME);
-  return PM2_ROOT_PATH;
+  console.error('[PM2][Initialization] Could not determine home directory!');
+  console.error('[PM2][Initialization] Defaulting to /etc/.pm2');
+  return p.resolve('/etc', '.pm2');
 }
 
 module.exports = function(PM2_HOME) {

test/programmatic/issue_6106_windows_home.mocha.js

@@ -0,0 +1,49 @@
+
+process.chdir(__dirname);
+
+var path = require('path');
+var os = require('os');
+var should = require('should');
+var pathsFn = require('../../paths.js');
+
+describe('PM2 Home Path Resolution (#6106)', function () {
+
+  var savedEnv;
+
+  beforeEach(function () {
+    savedEnv = {};
+    ['PM2_HOME', 'HOME', 'HOMEPATH', 'HOMEDRIVE', 'USERPROFILE'].forEach(function (k) {
+      savedEnv[k] = process.env[k];
+    });
+  });
+
+  afterEach(function () {
+    Object.keys(savedEnv).forEach(function (k) {
+      if (savedEnv[k] === undefined) delete process.env[k];
+      else process.env[k] = savedEnv[k];
+    });
+  });
+
+  it('should honor PM2_HOME env var override', function () {
+    process.env.PM2_HOME = '/custom/pm2/home';
+    var paths = pathsFn();
+    paths.PM2_HOME.should.eql('/custom/pm2/home');
+  });
+
+  it('should resolve from os.homedir() by default', function () {
+    delete process.env.PM2_HOME;
+    var paths = pathsFn();
+    paths.PM2_HOME.should.eql(path.resolve(os.homedir(), '.pm2'));
+  });
+
+  it('should resolve correctly when HOME env var is not set (#6106)', function () {
+    delete process.env.PM2_HOME;
+    delete process.env.HOME;
+    delete process.env.HOMEPATH;
+    delete process.env.HOMEDRIVE;
+
+    var paths = pathsFn();
+    paths.PM2_HOME.should.not.eql(path.resolve('/etc', '.pm2'));
+    paths.PM2_HOME.should.eql(path.resolve(os.homedir(), '.pm2'));
+  });
+});

test/unit.sh

@@ -95,6 +95,13 @@ runUnitTest $D/fclone.mocha.js
 
 runUnitTest $D/issues/json_env_passing_4080.mocha.js
 
+runUnitTest $D/issue_6106_windows_home.mocha.js
+runUnitTest $D/issue_6089_prototype_pollution.mocha.js
+runUnitTest $D/issue_6075_redos.mocha.js
+runUnitTest $D/issue_6073_object_env.mocha.js
+runUnitTest $D/treekill.mocha.js
+runUnitTest $D/http_interface.mocha.js
+
 D=test/interface
 
 runUnitTest $D/bus.spec.mocha.js