Define an Oban worker that runs a Codex job.
A worker is a task definition; a job is one instance of it. The Codex args are
a merge of worker-level defaults (:args) and the per-job args, the job winning
on conflicts -- except worker-level :pinned_args, which win over the job (a
guardrail for keys a job must not override). That spans a spectrum from one
mechanism:
- no defaults -> the job carries everything (a bare Oban-to-Codex passthrough)
- fixed config in the worker, the variable input in the job (the common case)
- everything in the worker, an empty job -> a routine, e.g. scheduled with
Oban.Plugins.Cron
Example
defmodule MyApp.PrReview do
use ObanCodex.Worker,
queue: :review,
max_attempts: 3,
args: ObanCodex.Args.defaults(
sandbox: :read_only,
approval_policy: :never
)
@impl ObanCodex.Worker
def handle_result(result, _job) do
case ObanCodex.outcome(result) do
"blocked" -> {:cancel, :blocked}
_ -> :ok
end
end
end
# the job is just the instance:
MyApp.PrReview.new(ObanCodex.Args.new(prompt: "PR #4321: " <> diff))
|> Oban.insert()use ObanCodex.Worker accepts every Oban.Worker option (:queue,
:max_attempts, :unique, :priority, ...) plus:
:args-- a map of default Codex args, merged under each job's args (the job wins). Defaults to%{}. Build it withObanCodex.Args.defaults/1(prompt-optional; evaluates at compile time) or write the string map directly. It may reference module attributes defined beforeuse. Keys must be strings (atom keys raise at compile time -- they would otherwise be silently dropped by the string-keyed merge).:pinned_args-- a map of Codex args merged over each job's args, so these keys are worker-invariant (they win even when a job supplies the same key). Defaults to%{}; same build/key rules as:args. Precedence ispinned_args > job args > args. Use it to pin security-relevant keys a job must not override --sandbox,approval_policy, dangerous bypass switches, orworking_dir-- which matters when job args come from an external or semi-trusted source (a webhook, an exposed enqueue API).:classifier-- aObanCodex.classifier/0, the outcome -> Oban-return mapping (seeObanCodex.Outcome), forwarded toObanCodex.run/2. It must return the{oban_return, payload}envelope (e.g.{{:cancel, :blocked}, error}), not a flat verdict like{:cancel, :blocked}--run/2raises on the latter, which Oban would otherwise treat as success.:query_fun-- aObanCodex.query_fun/0, the Codex entrypoint (defaults to&ObanCodex.Query.run/2), forwarded toObanCodex.run/2; override to stub Codex in tests.
It injects a perform/1 that merges the args (pinned_args > job > args), runs
ObanCodex.run/2, calls handle_result/2 on success, and routes every
non-:ok verdict ({:error,...} / {:cancel,...} / {:snooze,...}) through
handle_error/3 with the run's payload (default: pass the verdict straight to
Oban). A deterministic args fault (a missing prompt, an unknown
enum or incompatible session options) becomes
{:cancel, {:invalid_args, message}} rather than a
raise, so a malformed stored job dead-letters at once instead of retrying to
exhaustion (the message omits the arg values). perform/1, handle_result/2,
and handle_error/3 are all overridable.
Summary
Callbacks
@callback handle_error( ObanCodex.oban_return(), ObanCodex.Error.t() | CodexWrapper.Result.t() | term(), Oban.Job.t() ) :: ObanCodex.oban_return()
Called on every non-:ok verdict, with the classifier's Oban return, the
run's payload, and the Oban.Job. The error-path mirror of handle_result/2.
The default returns oban_return unchanged -- so a worker that does not
override it behaves exactly as before (the verdict passes straight to Oban).
Override it to react to the failure with the payload in hand, which run/2's
return would otherwise drop:
- read
ObanCodex.session_id/1off a result and enqueue asession_id:continuation (see the "session-resume handoff" pattern in the Agent worker patterns guide); - make the verdict job-aware -- e.g. bound a snooze on a
job.metacounter, or dead-letter on the finaljob.attempt.
Return any ObanCodex.oban_return/0. Returning oban_return unchanged
keeps the classifier's decision; returning a different verdict overrides it.
Unlike handle_result/2, this fires for {:error, _}, {:cancel, _}, and
{:snooze, _} -- the verdict is the first argument so a clause can match on it.
@callback handle_result(CodexWrapper.Result.t(), Oban.Job.t()) :: ObanCodex.oban_return()
Called with the successful %CodexWrapper.Result{} and the Oban.Job.
Return any ObanCodex.oban_return/0. The default returns :ok. Override to
branch on ObanCodex.outcome/1, read ObanCodex.text/1 /
ObanCodex.session_id/1,
or enqueue a follow-on effector job (the "dispose" half of propose/dispose).