Enable task terminal location in gitpod-web

Author: jeanp413

extensions/gitpod-remote/src/extension.ts

@@ -5,7 +5,7 @@
 /// <reference path='../../../src/vs/vscode.d.ts'/>
 
 import * as cp from 'child_process';
-import { GitpodExtensionContext, setupGitpodContext } from 'gitpod-shared';
+import { GitpodExtensionContext, registerTasks, setupGitpodContext } from 'gitpod-shared';
 import * as http from 'http';
 import * as path from 'path';
 import * as util from 'util';
@@ -30,6 +30,7 @@ export async function activate(context: vscode.ExtensionContext) {
 		return;
 	}
 
+	registerTasks(gitpodContext, (options) => vscode.window.createTerminal(options));
 	installInitialExtensions(gitpodContext);
 	registerHearbeat(gitpodContext);
 	registerCLI(gitpodContext);

extensions/gitpod-shared/src/extension.ts

@@ -3,10 +3,10 @@
  *--------------------------------------------------------------------------------------------*/
 
 import * as vscode from 'vscode';
-import { createGitpodExtensionContext, GitpodExtensionContext, registerDefaultLayout, registerNotifications, registerWorkspaceCommands, registerWorkspaceSharing, registerWorkspaceTimeout, registerTasks } from './features';
+import { createGitpodExtensionContext, GitpodExtensionContext, registerDefaultLayout, registerNotifications, registerWorkspaceCommands, registerWorkspaceSharing, registerWorkspaceTimeout } from './features';
 import { performance } from 'perf_hooks';
 
-export { GitpodExtensionContext, SupervisorConnection } from './features';
+export { GitpodExtensionContext, SupervisorConnection, registerTasks } from './features';
 export * from './gitpod-plugin-model';
 
 export async function setupGitpodContext(context: vscode.ExtensionContext): Promise<GitpodExtensionContext | undefined> {
@@ -34,7 +34,6 @@ export async function setupGitpodContext(context: vscode.ExtensionContext): Prom
 	registerWorkspaceTimeout(gitpodContext);
 	registerNotifications(gitpodContext);
 	registerDefaultLayout(gitpodContext);
-	registerTasks(gitpodContext);
 	return gitpodContext;
 }
 

extensions/gitpod-shared/src/features.ts

@@ -651,7 +651,7 @@ function installCLIProxy(context: vscode.ExtensionContext, output: vscode.Output
 
 type TerminalOpenMode = 'tab-before' | 'tab-after' | 'split-left' | 'split-right' | 'split-top' | 'split-bottom';
 
-export async function registerTasks(context: GitpodExtensionContext): Promise<void> {
+export async function registerTasks(context: GitpodExtensionContext, createTerminal: (options: vscode.ExtensionTerminalOptions, parent: vscode.Terminal | undefined) => vscode.Terminal): Promise<void> {
 	const tokenSource = new vscode.CancellationTokenSource();
 	const token = tokenSource.token;
 	context.subscriptions.push({
@@ -698,30 +698,42 @@ export async function registerTasks(context: GitpodExtensionContext): Promise<vo
 		return;
 	}
 
-	const terminals = new Map<string, SupervisorTerminal>();
+	const taskTerminals = new Map<string, SupervisorTerminal>();
 	try {
 		const response = await util.promisify(context.supervisor.terminal.list.bind(context.supervisor.terminal, new ListTerminalsRequest(), context.supervisor.metadata, {
 			deadline: Date.now() + context.supervisor.deadlines.long
 		}))();
-		for (const terminal of response.getTerminalsList()) {
-			terminals.set(terminal.getAlias(), terminal);
+		for (const term of response.getTerminalsList()) {
+			taskTerminals.set(term.getAlias(), term);
 		}
 	} catch (e) {
-		console.error('failed to list terminals:', e);
+		console.error('failed to list task terminals:', e);
 	}
 
 	let prevTerminal: vscode.Terminal | undefined;
 	for (const [alias, taskStatus] of tasks.entries()) {
-		const terminal = terminals.get(alias);
-		if (terminal) {
+		const taskTerminal = taskTerminals.get(alias);
+		if (taskTerminal) {
 			const openMode: TerminalOpenMode | undefined = taskStatus.getPresentation()?.getOpenMode() as TerminalOpenMode;
-			let parentTerminal = (openMode && openMode !== 'tab-before' && openMode !== 'tab-after') ? prevTerminal : undefined;
-			prevTerminal = registerTask(alias, terminal.getTitle(), context, token, parentTerminal);
+			const parentTerminal = (openMode && openMode !== 'tab-before' && openMode !== 'tab-after') ? prevTerminal : undefined;
+			const pty = createTaskPty(alias, context, token);
+
+			// Delegate creation of the terminal to the extension caller
+			// if proposed API usage is required.
+			const terminal = createTerminal(
+				{
+					name: taskTerminal.getTitle(),
+					pty
+				},
+				parentTerminal
+			);
+			terminal.show();
+			prevTerminal = terminal;
 		}
 	}
 }
 
-function registerTask(alias: string, initialTitle: string, context: GitpodExtensionContext, contextToken: vscode.CancellationToken, parentTerminal?: vscode.Terminal): vscode.Terminal {
+function createTaskPty(alias: string, context: GitpodExtensionContext, contextToken: vscode.CancellationToken): vscode.Pseudoterminal {
 	const tokenSource = new vscode.CancellationTokenSource();
 	contextToken.onCancellationRequested(() => tokenSource.cancel());
 	const token = tokenSource.token;
@@ -876,16 +888,5 @@ function registerTask(alias: string, initialTitle: string, context: GitpodExtens
 		}
 	};
 
-	let proposedOptions = vscode.env.uiKind === vscode.UIKind.Web ? {
-		location: parentTerminal ? { parentTerminal } : 1 /* vscode.TerminalLocation.Panel */
-	} : {};
-	proposedOptions = {}; // TODO: enable this
-	const terminal = vscode.window.createTerminal({
-		name: initialTitle,
-		pty,
-		...proposedOptions
-	});
-	terminal.show();
-
-	return terminal;
+	return pty;
 }

extensions/gitpod-web/src/extension.ts

@@ -8,7 +8,7 @@
 import * as workspaceInstance from '@gitpod/gitpod-protocol/lib/workspace-instance';
 import * as grpc from '@grpc/grpc-js';
 import * as fs from 'fs';
-import { GitpodPluginModel, GitpodExtensionContext, setupGitpodContext } from 'gitpod-shared';
+import { GitpodPluginModel, GitpodExtensionContext, setupGitpodContext, registerTasks } from 'gitpod-shared';
 import { GetTokenRequest } from '@gitpod/supervisor-api-grpc/lib/token_pb';
 import { PortsStatus, ExposedPortInfo, PortsStatusRequest, PortsStatusResponse, PortAutoExposure, PortVisibility, OnPortExposedAction } from '@gitpod/supervisor-api-grpc/lib/status_pb';
 import { TunnelVisiblity, TunnelPortRequest, RetryAutoExposeRequest, CloseTunnelRequest } from '@gitpod/supervisor-api-grpc/lib/port_pb';
@@ -31,6 +31,12 @@ export async function activate(context: vscode.ExtensionContext) {
 	}
 	registerAuth(gitpodContext);
 	registerPorts(gitpodContext);
+	registerTasks(gitpodContext, (options, parentTerminal) => {
+		return vscode.window.createTerminal({
+			...options,
+			location: parentTerminal ? { parentTerminal } : vscode.TerminalLocation.Panel
+		});
+	});
 
 	const codeServer = new GitpodCodeServer();
 	registerCLI(codeServer, gitpodContext);