Terminal: Bring back / enable TerminalService API (#20)

* Bring back node-pty, update lockfile

* Revert changes to terminalProcess.ts

* Update node to pick up latest 10.x

* Experiment with npmrc

* Revert "Experiment with npmrc"

This reverts commit a0db22b.

* Remove yarnrc

* Remove electron checks

* Remove gc-signals

* it...built?

* Logging / hacks to get terminal service available

* Revert changes to mainThreadHeapService

* Add test case for terminal execution

* Simplify first test to just check for process exit

* Fix bug with windows terminal output

* Add test for  /

* Clean up, add config neeeded to enable terminal

* Get tests green with configuration update

* Remove logging

* Save sandbox test

__sandbox__/test.js

@@ -72,7 +72,32 @@ let run = async () => {
     connection.sendNotification(extMessage, {
         type: 4, /* RequestJSONArgs */
         reqId: 2,
-        payload: ["ExtHostConfiguration", "$initializeConfiguration", [{}]],
+        payload: ["ExtHostConfiguration", "$initializeConfiguration", [{
+                defaults: {
+                    contents: {
+                        suggest: {
+                            enabled: true
+                        },
+                        terminal: {
+                            integrated: {
+                                env: {
+                                    windows: {},
+                                    linux: {},
+                                    osx: {},
+                                }
+                            }
+                    }
+                    },
+                    keys: ["suggest.enabled", "terminal.integrated"],
+                    overrides: [],
+                },
+                user: {},
+                workspace: {},
+                folders: {},
+                isComplete: true,
+                configurationScopes: {},
+
+        }]],
     });
 
     connection.sendNotification(extMessage, {
@@ -96,6 +121,34 @@ let run = async () => {
     // }, 1000);
 
 
+    setTimeout(() => {
+
+        console.log("SENDING MESSAGE");
+        connection.sendNotification(extMessage, {
+            type: 4,
+            reqId: 3,
+            payload: ["ExtHostTerminalService", "$createProcess", [
+                    1, {
+                        name: "Terminal 1",
+                        executable: "/non-existent-item",
+                        args: [],
+                    },{
+                        //scheme: "file",
+                        //path: "/Users/bryphe"
+                    },
+                    20,
+                    20
+            ]]
+        });
+        connection.sendNotification(extMessage, {
+            type: 4,
+            reqId: 3,
+            payload: ["ExtHostTerminalService", "$acceptProcessInput", [
+                    1, "git status\n"
+            ]]
+        });
+    }, 2000);
+
     let testModelAdded = {
         uri: {
             scheme: "file",
@@ -116,7 +169,7 @@ let run = async () => {
     };
 
 
-    setTimeout(() => {
+    /*setTimeout(() => {
         connection.sendNotification(extMessage, {
             type: 4,
             reqId: 3,
@@ -148,7 +201,7 @@ let run = async () => {
                 true,
             ]],
         });
-    }, 2000);
+    }, 2000);*/
 
     let closePromise = new Promise((c) => {
         connection.onClose(() => c());

__tests__/ExtensionHost.ts

@@ -85,18 +85,20 @@ export interface IExtensionHost {
     waitForMessageOnce: (rpcName: string, methodName: string, filter?: filterFunc) => Promise<void>;
 
     // ExtHostWorkspace
-    acceptWorkspaceData(uri: any, name: string, id: string);
+    acceptWorkspaceData: (uri: any, name: string, id: string) => any;
 
     // ExtHostConfiguration
-    acceptConfigurationChanged(data: any, configurationChangeData: any);
+    acceptConfigurationChanged: (data: any, configurationChangeData: any) => any;
 
     createDocument: (uri: any, lines: string[], modeId: string) => void;
     updateDocument: (uri: any, range: ChangedEventRange, text: string, version: number) => void;
 
-    executeContributedCommand(id: string);
+    executeContributedCommand: (id: string) => any;
 
     provideCompletionItems: (handle: number, resource: any, position: any, context: any) => Promise<any>;
 
+    terminalCreateProcess: (id: number, terminalOptions: any, width: number, height: number) => void;
+
     onMessage: IEvent<any>;
 }
 
@@ -192,9 +194,18 @@ export let withExtensionHost = async (extensions: string[], f: apiFunction) => {
                     contents: {
                         suggest: {
                             enabled: true
+                        },
+                        terminal: {
+                            integrated: {
+                                env: {
+                                    windows: null,
+                                    linux: null,
+                                    osx: null,
+                                }
+                            }
                         }
                     },
-                    keys: ["suggest.enabled"],
+                    keys: ["suggest.enabled", "terminal.integrated"],
                     overrides: [],
                 },
                 user: {},
@@ -332,6 +343,21 @@ export let withExtensionHost = async (extensions: string[], f: apiFunction) => {
     let provideCompletionItems = (handle: number, resource: any, position: any, context: any) => {
         return sendRequestWithCancellation(["ExtHostLanguageFeatures", "$provideCompletionItems", [handle, resource, position, context]]);
     };
+    let terminalCreateProcess = (id: number, terminalOptions: any, width: number, height: number) => {
+        sendNotification([
+            "ExtHostTerminalService",
+            "$createProcess",
+            [
+                id,
+                terminalOptions,
+                { 
+                    // TODO: Working directory
+                },
+                20,
+                20,
+            ]
+        ]);
+    };
 
     let extHost = {
         start,
@@ -344,6 +370,7 @@ export let withExtensionHost = async (extensions: string[], f: apiFunction) => {
         executeContributedCommand,
         updateDocument,
         provideCompletionItems,
+        terminalCreateProcess,
     };
 
     await f(extHost);

__tests__/Terminal.Test.ts

@@ -0,0 +1,80 @@
+import * as path from "path";
+
+import * as ExtensionHost from "./ExtensionHost";
+
+let extensionPath = path.join(__dirname, "..", "test_extensions", "oni-api-tests", "package.json");
+
+describe("Terminal", () => {
+    test("Verify we get a $sendProcessExit for a command that does not exist", async () => {
+        await ExtensionHost.withExtensionHost([extensionPath], async (api) => {
+
+            let terminalSendProcessExit = 
+            api.waitForMessageOnce("MainThreadTerminalService", "$sendProcessExit", (args) => {
+                console.log("$sendProcessExit: " + args[1]);
+                return true;
+            });
+
+            await api.start();
+
+            api.terminalCreateProcess(1, {
+                name: "Terminal 1",
+                executable: "/non-existent-item",
+                args: [],
+            },
+            20, 
+            20);
+
+            await terminalSendProcessExit;
+        });
+    });
+
+    test("Verify we get a $sendProcessData / $sendProcessTitle for a command that works", async () => {
+        await ExtensionHost.withExtensionHost([extensionPath], async (api) => {
+            let terminalSendProcessTitle = 
+                api.waitForMessageOnce("MainThreadTerminalService", "$sendProcessTitle", (args) => {
+                    console.log("$sendProcessTitle: " + args[1]);
+                    return true;
+                });
+
+            let terminalSendProcessData = 
+                api.waitForMessageOnce("MainThreadTerminalService", "$sendProcessData", (args) => {
+                    console.log("$sendProcessData: " + args[1]);
+                    return true;
+                });
+
+            let terminalSendProcessExit = 
+                api.waitForMessageOnce("MainThreadTerminalService", "$sendProcessExit", (args) => {
+                    console.log("$sendProcessExit: " + args[1]);
+                    return true;
+                });
+
+            let terminalArgs: any = null;
+            if(process.platform == "win32") {
+               terminalArgs = {
+                name: "Windows Terminal",
+                executable: "cmd.exe",
+                args: ["/c", "echo", "hello"]
+               }
+            } else {
+
+               terminalArgs = {
+                name: "Bash Terminal",
+                executable: "bash",
+                args: ["-c", "echo hello"]
+               }
+            }
+
+            await api.start();
+
+            api.terminalCreateProcess(
+                1,
+                terminalArgs,
+                20, 
+                20);
+
+            await terminalSendProcessTitle;
+            await terminalSendProcessData;
+            await terminalSendProcessExit;
+        });
+    });
+});

build/azure-pipelines/common/symbols.ts

@@ -174,7 +174,8 @@ async function ensureVersionAndSymbols(options: IOptions) {
 const pakage = require('../../../package.json');
 const product = require('../../../product.json');
 const repository = product.electronRepository;
-const electronVersion = require('../../lib/electron').getElectronVersion();
+// Onivim: We're running via Node, not electron
+const electronVersion = "?.?.?";
 const insiders = product.quality !== 'stable';
 let codeVersion = pakage.version;
 if (insiders) {
@@ -216,4 +217,4 @@ if (repository && codeVersion && electronVersion && (product.quality === 'stable
 	});
 } else {
 	console.log(`HockeyApp: skipping due to unexpected context (repository: ${repository}, codeVersion: ${codeVersion}, electronVersion: ${electronVersion}, quality: ${product.quality})`);
-}
+}

build/azure-pipelines/continuous-build-oni.yml

@@ -1,7 +1,7 @@
 steps:
 - task: NodeTool@0
   inputs:
-    versionSpec: "10.15.1"
+    versionSpec: "10.x"
 - powershell: |
     npm install -g [email protected]
   displayName: Install jest

build/gulpfile.vscode.js

@@ -141,7 +141,8 @@ function darwinBundleDocumentType(extensions, icon) {
 }
 
 const config = {
-	version: getElectronVersion(),
+	//version: getElectronVersion(),
+	version: "9.9.9",
 	productAppName: product.nameLong,
 	companyName: 'Microsoft Corporation',
 	copyright: 'Copyright (C) 2019 Microsoft. All rights reserved',

build/lib/electron.js

@@ -10,21 +10,23 @@ const path = require('path');
 const root = path.dirname(path.dirname(__dirname));
 
 function getElectronVersion() {
-	const yarnrc = fs.readFileSync(path.join(root, '.yarnrc'), 'utf8');
+	//const yarnrc = fs.readFileSync(path.join(root, '.yarnrc'), 'utf8');
 	// @ts-ignore
-	const target = /^target "(.*)"$/m.exec(yarnrc)[1];
+	//const target = /^target "(.*)"$/m.exec(yarnrc)[1];
 
-	return target;
+	//return target;
+	return "9.9.9";
 }
 
 module.exports.getElectronVersion = getElectronVersion;
 
 // returns 0 if the right version of electron is in .build/electron
 // @ts-ignore
 if (require.main === module) {
-	const version = getElectronVersion();
-	const versionFile = path.join(root, '.build', 'electron', 'version');
-	const isUpToDate = fs.existsSync(versionFile) && fs.readFileSync(versionFile, 'utf8') === `v${version}`;
+	// const version = getElectronVersion();
+	// const versionFile = path.join(root, '.build', 'electron', 'version');
+	// const isUpToDate = fs.existsSync(versionFile) && fs.readFileSync(versionFile, 'utf8') === `v${version}`;
 
-	process.exit(isUpToDate ? 0 : 1);
+	// process.exit(isUpToDate ? 0 : 1);
+	return 0;
 }

build/npm/preinstall.js

@@ -7,10 +7,11 @@ let err = false;
 
 const majorNodeVersion = parseInt(/^(\d+)\./.exec(process.versions.node)[1]);
 
-// if (majorNodeVersion < 8 || majorNodeVersion >= 11) {
-// 	console.error('\033[1;31m*** Please use node >=8 and <11.\033[0;0m');
-// 	err = true;
-// }
+// Needed for native dependencies
+if (majorNodeVersion < 8 || majorNodeVersion >= 11) {
+	console.error('\033[1;31m*** Please use node >=8 and <11.\033[0;0m');
+	err = true;
+}
 
 const cp = require('child_process');
 const yarnVersion = cp.execSync('yarn -v', { encoding: 'utf8' }).trim();
@@ -31,4 +32,4 @@ if (!/yarn\.js$|yarnpkg$/.test(process.env['npm_execpath'])) {
 if (err) {
 	console.error('');
 	process.exit(1);
-}
+}

oni.package.json

@@ -14,7 +14,8 @@
     "graceful-fs": "4.1.11",
     "iconv-lite": "0.4.23",
     "semver": "^5.5.0",
-    "vscode-jsonrpc": "4.0.0"
+    "vscode-jsonrpc": "4.0.0",
+    "node-pty": "0.8.1"
   },
   "devDependencies": {
   },

package.json

@@ -41,7 +41,7 @@
     "minimist": "1.2.0",
     "native-is-elevated": "^0.2.1",
     "native-keymap": "1.2.5",
-    "native-watchdog": "1.0.0",
+    "node-pty": "0.8.1",
     "semver": "^5.5.0",
     "spdlog": "0.7.2",
     "sudo-prompt": "8.2.0",

src/vs/workbench/api/node/extHostTerminalService.ts

@@ -464,8 +464,9 @@ export class ExtHostTerminalService implements ExtHostTerminalServiceShape {
 		// // Resolve env vars from config and shell
 		// const lastActiveWorkspaceRoot = this._workspaceContextService.getWorkspaceFolder(lastActiveWorkspaceRootUri);
 		const platformKey = platform.isWindows ? 'windows' : (platform.isMacintosh ? 'osx' : 'linux');
-		// const envFromConfig = terminalEnvironment.resolveConfigurationVariables(this._configurationResolverService, { ...terminalConfig.env[platformKey] }, lastActiveWorkspaceRoot);
+		//const envFromConfig = terminalEnvironment.resolveConfigurationVariables(this._configurationResolverService, { ...terminalConfig.env[platformKey] }, lastActiveWorkspaceRoot);
 		const envFromConfig = { ...terminalConfig.env[platformKey] };
+
 		// const envFromShell = terminalEnvironment.resolveConfigurationVariables(this._configurationResolverService, { ...shellLaunchConfig.env }, lastActiveWorkspaceRoot);
 
 		// Merge process env with the env from config
@@ -483,10 +484,14 @@ export class ExtHostTerminalService implements ExtHostTerminalServiceShape {
 
 		// Fork the process and listen for messages
 		this._logService.debug(`Terminal process launching on ext host`, shellLaunchConfig, initialCwd, cols, rows, env);
-		const p = new TerminalProcess(shellLaunchConfig, initialCwd, cols, rows, env, terminalConfig.get('windowsEnableConpty'));
+		// TODO:  Bring back `terminalConfig.get('windowsEnableConpty'));`
+		// When running as a node process, if true, this will push output to stdout and not giving `onProcessData` a chance to intercept
+		const p = new TerminalProcess(shellLaunchConfig, initialCwd, cols, rows, env, /* windowsEnableConpty */ false);
 		p.onProcessIdReady(pid => this._proxy.$sendProcessPid(id, pid));
 		p.onProcessTitleChanged(title => this._proxy.$sendProcessTitle(id, title));
-		p.onProcessData(data => this._proxy.$sendProcessData(id, data));
+		p.onProcessData(data => {
+			this._proxy.$sendProcessData(id, data)
+		});
 		p.onProcessExit((exitCode) => this._onProcessExit(id, exitCode));
 		this._terminalProcesses[id] = p;
 	}