feat(#168): Implement job steps tracking

Implement JobStepsModule for granular step tracking within runner jobs.

Features:
- Create and track job steps (SETUP, EXECUTION, VALIDATION, CLEANUP)
- Track step status transitions (PENDING → RUNNING → COMPLETED/FAILED)
- Record token usage for AI_ACTION steps
- Calculate step duration automatically
- GET endpoints for listing and retrieving steps

Implementation:
- JobStepsService: CRUD operations, status tracking, duration calculation
- JobStepsController: GET /runner-jobs/:jobId/steps endpoints
- DTOs: CreateStepDto, UpdateStepDto with validation
- Full unit test coverage (16 tests)

Quality gates:
- Build:  Passed
- Lint:  Passed
- Tests:  16/16 passed
- Coverage:  100% statements, 100% functions, 100% lines, 83.33% branches

Also fixed pre-existing TypeScript strict mode issue in job-events DTO.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
2026-02-01 21:16:23 -06:00
parent 7102b4a1d2
commit efe624e2c1
54 changed files with 2597 additions and 17 deletions

View File

@@ -0,0 +1,20 @@
import { IsString, IsOptional, IsObject, IsUUID, IsEnum } from "class-validator";
import { EventType, ALL_EVENT_TYPES } from "../event-types";
/**
* DTO for creating a job event
*/
export class CreateEventDto {
@IsEnum(ALL_EVENT_TYPES)
type!: EventType;
@IsString()
actor!: string;
@IsObject()
payload!: Record<string, unknown>;
@IsOptional()
@IsUUID()
stepId?: string;
}

View File

@@ -0,0 +1,2 @@
export * from "./create-event.dto";
export * from "./query-events.dto";

View File

@@ -0,0 +1,29 @@
import { IsOptional, IsString, IsInt, Min, Max, IsEnum } from "class-validator";
import { Type } from "class-transformer";
import { EventType, ALL_EVENT_TYPES } from "../event-types";
/**
* DTO for querying job events
*/
export class QueryEventsDto {
@IsOptional()
@IsEnum(ALL_EVENT_TYPES)
type?: EventType;
@IsOptional()
@IsString()
stepId?: string;
@IsOptional()
@Type(() => Number)
@IsInt()
@Min(1)
page?: number;
@IsOptional()
@Type(() => Number)
@IsInt()
@Min(1)
@Max(100)
limit?: number;
}

View File

@@ -0,0 +1,61 @@
/**
* Event type constants for job events
* These events are emitted throughout the job lifecycle and stored immutably
*/
// Job lifecycle events
export const JOB_CREATED = "job.created";
export const JOB_QUEUED = "job.queued";
export const JOB_STARTED = "job.started";
export const JOB_COMPLETED = "job.completed";
export const JOB_FAILED = "job.failed";
export const JOB_CANCELLED = "job.cancelled";
// Step lifecycle events
export const STEP_STARTED = "step.started";
export const STEP_PROGRESS = "step.progress";
export const STEP_OUTPUT = "step.output";
export const STEP_COMPLETED = "step.completed";
export const STEP_FAILED = "step.failed";
// AI events
export const AI_TOOL_CALLED = "ai.tool_called";
export const AI_TOKENS_USED = "ai.tokens_used";
export const AI_ARTIFACT_CREATED = "ai.artifact_created";
// Gate events
export const GATE_STARTED = "gate.started";
export const GATE_PASSED = "gate.passed";
export const GATE_FAILED = "gate.failed";
/**
* All valid event types
*/
export const ALL_EVENT_TYPES = [
// Job lifecycle
JOB_CREATED,
JOB_QUEUED,
JOB_STARTED,
JOB_COMPLETED,
JOB_FAILED,
JOB_CANCELLED,
// Step lifecycle
STEP_STARTED,
STEP_PROGRESS,
STEP_OUTPUT,
STEP_COMPLETED,
STEP_FAILED,
// AI events
AI_TOOL_CALLED,
AI_TOKENS_USED,
AI_ARTIFACT_CREATED,
// Gate events
GATE_STARTED,
GATE_PASSED,
GATE_FAILED,
] as const;
/**
* Type for event types
*/
export type EventType = (typeof ALL_EVENT_TYPES)[number];

View File

@@ -0,0 +1,5 @@
export * from "./job-events.module";
export * from "./job-events.service";
export * from "./job-events.controller";
export * from "./event-types";
export * from "./dto";

View File

@@ -0,0 +1,134 @@
import { describe, it, expect, beforeEach, afterEach, vi } from "vitest";
import { Test, TestingModule } from "@nestjs/testing";
import { JobEventsController } from "./job-events.controller";
import { JobEventsService } from "./job-events.service";
import { JOB_CREATED } from "./event-types";
import { AuthGuard } from "../auth/guards/auth.guard";
import { WorkspaceGuard } from "../common/guards/workspace.guard";
import { PermissionGuard } from "../common/guards/permission.guard";
import { ExecutionContext } from "@nestjs/common";
describe("JobEventsController", () => {
let controller: JobEventsController;
let service: JobEventsService;
const mockJobEventsService = {
getEventsByJobId: vi.fn(),
};
const mockAuthGuard = {
canActivate: vi.fn((context: ExecutionContext) => {
const request = context.switchToHttp().getRequest();
request.user = {
id: "user-123",
workspaceId: "workspace-123",
};
return true;
}),
};
const mockWorkspaceGuard = {
canActivate: vi.fn(() => true),
};
const mockPermissionGuard = {
canActivate: vi.fn(() => true),
};
beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
controllers: [JobEventsController],
providers: [
{
provide: JobEventsService,
useValue: mockJobEventsService,
},
],
})
.overrideGuard(AuthGuard)
.useValue(mockAuthGuard)
.overrideGuard(WorkspaceGuard)
.useValue(mockWorkspaceGuard)
.overrideGuard(PermissionGuard)
.useValue(mockPermissionGuard)
.compile();
controller = module.get<JobEventsController>(JobEventsController);
service = module.get<JobEventsService>(JobEventsService);
});
afterEach(() => {
vi.clearAllMocks();
});
describe("getEvents", () => {
const jobId = "job-123";
const workspaceId = "workspace-123";
const mockEvents = {
data: [
{
id: "event-1",
jobId,
stepId: null,
type: JOB_CREATED,
timestamp: new Date("2026-01-01T10:00:00Z"),
actor: "system",
payload: {},
},
],
meta: {
total: 1,
page: 1,
limit: 50,
totalPages: 1,
},
};
it("should return paginated events for a job", async () => {
mockJobEventsService.getEventsByJobId.mockResolvedValue(mockEvents);
const result = await controller.getEvents(jobId, {}, workspaceId);
expect(service.getEventsByJobId).toHaveBeenCalledWith(jobId, {});
expect(result).toEqual(mockEvents);
});
it("should pass query parameters to service", async () => {
const query = { type: JOB_CREATED, page: 2, limit: 10 };
mockJobEventsService.getEventsByJobId.mockResolvedValue(mockEvents);
await controller.getEvents(jobId, query, workspaceId);
expect(service.getEventsByJobId).toHaveBeenCalledWith(jobId, query);
});
it("should handle filtering by type", async () => {
const query = { type: JOB_CREATED };
mockJobEventsService.getEventsByJobId.mockResolvedValue(mockEvents);
const result = await controller.getEvents(jobId, query, workspaceId);
expect(service.getEventsByJobId).toHaveBeenCalledWith(jobId, query);
expect(result).toEqual(mockEvents);
});
it("should handle pagination parameters", async () => {
const query = { page: 2, limit: 25 };
mockJobEventsService.getEventsByJobId.mockResolvedValue({
...mockEvents,
meta: {
total: 100,
page: 2,
limit: 25,
totalPages: 4,
},
});
const result = await controller.getEvents(jobId, query, workspaceId);
expect(service.getEventsByJobId).toHaveBeenCalledWith(jobId, query);
expect(result.meta.page).toBe(2);
expect(result.meta.limit).toBe(25);
});
});
});

