feat(scenario): split log args into message/data and add debug level
CI / changes (pull_request) Successful in 12s
CI / version (pull_request) Skipped
CI / server (pull_request) Successful in 1m4s
CI / client (pull_request) Successful in 1m33s
CI / image (pull_request) Skipped

- context.log/warn/error and console.* split arguments: strings join
  into message, object/array args are kept out of it and stored as
  the log entry's new data column (JSON), so message stays a stable
  string regardless of an object's shape
- added a debug log level alongside log/warn/error, including
  context.debug() and console.debug() (previously folded into log)
- CSV/Markdown run log export include the data column/block
- LogOutput renders data pretty-printed in a separate block below
  the message, and dims debug entries with a dedicated grey token
  calibrated to the WCAG AA contrast floor
This commit is contained in:
ars9 committed 2026-10-01 14:09:45 +03:00
1 parent 6cba785e2f
commit 1273491eee
13 files changed
+204 -45

No files matched your search

@@ -19,10 +19,12 @@ export interface ExecResult {
}
export type ScriptLogger = (
level: "log" | "warn" | "error",
level: "debug" | "log" | "warn" | "error",
message: string,
/** Where the message was generated, e.g. "step:2", "snippet:login", "assertion:pass". */
context?: string | null,
/** Structured payload attached to the message (e.g. a created file's metadata). */
data?: unknown,
) => void;
/** The `context` object available inside user scripts as the sole argument. */
@@ -44,6 +46,7 @@ export interface ScriptContext {
log: (...args: unknown[]) => void;
warn: (...args: unknown[]) => void;
error: (...args: unknown[]) => void;
debug: (...args: unknown[]) => void;
/**
* Runs `fn` and requires it to return `true`. Logs the outcome under
* `description`, then throws if `fn` returned anything other than `true`
@@ -125,10 +128,27 @@ export class CodeExecutorService {
} = ctx;
const scriptLog: ScriptLogger =
log ?? ((level, msg) => this.logger[level](msg));
const toStr = (args: unknown[]) =>
args
.map((a) => (typeof a === "object" ? JSON.stringify(a) : String(a)))
.join(" ");
// Splits console/log args into a plain-text message (strings, numbers, ...)
// and a structured data payload (objects/arrays), logged separately so the
// message stays a stable string regardless of the object's shape.
const splitLogArgs = (
args: unknown[],
): { message: string; data: unknown } => {
const strings: string[] = [];
const objects: unknown[] = [];
for (const a of args) {
if (a !== null && typeof a === "object") {
objects.push(a);
} else {
strings.push(String(a));
}
}
return {
message: strings.join(" "),
data: objects.length === 0 ? null : objects.length === 1 ? objects[0] : objects,
};
};
// Innermost running snippet (if any) tags log entries; falls back to
// logContext (e.g. the current step) outside of any runSnippet call.
@@ -136,10 +156,16 @@ export class CodeExecutorService {
const currentContext = (): string | null =>
contextStack.length > 0 ? contextStack[contextStack.length - 1] : null;
const emit = (
level: "log" | "warn" | "error",
level: "debug" | "log" | "warn" | "error",
message: string,
contextOverride?: string,
): void => scriptLog(level, message, contextOverride ?? currentContext());
data?: unknown,
): void =>
scriptLog(level, message, contextOverride ?? currentContext(), data);
const emitArgs = (level: "debug" | "log" | "warn" | "error", args: unknown[]): void => {
const { message, data } = splitLogArgs(args);
emit(level, message, undefined, data);
};
const credMap: Record<string, unknown> = credentials ?? {};
const envData: EnvironmentData = environment ?? {};
@@ -149,11 +175,11 @@ export class CodeExecutorService {
let scriptContext: ScriptContext;
const fakeConsole = {
log: (...args: unknown[]) => emit("log", toStr(args)),
warn: (...args: unknown[]) => emit("warn", toStr(args)),
error: (...args: unknown[]) => emit("error", toStr(args)),
info: (...args: unknown[]) => emit("log", toStr(args)),
debug: (...args: unknown[]) => emit("log", toStr(args)),
log: (...args: unknown[]) => emitArgs("log", args),
warn: (...args: unknown[]) => emitArgs("warn", args),
error: (...args: unknown[]) => emitArgs("error", args),
info: (...args: unknown[]) => emitArgs("log", args),
debug: (...args: unknown[]) => emitArgs("debug", args),
};
try {
@@ -161,9 +187,10 @@ export class CodeExecutorService {
page,
browser,
dumpDom: (selector?: string) => dumpDom(page, selector),
log: (...args: unknown[]) => emit("log", toStr(args)),
warn: (...args: unknown[]) => emit("warn", toStr(args)),
error: (...args: unknown[]) => emit("error", toStr(args)),
log: (...args: unknown[]) => emitArgs("log", args),
warn: (...args: unknown[]) => emitArgs("warn", args),
error: (...args: unknown[]) => emitArgs("error", args),
debug: (...args: unknown[]) => emitArgs("debug", args),
assert: async (
fn: () => boolean | Promise<boolean>,
description: string,