Skip to content

chore(cli): updates to telemetry sink classes #696

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
merged 4 commits into from
Jul 9, 2025
Merged

chore(cli): updates to telemetry sink classes #696

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
93312cd
chore(cli): updates to telemetry sink classes
kaizencc Jul 8, 2025
f629406
Merge branch 'main' into conroy/fast-follow
kaizencc Jul 8, 2025
cb991f2
fix tests
kaizencc Jul 8, 2025
1d48f04
lint
kaizencc Jul 8, 2025
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
Prev Previous commit
Next Next commit
fix tests
  • Loading branch information
@kaizencc
kaizencc committed Jul 8, 2025
commit cb991f2d9d2299cffaa184fd9d12c119ba1ae66f
36 changes: 14 additions & 22 deletions packages/aws-cdk/test/cli/telemetry/endpoint-sink.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import * as https from 'https';
import { parse } from 'url';
import { IoHelper } from '../../../lib/api-private';
import { CliIoHost } from '../../../lib/cli/io-host';
import { EndpointTelemetrySink } from '../../../lib/cli/telemetry/endpoint-sink';
Expand Down Expand Up @@ -88,16 +87,15 @@ describe('EndpointTelemetrySink', () => {
test('makes a POST request to the specified endpoint', async () => {
// GIVEN
const mockRequest = setupMockRequest();
const endpoint = parse('https://example.com/telemetry');
const testEvent = createTestEvent('test', { foo: 'bar' });
const client = new EndpointTelemetrySink({ endpoint, ioHost });
const client = new EndpointTelemetrySink({ endpoint: 'https://example.com/telemetry', ioHost });

// WHEN
await client.emit(testEvent);
await client.flush();

// THEN
const expectedPayload = JSON.stringify([testEvent]);
const expectedPayload = JSON.stringify({ events: [testEvent]});
expect(https.request).toHaveBeenCalledWith({
hostname: 'example.com',
port: null,
Expand All @@ -117,9 +115,8 @@ describe('EndpointTelemetrySink', () => {
test('silently catches request errors', async () => {
// GIVEN
const mockRequest = setupMockRequest();
const endpoint = parse('https://example.com/telemetry');
const testEvent = createTestEvent('test');
const client = new EndpointTelemetrySink({ endpoint, ioHost });
const client = new EndpointTelemetrySink({ endpoint: 'https://example.com/telemetry', ioHost });

mockRequest.on.mockImplementation((event, callback) => {
if (event === 'error') {
Expand All @@ -137,18 +134,17 @@ describe('EndpointTelemetrySink', () => {
test('multiple events sent as one', async () => {
// GIVEN
const mockRequest = setupMockRequest();
const endpoint = parse('https://example.com/telemetry');
const testEvent1 = createTestEvent('test1', { foo: 'bar' });
const testEvent2 = createTestEvent('test2', { foo: 'bazoo' });
const client = new EndpointTelemetrySink({ endpoint, ioHost });
const client = new EndpointTelemetrySink({ endpoint: 'https://example.com/telemetry', ioHost });

// WHEN
await client.emit(testEvent1);
await client.emit(testEvent2);
await client.flush();

// THEN
const expectedPayload = JSON.stringify([testEvent1, testEvent2]);
const expectedPayload = JSON.stringify({ events: [testEvent1, testEvent2]});
expect(https.request).toHaveBeenCalledTimes(1);
expect(https.request).toHaveBeenCalledWith({
hostname: 'example.com',
Expand All @@ -169,10 +165,9 @@ describe('EndpointTelemetrySink', () => {
test('successful flush clears events cache', async () => {
// GIVEN
setupMockRequest();
const endpoint = parse('https://example.com/telemetry');
const testEvent1 = createTestEvent('test1', { foo: 'bar' });
const testEvent2 = createTestEvent('test2', { foo: 'bazoo' });
const client = new EndpointTelemetrySink({ endpoint, ioHost });
const client = new EndpointTelemetrySink({ endpoint: 'https://example.com/telemetry', ioHost });

// WHEN
await client.emit(testEvent1);
Expand All @@ -181,7 +176,7 @@ describe('EndpointTelemetrySink', () => {
await client.flush();

// THEN
const expectedPayload1 = JSON.stringify([testEvent1]);
const expectedPayload1 = JSON.stringify({ events: [testEvent1]});
expect(https.request).toHaveBeenCalledTimes(2);
expect(https.request).toHaveBeenCalledWith({
hostname: 'example.com',
Expand All @@ -196,7 +191,7 @@ describe('EndpointTelemetrySink', () => {
timeout: 500,
}, expect.anything());

const expectedPayload2 = JSON.stringify([testEvent2]);
const expectedPayload2 = JSON.stringify({ events: [testEvent2]});
expect(https.request).toHaveBeenCalledWith({
hostname: 'example.com',
port: null,
Expand Down Expand Up @@ -238,10 +233,9 @@ describe('EndpointTelemetrySink', () => {
return mockRequest;
});

const endpoint = parse('https://example.com/telemetry');
const testEvent1 = createTestEvent('test1', { foo: 'bar' });
const testEvent2 = createTestEvent('test2', { foo: 'bazoo' });
const client = new EndpointTelemetrySink({ endpoint, ioHost });
const client = new EndpointTelemetrySink({ endpoint: 'https://example.com/telemetry', ioHost });

// WHEN
await client.emit(testEvent1);
Expand All @@ -255,7 +249,7 @@ describe('EndpointTelemetrySink', () => {
await client.flush();

// THEN
const expectedPayload1 = JSON.stringify([testEvent1]);
const expectedPayload1 = JSON.stringify({ events: [testEvent1]});
expect(https.request).toHaveBeenCalledTimes(2);
expect(https.request).toHaveBeenCalledWith({
hostname: 'example.com',
Expand All @@ -270,15 +264,15 @@ describe('EndpointTelemetrySink', () => {
timeout: 500,
}, expect.anything());

const expectedPayload2 = JSON.stringify([testEvent2]);
const expectedPayload2 = JSON.stringify({ events: [testEvent1, testEvent2]});
expect(https.request).toHaveBeenCalledWith({
hostname: 'example.com',
port: null,
path: '/telemetry',
method: 'POST',
headers: {
'content-type': 'application/json',
'content-length': expectedPayload1.length + expectedPayload2.length - 1,
'content-length': expectedPayload2.length,
},
agent: undefined,
timeout: 500,
Expand All @@ -289,13 +283,12 @@ describe('EndpointTelemetrySink', () => {
// GIVEN
jest.useFakeTimers();
setupMockRequest(); // Setup the mock request but we don't need the return value
const endpoint = parse('https://example.com/telemetry');

// Create a spy on setInterval
const setIntervalSpy = jest.spyOn(global, 'setInterval');

// Create the client
const client = new EndpointTelemetrySink({ endpoint, ioHost });
const client = new EndpointTelemetrySink({ endpoint: 'https://example.com/telemetry', ioHost });

// Create a spy on the flush method
const flushSpy = jest.spyOn(client, 'flush');
Expand Down Expand Up @@ -337,8 +330,7 @@ describe('EndpointTelemetrySink', () => {
// Mock IoHelper.fromActionAwareIoHost to return our mock
jest.spyOn(IoHelper, 'fromActionAwareIoHost').mockReturnValue(mockIoHelper as any);

const endpoint = parse('https://example.com/telemetry');
const client = new EndpointTelemetrySink({ endpoint, ioHost });
const client = new EndpointTelemetrySink({ endpoint: 'https://example.com/telemetry', ioHost });

// Mock https.request to throw an error
(https.request as jest.Mock).mockImplementation(() => {
Expand Down
Loading