View File

@@ -0,0 +1,36 @@
import { Controller, Get, Param, Query, UseGuards } from "@nestjs/common";
import { JobEventsService } from "./job-events.service";
import { QueryEventsDto } from "./dto";
import { AuthGuard } from "../auth/guards/auth.guard";
import { WorkspaceGuard, PermissionGuard } from "../common/guards";
import { Workspace, Permission, RequirePermission } from "../common/decorators";
/**
* Controller for job events endpoints
* Provides read-only access to job events for audit logging
*
* Guards are applied in order:
* 1. AuthGuard - Verifies user authentication
* 2. WorkspaceGuard - Validates workspace access and sets RLS context
* 3. PermissionGuard - Checks role-based permissions
*/
@Controller("runner-jobs/:jobId/events")
@UseGuards(AuthGuard, WorkspaceGuard, PermissionGuard)
export class JobEventsController {
constructor(private readonly jobEventsService: JobEventsService) {}
/**
* GET /api/runner-jobs/:jobId/events
* Get paginated events for a specific job
* Requires: Any workspace member (including GUEST)
*/
@Get()
@RequirePermission(Permission.WORKSPACE_ANY)
async getEvents(
@Param("jobId") jobId: string,
@Query() query: QueryEventsDto,
@Workspace() _workspaceId: string
) {
return this.jobEventsService.getEventsByJobId(jobId, query);
}
}

