AshDispatch.Notifier.Info (AshDispatch v0.5.0)

View Source

Spark Info module — reads per-action AshDispatch config persisted by the resource transformers.

Mirrors Ash.Notifier.PubSub.Info's pattern: a thin Info module that the notifier consults at runtime to find per-action config. The config is persisted into dsl_state by AshDispatch.Resource.Transformers.InjectDispatchChanges (events) and AshDispatch.Resource.Transformers.InjectCounterBroadcasts (counters), then read back via Spark.Dsl.Extension.get_persisted/3.

Persisted keys

  • :ash_dispatch_dispatch_events — %{action_name => [event_config, ...]}
  • :ash_dispatch_counter_broadcasts — %{action_name => [counter_config, ...]}

Both keys default to %{} when absent (resource without dispatch events / counters), and per-action lookups default to [].

Summary

Types

counter_config()

Per-action counter-config list — one entry per counter ... do ... end block targeting the action.

event_config()

Per-action event-config list — one entry per event ... do ... end block targeting the action.

Functions

all_counter_broadcasts(resource)

Full counter-broadcasts map for resource keyed by action name.

all_dispatch_events(resource)

Full dispatch-events map for resource keyed by action name. Useful for introspection / admin tooling.

counter_broadcasts_for(resource, action_name)

All counter broadcasts triggered by action_name on resource. Returns [] when none are registered.

dispatch_events_for(resource, action_name)

All dispatch events triggered by action_name on resource. Returns [] when none are registered.

Types

counter_config()

@type counter_config() :: %{
  :counter_name => atom(),
  :resource => module(),
  :query_filter => term(),
  :audience => atom(),
  :invalidates => list(),
  optional(any()) => any()
}

Per-action counter-config list — one entry per counter ... do ... end block targeting the action.

event_config()

@type event_config() :: %{event_id: String.t(), load: term(), event_config: map()}

Per-action event-config list — one entry per event ... do ... end block targeting the action.

Functions

all_counter_broadcasts(resource)

@spec all_counter_broadcasts(module()) :: %{required(atom()) => [counter_config()]}

Full counter-broadcasts map for resource keyed by action name.

all_dispatch_events(resource)

@spec all_dispatch_events(module()) :: %{required(atom()) => [event_config()]}

Full dispatch-events map for resource keyed by action name. Useful for introspection / admin tooling.

counter_broadcasts_for(resource, action_name)

@spec counter_broadcasts_for(module(), atom()) :: [counter_config()]

All counter broadcasts triggered by action_name on resource. Returns [] when none are registered.

dispatch_events_for(resource, action_name)

@spec dispatch_events_for(module(), atom()) :: [event_config()]

All dispatch events triggered by action_name on resource. Returns [] when none are registered.