node-pty 1.2.0-beta.7 → 1.2.0-beta.9

package/src/unixTerminal.ts

@@ -1,388 +0,0 @@
-/**
- * Copyright (c) 2012-2015, Christopher Jeffrey (MIT License)
- * Copyright (c) 2016, Daniel Imms (MIT License).
- * Copyright (c) 2018, Microsoft Corporation (MIT License).
- */
-import * as fs from 'fs';
-import * as net from 'net';
-import * as path from 'path';
-import * as tty from 'tty';
-import { Terminal, DEFAULT_COLS, DEFAULT_ROWS } from './terminal';
-import { IProcessEnv, IPtyForkOptions, IPtyOpenOptions } from './interfaces';
-import { ArgvOrCommandLine, IDisposable } from './types';
-import { assign, loadNativeModule } from './utils';
-
-const native = loadNativeModule('pty');
-const pty: IUnixNative = native.module;
-let helperPath = native.dir + '/spawn-helper';
-helperPath = path.resolve(__dirname, helperPath);
-helperPath = helperPath.replace('app.asar', 'app.asar.unpacked');
-helperPath = helperPath.replace('node_modules.asar', 'node_modules.asar.unpacked');
-
-const DEFAULT_FILE = 'sh';
-const DEFAULT_NAME = 'xterm';
-const DESTROY_SOCKET_TIMEOUT_MS = 200;
-
-export class UnixTerminal extends Terminal {
-  protected _fd: number;
-  protected _pty: string;
-
-  protected _file: string;
-  protected _name: string;
-
-  protected _readable: boolean;
-  protected _writable: boolean;
-
-  private _boundClose: boolean = false;
-  private _emittedClose: boolean = false;
-
-  private _writeStream: CustomWriteStream;
-
-  private _master: net.Socket | undefined;
-  private _slave: net.Socket | undefined;
-
-  public get master(): net.Socket | undefined { return this._master; }
-  public get slave(): net.Socket | undefined { return this._slave; }
-
-  constructor(file?: string, args?: ArgvOrCommandLine, opt?: IPtyForkOptions) {
-    super(opt);
-
-    if (typeof args === 'string') {
-      throw new Error('args as a string is not supported on unix.');
-    }
-
-    // Initialize arguments
-    args = args || [];
-    file = file || DEFAULT_FILE;
-    opt = opt || {};
-    opt.env = opt.env || process.env;
-
-    this._cols = opt.cols || DEFAULT_COLS;
-    this._rows = opt.rows || DEFAULT_ROWS;
-    const uid = opt.uid ?? -1;
-    const gid = opt.gid ?? -1;
-    const env: IProcessEnv = assign({}, opt.env);
-
-    if (opt.env === process.env) {
-      this._sanitizeEnv(env);
-    }
-
-    const cwd = opt.cwd || process.cwd();
-    env.PWD = cwd;
-    const name = opt.name || env.TERM || DEFAULT_NAME;
-    env.TERM = name;
-    const parsedEnv = this._parseEnv(env);
-
-    const encoding = (opt.encoding === undefined ? 'utf8' : opt.encoding);
-
-    const onexit = (code: number, signal: number): void => {
-      // XXX Sometimes a data event is emitted after exit. Wait til socket is
-      // destroyed.
-      if (!this._emittedClose) {
-        if (this._boundClose) {
-          return;
-        }
-        this._boundClose = true;
-        // From macOS High Sierra 10.13.2 sometimes the socket never gets
-        // closed. A timeout is applied here to avoid the terminal never being
-        // destroyed when this occurs.
-        let timeout: NodeJS.Timeout | null = setTimeout(() => {
-          timeout = null;
-          // Destroying the socket now will cause the close event to fire
-          this._socket.destroy();
-        }, DESTROY_SOCKET_TIMEOUT_MS);
-        this.once('close', () => {
-          if (timeout !== null) {
-            clearTimeout(timeout);
-          }
-          this.emit('exit', code, signal);
-        });
-        return;
-      }
-      this.emit('exit', code, signal);
-    };
-
-    // fork
-    const term = pty.fork(file, args, parsedEnv, cwd, this._cols, this._rows, uid, gid, (encoding === 'utf8'), helperPath, onexit);
-
-    this._socket = new tty.ReadStream(term.fd);
-    if (encoding !== null) {
-      this._socket.setEncoding(encoding);
-    }
-    this._writeStream = new CustomWriteStream(term.fd, (encoding || undefined) as BufferEncoding);
-
-    // setup
-    this._socket.on('error', (err: any) => {
-      // NOTE: fs.ReadStream gets EAGAIN twice at first:
-      if (err.code) {
-        if (~err.code.indexOf('EAGAIN')) {
-          return;
-        }
-      }
-
-      // close
-      this._close();
-      // EIO on exit from fs.ReadStream:
-      if (!this._emittedClose) {
-        this._emittedClose = true;
-        this.emit('close');
-      }
-
-      // EIO, happens when someone closes our child process: the only process in
-      // the terminal.
-      // node < 0.6.14: errno 5
-      // node >= 0.6.14: read EIO
-      if (err.code) {
-        if (~err.code.indexOf('errno 5') || ~err.code.indexOf('EIO')) {
-          return;
-        }
-      }
-
-      // throw anything else
-      if (this.listeners('error').length < 2) {
-        throw err;
-      }
-    });
-
-    this._pid = term.pid;
-    this._fd = term.fd;
-    this._pty = term.pty;
-
-    this._file = file;
-    this._name = name;
-
-    this._readable = true;
-    this._writable = true;
-
-    this._socket.on('close', () => {
-      if (this._emittedClose) {
-        return;
-      }
-      this._emittedClose = true;
-      this._close();
-      this.emit('close');
-    });
-
-    this._forwardEvents();
-  }
-
-  protected _write(data: string | Buffer): void {
-    this._writeStream.write(data);
-  }
-
-  /* Accessors */
-  get fd(): number { return this._fd; }
-  get ptsName(): string { return this._pty; }
-
-  /**
-   * openpty
-   */
-
-  public static open(opt: IPtyOpenOptions): UnixTerminal {
-    const self: UnixTerminal = Object.create(UnixTerminal.prototype);
-    opt = opt || {};
-
-    if (arguments.length > 1) {
-      opt = {
-        cols: arguments[1],
-        rows: arguments[2]
-      };
-    }
-
-    const cols = opt.cols || DEFAULT_COLS;
-    const rows = opt.rows || DEFAULT_ROWS;
-    const encoding = (opt.encoding === undefined ? 'utf8' : opt.encoding);
-
-    // open
-    const term: IUnixOpenProcess = pty.open(cols, rows);
-
-    self._master = new tty.ReadStream(term.master);
-    if (encoding !== null) {
-      self._master.setEncoding(encoding);
-    }
-    self._master.resume();
-
-    self._slave = new tty.ReadStream(term.slave);
-    if (encoding !== null) {
-      self._slave.setEncoding(encoding);
-    }
-    self._slave.resume();
-
-    self._socket = self._master;
-    self._pid = -1;
-    self._fd = term.master;
-    self._pty = term.pty;
-
-    self._file = process.argv[0] || 'node';
-    self._name = process.env.TERM || '';
-
-    self._readable = true;
-    self._writable = true;
-
-    self._socket.on('error', err => {
-      self._close();
-      if (self.listeners('error').length < 2) {
-        throw err;
-      }
-    });
-
-    self._socket.on('close', () => {
-      self._close();
-    });
-
-    return self;
-  }
-
-  public destroy(): void {
-    this._close();
-
-    // Need to close the read stream so node stops reading a dead file
-    // descriptor. Then we can safely SIGHUP the shell.
-    this._socket.once('close', () => {
-      this.kill('SIGHUP');
-    });
-
-    this._socket.destroy();
-    this._writeStream.dispose();
-  }
-
-  public kill(signal?: string): void {
-    try {
-      process.kill(this.pid, signal || 'SIGHUP');
-    } catch (e) { /* swallow */ }
-  }
-
-  /**
-   * Gets the name of the process.
-   */
-  public get process(): string {
-    if (process.platform === 'darwin') {
-      const title = pty.process(this._fd);
-      return (title !== 'kernel_task') ? title : this._file;
-    }
-
-    return pty.process(this._fd, this._pty) || this._file;
-  }
-
-  /**
-   * TTY
-   */
-
-  public resize(cols: number, rows: number): void {
-    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);
-    this._cols = cols;
-    this._rows = rows;
-  }
-
-  public clear(): void {
-
-  }
-
-  private _sanitizeEnv(env: IProcessEnv): void {
-    // Make sure we didn't start our server from inside tmux.
-    delete env['TMUX'];
-    delete env['TMUX_PANE'];
-
-    // Make sure we didn't start our server from inside screen.
-    // http://web.mit.edu/gnu/doc/html/screen_20.html
-    delete env['STY'];
-    delete env['WINDOW'];
-
-    // Delete some variables that might confuse our terminal.
-    delete env['WINDOWID'];
-    delete env['TERMCAP'];
-    delete env['COLUMNS'];
-    delete env['LINES'];
-  }
-}
-
-interface IWriteTask {
-  /** The buffer being written. */
-  buffer: Buffer;
-  /** The current offset of not yet written data. */
-  offset: number;
-}
-
-/**
- * A custom write stream that writes directly to a file descriptor with proper
- * handling of backpressure and errors. This avoids some event loop exhaustion
- * issues that can occur when using the standard APIs in Node.
- */
-class CustomWriteStream implements IDisposable {
-
-  private readonly _writeQueue: IWriteTask[] = [];
-  private _writeImmediate: NodeJS.Immediate | undefined;
-
-  constructor(
-    private readonly _fd: number,
-    private readonly _encoding: BufferEncoding
-  ) {
-  }
-
-  dispose(): void {
-    clearImmediate(this._writeImmediate);
-    this._writeImmediate = undefined;
-  }
-
-  write(data: string | Buffer): void {
-    // Writes are put in a queue and processed asynchronously in order to handle
-    // backpressure from the kernel buffer.
-    const buffer = typeof data === 'string'
-      ? Buffer.from(data, this._encoding)
-      : Buffer.from(data);
-
-    if (buffer.byteLength !== 0) {
-      this._writeQueue.push({ buffer, offset: 0 });
-      if (this._writeQueue.length === 1) {
-        this._processWriteQueue();
-      }
-    }
-  }
-
-  private _processWriteQueue(): void {
-    this._writeImmediate = undefined;
-
-    if (this._writeQueue.length === 0) {
-      return;
-    }
-
-    const task = this._writeQueue[0];
-
-    // Write to the underlying file descriptor and handle it directly, rather
-    // than using the `net.Socket`/`tty.WriteStream` wrappers which swallow and
-    // mask errors like EAGAIN and can cause the thread to block indefinitely.
-    fs.write(this._fd, task.buffer, task.offset, (err, written) => {
-      if (err) {
-        if ('code' in err && err.code === 'EAGAIN') {
-          // `setImmediate` is used to yield to the event loop and re-attempt
-          // the write later.
-          this._writeImmediate = setImmediate(() => this._processWriteQueue());
-        } else {
-          // Stop processing immediately on unexpected error and log
-          this._writeQueue.length = 0;
-          console.error('Unhandled pty write error', err);
-        }
-        return;
-      }
-
-      task.offset += written;
-      if (task.offset >= task.buffer.byteLength) {
-        this._writeQueue.shift();
-      }
-
-      // Since there is more room in the kernel buffer, we can continue to write
-      // until we hit EAGAIN or exhaust the queue.
-      //
-      // Note that old versions of bash, like v3.2 which ships in macOS, appears
-      // to have a bug in its readline implementation that causes data
-      // corruption when writes to the pty happens too quickly. Instead of
-      // trying to workaround that we just accept it so that large pastes are as
-      // fast as possible.
-      // Context: https://github.com/microsoft/node-pty/issues/833
-      this._processWriteQueue();
-    });
-  }
-}

