fix: store original handle of debug adapter config

When frontend and main VS Code extensions load together, Theia creates
two extension host instances to manage different kinds of extensions.
Each will register the extensions' contributed debug adapter
configuration providers with incremented handles.

In cases of handle collisions during the registration of debug
configurations, Theia adjusts the handle of incoming providers.
However, this adjustment causes issues as the extension host no longer
associates the new handle with the original ID.

For instance, if the main VSIX contributes two debuggers assigned
handles `0` and `1`, and the web VSIX contributes a debugger with a
colliding handle `0`, Theia changes the web provider's handle to `2`.
Subsequently, when starting a debug session, the main extension
attempts to resolve handle `2`, but the frontend extension host only
recognizes the initial configuration.

This commit addresses the issue by storing the original handle of the
debug adapter configuration. During handle ID lookups, it will
reference the originally assigned handle instead of the adjusted one,
ensuring proper resolution and functionality across both extension host
instances.

Ref: eclipse-theia#13196

Author: kittaakos

packages/plugin-ext/src/main/browser/debug/plugin-debug-configuration-provider.ts

@@ -23,6 +23,11 @@ import {
 import { DebugConfiguration } from '@theia/debug/lib/common/debug-configuration';
 
 export class PluginDebugConfigurationProvider implements DebugConfigurationProvider {
+    /**
+     * After https://github.com/eclipse-theia/theia/pull/13196, the debug config handles might change.
+     * Store the original handle to be able to call the extension host when getting by handle.
+     */
+    protected readonly originalHandle: number;
     public handle: number;
     public type: string;
     public triggerKind: DebugConfigurationProviderTriggerKind;
@@ -41,23 +46,24 @@ export class PluginDebugConfigurationProvider implements DebugConfigurationProvi
         protected readonly debugExt: DebugExt
     ) {
         this.handle = description.handle;
+        this.originalHandle = this.handle;
         this.type = description.type;
         this.triggerKind = description.trigger;
 
         if (description.provideDebugConfiguration) {
-            this.provideDebugConfigurations = async (folder: string | undefined) => this.debugExt.$provideDebugConfigurationsByHandle(this.handle, folder);
+            this.provideDebugConfigurations = async (folder: string | undefined) => this.debugExt.$provideDebugConfigurationsByHandle(this.originalHandle, folder);
         }
 
         if (description.resolveDebugConfigurations) {
             this.resolveDebugConfiguration =
                 async (folder: string | undefined, debugConfiguration: DebugConfiguration) =>
-                    this.debugExt.$resolveDebugConfigurationByHandle(this.handle, folder, debugConfiguration);
+                    this.debugExt.$resolveDebugConfigurationByHandle(this.originalHandle, folder, debugConfiguration);
         }
 
         if (description.resolveDebugConfigurationWithSubstitutedVariables) {
             this.resolveDebugConfigurationWithSubstitutedVariables =
                 async (folder: string | undefined, debugConfiguration: DebugConfiguration) =>
-                    this.debugExt.$resolveDebugConfigurationWithSubstitutedVariablesByHandle(this.handle, folder, debugConfiguration);
+                    this.debugExt.$resolveDebugConfigurationWithSubstitutedVariablesByHandle(this.originalHandle, folder, debugConfiguration);
         }
     }
 }