From fd41cda8127ea0d5f43d0fba6e058a2b324cce77 Mon Sep 17 00:00:00 2001
From: Don Jayamanne <Don.Jayamanne@microsoft.com>
Date: Thu, 11 Jul 2024 12:46:29 +1000
Subject: [PATCH] Additional conda telemetry

---
 .../locators/common/nativePythonFinder.ts     | 11 +++
 .../composite/envsCollectionService.ts        | 84 +++++++++++++++++--
 .../common/environmentManagers/conda.ts       |  4 +
 src/client/telemetry/index.ts                 | 32 +++++++
 .../envsCollectionService.unit.test.ts        |  4 +
 5 files changed, 128 insertions(+), 7 deletions(-)

diff --git a/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts b/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts
index b8cb5c48a157..196808ac3e5f 100644
--- a/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts
+++ b/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts
@@ -47,10 +47,17 @@ export interface NativeEnvManagerInfo {
     version?: string;
 }
 
+export type NativeCondaInfo = {
+    canSpawnConda: boolean;
+    condaRcs: string[];
+    envDirs: string[];
+};
+
 export interface NativeGlobalPythonFinder extends Disposable {
     resolve(executable: string): Promise<NativeEnvInfo>;
     refresh(): AsyncIterable<NativeEnvInfo>;
     categoryToKind(category?: string): PythonEnvKind;
+    getCondaInfo(): Promise<NativeCondaInfo>;
 }
 
 interface NativeLog {
@@ -361,6 +368,10 @@ class NativeGlobalPythonFinderImpl extends DisposableBase implements NativeGloba
             this.outputChannel.error('Refresh error', ex);
         }
     }
+
+    async getCondaInfo(): Promise<NativeCondaInfo> {
+        return this.connection.sendRequest<NativeCondaInfo>('condaInfo');
+    }
 }
 
 type ConfigurationOptions = {
diff --git a/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts b/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts
index 00eec4866e78..266b2a4966cc 100644
--- a/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts
+++ b/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts
@@ -333,18 +333,30 @@ export class EnvsCollectionService extends PythonEnvsWatcher<PythonEnvCollection
         let condaInfoEnvsInvalid = 0;
         let condaInfoEnvsDuplicate = 0;
         let condaInfoEnvsInvalidPrefix = 0;
-        let condaInfoEnvsDirs: undefined | number;
+        let condaInfoEnvsDirs = 0;
         let envsDirs: string[] = [];
+        let condaRcs: number | undefined;
+        let condaRootPrefixFoundInInfoNotInNative: undefined | boolean;
+        let condaDefaultPrefixFoundInInfoNotInNative: undefined | boolean;
         try {
             const conda = await Conda.getConda();
             const info = await conda?.getInfo();
-            canSpawnConda = true;
+            canSpawnConda = !!info;
             condaInfoEnvs = info?.envs?.length;
             // eslint-disable-next-line camelcase
-            condaInfoEnvsDirs = info?.envs_dirs?.length;
-            // eslint-disable-next-line camelcase
             envsDirs = info?.envs_dirs || [];
-
+            const condaRcFiles = new Set<string>();
+            await Promise.all(
+                // eslint-disable-next-line camelcase
+                [info?.rc_path, info?.user_rc_path, info?.sys_rc_path, ...(info?.config_files || [])].map(
+                    async (rc) => {
+                        if (rc && (await pathExists(rc))) {
+                            condaRcFiles.add(rc);
+                        }
+                    },
+                ),
+            ).catch(noop);
+            condaRcs = condaRcFiles.size;
             const duplicate = new Set<string>();
             Promise.all(
                 (info?.envs || []).map(async (e) => {
@@ -361,6 +373,13 @@ export class EnvsCollectionService extends PythonEnvsWatcher<PythonEnvCollection
                     }
                 }),
             );
+            Promise.all(
+                envsDirs.map(async (e) => {
+                    if (await pathExists(e)) {
+                        condaInfoEnvsDirs += 1;
+                    }
+                }),
+            );
             nativeEnvs
                 .filter((e) => this.nativeFinder.categoryToKind(e.kind) === PythonEnvKind.Conda)
                 .forEach((e) => {
@@ -368,9 +387,40 @@ export class EnvsCollectionService extends PythonEnvsWatcher<PythonEnvCollection
                         missingEnvironments.nativeCondaEnvsInEnvDir += 1;
                     }
                 });
