node-pty 0.10.0-beta9 → 0.11.0-beta10

package/src/windowsPtyAgent.ts

@@ -4,11 +4,13 @@
  * Copyright (c) 2018, Microsoft Corporation (MIT License).
  */
 
+import * as fs from 'fs';
 import * as os from 'os';
 import * as path from 'path';
 import { Socket } from 'net';
 import { ArgvOrCommandLine } from './types';
 import { fork } from 'child_process';
+import { ConoutConnection } from './windowsConoutConnection';
 
 let conptyNative: IConptyNative;
 let winptyNative: IWinptyNative;
@@ -18,7 +20,7 @@ let winptyNative: IWinptyNative;
  * shutting down the socket. The timer will be reset if a new data event comes in after the timer
  * has started.
  */
-const FLUSH_DATA_INTERVAL = 20;
+const FLUSH_DATA_INTERVAL = 1000;
 
 /**
  * This agent sits between the WindowsTerminal class and provides a common interface for both conpty
@@ -32,6 +34,7 @@ export class WindowsPtyAgent {
   private _innerPidHandle: number;
   private _closeTimeout: NodeJS.Timer;
   private _exitCode: number | undefined;
+  private _conoutSocketWorker: ConoutConnection;
 
   private _fd: any;
   private _pty: number;
@@ -115,17 +118,22 @@ export class WindowsPtyAgent {
     // Create terminal pipe IPC channel and forward to a local unix socket.
     this._outSocket = new Socket();
     this._outSocket.setEncoding('utf8');
-    this._outSocket.connect(term.conout, () => {
-      // TODO: Emit event on agent instead of socket?
-
-      // Emit ready event.
+    // The conout socket must be ready out on another thread to avoid deadlocks
+    this._conoutSocketWorker = new ConoutConnection(term.conout);
+    this._conoutSocketWorker.onReady(() => {
+      this._conoutSocketWorker.connectSocket(this._outSocket);
+    });
+    this._outSocket.on('connect', () => {
       this._outSocket.emit('ready_datapipe');
     });
 
-    this._inSocket = new Socket();
+    const inSocketFD = fs.openSync(term.conin, 'w');
+    this._inSocket = new Socket({
+      fd: inSocketFD,
+      readable: false,
+      writable: true
+    });
     this._inSocket.setEncoding('utf8');
-    this._inSocket.connect(term.conin);
-    // TODO: Wait for ready event?
 
     if (this._useConpty) {
       const connect = (this._ptyNative as IConptyNative).connect(this._pty, commandLine, cwd, env, c => this._$onProcessExit(c));
@@ -146,9 +154,7 @@ export class WindowsPtyAgent {
 
   public kill(): void {
     this._inSocket.readable = false;
-    this._inSocket.writable = false;
     this._outSocket.readable = false;
-    this._outSocket.writable = false;
     // Tell the agent to kill the pty, this releases handles to the process
     if (this._useConpty) {
       this._getConsoleProcessList().then(consoleProcessList => {
@@ -178,6 +184,7 @@ export class WindowsPtyAgent {
         }
       });
     }
+    this._conoutSocketWorker.dispose();
   }
 
   private _getConsoleProcessList(): Promise<number[]> {
@@ -233,9 +240,7 @@ export class WindowsPtyAgent {
 
   private _cleanUpProcess(): void {
     this._inSocket.readable = false;
-    this._inSocket.writable = false;
     this._outSocket.readable = false;
-    this._outSocket.writable = false;
     this._outSocket.destroy();
   }
 }

package/src/windowsTerminal.test.ts

@@ -201,5 +201,15 @@ if (process.platform === 'win32') {
         });
       });
     });
+
+    describe('winpty', () => {
+      it('should accept input', (done) => {
+        const term = new WindowsTerminal('cmd.exe', '', { useConpty: false });
+        term.write('exit\r');
+        term.on('exit', () => {
+          done();
+        });
+      });
+    });
   });
 }

package/src/worker/conoutSocketWorker.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright (c) 2020, Microsoft Corporation (MIT License).
+ */
+
+import { parentPort, workerData } from 'worker_threads';
+import { Socket, createServer } from 'net';
+import { ConoutWorkerMessage, IWorkerData, getWorkerPipeName } from '../shared/conout';
+
+const conoutPipeName = (workerData as IWorkerData).conoutPipeName;
+const conoutSocket = new Socket();
+conoutSocket.setEncoding('utf8');
+conoutSocket.connect(conoutPipeName, () => {
+  const server = createServer(workerSocket => {
+    conoutSocket.pipe(workerSocket);
+  });
+  server.listen(getWorkerPipeName(conoutPipeName));
+  parentPort.postMessage(ConoutWorkerMessage.READY);
+});

package/typings/node-pty.d.ts

@@ -35,14 +35,14 @@ declare module 'node-pty' {
     rows?: number;
 
     /**
-     * Working directory to be set for the slave program.
+     * Working directory to be set for the child program.
      */
     cwd?: string;
 
     /**
-     * Environment to be set for the slave program.
+     * Environment to be set for the child program.
      */
-    env?: { [key: string]: string };
+    env?: { [key: string]: string | undefined };
 
     /**
      * String encoding of the underlying pty.
@@ -55,7 +55,7 @@ declare module 'node-pty' {
     /**
      * (EXPERIMENTAL)
      * Whether to enable flow control handling (false by default). If enabled a message of `flowControlPause`
-     * will pause the socket and thus blocking the slave program execution due to buffer back pressure.
+     * will pause the socket and thus blocking the child program execution due to buffer back pressure.
      * A message of `flowControlResume` will resume the socket into flow mode.
      * For performance reasons only a single message as a whole will match (no message part matching).
      * If flow control is enabled the `flowControlPause` and `flowControlResume` messages are not forwarded to
@@ -79,7 +79,7 @@ declare module 'node-pty' {
   export interface IPtyForkOptions extends IBasePtyForkOptions {
     /**
      * Security warning: use this option with great caution, as opened file descriptors
-     * with higher privileges might leak to the slave program.
+     * with higher privileges might leak to the child program.
      */
     uid?: number;
     gid?: number;
@@ -183,6 +183,16 @@ declare module 'node-pty' {
      * @throws Will throw when signal is used on Windows.
      */
     kill(signal?: string): void;
+
+    /**
+     * Pauses the pty for customizable flow control.
+     */
+    pause(): void;
+
+    /**
+     * Resumes the pty for customizable flow control.
+     */
+    resume(): void;
   }
 
   /**