Skip to content

Cleanup config to enabling new telemetry #2115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
robertbrignull merged 1 commit into from
Mar 3, 2023
Merged

Cleanup config to enabling new telemetry #2115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions extensions/ql-vscode/src/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,6 @@ export const GLOBAL_ENABLE_TELEMETRY = new Setting(
GLOBAL_TELEMETRY_SETTING,
);

export function newTelemetryEnabled(): boolean {
return true;
}

// Distribution configuration
const DISTRIBUTION_SETTING = new Setting("cli", ROOT_SETTING);
export const CUSTOM_CODEQL_PATH_SETTING = new Setting(
Expand Down
9 changes: 0 additions & 9 deletions extensions/ql-vscode/src/telemetry.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ import {
LOG_TELEMETRY,
isIntegrationTestMode,
isCanary,
newTelemetryEnabled,
} from "./config";
import * as appInsights from "applicationinsights";
import { extLogger } from "./common";
Expand Down Expand Up @@ -174,10 +173,6 @@ export class TelemetryListener extends ConfigListener {
return;
}

if (!newTelemetryEnabled()) {
return;
}

this.reporter.sendTelemetryEvent(
"ui-interaction",
{
Expand All @@ -196,10 +191,6 @@ export class TelemetryListener extends ConfigListener {
return;
}

if (!newTelemetryEnabled()) {
return;
}

const properties: { [key: string]: string } = {
isCanary: isCanary().toString(),
message: error.redactedMessage,
Expand Down
76 changes: 23 additions & 53 deletions extensions/ql-vscode/test/vscode-tests/no-workspace/telemetry.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ import {
} from "../../../src/telemetry";
import { UserCancellationException } from "../../../src/commandRunner";
import { ENABLE_TELEMETRY } from "../../../src/config";
import * as Config from "../../../src/config";
import { createMockExtensionContext } from "./index";
import { vscodeGetConfigurationMock } from "../test-config";
import { redactableError } from "../../../src/pure/errors";
Expand Down Expand Up @@ -393,67 +392,38 @@ describe("telemetry reporting", () => {
expect(showInformationMessageSpy).toBeCalledTimes(1);
});

describe("when new telementry is not enabled", () => {
beforeEach(async () => {
jest.spyOn(Config, "newTelemetryEnabled").mockReturnValue(false);
});

it("should not send a ui-interaction telementry event", async () => {
await telemetryListener.initialize();

telemetryListener.sendUIInteraction("test");

expect(sendTelemetryEventSpy).not.toBeCalled();
});

it("should not send an error telementry event", async () => {
await telemetryListener.initialize();
it("should send a ui-interaction telementry event", async () => {
await telemetryListener.initialize();

telemetryListener.sendError(redactableError`test`);
telemetryListener.sendUIInteraction("test");

expect(sendTelemetryEventSpy).not.toBeCalled();
});
expect(sendTelemetryEventSpy).toHaveBeenCalledWith(
"ui-interaction",
{
name: "test",
isCanary,
},
{},
);
});

describe("when new telementry is enabled", () => {
beforeEach(async () => {
jest.spyOn(Config, "newTelemetryEnabled").mockReturnValue(true);
});

it("should send a ui-interaction telementry event", async () => {
await telemetryListener.initialize();

telemetryListener.sendUIInteraction("test");

expect(sendTelemetryEventSpy).toHaveBeenCalledWith(
"ui-interaction",
{
name: "test",
isCanary,
},
{},
);
});

it("should send an error telementry event", async () => {
await telemetryListener.initialize();
it("should send an error telementry event", async () => {
await telemetryListener.initialize();

telemetryListener.sendError(redactableError`test`);
telemetryListener.sendError(redactableError`test`);

expect(sendTelemetryEventSpy).toHaveBeenCalledWith(
"error",
{
message: "test",
isCanary,
stack: expect.any(String),
},
{},
);
});
expect(sendTelemetryEventSpy).toHaveBeenCalledWith(
"error",
{
message: "test",
isCanary,
stack: expect.any(String),
},
{},
);
});

it("should redact error message contents", async () => {
jest.spyOn(Config, "newTelemetryEnabled").mockReturnValue(true);
await telemetryListener.initialize();

telemetryListener.sendError(
Expand Down