screencastgen

useJobProgress Hook

Real-time job progress tracking via Server-Sent Events.

Source: web/frontend/src/hooks/useJobProgress.ts

---

Signature

useJobProgress(jobId: string | undefined, enabled: boolean): ProgressEvent | null

Parameters:

Param	Type	Description
jobId	string \| undefined	Job to track
enabled	boolean	Whether to open the SSE connection

Returns: Current ProgressEvent or null

---

Behavior

1. When enabled is true and jobId is set, opens an EventSource to /api/jobs/{jobId}/events
2. Listens for progress events — parses JSON and updates state
3. Listens for done events — final update, then closes connection
4. Closes on error
5. Cleans up connection on unmount or when disabled

---

Event Types

SSE Event	Action
progress	Update ProgressEvent state
done	Update state + close connection
error	Close connection

---

ProgressEvent Shape

{
  job_id: string
  status: string
  phase: string
  current: number
  total: number
  message: string
  data?: {
    event: "page_start" | "page_progress" | "page_done"
    page: number
    completed: number
    total: number
    elapsed?: number
    seconds?: number
    page_times?: Array<{ page: number; seconds: number }>
  } | null
}

---

Consumer

Used by JobDetail Page to show real-time progress.

---

Backend

Connects to Events Router SSE endpoint.

---

See Also

• Events Router — SSE server endpoint
• Progress Reporter — Publishes events to Redis
• JobDetail Page — Uses this hook
• ProgressBar Component — Displays the progress

This site is open source. Improve this page.