Agent: clean-up assertion of telemetry events within integration tests #5455
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
akalia25
changed the title
olafurpg
requested changes
Sep 16, 2024
| @@ -30,6 +30,28 @@ const workspace = new TestWorkspace(path.join(__dirname, '__tests__', 'example-t | |||
| const mayRecord = | |||
| process.env.CODY_RECORDING_MODE === 'record' || process.env.CODY_RECORD_IF_MISSING === 'true' | |||
|
|
|||
| async function returnTelemetryEvents(currentClient: TestClient) { | |||
There was a problem hiding this comment.
The returnTelemetryEvents name is a bit unusual, also the return type is missing
Suggested change
| async function returnTelemetryEvents(currentClient: TestClient) { | |
| async function exportedTelemetryEvents(currentClient: TestClient): string[] { |
| // telemetry assertion, to validate the expected events fired during the test run | ||
| // Do not remove this assertion, and instead update the expectedEvents list above | ||
| expect(await returnTelemetryEvents(client)).toEqual( | ||
| expect.arrayContaining(client.expectedEvents) |
There was a problem hiding this comment.
We should remove the mutable TestClient.expectedEvents property and inline the values into the assertions instead. This is the only blocking comment for the PR
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously, the assertion of telemetry events for agent integration tests was happening within an
afterEach, and this was not the cleanest approach, as the error messages would not point to the relevant code causing the error. In addition, this PR also addsparametersas a property that gets sent with the testing telemetry events.Now, we manually add the assertion at the end of test cases where we want to assert what events got exported. As @olafurpg mentioned, the benefits of this approach are:
Addresses feedback here
Test plan
CI, specifically
pnpm run test src/index.test.tsChangelog