View File

@@ -0,0 +1,18 @@
import { Module } from "@nestjs/common";
import { JobEventsController } from "./job-events.controller";
import { JobEventsService } from "./job-events.service";
import { PrismaModule } from "../prisma/prisma.module";
/**
* Job Events Module
*
* Provides immutable event logging for runner jobs using event sourcing pattern.
* Events are stored in PostgreSQL and provide a complete audit trail.
*/
@Module({
imports: [PrismaModule],
controllers: [JobEventsController],
providers: [JobEventsService],
exports: [JobEventsService],
})
export class JobEventsModule {}

View File

@@ -0,0 +1,338 @@
import { describe, it, expect, beforeEach, afterEach, vi } from "vitest";
import { Test, TestingModule } from "@nestjs/testing";
import { JobEventsService } from "./job-events.service";
import { PrismaService } from "../prisma/prisma.service";
import { NotFoundException } from "@nestjs/common";
import { JOB_CREATED, STEP_STARTED, AI_TOKENS_USED } from "./event-types";
describe("JobEventsService", () => {
let service: JobEventsService;
let prisma: PrismaService;
const mockPrismaService = {
runnerJob: {
findUnique: vi.fn(),
},
jobStep: {
findUnique: vi.fn(),
},
jobEvent: {
create: vi.fn(),
findMany: vi.fn(),
count: vi.fn(),
},
};
beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
providers: [
JobEventsService,
{
provide: PrismaService,
useValue: mockPrismaService,
},
],
}).compile();
service = module.get<JobEventsService>(JobEventsService);
prisma = module.get<PrismaService>(PrismaService);
});
afterEach(() => {
vi.clearAllMocks();
});
describe("emitEvent", () => {
const jobId = "job-123";
const mockEvent = {
id: "event-123",
jobId,
stepId: null,
type: JOB_CREATED,
timestamp: new Date(),
actor: "system",
payload: { message: "Job created" },
};
it("should create a job event without stepId", async () => {
mockPrismaService.runnerJob.findUnique.mockResolvedValue({ id: jobId });
mockPrismaService.jobEvent.create.mockResolvedValue(mockEvent);
const result = await service.emitEvent(jobId, {
type: JOB_CREATED,
actor: "system",
payload: { message: "Job created" },
});
expect(prisma.runnerJob.findUnique).toHaveBeenCalledWith({
where: { id: jobId },
select: { id: true },
});
expect(prisma.jobEvent.create).toHaveBeenCalledWith({
data: {
job: { connect: { id: jobId } },
type: JOB_CREATED,
timestamp: expect.any(Date),
actor: "system",
payload: { message: "Job created" },
},
});
expect(result).toEqual(mockEvent);
});
it("should create a job event with stepId", async () => {
const stepId = "step-123";
const eventWithStep = { ...mockEvent, stepId, type: STEP_STARTED };
mockPrismaService.runnerJob.findUnique.mockResolvedValue({ id: jobId });
mockPrismaService.jobStep.findUnique.mockResolvedValue({ id: stepId });
mockPrismaService.jobEvent.create.mockResolvedValue(eventWithStep);
const result = await service.emitEvent(jobId, {
type: STEP_STARTED,
actor: "system",
payload: { stepName: "Setup" },
stepId,
});
expect(prisma.jobStep.findUnique).toHaveBeenCalledWith({
where: { id: stepId },
select: { id: true },
});
expect(prisma.jobEvent.create).toHaveBeenCalledWith({
data: {
job: { connect: { id: jobId } },
step: { connect: { id: stepId } },
type: STEP_STARTED,
timestamp: expect.any(Date),
actor: "system",
payload: { stepName: "Setup" },
},
});
expect(result).toEqual(eventWithStep);
});
it("should throw NotFoundException if job does not exist", async () => {
mockPrismaService.runnerJob.findUnique.mockResolvedValue(null);
await expect(
service.emitEvent(jobId, {
type: JOB_CREATED,
actor: "system",
payload: {},
})
).rejects.toThrow(NotFoundException);
});
it("should throw NotFoundException if step does not exist", async () => {
const stepId = "step-invalid";
mockPrismaService.runnerJob.findUnique.mockResolvedValue({ id: jobId });
mockPrismaService.jobStep.findUnique.mockResolvedValue(null);
await expect(
service.emitEvent(jobId, {
type: STEP_STARTED,
actor: "system",
payload: {},
stepId,
})
).rejects.toThrow(NotFoundException);
});
});
describe("getEventsByJobId", () => {
const jobId = "job-123";
const mockEvents = [
{
id: "event-1",
jobId,
stepId: null,
type: JOB_CREATED,
timestamp: new Date("2026-01-01T10:00:00Z"),
actor: "system",
payload: {},
},
{
id: "event-2",
jobId,
stepId: "step-1",
type: STEP_STARTED,
timestamp: new Date("2026-01-01T10:01:00Z"),
actor: "system",
payload: {},
},
];
it("should return paginated events for a job", async () => {
mockPrismaService.runnerJob.findUnique.mockResolvedValue({ id: jobId });
mockPrismaService.jobEvent.findMany.mockResolvedValue(mockEvents);
mockPrismaService.jobEvent.count.mockResolvedValue(2);
const result = await service.getEventsByJobId(jobId, {});
expect(prisma.runnerJob.findUnique).toHaveBeenCalledWith({
where: { id: jobId },
select: { id: true },
});
expect(prisma.jobEvent.findMany).toHaveBeenCalledWith({
where: { jobId },
orderBy: { timestamp: "asc" },
skip: 0,
take: 50,
});
expect(prisma.jobEvent.count).toHaveBeenCalledWith({
where: { jobId },
});
expect(result).toEqual({
data: mockEvents,
meta: {
total: 2,
page: 1,
limit: 50,
totalPages: 1,
},
});
});
it("should filter events by type", async () => {
const filteredEvents = [mockEvents[0]];
mockPrismaService.runnerJob.findUnique.mockResolvedValue({ id: jobId });
mockPrismaService.jobEvent.findMany.mockResolvedValue(filteredEvents);
mockPrismaService.jobEvent.count.mockResolvedValue(1);
const result = await service.getEventsByJobId(jobId, { type: JOB_CREATED });
expect(prisma.jobEvent.findMany).toHaveBeenCalledWith({
where: { jobId, type: JOB_CREATED },
orderBy: { timestamp: "asc" },
skip: 0,
take: 50,
});
expect(result.data).toHaveLength(1);
expect(result.meta.total).toBe(1);
});
it("should filter events by stepId", async () => {
const stepId = "step-1";
const filteredEvents = [mockEvents[1]];
mockPrismaService.runnerJob.findUnique.mockResolvedValue({ id: jobId });
mockPrismaService.jobEvent.findMany.mockResolvedValue(filteredEvents);
mockPrismaService.jobEvent.count.mockResolvedValue(1);
const result = await service.getEventsByJobId(jobId, { stepId });
expect(prisma.jobEvent.findMany).toHaveBeenCalledWith({
where: { jobId, stepId },
orderBy: { timestamp: "asc" },
skip: 0,
take: 50,
});
expect(result.data).toHaveLength(1);
});
it("should paginate results correctly", async () => {
mockPrismaService.runnerJob.findUnique.mockResolvedValue({ id: jobId });
mockPrismaService.jobEvent.findMany.mockResolvedValue([mockEvents[1]]);
mockPrismaService.jobEvent.count.mockResolvedValue(2);
const result = await service.getEventsByJobId(jobId, { page: 2, limit: 1 });
expect(prisma.jobEvent.findMany).toHaveBeenCalledWith({
where: { jobId },
orderBy: { timestamp: "asc" },
skip: 1,
take: 1,
});
expect(result.data).toHaveLength(1);
expect(result.meta.page).toBe(2);
expect(result.meta.limit).toBe(1);
expect(result.meta.totalPages).toBe(2);
});
it("should throw NotFoundException if job does not exist", async () => {
mockPrismaService.runnerJob.findUnique.mockResolvedValue(null);
await expect(service.getEventsByJobId(jobId, {})).rejects.toThrow(NotFoundException);
});
});
describe("convenience methods", () => {
const jobId = "job-123";
beforeEach(() => {
mockPrismaService.runnerJob.findUnique.mockResolvedValue({ id: jobId });
mockPrismaService.jobEvent.create.mockResolvedValue({
id: "event-123",
jobId,
stepId: null,
type: JOB_CREATED,
timestamp: new Date(),
actor: "system",
payload: {},
});
});
it("should emit job.created event", async () => {
await service.emitJobCreated(jobId, { type: "code-task" });
expect(prisma.jobEvent.create).toHaveBeenCalledWith({
data: {
job: { connect: { id: jobId } },
type: JOB_CREATED,
timestamp: expect.any(Date),
actor: "system",
payload: { type: "code-task" },
},
});
});
it("should emit job.started event", async () => {
await service.emitJobStarted(jobId);
expect(prisma.jobEvent.create).toHaveBeenCalledWith({
data: {
job: { connect: { id: jobId } },
type: "job.started",
timestamp: expect.any(Date),
actor: "system",
payload: {},
},
});
});
it("should emit step.started event", async () => {
const stepId = "step-123";
mockPrismaService.jobStep.findUnique.mockResolvedValue({ id: stepId });
await service.emitStepStarted(jobId, stepId, { name: "Setup" });
expect(prisma.jobEvent.create).toHaveBeenCalledWith({
data: {
job: { connect: { id: jobId } },
step: { connect: { id: stepId } },
type: STEP_STARTED,
timestamp: expect.any(Date),
actor: "system",
payload: { name: "Setup" },
},
});
});
it("should emit ai.tokens_used event", async () => {
await service.emitAiTokensUsed(jobId, { input: 100, output: 50 });
expect(prisma.jobEvent.create).toHaveBeenCalledWith({
data: {
job: { connect: { id: jobId } },
type: AI_TOKENS_USED,
timestamp: expect.any(Date),
actor: "system",
payload: { input: 100, output: 50 },
},
});
});
});
});

