node-pty 1.2.0-beta.6 → 1.2.0-beta.8

package/src/index.ts

@@ -1,52 +0,0 @@
-/**
- * Copyright (c) 2012-2015, Christopher Jeffrey, Peter Sunde (MIT License)
- * Copyright (c) 2016, Daniel Imms (MIT License).
- * Copyright (c) 2018, Microsoft Corporation (MIT License).
- */
-
-import { ITerminal, IPtyOpenOptions, IPtyForkOptions, IWindowsPtyForkOptions } from './interfaces';
-import { ArgvOrCommandLine } from './types';
-import { loadNativeModule } from './utils';
-
-let terminalCtor: any;
-if (process.platform === 'win32') {
-  terminalCtor = require('./windowsTerminal').WindowsTerminal;
-} else {
-  terminalCtor = require('./unixTerminal').UnixTerminal;
-}
-
-/**
- * Forks a process as a pseudoterminal.
- * @param file The file to launch.
- * @param args The file's arguments as argv (string[]) or in a pre-escaped
- * CommandLine format (string). Note that the CommandLine option is only
- * available on Windows and is expected to be escaped properly.
- * @param options The options of the terminal.
- * @throws When the file passed to spawn with does not exists.
- * @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 GetCommandLine https://msdn.microsoft.com/en-us/library/windows/desktop/ms683156.aspx
- */
-export function spawn(file?: string, args?: ArgvOrCommandLine, opt?: IPtyForkOptions | IWindowsPtyForkOptions): ITerminal {
-  return new terminalCtor(file, args, opt);
-}
-
-/** @deprecated */
-export function fork(file?: string, args?: ArgvOrCommandLine, opt?: IPtyForkOptions | IWindowsPtyForkOptions): ITerminal {
-  return new terminalCtor(file, args, opt);
-}
-
-/** @deprecated */
-export function createTerminal(file?: string, args?: ArgvOrCommandLine, opt?: IPtyForkOptions | IWindowsPtyForkOptions): ITerminal {
-  return new terminalCtor(file, args, opt);
-}
-
-export function open(options: IPtyOpenOptions): ITerminal {
-  return terminalCtor.open(options);
-}
-
-/**
- * Expose the native API when not Windows, note that this is not public API and
- * could be removed at any time.
- */
-export const native = (process.platform !== 'win32' ? loadNativeModule('pty').module : null);

package/src/interfaces.ts

@@ -1,130 +0,0 @@
-/**
- * Copyright (c) 2016, Daniel Imms (MIT License).
- * Copyright (c) 2018, Microsoft Corporation (MIT License).
- */
-
-export interface IProcessEnv {
-  [key: string]: string | undefined;
-}
-
-export interface ITerminal {
-  /**
-   * Gets the name of the process.
-   */
-  process: string;
-
-  /**
-   * Gets the process ID.
-   */
-  pid: number;
-
-  /**
-   * Writes data to the socket.
-   * @param data The data to write.
-   */
-  write(data: string | Buffer): void;
-
-  /**
-   * Resize the pty.
-   * @param cols The number of columns.
-   * @param rows The number of rows.
-   */
-  resize(cols: number, rows: number): void;
-
-  /**
-   * Clears the pty's internal representation of its buffer. This is a no-op
-   * unless on Windows/ConPTY.
-   */
-  clear(): void;
-
-  /**
-   * Close, kill and destroy the socket.
-   */
-  destroy(): void;
-
-  /**
-   * Kill the pty.
-   * @param signal The signal to send, by default this is SIGHUP. This is not
-   * supported on Windows.
-   */
-  kill(signal?: string): void;
-
-  /**
-   * Set the pty socket encoding.
-   */
-  setEncoding(encoding: string | null): void;
-
-  /**
-   * Resume the pty socket.
-   */
-  resume(): void;
-
-  /**
-   * Pause the pty socket.
-   */
-  pause(): void;
-
-  /**
-   * Alias for ITerminal.on(eventName, listener).
-   */
-  addListener(eventName: string, listener: (...args: any[]) => any): void;
-
-  /**
-   * Adds the listener function to the end of the listeners array for the event
-   * named eventName.
-   * @param eventName The event name.
-   * @param listener The callback function
-   */
-  on(eventName: string, listener: (...args: any[]) => any): void;
-
-  /**
-   * Returns a copy of the array of listeners for the event named eventName.
-   */
-  listeners(eventName: string): Function[];
-
-  /**
-   * Removes the specified listener from the listener array for the event named
-   * eventName.
-   */
-  removeListener(eventName: string, listener: (...args: any[]) => any): void;
-
-  /**
-   * Removes all listeners, or those of the specified eventName.
-   */
-  removeAllListeners(eventName: string): void;
-
-  /**
-   * Adds a one time listener function for the event named eventName. The next
-   * time eventName is triggered, this listener is removed and then invoked.
-   */
-  once(eventName: string, listener: (...args: any[]) => any): void;
-}
-
-interface IBasePtyForkOptions {
-  name?: string;
-  cols?: number;
-  rows?: number;
-  cwd?: string;
-  env?: IProcessEnv;
-  encoding?: string | null;
-  handleFlowControl?: boolean;
-  flowControlPause?: string;
-  flowControlResume?: string;
-}
-
-export interface IPtyForkOptions extends IBasePtyForkOptions {
-  uid?: number;
-  gid?: number;
-}
-
-export interface IWindowsPtyForkOptions extends IBasePtyForkOptions {
-  useConpty?: boolean;
-  useConptyDll?: boolean;
-  conptyInheritCursor?: boolean;
-}
-
-export interface IPtyOpenOptions {
-  cols?: number;
-  rows?: number;
-  encoding?: string | null;
-}

