mirror of
https://github.com/hanzoai/o11y.git
synced 2026-10-30 14:56:15 +00:00
zeekayandHanzo Dev
f337a4b21e
MAIN HAD NOT COMPILED SINCE 2026-07-30. Commit 5e3210f759 rewrote tables.go in three telemetry packages and the sentrytypes Event struct without updating their consumers, while its message claimed the read paths 'build clean' — proven false with a detached worktree at clean HEAD. That is why the deployed backend is SHA-pinned and stale: CI could not build main at all. THE RENAME: /api/v1|v2|v3|v4/<rest> -> /v1/o11y/<rest> (290 replacements; the host already says api, so the path never does, and one live generation carries no version segments). 21 duplicate v1 registrations DELETED with their v2 twins kept — gorilla/mux is first-match, so after the collapse the v1 line would have shadowed v2 silently, with no error, forever: rules (6), dashboards (6), services/top_operations/entry_point_operations/ttl (5), features, query_range v3+v4 -> v5, metrics/dashboards. 16 orphaned handler funcs (430 lines) deleted. CONSUMERS MIGRATED to the one-way table names, never the reverse: tables.go's deletion of the versioned constants was deliberate (stated three times), and the new blocks are positional 1:1 rewrites of the old, so every resolution is a constant the same commit declared — SpanIndexV3->span, LogsV2->log, SamplesV4->metric, TimeseriesV4->series, UpdatedMetadata->descriptor, ambiguity on operation-vs-trace settled by tables.go's own inline comments. sentrytypes.Frame/Event.Frames/Event.Handled RECONSTRUCTED, not guessed: pinned independently by eventsql.go's projection, eventstore.go's scan targets and module.go's clampLine/InApp, and asserted literally by the pre-existing TestFramesRoundTrip. TraceSummary.Sample -> Message (event.error has no sample column). Event.Sample deleted: a field that always read "" while claiming to hold the occurrence JSON. PATH MANGLERS KILLED, both deployment shapes: mount.go rewriteExternalPath+ setPath deleted (it mapped /v1/o11y/services -> /api/services => 404 on the cloud-binary path — proven with a real test before deletion); server.go StripPrefix removed (it reduced /v1/o11y/services -> /services => the web catch-all answered index.html on the standalone path). versionless.go + versionless_test.go + both call sites deleted: its regex matched 0 of the registered routes and walked the router at every startup to register nothing — the second spelling of one path, gone with the mechanism that needed it. FRONTEND: prependBase '/api/v1/' -> '/v1/o11y/' (both baseURL branches), 17 /api/v1/assistant literals renamed (note: no assistant route exists in pkg/ — client-only surface, a real product gap, not papered over), 21 MSW mocks moved so they intercept the paths the app now requests. GATE, all executed: go build ./... green; go test ./... green (exit 0); 0 /api/v[0-9] references in pkg code (frontend's 5 are query-builder escaping fixtures); 0 duplicate (method,path) registrations; /v1/o11y/services survives both mount.go and server.go untouched. Co-authored-by: Hanzo Dev <[email protected]>
79 lines
2.1 KiB
Plaintext
79 lines
2.1 KiB
Plaintext
---
|
|
description: Core testing conventions - imports, rendering, MSW, interactions, queries
|
|
globs: **/*.test.{ts,tsx}
|
|
alwaysApply: false
|
|
---
|
|
|
|
# Testing Conventions
|
|
|
|
## Imports
|
|
|
|
Always import from the test harness, never directly from `@testing-library/react`:
|
|
|
|
```ts
|
|
import { render, screen, userEvent, waitFor } from 'tests/test-utils';
|
|
import { server, rest } from 'mocks-server/server';
|
|
```
|
|
|
|
## Router
|
|
|
|
Use the built-in router in `render`:
|
|
|
|
```ts
|
|
render(<Page />, undefined, { initialRoute: '/traces-explorer' });
|
|
```
|
|
|
|
Only mock `useLocation` / `useParams` if the test depends on their values.
|
|
|
|
## MSW
|
|
|
|
Global MSW server runs automatically. Override per-test:
|
|
|
|
```ts
|
|
server.use(
|
|
rest.get('*/v1/o11y/foo', (_req, res, ctx) =>
|
|
res(ctx.status(200), ctx.json({ ok: true })))
|
|
);
|
|
```
|
|
|
|
Every route lives under `/v1/o11y/` — one prefix, no version segment below it,
|
|
no `/api/` segment (the host already says `api`). A mock spelled any other way
|
|
silently stops intercepting and the test passes for the wrong reason.
|
|
|
|
Keep large response fixtures in `mocks-server/__mockdata_`.
|
|
|
|
## Interactions
|
|
|
|
- Prefer `userEvent` for real user interactions (click, type, select, tab).
|
|
- Use `fireEvent` only for low-level events not covered by `userEvent` (e.g., scroll, resize). Wrap in `act(...)` if needed.
|
|
- Always `await` interactions:
|
|
|
|
```ts
|
|
const user = userEvent.setup({ pointerEventsCheck: 0 });
|
|
await user.click(screen.getByRole('button', { name: /save/i }));
|
|
```
|
|
|
|
## Timers
|
|
|
|
No global fake timers. Per-test only, for debounce/throttle:
|
|
|
|
```ts
|
|
jest.useFakeTimers();
|
|
const user = userEvent.setup({ advanceTimers: (ms) => jest.advanceTimersByTime(ms) });
|
|
await user.type(screen.getByRole('textbox'), 'query');
|
|
jest.advanceTimersByTime(400);
|
|
jest.useRealTimers();
|
|
```
|
|
|
|
## Queries
|
|
|
|
Prefer accessible queries: `getByRole` > `findByRole` > `getByLabelText` > visible text > `data-testid` (last resort).
|
|
|
|
## Anti-patterns
|
|
|
|
- Never import from `@testing-library/react` directly
|
|
- Never use global fake timers
|
|
- Never wrap `render` in `act(...)`
|
|
- Never mock infra dependencies locally (router, react-query)
|
|
- Limit to 3-5 focused tests per file
|