Report Environments activation state

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Author: eleanorjboyd

src/client/envExt/api.internal.ts

@@ -57,11 +57,13 @@ export function shouldEnvExtHandleActivation(): boolean {
 
 function getEnvExtensionDecisionInputs(): Pick<
     EnvsIntegrationDecisionTelemetry,
-    'envsAvailableToHostNow' | 'envsResolvedSettingNow'
+    'envsAvailableToHostNow' | 'envsActiveNow' | 'envsResolvedSettingNow'
 > {
     const config = getConfiguration('python');
+    const extension = getExtension(ENVS_EXTENSION_ID);
     return {
-        envsAvailableToHostNow: !!getExtension(ENVS_EXTENSION_ID),
+        envsAvailableToHostNow: !!extension,
+        envsActiveNow: extension?.isActive ?? false,
         envsResolvedSettingNow: config?.get<boolean>('useEnvironmentsExtension', false) ?? false,
     };
 }

src/client/startupTelemetry.ts

@@ -24,6 +24,7 @@ function getEnvExtensionStartupTelemetry() {
     return {
         envsDecisionReason: telemetry.envsDecisionReason,
         envsAvailableToHostNow: telemetry.envsAvailableToHostNow,
+        envsActiveNow: telemetry.envsActiveNow,
         envsResolvedSettingNow: telemetry.envsResolvedSettingNow,
     };
 }

src/client/telemetry/index.ts

@@ -363,6 +363,7 @@ export interface IEventNamePropertyMapping {
           "envsexplicitfalsescope" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "eleanorjboyd" },
           "envsdecisionreason" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "eleanorjboyd" },
           "envsavailabletohostnow" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "eleanorjboyd" },
+          "envsactivenow" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "eleanorjboyd" },
           "envsresolvedsettingnow" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "eleanorjboyd" }
        }
      */
@@ -427,6 +428,10 @@ export interface IEventNamePropertyMapping {
          * Whether Python Environments is currently available to this extension host.
          */
         envsAvailableToHostNow?: boolean;
+        /**
+         * Whether Python Environments is currently active in this extension host.
+         */
+        envsActiveNow?: boolean;
         /**
          * The current resolved value of python.useEnvironmentsExtension.
          */
@@ -441,6 +446,7 @@ export interface IEventNamePropertyMapping {
           "envsexplicitfalsescope" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "eleanorjboyd" },
           "envsdecisionreason" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "eleanorjboyd" },
           "envsavailabletohostnow" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "eleanorjboyd" },
+          "envsactivenow" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "eleanorjboyd" },
           "envsresolvedsettingnow" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "eleanorjboyd" },
           "envscacheddecision" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "eleanorjboyd" }
        }
@@ -449,6 +455,7 @@ export interface IEventNamePropertyMapping {
         envsExplicitFalseScope: EnvsExplicitFalseScope;
         envsDecisionReason?: EnvsIntegrationDecisionReason;
         envsAvailableToHostNow: boolean;
+        envsActiveNow: boolean;
         envsResolvedSettingNow: boolean;
         envsCachedDecision?: boolean;
     };

src/client/telemetry/types.ts

@@ -15,6 +15,7 @@ export type EnvsIntegrationDecisionReason = 'enabled' | 'extensionUnavailable' |
 export type EnvsIntegrationDecisionTelemetry = {
     envsDecisionReason?: EnvsIntegrationDecisionReason;
     envsAvailableToHostNow: boolean;
+    envsActiveNow: boolean;
     envsResolvedSettingNow: boolean;
     envsCachedDecision?: boolean;
 };

src/test/envExt/api.internal.unit.test.ts

@@ -39,35 +39,39 @@ suite('Python Environments integration decision telemetry', () => {
         {
             name: 'extension unavailable',
             available: false,
+            active: false,
             resolvedSetting: true,
             decision: false,
             reason: 'extensionUnavailable',
         },
         {
             name: 'resolved setting false',
             available: true,
+            active: true,
             resolvedSetting: false,
             decision: false,
             reason: 'resolvedSettingFalse',
         },
         {
             name: 'integration enabled',
             available: true,
+            active: true,
             resolvedSetting: true,
             decision: true,
             reason: 'enabled',
         },
     ] as const;
 
-    cases.forEach(({ name, available, resolvedSetting, decision, reason }) => {
+    cases.forEach(({ name, available, active, resolvedSetting, decision, reason }) => {
         test(`captures ${name}`, () => {
             getConfiguration.returns(configuration(resolvedSetting));
-            getExtension.returns(available ? ({} as Extension<unknown>) : undefined);
+            getExtension.returns(available ? ({ isActive: active } as Extension<unknown>) : undefined);
 
             assert.strictEqual(useEnvExtension(), decision);
             assert.deepEqual(getEnvExtensionDecisionTelemetry(), {
                 envsDecisionReason: reason,
                 envsAvailableToHostNow: available,
+                envsActiveNow: active,
                 envsResolvedSettingNow: resolvedSetting,
                 envsCachedDecision: decision,
             });
@@ -78,11 +82,12 @@ suite('Python Environments integration decision telemetry', () => {
     test('reports live inputs without changing a stale cached decision', () => {
         assert.isFalse(useEnvExtension());
         getConfiguration.returns(configuration(true));
-        getExtension.returns({} as Extension<unknown>);
+        getExtension.returns({ isActive: true } as Extension<unknown>);
 
         assert.deepEqual(getEnvExtensionDecisionTelemetry(), {
             envsDecisionReason: 'extensionUnavailable',
             envsAvailableToHostNow: true,
+            envsActiveNow: true,
             envsResolvedSettingNow: true,
             envsCachedDecision: false,
         });
@@ -91,11 +96,12 @@ suite('Python Environments integration decision telemetry', () => {
 
     test('does not initialize the cached decision when telemetry is requested', () => {
         getConfiguration.returns(configuration(true));
-        getExtension.returns({} as Extension<unknown>);
+        getExtension.returns({ isActive: false } as Extension<unknown>);
 
         assert.deepEqual(getEnvExtensionDecisionTelemetry(), {
             envsDecisionReason: undefined,
             envsAvailableToHostNow: true,
+            envsActiveNow: false,
             envsResolvedSettingNow: true,
             envsCachedDecision: undefined,
         });

src/test/envExt/telemetry.unit.test.ts

@@ -48,6 +48,7 @@ suite('Environments extension telemetry', () => {
     const decisionTelemetry = {
         envsDecisionReason: 'resolvedSettingFalse' as const,
         envsAvailableToHostNow: true,
+        envsActiveNow: true,
         envsResolvedSettingNow: false,
         envsCachedDecision: false,
     };

src/test/startupTelemetry.unit.test.ts

@@ -76,6 +76,7 @@ suite('Startup Telemetry - hasUserDefinedPythonPath()', async () => {
             sinon.stub(envExt, 'getEnvExtensionDecisionTelemetry').returns({
                 envsDecisionReason: 'resolvedSettingFalse',
                 envsAvailableToHostNow: true,
+                envsActiveNow: true,
                 envsResolvedSettingNow: false,
                 envsCachedDecision: false,
             });
@@ -111,6 +112,7 @@ suite('Startup Telemetry - hasUserDefinedPythonPath()', async () => {
                         envsExplicitFalseScope: 'workspace',
                         envsDecisionReason: 'resolvedSettingFalse',
                         envsAvailableToHostNow: true,
+                        envsActiveNow: true,
                         envsResolvedSettingNow: false,
                         isFirstSession: false,
                     }),