Validate output returned by poetry (#18488)

* Validate output returned by poetry

* Only build VSIX

* If a directory does not exist do not watch it

* Revert "Only build VSIX"

This reverts commit 339756f.

* News

* Fix tests

Author: Kartik Raj

news/2 Fixes/18459.md

@@ -0,0 +1 @@
+Fix CPU load issue caused by poetry plugin by not watching directories which do not exist.

src/client/pythonEnvironments/base/locators/lowLevel/fsWatchingLocator.ts

@@ -21,7 +21,7 @@ export enum FSWatcherKind {
     Workspace, // Watchers observes directory in the user's currently open workspace.
 }
 
-type DirUnwatchableReason = 'too many files' | undefined;
+type DirUnwatchableReason = 'directory does not exist' | 'too many files' | undefined;
 
 /**
  * Determine if the directory is watchable.
@@ -33,9 +33,9 @@ function checkDirWatchable(dirname: string): DirUnwatchableReason {
     } catch (err) {
         traceError('Reading directory to watch failed', err);
         if (err.code === 'ENOENT') {
-            // We treat a missing directory as watchable since it should
-            // be watchable if created later.
-            return undefined;
+            // Treat a missing directory as unwatchable since it can lead to CPU load issues:
+            // https://github.com/microsoft/vscode-python/issues/18459
+            return 'directory does not exist';
         }
         throw err; // re-throw
     }

src/client/pythonEnvironments/common/environmentManagers/poetry.ts

@@ -5,7 +5,14 @@
 
 import * as path from 'path';
 import { getOSType, getUserHomeDir, OSType } from '../../../common/utils/platform';
-import { getPythonSetting, isParentPath, pathExistsSync, readFileSync, shellExecute } from '../externalDependencies';
+import {
+    getPythonSetting,
+    isParentPath,
+    pathExists,
+    pathExistsSync,
+    readFileSync,
+    shellExecute,
+} from '../externalDependencies';
 import { getEnvironmentDirFromPath } from '../commonUtils';
 import { isVirtualenvEnvironment } from './simplevirtualenvs';
 import { StopWatch } from '../../../common/utils/stopWatch';
@@ -201,12 +208,16 @@ export class Poetry {
          * So we'll need to remove the string "(Activated)" after splitting lines to get the full path.
          */
         const activated = '(Activated)';
-        return result.stdout.splitLines().map((line) => {
-            if (line.endsWith(activated)) {
-                line = line.slice(0, -activated.length);
-            }
-            return line.trim();
-        });
+        const res = await Promise.all(
+            result.stdout.splitLines().map(async (line) => {
+                if (line.endsWith(activated)) {
+                    line = line.slice(0, -activated.length);
+                }
+                const folder = line.trim();
+                return (await pathExists(folder)) ? folder : undefined;
+            }),
+        );
+        return res.filter((r) => r !== undefined).map((r) => r!);
     }
 
     /**

src/test/pythonEnvironments/base/locators/lowLevel/fsWatchingLocator.unit.test.ts

@@ -12,9 +12,11 @@ import {
     FSWatchingLocator,
 } from '../../../../../client/pythonEnvironments/base/locators/lowLevel/fsWatchingLocator';
 import * as binWatcher from '../../../../../client/pythonEnvironments/common/pythonBinariesWatcher';
+import { TEST_LAYOUT_ROOT } from '../../../common/commonTestConstants';
 
 suite('File System Watching Locator Tests', () => {
-    const baseDir = '/this/is/a/fake/path';
+    const baseDir = TEST_LAYOUT_ROOT;
+    const fakeDir = '/this/is/a/fake/path';
     const callback = async () => Promise.resolve(PythonEnvKind.System);
     let watchLocationStub: sinon.SinonStub;
 
@@ -34,7 +36,7 @@ suite('File System Watching Locator Tests', () => {
                 envStructure?: binWatcher.PythonEnvStructure;
             } = {},
         ) {
-            super(() => baseDir, callback, opts, watcherKind);
+            super(() => [baseDir, fakeDir], callback, opts, watcherKind);
         }
 
         public async initialize() {
@@ -95,6 +97,11 @@ suite('File System Watching Locator Tests', () => {
                         assert.strictEqual(watchLocationStub.callCount, expected.length);
                         expected.forEach((glob) => {
                             assert.ok(watchLocationStub.calledWithMatch(baseDir, sinon.match.any, glob));
+                            assert.strictEqual(
+                                // As directory does not exist, it should not be watched.
+                                watchLocationStub.calledWithMatch(fakeDir, sinon.match.any, glob),
+                                false,
+                            );
                         });
                     } else if (watcherKind === FSWatcherKind.Global) {
                         assert.ok(watchLocationStub.notCalled);