From 703681efc93fbaaa5037e8b1154f4317599f2985 Mon Sep 17 00:00:00 2001 From: "fastedge-plugin-sync[bot]" Date: Tue, 25 Aug 2026 06:09:05 +0000 Subject: [PATCH] auto: update reference docs from fastedge-test (main) --- .../skills/test/reference/dotenv.md | 4 +- .../skills/test/reference/runner-internals.md | 4 +- .../skills/test/reference/server-api.md | 4 +- .../skills/test/reference/test-config.md | 4 +- .../skills/test/reference/test-framework.md | 8 +-- .../skills/test/reference/vscode-debugger.md | 54 ++++++++----------- 6 files changed, 33 insertions(+), 45 deletions(-) diff --git a/plugins/gcore-fastedge/skills/test/reference/dotenv.md b/plugins/gcore-fastedge/skills/test/reference/dotenv.md index fd92d88..703e31f 100644 --- a/plugins/gcore-fastedge/skills/test/reference/dotenv.md +++ b/plugins/gcore-fastedge/skills/test/reference/dotenv.md @@ -3,8 +3,8 @@ sources: - id: fastedge-test ref: main - commit: c79583ecbec74b0d36ae664cd3a148ae34059a75 - updated: 2026-08-20 + commit: 9c4ab58dddbffed3e446ab10e9249f07edc6165f + updated: 2026-08-25 --> # Dotenv — Runtime Secrets and Environment Variables diff --git a/plugins/gcore-fastedge/skills/test/reference/runner-internals.md b/plugins/gcore-fastedge/skills/test/reference/runner-internals.md index 3d00bc1..4c708cc 100644 --- a/plugins/gcore-fastedge/skills/test/reference/runner-internals.md +++ b/plugins/gcore-fastedge/skills/test/reference/runner-internals.md @@ -3,8 +3,8 @@ sources: - id: fastedge-test ref: main - commit: c79583ecbec74b0d36ae664cd3a148ae34059a75 - updated: 2026-08-20 + commit: 9c4ab58dddbffed3e446ab10e9249f07edc6165f + updated: 2026-08-25 --> # Runner Internals — Low-Level Runner API diff --git a/plugins/gcore-fastedge/skills/test/reference/server-api.md b/plugins/gcore-fastedge/skills/test/reference/server-api.md index d0a417c..6dcdd4b 100644 --- a/plugins/gcore-fastedge/skills/test/reference/server-api.md +++ b/plugins/gcore-fastedge/skills/test/reference/server-api.md @@ -3,8 +3,8 @@ sources: - id: fastedge-test ref: main - commit: c79583ecbec74b0d36ae664cd3a148ae34059a75 - updated: 2026-08-20 + commit: 9c4ab58dddbffed3e446ab10e9249f07edc6165f + updated: 2026-08-25 --> # Server API — REST and WebSocket Endpoints diff --git a/plugins/gcore-fastedge/skills/test/reference/test-config.md b/plugins/gcore-fastedge/skills/test/reference/test-config.md index 2a2acaa..f6c0ffd 100644 --- a/plugins/gcore-fastedge/skills/test/reference/test-config.md +++ b/plugins/gcore-fastedge/skills/test/reference/test-config.md @@ -3,8 +3,8 @@ sources: - id: fastedge-test ref: main - commit: c79583ecbec74b0d36ae664cd3a148ae34059a75 - updated: 2026-08-20 + commit: 9c4ab58dddbffed3e446ab10e9249f07edc6165f + updated: 2026-08-25 --> # test-config Reference diff --git a/plugins/gcore-fastedge/skills/test/reference/test-framework.md b/plugins/gcore-fastedge/skills/test/reference/test-framework.md index 90fc433..4b0a2ee 100644 --- a/plugins/gcore-fastedge/skills/test/reference/test-framework.md +++ b/plugins/gcore-fastedge/skills/test/reference/test-framework.md @@ -3,8 +3,8 @@ sources: - id: fastedge-test ref: main - commit: c79583ecbec74b0d36ae664cd3a148ae34059a75 - updated: 2026-08-20 + commit: 9c4ab58dddbffed3e446ab10e9249f07edc6165f + updated: 2026-08-25 --> # FastEdge Test Framework API @@ -71,8 +71,8 @@ defineTestSuite({ wasmBuffer: Buffer; // pre-loaded WASM binary — mutually exclusive with wasmPath runnerConfig?: { dotenv?: { - enabled?: boolean; // load .env into WASM before each test — see the DOTENV reference - path?: string; // directory to load dotenv files from; defaults to process CWD + enabled?: boolean; // load .env into WASM before each test — see the DOTENV reference + path?: string; // directory to load dotenv files from; defaults to process CWD }; enforceProductionPropertyRules?: boolean; // default true runnerType?: "http-wasm" | "proxy-wasm"; // override automatic WASM type detection diff --git a/plugins/gcore-fastedge/skills/test/reference/vscode-debugger.md b/plugins/gcore-fastedge/skills/test/reference/vscode-debugger.md index 812e117..3d97053 100644 --- a/plugins/gcore-fastedge/skills/test/reference/vscode-debugger.md +++ b/plugins/gcore-fastedge/skills/test/reference/vscode-debugger.md @@ -3,8 +3,8 @@ sources: - id: fastedge-test ref: main - commit: c79583ecbec74b0d36ae664cd3a148ae34059a75 - updated: 2026-08-20 + commit: 9c4ab58dddbffed3e446ab10e9249f07edc6165f + updated: 2026-08-25 --> # FastEdge Visual Debugger @@ -75,24 +75,6 @@ npx fastedge-debug --project-dir .. ../fixtures/scenario-1.test.json When omitted, behavior is unchanged — the positional argument or `process.cwd()` is used as the starting point. -Programmatic usage: -```typescript -import { startServer } from "@gcoredev/fastedge-test/server"; - -// Start on the default port (5179) -await startServer(); - -// Start on a custom port -await startServer(3000); -``` - -**Signature:** -```typescript -function startServer(port?: number): Promise; -``` - -The returned promise resolves once the server is bound and ready to accept connections. - --- ## Dual-Mode Behaviour @@ -120,24 +102,30 @@ See the dotenv reference for the full setup — prefix scheme, file options, pri ## What the UI Shows -| Panel | Content | -|---|---| -| Request | Method, URL, headers, body sent to the WASM | -| Response | Status, headers, body returned by the WASM | -| Logs | Streamed log output, filterable by level (trace/debug/info/warn/error/critical) | -| Hook results | **CDN only** — phase callbacks (`onRequestHeaders`, `onRequestBody`, `onResponseHeaders`, `onResponseBody`) | -| Property accesses | **CDN only** — which CDN properties the filter read | - -Log verbosity is controlled by `logLevel` in `fastedge-config.test.json`: -`0` = trace (everything), `1` = debug, `2` = info, `3` = warn, `4` = error. +The UI provides a graphical interface for loading WASM modules, configuring requests, and inspecting results. All UI interactions use the same REST and WebSocket endpoints available to API consumers. --- -## test-config Integration +## Programmatic Usage -The debugger auto-loads `fastedge-config.test.json` from the project root on startup — WASM path, request, headers, and CDN properties are pre-filled each session. +Import `startServer` from the `./server` export to start the server from your own script or test setup: -Use `/gcore-fastedge:test` to create or update this file. Full schema: see the test-config reference. +```typescript +import { startServer } from "@gcoredev/fastedge-test/server"; + +// Start on the default port (5179) +await startServer(); + +// Start on a custom port +await startServer(3000); +``` + +**Signature:** +```typescript +function startServer(port?: number): Promise; +``` + +The returned promise resolves once the server is bound and ready to accept connections. ---