Remove the unnecessary EnvFileTelemetry namespace (#11007)

Author: kimadeline

src/client/activation/activationManager.ts

@@ -13,7 +13,7 @@ import { IFileSystem } from '../common/platform/types';
 import { IDisposable, Resource } from '../common/types';
 import { IInterpreterAutoSelectionService } from '../interpreter/autoSelection/types';
 import { IInterpreterService } from '../interpreter/contracts';
-import { EnvFileTelemetry } from '../telemetry/envFileTelemetry';
+import { sendActivationTelemetry } from '../telemetry/envFileTelemetry';
 import { IExtensionActivationManager, IExtensionActivationService, IExtensionSingleActivationService } from './types';
 
 @injectable()
@@ -63,7 +63,7 @@ export class ExtensionActivationManager implements IExtensionActivationManager {
         // Get latest interpreter list in the background.
         this.interpreterService.getInterpreters(resource).ignoreErrors();
 
-        await EnvFileTelemetry.sendActivationTelemetry(this.fileSystem, this.workspaceService, resource);
+        await sendActivationTelemetry(this.fileSystem, this.workspaceService, resource);
 
         await this.autoSelection.autoSelectInterpreter(resource);
         await Promise.all(this.activationServices.map((item) => item.activate(resource)));

src/client/common/configSettings.ts

@@ -17,7 +17,7 @@ import '../common/extensions';
 import { IInterpreterAutoSeletionProxyService } from '../interpreter/autoSelection/types';
 import { sendTelemetryEvent } from '../telemetry';
 import { EventName } from '../telemetry/constants';
-import { EnvFileTelemetry } from '../telemetry/envFileTelemetry';
+import { sendSettingTelemetry } from '../telemetry/envFileTelemetry';
 import { IWorkspaceService } from './application/types';
 import { WorkspaceService } from './application/workspace';
 import { isTestExecution } from './constants';
@@ -205,7 +205,7 @@ export class PythonSettings implements IPythonSettings {
 
         const envFileSetting = pythonSettings.get<string>('envFile');
         this.envFile = systemVariables.resolveAny(envFileSetting)!;
-        EnvFileTelemetry.sendSettingTelemetry(this.workspace, envFileSetting);
+        sendSettingTelemetry(this.workspace, envFileSetting);
 
         // tslint:disable-next-line:no-any
         // tslint:disable-next-line:no-backbone-get-set-outside-model no-non-null-assertion no-any

src/client/common/variables/environmentVariablesProvider.ts

@@ -3,7 +3,7 @@
 
 import { inject, injectable } from 'inversify';
 import { ConfigurationChangeEvent, Disposable, Event, EventEmitter, FileSystemWatcher, Uri } from 'vscode';
-import { EnvFileTelemetry } from '../../telemetry/envFileTelemetry';
+import { sendFileCreationTelemetry } from '../../telemetry/envFileTelemetry';
 import { IWorkspaceService } from '../application/types';
 import { IPlatformService } from '../platform/types';
 import { IConfigurationService, ICurrentProcess, IDisposableRegistry } from '../types';
@@ -97,7 +97,7 @@ export class EnvironmentVariablesProvider implements IEnvironmentVariablesProvid
 
     private onEnvironmentFileCreated(workspaceFolderUri?: Uri) {
         this.onEnvironmentFileChanged(workspaceFolderUri);
-        EnvFileTelemetry.sendFileCreationTelemetry();
+        sendFileCreationTelemetry();
     }
 
     private onEnvironmentFileChanged(workspaceFolderUri?: Uri) {

src/client/telemetry/envFileTelemetry.ts

@@ -11,77 +11,69 @@ import { SystemVariables } from '../common/variables/systemVariables';
 import { sendTelemetryEvent } from '.';
 import { EventName } from './constants';
 
-export namespace EnvFileTelemetry {
-    let _defaultEnvFileSetting: string | undefined;
-    let envFileTelemetrySent = false;
+let _defaultEnvFileSetting: string | undefined;
+let envFileTelemetrySent = false;
 
-    export function sendSettingTelemetry(workspaceService: IWorkspaceService, envFileSetting?: string) {
-        if (shouldSendTelemetry() && envFileSetting !== defaultEnvFileSetting(workspaceService)) {
-            sendTelemetry(true);
-        }
+export function sendSettingTelemetry(workspaceService: IWorkspaceService, envFileSetting?: string) {
+    if (shouldSendTelemetry() && envFileSetting !== defaultEnvFileSetting(workspaceService)) {
+        sendTelemetry(true);
     }
+}
 
-    export function sendFileCreationTelemetry() {
-        if (shouldSendTelemetry()) {
-            sendTelemetry();
-        }
+export function sendFileCreationTelemetry() {
+    if (shouldSendTelemetry()) {
+        sendTelemetry();
     }
+}
 
-    export async function sendActivationTelemetry(
-        fileSystem: IFileSystem,
-        workspaceService: IWorkspaceService,
-        resource: Resource
-    ) {
-        if (shouldSendTelemetry()) {
-            const systemVariables = new SystemVariables(resource, undefined, workspaceService);
-            const envFilePath = systemVariables.resolveAny(defaultEnvFileSetting(workspaceService))!;
-            const envFileExists = await fileSystem.fileExists(envFilePath);
+export async function sendActivationTelemetry(
+    fileSystem: IFileSystem,
+    workspaceService: IWorkspaceService,
+    resource: Resource
+) {
+    if (shouldSendTelemetry()) {
+        const systemVariables = new SystemVariables(resource, undefined, workspaceService);
+        const envFilePath = systemVariables.resolveAny(defaultEnvFileSetting(workspaceService))!;
+        const envFileExists = await fileSystem.fileExists(envFilePath);
 
-            if (envFileExists) {
-                sendTelemetry();
-            }
+        if (envFileExists) {
+            sendTelemetry();
         }
     }
+}
 
-    function sendTelemetry(hasCustomEnvPath: boolean = false) {
-        sendTelemetryEvent(EventName.ENVFILE_WORKSPACE, undefined, { hasCustomEnvPath });
-
-        envFileTelemetrySent = true;
-    }
+function sendTelemetry(hasCustomEnvPath: boolean = false) {
+    sendTelemetryEvent(EventName.ENVFILE_WORKSPACE, undefined, { hasCustomEnvPath });
 
-    function shouldSendTelemetry(): boolean {
-        return !envFileTelemetrySent;
-    }
+    envFileTelemetrySent = true;
+}
 
-    function defaultEnvFileSetting(workspaceService: IWorkspaceService) {
-        if (!_defaultEnvFileSetting) {
-            const section = workspaceService.getConfiguration('python');
-            _defaultEnvFileSetting = section.inspect<string>('envFile')?.defaultValue || '';
-        }
+function shouldSendTelemetry(): boolean {
+    return !envFileTelemetrySent;
+}
 
-        return _defaultEnvFileSetting;
+function defaultEnvFileSetting(workspaceService: IWorkspaceService) {
+    if (!_defaultEnvFileSetting) {
+        const section = workspaceService.getConfiguration('python');
+        _defaultEnvFileSetting = section.inspect<string>('envFile')?.defaultValue || '';
     }
 
-    // Set state for tests.
-    export namespace EnvFileTelemetryTests {
-        export function setState({
-            telemetrySent,
-            defaultSetting
-        }: {
-            telemetrySent?: boolean;
-            defaultSetting?: string;
-        }) {
-            if (telemetrySent !== undefined) {
-                envFileTelemetrySent = telemetrySent;
-            }
-            if (defaultEnvFileSetting !== undefined) {
-                _defaultEnvFileSetting = defaultSetting;
-            }
-        }
+    return _defaultEnvFileSetting;
+}
 
-        export function resetState() {
-            _defaultEnvFileSetting = undefined;
-            envFileTelemetrySent = false;
+// Set state for tests.
+export namespace EnvFileTelemetryTests {
+    export function setState({ telemetrySent, defaultSetting }: { telemetrySent?: boolean; defaultSetting?: string }) {
+        if (telemetrySent !== undefined) {
+            envFileTelemetrySent = telemetrySent;
+        }
+        if (defaultEnvFileSetting !== undefined) {
+            _defaultEnvFileSetting = defaultSetting;
         }
     }
+
+    export function resetState() {
+        _defaultEnvFileSetting = undefined;
+        envFileTelemetrySent = false;
+    }
 }

src/test/activation/activationManager.unit.test.ts

@@ -22,7 +22,7 @@ import { IDisposable } from '../../client/common/types';
 import { IInterpreterAutoSelectionService } from '../../client/interpreter/autoSelection/types';
 import { IInterpreterService } from '../../client/interpreter/contracts';
 import { InterpreterService } from '../../client/interpreter/interpreterService';
-import { EnvFileTelemetry } from '../../client/telemetry/envFileTelemetry';
+import * as EnvFileTelemetry from '../../client/telemetry/envFileTelemetry';
 import { sleep } from '../core';
 
 // tslint:disable:max-func-body-length no-any

src/test/common/configSettings/configSettings.pythonPath.unit.test.ts

@@ -13,7 +13,7 @@ import * as typemoq from 'typemoq';
 import { Uri, WorkspaceConfiguration } from 'vscode';
 import { PythonSettings } from '../../../client/common/configSettings';
 import { noop } from '../../../client/common/utils/misc';
-import { EnvFileTelemetry } from '../../../client/telemetry/envFileTelemetry';
+import * as EnvFileTelemetry from '../../../client/telemetry/envFileTelemetry';
 import { MockAutoSelectionService } from '../../mocks/autoSelector';
 const untildify = require('untildify');
 

src/test/common/configSettings/configSettings.unit.test.ts

@@ -27,7 +27,7 @@ import {
     IWorkspaceSymbolSettings
 } from '../../../client/common/types';
 import { noop } from '../../../client/common/utils/misc';
-import { EnvFileTelemetry } from '../../../client/telemetry/envFileTelemetry';
+import * as EnvFileTelemetry from '../../../client/telemetry/envFileTelemetry';
 import { MockAutoSelectionService } from '../../mocks/autoSelector';
 
 // tslint:disable-next-line:max-func-body-length

src/test/common/variables/environmentVariablesProvider.unit.test.ts

@@ -21,7 +21,7 @@ import { clearCache } from '../../../client/common/utils/cacheUtils';
 import { EnvironmentVariablesService } from '../../../client/common/variables/environment';
 import { EnvironmentVariablesProvider } from '../../../client/common/variables/environmentVariablesProvider';
 import { IEnvironmentVariablesService } from '../../../client/common/variables/types';
-import { EnvFileTelemetry } from '../../../client/telemetry/envFileTelemetry';
+import * as EnvFileTelemetry from '../../../client/telemetry/envFileTelemetry';
 import { noop } from '../../core';
 
 // tslint:disable:no-any max-func-body-length

src/test/telemetry/envFileTelemetry.unit.test.ts

@@ -12,7 +12,12 @@ import { FileSystem } from '../../client/common/platform/fileSystem';
 import { IFileSystem } from '../../client/common/platform/types';
 import * as Telemetry from '../../client/telemetry';
 import { EventName } from '../../client/telemetry/constants';
-import { EnvFileTelemetry } from '../../client/telemetry/envFileTelemetry';
+import {
+    EnvFileTelemetryTests,
+    sendActivationTelemetry,
+    sendFileCreationTelemetry,
+    sendSettingTelemetry
+} from '../../client/telemetry/envFileTelemetry';
 
 suite('Env file telemetry', () => {
     const defaultEnvFileValue = 'someDefaultValue';
@@ -53,45 +58,45 @@ suite('Env file telemetry', () => {
     teardown(() => {
         telemetryEvent = undefined;
         sinon.restore();
-        EnvFileTelemetry.EnvFileTelemetryTests.resetState();
+        EnvFileTelemetryTests.resetState();
     });
 
     test('Setting telemetry should be sent with hasCustomEnvPath at true if the python.envFile setting is different from the default value', () => {
-        EnvFileTelemetry.sendSettingTelemetry(instance(workspaceService), 'bar');
+        sendSettingTelemetry(instance(workspaceService), 'bar');
 
         sinon.assert.calledOnce(sendTelemetryStub);
         assert.deepEqual(telemetryEvent, { eventName: EventName.ENVFILE_WORKSPACE, hasCustomEnvPath: true });
     });
 
     test('Setting telemetry should not be sent if a telemetry event has already been sent', () => {
-        EnvFileTelemetry.EnvFileTelemetryTests.setState({ telemetrySent: true });
+        EnvFileTelemetryTests.setState({ telemetrySent: true });
 
-        EnvFileTelemetry.sendSettingTelemetry(instance(workspaceService), 'bar');
+        sendSettingTelemetry(instance(workspaceService), 'bar');
 
         sinon.assert.notCalled(sendTelemetryStub);
         assert.deepEqual(telemetryEvent, undefined);
     });
 
     test('Setting telemetry should not be sent if the python.envFile setting is the same as the default value', () => {
-        EnvFileTelemetry.EnvFileTelemetryTests.setState({ defaultSetting: defaultEnvFileValue });
+        EnvFileTelemetryTests.setState({ defaultSetting: defaultEnvFileValue });
 
-        EnvFileTelemetry.sendSettingTelemetry(instance(workspaceService), defaultEnvFileValue);
+        sendSettingTelemetry(instance(workspaceService), defaultEnvFileValue);
 
         sinon.assert.notCalled(sendTelemetryStub);
         assert.deepEqual(telemetryEvent, undefined);
     });
 
     test('File creation telemetry should be sent if no telemetry event has been sent before', () => {
-        EnvFileTelemetry.sendFileCreationTelemetry();
+        sendFileCreationTelemetry();
 
         sinon.assert.calledOnce(sendTelemetryStub);
         assert.deepEqual(telemetryEvent, { eventName: EventName.ENVFILE_WORKSPACE, hasCustomEnvPath: false });
     });
 
     test('File creation telemetry should not be sent if a telemetry event has already been sent', () => {
-        EnvFileTelemetry.EnvFileTelemetryTests.setState({ telemetrySent: true });
+        EnvFileTelemetryTests.setState({ telemetrySent: true });
 
-        EnvFileTelemetry.sendFileCreationTelemetry();
+        sendFileCreationTelemetry();
 
         sinon.assert.notCalled(sendTelemetryStub);
         assert.deepEqual(telemetryEvent, undefined);
@@ -100,16 +105,16 @@ suite('Env file telemetry', () => {
     test('Activation telemetry should be sent if no telemetry event has been sent before, and a .env file exists', async () => {
         when(fileSystem.fileExists(anyString())).thenResolve(true);
 
-        await EnvFileTelemetry.sendActivationTelemetry(instance(fileSystem), instance(workspaceService), resource);
+        await sendActivationTelemetry(instance(fileSystem), instance(workspaceService), resource);
 
         sinon.assert.calledOnce(sendTelemetryStub);
         assert.deepEqual(telemetryEvent, { eventName: EventName.ENVFILE_WORKSPACE, hasCustomEnvPath: false });
     });
 
     test('Activation telemetry should not be sent if a telemetry event has already been sent', async () => {
-        EnvFileTelemetry.EnvFileTelemetryTests.setState({ telemetrySent: true });
+        EnvFileTelemetryTests.setState({ telemetrySent: true });
 
-        await EnvFileTelemetry.sendActivationTelemetry(instance(fileSystem), instance(workspaceService), resource);
+        await sendActivationTelemetry(instance(fileSystem), instance(workspaceService), resource);
 
         sinon.assert.notCalled(sendTelemetryStub);
         assert.deepEqual(telemetryEvent, undefined);
@@ -118,7 +123,7 @@ suite('Env file telemetry', () => {
     test('Activation telemetry should not be sent if no .env file exists', async () => {
         when(fileSystem.fileExists(anyString())).thenResolve(false);
 
-        await EnvFileTelemetry.sendActivationTelemetry(instance(fileSystem), instance(workspaceService), resource);
+        await sendActivationTelemetry(instance(fileSystem), instance(workspaceService), resource);
 
         sinon.assert.notCalled(sendTelemetryStub);
         assert.deepEqual(telemetryEvent, undefined);