package/src/utils.ts

@@ -1,29 +0,0 @@
-/**
- * Copyright (c) 2017, Daniel Imms (MIT License).
- * Copyright (c) 2018, Microsoft Corporation (MIT License).
- */
-
-export function assign(target: any, ...sources: any[]): any {
-  sources.forEach(source => Object.keys(source).forEach(key => target[key] = source[key]));
-  return target;
-}
-
-
-export function loadNativeModule(name: string): {dir: string, module: any} {
-  // Check build, debug, and then prebuilds.
-  const dirs = ['build/Release', 'build/Debug', `prebuilds/${process.platform}-${process.arch}`];
-  // Check relative to the parent dir for unbundled and then the current dir for bundled
-  const relative = ['..', '.'];
-  let lastError: unknown;
-  for (const d of dirs) {
-    for (const r of relative) {
-      const dir = `${r}/${d}`;
-      try {
-        return { dir, module: require(`${dir}/${name}.node`) };
-      } catch (e) {
-        lastError = e;
-      }
-    }
-  }
-  throw new Error(`Failed to load native module: ${name}.node, checked: ${dirs.join(', ')}: ${lastError}`);
-}

package/src/windowsConoutConnection.ts

@@ -1,82 +0,0 @@
-/**
- * Copyright (c) 2020, Microsoft Corporation (MIT License).
- */
-
-import { Worker } from 'worker_threads';
-import { Socket } from 'net';
-import { IDisposable } from './types';
-import { IWorkerData, ConoutWorkerMessage, getWorkerPipeName } from './shared/conout';
-import { join } from 'path';
-import { IEvent, EventEmitter2 } from './eventEmitter2';
-
-/**
- * The amount of time to wait for additional data after the conpty shell process has exited before
- * shutting down the worker and sockets. The timer will be reset if a new data event comes in after
- * the timer has started.
- */
-const FLUSH_DATA_INTERVAL = 1000;
-
-/**
- * Connects to and manages the lifecycle of the conout socket. This socket must be drained on
- * another thread in order to avoid deadlocks where Conpty waits for the out socket to drain
- * when `ClosePseudoConsole` is called. This happens when data is being written to the terminal when
- * the pty is closed.
- *
- * See also:
- * - https://github.com/microsoft/node-pty/issues/375
- * - https://github.com/microsoft/vscode/issues/76548
- * - https://github.com/microsoft/terminal/issues/1810
- * - https://docs.microsoft.com/en-us/windows/console/closepseudoconsole
- */
-export class ConoutConnection implements IDisposable {
-  private _worker: Worker;
-  private _drainTimeout: NodeJS.Timeout | undefined;
-  private _isDisposed: boolean = false;
-
-  private _onReady = new EventEmitter2<void>();
-  public get onReady(): IEvent<void> { return this._onReady.event; }
-
-  constructor(
-    private _conoutPipeName: string,
-    private _useConptyDll: boolean
-  ) {
-    const workerData: IWorkerData = {
-      conoutPipeName: _conoutPipeName
-    };
-    const scriptPath = __dirname.replace('node_modules.asar', 'node_modules.asar.unpacked');
-    this._worker = new Worker(join(scriptPath, 'worker/conoutSocketWorker.js'), { workerData });
-    this._worker.on('message', (message: ConoutWorkerMessage) => {
-      switch (message) {
-        case ConoutWorkerMessage.READY:
-          this._onReady.fire();
-          return;
-        default:
-          console.warn('Unexpected ConoutWorkerMessage', message);
-      }
-    });
-  }
-
-  dispose(): void {
-    if (!this._useConptyDll && this._isDisposed) {
-      return;
-    }
-    this._isDisposed = true;
-    // Drain all data from the socket before closing
-    this._drainDataAndClose();
-  }
-
-  connectSocket(socket: Socket): void {
-    socket.connect(getWorkerPipeName(this._conoutPipeName));
-  }
-
-  private _drainDataAndClose(): void {
-    if (this._drainTimeout) {
-      clearTimeout(this._drainTimeout);
-    }
-    this._drainTimeout = setTimeout(() => this._destroySocket(), FLUSH_DATA_INTERVAL);
-  }
-
-  private async _destroySocket(): Promise<void> {
-    await this._worker.terminate();
-  }
-}

