Testing

Run the tests, change the messages, and find out what the worker is doing.

Run the tests

npm run check

It does five things:

Generates src/proto from the protocol submodule.
Checks that each env in wrangler.jsonc repeats the top-level settings.
Checks that worker-configuration.d.ts matches wrangler.jsonc and .dev.vars.example.
Typechecks.
Runs the tests in workerd, the runtime of Cloudflare Workers. The SFU and TURN APIs are mocked.

To run one file:

npx vitest run tests/workerd/room.test.ts

File	What it tests
`token.test.ts`	The token API and opening the socket
`flow.test.ts`	Device sockets, wake, publish, subscribe and sleep
`presence.test.ts`	Pings, offline devices and reconnects
`room.test.ts`	Rooms, members and limits
`data.test.ts`	Data channels and control
`voice.test.ts`	Microphones and the devices' voices
`admin.test.ts`	The dashboard, with a key and with Access
`debug.test.ts`	The debug pages
`pages.test.ts`	The static pages

The messages live in mazupo/protocol. This repo has it as a submodule in external/protocol.

Change the .proto files in external/protocol, on a branch.
Run npm run proto. It warns that the submodule is not at the recorded commit. That is expected while you work.
Merge the protocol change to its main.
Point the submodule of this repo, pi-webrtc and client-sdk-js at the same commit.
In this repo, set protocol.commit in package.json to that commit too. A copy made by the Deploy to Cloudflare button has no submodule, so its build downloads the protos at this commit. npm run check fails when the two differ.

CI checks that this repo pins the same protocol commit as pi-webrtc main. So merge the pi-webrtc change first.

After you change vars, bindings or .dev.vars.example, run:

npm run cf-typegen

Optional secrets that are not in .dev.vars.example go in src/env.d.ts.

Server state on the demo pages shows what the Durable Objects hold. See Debug pages.
npm run dev prints one JSON line for each event, such as device_gone.
To keep a separate local state, run npx wrangler dev --persist-to <folder>.