@test-lab-ai/cli 0.2.13 → 0.2.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/bin/testlab.mjs CHANGED
@@ -49,6 +49,8 @@ Usage:
49
49
  testlab data create -f fixture.json Create a data fixture ({{data.<fixture>.<field>}})
50
50
  testlab scripts upload <file> --plan <id> Upload a local Playwright script for a plan
51
51
  (skips paid AI generation; --device optional)
52
+ testlab scripts get <id> [--out <file>] Download a plan's active script to fix + re-upload
53
+ (prints to stdout, or writes --out <file>; --device optional)
52
54
  testlab examples Print the full JSON reference for every
53
55
  resource (designed for AI agents)
54
56
  testlab skills install [--agent ...] Install the test-lab skills (test-lab-plan +
@@ -84,6 +86,7 @@ function parse() {
84
86
  project: { type: "string" },
85
87
  plan: { type: "string" },
86
88
  device: { type: "string" },
89
+ out: { type: "string", short: "o" },
87
90
  version: { type: "boolean", short: "v" },
88
91
  help: { type: "boolean", short: "h" },
89
92
  },
@@ -370,10 +373,19 @@ async function cmdDataCreate(flags) {
370
373
  // paid AI generation. The server validates it (allow-list + intent review),
371
374
  // wraps it in the trusted harness, and stores it as the plan's saved script.
372
375
  // On rejection the per-line issues are printed so an agent can self-correct.
376
+ // Strict positive-integer plan id from a CLI arg/flag. parseInt is too lenient
377
+ // ("12abc" -> 12, "12.9" -> 12), which would silently fetch/replace the WRONG
378
+ // plan; require all-digits and > 0 so a typo errors instead.
379
+ function parsePlanIdArg(raw) {
380
+ if (typeof raw !== "string" || !/^\d+$/.test(raw.trim())) return NaN
381
+ const n = parseInt(raw.trim(), 10)
382
+ return n > 0 ? n : NaN
383
+ }
384
+
373
385
  async function cmdScriptsUpload(flags, args) {
374
386
  const file = args[2]
375
387
  if (!file) errExit("usage: testlab scripts upload <file.spec.ts> --plan <planId> [--device <device>]")
376
- const planId = flags.plan ? parseInt(flags.plan, 10) : NaN
388
+ const planId = parsePlanIdArg(flags.plan)
377
389
  if (!Number.isInteger(planId)) errExit("--plan <planId> is required (the numeric test-plan id; see `testlab plans list`)")
378
390
  const { apiKey, apiUrl } = requireAuth(flags)
379
391
 
@@ -388,7 +400,9 @@ async function cmdScriptsUpload(flags, args) {
388
400
  // plan's first configured device. Hardcoding "Desktop Chrome" here would 400
389
401
  // on any plan whose device isn't Desktop Chrome (the server validates it).
390
402
  const device = flags.device
391
- const r = await apiFetch(apiUrl, apiKey, "POST", "/api/v1/scripts/upload", { script, planId, device })
403
+ // Idempotent on the server (saved_scripts upsert ON CONFLICT), so a transient
404
+ // 5xx is safe to retry — a successful retry overwrites, it never duplicates.
405
+ const r = await apiFetch(apiUrl, apiKey, "POST", "/api/v1/scripts/upload", { script, planId, device }, { retries: 3 })
392
406
 
393
407
  // 422 = the script was understood but rejected (allow-list or intent review).
394
408
  // Print the structured issues so a human or agent can fix and retry.
@@ -404,7 +418,20 @@ async function cmdScriptsUpload(flags, args) {
404
418
  log(`✗ Script rejected by security review: ${r.json.reason}`)
405
419
  process.exit(1)
406
420
  }
407
- if (!r.ok) errExit(`${r.status}: ${r.json?.error || "upload failed"}`)
421
+ if (!r.ok) {
422
+ // A 5xx (or network error) survived the retries — almost always a transient
423
+ // server blip, not a rejected script. Tell the user it's safe to re-run:
424
+ // the upload is idempotent, so a retry can't create a duplicate. (A genuinely
425
+ // bad script comes back as 422 and is handled above, never here.)
426
+ if (r.status === 0 || r.status >= 500) {
427
+ errExit(
428
+ `${r.status || "network"}: ${r.json?.error || "upload failed"}\n` +
429
+ ` This is usually a transient server error, not a rejected script. ` +
430
+ `Re-run the same command — the upload is idempotent, so it won't create a duplicate.`,
431
+ )
432
+ }
433
+ errExit(`${r.status}: ${r.json?.error || "upload failed"}`)
434
+ }
408
435
 
409
436
  const steps = r.json?.stepCount
410
437
  // Show the device the SERVER resolved (it defaults an omitted device to the
@@ -414,6 +441,44 @@ async function cmdScriptsUpload(flags, args) {
414
441
  log(` This plan now runs your script instead of AI generation.`)
415
442
  }
416
443
 
444
+ async function cmdScriptsGet(flags, args) {
445
+ const planId = parsePlanIdArg(args[2] ?? flags.plan)
446
+ if (!Number.isInteger(planId)) {
447
+ errExit("usage: testlab scripts get <planId> [--device <device>] [--out <file>]")
448
+ }
449
+ const { apiKey, apiUrl } = requireAuth(flags)
450
+
451
+ const qs = new URLSearchParams({ planId: String(planId) })
452
+ if (flags.device) qs.set("device", String(flags.device))
453
+ const r = await apiFetch(apiUrl, apiKey, "GET", `/api/v1/scripts?${qs.toString()}`)
454
+
455
+ // 404 carries a human message (no script / wrong device); surface it verbatim.
456
+ if (!r.ok) errExit(`${r.status}: ${r.json?.error || "failed to fetch script"}`)
457
+ const script = r.json?.script
458
+ if (typeof script !== "string") errExit("server returned no script")
459
+
460
+ const device = r.json?.device || flags.device || "the plan's default device"
461
+ const steps = r.json?.stepCount
462
+ const source = r.json?.source
463
+ const meta = `${steps != null ? `${steps} step${steps === 1 ? "" : "s"}, ` : ""}${device}${source ? `, ${source}` : ""}`
464
+ const withNl = script.endsWith("\n") ? script : script + "\n"
465
+
466
+ if (flags.out) {
467
+ try {
468
+ fs.writeFileSync(flags.out, withNl, "utf8")
469
+ } catch (e) {
470
+ errExit(`could not write ${flags.out}: ${e.message}`)
471
+ }
472
+ log(`✓ Saved plan #${planId} script → ${flags.out} (${meta})`)
473
+ log(` Edit it, then re-upload: testlab scripts upload ${flags.out} --plan ${planId}${flags.device ? ` --device "${flags.device}"` : ""}`)
474
+ } else {
475
+ // Status line to stderr so a plain `> file` redirect captures only the
476
+ // script (pipeable), while the human still sees what they fetched.
477
+ process.stderr.write(`# plan #${planId} script (${meta})\n`)
478
+ process.stdout.write(withNl)
479
+ }
480
+ }
481
+
417
482
  function cmdExamples() {
418
483
  log(EXAMPLES_TEXT)
419
484
  }
@@ -580,7 +645,8 @@ async function main() {
580
645
  return errExit("usage: testlab data <list|create>")
581
646
  case "scripts":
582
647
  if (args[1] === "upload") return cmdScriptsUpload(flags, args)
583
- return errExit("usage: testlab scripts upload <file.spec.ts> --plan <planId> [--device <device>]")
648
+ if (args[1] === "get") return cmdScriptsGet(flags, args)
649
+ return errExit("usage: testlab scripts <upload <file> --plan <id> | get <id> [--out <file>]>")
584
650
  case "examples":
585
651
  return cmdExamples()
586
652
  case "skills":
package/lib/api.mjs CHANGED
@@ -1,31 +1,72 @@
1
1
  /**
2
2
  * Tiny fetch wrapper for the test-lab public API. Uses global fetch (Node 18+).
3
3
  * Returns { ok, status, json } — json is the parsed body (or { raw } on non-JSON).
4
+ *
5
+ * Transient resilience: a 5xx or a network error is retried with linear backoff.
6
+ * Retries are SAFE only for idempotent calls, so they default ON for GET and OFF
7
+ * for writes — a write opts in explicitly via `opts.retries` (used by the
8
+ * idempotent script upload, which the server upserts ON CONFLICT). This is what
9
+ * stops a momentary empty-body 500 (a Worker hiccup or an edge rate-limit that
10
+ * short-circuits before the app's JSON error handler) from surfacing as a hard
11
+ * "500: upload failed" when a one-second retry would have gone through.
4
12
  */
5
- export async function apiFetch(apiUrl, apiKey, method, pathname, body) {
13
+ export async function apiFetch(apiUrl, apiKey, method, pathname, body, opts = {}) {
14
+ const retries = Number.isInteger(opts.retries) ? opts.retries : method === "GET" ? 2 : 0
15
+ const backoffMs = Number.isInteger(opts.backoffMs) ? opts.backoffMs : 800
16
+
6
17
  const headers = {}
7
18
  if (apiKey) headers["Authorization"] = `Bearer ${apiKey}`
8
19
  if (body !== undefined) headers["Content-Type"] = "application/json"
9
20
 
10
- let res
11
- try {
12
- res = await fetch(`${apiUrl}${pathname}`, {
13
- method,
14
- headers,
15
- body: body !== undefined ? JSON.stringify(body) : undefined,
16
- })
17
- } catch (e) {
18
- return { ok: false, status: 0, json: { error: `network error: ${e.message}` } }
19
- }
20
-
21
- const text = await res.text()
22
- let json = null
23
- if (text) {
21
+ for (let attempt = 0; ; attempt++) {
22
+ let res
24
23
  try {
25
- json = JSON.parse(text)
26
- } catch {
27
- json = { raw: text }
24
+ res = await fetch(`${apiUrl}${pathname}`, {
25
+ method,
26
+ headers,
27
+ body: body !== undefined ? JSON.stringify(body) : undefined,
28
+ })
29
+ } catch (e) {
30
+ if (attempt < retries) {
31
+ await sleep(backoffMs * (attempt + 1))
32
+ continue
33
+ }
34
+ return { ok: false, status: 0, json: { error: `network error: ${e.message}` } }
35
+ }
36
+
37
+ // 5xx = transient (Worker error / edge rate-limit). Retry while budget remains.
38
+ if (res.status >= 500 && attempt < retries) {
39
+ await sleep(backoffMs * (attempt + 1))
40
+ continue
41
+ }
42
+
43
+ const text = await res.text()
44
+ let json = null
45
+ if (text) {
46
+ try {
47
+ json = JSON.parse(text)
48
+ } catch {
49
+ json = { raw: text }
50
+ }
51
+ }
52
+
53
+ // A failed response with no usable error body (the empty-body 5xx case) would
54
+ // otherwise reach the caller as `json: null` and print a blank reason.
55
+ // Synthesize an actionable message keyed off the status instead.
56
+ if (!res.ok && (!json || (!json.error && !json.issues && !json.reason))) {
57
+ json = {
58
+ ...(json || {}),
59
+ error:
60
+ res.status >= 500
61
+ ? `server error (HTTP ${res.status}) with no response body — usually transient`
62
+ : `request failed (HTTP ${res.status})`,
63
+ }
28
64
  }
65
+
66
+ return { ok: res.ok, status: res.status, json }
29
67
  }
30
- return { ok: res.ok, status: res.status, json }
68
+ }
69
+
70
+ function sleep(ms) {
71
+ return new Promise((resolve) => setTimeout(resolve, ms))
31
72
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@test-lab-ai/cli",
3
- "version": "0.2.13",
3
+ "version": "0.2.14",
4
4
  "description": "Import existing test plans into test-lab.ai from the command line (or an AI agent).",
5
5
  "type": "module",
6
6
  "bin": {
@@ -32,18 +32,21 @@ This also means the script runs in a **restricted environment**: Playwright and
32
32
 
33
33
  Follow these in order.
34
34
 
35
- ### 1. Confirm the target plan exists and is reachable
35
+ ### 1. Design the test as a plan prompt first (with test-lab-plan)
36
36
 
37
- An upload attaches to an **existing** plan by numeric id. Before writing anything:
37
+ The plan's English **prompt is the spec; your script is one implementation of it.** Design the spec before you write a line of Playwright — that is what keeps the script honest and reviewable, and it is the fallback the platform runs if the script is ever cleared. Skipping this is how you end up with a script glued to a throwaway prompt that describes something else.
38
38
 
39
- - `testlab whoami` confirm the CLI is authenticated. If not, the user runs `testlab login` once or sets `TESTLAB_API_KEY`. If `testlab` is not found, use `npx @test-lab-ai/cli` instead.
40
- - `testlab plans list` find the plan id to upload to. The plan must already have a target URL (from its prompt or its project), because the script runs against that origin.
39
+ - **No plan yet?** Use the **test-lab-plan** skill to design it: one user journey, an explicit start URL, and a numbered `Verify that:` block of observable acceptance criteria. Create it (dashboard or `testlab import`), then attach your script.
40
+ - **Plan already exists?** Read its prompt that *is* your spec. If the prompt is vague, wrong, or describes a different flow, fix it with test-lab-plan **before** writing the script. Never encode behaviour in the script that the prompt doesn't claim.
41
41
 
42
- If there is no suitable plan yet, create one first (in the dashboard, or with the **test-lab-plan** skill + `testlab import`). The plan's English prompt stops driving runs the moment a script is uploaded: your script replaces AI generation for that plan and device.
42
+ Keep the prompt a clean user-journey spec: **no setup, auth, or implementation detail in the prose** — logged-in state, injected cookies, environment config, "no login needed", framework internals: none of it belongs there. Setup lives in the plan's pre-step / project environment, not the prompt body (test-lab-plan enforces this). Your script then *implements* that spec: one `test("Step N: …")` per prompt action, and an `expect` for each numbered acceptance criterion.
43
43
 
44
- ### 2. Know the flow and its checks
44
+ ### 2. Confirm the plan is reachable and read the real UI
45
45
 
46
- Same discipline as a good test plan: one user journey, explicit start, observable assertions. If you are in the target site's repo, read the relevant component / route so your locators and assertions match real DOM text and real success states, not guesses. If you are not in the repo, pull a snapshot with WebFetch or ask the user for the key screens. Anchor every `expect` to something real.
46
+ - `testlab whoami` confirm the CLI is authenticated. If not, the user runs `testlab login` once or sets `TESTLAB_API_KEY`. If `testlab` is not found, use `npx @test-lab-ai/cli` instead.
47
+ - `testlab plans list` – find the plan id to upload to. The plan must already have a target URL (from its prompt or its project), because the script runs against that origin. Uploading a script replaces AI generation for that plan + device, so from then on the prompt's job is to be the spec you implemented and the fallback — keep the two in sync.
48
+ - **Read the real UI before asserting.** If you are in the target site's repo, read the relevant component / route so your locators and assertions match real DOM text and real success states, not guesses. If you are not in the repo, pull a snapshot with WebFetch or ask the user for the key screens. Anchor every `expect` to something real **and to a criterion in the prompt.**
49
+ - **Fixing a script the plan already runs?** Download the live one with `testlab scripts get <id> [--device] [--out <file>]` (works for uploaded *and* generated scripts) instead of guessing at it, then edit and re-upload. That is the full fetch → fix → `scripts upload` loop, no dashboard needed.
47
50
 
48
51
  ### 3. Write the steps against `sharedPage`
49
52
 
@@ -140,6 +143,7 @@ The complete lists and the per-rule fixes are in `references/playwright-api.md`.
140
143
  7. **No Node / browser / network globals** (`process`, `fs`, `fetch`, `window`, `request`, …) and **no `page.evaluate`/`route`**. If you reached for one, rewrite the step to use the page.
141
144
  8. **No computed member keys or prototype access** (`x[expr]`, `.constructor`, `.__proto__`).
142
145
  9. **The plan id is right** (`testlab plans list`) and the plan has a target URL.
146
+ 10. **The script implements the plan's prompt.** Every prompt action maps to a `test("Step N: …")`, and every numbered acceptance criterion maps to an `expect`. The prompt itself reads as a clean user journey — no setup/auth/implementation detail leaked into the prose (that belongs in the plan's pre-step / environment). If the prompt and the script disagree, fix the prompt with test-lab-plan first.
143
147
 
144
148
  If any item fails, fix it before uploading – it will be rejected server-side anyway, and fixing first saves a round-trip.
145
149
 
@@ -157,7 +161,9 @@ If any item fails, fix it before uploading – it will be rejected server-side a
157
161
 
158
162
  ## Relationship to test-lab-plan
159
163
 
160
- - **test-lab-plan** describe a flow in English; the AI generates and maintains the Playwright. Best when you want low effort or don't have a script.
161
- - **test-lab-script** (this skill) – you own the Playwright; upload it verbatim. Best when you already have a script, need exact control, or want to save generation credits.
164
+ These **compose; they are not either/or.** test-lab-plan designs the spec (the plan's prompt); test-lab-script implements it (the Playwright). Even when you will hand-write the script, start with test-lab-plan so the spec is a clean, reviewable user journey and the script has a concrete contract to satisfy — see Workflow step 1.
165
+
166
+ - **test-lab-plan** – describe a flow in English; the AI generates and maintains the Playwright. Best when you want low effort, or as the spec step before you write your own script.
167
+ - **test-lab-script** (this skill) – you own the Playwright and upload it verbatim to implement that spec. Best when you need exact control, already have a script, or want to save generation credits.
162
168
 
163
169
  An uploaded script can still be refined later with AI from the dashboard (it is tagged as uploaded vs generated). `testlab examples` is the canonical, always-current reference for fixture shapes and resource formats.