Skip to content

Introducing Flop and config changes

Latest
Latest

Choose a tag to compare

View all tags
@csommerauer csommerauer released this 29 Apr 16:55
v0.4.0
3fe9081
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Changelog

All notable changes to DoubleEntryLedger are documented here. The format
follows Keep a Changelog and the
project follows Semantic Versioning.

[0.4.0]

⚠️ Breaking changes

Upgrading from 0.3.x requires code and config changes. Each item below
includes the migration step.

  1. Store list functions renamed and re-shaped. Every *_list_all_*
    and get_all_accounts_* function was replaced by list_for_*, now
    paginated via Flop. Returns changed
    from [item] / {:ok, [item]} to {:ok, {[item], %Flop.Meta{}}}.

    Migrate: see the Function rename map
    and unwrap the result at every call site:

    # 0.3.x
accounts = AccountStore.get_all_accounts_by_instance_id(instance_id)
# 0.4.0
{:ok, {accounts, _meta}} = AccountStore.list_for_instance(instance_id)

  2. Pagination: offset → cursor. List functions take a flop_params
    map (%{first: n, after: cursor, filters: [...]}), not positional
    (id, page, per_page).

    Migrate: translate page/per_page to Flop's :first + :after.
    See the Before/After examples in the README.

  3. Oban instance is now named DoubleEntryLedger.Oban. Every DEL
    enqueue targets this named instance. Upgrading without updating the
    config will crash at boot (Oban registers under the default name and
    collides with any other Oban you run).

    Migrate: add name: DoubleEntryLedger.Oban to the config:

    config :double_entry_ledger, Oban,
  name: DoubleEntryLedger.Oban,
  engine: Oban.Engines.Basic,
  queues: [double_entry_ledger: 10],
  repo: MyApp.Repo

  4. Supervision shift in BYO-repo mode. When :repo is configured
    (pointing DEL at the host's repo), DEL no longer supervises Oban or
    the command queue from its own tree — the consumer must. Leaving this
    out means background work silently never runs.

    Migrate (BYO-repo only; skip if :repo is unset):

    # lib/my_app/application.ex
children = [
  MyApp.Repo,
  # …other children…
] ++ DoubleEntryLedger.children()

Added

  • config :double_entry_ledger, repo: MyApp.Repo — point DEL at the
    host application's repo (BYO-repo mode). When unset DEL falls back to
    the shipped DoubleEntryLedger.Repo.
  • DoubleEntryLedger.children/0 — child specs for consumer supervisors
    in BYO-repo mode (command queue + named Oban instance).
  • DoubleEntryLedger.Telemetry.dashboard_metrics/0 — recommended
    Telemetry.Metrics list for Phoenix LiveDashboard.

Changed

  • Pagination is powered by Flop with
    cursor-based semantics. No consumer config :flop, repo: … needed —
    DEL ships its own Flop backend internally.
  • DoubleEntryLedger.Repo is automatically supervised only in
    standalone mode (no :repo configured). In BYO-repo mode supervision
    is the consumer's responsibility via DoubleEntryLedger.children/0.
  • DoubleEntryLedger.Oban is registered as a named Oban instance so it
    coexists with any Oban the host app runs.

Removed

  • All list_all_* and get_all_accounts_* function names on the store
    modules. See the migration table in the README.
Assets 2
Loading