Sending telemetry for what language server is chosen (microsoft#7442)

* Sending telemetry for what language server is chosen * News entry * Apply suggestions from code review Co-Authored-By: Eric Snow <ericsnowcurrently@gmail.com> * Remove reduntant type info

Author: Kartik Raj

news/3 Code Health/7109.md

@@ -0,0 +1 @@
+Send telemetry for what language server is chosen

src/client/activation/activationService.ts

@@ -103,17 +103,17 @@ export class LanguageServerExtensionActivationService implements IExtensionActiv
  this.currentActivator.activator.dispose();
  }
  }
- @swallowExceptions('Switch Language Server')
- public async trackLangaugeServerSwitch(jediEnabled: boolean): Promise<void> {
+ @swallowExceptions('Send telemetry for Language Server current selection')
+ public async sendTelemetryForChosenLanguageServer(jediEnabled: boolean): Promise<void> {
  const state = this.stateFactory.createGlobalPersistentState<boolean | undefined>('SWITCH_LS', undefined);
  if (typeof state.value !== 'boolean') {
  await state.updateValue(jediEnabled);
- return;
  }
  if (state.value !== jediEnabled) {
  await state.updateValue(jediEnabled);
- const message = jediEnabled ? 'Switch to Jedi from LS' : 'Switch to LS from Jedi';
- sendTelemetryEvent(EventName.PYTHON_LANGUAGE_SERVER_SWITCHED, undefined, { change: message });
+ sendTelemetryEvent(EventName.PYTHON_LANGUAGE_SERVER_CURRENT_SELECTION, undefined, { switchTo: jediEnabled });
+ } else {
+ sendTelemetryEvent(EventName.PYTHON_LANGUAGE_SERVER_CURRENT_SELECTION, undefined, { startup: jediEnabled });
  }
  }
 
@@ -145,7 +145,7 @@ export class LanguageServerExtensionActivationService implements IExtensionActiv
  }
  const configurationService = this.serviceContainer.get<IConfigurationService>(IConfigurationService);
  const enabled = configurationService.getSettings(this.resource).jediEnabled;
- this.trackLangaugeServerSwitch(enabled).ignoreErrors();
+ this.sendTelemetryForChosenLanguageServer(enabled).ignoreErrors();
  return enabled;
  }
 

src/client/telemetry/constants.ts

@@ -57,7 +57,7 @@ export enum EventName {
  UNITTEST_NAVIGATE = 'UNITTEST.NAVIGATE',
  UNITTEST_ENABLED = 'UNITTEST.ENABLED',
  UNITTEST_EXPLORER_WORK_SPACE_COUNT = 'UNITTEST.TEST_EXPLORER.WORK_SPACE_COUNT',
- PYTHON_LANGUAGE_SERVER_SWITCHED = 'PYTHON_LANGUAGE_SERVER.SWITCHED',
+ PYTHON_LANGUAGE_SERVER_CURRENT_SELECTION = 'PYTHON_LANGUAGE_SERVER_CURRENT_SELECTION',
  PYTHON_LANGUAGE_SERVER_ENABLED = 'PYTHON_LANGUAGE_SERVER.ENABLED',
  PYTHON_LANGUAGE_SERVER_EXTRACTED = 'PYTHON_LANGUAGE_SERVER.EXTRACTED',
  PYTHON_LANGUAGE_SERVER_DOWNLOADED = 'PYTHON_LANGUAGE_SERVER.DOWNLOADED',

src/client/telemetry/index.ts

@@ -964,9 +964,18 @@ export interface IEventNamePropertyMapping {
  selection: 'Reload' | undefined;
  };
  /**
- * Telemetry tracking switching between LS and Jedi
+ * Telemetry sent with details about the current selection of language server
  */
- [EventName.PYTHON_LANGUAGE_SERVER_SWITCHED]: { change: 'Switch to Jedi from LS' | 'Switch to LS from Jedi' };
+ [EventName.PYTHON_LANGUAGE_SERVER_CURRENT_SELECTION]: {
+ /**
+ * The startup value of the language server setting
+ */
+ startup?: boolean;
+ /**
+ * Used to track switch between LS and Jedi. Carries the final state after the switch.
+ */
+ switchTo?: boolean;
+ };
  /**
  * Telemetry event sent with details after attempting to download LS
  */

src/test/activation/activationService.unit.test.ts

@@ -502,7 +502,7 @@ suite('Activation - ActivationService', () => {
  });
  });
 