+
+            // Check if we have found the conda env that matches the `root_prefix` in the conda info.
+            // eslint-disable-next-line camelcase
+            const rootPrefix = (info?.root_prefix || '').toLowerCase();
+            if (rootPrefix) {
+                // Check if we have a conda env that matches this prefix.
+                if (
+                    envs.some(
+                        (e) => e.executable.sysPrefix.toLowerCase() === rootPrefix && e.kind === PythonEnvKind.Conda,
+                    )
+                ) {
+                    condaRootPrefixFoundInInfoNotInNative = nativeEnvs.some(
+                        (e) => e.prefix?.toLowerCase() === rootPrefix.toLowerCase(),
+                    );
+                }
+            }
+            // eslint-disable-next-line camelcase
+            const defaultPrefix = (info?.default_prefix || '').toLowerCase();
+            if (rootPrefix) {
+                // Check if we have a conda env that matches this prefix.
+                if (
+                    envs.some(
+                        (e) => e.executable.sysPrefix.toLowerCase() === defaultPrefix && e.kind === PythonEnvKind.Conda,
+                    )
+                ) {
+                    condaDefaultPrefixFoundInInfoNotInNative = nativeEnvs.some(
+                        (e) => e.prefix?.toLowerCase() === defaultPrefix.toLowerCase(),
+                    );
+                }
+            }
         } catch (ex) {
             canSpawnConda = false;
         }
+        const nativeCondaInfoPromise = this.nativeFinder.getCondaInfo();
         const prefixesSeenAlready = new Set<string>();
         await Promise.all(
             envs.map(async (env) => {
@@ -480,6 +530,22 @@ export class EnvsCollectionService extends PythonEnvsWatcher<PythonEnvCollection
             }),
         ).catch((ex) => traceError('Failed to send telemetry for missing environments', ex));
 
+        const nativeCondaInfo = await nativeCondaInfoPromise.catch((ex) =>
+            traceError(`Failed to get conda info from native locator`, ex),
+        );
+
+        type CondaTelemetry = {
+            nativeCanSpawnConda?: boolean;
+            nativeCondaInfoEnvsDirs?: number;
+            nativeCondaRcs?: number;
+        };
+
+        const condaTelemetry: CondaTelemetry = {};
+        if (nativeCondaInfo) {
+            condaTelemetry.nativeCanSpawnConda = nativeCondaInfo.canSpawnConda;
+            condaTelemetry.nativeCondaInfoEnvsDirs = new Set(nativeCondaInfo.envDirs).size;
+            condaTelemetry.nativeCondaRcs = new Set(nativeCondaInfo.condaRcs).size;
+        }
         const environmentsWithoutPython = envs.filter(
             (e) => getEnvPath(e.executable.filename, e.location).pathType === 'envFolderPath',
         ).length;
@@ -513,7 +579,7 @@ export class EnvsCollectionService extends PythonEnvsWatcher<PythonEnvCollection
                 if (e.executable.sysPrefix && !(await pathExists(e.executable.sysPrefix))) {
                     missingEnvironments.prefixNotExistsCondaEnvs += 1;
                 }
-                if (e.executable.filename && (await isCondaEnvironment(e.executable.filename))) {
+                if (e.executable.filename && !(await isCondaEnvironment(e.executable.filename))) {
                     missingEnvironments.invalidCondaEnvs += 1;
                 }
             }),
@@ -568,10 +634,13 @@ 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: 2,
+            telVer: 3,
+            condaRcs,
             condaInfoEnvsInvalid,
             condaInfoEnvsDuplicate,
             condaInfoEnvsInvalidPrefix,
+            condaRootPrefixFoundInInfoNotInNative,
+            condaDefaultPrefixFoundInInfoNotInNative,
             nativeDuration,
             workspaceFolderCount: (workspace.workspaceFolders || []).length,
             interpreters: this.cache.getAllEnvs().length,
@@ -610,6 +679,7 @@ export class EnvsCollectionService extends PythonEnvsWatcher<PythonEnvCollection
             nativeVirtualEnvEnvs,
             nativeVirtualEnvWrapperEnvs,
             nativeGlobal,
+            ...condaTelemetry,
             ...missingEnvironments,
         });
     }
