@skyramp/mcp 0.3.4 → 0.3.6-rc.1

package/build/utils/uiPageEnumerator.js

@@ -14,6 +14,12 @@
  *     Next.js (app/ and pages/), Nuxt / Vue Router file-based, and SvelteKit.
  *     Gated on detection of a framework config file in the repo.
  *
+ *   Strategy 1b — Import graph
+ *     For a changed file that is not itself a route (a component, a constants
+ *     module), map the production files that import it through the same
+ *     filesystem-route mapper. Uses the importer list the production-importer integration
+ *     check already computed. Merged with strategy 1 rather than tried after it.
+ *
  *   Strategy 2 — Source-grounded routes
  *     Walks router/App files with the TS Compiler API for code-defined
  *     route declarations like `<Route path="/cart" element={<Cart/>}>`.
@@ -26,6 +32,10 @@
  *   Strategy 3 — Root fallback
  *     Read the workspace's frontend baseUrl and treat it as the single
  *     candidate page. Always available when a frontend service is configured.
+ *
+ * When no frontend baseUrl can be resolved, strategies 1/1b still run and their
+ * results are returned as bare URL paths (`baseUrlResolved: false`) so the agent
+ * can prefix the base URL it discovers; strategies 2–3 need a host and are skipped.
  */
 import * as fs from "fs";
 import * as path from "path";
@@ -33,6 +43,13 @@ import { extractDartRoutes } from "./dartRouteExtractor.js";
 import { extractSourceRoutes } from "./sourceRouteExtractor.js";
 import { hasFlutterSdkDep } from "../prompts/test-recommendation/scopeAssessment.js";
 import { readWorkspaceConfigRaw } from "./workspaceAuth.js";
+/**
+ * Upper bound on candidate pages. Strategy 1b is bounded by changed files ×
+ * importers, and every candidate costs the agent a navigate + a capture, so the
+ * list is cut here — direct route matches first, then import-graph pages that
+ * render the most changed files.
+ */
+export const MAX_CANDIDATE_PAGES = 10;
 // ── Strategy 1: framework route grep ────────────────────────────────────────
 /**
  * File-system → URL mapping for filesystem-routed frameworks.
@@ -61,8 +78,9 @@ export function frameworkFileToUrlPath(filePath) {
         return "/" + stripRouteGroups(nextAppMatch[1]).replace(/\[(\.\.\.)?(\w+)\]/g, ":$2");
     }
     // Next.js Pages Router: pages/foo.tsx → /foo, pages/index.tsx → /
-    // Excludes pages/api/* (those are API handlers, not UI pages).
-    const nextPagesMatch = normalized.match(/(?:^|\/)pages\/(?!api\/)(.+?)\.(tsx|jsx|ts|js)$/);
+    // Excludes pages/api/* (API handlers) and the framework files _app, _document,
+    // _error (they wrap every page and are not routes of their own).
+    const nextPagesMatch = normalized.match(/(?:^|\/)pages\/(?!api\/)(?!_(?:app|document|error)\.)(.+?)\.(tsx|jsx|ts|js)$/);
     if (nextPagesMatch) {
         let urlPath = nextPagesMatch[1];
         // /index → /, /foo/index → /foo
@@ -140,43 +158,64 @@ export function detectsFilesystemRouting(repositoryPath) {
     return false;
 }
 /**
- * Strategy 1 implementation. Filters frontend files through the framework
- * route mapper; collects the URL paths that mapped successfully.
+ * Strategies 1 + 1b: map changed route files (1) and the route files that import
+ * changed non-route files (1b) to URL paths. Deduped by path; when both name the
+ * same path the strategy-1 entry wins and the extra source is appended.
  *
  * Suppressed when the repo doesn't have a recognized filesystem-routing
  * framework config — see `detectsFilesystemRouting`. Without that guard,
  * repos with conventional `pages/` directories but code-defined routes
  * (e.g. React with React Router) produce false-positive URLs.
  */
