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

package/README.md

@@ -9,7 +9,9 @@ This is useful for:
 - Writing a terminal emulator (eg. via [xterm.js](https://github.com/sourcelair/xterm.js)).
 - Getting certain programs to *think* you're a terminal, such as when you need a program to send you control sequences.
 
-`node-pty` supports Linux, macOS and Windows. Windows support is possible by utilizing the [Windows conpty API](https://blogs.msdn.microsoft.com/commandline/2018/08/02/windows-command-line-introducing-the-windows-pseudo-console-conpty/) on Windows 1809+ and the [winpty](https://github.com/rprichard/winpty) library in older version.
+`node-pty` supports Linux, macOS and Windows. Windows support is possible by utilizing the [Windows conpty API](https://blogs.msdn.microsoft.com/commandline/2018/08/02/windows-command-line-introducing-the-windows-pseudo-console-conpty/) on Windows 1809+.
+
+> **Note:** Support for the `winpty` library has been removed. Windows 10 version 1809 (build 18309) or later is now required.
 
 ## API
 
@@ -68,6 +70,7 @@ ptyProcess.write('ls\r');
 - [NxShell](https://nxshell.github.io/): An easy to use new terminal for Windows/Linux/MacOS platform.
 - [OpenSumi](https://github.com/opensumi/core): A framework helps you quickly build Cloud or Desktop IDE products.
 - [Enjoy Git](https://github.com/huangcs427/enjoy-git-release): A modern Git client featuring an intuitive user interface, built with Electron, Vue 3, and TypeScript.
+- [Logos](https://github.com/zixiao-labs/logos): A Modern, Lightweight Code Editor, built with Electron, Vue 3, and TypeScript.
 
 Do you use node-pty in your application as well? Please open a [Pull Request](https://github.com/Tyriar/node-pty/pulls) to include it here. We would love to have it in our list.
 
@@ -150,10 +153,6 @@ By default `PAUSE` and `RESUME` are XON/XOFF control codes (as shown above). To
 
 This happens when PowerShell is launched with no `SystemRoot` environment variable present.
 
-### ConnectNamedPipe failed: Windows error 232
-
-This error can occur due to anti-virus software intercepting winpty from creating a pty. To workaround this you can exclude this file from your anti-virus scanning `node-pty\build\Release\winpty-agent.exe`
-
 ## pty.js
 
 This project is forked from [chjj/pty.js](https://github.com/chjj/pty.js) with the primary goals being to provide better support for later Node.js versions and Windows.

package/binding.gyp

@@ -9,23 +9,26 @@
           'SpectreMitigation': 'Spectre'
         },
         'msvs_settings': {
-            'VCCLCompilerTool': {
-              'AdditionalOptions': [
-                '/guard:cf',
-                '/sdl',
-                '/W3',
-                '/w34244',
-                '/w34267',
-                '/ZH:SHA_256'
-              ]
-            },
-            'VCLinkerTool': {
-              'AdditionalOptions': [
-                '/DYNAMICBASE',
-                '/guard:cf'
-              ]
-            }
+          'VCCLCompilerTool': {
+            'AdditionalOptions': [
+              '/guard:cf',
+              '/sdl',
+              '/W3',
+              '/we4146',
+              '/we4244',
+              '/we4267',
+              '/ZH:SHA_256'
+            ]
           },
+          'VCLinkerTool': {
+            'AdditionalOptions': [
+              '/DYNAMICBASE',
+              '/guard:cf'
+            ]
+          }
+        },
+      }, {
+        'cflags': ['-O2', '-fstack-protector-strong'],
       }],
     ],
   },
@@ -47,26 +50,6 @@
           'sources' : [
             'src/win/conpty_console_list.cc'
           ],
-        },
-        {
-          'target_name': 'pty',
-          'include_dirs' : [
-            '<!(node -p "require(\'node-addon-api\').include_dir")',
-            'deps/winpty/src/include',
-          ],
-          # Disabled due to winpty
-          'msvs_disabled_warnings': [ 4506, 4530 ],
-          'dependencies' : [
-            'deps/winpty/src/winpty.gyp:winpty-agent',
-            'deps/winpty/src/winpty.gyp:winpty',
-          ],
-          'sources' : [
-            'src/win/winpty.cc',
-            'src/win/path_util.cc'
-          ],
-          'libraries': [
-            '-lshlwapi'
-          ],
         }
       ]
     }, { # OS!="win"
@@ -79,7 +62,8 @@
           'libraries': [
             '-lutil'
           ],
-          'cflags': ['-Wall', '-O2', '-D_FORTIFY_SOURCE=2'],
+          'cflags': ['-Wall'],
+          'ldflags': [],
           'conditions': [
             # http://www.gnu.org/software/gnulib/manual/html_node/forkpty.html
             #   One some systems (at least including Cygwin, Interix,
@@ -88,6 +72,61 @@
               'libraries!': [
                 '-lutil'
               ]
+            }],
+            ['OS=="linux"', {
+              'variables': {
+                'sysroot%': '<!(node -p "process.env.SYSROOT_PATH || \'\'")',
+                'target_arch%': '<!(node -p "process.env.npm_config_arch || process.arch")',
+              },
+              'conditions': [
+                ['sysroot!=""', {
+                  'variables': {
+                    'gcc_include%': '<!(${CXX:-g++} -print-file-name=include)',
+                  },
+                  'conditions': [
+                    ['target_arch=="x64"', {
+                      'cflags': [
+                        '--sysroot=<(sysroot)',
+                        '-nostdinc',
+                        '-isystem<(gcc_include)',
+                        '-isystem<(sysroot)/usr/include',
+                        '-isystem<(sysroot)/usr/include/x86_64-linux-gnu'
+                      ],
+                      'cflags_cc': [
+                        '-nostdinc++',
+                        '-isystem<(sysroot)/../include/c++/10.5.0',
+                        '-isystem<(sysroot)/../include/c++/10.5.0/x86_64-linux-gnu',
+                        '-isystem<(sysroot)/../include/c++/10.5.0/backward'
+                      ],
+                      'ldflags': [
+                        '--sysroot=<(sysroot)',
+                        '-L<(sysroot)/lib',
+                        '-L<(sysroot)/usr/lib'
+                      ],
+                    }],
+                    ['target_arch=="arm64"', {
+                      'cflags': [
+                        '--sysroot=<(sysroot)',
+                        '-nostdinc',
+                        '-isystem<(gcc_include)',
+                        '-isystem<(sysroot)/usr/include',
+                        '-isystem<(sysroot)/usr/include/aarch64-linux-gnu'
+                      ],
+                      'cflags_cc': [
+                        '-nostdinc++',
+                        '-isystem<(sysroot)/../include/c++/10.5.0',
+                        '-isystem<(sysroot)/../include/c++/10.5.0/aarch64-linux-gnu',
+                        '-isystem<(sysroot)/../include/c++/10.5.0/backward'
+                      ],
+                      'ldflags': [
+                        '--sysroot=<(sysroot)',
+                        '-L<(sysroot)/lib',
+                        '-L<(sysroot)/usr/lib'
+                      ],
+                    }]
+                  ]
+                }]
+              ]
             }]
           ]
         }

