RedefineduseAgentLogs to support dependency injection for how the websocket connection is created
Redefined the test suite foruseAgentLogs to work as a set of unit tests
Moved our mock websocket logic into a general test helper file
Updated the test helper for generating logs so that each log is guaranteed to have a different timestamp

Notes

This PR doesn't add any additional test cases, but with the new logic in place, it should be easy to add a lot more
- If I had more time today, I would've added a test to assert that logs are sorted by timestamp before returning, since websocket messages aren't guaranteed to be in order

Parkreiner added2 commits

May 23, 2025 20:03

wip: commit progress on test update

d6e00c3

refactor: update useAgentLogs tests as unit tests

43d0ca8

Parkreiner requested a review fromBrunoQuaresma

May 23, 2025 20:28

Parkreiner self-assigned this

May 23, 2025

Parkreiner added2 commits

May 23, 2025 20:30

docs: rewrite comment for clarity

727bddd

fix: remove unnecessary type

d46d144

Parkreiner commented

May 23, 2025

View reviewed changes

site/src/testHelpers/websockets.ts

		@@ -0,0 +1,135 @@
		import type { WebSocketEventType } from "utils/OneWayWebSocket";

		export type MockWebSocketPublisher = Readonly<{

Copy link

MemberAuthor

ParkreinerMay 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

The entire contents of the file were basically copy-pasted from the other test file. The only change was that the publisher type is now exported and was renamed to be a little more clear

Parkreiner added3 commits

May 23, 2025 21:04

fix: make sure logs have different timestamps

91a6fc1

fix: add different dates to reduce risk of false positives

ecbe7b0

Merge branch 'main' into mes/logs-flake

d13bcdc

Parkreiner commented

May 23, 2025

View reviewed changes

site/src/modules/resources/useAgentLogs.test.ts

Comment on lines +18 to +22

		// Make sure that the logs generated each have unique timestamps, so
		// that we can test whether they're being sorted properly before being
		// returned by the hook
		const logDate = new Date(baseDate.getTime() + i * millisecondsInOneMinute);
		return {

Copy link

MemberAuthor

ParkreinerMay 23, 2025•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Like I said in the PR body, I didn't add a test to assert the sorting functionality yet, but I updated the test helper anyway, so that I can make sure the old/new sets of logs created in the test case are guaranteed to be different, and there's no risk of false positives