Changelog

Copy Markdown View Source

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

2.4.0 - 2026-07-31

Added

  • The :timeout option now accepts :infinity, for a wait that continues until its condition is met rather than giving up after a fixed budget. Such a wait can never time out, so the ! variants never raise, else clauses never run, and WaitForIt.until/2 never returns {:timeout, last_value}. (Issue #6)
  • Telemetry metadata now includes a wait_context key, which distinguishes a wait that was written directly (nil) from one a construct desugared to. A <~ clause of a with_wait reports %{construct: :with_wait, clause: index}, so its events are no longer indistinguishable from a standalone match_wait and can be attributed to a specific clause. (Issue #19)

Fixed

  • Corrected the WaitForIt.wait_opt/0 typespec, which declared :interval (and its :frequency alias) as an integer only, even though a WaitForIt.Backoff function has been accepted since 2.2.0.

2.3.0 - 2026-07-31

Added

  • Added a functional (non-macro) waiting API, WaitForIt.until/2 and WaitForIt.until!/2, for conditions that are computed at runtime or passed in as a function. until/2 returns a tagged {:ok, value} or {:timeout, last_value} result; until!/2 returns the bare value on success and raises WaitForIt.TimeoutError on timeout.

Changed

  • Clarified the "Timeout behavior" documentation to lead with the single underlying rule — on timeout, each waiting form behaves exactly as its native Elixir counterpart would on a final non-matching evaluation — and demoted the behavior matrix to a reference table (now with a native-counterpart column). Documentation only; no API or behavioral changes.

2.2.1 - 2026-06-18

Changed

  • Restructured the documentation so the README is the single source for the WaitForIt module documentation, removing the duplicated Overview page. Documentation only; no API or behavioral changes.

2.2.0 - 2026-06-18

Added

  • Added the with_wait/3 and with_wait!/3 macros for composing several waits in a with-style pipeline. Clauses use <- (ordinary one-shot match) or <~ (wait-for-match, with optional per-clause options); a <~ timeout flows to the else block like an ordinary non-match (or raises WaitForIt.TimeoutError for with_wait!). See the "Composing waits" guide.
  • Added the WaitForIt.Test module with assert_eventually/2 (truthy and pattern-binding forms), refute_eventually/2, and assert_always/2 test assertions that fail with a regular ExUnit.AssertionError (including the source expression and last value) on timeout.
  • Documented and promoted the match_wait/3 construct, and added a match_wait!/3 bang variant.
  • Added the :interval option as the preferred name for the polling interval. :frequency continues to work as an alias and is slated for removal in a future major version.

  • Added :telemetry events ([:wait_for_it, :wait, :start | :stop | :exception]) for every wait, exposing wait duration, evaluation count, and outcome.

  • Added backoff support: the :interval option now accepts a 1-arity function of the attempt number, plus a new WaitForIt.Backoff module with constant/1 and exponential/1 strategies.
  • Added guides (Waiting in tests, Polling vs signaling, Composing waits, Recipes, Telemetry) and a rewritten README.
  • Added GitHub Actions CI (test matrix, formatting, Credo, Dialyzer).

Changed

  • Rewrote the internal wait loop to use a single monotonic deadline, making timeouts immune to wall-clock adjustments and unifying the polling and signaling code paths (the polling mode no longer spawns a helper process per wait).
  • Deprecated the WaitForIt.V1 macros; they now emit deprecation warnings pointing at the current WaitForIt API and will be removed in a future major version.
  • Modernized dependencies (ex_doc, stream_data, credo).

2.1.0 - 2023--11-14

Changed

2.0.0 - 2023-11-02

Changed

1.4.0 - 2023-10-24

Added

  • Add WaitForIt.wait! macro.

[1.3.0] - 2020-04-02

Changed

  • Use DynamicSupervisor to manage condition variables.

[1.2.1] - 2019-03-14

Added

  • Add :pre_wait option to all forms of waiting.

[1.2.0] - 2019-03-08

Added

  • Add support for match clauses in else block of case_wait. (Issue #9)

1.1.1 - 2018-03-03

Added

  • Add idle timeout feature for ConditionVariable.

1.1.0 - 2017-09-02

Added

  • Add support for else clause in case_wait and cond_wait. (Issue #4)
  • Add this CHANGELOG

Changed

  • Use supervisor to manage condition variables. (Issue #5)

Fixed

1.0.0 - 2017-08-28

  • Initial release supporting wait, case_wait, and cond_wait with either polling or condition variable signaling.