From e5f8539af2ad1bca609bb7a416b50eb27e2f6014 Mon Sep 17 00:00:00 2001
From: Don Jayamanne <don.jayamanne@outlook.com>
Date: Sun, 14 Jul 2024 17:04:00 +1000
Subject: [PATCH] Additional data to compare conda environments.txt (#23805)

---
 .../base/locators/common/nativePythonFinder.ts  |  3 +++
 .../locators/composite/envsCollectionService.ts | 16 ++++++++++++++--
 src/client/telemetry/index.ts                   | 17 ++++++++++++++++-
 3 files changed, 33 insertions(+), 3 deletions(-)

diff --git a/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts b/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts
index 196808ac3e5f..3478f2d4cd0e 100644
--- a/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts
+++ b/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts
@@ -51,6 +51,9 @@ export type NativeCondaInfo = {
     canSpawnConda: boolean;
     condaRcs: string[];
     envDirs: string[];
+    environmentsTxt?: string;
+    environmentsTxtExists?: boolean;
+    environmentsFromTxt: string[];
 };
 
 export interface NativeGlobalPythonFinder extends Disposable {
diff --git a/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts b/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts
index e6a61964a245..f1a3e98b7467 100644
--- a/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts
+++ b/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts
@@ -359,6 +359,9 @@ export class EnvsCollectionService extends PythonEnvsWatcher<PythonEnvCollection
             nativeCondaEnvDirsNotFound: number;
             nativeCondaEnvDirsNotFoundHasEnvs: number;
             nativeCondaEnvDirsNotFoundHasEnvsInTxt: number;
+            nativeCondaEnvTxtSame?: boolean;
+            nativeCondaEnvTxtExists?: boolean;
+            nativeCondaEnvsFromTxt: number;
         };
 
         const userProvidedCondaExe = fsPath
@@ -380,11 +383,12 @@ export class EnvsCollectionService extends PythonEnvsWatcher<PythonEnvCollection
             nativeCondaEnvDirsNotFound: 0,
             nativeCondaEnvDirsNotFoundHasEnvs: 0,
             nativeCondaEnvDirsNotFoundHasEnvsInTxt: 0,
+            nativeCondaEnvsFromTxt: 0,
         };
 
         // Get conda telemetry
         {
-            const [info, nativeCondaInfo, condaEnvsInEnvironmentsTxt] = await Promise.all([
+            const [info, nativeCondaInfo, condaEnvsInEnvironmentsTxt, envTxt] = await Promise.all([
                 Conda.getConda()
                     .catch((ex) => traceError('Failed to get conda info', ex))
                     .then((conda) => conda?.getInfo()),
@@ -405,12 +409,20 @@ export class EnvsCollectionService extends PythonEnvsWatcher<PythonEnvCollection
                     })
                     .catch((ex) => traceError(`Failed to get conda envs from environments.txt`, ex))
                     .then((items) => items || []),
+                getCondaEnvironmentsTxt().catch(noop),
             ]);
 
+            const environmentsTxt =
+                Array.isArray(envTxt) && envTxt.length ? fsPath.normalize(envTxt[0]).toLowerCase() : undefined;
             if (nativeCondaInfo) {
                 condaTelemetry.nativeCanSpawnConda = nativeCondaInfo.canSpawnConda;
                 condaTelemetry.nativeCondaInfoEnvsDirs = new Set(nativeCondaInfo.envDirs).size;
                 condaTelemetry.nativeCondaRcs = new Set(nativeCondaInfo.condaRcs).size;
+
+                const nativeEnvTxt = fsPath.normalize(nativeCondaInfo.environmentsTxt || '').toLowerCase();
+                condaTelemetry.nativeCondaEnvTxtExists = nativeCondaInfo.environmentsTxtExists === true;
+                condaTelemetry.nativeCondaEnvsFromTxt = (nativeCondaInfo.environmentsFromTxt || []).length;
+                condaTelemetry.nativeCondaEnvTxtSame = nativeEnvTxt === environmentsTxt;
             }
             condaTelemetry.condaEnvsInTxt = condaEnvsInEnvironmentsTxt.length;
             condaTelemetry.canSpawnConda = !!info;
@@ -736,7 +748,7 @@ export class EnvsCollectionService extends PythonEnvsWatcher<PythonEnvCollection
 
         // Intent is to capture time taken for discovery of all envs to complete the first time.
         sendTelemetryEvent(EventName.PYTHON_INTERPRETER_DISCOVERY, elapsedTime, {
-            telVer: 5,
+            telVer: 6,
             nativeDuration,
             workspaceFolderCount: (workspace.workspaceFolders || []).length,
             interpreters: this.cache.getAllEnvs().length,
diff --git a/src/client/telemetry/index.ts b/src/client/telemetry/index.ts
index 127f15ac7158..a1aaa4b02bfd 100644
--- a/src/client/telemetry/index.ts
+++ b/src/client/telemetry/index.ts
@@ -1219,7 +1219,10 @@ export interface IEventNamePropertyMapping {
         "nativeCondaRcsNotFound" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" },
         "nativeCondaEnvDirsNotFound" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" },
         "nativeCondaEnvDirsNotFoundHasEnvs" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" },
-        "nativeCondaEnvDirsNotFoundHasEnvsInTxt" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" }
+        "nativeCondaEnvDirsNotFoundHasEnvsInTxt" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" },
+        "nativeCondaEnvTxtSame" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" },
+        "nativeCondaEnvsFromTxt" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" },
+        "nativeCondaEnvTxtExists" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" }
        }
      */
     [EventName.PYTHON_INTERPRETER_DISCOVERY]: {
@@ -1487,6 +1490,18 @@ export interface IEventNamePropertyMapping {
          * Number of environments of a specific type missing in Native Locator (compared to the Stable Locator).
          */
         missingNativeCondaEnvs?: number;
+        /**
+         * Whether the env txt found by native locator is the same as that found by pythonn ext.
+         */
+        nativeCondaEnvTxtSame?: boolean;
+        /**
+         * Number of environments found from env txt by native locator.
+         */
+        nativeCondaEnvsFromTxt?: number;
+        /**
+         * Whether the env txt found by native locator exists.
+         */
+        nativeCondaEnvTxtExists?: boolean;
         /**
          * Number of environments of a specific type missing in Native Locator (compared to the Stable Locator).
          */