-export function findCandidatePagesByFrameworkRoute(frontendFiles, baseUrl, repositoryPath) {
+function collectRoutePaths(frontendFiles, integration, repositoryPath) {
     // When repositoryPath is provided, gate on framework detection. When
     // omitted (e.g. older callers, unit tests), preserve original behavior.
     if (repositoryPath !== undefined && !detectsFilesystemRouting(repositoryPath)) {
         return [];
     }
-    const byUrl = new Map();
-    for (const file of frontendFiles) {
-        const urlPath = frameworkFileToUrlPath(file);
-        if (urlPath === null)
-            continue;
-        const normalizedBase = baseUrl.replace(/\/$/, "");
-        const fullUrl = normalizedBase + urlPath;
-        const existing = byUrl.get(fullUrl);
+    const byPath = new Map();
+    const add = (urlPath, sourceFile, strategy, via) => {
+        const existing = byPath.get(urlPath);
         if (existing) {
-            // Same URL surfaced by multiple files — track all sources.
-            if (!existing.sourcedFrom.includes(file)) {
-                existing.sourcedFrom.push(file);
-            }
+            // Same path surfaced by multiple files — track all sources.
+            if (!existing.sourcedFrom.includes(sourceFile))
+                existing.sourcedFrom.push(sourceFile);
+            if (via && existing.via && !existing.via.includes(via))
+                existing.via.push(via);
         }
         else {
-            byUrl.set(fullUrl, {
-                url: fullUrl,
-                sourcedFrom: [file],
-                strategy: "framework-route-grep",
-            });
+            byPath.set(urlPath, { path: urlPath, sourcedFrom: [sourceFile], strategy, ...(via ? { via: [via] } : {}) });
+        }
+    };
+    for (const file of frontendFiles) {
+        const urlPath = frameworkFileToUrlPath(file);
+        if (urlPath !== null)
+            add(urlPath, file, "framework-route-grep");
+    }
+    for (const entry of integration ?? []) {
+        if (!entry.integrated)
+            continue;
+        for (const importer of entry.importers) {
+            const urlPath = frameworkFileToUrlPath(importer);
+            if (urlPath !== null)
+                add(urlPath, entry.file, "import-graph", importer);
         }
     }
-    return Array.from(byUrl.values());
+    const all = Array.from(byPath.values());
+    const rank = (c) => (c.strategy === "framework-route-grep" ? 1 : 0) * 1000 + c.sourcedFrom.length;
+    return all.sort((a, b) => rank(b) - rank(a)).slice(0, MAX_CANDIDATE_PAGES);
+}
+function joinBaseUrl(baseUrl, candidate) {
+    return {
+        url: baseUrl.replace(/\/$/, "") + candidate.path,
+        sourcedFrom: candidate.sourcedFrom,
+        strategy: candidate.strategy,
+        ...(candidate.via ? { via: candidate.via } : {}),
+    };
+}
+/** Strategy 1 only (no import graph), joined to `baseUrl`. */
+export function findCandidatePagesByFrameworkRoute(frontendFiles, baseUrl, repositoryPath) {
+    return collectRoutePaths(frontendFiles, undefined, repositoryPath).map((c) => joinBaseUrl(baseUrl, c));
 }
 // ── Strategy 2: source-grounded routes ──────────────────────────────────────
 /**
@@ -302,13 +341,10 @@ export function findCandidatePagesByDartRoute(repositoryPath, baseUrl, frontendF
  */
 export async function findRootFallbackPage(repositoryPath) {
     const baseUrl = await pickFrontendBaseUrl(repositoryPath);
-    if (!baseUrl)
-        return null;
-    return {
-        url: baseUrl,
-        sourcedFrom: [],
-        strategy: "root-fallback",
-    };
+    return baseUrl ? rootFallbackPage(baseUrl) : null;
+}
+function rootFallbackPage(baseUrl) {
+    return { url: baseUrl, sourcedFrom: [], strategy: "root-fallback" };
 }
 /**
  * Mirror of testbot.git src/services.ts exportServiceBaseUrlEnvVars sanitize().
@@ -369,19 +405,21 @@ function pickFrontendService(services) {
  *      is the picked frontend service's serviceName, sanitized via
  *      `sanitizeServiceName`)
  *   2. Global override: `SKYRAMP_TEST_BASE_URL` (single service or all
- *      services share one URL)
+ *      services share one URL). Also honored when the workspace declares no
+ *      services at all — the action can know the URL without a workspace entry.
  *   3. Static workspace.yml value: `api.baseUrl` from the picked frontend
  *      service
  *
- * Returns null when no service has a usable URL.
+ * Returns null when neither the environment nor any service has a usable URL.
  *
  * Exported (vs private) so analyze_changes and future tools can reuse the
  * same selection without re-implementing it.
  */
 export async function pickFrontendBaseUrl(repositoryPath) {
     const config = await readWorkspaceConfigRaw(repositoryPath);
+    const global = process.env.SKYRAMP_TEST_BASE_URL?.trim();
     if (!config?.services || !Array.isArray(config.services))
-        return null;
+        return global || null;
     const picked = pickFrontendService(config.services);
     // 1. Per-service override (multi-service, distinct URLs).
     // readWorkspaceConfigRaw may fall back to unvalidated YAML, so serviceName
@@ -392,7 +430,6 @@ export async function pickFrontendBaseUrl(repositoryPath) {
             return perSvc;
     }
     // 2. Global override (single service / all services share a URL).
-    const global = process.env.SKYRAMP_TEST_BASE_URL?.trim();
     if (global)
         return global;
     // 3. Static workspace.yml value.
@@ -400,31 +437,38 @@ export async function pickFrontendBaseUrl(repositoryPath) {
 }
 // ── Composer ────────────────────────────────────────────────────────────────
 /**
- * Run the strategy ladder in order: framework route grep (1) → source-grounded
- * routes (2) → root fallback (3). Each strategy is consulted only if the
- * previous one produced no candidates. Returns whatever the ladder produces
- * (possibly empty if the workspace has no frontend baseUrl AND none of the
- * earlier strategies matched).
+ * Run the strategy ladder: framework route grep + import graph (1/1b) →
+ * source-grounded routes (2) → Dart GoRouter (2.5) → root fallback (3). Each
+ * later strategy is consulted only if the earlier ones produced no candidates.
+ *
+ * `integration` is the production-importer check for the same files; when given,
+ * changed non-route files resolve to the pages that import them.
+ *
+ * Without a resolvable frontend baseUrl only strategies 1/1b can run; their
+ * paths are returned with `baseUrlResolved: false` for the agent to prefix.
+ * Returns empty only when nothing resolves at all.
  */
-export async function enumerateCandidateUiPages(repositoryPath, frontendFiles) {
+export async function enumerateCandidateUiPages(repositoryPath, frontendFiles, integration) {
     if (frontendFiles.length === 0)
         return [];
     const baseUrl = await pickFrontendBaseUrl(repositoryPath);
-    // Strategy 1 needs a baseUrl to construct full URLs. Without one, the
-    // fallback path in strategy 3 also won't fire — return empty and let the
-    // caller decide what to do (typically: persist nothing, agent does its
-    // own enumeration via the existing prompt fallback).
-    if (!baseUrl)
-        return [];
-    const fromRoutes = findCandidatePagesByFrameworkRoute(frontendFiles, baseUrl, repositoryPath);
-    if (fromRoutes.length > 0)
-        return fromRoutes;
+    const routePaths = collectRoutePaths(frontendFiles, integration, repositoryPath);
+    if (!baseUrl) {
+        return routePaths.map((c) => ({
+            url: c.path,
+            sourcedFrom: c.sourcedFrom,
+            strategy: c.strategy,
+            baseUrlResolved: false,
+            ...(c.via ? { via: c.via } : {}),
+        }));
+    }
+    if (routePaths.length > 0)
+        return routePaths.map((c) => joinBaseUrl(baseUrl, c));
     const fromSource = findCandidatePagesBySourceRoute(frontendFiles, baseUrl, repositoryPath);
     if (fromSource.length > 0)
         return fromSource;
     const fromDart = findCandidatePagesByDartRoute(repositoryPath, baseUrl, frontendFiles);
     if (fromDart.length > 0)
         return fromDart;
-    const fallback = await findRootFallbackPage(repositoryPath);
-    return fallback ? [fallback] : [];
+    return [rootFallbackPage(baseUrl)];
 }

package/build/utils/utils-verify/allow.d.ts

@@ -0,0 +1,16 @@
+import type { UtilsLanguageSpec } from "./language-spec.js";
+export type UtilsViolationKind = "duplicate-helper" | "body-assertion" | "scenario-name";
+export declare const UTILS_VIOLATION_KINDS: readonly UtilsViolationKind[];
+export interface UtilsAllow {
+    kind: UtilsViolationKind;
+    helper: string;
+    reason: string;
+}
+/** The exact line to paste for a violation — what the failure text hands the agent. */
+export declare function allowMarkerLine(spec: UtilsLanguageSpec, kind: UtilsViolationKind, helper: string): string;
+export declare function parseUtilsAllows(content: string, spec: UtilsLanguageSpec): {
+    allows: UtilsAllow[];
+    /** Marker lines the loose pattern recognises but the grammar cannot read — a decline
+     *  the gate would otherwise drop silently. Reported back so the agent fixes the line. */
+    malformed: string[];
+};

package/build/utils/utils-verify/allow.js

@@ -0,0 +1,68 @@
+import { blankStrings } from "./parse.js";
+export const UTILS_VIOLATION_KINDS = [
+    "duplicate-helper",
+    "body-assertion",
+    "scenario-name",
+];
+/**
+ * The documented-decline marker for a utils-file invariant, written in the utils file:
+ *
+ *     # reuse-verify: allow <kind> <helper> — <reason>      (Python)
+ *     // reuse-verify: allow <kind> <helper> — <reason>     (TS/JS)
+ *
+ * ONE grammar, used by both the gate and the report. The POM path's `// kept inline:`
+ * marker had two — the gate's regex and the report parser disagreed on the separator
+ * and on the file extension — and the gap was a run where the gate blocked execution
+ * on declines the report listed correctly (mcp#716, run 30965653402). Here the gate
+ * and the report call this one function.
+ *
+ * The separator is an em/en dash or a hyphen with whitespace on BOTH sides, so a
+ * hyphen inside a helper name cannot be mistaken for it. `(?!<reason)` rejects the
+ * paste-ready line from the failure text when it was pasted unedited: publishing the
+ * placeholder as the stated reason is worse than no marker.
+ */
+const ALLOW_RE = /reuse-verify:\s*allow\s+(duplicate-helper|body-assertion|scenario-name)\s+([A-Za-z_$][\w$]*)\s*(?:[—–]+|\s+-+\s+)\s*(?!<reason)(\S.*?)\s*$/;
+const ALLOW_LOOSE_RE = /reuse-verify:\s*allow\b/;
+/** The exact line to paste for a violation — what the failure text hands the agent. */
+export function allowMarkerLine(spec, kind, helper) {
+    return `${spec.commentPrefix} reuse-verify: allow ${kind} ${helper} — <reason this helper must stay as it is>`;
+}
+export function parseUtilsAllows(content, spec) {
+    const allows = [];
+    const malformed = [];
+    // String contents are blanked first, so a marker (or a comment token) quoted in
+    // code can neither be read as a decline nor make one look like a comment.
+    const rawLines = content.split("\n");
+    const codeLines = blankStrings(content, spec).split("\n");
+    for (let n = 0; n < rawLines.length; n++) {
+        const raw = rawLines[n];
+        const code = codeLines[n] ?? "";
+        // The marker may sit in a trailing comment, a block comment or a JSDoc line — any
+        // comment form. Match from the marker itself, so the comment syntax around it does
+        // not decide whether a decline is read.
+        const at = code.search(ALLOW_LOOSE_RE);
+        if (at === -1)
+            continue;
+        const before = code.slice(0, at);
+        const inComment = spec.commentPrefix === "#"
+            ? /#/.test(before)
+            : /\/\/|\/\*|^\s*\*/.test(before);
+        if (!inComment)
+            continue;
+        const line = raw
+            .slice(at)
+            .replace(/\s*\*\/\s*$/, "")
+            .trim();
+        const m = ALLOW_RE.exec(line);
+        if (!m) {
+            malformed.push(raw.trim());
+            continue;
+        }
+        allows.push({
+            kind: m[1],
+            helper: m[2],
+            reason: m[3],
+        });
+    }
+    return { allows, malformed };
+}

package/build/utils/utils-verify/call-sites.d.ts

@@ -0,0 +1,34 @@
+import { type UtilsHelper } from "./parse.js";
+import { type UtilsLanguageSpec } from "./language-spec.js";
+/** The codegen marker every Skyramp-GENERATED TEST carries on line 1 (`Generated by
+ *  Skyramp v<version>`), as opposed to the utils header (`Generated by Skyramp on …`).
+ *  The same discriminator STEP 4 of the reuse prompt hands the agent. */
+export declare const CODEGEN_MARKER_RE: RegExp;
+export interface InlineCallSite {
+    /** Absolute path of the sibling test. */
+    file: string;
+    /** 1-based line of the request call. */
+    line: number;
+    method: string;
+    path: string;
+    /** The utils helper that wraps the same method+path. */
+    helper: string;
+}
+/**
+ * Inline request calls in OTHER Skyramp-generated tests beside `testFile` that a
+ * utils helper already wraps — the reuse the prompt asks for and the agent does not
+ * perform (measured 0/2 seeded eval runs with the rule as its own mandatory step).
+ *
+ * A call is INLINE when it sits in a test function, not in a module-level helper of
+ * the sibling's own: a sibling that defines `create_order` locally is STEP 4b's
+ * helper-vs-helper case, not a call site. Equivalence is `c3b9157b`'s: same method
+ * and same normalised path, nothing else — literals are what the call's arguments
+ * are for.
+ *
+ * Advisory by design: it names a change to a PRE-EXISTING test, which the maintenance
+ * flow owns, so it informs rather than gates. Never throws.
+ */
+export declare function findSiblingInlineCallSites(testFile: string, utilsFiles: string[], _helpers: UtilsHelper[], spec: UtilsLanguageSpec): Promise<InlineCallSite[]>;
+/** The keyword names of a request call (`path=`, `method=`, `query_params=` … / TS
+ *  object keys), less the liftable ones — a cheap normalised call shape. */
+export declare function shapeKeys(call: string): Set<string>;

package/build/utils/utils-verify/call-sites.js

@@ -0,0 +1,154 @@
+import * as fs from "fs";
+import * as path from "path";
+import { SKYRAMP_UTILS_HEADER } from "../utils.js";
+import { parseUtilsFile } from "./parse.js";
+import { normalizePath } from "./language-spec.js";
+import { realpath } from "./locate.js";
+/** The codegen marker every Skyramp-GENERATED TEST carries on line 1 (`Generated by
+ *  Skyramp v<version>`), as opposed to the utils header (`Generated by Skyramp on …`).
+ *  The same discriminator STEP 4 of the reuse prompt hands the agent. */
+export const CODEGEN_MARKER_RE = new RegExp(`${SKYRAMP_UTILS_HEADER.replace(/[.*+?^${}()|[\]\\]/g, "\\$&")}\\s+v\\d`);
+const HEADER_SCAN_LINES = 5;
+const REQUEST_CALL_RE = /\b(?:send_request|sendRequest)\s*\(/g;
+/**
+ * Inline request calls in OTHER Skyramp-generated tests beside `testFile` that a
+ * utils helper already wraps — the reuse the prompt asks for and the agent does not
+ * perform (measured 0/2 seeded eval runs with the rule as its own mandatory step).
+ *
+ * A call is INLINE when it sits in a test function, not in a module-level helper of
+ * the sibling's own: a sibling that defines `create_order` locally is STEP 4b's
+ * helper-vs-helper case, not a call site. Equivalence is `c3b9157b`'s: same method
+ * and same normalised path, nothing else — literals are what the call's arguments
+ * are for.
+ *
+ * Advisory by design: it names a change to a PRE-EXISTING test, which the maintenance
+ * flow owns, so it informs rather than gates. Never throws.
+ */
+export async function findSiblingInlineCallSites(testFile, utilsFiles, _helpers, spec) {
+    // route → helper name + the keyword set of the helper's own request call, so a
+    // sibling call is reported only when its SHAPE matches too (same keywords once the
+    // liftable ones are set aside) — criterion 2 of the API near-duplicate definition.
+    const byRoute = new Map();
+    for (const utilsFile of utilsFiles) {
+        let content;
+        try {
+            content = await fs.promises.readFile(utilsFile, "utf8");
+        }
+        catch {
+            continue;
+        }
+        // Owners come from THIS file's own parse: `helpers` spans every utils file, and
+        // a line range alone would attribute file B's request to file A's helper.
+        const fileHelpers = parseUtilsFile(content, spec);
+        for (const m of content.matchAll(REQUEST_CALL_RE)) {
+            const start = m.index ?? 0;
+            const line = content.slice(0, start).split("\n").length;
+            const owner = fileHelpers.find((h) => h.line <= line && line <= h.endLine);
+            if (!owner?.method || !owner.normalizedPath)
+                continue;
+            const call = callText(content, start + m[0].length - 1);
+            byRoute.set(`${owner.method} ${owner.normalizedPath}`, {
+                helper: owner.name,
+                keys: shapeKeys(call),
+            });
+        }
+    }
+    if (byRoute.size === 0)
+        return [];
+    // Canonical, like the utils paths: otherwise a tool-supplied /tmp path and a
+    // realpath'd /private/tmp utils file look like different directories to the renderer.
+    const dir = path.dirname(await realpath(testFile));
+    // Canonical like `dir`, or a spec reached through a symlink is reported as its
+    // own sibling.
+    const exclude = new Set(await Promise.all([testFile, ...utilsFiles].map((f) => realpath(f))));
+    let entries;
+    try {
+        entries = await fs.promises.readdir(dir);
+    }
+    catch {
+        return [];
+    }
+    const out = [];
+    for (const name of entries.sort()) {
+        const file = path.join(dir, name);
+        if (exclude.has(path.resolve(file)))
+            continue;
+        if (!spec.extensions.some((e) => name.toLowerCase().endsWith(e)))
+            continue;
+        let content;
+        try {
+            content = await fs.promises.readFile(file, "utf8");
+        }
+        catch {
+            continue;
+        }
+        if (!CODEGEN_MARKER_RE.test(content.split("\n").slice(0, HEADER_SCAN_LINES).join("\n")))
+            continue;
+        // Line ranges of the sibling's own non-test helpers: calls inside them are not inline.
+        const localHelpers = parseUtilsFile(content, spec).filter((h) => !/^test/i.test(h.name));
+        const inLocalHelper = (line) => localHelpers.some((h) => line >= h.line && line <= h.endLine);
+        for (const m of content.matchAll(REQUEST_CALL_RE)) {
+            const start = m.index ?? 0;
+            const line = content.slice(0, start).split("\n").length;
+            if (inLocalHelper(line))
+                continue;
+            const call = callText(content, start + m[0].length - 1);
+            const method = spec.methodRe.exec(call)?.[1]?.toUpperCase();
+            const p = spec.pathRe.exec(call)?.[1];
+            if (!method || !p)
+                continue;
+            const match = byRoute.get(`${method} ${normalizePath(p)}`);
+            if (!match)
+                continue;
+            if (!sameShape(shapeKeys(call), match.keys))
+                continue;
+            out.push({ file, line, method, path: p, helper: match.helper });
+        }
+    }
+    return out;
+}
+/** Keywords whose presence differs legitimately between two versions of one request:
+ *  the literals the merge rule lifts to parameters. Everything else is call shape. */
+const LIFTABLE_KEYS = new Set([
+    "body",
+    "data",
+    "data_override",
+    "dataOverride",
+    "headers",
+    "url",
+    "path_params",
+    "pathParams",
+]);
+/** The keyword names of a request call (`path=`, `method=`, `query_params=` … / TS
+ *  object keys), less the liftable ones — a cheap normalised call shape. */
+export function shapeKeys(call) {
+    const keys = new Set();
+    for (const m of call.matchAll(/\b([A-Za-z_]\w*)\s*[=:](?![=])/g)) {
+        if (!LIFTABLE_KEYS.has(m[1]))
+            keys.add(m[1]);
+    }
+    return keys;
+}
+function sameShape(a, b) {
+    if (a.size !== b.size)
+        return false;
+    for (const k of a)
+        if (!b.has(k))
+            return false;
+    return true;
+}
+/** Text of the parenthesised argument list starting at the `(` at `open`. */
+function callText(content, open) {
+    let depth = 0;
+    for (let i = open; i < content.length; i++) {
+        const ch = content[i];
+        if (ch === "(")
+            depth++;
+        else if (ch === ")") {
+            depth--;
+            if (depth === 0)
+                return content.slice(open, i + 1);
+        }
+    }
+    return content.slice(open);
+}

package/build/utils/utils-verify/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./language-spec.js";
+export * from "./parse.js";
+export * from "./allow.js";
+export * from "./locate.js";
+export * from "./verify.js";
+export * from "./stage.js";
+export * from "./call-sites.js";

package/build/utils/utils-verify/index.js

@@ -0,0 +1,7 @@
+export * from "./language-spec.js";
+export * from "./parse.js";
+export * from "./allow.js";
+export * from "./locate.js";
+export * from "./verify.js";
+export * from "./stage.js";
+export * from "./call-sites.js";

package/build/utils/utils-verify/language-spec.d.ts

@@ -0,0 +1,91 @@
+/**
+ * Language-parametric description of a shared SkyrampUtils file, and the invariants
+ * every helper in it must hold. Encoded as DATA rather than as per-language checks so
+ * that adding a language (or a helper family with a different assertion rule, e.g.
+ * browser helpers) is a table entry, not a second verifier.
+ *
+ * The invariants come from the prompts that author these files — the HELPER SHAPE
+ * block in the integration modularization prompt and the API near-duplicate rules in
+ * the reuse prompt — and exist here because prompt rules are LLM-enforced only:
+ * SKYR-4196 Part B runs 5 and 11 leaked a scenario-literal body assertion into a shared
+ * helper despite both rules being in the prompt.
+ */
+export type UtilsLanguage = "python" | "typescript" | "javascript";
+export interface UtilsLanguageSpec {
+    language: UtilsLanguage;
+    /** File extensions (with dot) a utils file in this language can carry. */
+    extensions: string[];
+    commentPrefix: "#" | "//";
+    /** Matches the FIRST line of a module-level helper definition; group 1 is the name. */
+    helperStart: RegExp;
+    /** `method="POST"` / `method: "POST"` inside a helper body; group 1 is the verb. */
+    methodRe: RegExp;
+    /** `path="/api/…"` / `path: "/…"` inside a helper body; group 1 is the path. */
+    pathRe: RegExp;
+    /** A line that is an assertion at all. */
+    assertionRe: RegExp;
+    /** The one assertion shape an API helper may carry: a status-code comparison. Any
+     *  assertion line not matching this is a body assertion — the scenario-specific
+     *  claim that fails the next scenario calling the helper. */
+    allowedAssertion: RegExp;
+    /** The assertions a BROWSER helper may carry: structural waits that an element
+     *  rendered / is interactable (`toBeVisible`, `toBeEnabled`, …). Value assertions
+     *  (`toHaveText`, `toHaveValue`, `toHaveCount`, `toHaveURL`, any `expect` on a
+     *  literal) are the browser analogue of a body assertion. Mirrors the
+     *  BROWSER_HELPERS policy the modularization and reuse prompts state. */
+    allowedBrowserAssertion: RegExp;
+    /** Names `specContent` imports from the utils module whose basename stem is `stem`. */
+    importedNames(specContent: string, stem: string): string[];
+}
+/** Path parameters spelled `{id}`, `${id}`, `:id` all normalise to `{}` so two helpers
+ *  for `/orders/{order_id}` and `/orders/{id}` compare equal. */
+export declare function normalizePath(p: string): string;
+export declare const UTILS_LANGUAGE_SPECS: Record<UtilsLanguage, UtilsLanguageSpec>;
+/**
+ * The two kinds of shared helper, keyed by the test type's substrate — the same
+ * split the modularization and reuse prompts make (API_HELPERS / BROWSER_HELPERS):
+ * - `api` (integration, contract, load …): one SDK request; equivalence is
+ *   method+path; the only assertion is the status code.
+ * - `browser` (ui, e2e): a Playwright action sequence; no route to key duplicates
+ *   on, so the duplicate check is inert; the only assertions are structural waits.
+ */
+export type HelperFamily = "api" | "browser";
+export interface HelperFamilySpec {
+    family: HelperFamily;
+    /** Whether two helpers wrapping the same method+path are a violation. */
+    routeDuplicates: boolean;
+    /** Picks the permitted-assertion pattern out of a language spec. */
+    allowedAssertion(spec: UtilsLanguageSpec): RegExp;
+    /** Whether one complete assertion expression is permitted for this family. */
+    isAllowed(spec: UtilsLanguageSpec, expr: string): boolean;
+    /** One clause for the failure text: what a helper of this family may assert. */
+    assertionRule: string;
+}
+export declare const HELPER_FAMILIES: Record<HelperFamily, HelperFamilySpec>;
+/** The helper family a test type's shared helpers follow. Unlike `isBrowserTestType`,
+ *  an ABSENT test type resolves to `api`: this runs against a utils file that already
+ *  exists, and the browser rules are the more permissive of the two on duplicates, so
+ *  guessing "browser" would silently switch a check off. */
+export declare function helperFamilyFor(testType: string | undefined): HelperFamilySpec;
+/** The spec for a language string as the tools receive it, or `undefined` for a
+ *  language this verifier does not cover (Java: utils reuse is disabled for it). */
+export declare function utilsSpecFor(language: string | undefined): UtilsLanguageSpec | undefined;
+/** The spec whose extensions cover `file`, for callers that know a path but not a language. */
+export declare function utilsSpecForFile(file: string): UtilsLanguageSpec | undefined;
+/**
+ * Helper names are `<verb>_<resource>` only (`create_order`, `update_order`); scenario
+ * data belongs in arguments. A name carrying a scenario adjective or a literal is the
+ * signature of a helper that will not merge with the same step from the next test
+ * (`update_order_50_discount` beside `update_order_discount`, SKYR-4196 run 4).
+ *
+ * Tokens are matched after splitting on `_` and camelCase boundaries, so the rule
+ * applies unchanged to Python and TS/JS names.
+ */
+export declare const SCENARIO_NAME_RULE: {
+    forbiddenTokens: Set<string>;
+    /** A bare number as its OWN token — `update_order_50_discount` — never a digit inside
+     *  an identifier (`s3`, `oauth2`, `ipv4`, `sha256`, `base64`, `iso8601`, `2fa`). */
+    digitToken: RegExp;
+};
+/** The reason a name is scenario-flavoured, or `undefined` when it is canonical. */
+export declare function scenarioNameViolation(name: string): string | undefined;