All Versions
Latest Version
Avg Release Cycle
25 days
Latest Release
42 days ago

Changelog History
Page 3

  • v2.4.0 Changes

    January 26, 2021

    ๐Ÿ”Œ Centralized Stager Plugin

    โฑ Queue producers no longer poll every second to stage scheduled jobs. Instead, ๐Ÿ”Œ the new Oban.Plugins.Stager plugin efficiently handles staging from a single location. This reduces overall load on the BEAM and PostgreSQL, allowing apps to easily run hundreds of queues simultaneously with little additional overhead.

    In a test with a single Ecto connection and 512 queues the CPU load went from 60.0% BEAM / 21.5% PostgreSQL in v2.3.4 to 0.5% BEAM / 0.0% PostgreSQL.

    ๐Ÿ”Œ The stager plugin is automatically injected into Oban instances and there isn't ๐Ÿ”ง any additional configuration necessary. However, if you've set a poll_interval ๐Ÿšš for Oban or an individual queue you can safely remove it.

    Overhauled Cron

    The CRON parser is entirely rewritten to be simpler and dramatically smaller. ๐Ÿ“œ The previous parser was built on nimble_parsec and while it was fast, the ๐Ÿ“œ compiled parser added ~5,500LOC to the code base. Thanks to a suite of property โœ… tests we can be confident that the new parser behaves identically to the ๐Ÿ“œ previous one, and has much clearer error messages when parsing fails.

    ๐Ÿ“œ Along with a new parser the crontab functionality is extracted into the ๐Ÿ”Œ Oban.Plugins.Cron plugin. For backward compatibility, top-level crontab and ๐Ÿ”Œ timezone options are transformed into a plugin declaration. If you'd like to ๐Ÿ”ง start configuring the plugin directly change your config from:

    config :my_app, Oban,
      crontab: [{"* * * * *", MyApp.Worker}],
      timezone: "America/Chicago"

    To this:

    config :my_app, Oban,
      plugins: [
         crontab: [{"* * * * *", MyApp.Worker}],
         timezone: "America/Chicago"}

    ๐Ÿ”Œ The plugin brings a cleaner implementation, simplified supervision tree, and ๐Ÿ”ง eliminates the need to set crontab: false in test configuration.

    ๐Ÿ‘Œ Improved Indexes for Unique Jobs

    ๐Ÿ‘ท Applications may have thousands to millions of completed jobs in storage. As the ๐ŸŽ table grows the performance of inserting unique jobs can slow drastically. A new V10 migration adds necessary indexes, and paired with improved query logic it alleviates insert slowdown entirely.

    ๐Ÿ‘ท For comparison, a local benchmark showed that in v2.3.4 inserting a unique job ๐Ÿ‘ท into a table of 1 million jobs runs around 4.81 IPS. In v2.4.0 it runs at 925.34 IPS, nearly 200x faster.

    The V10 migration is optional. If you decide to migrate, first create a new migration:

    mix ecto.gen.migration upgrade_oban_jobs_to_v10

    Next, call Oban.Migrations in the generated migration:

    defmodule MyApp.Repo.Migrations.UpdateObanJobsToV10 do
      use Ecto.Migration
      def up do
        Oban.Migrations.up(version: 10)
      def down do
        Oban.Migrations.down(version: 10)

    โž• Added

    • [Oban] Add [:oban, :supervisor, :init] event emitted when an Oban supervisor starts.

    • ๐Ÿ”Œ [Oban.Telemetry] Wrap built-in plugins with telemetry spans and consistently include conf in all telemetry events.

    • [Oban.Config] Improve the error messages raised during initial validation. Also, the Config module is now public with light documentation.

    • โœ… [Oban.Testing] Support specifying a default prefix for all test assertions. This comes with improved assertion messages that now include the prefix.

    • [Oban.Repo] Add delete/3 as a convenient wrapper around c:Ecto.Repo.delete/2.

    • ๐Ÿ‘ท [Oban.Job] New check constraints prevent inserting jobs with an invalid priority, negative max_attempts or an attempt number beyond the maximum.

    ๐Ÿ”„ Changed

    • ๐Ÿ—„ [Oban.Telemetry] Deprecate and replace span/3 usage in favor of the official :telemetry.span/3, which wasn't available when span/3 was implemented.

    ๐Ÿ›  Fixed

    • [Oban] Inspect the error reason for a failed insert!/2 call before it is raised as an error. When insert!/2 was called in a transaction the error could be :rollback, which wasn't a valid error.
  • v2.3.4 Changes

    December 02, 2020

    ๐Ÿ›  Fixed

    • โšก๏ธ [Oban.Worker] Update from_string/1 to correctly work with modules that weren't loaded.
  • v2.3.3 Changes

    November 10, 2020

    ๐Ÿ”„ Changed

    • ๐Ÿ‘ท [Oban.Migration] Conditionally skip altering oban_job_state if the cancelled state is already present. This allows for a smoother upgrade path for users running PG < 12. See the notes for v2.3.0 for more details.
  • v2.3.2 Changes

    November 06, 2020

    ๐Ÿ›  Fixed

    • โช [Oban.Migration] Restore indexes possibly removed by changing oban_job_state. This only applies to PG older than version 12.

    • ๐Ÿ”Œ [Oban.Plugins.Pruner] Prune cancelled jobs along with completed or discarded.

  • v2.3.1 Changes

    November 06, 2020

    ๐Ÿ”„ Changed

    • ๐Ÿ‘ท [Oban.Migration] Conditionally alter oban_job_state if the PG version is 12 or greater. This is vastly faster than the renaming, adding and dropping required for older PG versions.
  • v2.3.0 Changes

    November 06, 2020

    Migration Required (V9)

    ๐Ÿ‘ท Migration V9 brings the new cancelled state, a cancelled_at column, and job meta.

    Older versions of PostgreSQL, prior to version 12, don't allow altering an enum within a transaction. If you're running an older version and want to prevent a table rewrite you can add the new cancelled at state before running the V9 migration.

    Create a migration with @disable_ddl_transaction true declared and run the ๐Ÿ‘ท command ALTER TYPE oban_job_state ADD VALUE IF NOT EXISTS 'cancelled'. The V9 ๐Ÿ‘€ migration will see that the cancelled value exists and won't attempt to modify the enum.

    After you've sorted adding the cancelled state (or ignored the issue, because ๐Ÿ‘ท you're either running PG >= 12 or don't have many jobs retained), generate a new migration:

    mix ecto.gen.migration upgrade_oban_jobs_to_v9

    Next, call Oban.Migrations in the generated migration:

    defmodule MyApp.Repo.Migrations.UpdateObanJobsToV9 do
      use Ecto.Migration
      def up do
        Oban.Migrations.up(version: 9)
      def down do
        Oban.Migrations.down(version: 9)

    โฌ†๏ธ Oban will manage upgrading to V9 regardless of the version your application is currently using, and it will roll back a single version.

    โž• Added

    • ๐Ÿ‘ท [Oban.Job] Add new meta field for storing arbitrary job data that isn't appropriate as args.

    • ๐Ÿ‘ท [Oban.Job] Introduce a cancelled state, along with a new cancelled_at timestamp field. Cancelling a job via Oban.cancel_job (or via Oban Web) now marks the job as cancelled rather than discarded.

    • ๐Ÿ‘ท [Oban.Worker] Add from_string/1 for improved worker module resolution.

    • ๐Ÿ“‡ [Oban.Telemetry] Pass the full job schema in telemetry metadata, not only select fields. Individual fields such as args, worker, etc. are still passed for backward compatibility. However, their use is deprecated and they are no longer documented.

    ๐Ÿ›  Fixed

    • [Oban.Notifier] Fix resolution of Oban.Notifier child process in Oban.Notifier.listen/2.

    • ๐Ÿ‘ท [Oban.Queue.Producer] Fix cancelling jobs without a supervised process. In some circumstances, namely a hot code upgrade, the job's process could terminate without the producer tracking it and leave the job un-killable.

    • [Oban] Only convert invalid changesets into ChangesetError from insert!. This prevents unexpected errors when insert! is called within a transaction after the transaction has rolled back.

  • v2.2.0 Changes

    October 12, 2020

    โž• Added

    • [Oban] Replace local dynamically composed names with a registry. This dramatically simplifies locating nested children, avoids unnecessary atom creation at runtime and improves the performance of config lookups.

    • [Oban.Repo] The new Oban.Repo module wraps interactions with underlying Ecto repos. This ensures consistent prefix and log level handling, while also adding full dynamic repo support.

    The Oban.Repo wrapper should be used when authoring plugins.

    • ๐Ÿ‘ท [Oban.Job] Augment the unique keys option with replace_args, which allows enqueuing a unique job and replacing the args subsequently. For example, given a job with these args:

      %{some_value: 1, id: 123}

    Attempting to insert a new job:

    %{some_value: 2, id: 123}
    |> 10, replace_args: true unique: [keys: [:id]])
    |> Oban.insert()

    Will result in a single job with the args:

    %{some_value: 2, id: 123}
    • [Oban] Add Oban.check_queue/1,2 for runtime introspection of a queue's state. It displays a compactly formatted breakdown of the queue's configuration, a list of running jobs, and static identity information.

    • ๐Ÿ‘ท [Oban] Add Oban.retry_job/1,2, used to manually retry a discarded or retryable job.

    • ๐Ÿ“‡ [Oban.Telemetry] Include tags as part of the metadata for job events.

    ๐Ÿ”„ Changed

    • 0๏ธโƒฃ [Oban.Worker] The default backoff algorithm now includes a small amount of jitter. The jitter helps prevent jobs that fail simultaneously from repeatedly retrying together.

    ๐Ÿ›  Fixed

    • 0๏ธโƒฃ [Oban.Job] Don't include discarded state by default when accounting for uniqueness.

    • ๐Ÿ‘ [Oban.Cron] Fully support weekeday ranges in crontab expressions. Previously, given a weekday range like MON-WED the parser would only retain the MON.

  • v2.1.0 Changes

    August 21, 2020

    ๐Ÿ›  Fixed

    • โœ… [Oban.Testing] Modify the behaviour checking in perform_job/3 so that it considers all behaviours.

    • ๐Ÿ”Œ [Oban.Plugins.Pruner] Use distinct names when running multiple Oban instances in the same application.

    โž• Added

    • [Oban] In addition to the standard queue-name / limit keyword syntax it is now possible to define per-queue options such as :poll_interval, :dispatch_cooldown, :paused, and even override the :producer module.

    • ๐Ÿ‘ท [Oban] Cancelling a running job now records an error on the job if it was running at the time it was cancelled.

    • ๐Ÿ‘ท [Oban.Job] Allow using :discarded as a unique state and expose all possible states through Oban.Job.states/0.

    • ๐Ÿ‘ท [Oban.Worker] Allow returning {:discard, reason} from perform/1, where the reason is recorded in the job's errors array. If no reason is provided then a default of "None" is used. All discarded jobs will have an error now, whether discarded manually or automatically.

    • ๐Ÿ‘ท [Oban.Job] Add support for uniqueness across sub-args with the :keys attribute. This makes it possible to only use a few values from a job to determine uniqueness. For example, a job that includes a lot of metadata but must be considered unique based on a :url field can specify keys: [:url].

    ๐Ÿ”„ Changed

    • ๐Ÿ‘ท [Oban.Worker] Wrap {:error, reason} and {:discard, reason} in a proper Oban.PerformError exception with a customized message. This ensures that the :error value passed to telemetry handlers is an exception and not a raw term.

    • ๐Ÿ‘ท [Oban.Worker] Wrap job timeouts in Oban.TimeoutError with a customized message indicating the worker and timeout value. This replaces the raw :timeout atom that was reported before.

    • ๐Ÿ‘ท [Oban.Worker] Wrap caught exits and throws in Oban.CrashError with a formatted message. This means the :error value passed to telemetry is always a proper exception and easier to report.

    • ๐Ÿ‘ท [Oban.Worker] Stop reporting internal stacktraces for timeouts, discards or error tuples. The stacktrace was useless and potentially misleading as it appeared that the error originated from Oban rather than the worker module.

  • v2.0.0 Changes

    July 10, 2020

    No changes from [2.0.0-rc.3][].

  • v2.0.0-rc.3 Changes

    July 01, 2020

    ๐Ÿ›  Fixed

    • ๐Ÿ‘ป [Oban.Crontab.Cron] Do not raise an ArgumentError exception when the crontab configuration includes a step of 1, which is a valid step value.

    • [Oban.Telemetry] Correctly record duration and queue_time using native time units, but log them using microseconds. Previously they used a mixture of native and microseconds, which yielded inconsistent values.

    โž• Added

    • 0๏ธโƒฃ [Oban.Telemetry] Include job queue_time in the default logger output.

    ๐Ÿ”„ Changed

    • ๐Ÿ”Œ [Oban.Plugins.Pruner] The FixedPruner is renamed to Pruner and allows users to configure the max_age value. This partially reverses the breaking change imposed by the move from prune to the FixedPruner plugin, though there isn't any support for max_len or dynamic pruning.