test(playground): smoke-test the playground's own server plugins - #542
Draft
IamGalymzhan wants to merge 4 commits into
Draft
test(playground): smoke-test the playground's own server plugins#542IamGalymzhan wants to merge 4 commits into
IamGalymzhan wants to merge 4 commits into
Conversation
The playground's server plugins had no tests at all. `tests/` holds Playwright specs that intercept `/api` at the browser boundary (`page.route` + `fulfill`), so the Express server never runs in them — route handlers, `execute()` interceptors, and `executeStream` are all unexercised. These five tests cover that side using the harness from #540: real HTTP, faked data plane, no workspace, no credentials, no network. Adds a `dev-playground` vitest project so `pnpm test` (and CI's Unit Tests job) picks them up: 4517 -> 4522. The `tests/**` exclusion is load-bearing — without it vitest's default `**/*.spec.ts` glob collects the Playwright specs and they fail on import with "Playwright Test did not expect test.describe() to be called here". Two things worth knowing, both found by writing this: - `telemetry-example-plugin` really calls `fetch("https://example.com")` in its external-api span, so a naive test needs the internet. The suite stubs non-loopback fetches and passes loopback through, since that is how the harness reaches its own server. Verified hermetic under a socket guard that throws on any non-loopback connect. - `expectStream` buffers a source to completion and throws on timeout rather than returning partial events, so it cannot assert on a long-lived stream. The reconnect stream is five messages three seconds apart, so the SSE test reads one payload and hangs up instead of costing ~12s. Scoped to smoke coverage deliberately. Not included: reconnection replay (`executeStream`'s ring buffer and `Last-Event-ID` handling is the real prize and deserves its own tests), and a `typecheck` script for the app — the existing tsconfig reports 2128 errors from the client's unset `--jsx`, and a server-scoped one still has 13 pre-existing errors that CI has never seen because `pnpm -r typecheck` skips this workspace. Signed-off-by: Galymzhan <zhangazy2004@gmail.com>
This file contains hidden or 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
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.
Summary
Third in the stack — base is
feat/testing-kit-harness(#540), which is itself based on #530. Review those first; GitHub shows only this PR's 2 files here, and retargets automatically as the parents merge.The playground's server plugins had no tests at all.
apps/dev-playground/tests/holds Playwright specs that intercept/apiat the browser boundary (page.route+route.fulfill), so the Express server never runs in them — route handlers,execute()interceptors, andexecuteStreamare entirely unexercised. These five tests cover that side with the harness from #540: real HTTP, faked data plane, no workspace, no credentials, no network.It also serves as dogfooding that a customer would recognise — the reference app testing its own plugins the way the docs tell them to test theirs.
What's covered
GET /api/reconnecttext/event-streamand emits its first messagePOST /api/telemetry-examples/combinedTelemetryProviderand threadsuserIdthroughlakebase-examplesunconfiguredPGHOST/LAKEBASE_ENDPOINT, and the app still bootsAdds a
dev-playgroundvitest project sopnpm testand CI's Unit Tests job pick them up: 4517 → 4522.Two things writing this turned up
telemetry-example-pluginreally callsfetch("https://example.com")in its external-api span, so a naive test of it needs the internet. The suite stubs non-loopback fetches and passes loopback through — loopback has to work, since that's how the harness reaches its own server. Verified hermetic by running the suite under a socket guard that throws on any non-loopbackconnect.expectStreamcan't assert on a long-lived stream. It buffers a source to completion and throws on timeout rather than returning partial events. The reconnect stream is five messages three seconds apart, so the SSE test reads one payload offres.bodyand hangs up instead of costing ~12s.Notes for the reviewer
tests/**exclusion in the new vitest project is load-bearing. Vitest's default**/*.spec.tsglob otherwise collects the Playwright specs, which fail on import withPlaywright Test did not expect test.describe() to be called here. Verified by removing it.executeStream's ring buffer andLast-Event-IDhandling — and deserves its own tests rather than being smuggled into a smoke suite.typecheckscript for this app, so the new file is transpile-only. Adding one is out of scope: the existing tsconfig reports 2128 errors from the client's unset--jsx, and a server-scoped one still has 13 pre-existing errors CI has never seen, becausepnpm -r typecheckskips this workspace. The most interesting of those 13 is a duplicate-identity clash betweenappkit/dist/shared/src/workspace-client/typesandshared/dist/workspace-client/types—sharedis bundled inline into appkit, so the twoWorkspaceClienttypes diverge onConfig. Worth its own issue.Verification
4522 tests pass; typecheck, lint, and format clean. The five new tests pass with zero non-loopback connection attempts under a socket guard.
This pull request and its description were written by Isaac.