# Changelog for Oban v2.20
_🌟 Looking for changes to [Oban Pro][pro]? Check the [Oban.Pro Changelog][opc] 🌟_
This release brings a fantastic new helper function, an optional migration to aid pruning, some
stability improvements, and a bevy of documentation updates.
See the [Upgrade Guide](v2-20.html) for _optional_ upgrade instructions.
## 🦋 Update Job
This introduces the `Oban.update_job/2,3` function to simplify updating existing jobs while
ensuring data consistency and safety. Previously, updating jobs required manually constructing
change operations or complex queries that could lead to race conditions or invalid state changes.
Only a curated subset of job fields, e.g. `:args`, `:max_attempts`, `:meta`, etc. may be updated
and they use the same validation rules as insertion to prevent invalid data. Updates are also
wrapped in a transaction with locking clauses to prevent concurrent modifications.
The function supports direct map changes:
```elixir
Oban.update_job(job, %{priority: 0, tags: ["urgent"]})
```
It also has a convenient function-based mode for dynamic changes:
```elixir
Oban.update_job(job, fn job ->
%{meta: Map.put(job.meta, "processed_by", current_node())}
end)
```
## ❄️ Unique State Groups
There are now named unique state groups to replace custom state lists for unique jobs, promoting
better uniqueness design and reducing configuration errors.
Previously, developers had to manually specify lists of job states for uniqueness, which was
error-prone and could lead to subtle bugs when states were omitted or incorrectly combined. The
new predefined groups ensure correctness and consistency across applications.
The new state groups are:
- **`:all`** - All job states
- **`:incomplete`** - Jobs that haven't finished (`~w(available scheduled executing retryable)a`)
- **`:scheduled`** - Only scheduled jobs (`[:scheduled]`)
- **`:successful`** - Jobs that completed successfully (`~w(available scheduled executing retryable completed)a`)
These groups eliminate the risk of accidentally creating incomplete or incorrect state lists that
could allow duplicate jobs to be created when they shouldn't be, or prevent valid job creation
when duplicates should be allowed.
## 🪺 Nested Plugin Supervision
Plugins and the internal Stager are now nested within a secondary supervision tree to improve
system resilience and stability.
Previously, plugins were supervised directly under the main Oban supervisor alongside core
process. This meant that plugin failures could potentially impact the entire Oban system, and
frequent plugin restarts could trigger cascading failures in the primary supervision tree.
The new supervisor has more lenient restart limits to allow for more plugin restart attempts
before giving up. This change makes Oban more robust in production environments where plugins may
experience transient failures due to database or connectivity issues.
## v2.20.1 — 2025-08-15
### Bug Fixes
- [Worker] Handle missing fields in unique Worker validation.
## v2.20.0 — 2025-08-13
### Enhancements
- `Migration` Add V13 migration for indexing cancelled and discarded states.
A new V13 migration adds compound indexes to significantly improve `Oban.Plugins.Pruner`
performance when cleaning up `discarded` and `cancelled` jobs. This is especially beneficial for
applications that process large volumes of jobs and retain them for extended periods.
- `Repo` Expose dynamic repo switching as `with_dynamic_repo/2`
The function was previously internal, which made impossible to use in external modules or extend
upon. Now custom plugins and extensions can use `Repo.with_dynamic_repo/2` to use the configured
dynamic repo options.
### Bug Fixes
- [Oban] Allow `insert_all/1,3` via Oban facade
The `insert_all/1` and `insert_all/3` function variants were missing from the generated Oban
facade functions when using a named instance.
- [Testing] Generate correct `perform_job/1,2,3` clauses.
The `perform_job/2,3` clauses generated by `use Oban.Testing` didn't handle the `perform_job/2`
variant designed to run jobs created with `build_job/3`. This caused test failures when trying
to execute jobs built using the `build_job/3` helper function.
The fix generates the missing `perform_job/2` clause along with a convenient `perform_job/1`
variant, ensuring all testing scenarios work seamlessly regardless of how jobs are constructed.
- [Testing] Restrict inline execution to `available` and `scheduled` states.
Jobs in the `completed` state or other non-runnable states were incorrectly attempted by the
inline engine, potentially causing errors or unexpected behavior during testing.
- [Worker] Disallow `:keys` when `:fields` doesn't contain `:args` or `:meta`
Unique job configurations using `:keys` were allowed even when `:fields` didn't include `:args`
or `:meta`, which would result in runtime errors since keys can only extract values from these
keyable fields.
- [Cron] Fix error message when the crontab has an invalid range.
Cron validation errors for invalid ranges were returning exception structs instead of readable
error messages, making it difficult to understand and fix crontab configuration issues.
[pro]: https://oban.pro
[opc]: https://oban.pro/docs/pro/changelog.html
