chore(deps): update dependency oban to v2.20.1

[renovate]

This PR contains the following updates:

Package	Type	Update	Change
oban (source)	prod	minor	2.18.3 -> 2.20.1

---

Release Notes

oban-bg/oban (oban)

v2.20.1

Compare Source

Bug Fixes

• [Worker] Handle missing fields in unique Worker validation.

  Workers that specified keys without fields would fail validation at compile time. Now
  default values are considered for use Oban.Worker as well as Job.new/2.

v2.20.0

Compare Source

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.

v2.19.4

Compare Source

v2.19.3

Compare Source

v2.19.2

Compare Source

Enhancements

• [Oban] Allow setting a MFA in :get_dynamic_repo

  Anonymous functions don't work with OTP releases, as anonymous functions cannot be used in configuration. Now a MFA tuple can be passed instead of a fun, and the scaling guide recommends a function instead.

• [Cron] Include configured timezone in cron job metadata

  Along with the cron expression, stored as cron_expr, the configured timezone is also recorded as cron_tz in cron job metadata.

• [Cron] Add next_at/2 and last_at/2 for cron time calculations

  This implements jumping functions for cron expressions. Rather than naively iterating through minutes, it uses the expression values to efficiently jump to the next or last cron run time.

• [Executor] Always convert queue_time to native time unit

  The telemetry docs state that measurements are recorded in native time units. However, that hasn't been the case for queue_time for a while now. It usually worked anyway native and nanosecond is of the same resolution, but now it is guaranteed.

Bug Fixes

• [Peer] Correct leadership elections for the Dolphin engine

  MySQL always returns the number of entries attempted, even when nothing was added. The previous match caused all nodes to believe they were the leader. This uses a secondary query within the same transaction to detect if the current instance is the leader.

• [Reindexer] Drop invalid indexes concurrently when reindexing.

  The DROP INDEX query would lock the whole table with an ACCESS EXCLUSIVE lock and could cause queries to fail unexpectedly.

• [Testing] Use Ecto.Type.cast/2 for backward compatibility

  The cast!/2 function wasn't added until Ecto 3.12. This reverts time casting to use cast/2 for compatibility with earlier Ecto versions.

• [Worker] Validate that the unique option isn't an empty list.

  An empty list was accepted at compile time, but wouldn't be valid later at runtime. Now the two validations match for greater parity.

v2.19.1

Compare Source

Bug Fixes

• [Mix] Improve igniter installer idempotency and compatibility.

  The installer now uses on_exists: :skip when generating a migration, so it composes safely with other igniter installers. It also removes unnecessary add_dep calls that would overwrite a previously specified Oban version with ~> 2.18.

v2.19.0: v2.19

Compare Source

The minimum Elixir version is now v1.15. The official policy is to only support the three latest versions of Elixir.

🐬 MySQL Support

Oban officially supports MySQL with the new Dolphin engine. Oban supports modern (read "with full JSON support") MySQL versions from 8.4 on, and has been tested on the highly scalable Plantescale database.

Running on MySQL is as simple as specifying the Dolphin engine in your configuration:

config :my_app, Oban,
  engine: Oban.Engines.Dolphin,
  queues: [default: 10],
  repo: MyApp.Repo

With this addition, Oban can run in estimated 10% more Elixir applications!

⚗️ Automated Installer

Installing Oban into a new application is simplified with a new igniter powered mix task. The new oban.install task handles installing and configuring a standard Oban installation, and it will deduce the correct engine and notifier automatically based on the database adapter.

mix igniter.install oban

This oban.install task is currently the recommended way to install Oban. As a bonus, the task composes together with other igniter installers, making it possible to install phoenix, ash, oban, and other packages with a single command:

mix igniter.install phoenix ash_phoenix ash_postgres ash_oban

Look at the Mix.Oban.Install docs for full usage and options.

📔 Logging Enhancements

Logging in a busy system may be noisy due to job events, but there are other events that are particularly useful for diagnosing issues. A new events option for attach_default_logger/1 allows selective event logging, so it's possible to receive important notices such as notifier connectivity issues, without logging all job activity:

Oban.Telemetry.attach_default_logger(events: ~w(notifier peer stager)a)

Along with filtering, there are new events to make diagnosing operational problems easier.

A peer:election events logs leadership changes to indicate when nodes gain or lose leadership. Leadership issues are rare, but insidious, and make diagnosing production problems especially tricky.

[
  message: "peer became leader",
  source: "oban",
  event: "peer:election",
  node: "worker.1",
  leader: true,
  was_leader: false
]

Helpfully, plugin:stop events are now logged for all core plugins via an optional callback, and plugin:exception events are logged for all plugins regardless of whether they implement the callback. Runtime information is logged for Cron, Lifeline, Pruner, Stager, and Reindexer plugins.

For example, every time Cron runs successfully it will output details about the execution time and all of the inserted job ids:

[
  source: "oban",
  duration: 103,
  event: "plugin:stop",
  plugin: "Oban.Plugins.Cron",
  jobs: [1, 2, 3]
]

⛵️ Official JSON

Oban will default to using the official JSON module built into Elixir v1.18+ when available.

A new Oban.JSON module detects whether the official Elixir JSON module is available at compile time. If it isn't available, then it falls back to Jason, and if Jason isn't available (which is extremely rare) then it warns about a missing module.

This approach was chosen over a config option for backward compatibility because Oban will only support the JSON module once the minimum supported Elixir version is v1.18.

v2.19.0 — 2025-01-16

Enhancements

• [Oban] Start all queues in parallel on initialization.

  The midwife now starts queues using an async stream to parallelize startup and minimize boot time for applications with many queues. Previously,

• [Oban] Safely return nil from check_queue/2 when checking queues that aren't running.

  Checking on a queue that wasn't currently running on the local node now returns nil rather than causing a crash. This makes it safer to check the whether a queue is running at all without a try/catch clause.

• [Oban] Add check_all_queues/1 to gather all queue status in a single function.

  This new helper gathers the "check" details from all running queues on the local node. While it was previously possible to pull the queues list from config and call check_queue/2 on each entry, this more accurately pulls from the registry and checks each producer concurrently.

• [Oban] Add delete_job/2 and delete_all_jobs/2 operations.

  This adds Oban.delete_job/2, Oban.delete_all_jobs/2, Engine callbacks, and associated operations for all native engines. Deleting jobs is now easier and safer, due to automatic state protections.

• [Engine] Record when a queue starts shutting down

  Queue producer metadata now includes a shutdown_started_at field to indicate that a queue isn't just paused, but is actually shutting down as well.

• [Engine] Add rescue_jobs/3 callback for all engines.

  The Lifeline plugin formerly used two queries to rescue jobs—one to mark jobs with remaining attempts as available and another that discarded the remaining stuck jobs. Those are now combined into a single callback, with the base definition in the Basic engine.

  MySQL won't accept a select in an update statement. The Dolphin implementation of rescue_jobs/3 uses multiple queries to return the relevant telemetry data and make multiple updates.

• [Cron] Introduce Oban.Cron with schedule_interval/4

  The new Cron module allows processes, namely plugins, to get cron-like scheduled functionality with a single function call. This will allow plugins to removes boilerplate around parsing, scheduling, and evaluating for cron behavior.

• [Registry] Add select/1 to simplify querying for registered modules.

• [Testing] Add build_job/3 helper for easier testing.

  Extract the mechanism for verifying and building jobs out of perform_job/3 so that it's usable in isolation. This also introduces perform_job/2 for executing built jobs.

• [Telemetry] Add information on leadership changes to oban.peer.election event.

  An additional was_leader? field is included in [:oban, :peer, :election | _] event metadata to make hooking into leadership change events simpler.

• [Telemetry] Add callback powered logging for plugin events.

  Events are now logged for plugins that implement the a new optional callback, and exceptions are logged for all plugins regardless of whether they implement the callback.

  This adds logging for Cron, Lifeline, Pruner, Stager, and Reindexer.

• [Telemetry] Add peer election logging to default logger.

  The default logger now includes leadership events to make identifying the leader, and leadership changes between nodes, easier.

• [Telemetry] Add option to restrict logging to certain events.

  Logging in a busy system may be noisy due to job events, but there are other events that are particularly useful for diagnosing issues. This adds an events option to attach_default_logger/1 to allow selective event logging.

• [Telemetry] Expose default_handler_id/0 for telemetry testing.

  Simplifies testing whether the default logger is attached or detached in application code.

Chores

• [Peer] The default database-backed peer was renamed from Postgres to Database because it is also used for MySQL databases.

Bug Fixes

• [Oban] Allow overwriting all insert/* functions arities after use Oban.

• [Node] Correctly handle :node option for scale_queue/2

  Scoping scale_queue/2 calls to a single node didn't work as advertised due to some extra validation for producer meta compatibility.

• [Migration] Fix version query for databases with non-unique oid

  Use pg_catalog.obj_description(object_oid, catalog_name), introduced in PostgreSQL 7.2, to specify the pg_class catalog so only the oban_jobs description is returned.

• [Pruner] Use state specific fields when querying for prunable jobs.

  Using scheduled_at is not correct in all situations. Depending on job state, one of cancelled_at, discarded_at, or scheduled_at should be used.

• [Peer] Conditionally return the current node as leader for isolated peers.

  Prevents returning the current node name when leadership is disabled.

• [Testing] Retain time as microseconds for scheduled_at tests.

  Include microseconds in the begin and until times used for scheduled_at tests with a delta. The prior version would truncate, which rounded the until down and broke microsecond level checks.

• [Telemetry] Correct spelling of "elapsed" in oban.queue.shutdown metadata.

---

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

---

• If you want to rebase/retry this PR, check this box

---

This PR was generated by Mend Renovate. View the repository job log.