diff --git a/src/client/pythonEnvironments/common/environmentManagers/conda.ts b/src/client/pythonEnvironments/common/environmentManagers/conda.ts
index 9f107a737dc3..d19d3f5c7ffe 100644
--- a/src/client/pythonEnvironments/common/environmentManagers/conda.ts
+++ b/src/client/pythonEnvironments/common/environmentManagers/conda.ts
@@ -44,6 +44,10 @@ export type CondaInfo = {
     root_prefix?: string; // eslint-disable-line camelcase
     conda_version?: string; // eslint-disable-line camelcase
     conda_shlvl?: number; // eslint-disable-line camelcase
+    config_files?: string[]; // eslint-disable-line camelcase
+    rc_path?: string; // eslint-disable-line camelcase
+    sys_rc_path?: string; // eslint-disable-line camelcase
+    user_rc_path?: string; // eslint-disable-line camelcase
 };
 
 type CondaEnvInfo = {
diff --git a/src/client/telemetry/index.ts b/src/client/telemetry/index.ts
index cd5dac6c0cb9..adf9b1e1059e 100644
--- a/src/client/telemetry/index.ts
+++ b/src/client/telemetry/index.ts
@@ -1153,6 +1153,9 @@ export interface IEventNamePropertyMapping {
         "envsNotFound" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true , "owner": "donjayamanne"},
         "condaInfoEnvs" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true , "owner": "donjayamanne"},
         "condaInfoEnvsDirs" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true , "owner": "donjayamanne"},
+        "nativeCondaInfoEnvsDirs" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true , "owner": "donjayamanne"},
+        "condaRcs" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true , "owner": "donjayamanne"},
+        "nativeCondaRcs" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true , "owner": "donjayamanne"},
         "condaEnvsInEnvDir" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true , "owner": "donjayamanne"},
         "nativeCondaEnvsInEnvDir" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true , "owner": "donjayamanne"},
         "invalidCondaEnvs" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true , "owner": "donjayamanne"},
@@ -1161,6 +1164,9 @@ export interface IEventNamePropertyMapping {
         "environmentsWithoutPython" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" },
         "usingNativeLocator" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" },
         "canSpawnConda" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "donjayamanne" },
+        "nativeCanSpawnConda" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true , "owner": "donjayamanne"},
+        "condaRootPrefixFoundInInfoNotInNative" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true , "owner": "donjayamanne"},
+        "condaDefaultPrefixFoundInInfoNotInNative" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true , "owner": "donjayamanne"},
         "activeStateEnvs" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" },
         "condaEnvs" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" },
         "customEnvs" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "owner": "donjayamanne" },
@@ -1249,6 +1255,18 @@ export interface IEventNamePropertyMapping {
          * The number of the envs_dirs returned by `conda info`
          */
         condaInfoEnvsDirs?: number;
+        /**
+         * The number of the envs_dirs returned by native locator.
+         */
+        nativeCondaInfoEnvsDirs?: number;
+        /**
+         * The number of the conda rc files found using conda info
+         */
+        condaRcs?: number;
+        /**
+         * The number of the conda rc files found using native locator.
+         */
+        nativeCondaRcs?: number;
         /**
          * The number of conda interpreters that are in the one of the global conda env locations.
          * Global conda envs locations are returned by `conda info` in the `envs_dirs` setting.
@@ -1259,6 +1277,16 @@ export interface IEventNamePropertyMapping {
          * Global conda envs locations are returned by `conda info` in the `envs_dirs` setting.
          */
         nativeCondaEnvsInEnvDir?: number;
+        /**
+         * A conda env found that matches the root_prefix returned by `conda info`
+         * However a corresponding conda env not found by native locator.
+         */
+        condaRootPrefixFoundInInfoNotInNative?: boolean;
+        /**
+         * A conda env found that matches the root_prefix returned by `conda info`
+         * However a corresponding conda env not found by native locator.
+         */
+        condaDefaultPrefixFoundInInfoNotInNative?: boolean;
         /**
          * The number of conda interpreters without the `conda-meta` directory.
          */
@@ -1275,6 +1303,10 @@ export interface IEventNamePropertyMapping {
          * Conda exe can be spawned.
          */
         canSpawnConda?: boolean;
+        /**
+         * Conda exe can be spawned by native locator.
+         */
+        nativeCanSpawnConda?: boolean;
         /**
          * The number of the interpreters not found in disc.
          */
diff --git a/src/test/pythonEnvironments/base/locators/composite/envsCollectionService.unit.test.ts b/src/test/pythonEnvironments/base/locators/composite/envsCollectionService.unit.test.ts
index 572d6b904419..9acd76a6913f 100644
--- a/src/test/pythonEnvironments/base/locators/composite/envsCollectionService.unit.test.ts
+++ b/src/test/pythonEnvironments/base/locators/composite/envsCollectionService.unit.test.ts
@@ -29,6 +29,10 @@ import { OSType, getOSType } from '../../../../common';
 import * as nativeFinder from '../../../../../client/pythonEnvironments/base/locators/common/nativePythonFinder';
 
 class MockNativePythonFinder implements nativeFinder.NativeGlobalPythonFinder {
+    getCondaInfo(): Promise<nativeFinder.NativeCondaInfo> {
+        throw new Error('Method not implemented.');
+    }
+
     categoryToKind(_category: string): PythonEnvKind {
         throw new Error('Method not implemented.');
     }