Fix unresponsive extension issues caused by discovery component (#17781)

* Fix unresponsive extension issues caused by discovery component

* News entry

* Add doc comment

Author: Kartik Raj

news/2 Fixes/11924.md

@@ -0,0 +1 @@
+Fix unresponsive extension issues caused by discovery component.

src/client/common/utils/misc.ts

@@ -4,7 +4,7 @@
 import type { TextDocument, Uri } from 'vscode';
 import { InteractiveInputScheme, NotebookCellScheme } from '../constants';
 import { InterpreterUri } from '../installer/types';
-import { arePathsSame, isParentPath } from '../platform/fs-paths';
+import { isParentPath } from '../platform/fs-paths';
 import { Resource } from '../types';
 import { isPromise } from './async';
 import { StopWatch } from './stopWatch';
@@ -103,19 +103,19 @@ function isUri(resource?: Uri | any): resource is Uri {
  * The scheme must match, as well as path.
  *
  * @param checkParent - if `true`, match if the candidate is rooted under `uri`
+ * or if the candidate matches `uri` exactly.
  * @param checkChild - if `true`, match if `uri` is rooted under the candidate
- * @param checkExact - if `true`, match if the candidate matches `uri` exactly
+ * or if the candidate matches `uri` exactly.
  */
 export function getURIFilter(
     uri: Uri,
     opts: {
         checkParent?: boolean;
         checkChild?: boolean;
-        checkExact?: boolean;
-    } = { checkExact: true },
+    } = { checkParent: true },
 ): (u: Uri) => boolean {
     let uriPath = uri.path;
-    while (uri.path.endsWith('/')) {
+    while (uriPath.endsWith('/')) {
         uriPath = uriPath.slice(0, -1);
     }
     const uriRoot = `${uriPath}/`;
@@ -124,12 +124,9 @@ export function getURIFilter(
             return false;
         }
         let candidatePath = candidate.path;
-        while (candidate.path.endsWith('/')) {
+        while (candidatePath.endsWith('/')) {
             candidatePath = candidatePath.slice(0, -1);
         }
-        if (opts.checkExact && arePathsSame(candidatePath, uriPath)) {
-            return true;
-        }
         if (opts.checkParent && isParentPath(candidatePath, uriRoot)) {
             return true;
         }

src/client/pythonEnvironments/base/locatorUtils.ts

@@ -55,7 +55,6 @@ function getSearchLocationFilters(query: PythonLocatorQuery): ((u: Uri) => boole
     return query.searchLocations.roots.map((loc) =>
         getURIFilter(loc, {
             checkParent: true,
-            checkExact: true,
         }),
     );
 }

src/client/pythonEnvironments/base/locators/index.ts

@@ -73,7 +73,7 @@ export class WorkspaceLocators<I = PythonEnvInfo> extends LazyResourceBasedLocat
             if (query?.searchLocations !== undefined) {
                 const root = this.roots[key];
                 // Match any related search location.
-                const filter = getURIFilter(root, { checkParent: true, checkChild: true, checkExact: true });
+                const filter = getURIFilter(root, { checkParent: true, checkChild: true });
                 // Ignore any requests for global envs.
                 if (!query.searchLocations.roots.some(filter)) {
                     // This workspace folder did not match the query, so skip it!

src/test/pythonEnvironments/base/locatorUtils.unit.test.ts

@@ -37,7 +37,7 @@ const envL2 = createLocatedEnv('/conda/envs/envL2', '3.8.3', PythonEnvKind.Conda
 const locatedEnvs = [envL1, envL2];
 
 const envS1 = createNamedEnv('env S1', '3.9', PythonEnvKind.OtherVirtual, `${homeDir}/some-dir/bin/python`);
-setSearchLocation(envS1, homeDir);
+setSearchLocation(envS1, `${homeDir}/`); // Have a search location ending in '/'
 const envS2 = createNamedEnv('env S2', '3.9', PythonEnvKind.OtherVirtual, `${homeDir}/some-dir2/bin/python`);
 setSearchLocation(envS2, homeDir);
 const envS3 = createNamedEnv('env S2', '3.9', PythonEnvKind.OtherVirtual, `${workspaceRoot.fsPath}/p/python`);
@@ -178,6 +178,20 @@ suite('Python envs locator utils - getQueryFilter', () => {
             assert.deepEqual(filtered, expected);
         });
 
+        test("match multiple (one location) uri path ending in '/'", () => {
+            const expected = [envS3, envSL2];
+            const searchLocations = {
+                roots: [Uri.file(`${workspaceRoot.path}/`)],
+                doNotIncludeNonRooted: true,
+            };
+            const query: PythonLocatorQuery = { searchLocations };
+
+            const filter = getQueryFilter(query);
+            const filtered = envs.filter(filter);
+
+            assert.deepEqual(filtered, expected);
+        });
+
         test('match multiple (multiple locations)', () => {
             const expected = [envS3, ...rootedLocatedEnvs];
             const searchLocations = {