mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-04-26 17:30:07 +00:00
[feat] Add Jobs API infrastructure (PR 1 of 3)
Adds Jobs API types, fetchers, and new API methods without breaking existing code. This is the foundation for migrating from legacy /history and /queue endpoints to the unified /jobs endpoint. New files: - src/platform/remote/comfyui/jobs/types/jobTypes.ts - Zod schemas for Jobs API - src/platform/remote/comfyui/jobs/fetchers/fetchJobs.ts - Fetchers for /jobs endpoint - src/platform/remote/comfyui/jobs/index.ts - Barrel exports - tests-ui/tests/platform/remote/comfyui/jobs/fetchers/fetchJobs.test.ts API additions (non-breaking): - api.getQueueFromJobsApi() - Queue from /jobs endpoint - api.getHistoryFromJobsApi() - History from /jobs endpoint - api.getJobDetail() - Full job details including workflow and outputs Part of Jobs API migration. See docs/JOBS_API_MIGRATION_PLAN.md for details. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
160
src/platform/remote/comfyui/jobs/fetchers/fetchJobs.ts
Normal file
160
src/platform/remote/comfyui/jobs/fetchers/fetchJobs.ts
Normal file
@@ -0,0 +1,160 @@
|
||||
/**
|
||||
* @fileoverview Jobs API Fetchers
|
||||
* @module platform/remote/comfyui/jobs/fetchers/fetchJobs
|
||||
*
|
||||
* Unified jobs API fetcher for history, queue, and job details.
|
||||
* All distributions use the /jobs endpoint.
|
||||
*/
|
||||
|
||||
import type { ComfyWorkflowJSON } from '@/platform/workflow/validation/schemas/workflowSchema'
|
||||
import type { PromptId } from '@/schemas/apiSchema'
|
||||
|
||||
import type {
|
||||
JobDetail,
|
||||
JobListItem,
|
||||
JobStatus,
|
||||
RawJobListItem
|
||||
} from '../types/jobTypes'
|
||||
import { zJobDetail, zJobsListResponse } from '../types/jobTypes'
|
||||
|
||||
// ============================================================================
|
||||
// Job List Fetchers
|
||||
// ============================================================================
|
||||
|
||||
interface FetchJobsRawResult {
|
||||
jobs: RawJobListItem[]
|
||||
total: number
|
||||
offset: number
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetches raw jobs from /jobs endpoint
|
||||
* @internal
|
||||
*/
|
||||
async function fetchJobsRaw(
|
||||
fetchApi: (url: string) => Promise<Response>,
|
||||
statuses: JobStatus[],
|
||||
maxItems: number = 200,
|
||||
offset: number = 0
|
||||
): Promise<FetchJobsRawResult> {
|
||||
const statusParam = statuses.join(',')
|
||||
const url = `/jobs?status=${statusParam}&limit=${maxItems}&offset=${offset}`
|
||||
try {
|
||||
const res = await fetchApi(url)
|
||||
if (!res.ok) {
|
||||
console.error(`[Jobs API] Failed to fetch jobs: ${res.status}`)
|
||||
return { jobs: [], total: 0, offset: 0 }
|
||||
}
|
||||
const data = zJobsListResponse.parse(await res.json())
|
||||
return { jobs: data.jobs, total: data.pagination.total, offset }
|
||||
} catch (error) {
|
||||
console.error('[Jobs API] Error fetching jobs:', error)
|
||||
return { jobs: [], total: 0, offset: 0 }
|
||||
}
|
||||
}
|
||||
|
||||
// Large offset to ensure running/pending jobs sort above history
|
||||
const QUEUE_PRIORITY_BASE = 1_000_000
|
||||
|
||||
/**
|
||||
* Assigns synthetic priority to jobs.
|
||||
* Only assigns if job doesn't already have a server-provided priority.
|
||||
*/
|
||||
function assignPriority(
|
||||
jobs: RawJobListItem[],
|
||||
basePriority: number
|
||||
): JobListItem[] {
|
||||
return jobs.map((job, index) => ({
|
||||
...job,
|
||||
priority: job.priority ?? basePriority - index
|
||||
}))
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetches history (completed jobs)
|
||||
* Assigns synthetic priority starting from total (lower than queue jobs).
|
||||
*/
|
||||
export async function fetchHistory(
|
||||
fetchApi: (url: string) => Promise<Response>,
|
||||
maxItems: number = 200,
|
||||
offset: number = 0
|
||||
): Promise<JobListItem[]> {
|
||||
const { jobs, total } = await fetchJobsRaw(
|
||||
fetchApi,
|
||||
['completed'],
|
||||
maxItems,
|
||||
offset
|
||||
)
|
||||
// History gets priority based on total count (lower than queue)
|
||||
return assignPriority(jobs, total - offset)
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetches queue (in_progress + pending jobs)
|
||||
* Pending jobs get highest priority, then running jobs.
|
||||
*/
|
||||
export async function fetchQueue(
|
||||
fetchApi: (url: string) => Promise<Response>
|
||||
): Promise<{ Running: JobListItem[]; Pending: JobListItem[] }> {
|
||||
const { jobs } = await fetchJobsRaw(
|
||||
fetchApi,
|
||||
['in_progress', 'pending'],
|
||||
200,
|
||||
0
|
||||
)
|
||||
|
||||
const running = jobs.filter((j) => j.status === 'in_progress')
|
||||
const pending = jobs.filter((j) => j.status === 'pending')
|
||||
|
||||
// Pending gets highest priority, then running
|
||||
// Both are above any history job due to QUEUE_PRIORITY_BASE
|
||||
return {
|
||||
Running: assignPriority(running, QUEUE_PRIORITY_BASE + running.length),
|
||||
Pending: assignPriority(
|
||||
pending,
|
||||
QUEUE_PRIORITY_BASE + running.length + pending.length
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
// ============================================================================
|
||||
// Job Detail Fetcher
|
||||
// ============================================================================
|
||||
|
||||
/**
|
||||
* Fetches full job details from /jobs/{job_id}
|
||||
*/
|
||||
export async function fetchJobDetail(
|
||||
fetchApi: (url: string) => Promise<Response>,
|
||||
promptId: PromptId
|
||||
): Promise<JobDetail | undefined> {
|
||||
try {
|
||||
const res = await fetchApi(`/jobs/${promptId}`)
|
||||
|
||||
if (!res.ok) {
|
||||
console.warn(`Job not found for prompt ${promptId}`)
|
||||
return undefined
|
||||
}
|
||||
|
||||
return zJobDetail.parse(await res.json())
|
||||
} catch (error) {
|
||||
console.error(`Failed to fetch job detail for prompt ${promptId}:`, error)
|
||||
return undefined
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Extracts workflow from job detail response.
|
||||
* The workflow is nested at: workflow.extra_data.extra_pnginfo.workflow
|
||||
*/
|
||||
export function extractWorkflow(
|
||||
job: JobDetail | undefined
|
||||
): ComfyWorkflowJSON | undefined {
|
||||
// Cast is safe - workflow will be validated by loadGraphData -> validateComfyWorkflow
|
||||
const workflowData = job?.workflow as
|
||||
| { extra_data?: { extra_pnginfo?: { workflow?: unknown } } }
|
||||
| undefined
|
||||
return workflowData?.extra_data?.extra_pnginfo?.workflow as
|
||||
| ComfyWorkflowJSON
|
||||
| undefined
|
||||
}
|
||||
13
src/platform/remote/comfyui/jobs/index.ts
Normal file
13
src/platform/remote/comfyui/jobs/index.ts
Normal file
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @fileoverview Jobs API module
|
||||
* @module platform/remote/comfyui/jobs
|
||||
*
|
||||
* Unified jobs API for history, queue, and job details.
|
||||
*/
|
||||
|
||||
export {
|
||||
extractWorkflow,
|
||||
fetchHistory,
|
||||
fetchJobDetail,
|
||||
fetchQueue
|
||||
} from './fetchers/fetchJobs'
|
||||
114
src/platform/remote/comfyui/jobs/types/jobTypes.ts
Normal file
114
src/platform/remote/comfyui/jobs/types/jobTypes.ts
Normal file
@@ -0,0 +1,114 @@
|
||||
/**
|
||||
* @fileoverview Jobs API types - Backend job API format
|
||||
* @module platform/remote/comfyui/jobs/types/jobTypes
|
||||
*
|
||||
* These types represent the jobs API format returned by the backend.
|
||||
* Jobs API provides a memory-optimized alternative to history API.
|
||||
*/
|
||||
|
||||
import { z } from 'zod'
|
||||
|
||||
import { resultItemType, zTaskOutput } from '@/schemas/apiSchema'
|
||||
|
||||
// ============================================================================
|
||||
// Zod Schemas
|
||||
// ============================================================================
|
||||
|
||||
const zJobStatus = z.enum([
|
||||
'pending',
|
||||
'in_progress',
|
||||
'completed',
|
||||
'failed',
|
||||
'cancelled'
|
||||
])
|
||||
|
||||
const zPreviewOutput = z
|
||||
.object({
|
||||
filename: z.string(),
|
||||
subfolder: z.string(),
|
||||
type: resultItemType
|
||||
})
|
||||
.passthrough() // Allow extra fields like nodeId, mediaType
|
||||
|
||||
/**
|
||||
* Execution error details for error jobs.
|
||||
* Contains the same structure as ExecutionErrorWsMessage from WebSocket.
|
||||
*/
|
||||
const zExecutionError = z
|
||||
.object({
|
||||
prompt_id: z.string().optional(),
|
||||
timestamp: z.number().optional(),
|
||||
node_id: z.string(),
|
||||
node_type: z.string(),
|
||||
executed: z.array(z.string()).optional(),
|
||||
exception_message: z.string(),
|
||||
exception_type: z.string(),
|
||||
traceback: z.array(z.string()),
|
||||
current_inputs: z.unknown(),
|
||||
current_outputs: z.unknown()
|
||||
})
|
||||
.passthrough()
|
||||
|
||||
/**
|
||||
* Raw job from API - uses passthrough to allow extra fields
|
||||
*/
|
||||
const zRawJobListItem = z
|
||||
.object({
|
||||
id: z.string(),
|
||||
status: zJobStatus,
|
||||
create_time: z.number(),
|
||||
execution_start_time: z.number().nullable().optional(),
|
||||
execution_end_time: z.number().nullable().optional(),
|
||||
preview_output: zPreviewOutput.nullable().optional(),
|
||||
outputs_count: z.number().optional(),
|
||||
execution_error: zExecutionError.nullable().optional(),
|
||||
workflow_id: z.string().nullable().optional(),
|
||||
priority: z.number().optional()
|
||||
})
|
||||
.passthrough()
|
||||
|
||||
/**
|
||||
* Job detail - returned by GET /api/jobs/{job_id} (detail endpoint)
|
||||
* Includes full workflow and outputs for re-execution and downloads
|
||||
*/
|
||||
export const zJobDetail = zRawJobListItem
|
||||
.extend({
|
||||
workflow: z.unknown().optional(),
|
||||
outputs: zTaskOutput.optional(),
|
||||
update_time: z.number().optional(),
|
||||
execution_status: z.unknown().optional(),
|
||||
execution_meta: z.unknown().optional()
|
||||
})
|
||||
.passthrough()
|
||||
|
||||
/**
|
||||
* Pagination info from API
|
||||
*/
|
||||
const zPaginationInfo = z
|
||||
.object({
|
||||
offset: z.number(),
|
||||
limit: z.number(),
|
||||
total: z.number(),
|
||||
has_more: z.boolean()
|
||||
})
|
||||
.passthrough()
|
||||
|
||||
/**
|
||||
* Jobs list response structure
|
||||
*/
|
||||
export const zJobsListResponse = z
|
||||
.object({
|
||||
jobs: z.array(zRawJobListItem),
|
||||
pagination: zPaginationInfo
|
||||
})
|
||||
.passthrough()
|
||||
|
||||
// ============================================================================
|
||||
// TypeScript Types (derived from Zod schemas)
|
||||
// ============================================================================
|
||||
|
||||
export type JobStatus = z.infer<typeof zJobStatus>
|
||||
export type RawJobListItem = z.infer<typeof zRawJobListItem>
|
||||
/** Job list item with priority always set (server-provided or synthetic) */
|
||||
export type JobListItem = RawJobListItem & { priority: number }
|
||||
export type JobDetail = z.infer<typeof zJobDetail>
|
||||
Reference in New Issue
Block a user