package/src/native.d.ts

@@ -1,54 +0,0 @@
-/**
- * Copyright (c) 2018, Microsoft Corporation (MIT License).
- */
-
-interface IConptyNative {
-  startProcess(file: string, cols: number, rows: number, debug: boolean, pipeName: string, conptyInheritCursor: boolean, useConptyDll: boolean): IConptyProcess;
-  connect(ptyId: number, commandLine: string, cwd: string, env: string[], useConptyDll: boolean, onExitCallback: (exitCode: number) => void): { pid: number };
-  resize(ptyId: number, cols: number, rows: number, useConptyDll: boolean): void;
-  clear(ptyId: number, useConptyDll: boolean): void;
-  kill(ptyId: number, useConptyDll: boolean): void;
-}
-
-interface IWinptyNative {
-  startProcess(file: string, commandLine: string, env: string[], cwd: string, cols: number, rows: number, debug: boolean): IWinptyProcess;
-  resize(pid: number, cols: number, rows: number): void;
-  kill(pid: number, innerPid: number): void;
-  getProcessList(pid: number): number[];
-  getExitCode(innerPid: number): number;
-}
-
-interface IUnixNative {
-  fork(file: string, args: string[], parsedEnv: string[], cwd: string, cols: number, rows: number, uid: number, gid: number, useUtf8: boolean, helperPath: string, onExitCallback: (code: number, signal: number) => void): IUnixProcess;
-  open(cols: number, rows: number): IUnixOpenProcess;
-  process(fd: number, pty?: string): string;
-  resize(fd: number, cols: number, rows: number): void;
-}
-
-interface IConptyProcess {
-  pty: number;
-  fd: number;
-  conin: string;
-  conout: string;
-}
-
-interface IWinptyProcess {
-  pty: number;
-  fd: number;
-  conin: string;
-  conout: string;
-  pid: number;
-  innerPid: number;
-}
-
-interface IUnixProcess {
-  fd: number;
-  pid: number;
-  pty: string;
-}
-
-interface IUnixOpenProcess {
-  master: number;
-  slave: number;
-  pty: string;
-}

package/src/shared/conout.ts

@@ -1,15 +0,0 @@
-/**
- * Copyright (c) 2020, Microsoft Corporation (MIT License).
- */
-
-export interface IWorkerData {
-  conoutPipeName: string;
-}
-
-export const enum ConoutWorkerMessage {
-  READY = 1
-}
-
-export function getWorkerPipeName(conoutPipeName: string): string {
-  return `${conoutPipeName}-worker`;
-}

package/src/terminal.test.ts

