Ports attributes API updates (microsoft#182617)

* Ports attributes API updates
Part of microsoft#115616

* Remove port number from attributes API

Author: alexr00

src/vs/workbench/api/browser/mainThreadTunnelService.ts

@@ -86,7 +86,7 @@ export class MainThreadTunnelService extends Disposable implements MainThreadTun
 			const portRange = selector.portRange;
 			const portInRange = portRange ? ports.some(port => portRange[0] <= port && port < portRange[1]) : true;
 			const pidMatches = !selector.pid || (selector.pid === pid);
-			const commandMatches = !selector.commandMatcher || (commandLine && (commandLine.match(selector.commandMatcher)));
+			const commandMatches = !selector.commandPattern || (commandLine && (commandLine.match(selector.commandPattern)));
 			return portInRange && pidMatches && commandMatches;
 		}).map(entry => entry[0]);
 

src/vs/workbench/api/common/extHost.api.impl.ts

@@ -1071,7 +1071,7 @@ export function createApiFactoryAndRegisterActors(accessor: ServicesAccessor): I
 				checkProposedApiEnabled(extension, 'tunnels');
 				return extHostTunnelService.onDidChangeTunnels(listener, thisArg, disposables);
 			},
-			registerPortAttributesProvider: (portSelector: { pid?: number; portRange?: [number, number]; commandMatcher?: RegExp }, provider: vscode.PortAttributesProvider) => {
+			registerPortAttributesProvider: (portSelector: { pid?: number; portRange?: [number, number]; commandPattern?: RegExp }, provider: vscode.PortAttributesProvider) => {
 				checkProposedApiEnabled(extension, 'portsAttributes');
 				return extHostTunnelService.registerPortsAttributesProvider(portSelector, provider);
 			},

src/vs/workbench/api/common/extHost.protocol.ts

@@ -1400,7 +1400,7 @@ export enum CandidatePortSource {
 export interface PortAttributesProviderSelector {
 	pid?: number;
 	portRange?: [number, number];
-	commandMatcher?: RegExp;
+	commandPattern?: RegExp;
 }
 
 export interface MainThreadTunnelServiceShape extends IDisposable {

src/vs/workbench/api/common/extHostTunnelService.ts

@@ -48,7 +48,7 @@ export interface IExtHostTunnelService extends ExtHostTunnelServiceShape {
 	getTunnels(): Promise<vscode.TunnelDescription[]>;
 	onDidChangeTunnels: vscode.Event<void>;
 	setTunnelFactory(provider: vscode.RemoteAuthorityResolver | undefined): Promise<IDisposable>;
-	registerPortsAttributesProvider(portSelector: { pid?: number; portRange?: [number, number]; commandMatcher?: RegExp }, provider: vscode.PortAttributesProvider): IDisposable;
+	registerPortsAttributesProvider(portSelector: { pid?: number; portRange?: [number, number]; commandPattern?: RegExp }, provider: vscode.PortAttributesProvider): IDisposable;
 }
 
 export const IExtHostTunnelService = createDecorator<IExtHostTunnelService>('IExtHostTunnelService');

src/vs/workbench/api/common/extHostTypes.ts

@@ -3834,15 +3834,16 @@ export class LinkedEditingRanges {
 
 //#region ports
 export class PortAttributes {
-	private _port: number;
 	private _autoForwardAction: PortAutoForwardAction;
-	constructor(port: number, autoForwardAction: PortAutoForwardAction) {
-		this._port = port;
-		this._autoForwardAction = autoForwardAction;
-	}
 
-	get port(): number {
-		return this._port;
+	constructor(autoForwardAction: PortAutoForwardAction);
+	constructor(port: number, autoForwardAction: PortAutoForwardAction);
+	constructor(portOrAction: number | PortAutoForwardAction, autoForwardAction?: PortAutoForwardAction) {
+		if (typeof portOrAction === 'number') {
+			this._autoForwardAction = autoForwardAction!;
+		} else {
+			this._autoForwardAction = portOrAction;
+		}
 	}
 
 	get autoForwardAction(): PortAutoForwardAction {

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

@@ -244,22 +244,22 @@ export class ExtHostTunnelService extends Disposable implements IExtHostTunnelSe
 	}
 
 	async $providePortAttributes(handles: number[], ports: number[], pid: number | undefined, commandline: string | undefined, cancellationToken: vscode.CancellationToken): Promise<ProvidedPortAttributes[]> {
-		const providedAttributes: vscode.ProviderResult<vscode.PortAttributes>[] = [];
+		const providedAttributes: { providedAttributes: vscode.PortAttributes | null | undefined; port: number }[] = [];
 		for (const handle of handles) {
 			const provider = this._portAttributesProviders.get(handle);
 			if (!provider) {
 				return [];
 			}
 			providedAttributes.push(...(await Promise.all(ports.map(async (port) => {
-				return provider.provider.providePortAttributes(port, pid, commandline, cancellationToken);
+				return { providedAttributes: (await provider.provider.providePortAttributes(port, pid, commandline, cancellationToken)), port };
 			}))));
 		}
 
-		const allAttributes = <vscode.PortAttributes[]>providedAttributes.filter(attribute => !!attribute);
+		const allAttributes = <{ providedAttributes: vscode.PortAttributes; port: number }[]>providedAttributes.filter(attribute => !!attribute.providedAttributes);
 
 		return (allAttributes.length > 0) ? allAttributes.map(attributes => {
 			return {
-				autoForwardAction: <ProvidedOnAutoForward><unknown>attributes.autoForwardAction,
+				autoForwardAction: <ProvidedOnAutoForward><unknown>attributes.providedAttributes.autoForwardAction,
 				port: attributes.port
 			};
 		}) : [];

src/vscode-dts/vscode.proposed.portsAttributes.d.ts

@@ -16,25 +16,30 @@ declare module 'vscode' {
 		OpenBrowserOnce = 6
 	}
 
+	/**
+	 * The attributes that a forwarded port can have.
+	 */
 	export class PortAttributes {
-		/**
-		 * The port number associated with this this set of attributes.
-		 */
-		port: number;
-
 		/**
 		 * The action to be taken when this port is detected for auto forwarding.
 		 */
 		autoForwardAction: PortAutoForwardAction;
 
+		/**
+		 * @deprecated
+		 */
+		constructor(port: number, autoForwardAction: PortAutoForwardAction);
 		/**
 		 * Creates a new PortAttributes object
 		 * @param port the port number
 		 * @param autoForwardAction the action to take when this port is detected
 		 */
-		constructor(port: number, autoForwardAction: PortAutoForwardAction);
+		constructor(autoForwardAction: PortAutoForwardAction);
 	}
 
+	/**
+	 * A provider of port attributes. Port attributes are used to determine what action should be taken when a port is discovered.
+	 */
 	export interface PortAttributesProvider {
 		/**
 		 * Provides attributes for the given port. For ports that your extension doesn't know about, simply
@@ -55,8 +60,9 @@ declare module 'vscode' {
 		 * know the range of ports or the pid of your process. All properties of a the portSelector must be true for your
 		 * provider to get called.
 		 * The `portRange` is start inclusive and end exclusive.
+		 * The `commandPattern` is a regular expression that will be matched against the command line of the process.
 		 * @param provider The PortAttributesProvider
 		 */
-		export function registerPortAttributesProvider(portSelector: { pid?: number; portRange?: [number, number]; commandMatcher?: RegExp }, provider: PortAttributesProvider): Disposable;
+		export function registerPortAttributesProvider(portSelector: { pid?: number; portRange?: [number, number]; commandPattern?: RegExp }, provider: PortAttributesProvider): Disposable;
 	}
 }