node-pty 1.2.0-beta.11 → 1.2.0-beta.13

package/lib/conpty_console_list_agent.js

@@ -8,7 +8,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 var utils_1 = require("./utils");
-var getConsoleProcessList = utils_1.loadNativeModule('conpty_console_list').module.getConsoleProcessList;
+var getConsoleProcessList = (0, utils_1.loadNativeModule)('conpty_console_list').module.getConsoleProcessList;
 var shellPid = parseInt(process.argv[2], 10);
 var consoleProcessList = [];
 if (shellPid > 0) {

package/lib/index.js

@@ -5,7 +5,11 @@
  * Copyright (c) 2018, Microsoft Corporation (MIT License).
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.native = exports.open = exports.createTerminal = exports.fork = exports.spawn = void 0;
+exports.native = void 0;
+exports.spawn = spawn;
+exports.fork = fork;
+exports.createTerminal = createTerminal;
+exports.open = open;
 var utils_1 = require("./utils");
 var terminalCtor;
 if (process.platform === 'win32') {
@@ -29,24 +33,20 @@ else {
 function spawn(file, args, opt) {
     return new terminalCtor(file, args, opt);
 }
-exports.spawn = spawn;
 /** @deprecated */
 function fork(file, args, opt) {
     return new terminalCtor(file, args, opt);
 }
-exports.fork = fork;
 /** @deprecated */
 function createTerminal(file, args, opt) {
     return new terminalCtor(file, args, opt);
 }
-exports.createTerminal = createTerminal;
 function open(options) {
     return terminalCtor.open(options);
 }
-exports.open = open;
 /**
  * Expose the native API when not Windows, note that this is not public API and
  * could be removed at any time.
  */
-exports.native = (process.platform !== 'win32' ? utils_1.loadNativeModule('pty').module : null);
+exports.native = (process.platform !== 'win32' ? (0, utils_1.loadNativeModule)('pty').module : null);
 //# sourceMappingURL=index.js.map

package/lib/shared/conout.js

@@ -3,9 +3,8 @@
  * Copyright (c) 2020, Microsoft Corporation (MIT License).
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getWorkerPipeName = void 0;
+exports.getWorkerPipeName = getWorkerPipeName;
 function getWorkerPipeName(conoutPipeName) {
-    return conoutPipeName + "-worker";
+    return "".concat(conoutPipeName, "-worker");
 }
-exports.getWorkerPipeName = getWorkerPipeName;
 //# sourceMappingURL=conout.js.map

package/lib/terminal.js

@@ -101,14 +101,14 @@ var Terminal = /** @class */ (function () {
             if (Array.isArray(value)) {
                 value.forEach(function (v, i) {
                     if (typeof v !== type) {
-                        throw new Error(name + "[" + i + "] must be a " + type + " (not a " + typeof v[i] + ")");
+                        throw new Error("".concat(name, "[").concat(i, "] must be a ").concat(type, " (not a ").concat(typeof v[i], ")"));
                     }
                 });
                 return;
             }
         }
         if (typeof value !== type) {
-            throw new Error(name + " must be a " + type + " (not a " + typeof value + ")");
+            throw new Error("".concat(name, " must be a ").concat(type, " (not a ").concat(typeof value, ")"));
         }
     };
     /** See net.Socket.end */

package/lib/unixTerminal.js

@@ -3,10 +3,12 @@ var __extends = (this && this.__extends) || (function () {
     var extendStatics = function (d, b) {
         extendStatics = Object.setPrototypeOf ||
             ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
         return extendStatics(d, b);
     };
     return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
         extendStatics(d, b);
         function __() { this.constructor = d; }
         d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
@@ -24,7 +26,7 @@ var path = require("path");
 var tty = require("tty");
 var terminal_1 = require("./terminal");
 var utils_1 = require("./utils");
-var native = utils_1.loadNativeModule('pty');
+var native = (0, utils_1.loadNativeModule)('pty');
 var pty = native.module;
 var helperPath = native.dir + '/spawn-helper';
 helperPath = path.resolve(__dirname, helperPath);
@@ -52,7 +54,7 @@ var UnixTerminal = /** @class */ (function (_super) {
         _this._rows = opt.rows || terminal_1.DEFAULT_ROWS;
         var uid = (_a = opt.uid) !== null && _a !== void 0 ? _a : -1;
         var gid = (_b = opt.gid) !== null && _b !== void 0 ? _b : -1;
-        var env = utils_1.assign({}, opt.env);
+        var env = (0, utils_1.assign)({}, opt.env);
         if (opt.env === process.env) {
             _this._sanitizeEnv(env);
         }

package/lib/utils.js

@@ -4,7 +4,8 @@
  * Copyright (c) 2018, Microsoft Corporation (MIT License).
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadNativeModule = exports.assign = void 0;
+exports.assign = assign;
+exports.loadNativeModule = loadNativeModule;
 function assign(target) {
     var sources = [];
     for (var _i = 1; _i < arguments.length; _i++) {
@@ -13,10 +14,9 @@ function assign(target) {
     sources.forEach(function (source) { return Object.keys(source).forEach(function (key) { return target[key] = source[key]; }); });
     return target;
 }
-exports.assign = assign;
 function loadNativeModule(name) {
     // Check build, debug, and then prebuilds.
-    var dirs = ['build/Release', 'build/Debug', "prebuilds/" + process.platform + "-" + process.arch];
+    var dirs = ['build/Release', 'build/Debug', "prebuilds/".concat(process.platform, "-").concat(process.arch)];
     // Check relative to the parent dir for unbundled and then the current dir for bundled
     var relative = ['..', '.'];
     var lastError;
@@ -24,16 +24,15 @@ function loadNativeModule(name) {
         var d = dirs_1[_i];
         for (var _a = 0, relative_1 = relative; _a < relative_1.length; _a++) {
             var r = relative_1[_a];
-            var dir = r + "/" + d;
+            var dir = "".concat(r, "/").concat(d);
             try {
-                return { dir: dir, module: require(dir + "/" + name + ".node") };
+                return { dir: dir, module: require("".concat(dir, "/").concat(name, ".node")) };
             }
             catch (e) {
                 lastError = e;
             }
         }
     }
-    throw new Error("Failed to load native module: " + name + ".node, checked: " + dirs.join(', ') + ": " + lastError);
+    throw new Error("Failed to load native module: ".concat(name, ".node, checked: ").concat(dirs.join(', '), ": ").concat(lastError));
 }
-exports.loadNativeModule = loadNativeModule;
 //# sourceMappingURL=utils.js.map

package/lib/windowsConoutConnection.js

@@ -12,12 +12,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
             if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
             if (y = 0, t) op = [op[0] & 2, t.value];
             switch (op[0]) {
@@ -73,10 +73,10 @@ var ConoutConnection = /** @class */ (function () {
             conoutPipeName: _conoutPipeName
         };
         var scriptPath = __dirname.replace('node_modules.asar', 'node_modules.asar.unpacked');
-        this._worker = new worker_threads_1.Worker(path_1.join(scriptPath, 'worker/conoutSocketWorker.js'), { workerData: workerData });
+        this._worker = new worker_threads_1.Worker((0, path_1.join)(scriptPath, 'worker/conoutSocketWorker.js'), { workerData: workerData });
         this._worker.on('message', function (message) {
             switch (message) {
-                case 1 /* READY */:
+                case 1 /* ConoutWorkerMessage.READY */:
                     _this._onReady.fire();
                     return;
                 default:
@@ -98,7 +98,7 @@ var ConoutConnection = /** @class */ (function () {
         this._drainDataAndClose();
     };
     ConoutConnection.prototype.connectSocket = function (socket) {
-        socket.connect(conout_1.getWorkerPipeName(this._conoutPipeName));
+        socket.connect((0, conout_1.getWorkerPipeName)(this._conoutPipeName));
     };
     ConoutConnection.prototype._drainDataAndClose = function () {
         var _this = this;

package/lib/windowsPtyAgent.js

@@ -5,7 +5,8 @@
  * Copyright (c) 2018, Microsoft Corporation (MIT License).
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.argsToCommandLine = exports.WindowsPtyAgent = void 0;
+exports.WindowsPtyAgent = void 0;
+exports.argsToCommandLine = argsToCommandLine;
 var fs = require("fs");
 var path = require("path");
 var child_process_1 = require("child_process");
@@ -24,13 +25,13 @@ var FLUSH_DATA_INTERVAL = 1000;
  */
 var WindowsPtyAgent = /** @class */ (function () {
     function WindowsPtyAgent(file, args, env, cwd, cols, rows, debug, _useConptyDll, conptyInheritCursor) {
-        var _this = this;
         if (_useConptyDll === void 0) { _useConptyDll = false; }
         if (conptyInheritCursor === void 0) { conptyInheritCursor = false; }
+        var _this = this;
         this._useConptyDll = _useConptyDll;
         this._innerPid = 0;
         if (!conptyNative) {
-            conptyNative = utils_1.loadNativeModule('conpty').module;
+            conptyNative = (0, utils_1.loadNativeModule)('conpty').module;
         }
         this._ptyNative = conptyNative;
         // Sanitize input variable.
@@ -160,7 +161,7 @@ var WindowsPtyAgent = /** @class */ (function () {
             return Promise.resolve([]);
         }
         return new Promise(function (resolve) {
-            var agent = child_process_1.fork(path.join(__dirname, 'conpty_console_list_agent'), [_this._innerPid.toString()]);
+            var agent = (0, child_process_1.fork)(path.join(__dirname, 'conpty_console_list_agent'), [_this._innerPid.toString()]);
             agent.on('message', function (message) {
                 clearTimeout(timeout);
                 resolve(message.consoleProcessList);
@@ -180,7 +181,7 @@ var WindowsPtyAgent = /** @class */ (function () {
         configurable: true
     });
     WindowsPtyAgent.prototype._generatePipeName = function () {
-        return "conpty-" + Math.random() * 10000000;
+        return "conpty-".concat(Math.random() * 10000000);
     };
     /**
      * Triggered from the native side when a contpy process exits.
@@ -222,7 +223,7 @@ function argsToCommandLine(file, args) {
         if (args.length === 0) {
             return file;
         }
-        return argsToCommandLine(file, []) + " " + args;
+        return "".concat(argsToCommandLine(file, []), " ").concat(args);
     }
     var argv = [file];
     Array.prototype.push.apply(argv, args);
@@ -270,7 +271,6 @@ function argsToCommandLine(file, args) {
     }
     return result;
 }
-exports.argsToCommandLine = argsToCommandLine;
 function isCommandLine(args) {
     return typeof args === 'string';
 }

package/lib/windowsTerminal.js

@@ -8,10 +8,12 @@ var __extends = (this && this.__extends) || (function () {
     var extendStatics = function (d, b) {
         extendStatics = Object.setPrototypeOf ||
             ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
         return extendStatics(d, b);
     };
     return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
         extendStatics(d, b);
         function __() { this.constructor = d; }
         d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
@@ -37,7 +39,7 @@ var WindowsTerminal = /** @class */ (function (_super) {
         if (opt.encoding) {
             console.warn('Setting encoding on Windows is not supported');
         }
-        var env = utils_1.assign({}, opt.env);
+        var env = (0, utils_1.assign)({}, opt.env);
         _this._cols = opt.cols || terminal_1.DEFAULT_COLS;
         _this._rows = opt.rows || terminal_1.DEFAULT_ROWS;
         var cwd = opt.cwd || process.cwd();

package/lib/worker/conoutSocketWorker.js

@@ -10,13 +10,13 @@ var conoutPipeName = worker_threads_1.workerData.conoutPipeName;
 var conoutSocket = new net_1.Socket();
 conoutSocket.setEncoding('utf8');
 conoutSocket.connect(conoutPipeName, function () {
-    var server = net_1.createServer(function (workerSocket) {
+    var server = (0, net_1.createServer)(function (workerSocket) {
         conoutSocket.pipe(workerSocket);
     });
-    server.listen(conout_1.getWorkerPipeName(conoutPipeName));
+    server.listen((0, conout_1.getWorkerPipeName)(conoutPipeName));
     if (!worker_threads_1.parentPort) {
         throw new Error('worker_threads parentPort is null');
     }
-    worker_threads_1.parentPort.postMessage(1 /* READY */);
+    worker_threads_1.parentPort.postMessage(1 /* ConoutWorkerMessage.READY */);
 });
 //# sourceMappingURL=conoutSocketWorker.js.map

package/package.json

@@ -4,7 +4,7 @@
   "author": {
     "name": "Microsoft Corporation"
   },
-  "version": "1.2.0-beta.11",
+  "version": "1.2.0-beta.13",
   "license": "MIT",
   "main": "./lib/index.js",
   "types": "./typings/node-pty.d.ts",
@@ -38,7 +38,7 @@
   "scripts": {
     "build": "tsc -b ./src/tsconfig.json",
     "watch": "tsc -b -w ./src/tsconfig.json",
-    "lint": "eslint -c .eslintrc.js --ext .ts src/",
+    "lint": "eslint src/",
     "install": "node scripts/prebuild.js || node-gyp rebuild",
     "postinstall": "node scripts/post-install.js",
     "compileCommands": "node scripts/gen-compile-commands.js",
@@ -53,13 +53,13 @@
   "devDependencies": {
     "@types/mocha": "^7.0.2",
     "@types/node": "12",
-    "@typescript-eslint/eslint-plugin": "^2.27.0",
-    "@typescript-eslint/parser": "^2.27.0",
+    "@typescript-eslint/eslint-plugin": "^8.0.0",
+    "@typescript-eslint/parser": "^8.0.0",
     "cross-env": "^5.1.4",
-    "eslint": "^6.8.0",
+    "eslint": "^9.0.0",
     "mocha": "10",
     "node-gyp": "^11.4.2",
     "ps-list": "^6.0.0",
-    "typescript": "^3.8.3"
+    "typescript": "^5.0.0"
   }
 }

package/src/win/conpty.cc

@@ -14,6 +14,8 @@
 #include <node_api.h>
 #include <assert.h>
 #include <Shlwapi.h> // PathCombine, PathIsRelative
+#include <atomic>
+#include <mutex>
 #include <sstream>
 #include <iostream>
 #include <string>
@@ -50,9 +52,12 @@ struct pty_baton {
 };
 
 static std::vector<std::unique_ptr<pty_baton>> ptyHandles;
-static volatile LONG ptyCounter;
+static std::mutex g_ptyHandlesMutex;
+static std::atomic<int> ptyCounter{0};
 
-static pty_baton* get_pty_baton(int id) {
+// The leading scoped-lock parameter encodes the precondition that the caller
+// holds g_ptyHandlesMutex.
+static pty_baton* get_pty_baton(const std::lock_guard<std::mutex>&, int id) {
   auto it = std::find_if(ptyHandles.begin(), ptyHandles.end(), [id](const auto& ptyHandle) {
     return ptyHandle->id == id;
   });
@@ -62,17 +67,6 @@ static pty_baton* get_pty_baton(int id) {
   return nullptr;
 }
 
-static bool remove_pty_baton(int id) {
-  auto it = std::remove_if(ptyHandles.begin(), ptyHandles.end(), [id](const auto& ptyHandle) {
-    return ptyHandle->id == id;
-  });
-  if (it != ptyHandles.end()) {
-    ptyHandles.erase(it);
-    return true;
-  }
-  return false;
-}
-
 struct ExitEvent {
   int exit_code = 0;
 };
@@ -99,11 +93,15 @@ void SetupExitCallback(Napi::Env env, Napi::Function cb, pty_baton* baton) {
     ExitEvent *exit_event = new ExitEvent;
     // Wait for process to complete.
     WaitForSingleObject(baton->hShell, INFINITE);
-    // Get process exit code.
-    GetExitCodeProcess(baton->hShell, (LPDWORD)(&exit_event->exit_code));
-    // Clean up handles
-    CloseHandle(baton->hShell);
-    assert(remove_pty_baton(baton->id));
+    {
+      std::lock_guard<std::mutex> lock(g_ptyHandlesMutex);
+      GetExitCodeProcess(baton->hShell, (LPDWORD)(&exit_event->exit_code));
+      CloseHandle(baton->hShell);
+      const int id = baton->id;
+      std::erase_if(ptyHandles, [id](const auto& ptyHandle) {
+        return ptyHandle->id == id;
+      });
+    }
 
     auto status = tsfn.BlockingCall(exit_event, callback); // In main thread
     switch (status) {
@@ -298,10 +296,13 @@ static Napi::Value PtyStartProcess(const Napi::CallbackInfo& info) {
 
   if (SUCCEEDED(hr)) {
     // We were able to instantiate a conpty
-    const int ptyId = InterlockedIncrement(&ptyCounter);
+    const int ptyId = ++ptyCounter;
     marshal.Set("pty", Napi::Number::New(env, ptyId));
-    ptyHandles.emplace_back(
-        std::make_unique<pty_baton>(ptyId, hIn, hOut, hpc));
+    {
+      std::lock_guard<std::mutex> lock(g_ptyHandlesMutex);
+      ptyHandles.emplace_back(
+          std::make_unique<pty_baton>(ptyId, hIn, hOut, hpc));
+    }
   } else {
     throw Napi::Error::New(env, "Cannot launch conpty");
   }
@@ -349,10 +350,13 @@ static Napi::Value PtyConnect(const Napi::CallbackInfo& info) {
   const bool useConptyDll = info[4].As<Napi::Boolean>().Value();
   Napi::Function exitCallback = info[5].As<Napi::Function>();
 
-  // Fetch pty handle from ID and start process
-  pty_baton* handle = get_pty_baton(id);
-  if (!handle) {
-    throw Napi::Error::New(env, "Invalid pty handle");
+  pty_baton* handle;
+  {
+    std::lock_guard<std::mutex> lock(g_ptyHandlesMutex);
+    handle = get_pty_baton(lock, id);
+    if (!handle) {
+      throw Napi::Error::New(env, "Invalid pty handle");
+    }
   }
 
   // Prepare command line
@@ -471,7 +475,8 @@ static Napi::Value PtyResize(const Napi::CallbackInfo& info) {
   SHORT rows = static_cast<SHORT>(info[2].As<Napi::Number>().Uint32Value());
   const bool useConptyDll = info[3].As<Napi::Boolean>().Value();
 
-  const pty_baton* handle = get_pty_baton(id);
+  std::lock_guard<std::mutex> lock(g_ptyHandlesMutex);
+  const pty_baton* handle = get_pty_baton(lock, id);
 
   if (handle != nullptr) {
     HANDLE hLibrary = LoadConptyDll(info, useConptyDll);
@@ -512,7 +517,8 @@ static Napi::Value PtyClear(const Napi::CallbackInfo& info) {
     return env.Undefined();
   }
 
-  const pty_baton* handle = get_pty_baton(id);
+  std::lock_guard<std::mutex> lock(g_ptyHandlesMutex);
+  const pty_baton* handle = get_pty_baton(lock, id);
 
   if (handle != nullptr) {
     HANDLE hLibrary = LoadConptyDll(info, useConptyDll);
@@ -543,7 +549,8 @@ static Napi::Value PtyKill(const Napi::CallbackInfo& info) {
   int id = info[0].As<Napi::Number>().Int32Value();
   const bool useConptyDll = info[1].As<Napi::Boolean>().Value();
 
-  const pty_baton* handle = get_pty_baton(id);
+  std::lock_guard<std::mutex> lock(g_ptyHandlesMutex);
+  const pty_baton* handle = get_pty_baton(lock, id);
 
   if (handle != nullptr) {
     HANDLE hLibrary = LoadConptyDll(info, useConptyDll);

package/typings/node-pty.d.ts

@@ -12,7 +12,7 @@ declare module 'node-pty' {
    * escaped properly.
    * @param options The options of the terminal.
    * @see CommandLineToArgvW https://msdn.microsoft.com/en-us/library/windows/desktop/bb776391(v=vs.85).aspx
-   * @see Parsing C++ Comamnd-Line Arguments https://msdn.microsoft.com/en-us/library/17w5ykft.aspx
+   * @see Parsing C++ Command-Line Arguments https://msdn.microsoft.com/en-us/library/17w5ykft.aspx
    * @see GetCommandLine https://msdn.microsoft.com/en-us/library/windows/desktop/ms683156.aspx
    */
   export function spawn(file: string, args: string[] | string, options: IPtyForkOptions | IWindowsPtyForkOptions): IPty;