feat(scenario): tag run log entries with their context
- scenario_run_logs gains a context column (step:N, snippet:alias, assertion:pass/fail, run), tracked through a call stack in CodeExecutorService so nested runSnippet calls tag their own and inner log lines - automatic step started/passed/failed entries and the Playwright trace upload notice are tagged accordingly - run log export (CSV/Markdown) and the logs search match context as well as message - add a LogOutput UI component: a terminal-style log viewer with level color coding, elapsed-time-since-start timestamps and a context tag, replacing the generic Table on the run detail page - show the full log list instead of paginating it, capped to a scrollable block - fix migrations.spec.ts's revert test, which only undid the last migration instead of all of them
This commit is contained in:
15 files changed
+383
-70
No files matched your search
@@ -21,6 +21,8 @@ export interface ExecResult {
|
||||
export type ScriptLogger = (
|
||||
level: "log" | "warn" | "error",
|
||||
message: string,
|
||||
/** Where the message was generated, e.g. "step:2", "snippet:login", "assertion:pass". */
|
||||
context?: string | null,
|
||||
) => void;
|
||||
|
||||
/** The `context` object available inside user scripts as the sole argument. */
|
||||
@@ -70,6 +72,8 @@ export interface ExecContext {
|
||||
browser: BrowserContext;
|
||||
code: string;
|
||||
log?: ScriptLogger;
|
||||
/** Base log context for this execution, e.g. "step:2". */
|
||||
logContext?: string | null;
|
||||
getStepOutput?: (order: number) => Promise<unknown>;
|
||||
credentials?: Record<string, unknown>;
|
||||
environment?: EnvironmentData | null;
|
||||
@@ -110,6 +114,7 @@ export class CodeExecutorService {
|
||||
browser,
|
||||
code,
|
||||
log,
|
||||
logContext,
|
||||
getStepOutput,
|
||||
credentials,
|
||||
environment,
|
||||
@@ -125,6 +130,17 @@ export class CodeExecutorService {
|
||||
.map((a) => (typeof a === "object" ? JSON.stringify(a) : String(a)))
|
||||
.join(" ");
|
||||
|
||||
// Innermost running snippet (if any) tags log entries; falls back to
|
||||
// logContext (e.g. the current step) outside of any runSnippet call.
|
||||
const contextStack: string[] = logContext ? [logContext] : [];
|
||||
const currentContext = (): string | null =>
|
||||
contextStack.length > 0 ? contextStack[contextStack.length - 1] : null;
|
||||
const emit = (
|
||||
level: "log" | "warn" | "error",
|
||||
message: string,
|
||||
contextOverride?: string,
|
||||
): void => scriptLog(level, message, contextOverride ?? currentContext());
|
||||
|
||||
const credMap: Record<string, unknown> = credentials ?? {};
|
||||
const envData: EnvironmentData = environment ?? {};
|
||||
const snippetMap: Record<string, string> = snippets ?? {};
|
||||
@@ -133,11 +149,11 @@ export class CodeExecutorService {
|
||||
let scriptContext: ScriptContext;
|
||||
|
||||
const fakeConsole = {
|
||||
log: (...args: unknown[]) => scriptLog("log", toStr(args)),
|
||||
warn: (...args: unknown[]) => scriptLog("warn", toStr(args)),
|
||||
error: (...args: unknown[]) => scriptLog("error", toStr(args)),
|
||||
info: (...args: unknown[]) => scriptLog("log", toStr(args)),
|
||||
debug: (...args: unknown[]) => scriptLog("log", toStr(args)),
|
||||
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)),
|
||||
};
|
||||
|
||||
try {
|
||||
@@ -145,9 +161,9 @@ export class CodeExecutorService {
|
||||
page,
|
||||
browser,
|
||||
dumpDom: (selector?: string) => dumpDom(page, selector),
|
||||
log: (...args: unknown[]) => scriptLog("log", toStr(args)),
|
||||
warn: (...args: unknown[]) => scriptLog("warn", toStr(args)),
|
||||
error: (...args: unknown[]) => scriptLog("error", toStr(args)),
|
||||
log: (...args: unknown[]) => emit("log", toStr(args)),
|
||||
warn: (...args: unknown[]) => emit("warn", toStr(args)),
|
||||
error: (...args: unknown[]) => emit("error", toStr(args)),
|
||||
assert: async (
|
||||
fn: () => boolean | Promise<boolean>,
|
||||
description: string,
|
||||
@@ -161,13 +177,13 @@ export class CodeExecutorService {
|
||||
failureReason = (err as Error).message;
|
||||
}
|
||||
if (passed) {
|
||||
scriptLog("log", `Assertion passed: ${description}`);
|
||||
emit("log", description, "assertion:pass");
|
||||
return;
|
||||
}
|
||||
const message = failureReason
|
||||
? `Assertion failed: ${description} (${failureReason})`
|
||||
: `Assertion failed: ${description}`;
|
||||
scriptLog("error", message);
|
||||
emit("error", message, "assertion:fail");
|
||||
throw new Error(message);
|
||||
},
|
||||
getStepOutput: getStepOutput ?? (() => Promise.resolve(null)),
|
||||
@@ -197,7 +213,9 @@ export class CodeExecutorService {
|
||||
if (snippetCode == null) {
|
||||
throw new Error(`Snippet alias "${alias}" not found`);
|
||||
}
|
||||
scriptLog("log", `Snippet "${alias}" started`);
|
||||
const snippetContext = `snippet:${alias}`;
|
||||
contextStack.push(snippetContext);
|
||||
emit("log", `Snippet "${alias}" started`, snippetContext);
|
||||
const snippetFn = new Function(
|
||||
"context",
|
||||
"console",
|
||||
@@ -212,14 +230,17 @@ export class CodeExecutorService {
|
||||
args,
|
||||
playwrightExpect,
|
||||
);
|
||||
scriptLog("log", `Snippet "${alias}" finished`);
|
||||
emit("log", `Snippet "${alias}" finished`, snippetContext);
|
||||
return snippetResult;
|
||||
} catch (err) {
|
||||
scriptLog(
|
||||
emit(
|
||||
"error",
|
||||
`Snippet "${alias}" failed: ${(err as Error).message}`,
|
||||
snippetContext,
|
||||
);
|
||||
throw err;
|
||||
} finally {
|
||||
contextStack.pop();
|
||||
}
|
||||
},
|
||||
getScenarioFiles: async (opts?: { limit?: number; offset?: number }) => {
|
||||
|
||||
@@ -26,6 +26,11 @@ export class ExecContextBuilder {
|
||||
return this;
|
||||
}
|
||||
|
||||
logContext(logContext: string): this {
|
||||
this.ctx.logContext = logContext;
|
||||
return this;
|
||||
}
|
||||
|
||||
getStepOutput(fn: (order: number) => Promise<unknown>): this {
|
||||
this.ctx.getStepOutput = fn;
|
||||
return this;
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
import { MigrationInterface, QueryRunner } from "typeorm";
|
||||
|
||||
export class AddRunLogContext1790848194828 implements MigrationInterface {
|
||||
name = "AddRunLogContext1790848194828";
|
||||
|
||||
public async up(queryRunner: QueryRunner): Promise<void> {
|
||||
await queryRunner.query(
|
||||
`CREATE TABLE "temporary_scenario_run_logs" ("id" varchar PRIMARY KEY NOT NULL, "runId" varchar NOT NULL, "stepRunId" varchar, "level" text NOT NULL DEFAULT ('log'), "message" text NOT NULL, "createdAt" datetime NOT NULL DEFAULT (datetime('now')), "seq" integer NOT NULL DEFAULT (0), "context" text, CONSTRAINT "FK_dde48478a42823e583a360dd468" FOREIGN KEY ("runId") REFERENCES "scenario_runs" ("id") ON DELETE CASCADE ON UPDATE NO ACTION, CONSTRAINT "FK_62d82b9fce3a6a2947ed1136c67" FOREIGN KEY ("stepRunId") REFERENCES "scenario_run_steps" ("id") ON DELETE SET NULL ON UPDATE NO ACTION)`,
|
||||
);
|
||||
await queryRunner.query(
|
||||
`INSERT INTO "temporary_scenario_run_logs"("id", "runId", "stepRunId", "level", "message", "createdAt", "seq") SELECT "id", "runId", "stepRunId", "level", "message", "createdAt", "seq" FROM "scenario_run_logs"`,
|
||||
);
|
||||
await queryRunner.query(`DROP TABLE "scenario_run_logs"`);
|
||||
await queryRunner.query(
|
||||
`ALTER TABLE "temporary_scenario_run_logs" RENAME TO "scenario_run_logs"`,
|
||||
);
|
||||
}
|
||||
|
||||
public async down(queryRunner: QueryRunner): Promise<void> {
|
||||
await queryRunner.query(
|
||||
`ALTER TABLE "scenario_run_logs" RENAME TO "temporary_scenario_run_logs"`,
|
||||
);
|
||||
await queryRunner.query(
|
||||
`CREATE TABLE "scenario_run_logs" ("id" varchar PRIMARY KEY NOT NULL, "runId" varchar NOT NULL, "stepRunId" varchar, "level" text NOT NULL DEFAULT ('log'), "message" text NOT NULL, "createdAt" datetime NOT NULL DEFAULT (datetime('now')), "seq" integer NOT NULL DEFAULT (0), CONSTRAINT "FK_dde48478a42823e583a360dd468" FOREIGN KEY ("runId") REFERENCES "scenario_runs" ("id") ON DELETE CASCADE ON UPDATE NO ACTION, CONSTRAINT "FK_62d82b9fce3a6a2947ed1136c67" FOREIGN KEY ("stepRunId") REFERENCES "scenario_run_steps" ("id") ON DELETE SET NULL ON UPDATE NO ACTION)`,
|
||||
);
|
||||
await queryRunner.query(
|
||||
`INSERT INTO "scenario_run_logs"("id", "runId", "stepRunId", "level", "message", "createdAt", "seq") SELECT "id", "runId", "stepRunId", "level", "message", "createdAt", "seq" FROM "temporary_scenario_run_logs"`,
|
||||
);
|
||||
await queryRunner.query(`DROP TABLE "temporary_scenario_run_logs"`);
|
||||
}
|
||||
}
|
||||
@@ -1,7 +1,8 @@
|
||||
import { Initial1790793447827 } from "./1790793447827-Initial";
|
||||
import { AddRunLogContext1790848194828 } from "./1790848194828-AddRunLogContext";
|
||||
|
||||
/**
|
||||
* All migrations, oldest first. Listed explicitly (instead of a glob) so the
|
||||
* same list works from compiled JS, ts-jest and the TypeORM CLI.
|
||||
*/
|
||||
export const MIGRATIONS = [Initial1790793447827];
|
||||
export const MIGRATIONS = [Initial1790793447827, AddRunLogContext1790848194828];
|
||||
@@ -36,6 +36,10 @@ export class ScenarioRunLogEntity {
|
||||
@Column({ type: "text", default: "log" })
|
||||
level: LogLevel;
|
||||
|
||||
// Where the message was generated, e.g. "step:2", "snippet:login", "assertion:pass"
|
||||
@Column({ type: "text", nullable: true })
|
||||
context: string | null;
|
||||
|
||||
@Column({ type: "text" })
|
||||
message: string;
|
||||
|
||||
|
||||
@@ -143,7 +143,7 @@ export class ScenarioSchedulerService implements OnModuleInit {
|
||||
statuses: ["pending", "waiting"],
|
||||
})
|
||||
.execute();
|
||||
this.persistLog(runId, null, "error", reason);
|
||||
this.persistLog(runId, null, "error", reason, "run");
|
||||
}
|
||||
|
||||
private persistLog(
|
||||
@@ -151,18 +151,19 @@ export class ScenarioSchedulerService implements OnModuleInit {
|
||||
stepRunId: string | null,
|
||||
level: "log" | "warn" | "error",
|
||||
message: string,
|
||||
context: string | null = null,
|
||||
): void {
|
||||
const seq = (this.runLogSeq.get(runId) ?? 0) + 1;
|
||||
this.runLogSeq.set(runId, seq);
|
||||
void this.runLogRepo.save(
|
||||
this.runLogRepo.create({ runId, stepRunId, level, message, seq }),
|
||||
this.runLogRepo.create({ runId, stepRunId, level, message, context, seq }),
|
||||
);
|
||||
}
|
||||
|
||||
private stepLogger(stepRunId: string, runId: string): ScriptLogger {
|
||||
return (level, msg) => {
|
||||
return (level, msg, context) => {
|
||||
this.logger[level](`StepRun #${stepRunId} script: ${msg}`);
|
||||
this.persistLog(runId, stepRunId, level, msg);
|
||||
this.persistLog(runId, stepRunId, level, msg, context ?? null);
|
||||
};
|
||||
}
|
||||
|
||||
@@ -384,6 +385,7 @@ export class ScenarioSchedulerService implements OnModuleInit {
|
||||
stepRun.id,
|
||||
"log",
|
||||
`Step ${step.order} started${step.title ? `: ${step.title}` : ""}`,
|
||||
`step:${step.order}`,
|
||||
);
|
||||
|
||||
try {
|
||||
@@ -402,6 +404,7 @@ export class ScenarioSchedulerService implements OnModuleInit {
|
||||
.browser(context)
|
||||
.code(step.execCode)
|
||||
.log(this.stepLogger(stepRun.id, stepRun.runId))
|
||||
.logContext(`step:${step.order}`)
|
||||
.getStepOutput(getStepOutput)
|
||||
.credentials(creds)
|
||||
.environment(env)
|
||||
@@ -527,6 +530,7 @@ export class ScenarioSchedulerService implements OnModuleInit {
|
||||
null,
|
||||
"log",
|
||||
"Playwright trace uploaded to run files (open with `npx playwright show-trace trace.zip` or https://trace.playwright.dev)",
|
||||
"run",
|
||||
);
|
||||
} catch (err) {
|
||||
this.logger.warn(
|
||||
@@ -557,6 +561,7 @@ export class ScenarioSchedulerService implements OnModuleInit {
|
||||
stepRun.id,
|
||||
"log",
|
||||
`Step ${stepRun.order} passed`,
|
||||
`step:${stepRun.order}`,
|
||||
);
|
||||
|
||||
// Find the next waiting step in this run (next by order)
|
||||
@@ -599,6 +604,7 @@ export class ScenarioSchedulerService implements OnModuleInit {
|
||||
stepRun.id,
|
||||
"error",
|
||||
`Step ${stepRun.order} failed: ${description}`,
|
||||
`step:${stepRun.order}`,
|
||||
);
|
||||
|
||||
await this.dumpPageOnFailure(stepRun);
|
||||
@@ -666,6 +672,7 @@ export class ScenarioSchedulerService implements OnModuleInit {
|
||||
stepRun.id,
|
||||
"log",
|
||||
`Step ${stepRun.order} failed: page dump uploaded to run files`,
|
||||
`step:${stepRun.order}`,
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -578,7 +578,12 @@ export class ScenarioService implements OnModuleInit {
|
||||
`Run ${runId} not found in scenario ${scenarioId}`,
|
||||
);
|
||||
const logs = await this.runLogRepo.find({
|
||||
where: q?.trim() ? { runId, message: Like(`%${q.trim()}%`) } : { runId },
|
||||
where: q?.trim()
|
||||
? [
|
||||
{ runId, message: Like(`%${q.trim()}%`) },
|
||||
{ runId, context: Like(`%${q.trim()}%`) },
|
||||
]
|
||||
: { runId },
|
||||
order: { seq: "ASC", createdAt: "ASC" },
|
||||
});
|
||||
return Object.assign(run, { logs });
|
||||
@@ -606,9 +611,9 @@ export class ScenarioService implements OnModuleInit {
|
||||
const escapeCsv = (value: string): string =>
|
||||
/[",\n]/.test(value) ? `"${value.replace(/"/g, '""')}"` : value;
|
||||
const rows = [
|
||||
["Timestamp", "Level", "Message"].map(escapeCsv).join(","),
|
||||
["Timestamp", "Level", "Context", "Message"].map(escapeCsv).join(","),
|
||||
...logs.map((l) =>
|
||||
[l.createdAt.toISOString(), l.level, l.message]
|
||||
[l.createdAt.toISOString(), l.level, l.context ?? "", l.message]
|
||||
.map((v) => escapeCsv(String(v)))
|
||||
.join(","),
|
||||
),
|
||||
@@ -617,7 +622,8 @@ export class ScenarioService implements OnModuleInit {
|
||||
}
|
||||
|
||||
const sections = logs.map(
|
||||
(l) => `## [${l.level}] ${l.createdAt.toISOString()}\n\n${l.message}`,
|
||||
(l) =>
|
||||
`## [${l.level}]${l.context ? ` (${l.context})` : ""} ${l.createdAt.toISOString()}\n\n${l.message}`,
|
||||
);
|
||||
return [`# Run ${runId} logs`, ...sections].join("\n\n");
|
||||
}
|
||||
|
||||
Reference in new issue
Block a user