feat: Disable all telemetry. (#202)

Artmann · web-flow · commit 26ad5685c0c6 · 2025-11-12T16:29:18.000+01:00
diff --git a/src/interactive-window/shiftEnterBanner.unit.test.ts b/src/interactive-window/shiftEnterBanner.unit.test.ts
@@ -10,8 +10,7 @@ import {
     isTestExecution,
     isUnitTestExecution,
     setTestExecution,
-    setUnitTestExecution,
-    Telemetry
+    setUnitTestExecution
 } from '../platform/common/constants';
 import {
     IConfigurationService,
@@ -61,10 +60,7 @@ suite('Interactive Shift Enter Banner', () => {
 
         config.verifyAll();
 
-        expect(Reporter.eventNames).to.deep.equal([
-            Telemetry.ShiftEnterBannerShown,
-            Telemetry.EnableInteractiveShiftEnter
-        ]);
+        // Telemetry verification removed as telemetry is now disabled
     });
 
     test("Shift Enter Banner don't check Jupyter when disabled", async () => {
@@ -89,10 +85,7 @@ suite('Interactive Shift Enter Banner', () => {
 
         config.verifyAll();
 
-        expect(Reporter.eventNames).to.deep.equal([
-            Telemetry.ShiftEnterBannerShown,
-            Telemetry.DisableInteractiveShiftEnter
-        ]);
+        // Telemetry verification removed as telemetry is now disabled
     });
 });
 
diff --git a/src/platform/common/experiments/telemetry.unit.test.ts b/src/platform/common/experiments/telemetry.unit.test.ts
@@ -9,20 +9,14 @@ import * as Telemetry from '../../../platform/telemetry/index';
 suite('Experimentation telemetry', () => {
     const event = 'SomeEventName';
 
-    let telemetryEvents: { eventName: string; properties: object }[] = [];
-    let sendTelemetryEventStub: sinon.SinonStub;
     let setSharedPropertyStub: sinon.SinonStub;
     let experimentTelemetry: ExperimentationTelemetry;
     let eventProperties: Map<string, string>;
 
     setup(() => {
-        sendTelemetryEventStub = sinon
-            .stub(Telemetry, 'sendTelemetryEvent')
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            .callsFake((eventName: string, _, properties: any) => {
-                const telemetry = { eventName, properties };
-                telemetryEvents.push(telemetry);
-            });
+        sinon.stub(Telemetry, 'sendTelemetryEvent').callsFake(() => {
+            // Stub for telemetry (now disabled)
+        });
         setSharedPropertyStub = sinon.stub(Telemetry, 'setSharedProperty');
 
         eventProperties = new Map<string, string>();
@@ -33,21 +27,13 @@ suite('Experimentation telemetry', () => {
     });
 
     teardown(() => {
-        telemetryEvents = [];
         sinon.restore();
     });
 
-    test('Calling postEvent should send a telemetry event', () => {
-        experimentTelemetry.postEvent(event, eventProperties);
-
-        sinon.assert.calledOnce(sendTelemetryEventStub);
-        assert.equal(telemetryEvents.length, 1);
-        assert.deepEqual(telemetryEvents[0], {
-            eventName: event,
-            properties: {
-                foo: 'one',
-                bar: 'two'
-            }
+    test('Calling postEvent should not throw (telemetry disabled)', () => {
+        // Telemetry is now disabled, so we just verify the method doesn't throw
+        assert.doesNotThrow(() => {
+            experimentTelemetry.postEvent(event, eventProperties);
         });
     });
 
diff --git a/src/platform/telemetry/index.ts b/src/platform/telemetry/index.ts
@@ -41,8 +41,7 @@ function isTelemetrySupported(): boolean {
  * @returns {boolean}
  */
 export function isTelemetryDisabled(): boolean {
-    const settings = workspace.getConfiguration('telemetry').inspect<boolean>('enableTelemetry')!;
-    return settings.globalValue === false ? true : false;
+    return true;
 }
 
 export function onDidChangeTelemetryEnablement(handler: (enabled: boolean) => void): Disposable {
diff --git a/src/platform/telemetry/index.unit.test.ts b/src/platform/telemetry/index.unit.test.ts
@@ -4,20 +4,13 @@
 /* eslint-disable , , @typescript-eslint/no-explicit-any */
 import * as sinon from 'sinon';
 import { expect } from 'chai';
-import { instance, mock, reset, verify, when } from 'ts-mockito';
-import { Disposable, WorkspaceConfiguration } from 'vscode';
+import { Disposable } from 'vscode';
 import { EXTENSION_ROOT_DIR } from '../constants.node';
-import {
-    _resetSharedProperties,
-    getTelemetryReporter,
-    isTelemetryDisabled,
-    sendTelemetryEvent,
-    setSharedProperty
-} from '../../telemetry';
+import { _resetSharedProperties, getTelemetryReporter, sendTelemetryEvent, setSharedProperty } from '../../telemetry';
 import { isUnitTestExecution, isTestExecution, setTestExecution, setUnitTestExecution } from '../common/constants';
 import { sleep } from '../../test/core';
 import { waitForCondition } from '../../test/common';
-import { mockedVSCodeNamespaces, resetVSCodeMocks } from '../../test/vscode-mock';
+import { resetVSCodeMocks } from '../../test/vscode-mock';
 import { IDisposable } from '../common/types';
 import { dispose } from '../common/utils/lifecycle';
 
@@ -80,35 +73,7 @@ suite('Telemetry', () => {
         _resetSharedProperties();
     });
 
-    const testsForisTelemetryDisabled = [
-        {
-            testName: 'Returns true when globalValue is set to false',
-            settings: { globalValue: false },
-            expectedResult: true
-        },
-        {
-            testName: 'Returns false otherwise',
-            settings: {},
-            expectedResult: false
-        }
-    ];
-
-    suite('Function isTelemetryDisabled()', () => {
-        testsForisTelemetryDisabled.forEach((testParams) => {
-            test(testParams.testName, async () => {
-                const workspaceConfig = mock<WorkspaceConfiguration>();
-                reset(mockedVSCodeNamespaces.workspace);
-                when(mockedVSCodeNamespaces.workspace.getConfiguration('telemetry')).thenReturn(
-                    instance(workspaceConfig)
-                );
-                when(workspaceConfig.inspect<string>('enableTelemetry')).thenReturn(testParams.settings as any);
-
-                expect(isTelemetryDisabled()).to.equal(testParams.expectedResult);
-
-                verify(mockedVSCodeNamespaces.workspace.getConfiguration('telemetry')).once();
-            });
-        });
-    });
+    // Note: isTelemetryDisabled() tests removed as telemetry is now permanently disabled
 
     test('Send Telemetry', async () => {
         const eventName = 'Testing';
diff --git a/src/standalone/import-export/importTracker.unit.test.ts b/src/standalone/import-export/importTracker.unit.test.ts
@@ -4,7 +4,6 @@
 /* eslint-disable , , @typescript-eslint/no-explicit-any, no-multi-str, no-trailing-spaces */
 import * as sinon from 'sinon';
 import * as fakeTimers from '@sinonjs/fake-timers';
-import { assert, expect } from 'chai';
 import { when } from 'ts-mockito';
 import { Disposable, EventEmitter, NotebookCellKind, NotebookDocument } from 'vscode';
 
@@ -18,11 +17,8 @@ import {
 } from '../../platform/common/constants';
 import { dispose } from '../../platform/common/utils/lifecycle';
 import { IDisposable } from '../../platform/common/types';
-import { EventName } from '../../platform/telemetry/constants';
-import { getTelemetrySafeHashedString } from '../../platform/telemetry/helpers';
 import { ImportTracker } from './importTracker';
-import { ResourceTypeTelemetryProperty, getTelemetryReporter } from '../../telemetry';
-import { waitForCondition } from '../../test/common';
+import { getTelemetryReporter } from '../../telemetry';
 import { createMockedNotebookDocument } from '../../test/datascience/editor-integration/helpers';
 import { mockedVSCodeNamespaces } from '../../test/vscode-mock';
 import { EmptyEvent } from '../../platform/common/utils/events';
@@ -35,15 +31,6 @@ suite(`Import Tracker`, async () => {
     let onDidOpenNbEvent: EventEmitter<NotebookDocument>;
     let onDidCloseNbEvent: EventEmitter<NotebookDocument>;
     let onDidSaveNbEvent: EventEmitter<NotebookDocument>;
-    let pandasHash: string;
-    let elephasHash: string;
-    let kerasHash: string;
-    let pysparkHash: string;
-    let sparkdlHash: string;
-    let numpyHash: string;
-    let scipyHash: string;
-    let sklearnHash: string;
-    let randomHash: string;
     let disposables: IDisposable[] = [];
     let clock: fakeTimers.InstalledClock;
 
@@ -52,46 +39,11 @@ suite(`Import Tracker`, async () => {
         public static properties: Record<string, string>[] = [];
         public static measures: {}[] = [];
 
-        public static async expectHashes(
-            when: 'onExecution' | 'onOpenCloseOrSave' = 'onOpenCloseOrSave',
-            resourceType: ResourceTypeTelemetryProperty['resourceType'] = undefined,
-            ...hashes: string[]
-        ) {
+        // Telemetry is now disabled, so this method just ensures the tracker doesn't crash
+        public static async expectHashes() {
             clock.tick(1);
             void clock.runAllAsync();
-            if (hashes.length > 0) {
-                await waitForCondition(
-                    async () => {
-                        expect(Reporter.eventNames).to.contain(EventName.HASHED_PACKAGE_NAME);
-                        return true;
-                    },
-                    1_000,
-                    'Hashed package name event not sent'
-                );
-                expect(Reporter.eventNames).to.contain(EventName.HASHED_PACKAGE_NAME);
-                await waitForCondition(
-                    async () => {
-                        Reporter.properties.filter((item) => Object.keys(item).length).length === hashes.length;
-                        return true;
-                    },
-                    1_000,
-                    () =>
-                        `Incorrect number of hashed package name events sent. Expected ${hashes.length}, got ${
-                            Reporter.properties.filter((item) => Object.keys(item).length).length
-                        }, with values ${JSON.stringify(
-                            Reporter.properties.filter((item) => Object.keys(item).length)
-                        )}`
-                );
-            }
-            const properties = Reporter.properties.filter((item) => Object.keys(item).length);
-            const expected = resourceType
-                ? hashes.map((hash) => ({ hashedNamev2: hash, when, resourceType }))
-                : hashes.map((hash) => ({ hashedNamev2: hash, when }));
-            assert.deepEqual(
-                properties.sort((a, b) => a.hashedNamev2.localeCompare(b.hashedNamev2)),
-                expected.sort((a, b) => a.hashedNamev2.localeCompare(b.hashedNamev2)),
-                `Hashes not sent correctly, expected ${JSON.stringify(expected)} but got ${JSON.stringify(properties)}`
-            );
+            // Telemetry verification removed as telemetry is now disabled
         }
 
         public sendTelemetryEvent(eventName: string, properties?: {}, measures?: {}) {
@@ -100,17 +52,6 @@ suite(`Import Tracker`, async () => {
             Reporter.measures.push(measures!);
         }
     }
-    suiteSetup(async () => {
-        pandasHash = await getTelemetrySafeHashedString('pandas');
-        elephasHash = await getTelemetrySafeHashedString('elephas');
-        kerasHash = await getTelemetrySafeHashedString('keras');
-        pysparkHash = await getTelemetrySafeHashedString('pyspark');
-        sparkdlHash = await getTelemetrySafeHashedString('sparkdl');
-        numpyHash = await getTelemetrySafeHashedString('numpy');
-        scipyHash = await getTelemetrySafeHashedString('scipy');
-        sklearnHash = await getTelemetrySafeHashedString('sklearn');
-        randomHash = await getTelemetrySafeHashedString('random');
-    });
     setup(() => {
         const reporter = getTelemetryReporter();
         sinon.stub(reporter, 'sendTelemetryEvent').callsFake((eventName: string, properties?: {}, measures?: {}) => {
@@ -159,21 +100,21 @@ suite(`Import Tracker`, async () => {
         const nb = createMockedNotebookDocument([{ kind: NotebookCellKind.Code, languageId: 'python', value: code }]);
         onDidOpenNbEvent.fire(nb);
 
-        await Reporter.expectHashes('onOpenCloseOrSave', 'notebook', pandasHash);
+        await Reporter.expectHashes();
     });
     test('Close document', async () => {
         const code = `import pandas\r\n`;
         const nb = createMockedNotebookDocument([{ kind: NotebookCellKind.Code, languageId: 'python', value: code }]);
         onDidCloseNbEvent.fire(nb);
 
-        await Reporter.expectHashes('onOpenCloseOrSave', 'notebook', pandasHash);
+        await Reporter.expectHashes();
     });
     test('Save document', async () => {
         const code = `import pandas\r\n`;
         const nb = createMockedNotebookDocument([{ kind: NotebookCellKind.Code, languageId: 'python', value: code }]);
         onDidSaveNbEvent.fire(nb);
 
-        await Reporter.expectHashes('onOpenCloseOrSave', 'notebook', pandasHash);
+        await Reporter.expectHashes();
     });
 
     test('Already opened documents', async () => {
@@ -183,13 +124,9 @@ suite(`Import Tracker`, async () => {
 
         await importTracker.activate();
 
-        await Reporter.expectHashes('onOpenCloseOrSave', 'notebook', pandasHash);
+        await Reporter.expectHashes();
     });
-    async function testImports(
-        code: string,
-        notebookType: typeof JupyterNotebookView | typeof InteractiveWindowView,
-        ...expectedPackageHashes: string[]
-    ) {
+    async function testImports(code: string, notebookType: typeof JupyterNotebookView | typeof InteractiveWindowView) {
         const nb = createMockedNotebookDocument(
             [{ kind: NotebookCellKind.Code, languageId: 'python', value: code }],
             undefined,
@@ -200,11 +137,7 @@ suite(`Import Tracker`, async () => {
 
         await importTracker.activate();
 
-        await Reporter.expectHashes(
-            'onOpenCloseOrSave',
-            notebookType === 'jupyter-notebook' ? 'notebook' : 'interactive',
-            ...expectedPackageHashes
-        );
+        await Reporter.expectHashes();
     }
     test('from <pkg>._ import _, _', async () => {
         const code = `
@@ -226,7 +159,7 @@ suite(`Import Tracker`, async () => {
 
             weights = adapter.retrieve_keras_weights(java_model)
             model.set_weights(weights)`;
-        await testImports(code, 'jupyter-notebook', elephasHash, kerasHash);
+        await testImports(code, 'jupyter-notebook');
     });
 
     test('from <pkg>._ import _', async () => {
@@ -247,7 +180,7 @@ suite(`Import Tracker`, async () => {
             evaluator = MulticlassClassificationEvaluator(metricName="accuracy")
             print("Training set accuracy = " + str(evaluator.evaluate(predictionAndLabels)))`;
 
-        await testImports(code, 'interactive', pysparkHash, sparkdlHash);
+        await testImports(code, 'interactive');
     });
 
     test('import <pkg> as _', async () => {
@@ -263,7 +196,7 @@ suite(`Import Tracker`, async () => {
         df.Age = categories
         return df`;
 
-        await testImports(code, 'interactive', pandasHash, numpyHash, randomHash);
+        await testImports(code, 'interactive');
     });
 
     test('from <pkg> import _', async () => {
@@ -277,12 +210,12 @@ suite(`Import Tracker`, async () => {
     y = np.array([r * np.sin(theta) for r in radius])
     z = np.array([drumhead_height(1, 1, r, theta, 0.5) for r in radius])`;
 
-        await testImports(code, 'interactive', scipyHash);
+        await testImports(code, 'interactive');
     });
 
     test('from <pkg> import _ as _', async () => {
         const code = `from pandas import DataFrame as df`;
-        await testImports(code, 'jupyter-notebook', pandasHash);
+        await testImports(code, 'jupyter-notebook');
     });
 
     test('import <pkg1>, <pkg2>', async () => {
@@ -295,7 +228,7 @@ suite(`Import Tracker`, async () => {
     x = np.array([r * np.cos(theta) for r in radius])
     y = np.array([r * np.sin(theta) for r in radius])
     z = np.array([drumhead_height(1, 1, r, theta, 0.5) for r in radius])`;
-        await testImports(code, 'interactive', sklearnHash, pandasHash);
+        await testImports(code, 'interactive');
     });
 
     test('Import from within a function', async () => {
@@ -309,14 +242,14 @@ suite(`Import Tracker`, async () => {
     y = np.array([r * np.sin(theta) for r in radius])
     z = np.array([drumhead_height(1, 1, r, theta, 0.5) for r in radius])`;
 
-        await testImports(code, 'interactive', sklearnHash);
+        await testImports(code, 'interactive');
     });
 
     test('Do not send the same package twice', async () => {
         const code = `
     import pandas
     import pandas`;
-        await testImports(code, 'interactive', pandasHash);
+        await testImports(code, 'interactive');
     });
 
     test('Ignore relative imports', async () => {
@@ -328,7 +261,7 @@ suite(`Import Tracker`, async () => {
         const nb = createMockedNotebookDocument([{ kind: NotebookCellKind.Code, languageId: 'python', value: code }]);
         notebookCellExecutions.changeCellState(nb.cellAt(0), NotebookCellExecutionState.Pending);
 
-        await Reporter.expectHashes('onExecution', 'notebook', numpyHash);
+        await Reporter.expectHashes();
 
         // Executing the cell multiple will have no effect, the telemetry is only sent once.
         notebookCellExecutions.changeCellState(nb.cellAt(0), NotebookCellExecutionState.Pending);
@@ -338,6 +271,6 @@ suite(`Import Tracker`, async () => {
         notebookCellExecutions.changeCellState(nb.cellAt(0), NotebookCellExecutionState.Executing);
         notebookCellExecutions.changeCellState(nb.cellAt(0), NotebookCellExecutionState.Idle);
 
-        await Reporter.expectHashes('onExecution', 'notebook', numpyHash);
+        await Reporter.expectHashes();
     });
 });

Original file line number	Diff line number	Diff line change
`@@ -41,8 +41,7 @@ function isTelemetrySupported(): boolean {`
`41`	`41`	`* @returns {boolean}`
`42`	`42`	`*/`
`43`	`43`	`export function isTelemetryDisabled(): boolean {`
`44`		`- const settings = workspace.getConfiguration('telemetry').inspect<boolean>('enableTelemetry')!;`
`45`		`- return settings.globalValue === false ? true : false;`
	`44`	`+ return true;`
`46`	`45`	`}`
`47`	`46`
`48`	`47`	`export function onDidChangeTelemetryEnablement(handler: (enabled: boolean) => void): Disposable {`