- suite('Test trackLangaugeServerSwitch()', () => {
+ suite('Test sendTelemetryForChosenLanguageServer()', () => {
  let serviceContainer: TypeMoq.IMock<IServiceContainer>;
  let pythonSettings: TypeMoq.IMock<IPythonSettings>;
  let appShell: TypeMoq.IMock<IApplicationShell>;
@@ -578,33 +578,63 @@ suite('Activation - ActivationService', () => {
 
  test('Track current LS usage for first usage', async () => {
  state.reset();
- state.setup(s => s.value).returns(() => undefined).verifiable(TypeMoq.Times.once());
- state.setup(s => s.updateValue(TypeMoq.It.isValue(true))).returns(() => Promise.resolve()).verifiable(TypeMoq.Times.once());
+ state.setup(s => s.value).returns(() => undefined)
+ .verifiable(TypeMoq.Times.exactly(2));
+ state.setup(s => s.updateValue(TypeMoq.It.isValue(true)))
+ .returns(() => {
+ state.setup(s => s.value).returns(() => true);
+ return Promise.resolve();
+ })
+ .verifiable(TypeMoq.Times.once());
 
  const activationService = new LanguageServerExtensionActivationService(serviceContainer.object, stateFactory.object, experiments.object);
- await activationService.trackLangaugeServerSwitch(true);
+ await activationService.sendTelemetryForChosenLanguageServer(true);
 
  state.verifyAll();
  });
  test('Track switch to LS', async () => {
  state.reset();
- state.setup(s => s.value).returns(() => true).verifiable(TypeMoq.Times.once());
- state.setup(s => s.updateValue(TypeMoq.It.isValue(false))).returns(() => Promise.resolve()).verifiable(TypeMoq.Times.once());
+ state.setup(s => s.value)
+ .returns(() => true)
+ .verifiable(TypeMoq.Times.exactly(2));
+ state.setup(s => s.updateValue(TypeMoq.It.isValue(false)))
+ .returns(() => Promise.resolve())
+ .verifiable(TypeMoq.Times.once());
 
  const activationService = new LanguageServerExtensionActivationService(serviceContainer.object, stateFactory.object, experiments.object);
- await activationService.trackLangaugeServerSwitch(false);
+ await activationService.sendTelemetryForChosenLanguageServer(false);
 
- state.verify(s => s.updateValue(TypeMoq.It.isValue(false)), TypeMoq.Times.once());
+ state.verifyAll();
  });
  test('Track switch to Jedi', async () => {
  state.reset();
- state.setup(s => s.value).returns(() => false).verifiable(TypeMoq.Times.once());
- state.setup(s => s.updateValue(TypeMoq.It.isValue(true))).returns(() => Promise.resolve()).verifiable(TypeMoq.Times.once());
+ state.setup(s => s.value)
+ .returns(() => false)
+ .verifiable(TypeMoq.Times.exactly(2));
+ state.setup(s => s.updateValue(TypeMoq.It.isValue(true)))
+ .returns(() => Promise.resolve())
+ .verifiable(TypeMoq.Times.once());
 
  const activationService = new LanguageServerExtensionActivationService(serviceContainer.object, stateFactory.object, experiments.object);
- await activationService.trackLangaugeServerSwitch(true);
+ await activationService.sendTelemetryForChosenLanguageServer(true);
 
- state.verify(s => s.updateValue(TypeMoq.It.isValue(true)), TypeMoq.Times.once());
+ state.verifyAll();
+ });
+ test('Track startup value', async () => {
+ state.reset();
+ state
+ .setup(s => s.value)
+ .returns(() => true)
+ .verifiable(TypeMoq.Times.exactly(2));
+ state
+ .setup(s => s.updateValue(TypeMoq.It.isAny()))
+ .returns(() => Promise.resolve())
+ .verifiable(TypeMoq.Times.never());
+
+ const activationService = new LanguageServerExtensionActivationService(serviceContainer.object, stateFactory.object, experiments.object);
+ await activationService.sendTelemetryForChosenLanguageServer(true);
+
+ state.verifyAll();
  });
  });