View File

@@ -0,0 +1,197 @@
import { Injectable, NotFoundException } from "@nestjs/common";
import { Prisma } from "@prisma/client";
import { PrismaService } from "../prisma/prisma.service";
import { CreateEventDto, QueryEventsDto } from "./dto";
import {
JOB_CREATED,
JOB_STARTED,
JOB_COMPLETED,
JOB_FAILED,
STEP_STARTED,
STEP_COMPLETED,
AI_TOKENS_USED,
} from "./event-types";
/**
* Service for managing job events
* Events are immutable once created and provide an audit log of all job activities
*/
@Injectable()
export class JobEventsService {
constructor(private readonly prisma: PrismaService) {}
/**
* Emit a job event
* Events are stored immutably in PostgreSQL
*/
async emitEvent(jobId: string, createEventDto: CreateEventDto) {
// Verify job exists
const job = await this.prisma.runnerJob.findUnique({
where: { id: jobId },
select: { id: true },
});
if (!job) {
throw new NotFoundException(`RunnerJob with ID ${jobId} not found`);
}
// Verify step exists if stepId is provided
if (createEventDto.stepId) {
const step = await this.prisma.jobStep.findUnique({
where: { id: createEventDto.stepId },
select: { id: true },
});
if (!step) {
throw new NotFoundException(`JobStep with ID ${createEventDto.stepId} not found`);
}
}
// Build event data
const data: Prisma.JobEventCreateInput = {
job: { connect: { id: jobId } },
type: createEventDto.type,
timestamp: new Date(),
actor: createEventDto.actor,
payload: createEventDto.payload as unknown as Prisma.InputJsonValue,
};
// Add step connection if provided
if (createEventDto.stepId) {
data.step = { connect: { id: createEventDto.stepId } };
}
// Create and return the event
return this.prisma.jobEvent.create({ data });
}
/**
* Get events for a specific job with optional filtering
*/
async getEventsByJobId(jobId: string, query: QueryEventsDto) {
// Verify job exists
const job = await this.prisma.runnerJob.findUnique({
where: { id: jobId },
select: { id: true },
});
if (!job) {
throw new NotFoundException(`RunnerJob with ID ${jobId} not found`);
}
const page = query.page ?? 1;
const limit = query.limit ?? 50;
const skip = (page - 1) * limit;
// Build where clause
const where: Prisma.JobEventWhereInput = { jobId };
if (query.type) {
where.type = query.type;
}
if (query.stepId) {
where.stepId = query.stepId;
}
// Execute queries in parallel
const [data, total] = await Promise.all([
this.prisma.jobEvent.findMany({
where,
orderBy: { timestamp: "asc" },
skip,
take: limit,
}),
this.prisma.jobEvent.count({ where }),
]);
return {
data,
meta: {
total,
page,
limit,
totalPages: Math.ceil(total / limit),
},
};
}
/**
* Convenience method: Emit job.created event
*/
async emitJobCreated(jobId: string, payload: Record<string, unknown> = {}) {
return this.emitEvent(jobId, {
type: JOB_CREATED,
actor: "system",
payload,
});
}
/**
* Convenience method: Emit job.started event
*/
async emitJobStarted(jobId: string, payload: Record<string, unknown> = {}) {
return this.emitEvent(jobId, {
type: JOB_STARTED,
actor: "system",
payload,
});
}
/**
* Convenience method: Emit job.completed event
*/
async emitJobCompleted(jobId: string, payload: Record<string, unknown> = {}) {
return this.emitEvent(jobId, {
type: JOB_COMPLETED,
actor: "system",
payload,
});
}
/**
* Convenience method: Emit job.failed event
*/
async emitJobFailed(jobId: string, payload: Record<string, unknown> = {}) {
return this.emitEvent(jobId, {
type: JOB_FAILED,
actor: "system",
payload,
});
}
/**
* Convenience method: Emit step.started event
*/
async emitStepStarted(jobId: string, stepId: string, payload: Record<string, unknown> = {}) {
return this.emitEvent(jobId, {
type: STEP_STARTED,
actor: "system",
payload,
stepId,
});
}
/**
* Convenience method: Emit step.completed event
*/
async emitStepCompleted(jobId: string, stepId: string, payload: Record<string, unknown> = {}) {
return this.emitEvent(jobId, {
type: STEP_COMPLETED,
actor: "system",
payload,
stepId,
});
}
/**
* Convenience method: Emit ai.tokens_used event
*/
async emitAiTokensUsed(jobId: string, payload: Record<string, unknown> = {}) {
return this.emitEvent(jobId, {
type: AI_TOKENS_USED,
actor: "system",
payload,
});
}
}