Start enforcing the tunnels API (microsoft#163187)

alexr00 · web-flow · commit 23e6c032afd6 · 2022-10-10T10:10:24.000-07:00
* Start enforcing the tunnels API

* Fix API test
diff --git a/extensions/vscode-api-tests/package.json b/extensions/vscode-api-tests/package.json
@@ -34,6 +34,7 @@
     "taskPresentationGroup",
     "terminalDataWriteEvent",
     "terminalDimensions",
+	"tunnels",
     "envShellEvent",
     "testCoverage",
     "testObserver",
diff --git a/extensions/vscode-test-resolver/package.json b/extensions/vscode-test-resolver/package.json
@@ -6,7 +6,8 @@
   "license": "MIT",
   "enableProposedApi": true,
   "enabledApiProposals": [
-    "resolvers"
+    "resolvers",
+	"tunnels"
   ],
   "private": true,
   "engines": {
diff --git a/extensions/vscode-test-resolver/tsconfig.json b/extensions/vscode-test-resolver/tsconfig.json
@@ -9,6 +9,7 @@
 	"include": [
 		"src/**/*",
 		"../../src/vscode-dts/vscode.d.ts",
+		"../../src/vscode-dts/vscode.proposed.tunnels.d.ts",
 		"../../src/vscode-dts/vscode.proposed.resolvers.d.ts"
 	]
 }
diff --git a/src/vs/workbench/api/common/extHost.api.impl.ts b/src/vs/workbench/api/common/extHost.api.impl.ts
@@ -1010,7 +1010,7 @@ export function createApiFactoryAndRegisterActors(accessor: ServicesAccessor): I
 				return extHostFileSystemEvent.getOnWillRenameFileEvent(extension)(listener, thisArg, disposables);
 			},
 			openTunnel: (forward: vscode.TunnelOptions) => {
-				checkProposedApiEnabled(extension, 'resolvers');
+				checkProposedApiEnabled(extension, 'tunnels');
 				return extHostTunnelService.openTunnel(extension, forward).then(value => {
 					if (!value) {
 						throw new Error('cannot open tunnel');
@@ -1019,11 +1019,11 @@ export function createApiFactoryAndRegisterActors(accessor: ServicesAccessor): I
 				});
 			},
 			get tunnels() {
-				checkProposedApiEnabled(extension, 'resolvers');
+				checkProposedApiEnabled(extension, 'tunnels');
 				return extHostTunnelService.getTunnels();
 			},
 			onDidChangeTunnels: (listener, thisArg?, disposables?) => {
-				checkProposedApiEnabled(extension, 'resolvers');
+				checkProposedApiEnabled(extension, 'tunnels');
 				return extHostTunnelService.onDidChangeTunnels(listener, thisArg, disposables);
 			},
 			registerPortAttributesProvider: (portSelector: { pid?: number; portRange?: [number, number]; commandMatcher?: RegExp }, provider: vscode.PortAttributesProvider) => {
diff --git a/src/vscode-dts/vscode.proposed.resolvers.d.ts b/src/vscode-dts/vscode.proposed.resolvers.d.ts
@@ -43,7 +43,7 @@ declare module 'vscode' {
 		label: string;
 	}
 
-	export interface TunnelOptions {
+	interface TunnelOptions {
 		remoteAddress: { port: number; host: string };
 		// The desired local port. If this port can't be used, then another will be chosen.
 		localAddressPort?: number;
@@ -56,7 +56,7 @@ declare module 'vscode' {
 		protocol?: string;
 	}
 
-	export interface TunnelDescription {
+	interface TunnelDescription {
 		remoteAddress: { port: number; host: string };
 		//The complete local address(ex. localhost:1234)
 		localAddress: { port: number; host: string } | string;
@@ -69,7 +69,7 @@ declare module 'vscode' {
 		protocol?: string;
 	}
 
-	export interface Tunnel extends TunnelDescription {
+	interface Tunnel extends TunnelDescription {
 		// Implementers of Tunnel should fire onDidDispose when dispose is called.
 		onDidDispose: Event<void>;
 		dispose(): void | Thenable<void>;
@@ -164,29 +164,6 @@ declare module 'vscode' {
 		candidatePortSource?: CandidatePortSource;
 	}
 
-	export namespace workspace {
-		/**
-		 * Forwards a port. If the current resolver implements RemoteAuthorityResolver:forwardPort then that will be used to make the tunnel.
-		 * By default, openTunnel only support localhost; however, RemoteAuthorityResolver:tunnelFactory can be used to support other ips.
-		 *
-		 * @throws When run in an environment without a remote.
-		 *
-		 * @param tunnelOptions The `localPort` is a suggestion only. If that port is not available another will be chosen.
-		 */
-		export function openTunnel(tunnelOptions: TunnelOptions): Thenable<Tunnel>;
-
-		/**
-		 * Gets an array of the currently available tunnels. This does not include environment tunnels, only tunnels that have been created by the user.
-		 * Note that these are of type TunnelDescription and cannot be disposed.
-		 */
-		// export let tunnels: Thenable<TunnelDescription[]>;
-
-		/**
-		 * Fired when the list of tunnels has changed.
-		 */
-		export const onDidChangeTunnels: Event<void>;
-	}
-
 	export interface ResourceLabelFormatter {
 		scheme: string;
 		authority?: string;
diff --git a/src/vscode-dts/vscode.proposed.tunnels.d.ts b/src/vscode-dts/vscode.proposed.tunnels.d.ts
@@ -12,6 +12,10 @@ declare module 'vscode' {
 		// The desired local port. If this port can't be used, then another will be chosen.
 		localAddressPort?: number;
 		label?: string;
+		/**
+		 * @deprecated Use privacy instead
+		 */
+		public?: boolean;
 		privacy?: string;
 		protocol?: string;
 	}
@@ -20,6 +24,10 @@ declare module 'vscode' {
 		remoteAddress: { port: number; host: string };
 		//The complete local address(ex. localhost:1234)
 		localAddress: { port: number; host: string } | string;
+		/**
+		 * @deprecated Use privacy instead
+		 */
+		public?: boolean;
 		privacy?: string;
 		// If protocol is not provided it is assumed to be http, regardless of the localAddress.
 		protocol?: string;
@@ -51,6 +59,6 @@ declare module 'vscode' {
 		/**
 		 * Fired when the list of tunnels has changed.
 		 */
-		// export const onDidChangeTunnels: Event<void>;
+		export const onDidChangeTunnels: Event<void>;
 	}
 }

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@`
`9`	`9`	`"include": [`
`10`	`10`	`"src/*/",`
`11`	`11`	`"../../src/vscode-dts/vscode.d.ts",`
	`12`	`+ "../../src/vscode-dts/vscode.proposed.tunnels.d.ts",`
`12`	`13`	`"../../src/vscode-dts/vscode.proposed.resolvers.d.ts"`
`13`	`14`	`]`
`14`	`15`	`}`