jeirmeister/Cockatrice
1
0
Fork 0
mirror of https://github.com/Cockatrice/Cockatrice.git synced 2026-06-10 08:14:47 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

cleanup testing utilities, documentation, and AI commentary

Browse source
This commit is contained in:
seavor 2026-04-18 15:32:50 -05:00
parent bd2382c94e
commit ef6cea6f6c
150 changed files with 891 additions and 1233 deletions
Download patch file Download diff file Expand all files Collapse all files

32
webclient/src/__test-utils__/globalGuards.ts
View file

@ -1,15 +1,9 @@
// Shared lifecycle helpers for test files that need to mutate global state.
//
// The root `setupTests.ts` guards catch leaks even when callers forget to
// clean up, but opt-in helpers make intent explicit at the call site and
// avoid piling cleanup logic onto the shared safety net.
/**
* Temporarily override fields on `window.location` and return a restore fn.
*
* `Object.defineProperty(window, 'location', ...)` is not a `vi.spyOn` target,
* so `vi.restoreAllMocks()` will NOT undo it. Always pair with the returned
* `restore` callback (ideally in `afterEach`).
* @critical `Object.defineProperty(window, 'location', ...)` isn't a vi.spyOn
* target, so `vi.restoreAllMocks()` will NOT undo it. Always invoke the
* returned restore callback.
*/
export function withMockLocation(overrides: Partial<Location>): () => void {
const originalDescriptor = Object.getOwnPropertyDescriptor(window, 'location');
@ -26,23 +20,3 @@ export function withMockLocation(overrides: Partial<Location>): () => void {
}
};
}
/**
* Push an entry onto a shared event-handler registry array and return a
* teardown function that removes exactly that entry.
*
* Used by ProtobufService specs which install temporary handlers into the
* (mocked) `GameEvents` / `RoomEvents` / `SessionEvents` arrays. Manual
* `.push()`/`.pop()` inside a test body corrupts the array if an assertion
* throws between them — this helper makes the teardown safe to run in
* `afterEach`.
*/
export function withEventRegistry<T>(registry: T[], entry: T): () => void {
registry.push(entry);
return () => {
const index = registry.lastIndexOf(entry);
if (index !== -1) {
registry.splice(index, 1);
}
};
}