Local Testing with Vitest
Use the existing unit and integration tests as the fastest confidence check for config and routing changes. The gateway repo uses Vitest for unit tests and
Last updated
Use the existing unit and integration tests as the fastest confidence check for config and routing changes. The gateway repo uses Vitest for unit tests and
Use the existing unit and integration tests as the fastest confidence check for config and routing changes. The gateway repo uses Vitest for unit tests and optional coverage reporting. This page explains how to run the test suite, interpret results, and add tests for new route configurations.
Last reviewed: 2026-03-06
Use the deployment and troubleshooting guides when you are deploying the gateway to Cloudflare, setting up CI/CD, running tests, or diagnosing production issues. These guides cover the operational side of the gateway lifecycle from local development to production debugging.
The gateway deploys as a standard Cloudflare Worker using wrangler deploy. The wrangler.toml file defines the worker name, entrypoint, compatibility settings, and binding declarations.
GitHub Actions can automate deployments, running config validation, tests, and docs checks before publishing the worker. The workflow uses the same wrangler deploy command.
The gateway repo includes Vitest unit tests and optional E2E tests using unstable_dev. Run unit tests with npm test and E2E tests with the RUN_LOCAL_WORKER_E2E=true flag.
When debugging upstream failures, isolate whether the issue is in routing (wrong path matched), auth (token rejected), or the upstream itself (backend error). Check wrangler tail logs for the gateway's perspective.
npm test
npm run test:coverage
RUN_LOCAL_WORKER_E2E=true npm run test:e2eThis snippet shows three test commands: npm test runs the Vitest unit suite, npm run test:coverage adds coverage reporting, and the E2E command runs worker-level tests. Start with npm test after any config change to catch schema or routing errors.
If wrangler deploy fails with "missing binding", check your wrangler.toml for typos in binding names and verify that all referenced KV namespaces, service bindings, and secrets exist in your Cloudflare account.
If GitHub Actions deploys succeed but the worker returns 500, check whether environment variables and secrets are set in the Cloudflare dashboard -- they are not deployed by Wrangler and must be configured separately.
If E2E tests fail with "unstable_dev not found", make sure you are running a Wrangler version that supports unstable_dev and that RUN_LOCAL_WORKER_E2E=true is set in your environment.
If routes work locally but not in production, compare the config source: local dev uses the file system, while production may use KV or SAG_API_CONFIG_JSON. Confirm the production config matches your local config.
Last updated