feat: support "debug url" in terminals created through the `node-term…

…inal` launch type (#2050)

Fixes #2049

CHANGELOG.md

@@ -4,6 +4,7 @@ This changelog records changes to stable releases since 1.50.2. "TBA" changes he
 
 ## Nightly (only)
 
+- feat: support "debug url" in terminals created through the `node-terminal` launch type ([#2049](https://github.com/microsoft/vscode-js-debug/issues/2049))
 - fix: hover evaluation incorrectly showing undefined ([vscode#221503](https://github.com/microsoft/vscode/issues/221503))
 
 ## v1.92 (July 2024)

src/common/terminalLinkProvider.ts

@@ -0,0 +1,18 @@
+/*---------------------------------------------------------
+ * Copyright (C) Microsoft Corporation. All rights reserved.
+ *--------------------------------------------------------*/
+
+import type * as vscode from 'vscode';
+
+/**
+ * Terminal link provider available when running in the vscode UI.
+ */
+export interface ITerminalLinkProvider<T extends vscode.TerminalLink = vscode.TerminalLink>
+  extends vscode.TerminalLinkProvider<T> {
+  /**
+   * Turns on link handling in the given terminal.
+   */
+  enableHandlingInTerminal(terminal: vscode.Terminal): void;
+}
+
+export const ITerminalLinkProvider = Symbol('ITerminalLinkProvider');

src/extension.ts

@@ -27,7 +27,6 @@ import { attachProcess, pickProcess } from './ui/processPicker';
 import { registerProfilingCommand } from './ui/profiling';
 import { registerRequestCDPProxy } from './ui/requestCDPProxy';
 import { registerRevealPage } from './ui/revealPage';
-import { TerminalLinkHandler } from './ui/terminalLinkHandler';
 import { toggleSkippingFile } from './ui/toggleSkippingFile';
 import { VSCodeSessionManager } from './ui/vsCodeSessionManager';
 
@@ -93,12 +92,7 @@ export function activate(context: vscode.ExtensionContext) {
 
   registerCompanionBrowserLaunch(context);
   registerCustomBreakpointsUI(context, debugSessionTracker);
-  registerDebugTerminalUI(
-    context,
-    services.get(DelegateLauncherFactory),
-    services.get(TerminalLinkHandler),
-    services,
-  );
+  registerDebugTerminalUI(context, services.get(DelegateLauncherFactory), services);
   registerProfilingCommand(context, services);
   registerAutoAttach(context, services.get(DelegateLauncherFactory), services);
   registerRevealPage(context, debugSessionTracker);

src/targets/node/terminalNodeLauncher.ts

@@ -3,7 +3,7 @@
  *--------------------------------------------------------*/
 
 import { randomBytes } from 'crypto';
-import { inject, injectable } from 'inversify';
+import { inject, injectable, optional } from 'inversify';
 import { tmpdir } from 'os';
 import * as path from 'path';
 import * as vscode from 'vscode';
@@ -12,6 +12,7 @@ import { DebugType } from '../../common/contributionUtils';
 import { EventEmitter } from '../../common/events';
 import { ILogger } from '../../common/logging';
 import { delay } from '../../common/promiseUtil';
+import { ITerminalLinkProvider } from '../../common/terminalLinkProvider';
 import { AnyLaunchConfiguration, ITerminalLaunchConfiguration } from '../../configuration';
 import { ErrorCodes } from '../../dap/errors';
 import { ProtocolError } from '../../dap/protocolError';
@@ -77,6 +78,9 @@ export class TerminalNodeLauncher extends NodeLauncherBase<ITerminalLaunchConfig
     @inject(FS) private readonly fs: FsPromises,
     @inject(ISourcePathResolverFactory) pathResolverFactory: ISourcePathResolverFactory,
     @inject(IPortLeaseTracker) portLeaseTracker: IPortLeaseTracker,
+    @optional()
+    @inject(ITerminalLinkProvider)
+    private readonly terminalLinkProvider: ITerminalLinkProvider | undefined,
   ) {
     super(pathProvider, logger, portLeaseTracker, pathResolverFactory);
   }
@@ -137,6 +141,7 @@ export class TerminalNodeLauncher extends NodeLauncherBase<ITerminalLaunchConfig
       env: hideDebugInfoFromConsole(binary, env).defined(),
       isTransient: true,
     });
+    this.terminalLinkProvider?.enableHandlingInTerminal(terminal);
     this.terminalCreatedEmitter.fire(terminal);
 
     terminal.show();

src/ui/debugTerminalUI.ts

@@ -17,6 +17,7 @@ import {
 } from '../common/contributionUtils';
 import { EventEmitter } from '../common/events';
 import { ProxyLogger } from '../common/logging/proxyLogger';
+import { ITerminalLinkProvider } from '../common/terminalLinkProvider';
 import {
   applyDefaults,
   ITerminalLaunchConfiguration,
@@ -32,7 +33,6 @@ import { NodeOnlyPathResolverFactory } from '../targets/sourcePathResolverFactor
 import { MutableTargetOrigin } from '../targets/targetOrigin';
 import { ITarget } from '../targets/targets';
 import { DapTelemetryReporter } from '../telemetry/dapTelemetryReporter';
-import { TerminalLinkHandler } from './terminalLinkHandler';
 
 export const launchVirtualTerminalParent = (
   delegate: DelegateLauncherFactory,
@@ -203,7 +203,6 @@ class ProfileTerminalLauncher extends TerminalNodeLauncher {
 export function registerDebugTerminalUI(
   context: vscode.ExtensionContext,
   delegateFactory: DelegateLauncherFactory,
-  linkHandler: TerminalLinkHandler,
   services: Container,
 ) {
   const terminals = new Map<
@@ -218,6 +217,7 @@ export function registerDebugTerminalUI(
       services.get(FS),
       services.get(NodeOnlyPathResolverFactory),
       services.get(IPortLeaseTracker),
+      services.get(ITerminalLinkProvider),
     );
 
   /**
@@ -263,7 +263,6 @@ export function registerDebugTerminalUI(
 
     launcher.onTerminalCreated(terminal => {
       terminals.set(terminal, { launcher, folder: workspaceFolder, cwd: defaultConfig?.cwd });
-      linkHandler.enableHandlingInTerminal(terminal);
     });
 
     try {
@@ -306,6 +305,7 @@ export function registerDebugTerminalUI(
               services.get(FS),
               services.get(NodeOnlyPathResolverFactory),
               services.get(IPortLeaseTracker),
+              services.get(ITerminalLinkProvider),
             );
 
             launcher.onOptionsReady(options => resolve(new vscode.TerminalProfile(options)));
@@ -314,6 +314,5 @@ export function registerDebugTerminalUI(
           }),
         ),
     }),
-    vscode.window.registerTerminalLinkProvider?.(linkHandler),
   );
 }

src/ui/terminalLinkHandler.ts

@@ -16,6 +16,7 @@ import {
 import { DefaultBrowser, IDefaultBrowserProvider } from '../common/defaultBrowserProvider';
 import { DisposableList, IDisposable } from '../common/disposable';
 import { once } from '../common/objUtils';
+import { ITerminalLinkProvider } from '../common/terminalLinkProvider';
 import { isLoopbackIp, isMetaAddress } from '../common/urlUtils';
 
 interface ITerminalLink extends vscode.TerminalLink {
@@ -29,9 +30,7 @@ const enum Protocol {
 }
 
 @injectable()
-export class TerminalLinkHandler
-  implements vscode.TerminalLinkProvider<ITerminalLink>, IDisposable
-{
+export class TerminalLinkHandler implements ITerminalLinkProvider<ITerminalLink>, IDisposable {
   private readonly enabledTerminals = new WeakSet<vscode.Terminal>();
   private readonly disposable = new DisposableList();
   private notifiedCantOpenOnWeb = false;
@@ -44,6 +43,8 @@ export class TerminalLinkHandler
           this.baseConfiguration = this.readConfig();
         }
       }),
+
+      vscode.window.registerTerminalLinkProvider(this),
     );
   }
 

src/ui/ui-ioc.extensionOnly.ts

@@ -5,6 +5,7 @@
 import { Container } from 'inversify';
 import { IDwarfModuleProvider } from '../adapter/dwarf/dwarfModuleProvider';
 import { IRequestOptionsProvider } from '../adapter/resourceProvider/requestOptionsProvider';
+import { ITerminalLinkProvider } from '../common/terminalLinkProvider';
 import { IExtensionContribution, trackDispose, VSCodeApi } from '../ioc-extras';
 import { TerminalNodeLauncher } from '../targets/node/terminalNodeLauncher';
 import { ILauncher } from '../targets/targets';
@@ -68,9 +69,13 @@ export const registerUiComponents = (container: Container) => {
   container.bind(ILinkedBreakpointLocation).to(LinkedBreakpointLocationUI).inSingletonScope();
   container.bind(DebugSessionTracker).toSelf().inSingletonScope().onActivation(trackDispose);
   container.bind(UiProfileManager).toSelf().inSingletonScope().onActivation(trackDispose);
-  container.bind(TerminalLinkHandler).toSelf().inSingletonScope();
   container.bind(DisableSourceMapUI).toSelf().inSingletonScope();
   container.bind(IDwarfModuleProvider).to(DwarfModuleProvider).inSingletonScope();
+  container
+    .bind(ITerminalLinkProvider)
+    .to(TerminalLinkHandler)
+    .inSingletonScope()
+    .onActivation(trackDispose);
 
   container
     .bind(ITerminationConditionFactory)