Improve ports

package.json

@@ -155,6 +155,7 @@
 		"analytics-node": "^6.2.0",
 		"configcat-node": "^8.0.0",
 		"js-yaml": "^4.1.0",
+		"jsonc-parser": "^3.2.0",
 		"node-fetch": "2.6.7",
 		"pkce-challenge": "^3.0.0",
 		"semver": "^7.3.7",

src/remoteConnector.ts

@@ -5,6 +5,7 @@
 
 import { AutoTunnelRequest, ResolveSSHConnectionRequest, ResolveSSHConnectionResponse } from '@gitpod/local-app-api-grpcweb/lib/localapp_pb';
 import { LocalAppClient } from '@gitpod/local-app-api-grpcweb/lib/localapp_pb_service';
+import { WorkspaceConfig, PortConfig, PortOnOpen } from '@gitpod/gitpod-protocol/lib/protocol';
 import { NodeHttpTransport } from '@improbable-eng/grpc-web-node-http-transport';
 import { grpc } from '@improbable-eng/grpc-web';
 import * as cp from 'child_process';
@@ -18,6 +19,7 @@ import { ParsedKey } from 'ssh2-streams';
 import * as tmp from 'tmp';
 import * as path from 'path';
 import * as vscode from 'vscode';
+import { parse as parseJson, modify as modifyJson, applyEdits as applyEditsJson } from 'jsonc-parser';
 import Log from './common/logger';
 import { Disposable } from './common/dispose';
 import { withServerApi } from './internalApi';
@@ -1028,6 +1030,71 @@ export default class RemoteConnector extends Disposable {
 		}
 	}
 
+	private async configureMachineSettings(wsConfig: WorkspaceConfig) {
+		// Let's reuse the `__gitpod.getGitpodRemoteLogsUri` command to get the vscode-server folder
+		let extRemoteLogsUri: vscode.Uri | undefined;
+		try {
+			extRemoteLogsUri = await retry(async () => {
+				return await vscode.commands.executeCommand('__gitpod.getGitpodRemoteLogsUri');
+			}, 3000, 15);
+		} catch {
+		}
+
+		if (!extRemoteLogsUri) {
+			return;
+		}
+
+		const remoteUserDataPath = path.posix.dirname(path.posix.dirname(path.posix.dirname(path.posix.dirname(extRemoteLogsUri.path))));
+		const machineSettingsResource = extRemoteLogsUri.with({ path: path.posix.join(remoteUserDataPath, 'Machine', 'settings.json') });
+		try {
+			let settingsStr: string = '{}';
+			const fileExists = await vscode.workspace.fs.stat(machineSettingsResource).then(() => true, () => false);
+			if (fileExists) {
+				const settingsbuffer = await vscode.workspace.fs.readFile(machineSettingsResource);
+				settingsStr = new TextDecoder().decode(settingsbuffer);
+			}
+
+			// settings.json is a json with comments file so we use jsonc-parser library
+			const settingsJson = parseJson(settingsStr);
+			if (settingsJson['remote.autoForwardPortsSource'] === undefined) {
+				const edits = modifyJson(settingsStr, ['remote.autoForwardPortsSource'], 'process', { formattingOptions: { insertSpaces: true, tabSize: 4, insertFinalNewline: true } });
+				settingsStr = applyEditsJson(settingsStr, edits);
+			}
+			if (settingsJson['remote.portsAttributes'] === undefined && wsConfig.ports?.length) {
+				const mapOnOpen = (onOpen?: PortOnOpen)=>{
+					switch (onOpen) {
+						case 'open-browser': return 'openBrowser';
+						case 'open-preview': return 'openPreview';
+						default: return onOpen;
+					}
+				};
+
+				const portsAttributes: any = {};
+				for (const portConfig of wsConfig.ports) {
+					portsAttributes[portConfig.port] = {
+						label: portConfig.name,
+						onAutoForward: mapOnOpen(portConfig.onOpen)
+					};
+				}
+				const edits = modifyJson(settingsStr, ['remote.portsAttributes'], portsAttributes, { formattingOptions: { insertSpaces: true, tabSize: 4, insertFinalNewline: true } });
+				settingsStr = applyEditsJson(settingsStr, edits);
+			}
+
+			const settingsbuffer = new TextEncoder().encode(settingsStr);
+			await vscode.workspace.fs.writeFile(machineSettingsResource, settingsbuffer);
+		} catch (e) {
+			this.logger.error(`Could not update ${machineSettingsResource.toString()} resource`, e);
+		}
+	}
+
+	private async tunnelPortsFromConfig(portsConfig: PortConfig[]) {
+		for (const portConfig of portsConfig) {
+			if (portConfig.onOpen !== 'ignore') {
+				await vscode.env.asExternalUri(vscode.Uri.parse(`http://localhost:${portConfig.port}`));
+			}
+		}
+	}
+
 	private async onGitpodRemoteConnection() {
 		const remoteUri = vscode.workspace.workspaceFile || vscode.workspace.workspaceFolders?.[0].uri;
 		if (!remoteUri) {
@@ -1057,6 +1124,8 @@ export default class RemoteConnector extends Disposable {
 
 		await this.context.globalState.update(`${RemoteConnector.SSH_DEST_KEY}${sshDestStr}`, { ...connectionInfo, isFirstConnection: false });
 
+		this.configureMachineSettings(workspaceInfo.workspace.config).then(() => this.tunnelPortsFromConfig(workspaceInfo.workspace.config.ports ?? []));
+
 		const gitpodVersion = await getGitpodVersion(connectionInfo.gitpodHost, this.logger);
 
 		const heartbeatSupported = session.scopes.includes(ScopeFeature.LocalHeartbeat);

yarn.lock

@@ -1798,6 +1798,11 @@ json-stable-stringify-without-jsonify@^1.0.1:
   resolved "https://registry.yarnpkg.com/json-stable-stringify-without-jsonify/-/json-stable-stringify-without-jsonify-1.0.1.tgz#9db7b59496ad3f3cfef30a75142d2d930ad72651"
   integrity sha1-nbe1lJatPzz+8wp1FC0tkwrXJlE=
 
+jsonc-parser@^3.2.0:
+  version "3.2.0"
+  resolved "https://registry.yarnpkg.com/jsonc-parser/-/jsonc-parser-3.2.0.tgz#31ff3f4c2b9793f89c67212627c51c6394f88e76"
+  integrity sha512-gfFQZrcTc8CnKXp6Y4/CBT3fTc0OVuDofpre4aEeEpSBPV5X5v4+Vmx+8snU7RLPrNHPKSgLxGo9YuQzz20o+w==
+
 kind-of@^6.0.2:
   version "6.0.3"
   resolved "https://registry.yarnpkg.com/kind-of/-/kind-of-6.0.3.tgz#07c05034a6c349fa06e24fa35aa76db4580ce4dd"