Switch to endpoint files of the form endpoint-{window_id}-{random_str}.txt

Zentrik · Zentrik · commit 1ebf774472b8 · 2026-01-10T19:26:07.000Z
This fixes the issue with never cleaning up the created folders in the previous implementation
diff --git a/bundled/scripts/noConfigScripts/debugpy b/bundled/scripts/noConfigScripts/debugpy
@@ -1,6 +1,5 @@
 #! /bin/bash
 # Bash script
-endpoint_dir="$VSCODE_DEBUGPY_ADAPTER_ENDPOINTS"
-endpoint_file="$(mktemp -p "$endpoint_dir" endpoint-XXXXXX.txt)"
-export DEBUGPY_ADAPTER_ENDPOINTS="$endpoint_file"
+# VSCODE_DEBUGPY_ADAPTER_ENDPOINTS is a prefix; mktemp creates the file atomically to prevent races
+export DEBUGPY_ADAPTER_ENDPOINTS=$(mktemp "${VSCODE_DEBUGPY_ADAPTER_ENDPOINTS}XXXXXX.txt")
 python3 "$BUNDLED_DEBUGPY_PATH" --listen 0 --wait-for-client "$@"
diff --git a/bundled/scripts/noConfigScripts/debugpy.bat b/bundled/scripts/noConfigScripts/debugpy.bat
@@ -1,4 +1,5 @@
 @echo off
 :: Bat script
-set "DEBUGPY_ADAPTER_ENDPOINTS=%VSCODE_DEBUGPY_ADAPTER_ENDPOINTS%\endpoint-%RANDOM%%RANDOM%.txt"
+:: VSCODE_DEBUGPY_ADAPTER_ENDPOINTS is a prefix; append random suffix to create unique file
+set "DEBUGPY_ADAPTER_ENDPOINTS=%VSCODE_DEBUGPY_ADAPTER_ENDPOINTS%%RANDOM%%RANDOM%.txt"
 python %BUNDLED_DEBUGPY_PATH% --listen 0 --wait-for-client %*
diff --git a/bundled/scripts/noConfigScripts/debugpy.fish b/bundled/scripts/noConfigScripts/debugpy.fish
@@ -1,5 +1,4 @@
 # Fish script
-set endpoint_dir $VSCODE_DEBUGPY_ADAPTER_ENDPOINTS
-set endpoint_file (mktemp -p $endpoint_dir endpoint-XXXXXX.txt)
-set -x DEBUGPY_ADAPTER_ENDPOINTS $endpoint_file
+# VSCODE_DEBUGPY_ADAPTER_ENDPOINTS is a prefix; mktemp creates the file atomically to prevent races
+set -x DEBUGPY_ADAPTER_ENDPOINTS (mktemp "$VSCODE_DEBUGPY_ADAPTER_ENDPOINTS"XXXXXX.txt)
 python3 $BUNDLED_DEBUGPY_PATH --listen 0 --wait-for-client $argv
diff --git a/bundled/scripts/noConfigScripts/debugpy.ps1 b/bundled/scripts/noConfigScripts/debugpy.ps1
@@ -1,7 +1,8 @@
 # PowerShell script