@@ -1,119 +0,0 @@
-/**
- * Copyright (c) 2017, Daniel Imms (MIT License).
- * Copyright (c) 2018, Microsoft Corporation (MIT License).
- */
-
-import * as assert from 'assert';
-import { WindowsTerminal } from './windowsTerminal';
-import { UnixTerminal } from './unixTerminal';
-import { Terminal } from './terminal';
-import { Socket } from 'net';
-
-const terminalConstructor = (process.platform === 'win32') ? WindowsTerminal : UnixTerminal;
-const SHELL = (process.platform === 'win32') ? 'cmd.exe' : '/bin/bash';
-
-let terminalCtor: WindowsTerminal | UnixTerminal;
-if (process.platform === 'win32') {
-  terminalCtor = require('./windowsTerminal');
-} else {
-  terminalCtor = require('./unixTerminal');
-}
-
-class TestTerminal extends Terminal {
-  public checkType<T>(name: string, value: T, type: string, allowArray: boolean = false): void {
-    this._checkType(name, value, type, allowArray);
-  }
-  protected _write(data: string | Buffer): void {
-    throw new Error('Method not implemented.');
-  }
-  public resize(cols: number, rows: number): void {
-    throw new Error('Method not implemented.');
-  }
-  public clear(): void {
-    throw new Error('Method not implemented.');
-  }
-  public destroy(): void {
-    throw new Error('Method not implemented.');
-  }
-  public kill(signal?: string): void {
-    throw new Error('Method not implemented.');
-  }
-  public get process(): string {
-    throw new Error('Method not implemented.');
-  }
-  public get master(): Socket {
-    throw new Error('Method not implemented.');
-  }
-  public get slave(): Socket {
-    throw new Error('Method not implemented.');
-  }
-}
-
-describe('Terminal', () => {
-  describe('constructor', () => {
-    it('should do basic type checks', () => {
-      assert.throws(
-        () => new (<any>terminalCtor)('a', 'b', { 'name': {} }),
-        'name must be a string (not a object)'
-      );
-    });
-  });
-
-  describe('checkType', () => {
-    it('should throw for the wrong type', () => {
-      const t = new TestTerminal();
-      assert.doesNotThrow(() => t.checkType('foo', 'test', 'string'));
-      assert.doesNotThrow(() => t.checkType('foo', 1, 'number'));
-      assert.doesNotThrow(() => t.checkType('foo', {}, 'object'));
-
-      assert.throws(() => t.checkType('foo', 'test', 'number'));
-      assert.throws(() => t.checkType('foo', 1, 'object'));
-      assert.throws(() => t.checkType('foo', {}, 'string'));
-    });
-    it('should throw for wrong types within arrays', () => {
-      const t = new TestTerminal();
-      assert.doesNotThrow(() => t.checkType('foo', ['test'], 'string', true));
-      assert.doesNotThrow(() => t.checkType('foo', [1], 'number', true));
-      assert.doesNotThrow(() => t.checkType('foo', [{}], 'object', true));
-
-      assert.throws(() => t.checkType('foo', ['test'], 'number', true));
-      assert.throws(() => t.checkType('foo', [1], 'object', true));
-      assert.throws(() => t.checkType('foo', [{}], 'string', true));
-    });
-  });
-
-  describe('automatic flow control', () => {
-    it('should respect ctor flow control options', () => {
-      const pty = new terminalConstructor(SHELL, [], {handleFlowControl: true, flowControlPause: 'abc', flowControlResume: '123'});
-      assert.equal(pty.handleFlowControl, true);
-      assert.equal((pty as any)._flowControlPause, 'abc');
-      assert.equal((pty as any)._flowControlResume, '123');
-    });
-    // TODO: I don't think this test ever worked due to pollUntil being used incorrectly
-    // it('should do flow control automatically', async function(): Promise<void> {
-    //   // Flow control doesn't work on Windows
-    //   if (process.platform === 'win32') {
-    //     return;
-    //   }
-
-    //   this.timeout(10000);
-    //   const pty = new terminalConstructor(SHELL, [], {handleFlowControl: true, flowControlPause: 'PAUSE', flowControlResume: 'RESUME'});
-    //   let read: string = '';
-    //   pty.on('data', data => read += data);
-    //   pty.on('pause', () => read += 'paused');
-    //   pty.on('resume', () => read += 'resumed');
-    //   pty.write('1');
-    //   pty.write('PAUSE');
-    //   pty.write('2');
-    //   pty.write('RESUME');
-    //   pty.write('3');
-    //   await pollUntil(() => {
-    //     return stripEscapeSequences(read).endsWith('1pausedresumed23');
-    //   }, 100, 10);
-    // });
-  });
-});
-
-function stripEscapeSequences(data: string): string {
-  return data.replace(/\u001b\[0K/, '');
-}

package/src/terminal.ts

@@ -1,211 +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 { Socket } from 'net';
-import { EventEmitter } from 'events';
-import { ITerminal, IPtyForkOptions, IProcessEnv } from './interfaces';
-import { EventEmitter2, IEvent } from './eventEmitter2';
-import { IExitEvent } from './types';
-
-export const DEFAULT_COLS: number = 80;
-export const DEFAULT_ROWS: number = 24;
-
-/**
- * Default messages to indicate PAUSE/RESUME for automatic flow control.
- * To avoid conflicts with rebound XON/XOFF control codes (such as on-my-zsh),
- * the sequences can be customized in `IPtyForkOptions`.
- */
-const FLOW_CONTROL_PAUSE =  '\x13';   // defaults to XOFF
-const FLOW_CONTROL_RESUME = '\x11';   // defaults to XON
-
-export abstract class Terminal implements ITerminal {
-  protected _socket!: Socket; // HACK: This is unsafe
-  protected _pid: number = 0;
-  protected _fd: number = 0;
-  protected _pty: any;
-
-  protected _file!: string; // HACK: This is unsafe
-  protected _name!: string; // HACK: This is unsafe
-  protected _cols: number = 0;
-  protected _rows: number = 0;
-
-  protected _readable: boolean = false;
-  protected _writable: boolean = false;
-
-  protected _internalee: EventEmitter;
-  private _flowControlPause: string;
-  private _flowControlResume: string;
-  public handleFlowControl: boolean;
-
-  private _onData = new EventEmitter2<string>();
-  public get onData(): IEvent<string> { return this._onData.event; }
-  private _onExit = new EventEmitter2<IExitEvent>();
-  public get onExit(): IEvent<IExitEvent> { return this._onExit.event; }
-
-  public get pid(): number { return this._pid; }
-  public get cols(): number { return this._cols; }
-  public get rows(): number { return this._rows; }
-
-  constructor(opt?: IPtyForkOptions) {
-    // for 'close'
-    this._internalee = new EventEmitter();
-
-    // setup flow control handling
-    this.handleFlowControl = !!(opt?.handleFlowControl);
-    this._flowControlPause = opt?.flowControlPause || FLOW_CONTROL_PAUSE;
-    this._flowControlResume = opt?.flowControlResume || FLOW_CONTROL_RESUME;
-
-    if (!opt) {
-      return;
-    }
-
-    // Do basic type checks here in case node-pty is being used within JavaScript. If the wrong
-    // types go through to the C++ side it can lead to hard to diagnose exceptions.
-    this._checkType('name', opt.name ? opt.name : undefined, 'string');
-    this._checkType('cols', opt.cols ? opt.cols : undefined, 'number');
-    this._checkType('rows', opt.rows ? opt.rows : undefined, 'number');
-    this._checkType('cwd', opt.cwd ? opt.cwd : undefined, 'string');
-    this._checkType('env', opt.env ? opt.env : undefined, 'object');
-    this._checkType('uid', opt.uid ? opt.uid : undefined, 'number');
-    this._checkType('gid', opt.gid ? opt.gid : undefined, 'number');
-    this._checkType('encoding', opt.encoding ? opt.encoding : undefined, 'string');
-  }
-
-  protected abstract _write(data: string | Buffer): void;
-
-  public write(data: string | Buffer): void {
-    if (this.handleFlowControl) {
-      // PAUSE/RESUME messages are not forwarded to the pty
-      if (data === this._flowControlPause) {
-        this.pause();
-        return;
-      }
-      if (data === this._flowControlResume) {
-        this.resume();
-        return;
-      }
-    }
-    // everything else goes to the real pty
-    this._write(data);
-  }
-
-  protected _forwardEvents(): void {
-    this.on('data', e => this._onData.fire(e));
-    this.on('exit', (exitCode, signal) => this._onExit.fire({ exitCode, signal }));
-  }
-
-  protected _checkType<T>(name: string, value: T | undefined, type: string, allowArray: boolean = false): void {
-    if (value === undefined) {
-      return;
-    }
-    if (allowArray) {
-      if (Array.isArray(value)) {
-        value.forEach((v, i) => {
-          if (typeof v !== type) {
-            throw new Error(`${name}[${i}] must be a ${type} (not a ${typeof v[i]})`);
-          }
-        });
-        return;
-      }
-    }
-    if (typeof value !== type) {
-      throw new Error(`${name} must be a ${type} (not a ${typeof value})`);
-    }
-  }
-
-  /** See net.Socket.end */
-  public end(data: string): void {
-    this._socket.end(data);
-  }
-
-  /** See stream.Readable.pipe */
-  public pipe(dest: any, options: any): any {
-    return this._socket.pipe(dest, options);
-  }
-
-  /** See net.Socket.pause */
-  public pause(): Socket {
-    return this._socket.pause();
-  }
-
-  /** See net.Socket.resume */
-  public resume(): Socket {
-    return this._socket.resume();
-  }
-
-  /** See net.Socket.setEncoding */
-  public setEncoding(encoding: string | null): void {
-    if ((this._socket as any)._decoder) {
-      delete (this._socket as any)._decoder;
-    }
-    if (encoding) {
-      this._socket.setEncoding(encoding);
-    }
-  }
-
-  public addListener(eventName: string, listener: (...args: any[]) => any): void { this.on(eventName, listener); }
-  public on(eventName: string, listener: (...args: any[]) => any): void {
-    if (eventName === 'close') {
-      this._internalee.on('close', listener);
-      return;
-    }
-    this._socket.on(eventName, listener);
-  }
-
-  public emit(eventName: string, ...args: any[]): any {
-    if (eventName === 'close') {
-      return this._internalee.emit.apply(this._internalee, arguments as any);
-    }
-    return this._socket.emit.apply(this._socket, arguments as any);
-  }
-
-  public listeners(eventName: string): Function[] {
-    return this._socket.listeners(eventName);
-  }
-
-  public removeListener(eventName: string, listener: (...args: any[]) => any): void {
-    this._socket.removeListener(eventName, listener);
-  }
-
-  public removeAllListeners(eventName: string): void {
-    this._socket.removeAllListeners(eventName);
-  }
-
-  public once(eventName: string, listener: (...args: any[]) => any): void {
-    this._socket.once(eventName, listener);
-  }
-
-  public abstract resize(cols: number, rows: number): void;
-  public abstract clear(): void;
-  public abstract destroy(): void;
-  public abstract kill(signal?: string): void;
-
-  public abstract get process(): string;
-  public abstract get master(): Socket| undefined;
-  public abstract get slave(): Socket | undefined;
-
-  protected _close(): void {
-    this._socket.readable = false;
-    this.write = () => {};
-    this.end = () => {};
-    this._writable = false;
-    this._readable = false;
-  }
-
-  protected _parseEnv(env: IProcessEnv): string[] {
-    const keys = Object.keys(env || {});
-    const pairs = [];
-
-    for (let i = 0; i < keys.length; i++) {
-      if (keys[i] === undefined) {
-        continue;
-      }
-      pairs.push(keys[i] + '=' + env[keys[i]]);
-    }
-
-    return pairs;
-  }
-}

package/src/testUtils.test.ts

@@ -1,23 +0,0 @@
-/**
- * Copyright (c) 2019, Microsoft Corporation (MIT License).
- */
-
-export function pollUntil(cb: () => boolean, timeout: number, interval: number): Promise<void> {
-  return new Promise<void>((resolve, reject) => {
-    const intervalId = setInterval(() => {
-      if (cb()) {
-        clearInterval(intervalId);
-        clearTimeout(timeoutId);
-        resolve();
-      }
-    }, interval);
-    const timeoutId = setTimeout(() => {
-      clearInterval(intervalId);
-      if (cb()) {
-        resolve();
-      } else {
-        reject();
-      }
-    }, timeout);
-  });
-}

package/src/tsconfig.json

@@ -1,22 +0,0 @@
-{
-  "compilerOptions": {
-    "module": "commonjs",
-    "target": "es5",
-    "rootDir": ".",
-    "outDir": "../lib",
-    "sourceMap": true,
-    "lib": [
-      "es2015"
-    ],
-    "strict": true
-  },
-  "exclude": [
-    "node_modules",
-    "scripts",
-    "index.js",
-    "demo.js",
-    "lib",
-    "test",
-    "examples"
-  ]
-}

package/src/types.ts

@@ -1,15 +0,0 @@
-/**
- * Copyright (c) 2017, Daniel Imms (MIT License).
- * Copyright (c) 2018, Microsoft Corporation (MIT License).
- */
-
-export type ArgvOrCommandLine = string[] | string;
-
-export interface IExitEvent {
-  exitCode: number;
-  signal: number | undefined;
-}
-
-export interface IDisposable {
-  dispose(): void;
-}