@piwitests/instrumentation

@piwitests/instrumentation

Nitro / Nuxt server plugin for Piwi Dashboard — captures Warning and Error log entries per HTTP request and delivers them to the Piwi Dashboard reporter via the X-Piwi-Logs response header.

During a Playwright test run, the reporter reads this header from every response and stores the entries alongside the network request. The entries are then available in the Piwi Dashboard test-case view and are included in the AI diagnosis context.

Active outside production by default. Capture is controlled by the PIWI_TEST_LOGS_DISABLED environment variable:

• unset — capture is on, except when NODE_ENV === 'production'
• PIWI_TEST_LOGS_DISABLED=true — capture is off everywhere
• PIWI_TEST_LOGS_DISABLED=false — capture is on even in production builds (useful for a production-mode test deployment)

Installation

npm install @piwitests/instrumentation

Usage

Create a file in your project's server plugins directory:

// Nuxt: server/plugins/piwi-test-logs.ts
// Standalone Nitro: plugins/piwi-test-logs.ts
export { default } from '@piwitests/instrumentation'

That's all. Nitro auto-loads every file in that directory on startup (server/plugins/ in a Nuxt app, plugins/ under the Nitro srcDir in a standalone Nitro app).

A runnable end-to-end demo lives in examples/playwright-fixtures — a standalone Nitro app instrumented with this package, with a Playwright spec showing the captured logs in the dashboard.

What gets captured

Only calls made through consola are captured — bare console.warn() / console.error() output is not. Nuxt server code typically logs via consola already; in a standalone Nitro app, import { consola } from 'consola' in your handlers.

Each captured entry contains:

Up to 50 entries per request are included. The header is always emitted (with an empty array when no entries were captured) so the Piwi reporter can confirm the plugin is active.

How it works

Playwright test
  └─ page.goto('/api/orders')
       └─ Nitro route handler runs
            ├─ consola.warn('Stock low')     ← captured via consola reporter
            └─ HTTP response
                 └─ X-Piwi-Logs: <gzip+base64 JSON>
                      └─ Piwi reporter reads header
                           └─ stored as serverLogs on the network request
                                └─ visible in test-case detail + AI diagnosis

The plugin wraps Nitro's root H3 handler and uses three mechanisms:

1. event.context._piwiLogs — a plain per-request array attached to the H3 event as the wrapped handler starts; everything captured for the request accumulates here.
2. AsyncLocalStorage.run() — scopes that buffer around the entire downstream chain (hooks, middleware, route handlers), so the process-global consola reporter always appends to the correct request's buffer.
3. A patched res.end — the header is written just before the response goes out, which covers every response, including H3 error responses that bypass Nitro's beforeResponse hook. Right before writing, unhandled errors are drained from event.context.nitro.errors, so thrown errors appear even when nothing logged via consola.

Peer dependencies

These are already installed in any Nuxt project — no extra installs needed.

Building from source

cd integrations/nitro
npm run build   # emits dist/index.js + dist/index.d.ts

License

MIT