ars9/liqa
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(scenarios): add timeoutSeconds to scenarios and steps

Browse Source 
- add timeoutSeconds field to scenario and step entities
- add timeoutSeconds to create/update DTOs for scenario and step
- enforce timeout via scheduler: abort run if step exceeds limit
- expose timeoutSeconds in MCP create/update scenario and step tools
- add client-side type, API, i18n, and form support for timeoutSeconds
- add integration tests for timeout persistence via REST and MCP
This commit is contained in:
ars9
2026-04-17 13:46:30 +03:00
parent 8dbd319bba
commit a50dce2755
19 changed files with 402 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
server/src/mcp/mcp.service.ts
+30 -2
View File
@@ -476,14 +476,21 @@ export class McpService {
.uuid()
.optional()
.describe("Optional linked environment ID"),
timeoutSeconds: z
.number()
.int()
.min(1)
.optional()
.describe("Scenario-level timeout in seconds (default 600)"),
},
},
async ({ name, description, environmentId }) => {
async ({ name, description, environmentId, timeoutSeconds }) => {
try {
const scenario = await this.scenarioService.create({
name,
description,
environmentId,
timeoutSeconds,
});
return {
content: [
@@ -515,14 +522,22 @@ export class McpService {
.nullable()
.optional()
.describe("Linked environment ID (null to unlink)"),
timeoutSeconds: z
.number()
.int()
.min(1)
.nullable()
.optional()
.describe("Scenario-level timeout in seconds (null to reset to default 600)"),
},
},
async ({ id, name, description, environmentId }) => {
async ({ id, name, description, environmentId, timeoutSeconds }) => {
try {
const scenario = await this.scenarioService.update(id, {
name,
description,
environmentId,
timeoutSeconds,
});
return {
content: [
@@ -580,6 +595,12 @@ export class McpService {
.string()
.optional()
.describe("Playwright JS code to execute (exec steps)"),
timeoutSeconds: z
.number()
.int()
.min(1)
.optional()
.describe("Step-level timeout in seconds (default 60, falls back to scenario timeout)"),
},
},
async ({ scenarioId, ...dto }) => {
@@ -640,6 +661,13 @@ export class McpService {
.describe("New step type"),
title: z.string().optional().describe("New step title"),
execCode: z.string().optional().describe("New exec code"),
timeoutSeconds: z
.number()
.int()
.min(1)
.nullable()
.optional()
.describe("Step-level timeout in seconds (null to reset to default)"),
},
},
async ({ scenarioId, stepId, ...dto }) => {
server/src/scenario/dto/create-scenario-step.dto.ts
+7 -1
View File
@@ -1,5 +1,5 @@
import { ApiPropertyOptional } from "@nestjs/swagger";
import { IsNotEmpty, IsOptional, IsString } from "class-validator";
import { IsInt, IsNotEmpty, IsOptional, IsString, Min } from "class-validator";
export class CreateScenarioStepDto {
@ApiPropertyOptional({ example: "Check login page title" })
@@ -12,4 +12,10 @@ export class CreateScenarioStepDto {
@IsString()
@IsNotEmpty()
execCode?: string;
@ApiPropertyOptional({ description: "Step timeout in seconds (default: 60)" })
@IsOptional()
@IsInt()
@Min(1)
timeoutSeconds?: number;
}
server/src/scenario/dto/create-scenario.dto.ts
+7 -1
View File
@@ -1,5 +1,5 @@
import { ApiProperty, ApiPropertyOptional } from "@nestjs/swagger";
import { IsNotEmpty, IsOptional, IsString, IsUUID } from "class-validator";
import { IsInt, IsNotEmpty, IsOptional, IsString, IsUUID, Min } from "class-validator";
export class CreateScenarioDto {
@ApiProperty({ example: "Login and verify cabinet" })
@@ -16,4 +16,10 @@ export class CreateScenarioDto {
@IsOptional()
@IsUUID()
environmentId?: string;
@ApiPropertyOptional({ description: "Scenario timeout in seconds (default: 600)" })
@IsOptional()
@IsInt()
@Min(1)
timeoutSeconds?: number;
}
server/src/scenario/dto/update-scenario-step.dto.ts
+6
View File
@@ -18,4 +18,10 @@ export class UpdateScenarioStepDto {
@IsString()
@IsNotEmpty()
execCode?: string;
@ApiPropertyOptional({ description: "Step timeout in seconds (null to use default of 60)" })
@IsOptional()
@IsInt()
@Min(1)
timeoutSeconds?: number | null;
}
server/src/scenario/dto/update-scenario.dto.ts
+7 -1
View File
@@ -1,5 +1,5 @@
import { ApiPropertyOptional } from "@nestjs/swagger";
import { IsNotEmpty, IsOptional, IsString, IsUUID } from "class-validator";
import { IsInt, IsNotEmpty, IsOptional, IsString, IsUUID, Min } from "class-validator";
export class UpdateScenarioDto {
@ApiPropertyOptional({ example: "Updated scenario name" })
@@ -17,4 +17,10 @@ export class UpdateScenarioDto {
@IsOptional()
@IsUUID()
environmentId?: string | null;
@ApiPropertyOptional({ description: "Scenario timeout in seconds (null to use default of 600)" })
@IsOptional()
@IsInt()
@Min(1)
timeoutSeconds?: number | null;
}
server/src/scenario/scenario-scheduler.service.ts
+55 -1
View File
@@ -40,6 +40,11 @@ export class ScenarioSchedulerService {
private readonly runSnippets = new Map<string, Record<string, string>>();
// Cache environment values per run (built once when a run starts)
private readonly runEnvironments = new Map<string, EnvironmentData>();
// Cache scenario-level timeout (seconds) per run
private readonly runScenarioTimeouts = new Map<string, number | null>();
private static readonly DEFAULT_SCENARIO_TIMEOUT_SEC = 600;
private static readonly DEFAULT_STEP_TIMEOUT_SEC = 60;
constructor(
@InjectRepository(ScenarioRunEntity)
@@ -120,6 +125,11 @@ export class ScenarioSchedulerService {
.then((env) => env?.data ?? {})
.catch(() => ({}) as EnvironmentData);
this.runEnvironments.set(run.id, environmentData);
// Cache scenario-level timeout for the run
const scenario = await this.scenarioService
.findOne(run.scenarioId)
.catch(() => null);
this.runScenarioTimeouts.set(run.id, scenario?.timeoutSeconds ?? null);
const traceId = crypto.randomUUID();
void traceStorage.run({ traceId }, () =>
this.processRunToCompletion(run.id),
@@ -128,6 +138,10 @@ export class ScenarioSchedulerService {
}
private async processRunToCompletion(runId: string): Promise<void> {
const scenarioTimeoutSec =
this.runScenarioTimeouts.get(runId) ??
ScenarioSchedulerService.DEFAULT_SCENARIO_TIMEOUT_SEC;
const scenarioDeadline = Date.now() + scenarioTimeoutSec * 1000;
try {
let stepRun = await this.runStepRepo.findOne({
where: { runId, status: "pending" },
@@ -135,6 +149,28 @@ export class ScenarioSchedulerService {
order: { order: "ASC" },
});
while (stepRun) {
if (Date.now() >= scenarioDeadline) {
this.logger.error(
`Run #${runId}: exceeded scenario timeout of ${scenarioTimeoutSec}s`,
);
this.persistLog(
runId,
null,
"error",
`Scenario timed out after ${scenarioTimeoutSec}s`,
);
await this.runRepo.update(runId, { status: "fail" });
await this.runStepRepo
.createQueryBuilder()
.update()
.set({ status: "cancelled" })
.where("runId = :runId AND status IN (:...statuses)", {
runId,
statuses: ["waiting", "pending", "in_progress"],
})
.execute();
return;
}
await this.executeStepRun(stepRun);
stepRun = await this.runStepRepo.findOne({
where: { runId, status: "pending" },
@@ -158,6 +194,7 @@ export class ScenarioSchedulerService {
this.runCredentials.delete(runId);
this.runSnippets.delete(runId);
this.runEnvironments.delete(runId);
this.runScenarioTimeouts.delete(runId);
await this.maybePreserveSession(runId);
}
}
@@ -245,7 +282,24 @@ export class ScenarioSchedulerService {
.environment(env)
.snippets(snips)
.build();
const { result: execOutput } = await this.codeExecutor.execute(execCtx);
const scenarioTimeoutSec = this.runScenarioTimeouts.get(stepRun.runId) ?? null;
const stepTimeoutSec =
step.timeoutSeconds ??
scenarioTimeoutSec ??
ScenarioSchedulerService.DEFAULT_STEP_TIMEOUT_SEC;
const stepTimeoutMs = stepTimeoutSec * 1000;
const timeoutPromise = new Promise<never>((_, reject) =>
setTimeout(
() => reject(new Error(`Step timed out after ${stepTimeoutSec}s`)),
stepTimeoutMs,
),
);
const { result: execOutput } = await Promise.race([
this.codeExecutor.execute(execCtx),
timeoutPromise,
]);
await this.passStepRun(stepRun, null, execOutput);
} catch (err) {
server/src/scenario/scenario-step.entity.ts
+3
View File
@@ -32,6 +32,9 @@ export class ScenarioStepEntity {
@Column({ type: "text", nullable: true })
execCode: string | null;
@Column({ type: "int", nullable: true })
timeoutSeconds: number | null;
@CreateDateColumn()
createdAt: Date;
server/src/scenario/scenario.entity.ts
+3
View File
@@ -26,6 +26,9 @@ export class ScenarioEntity {
@Column({ nullable: true, type: "text" })
environmentId: string | null;
@Column({ type: "int", nullable: true })
timeoutSeconds: number | null;
@ManyToOne(() => EnvironmentEntity, { nullable: true, onDelete: "SET NULL", eager: false })
@JoinColumn({ name: "environmentId" })
environment: EnvironmentEntity | null;
server/test/mcp.controller.spec.ts
+143
View File
@@ -141,4 +141,147 @@ describe("McpController", () => {
expect(result.isError).toBe(true);
});
});
// ── create_scenario / update_scenario timeoutSeconds ──────────────────────
describe("create_scenario with timeoutSeconds", () => {
it("saves timeoutSeconds on the created scenario", async () => {
const { status, rpc } = await mcpCall("create_scenario", {
name: "mcp-timeout-sc",
timeoutSeconds: 300,
});
expect(status).toBe(200);
const result = rpc.result as { content: { text: string }[] };
const created = JSON.parse(result.content[0].text) as {
name: string;
timeoutSeconds: number | null;
};
expect(created.name).toBe("mcp-timeout-sc");
expect(created.timeoutSeconds).toBe(300);
});
it("stores null timeoutSeconds when not provided", async () => {
const { rpc } = await mcpCall("create_scenario", {
name: "mcp-no-timeout",
});
const result = rpc.result as { content: { text: string }[] };
const created = JSON.parse(result.content[0].text) as {
timeoutSeconds: number | null;
};
expect(created.timeoutSeconds).toBeNull();
});
});
describe("update_scenario timeoutSeconds", () => {
it("updates and clears timeoutSeconds", async () => {
// create
const createRpc = (
await mcpCall("create_scenario", { name: "mcp-upd-timeout" })
).rpc;
const created = JSON.parse(
(createRpc.result as { content: { text: string }[] }).content[0].text,
) as { id: string };
// set
const setRpc = (
await mcpCall("update_scenario", {
id: created.id,
timeoutSeconds: 120,
})
).rpc;
const updated = JSON.parse(
(setRpc.result as { content: { text: string }[] }).content[0].text,
) as { timeoutSeconds: number | null };
expect(updated.timeoutSeconds).toBe(120);
// clear
const clearRpc = (
await mcpCall("update_scenario", {
id: created.id,
timeoutSeconds: null,
})
).rpc;
const cleared = JSON.parse(
(clearRpc.result as { content: { text: string }[] }).content[0].text,
) as { timeoutSeconds: number | null };
expect(cleared.timeoutSeconds).toBeNull();
});
});
// ── create_scenario_step / update_scenario_step timeoutSeconds ────────────
describe("create_scenario_step with timeoutSeconds", () => {
it("saves timeoutSeconds on the created step", async () => {
// create a scenario first
const scRpc = (
await mcpCall("create_scenario", { name: "mcp-step-timeout-parent" })
).rpc;
const sc = JSON.parse(
(scRpc.result as { content: { text: string }[] }).content[0].text,
) as { id: string };
const { status, rpc } = await mcpCall("create_scenario_step", {
scenarioId: sc.id,
order: 0,
type: "exec",
execCode: "return 1;",
timeoutSeconds: 45,
});
expect(status).toBe(200);
const result = rpc.result as { content: { text: string }[] };
const step = JSON.parse(result.content[0].text) as {
timeoutSeconds: number | null;
};
expect(step.timeoutSeconds).toBe(45);
});
});
describe("update_scenario_step timeoutSeconds", () => {
it("updates and clears step timeoutSeconds", async () => {
// create scenario + step
const scRpc = (
await mcpCall("create_scenario", { name: "mcp-step-upd-parent" })
).rpc;
const sc = JSON.parse(
(scRpc.result as { content: { text: string }[] }).content[0].text,
) as { id: string };
const stepRpc = (
await mcpCall("create_scenario_step", {
scenarioId: sc.id,
order: 0,
type: "exec",
})
).rpc;
const step = JSON.parse(
(stepRpc.result as { content: { text: string }[] }).content[0].text,
) as { id: string };
// set
const setRpc = (
await mcpCall("update_scenario_step", {
scenarioId: sc.id,
stepId: step.id,
timeoutSeconds: 90,
})
).rpc;
const updated = JSON.parse(
(setRpc.result as { content: { text: string }[] }).content[0].text,
) as { timeoutSeconds: number | null };
expect(updated.timeoutSeconds).toBe(90);
// clear
const clearRpc = (
await mcpCall("update_scenario_step", {
scenarioId: sc.id,
stepId: step.id,
timeoutSeconds: null,
})
).rpc;
const cleared = JSON.parse(
(clearRpc.result as { content: { text: string }[] }).content[0].text,
) as { timeoutSeconds: number | null };
expect(cleared.timeoutSeconds).toBeNull();
});
});
});
server/test/scenario.controller.spec.ts
+82
View File
@@ -81,6 +81,29 @@ describe("ScenarioController", () => {
.send({})
.expect(400);
});
it("saves timeoutSeconds when provided", async () => {
const res = await request(app.getHttpServer())
.post("/scenarios")
.send({ name: "timeout-sc", timeoutSeconds: 300 })
.expect(201);
expect(res.body.timeoutSeconds).toBe(300);
});
it("stores null timeoutSeconds when not provided", async () => {
const res = await request(app.getHttpServer())
.post("/scenarios")
.send({ name: "no-timeout-sc" })
.expect(201);
expect(res.body.timeoutSeconds).toBeNull();
});
it("returns 400 for timeoutSeconds below 1", async () => {
await request(app.getHttpServer())
.post("/scenarios")
.send({ name: "bad-timeout", timeoutSeconds: 0 })
.expect(400);
});
});
// ── GET /scenarios ─────────────────────────────────────────────────────────
@@ -181,6 +204,27 @@ describe("ScenarioController", () => {
expect(res.body.name).toBe("patched");
});
it("updates timeoutSeconds", async () => {
const sc = await createScenario("timeout-patch");
const res = await request(app.getHttpServer())
.patch(`/scenarios/${sc.id}`)
.send({ timeoutSeconds: 120 })
.expect(200);
expect(res.body.timeoutSeconds).toBe(120);
});
it("clears timeoutSeconds to null", async () => {
const created = await request(app.getHttpServer())
.post("/scenarios")
.send({ name: "clear-timeout", timeoutSeconds: 120 })
.expect(201);
const res = await request(app.getHttpServer())
.patch(`/scenarios/${created.body.id}`)
.send({ timeoutSeconds: null })
.expect(200);
expect(res.body.timeoutSeconds).toBeNull();
});
it("returns 404 for unknown id", async () => {
await request(app.getHttpServer())
.patch("/scenarios/00000000-0000-0000-0000-000000000001")
@@ -260,6 +304,24 @@ describe("ScenarioController", () => {
.expect(201);
});
it("saves timeoutSeconds on step when provided", async () => {
const sc = await createScenario();
const res = await request(app.getHttpServer())
.post(`/scenarios/${sc.id}/steps`)
.send({ execCode: "return 1;", timeoutSeconds: 45 })
.expect(201);
expect(res.body.timeoutSeconds).toBe(45);
});
it("stores null step timeoutSeconds when not provided", async () => {
const sc = await createScenario();
const res = await request(app.getHttpServer())
.post(`/scenarios/${sc.id}/steps`)
.send({ execCode: "return 1;" })
.expect(201);
expect(res.body.timeoutSeconds).toBeNull();
});
it("returns 404 for unknown scenario", async () => {
await request(app.getHttpServer())
.post("/scenarios/00000000-0000-0000-0000-000000000001/steps")
@@ -320,6 +382,26 @@ describe("ScenarioController", () => {
expect(res.body.execCode).toBe("return 99;");
});
it("updates step timeoutSeconds", async () => {
const sc = await createScenario();
const step = await createStep(sc.id);
const res = await request(app.getHttpServer())
.patch(`/scenarios/${sc.id}/steps/${step.id}`)
.send({ timeoutSeconds: 90 })
.expect(200);
expect(res.body.timeoutSeconds).toBe(90);
});
it("clears step timeoutSeconds to null", async () => {
const sc = await createScenario();
const step = await createStep(sc.id, { timeoutSeconds: 90 });
const res = await request(app.getHttpServer())
.patch(`/scenarios/${sc.id}/steps/${step.id}`)
.send({ timeoutSeconds: null })
.expect(200);
expect(res.body.timeoutSeconds).toBeNull();
});
it("returns 404 for unknown step", async () => {
const sc = await createScenario();
await request(app.getHttpServer())