package/src/windowsPtyAgent.test.ts

@@ -1,94 +0,0 @@
-/**
- * Copyright (c) 2017, Daniel Imms (MIT License).
- * Copyright (c) 2018, Microsoft Corporation (MIT License).
- */
-
-import * as assert from 'assert';
-import { argsToCommandLine } from './windowsPtyAgent';
-
-function check(file: string, args: string | string[], expected: string): void {
-  assert.equal(argsToCommandLine(file, args), expected);
-}
-
-if (process.platform === 'win32') {
-  describe('argsToCommandLine', () => {
-    describe('Plain strings', () => {
-      it('doesn\'t quote plain string', () => {
-        check('asdf', [], 'asdf');
-      });
-      it('doesn\'t escape backslashes', () => {
-        check('\\asdf\\qwer\\', [], '\\asdf\\qwer\\');
-      });
-      it('doesn\'t escape multiple backslashes', () => {
-        check('asdf\\\\qwer', [], 'asdf\\\\qwer');
-      });
-      it('adds backslashes before quotes', () => {
-        check('"asdf"qwer"', [], '\\"asdf\\"qwer\\"');
-      });
-      it('escapes backslashes before quotes', () => {
-        check('asdf\\"qwer', [], 'asdf\\\\\\"qwer');
-      });
-    });
-
-    describe('Quoted strings', () => {
-      it('quotes string with spaces', () => {
-        check('asdf qwer', [], '"asdf qwer"');
-      });
-      it('quotes empty string', () => {
-        check('', [], '""');
-      });
-      it('quotes string with tabs', () => {
-        check('asdf\tqwer', [], '"asdf\tqwer"');
-      });
-      it('escapes only the last backslash', () => {
-        check('\\asdf \\qwer\\', [], '"\\asdf \\qwer\\\\"');
-      });
-      it('doesn\'t escape multiple backslashes', () => {
-        check('asdf \\\\qwer', [], '"asdf \\\\qwer"');
-      });
-      it('escapes backslashes before quotes', () => {
-        check('asdf \\"qwer', [], '"asdf \\\\\\"qwer"');
-      });
-      it('escapes multiple backslashes at the end', () => {
-        check('asdf qwer\\\\', [], '"asdf qwer\\\\\\\\"');
-      });
-    });
-
-    describe('Multiple arguments', () => {
-      it('joins arguments with spaces', () => {
-        check('asdf', ['qwer zxcv', '', '"'], 'asdf "qwer zxcv" "" \\"');
-      });
-      it('array argument all in quotes', () => {
-        check('asdf', ['"surounded by quotes"'], 'asdf \\"surounded by quotes\\"');
-      });
-      it('array argument quotes in the middle', () => {
-        check('asdf', ['quotes "in the" middle'], 'asdf "quotes \\"in the\\" middle"');
-      });
-      it('array argument quotes near start', () => {
-        check('asdf', ['"quotes" near start'], 'asdf "\\"quotes\\" near start"');
-      });
-      it('array argument quotes near end', () => {
-        check('asdf', ['quotes "near end"'], 'asdf "quotes \\"near end\\""');
-      });
-    });
-
-    describe('Args as CommandLine', () => {
-      it('should handle empty string', () => {
-        check('file', '', 'file');
-      });
-      it('should not change args', () => {
-        check('file', 'foo bar baz', 'file foo bar baz');
-        check('file', 'foo \\ba"r \baz', 'file foo \\ba"r \baz');
-      });
-    });
-
-    describe('Real-world cases', () => {
-      it('quotes within quotes', () => {
-        check('cmd.exe', ['/c', 'powershell -noexit -command \'Set-location \"C:\\user\"\''], 'cmd.exe /c "powershell -noexit -command \'Set-location \\\"C:\\user\\"\'"');
-      });
-      it('space within quotes', () => {
-        check('cmd.exe', ['/k', '"C:\\Users\\alros\\Desktop\\test script.bat"'], 'cmd.exe /k \\"C:\\Users\\alros\\Desktop\\test script.bat\\"');
-      });
-    });
-  });
-}