package/lib/conpty_console_list_agent.js

@@ -10,7 +10,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var utils_1 = require("./utils");
 var getConsoleProcessList = utils_1.loadNativeModule('conpty_console_list').module.getConsoleProcessList;
 var shellPid = parseInt(process.argv[2], 10);
-var consoleProcessList = getConsoleProcessList(shellPid);
+var consoleProcessList = [];
+if (shellPid > 0) {
+    try {
+        consoleProcessList = getConsoleProcessList(shellPid);
+    }
+    catch (_a) {
+        // AttachConsole can fail if the process already exited or is invalid.
+        consoleProcessList = [];
+    }
+}
 process.send({ consoleProcessList: consoleProcessList });
 process.exit(0);
 //# sourceMappingURL=conpty_console_list_agent.js.map

package/lib/unixTerminal.js

@@ -236,7 +236,7 @@ var UnixTerminal = /** @class */ (function (_super) {
         get: function () {
             if (process.platform === 'darwin') {
                 var title = pty.process(this._fd);
-                return (title !== 'kernel_task') ? title : this._file;
+                return (title !== 'kernel_task' && title !== 'spawn_helper') ? title : this._file;
             }
             return pty.process(this._fd, this._pty) || this._file;
         },
@@ -246,11 +246,14 @@ var UnixTerminal = /** @class */ (function (_super) {
     /**
      * TTY
      */
-    UnixTerminal.prototype.resize = function (cols, rows) {
+    UnixTerminal.prototype.resize = function (cols, rows, pixelSize) {
+        var _a, _b;
         if (cols <= 0 || rows <= 0 || isNaN(cols) || isNaN(rows) || cols === Infinity || rows === Infinity) {
             throw new Error('resizing must be done using positive cols and rows');
         }
-        pty.resize(this._fd, cols, rows);
+        var pixelWidth = (_a = pixelSize === null || pixelSize === void 0 ? void 0 : pixelSize.width) !== null && _a !== void 0 ? _a : 0;
+        var pixelHeight = (_b = pixelSize === null || pixelSize === void 0 ? void 0 : pixelSize.height) !== null && _b !== void 0 ? _b : 0;
+        pty.resize(this._fd, cols, rows, pixelWidth, pixelHeight);
         this._cols = cols;
         this._rows = rows;
     };

package/lib/utils.js

@@ -24,7 +24,7 @@ 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 = r + "/" + d;
             try {
                 return { dir: dir, module: require(dir + "/" + name + ".node") };
             }

package/lib/windowsPtyAgent.js

@@ -7,14 +7,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.argsToCommandLine = exports.WindowsPtyAgent = void 0;
 var fs = require("fs");
-var os = require("os");
 var path = require("path");
 var child_process_1 = require("child_process");
 var net_1 = require("net");
 var windowsConoutConnection_1 = require("./windowsConoutConnection");
 var utils_1 = require("./utils");
 var conptyNative;
-var winptyNative;
 /**
  * The amount of time to wait for additional data after the conpty shell process has exited before
  * shutting down the socket. The timer will be reset if a new data event comes in after the timer
@@ -22,46 +20,25 @@ var winptyNative;
  */
 var FLUSH_DATA_INTERVAL = 1000;
 /**
- * This agent sits between the WindowsTerminal class and provides a common interface for both conpty
- * and winpty.
+ * This agent sits between the WindowsTerminal class and provides an interface for conpty.
  */
 var WindowsPtyAgent = /** @class */ (function () {
-    function WindowsPtyAgent(file, args, env, cwd, cols, rows, debug, _useConpty, _useConptyDll, conptyInheritCursor) {
+    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; }
-        this._useConpty = _useConpty;
         this._useConptyDll = _useConptyDll;
-        this._pid = 0;
         this._innerPid = 0;
-        if (this._useConpty === undefined || this._useConpty === true) {
-            this._useConpty = this._getWindowsBuildNumber() >= 18309;
+        if (!conptyNative) {
+            conptyNative = utils_1.loadNativeModule('conpty').module;
         }
-        if (this._useConpty) {
-            if (!conptyNative) {
-                conptyNative = utils_1.loadNativeModule('conpty').module;
-            }
-        }
-        else {
-            if (!winptyNative) {
-                winptyNative = utils_1.loadNativeModule('pty').module;
-            }
-        }
-        this._ptyNative = this._useConpty ? conptyNative : winptyNative;
+        this._ptyNative = conptyNative;
         // Sanitize input variable.
         cwd = path.resolve(cwd);
         // Compose command line
         var commandLine = argsToCommandLine(file, args);
         // Open pty session.
-        var term;
-        if (this._useConpty) {
-            term = this._ptyNative.startProcess(file, cols, rows, debug, this._generatePipeName(), conptyInheritCursor, this._useConptyDll);
-        }
-        else {
-            term = this._ptyNative.startProcess(file, commandLine, env, cwd, cols, rows, debug);
-            this._pid = term.pid;
-            this._innerPid = term.innerPid;
-        }
+        var term = conptyNative.startProcess(file, cols, rows, debug, this._generatePipeName(), conptyInheritCursor, this._useConptyDll);
         // Not available on windows.
         this._fd = term.fd;
         // Generated incremental number that has no real purpose besides  using it
@@ -71,9 +48,26 @@ var WindowsPtyAgent = /** @class */ (function () {
         this._outSocket = new net_1.Socket();
         this._outSocket.setEncoding('utf8');
         // The conout socket must be ready out on another thread to avoid deadlocks
+        // We must wait for the worker to connect before calling conptyNative.connect()
+        // to avoid blocking the Node.js event loop in ConnectNamedPipe.
+        // See https://github.com/microsoft/node-pty/issues/763
         this._conoutSocketWorker = new windowsConoutConnection_1.ConoutConnection(term.conout, this._useConptyDll);
+        // Store pending connection info - we'll complete the connection when worker is ready
+        this._pendingPtyInfo = { pty: this._pty, commandLine: commandLine, cwd: cwd, env: env };
+        // Timeout to ensure connection completes even if worker fails to signal ready
+        var connectionTimeout = setTimeout(function () {
+            if (_this._pendingPtyInfo) {
+                // Worker never signaled ready - complete connection anyway to avoid zombie state
+                _this._completePtyConnection();
+            }
+        }, 5000);
         this._conoutSocketWorker.onReady(function () {
+            clearTimeout(connectionTimeout);
             _this._conoutSocketWorker.connectSocket(_this._outSocket);
+            // Now that the worker has connected to the output pipe, we can safely call
+            // conptyNative.connect() which calls ConnectNamedPipe - it won't block because
+            // the client (worker) is already connected
+            _this._completePtyConnection();
         });
         this._outSocket.on('connect', function () {
             _this._outSocket.emit('ready_datapipe');
@@ -85,10 +79,6 @@ var WindowsPtyAgent = /** @class */ (function () {
             writable: true
         });
         this._inSocket.setEncoding('utf8');
-        if (this._useConpty) {
-            var connect = this._ptyNative.connect(this._pty, commandLine, cwd, env, this._useConptyDll, function (c) { return _this._$onProcessExit(c); });
-            this._innerPid = connect.pid;
-        }
     }
     Object.defineProperty(WindowsPtyAgent.prototype, "inSocket", {
         get: function () { return this._inSocket; },
@@ -115,71 +105,60 @@ var WindowsPtyAgent = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
-    WindowsPtyAgent.prototype.resize = function (cols, rows) {
-        if (this._useConpty) {
-            if (this._exitCode !== undefined) {
-                throw new Error('Cannot resize a pty that has already exited');
-            }
-            this._ptyNative.resize(this._pty, cols, rows, this._useConptyDll);
+    WindowsPtyAgent.prototype._completePtyConnection = function () {
+        var _this = this;
+        if (!this._pendingPtyInfo) {
             return;
         }
-        this._ptyNative.resize(this._pid, cols, rows);
+        var _a = this._pendingPtyInfo, pty = _a.pty, commandLine = _a.commandLine, cwd = _a.cwd, env = _a.env;
+        this._pendingPtyInfo = undefined;
+        var connect = conptyNative.connect(pty, commandLine, cwd, env, this._useConptyDll, function (c) { return _this._$onProcessExit(c); });
+        this._innerPid = connect.pid;
     };
-    WindowsPtyAgent.prototype.clear = function () {
-        if (this._useConpty) {
-            this._ptyNative.clear(this._pty, this._useConptyDll);
+    WindowsPtyAgent.prototype.resize = function (cols, rows) {
+        if (this._exitCode !== undefined) {
+            throw new Error('Cannot resize a pty that has already exited');
         }
+        this._ptyNative.resize(this._pty, cols, rows, this._useConptyDll);
+    };
+    WindowsPtyAgent.prototype.clear = function () {
+        this._ptyNative.clear(this._pty, this._useConptyDll);
     };
     WindowsPtyAgent.prototype.kill = function () {
         var _this = this;
+        // Prevent deferred connection from completing after kill
+        this._pendingPtyInfo = undefined;
         // Tell the agent to kill the pty, this releases handles to the process
-        if (this._useConpty) {
-            if (!this._useConptyDll) {
-                this._inSocket.readable = false;
-                this._outSocket.readable = false;
-                this._getConsoleProcessList().then(function (consoleProcessList) {
-                    consoleProcessList.forEach(function (pid) {
-                        try {
-                            process.kill(pid);
-                        }
-                        catch (e) {
-                            // Ignore if process cannot be found (kill ESRCH error)
-                        }
-                    });
-                });
-                this._ptyNative.kill(this._pty, this._useConptyDll);
-                this._conoutSocketWorker.dispose();
-            }
-            else {
-                // Close the input write handle to signal the end of session.
-                this._inSocket.destroy();
-                this._ptyNative.kill(this._pty, this._useConptyDll);
-                this._outSocket.on('data', function () {
-                    _this._conoutSocketWorker.dispose();
+        if (!this._useConptyDll) {
+            this._inSocket.readable = false;
+            this._outSocket.readable = false;
+            this._getConsoleProcessList().then(function (consoleProcessList) {
+                consoleProcessList.forEach(function (pid) {
+                    try {
+                        process.kill(pid);
+                    }
+                    catch (e) {
+                        // Ignore if process cannot be found (kill ESRCH error)
+                    }
                 });
-            }
+            });
+            this._ptyNative.kill(this._pty, this._useConptyDll);
+            this._conoutSocketWorker.dispose();
         }
         else {
-            // Because pty.kill closes the handle, it will kill most processes by itself.
-            // Process IDs can be reused as soon as all handles to them are
-            // dropped, so we want to immediately kill the entire console process list.
-            // If we do not force kill all processes here, node servers in particular
-            // seem to become detached and remain running (see
-            // Microsoft/vscode#26807).
-            var processList = this._ptyNative.getProcessList(this._pid);
-            this._ptyNative.kill(this._pid, this._innerPid);
-            processList.forEach(function (pid) {
-                try {
-                    process.kill(pid);
-                }
-                catch (e) {
-                    // Ignore if process cannot be found (kill ESRCH error)
-                }
+            // Close the input write handle to signal the end of session.
+            this._inSocket.destroy();
+            this._ptyNative.kill(this._pty, this._useConptyDll);
+            this._outSocket.on('data', function () {
+                _this._conoutSocketWorker.dispose();
             });
         }
     };
     WindowsPtyAgent.prototype._getConsoleProcessList = function () {
         var _this = this;
+        if (this._innerPid <= 0) {
+            return Promise.resolve([]);
+        }
         return new Promise(function (resolve) {
             var agent = child_process_1.fork(path.join(__dirname, 'conpty_console_list_agent'), [_this._innerPid.toString()]);
             agent.on('message', function (message) {
@@ -195,23 +174,11 @@ var WindowsPtyAgent = /** @class */ (function () {
     };
     Object.defineProperty(WindowsPtyAgent.prototype, "exitCode", {
         get: function () {
-            if (this._useConpty) {
-                return this._exitCode;
-            }
-            var winptyExitCode = this._ptyNative.getExitCode(this._innerPid);
-            return winptyExitCode === -1 ? undefined : winptyExitCode;
+            return this._exitCode;
         },
         enumerable: false,
         configurable: true
     });
-    WindowsPtyAgent.prototype._getWindowsBuildNumber = function () {
-        var osVersion = (/(\d+)\.(\d+)\.(\d+)/g).exec(os.release());
-        var buildNumber = 0;
-        if (osVersion && osVersion.length === 4) {
-            buildNumber = parseInt(osVersion[3]);
-        }
-        return buildNumber;
-    };
     WindowsPtyAgent.prototype._generatePipeName = function () {
         return "conpty-" + Math.random() * 10000000;
     };

package/lib/windowsTerminal.js

@@ -48,7 +48,7 @@ var WindowsTerminal = /** @class */ (function (_super) {
         // Functions that need to run after `ready` event is emitted.
         _this._deferreds = [];
         // Create new termal.
-        _this._agent = new windowsPtyAgent_1.WindowsPtyAgent(file, args, parsedEnv, cwd, _this._cols, _this._rows, false, opt.useConpty, opt.useConptyDll, opt.conptyInheritCursor);
+        _this._agent = new windowsPtyAgent_1.WindowsPtyAgent(file, args, parsedEnv, cwd, _this._cols, _this._rows, false, opt.useConptyDll, opt.conptyInheritCursor);
         _this._socket = _this._agent.outSocket;
         // Not available until `ready` event emitted.
         _this._pid = _this._agent.innerPid;
@@ -57,6 +57,8 @@ var WindowsTerminal = /** @class */ (function (_super) {
         // The forked windows terminal is not available until `ready` event is
         // emitted.
         _this._socket.on('ready_datapipe', function () {
+            // Update pid now that the agent has connected
+            _this._pid = _this._agent.innerPid;
             // Run deferreds and set ready state once the first data event is received.
             _this._socket.once('data', function () {
                 // Wait until the first data event is fired then we can run deferreds.
@@ -121,7 +123,7 @@ var WindowsTerminal = /** @class */ (function (_super) {
     /**
      * TTY
      */
-    WindowsTerminal.prototype.resize = function (cols, rows) {
+    WindowsTerminal.prototype.resize = function (cols, rows, pixelSize) {
         var _this = this;
         if (cols <= 0 || rows <= 0 || isNaN(cols) || isNaN(rows) || cols === Infinity || rows === Infinity) {
             throw new Error('resizing must be done using positive cols and rows');

package/package.json

@@ -4,7 +4,7 @@
   "author": {
     "name": "Microsoft Corporation"
   },
-  "version": "1.2.0-beta.1",
+  "version": "1.2.0-beta.11",
   "license": "MIT",
   "main": "./lib/index.js",
   "types": "./typings/node-pty.d.ts",
@@ -14,10 +14,11 @@
   },
   "files": [
     "binding.gyp",
-    "lib/",
-    "scripts/",
-    "src/",
-    "deps/",
+    "lib/**/*.js",
+    "!lib/**/*.test.js",
+    "scripts/post-install.js",
+    "scripts/prebuild.js",
+    "src/**/*.{cc,h}",
     "prebuilds/",
     "third_party/",
     "typings/"

package/scripts/post-install.js

@@ -12,11 +12,7 @@ const BUILD_FILES = [
   path.join(RELEASE_DIR, 'conpty_console_list.pdb'),
   path.join(RELEASE_DIR, 'pty.node'),
   path.join(RELEASE_DIR, 'pty.pdb'),
-  path.join(RELEASE_DIR, 'spawn-helper'),
-  path.join(RELEASE_DIR, 'winpty-agent.exe'),
-  path.join(RELEASE_DIR, 'winpty-agent.pdb'),
-  path.join(RELEASE_DIR, 'winpty.dll'),
-  path.join(RELEASE_DIR, 'winpty.pdb')
+  path.join(RELEASE_DIR, 'spawn-helper')
 ];
 const CONPTY_DIR = path.join(__dirname, '../third_party/conpty');
 const CONPTY_SUPPORTED_ARCH = ['x64', 'arm64'];