Skip to content

Commit ca96cdf

Browse files
Mock sendTelemetryErrorEvent and check appropriately
1 parent aad1fee commit ca96cdf

File tree

1 file changed

+20
-3
lines changed

1 file changed

+20
-3
lines changed

extensions/ql-vscode/test/vscode-tests/no-workspace/telemetry.test.ts

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,9 @@ describe("telemetry reporting", () => {
3030
let sendTelemetryEventSpy: jest.SpiedFunction<
3131
typeof TelemetryReporter.prototype.sendTelemetryEvent
3232
>;
33+
let sendTelemetryErrorEventSpy: jest.SpiedFunction<
34+
typeof TelemetryReporter.prototype.sendTelemetryErrorEvent
35+
>;
3336
let disposeSpy: jest.SpiedFunction<
3437
typeof TelemetryReporter.prototype.dispose
3538
>;
@@ -53,6 +56,9 @@ describe("telemetry reporting", () => {
5356
sendTelemetryEventSpy = jest
5457
.spyOn(TelemetryReporter.prototype, "sendTelemetryEvent")
5558
.mockReturnValue(undefined);
59+
sendTelemetryErrorEventSpy = jest
60+
.spyOn(TelemetryReporter.prototype, "sendTelemetryErrorEvent")
61+
.mockReturnValue(undefined);
5662
disposeSpy = jest
5763
.spyOn(TelemetryReporter.prototype, "dispose")
5864
.mockResolvedValue(undefined);
@@ -192,6 +198,7 @@ describe("telemetry reporting", () => {
192198
},
193199
{ executionTime: 1234 },
194200
);
201+
expect(sendTelemetryErrorEventSpy).not.toBeCalled();
195202
});
196203

197204
it("should send a command usage event with an error", async () => {
@@ -213,6 +220,7 @@ describe("telemetry reporting", () => {
213220
},
214221
{ executionTime: 1234 },
215222
);
223+
expect(sendTelemetryErrorEventSpy).not.toBeCalled();
216224
});
217225

218226
it("should send a command usage event with a cli version", async () => {
@@ -235,6 +243,7 @@ describe("telemetry reporting", () => {
235243
},
236244
{ executionTime: 1234 },
237245
);
246+
expect(sendTelemetryErrorEventSpy).not.toBeCalled();
238247

239248
// Verify that if the cli version is not set, then the telemetry falls back to "not-set"
240249
sendTelemetryEventSpy.mockClear();
@@ -256,6 +265,7 @@ describe("telemetry reporting", () => {
256265
},
257266
{ executionTime: 5678 },
258267
);
268+
expect(sendTelemetryErrorEventSpy).not.toBeCalled();
259269
});
260270

261271
it("should avoid sending an event when telemetry is disabled", async () => {
@@ -266,6 +276,7 @@ describe("telemetry reporting", () => {
266276
telemetryListener.sendCommandUsage("command-id", 1234, new Error());
267277

268278
expect(sendTelemetryEventSpy).not.toBeCalled();
279+
expect(sendTelemetryErrorEventSpy).not.toBeCalled();
269280
});
270281

271282
it("should send an event when telemetry is re-enabled", async () => {
@@ -285,6 +296,7 @@ describe("telemetry reporting", () => {
285296
},
286297
{ executionTime: 1234 },
287298
);
299+
expect(sendTelemetryErrorEventSpy).not.toBeCalled();
288300
});
289301

290302
it("should filter undesired properties from telemetry payload", async () => {
@@ -442,6 +454,7 @@ describe("telemetry reporting", () => {
442454
},
443455
{},
444456
);
457+
expect(sendTelemetryErrorEventSpy).not.toBeCalled();
445458
});
446459

447460
it("should send a ui-interaction telementry event with a cli version", async () => {
@@ -459,14 +472,16 @@ describe("telemetry reporting", () => {
459472
},
460473
{},
461474
);
475+
expect(sendTelemetryErrorEventSpy).not.toBeCalled();
462476
});
463477

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

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

469-
expect(sendTelemetryEventSpy).toHaveBeenCalledWith(
483+
expect(sendTelemetryEventSpy).not.toBeCalled();
484+
expect(sendTelemetryErrorEventSpy).toHaveBeenCalledWith(
470485
"error",
471486
{
472487
message: "test",
@@ -484,7 +499,8 @@ describe("telemetry reporting", () => {
484499

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

487-
expect(sendTelemetryEventSpy).toHaveBeenCalledWith(
502+
expect(sendTelemetryEventSpy).not.toBeCalled();
503+
expect(sendTelemetryErrorEventSpy).toHaveBeenCalledWith(
488504
"error",
489505
{
490506
message: "test",
@@ -503,7 +519,8 @@ describe("telemetry reporting", () => {
503519
redactableError`test message with secret information: ${42} and more ${"secret"} parts`,
504520
);
505521

506-
expect(sendTelemetryEventSpy).toHaveBeenCalledWith(
522+
expect(sendTelemetryEventSpy).not.toBeCalled();
523+
expect(sendTelemetryErrorEventSpy).toHaveBeenCalledWith(
507524
"error",
508525
{
509526
message:

0 commit comments

Comments
 (0)