-$endpointFolder = $env:VSCODE_DEBUGPY_ADAPTER_ENDPOINTS
-$endpointFile = Join-Path $endpointFolder ("endpoint-{0}.txt" -f ([System.Guid]::NewGuid().ToString('N').Substring(0, 8)))
-$env:DEBUGPY_ADAPTER_ENDPOINTS = $endpointFile
+# VSCODE_DEBUGPY_ADAPTER_ENDPOINTS is a prefix; append random suffix to create unique file
+$endpointPrefix = $env:VSCODE_DEBUGPY_ADAPTER_ENDPOINTS
+$randomString = [System.Guid]::NewGuid().ToString('N').Substring(0, 8)
+$env:DEBUGPY_ADAPTER_ENDPOINTS = "${endpointPrefix}${randomString}.txt"
 
 $os = [System.Environment]::OSVersion.Platform
 if ($os -eq [System.PlatformID]::Win32NT) {
diff --git a/src/extension/noConfigDebugInit.ts b/src/extension/noConfigDebugInit.ts
@@ -11,7 +11,6 @@ import {
     env,
     l10n,
     RelativePattern,
-    workspace,
 } from 'vscode';
 import { createFileSystemWatcher, debugStartDebugging } from './utils';
 import { traceError, traceVerbose } from './common/log/logging';
@@ -40,33 +39,22 @@ export async function registerNoConfigDebug(
     const collection = envVarCollection;
 
     // create a temp directory for the noConfigDebugAdapterEndpoints
-    // folder path format: extPath/.noConfigDebugAdapterEndpoints/<stableWorkspaceHash>
-    let workspaceString = workspace.workspaceFile?.fsPath;
-    if (!workspaceString) {
-        workspaceString = workspace.workspaceFolders?.map((e) => e.uri.fsPath).join(';');
-    }
-    if (!workspaceString) {
-        traceError('No workspace folder found');
-        return Promise.resolve(new Disposable(() => {}));
-    }
-
-    // create a stable hash for the workspace folder and VS Code window, reduce terminal variable churn
+    // file path format: extPath/.noConfigDebugAdapterEndpoints/endpoint-windowHash-*
     const hash = crypto.createHash('sha256');
-    hash.update(workspaceString.toString());
     hash.update(env.sessionId);
-    const stableWorkspaceHash = hash.digest('hex').slice(0, 16);
+    const windowHash = hash.digest('hex').slice(0, 16);
 
-    const tempDirPath = path.join(extPath, '.noConfigDebugAdapterEndpoints');
-    const endpointFolderPath = path.join(tempDirPath, stableWorkspaceHash);
+    const endpointFolderPath = path.join(extPath, '.noConfigDebugAdapterEndpoints');
+    const endpointPrefix = `endpoint-${windowHash}-`;
 
-    // create the temp directory if it doesn't exist
+    // create the directory if it doesn't exist
     if (!fs.existsSync(endpointFolderPath)) {
         fs.mkdirSync(endpointFolderPath, { recursive: true });
     } else {
-        // clean out any existing endpoint files in the folder
+        // clean out any existing endpoint files for this window hash
         const entries = fs.readdirSync(endpointFolderPath, { withFileTypes: true });
         for (const entry of entries) {
-            if (entry.isFile()) {
+            if (entry.isFile() && entry.name.startsWith(endpointPrefix)) {
                 const entryPath = path.join(endpointFolderPath, entry.name.toString());
                 fs.unlinkSync(entryPath);
             }
@@ -79,7 +67,8 @@ export async function registerNoConfigDebug(
     collection.replace('PYDEVD_DISABLE_FILE_VALIDATION', '1');
 
     // Add env vars for VSCODE_DEBUGPY_ADAPTER_ENDPOINTS, BUNDLED_DEBUGPY_PATH, and PATH
-    collection.replace('VSCODE_DEBUGPY_ADAPTER_ENDPOINTS', endpointFolderPath);
+    // VSCODE_DEBUGPY_ADAPTER_ENDPOINTS is the prefix for endpoint files - scripts append something unique to avoid collisions
+    collection.replace('VSCODE_DEBUGPY_ADAPTER_ENDPOINTS', path.join(endpointFolderPath, endpointPrefix));
 
     const noConfigScriptsDir = path.join(extPath, 'bundled', 'scripts', 'noConfigScripts');
     const pathSeparator = process.platform === 'win32' ? ';' : ':';
@@ -98,8 +87,8 @@ export async function registerNoConfigDebug(
         'Enables use of [no-config debugging](https://github.com/microsoft/vscode-python-debugger/wiki/No%E2%80%90Config-Debugging), `debugpy <script.py>`, in the terminal.',
     );
 
-    // create file system watcher for the debuggerAdapterEndpointFolder for when the communication port is written
-    const fileSystemWatcher = createFileSystemWatcher(new RelativePattern(endpointFolderPath, '**/*.txt'));
+    // create file system watcher for endpoint files matching this window's prefix
+    const fileSystemWatcher = createFileSystemWatcher(new RelativePattern(endpointFolderPath, `${endpointPrefix}*`));
     const fileCreationEvent = fileSystemWatcher.onDidCreate(async (uri) => {
         sendTelemetryEvent(EventName.DEBUG_SESSION_START, undefined, {
             trigger: 'noConfig' as TriggerType,
diff --git a/src/test/unittest/noConfigDebugInit.unit.test.ts b/src/test/unittest/noConfigDebugInit.unit.test.ts
@@ -6,7 +6,7 @@ import { IExtensionContext } from '../../extension/common/types';
 import { registerNoConfigDebug as registerNoConfigDebug } from '../../extension/noConfigDebugInit';
 import * as TypeMoq from 'typemoq';
 import * as sinon from 'sinon';
-import { DebugConfiguration, DebugSessionOptions, RelativePattern, Uri, env, workspace } from 'vscode';
+import { DebugConfiguration, DebugSessionOptions, env, RelativePattern, Uri, workspace } from 'vscode';
 import * as utils from '../../extension/utils';
 import { assert } from 'console';
 import * as fs from 'fs';
@@ -22,9 +22,7 @@ suite('setup for no-config debug scenario', function () {
     let DEBUGPY_ADAPTER_ENDPOINTS = 'DEBUGPY_ADAPTER_ENDPOINTS';
     let BUNDLED_DEBUGPY_PATH = 'BUNDLED_DEBUGPY_PATH';
     let workspaceUriStub: sinon.SinonStub;
-    let sessionIdStub: sinon.SinonStub;
-    let stableWorkspaceHash: string;
-    let workspacePath: string;
+    let windowHash: string;
 
     const testDataDir = path.join(__dirname, 'testData');
     const testFilePath = path.join(testDataDir, 'debuggerAdapterEndpoint.txt');
@@ -37,28 +35,25 @@ suite('setup for no-config debug scenario', function () {
             noConfigScriptsDir = path.join(context.object.extensionPath, 'bundled/scripts/noConfigScripts');
             bundledDebugPath = path.join(context.object.extensionPath, 'bundled/libs/debugpy');
 
-            sessionIdStub = sinon.stub(env, 'sessionId').value('test-session');
-            workspacePath = os.tmpdir();
-
             // Stub crypto.randomBytes with proper typing
             let randomBytesStub = sinon.stub(crypto, 'randomBytes');
             // Provide a valid Buffer object
             randomBytesStub.callsFake((_size: number) => Buffer.from('1234567899', 'hex'));
 
-            workspaceUriStub = sinon.stub(workspace, 'workspaceFolders').value([{ uri: Uri.parse(workspacePath) }]);
+            workspaceUriStub = sinon.stub(workspace, 'workspaceFolders').value([{ uri: Uri.parse(os.tmpdir()) }]);
 
-            const hash = crypto.createHash('sha256');
-            hash.update(workspacePath.toString());
-            hash.update('test-session');
-            stableWorkspaceHash = hash.digest('hex').slice(0, 16);
+            // Stub env.sessionId to get a stable window hash
+            sinon.stub(env, 'sessionId').value('test-session-id');
+            const hashObj = crypto.createHash('sha256');
+            hashObj.update('test-session-id');
+            windowHash = hashObj.digest('hex').substring(0, 16);
         } catch (error) {
             console.error('Error in setup:', error);
         }
     });
     teardown(() => {
         sinon.restore();
         workspaceUriStub.restore();
-        sessionIdStub.restore();
     });
 
     test('should add environment variables for DEBUGPY_ADAPTER_ENDPOINTS, BUNDLED_DEBUGPY_PATH, and PATH', async () => {
@@ -71,14 +66,8 @@ suite('setup for no-config debug scenario', function () {
             .setup((x) => x.replace(TypeMoq.It.isAny(), TypeMoq.It.isAny()))
             .callback((key, value) => {
                 if (key === DEBUGPY_ADAPTER_ENDPOINTS) {
-                    assert(
-                        value ===
-                            path.join(
-                                context.object.extensionPath,
-                                '.noConfigDebugAdapterEndpoints',
-                                stableWorkspaceHash,
-                            ),
-                    );
+                    assert(value.includes('endpoint-'));
+                    assert(value.includes(windowHash));
                 } else if (key === BUNDLED_DEBUGPY_PATH) {
                     assert(value === bundledDebugPath);
                 } else if (key === 'PYDEVD_DISABLE_FILE_VALIDATION') {
@@ -213,8 +202,8 @@ suite('setup for no-config debug scenario', function () {
         // Assert
         sinon.assert.calledOnce(createFileSystemWatcherFunct);
         const expectedPattern = new RelativePattern(
-            path.join(os.tmpdir(), '.noConfigDebugAdapterEndpoints', stableWorkspaceHash),
-            '**/*.txt',
+            path.join(os.tmpdir(), '.noConfigDebugAdapterEndpoints'),
+            `endpoint-${windowHash}-*`,
         );
         sinon.assert.calledWith(createFileSystemWatcherFunct, expectedPattern);
     });
@@ -280,27 +269,25 @@ suite('setup for no-config debug scenario', function () {
         sinon.assert.calledWith(debugStub, undefined, expectedConfig, optionsExpected);
     });
 
-    test('should clear existing endpoint files when debuggerAdapterEndpointFolder exists', async () => {
+    test('should clean up existing endpoint files for this window hash when debuggerAdapterEndpointFolder exists', async () => {
         // Arrange
         const environmentVariableCollectionMock = TypeMoq.Mock.ofType<any>();
         context.setup((c) => c.environmentVariableCollection).returns(() => environmentVariableCollectionMock.object);
 
-        const endpointFolderPath = path.join(os.tmpdir(), '.noConfigDebugAdapterEndpoints', stableWorkspaceHash);
-        const fsExistsSyncStub = sinon.stub(fs, 'existsSync').callsFake((p) => p === endpointFolderPath);
-        const fakeDirent = { isFile: () => true, name: Buffer.from('old.txt') } as unknown as fs.Dirent<Buffer>;
-        const fsReaddirSyncStub = sinon.stub(fs, 'readdirSync').callsFake((dirPath: fs.PathLike, options?: any) => {
-            assert(dirPath === endpointFolderPath);
-            assert(options?.withFileTypes === true);
-            return [fakeDirent] as unknown as fs.Dirent<Buffer>[];
-        });
+        const fsExistsSyncStub = sinon.stub(fs, 'existsSync').returns(true);
+        const fsReaddirSyncStub = sinon.stub(fs, 'readdirSync').returns([
+            { name: `endpoint-${windowHash}-abc123.txt`, isFile: () => true },
+            { name: `endpoint-otherhash-def456.txt`, isFile: () => true },
+            { name: 'somedir', isFile: () => false },
+        ] as any);
         const fsUnlinkSyncStub = sinon.stub(fs, 'unlinkSync');
 
         // Act
         await registerNoConfigDebug(context.object.environmentVariableCollection, context.object.extensionPath);
 
-        // Assert
-        sinon.assert.calledWith(fsExistsSyncStub, endpointFolderPath);
-        sinon.assert.calledWith(fsUnlinkSyncStub, path.join(endpointFolderPath, 'old.txt'));
+        // Assert - only files matching this window hash should be deleted
+        sinon.assert.called(fsReaddirSyncStub);
+        sinon.assert.calledOnce(fsUnlinkSyncStub);
 
         // Cleanup
         fsExistsSyncStub.restore();
