hecks 1.4.0 → 1.5.0

data/lib/hecks/runtime/loader.rb

@@ -37,6 +37,20 @@ module Hecks
       # its own env var name and passes the resulting string straight
       # through, e.g. `Hecks.boot(path, environment:
       # ENV.fetch("MYAPP_ENV", "development"))`.
+      #
+      # @param path [String] a domain directory to boot, resolved through
+      #   `Ports::Loading#bluebook_directory`
+      # @param shared [String, nil] an explicit shared ports/adapters root override; nil
+      #   resolves it by walking up from the domain directory
+      # @param install_facade [Boolean] whether to install the `Widget::Item.Add(...)`
+      #   facade sugar
+      # @param environment [String, nil] the environment overlay to load after the
+      #   domain's own files (e.g. `"production"`); nil loads none
+      # @return [Runtime::Dispatcher, Runtime::RemoteDispatcher] the booted dispatcher
+      # @raise [Errno::ENOENT] if `path` names neither a domain directory nor one holding
+      #   a `bluebook/` subdirectory
+      # @raise [Runtime::WiringError] if a boot gate finds a wiring problem (an undeclared
+      #   bind, a compute/rekey rule with no persistence plugin loaded, …)
       def self.boot(path, shared: nil, install_facade: true, environment: nil)
         loading   = Ports::Loading.bootstrap
         directory = loading.bluebook_directory(path)
@@ -52,6 +66,7 @@ module Hecks
         run_boot_gates!(registry, directory)
         dispatcher = dispatcher_for(registry)
         redrive_outbox!(dispatcher)
+        seed_privacy_markings!(dispatcher, registry)
         install_facade ? bind_runtime(dispatcher) : dispatcher
       end
 
@@ -63,12 +78,43 @@ module Hecks
       # provably never started; `claimed` rows are surfaced, never
       # auto-redriven — see `Runtime::Outbox`. A remote dispatcher has
       # no local stores to scan.
+      #
+      # @param dispatcher [Runtime::Dispatcher, Runtime::RemoteDispatcher] the
+      #   just-booted dispatcher; a no-op unless it exposes an `outbox`
+      # @return [void]
       def self.redrive_outbox!(dispatcher)
         return unless dispatcher.respond_to?(:outbox)
 
         dispatcher.outbox.redrive!
       end
 
+      # Turns every `.hecksagon`-declared `AggregateDoor#mark_sensitive` fact into a real
+      # `Privacy::Marking.Mark` — after the dispatcher exists (dispatch needs a bound
+      # repository), idempotent across reboots (a marking already present is never
+      # re-dispatched, the same "provably never started" restraint `redrive_outbox!`
+      # holds itself to above). A no-op when nothing declared one, or when the domain
+      # never attached Privacy at all.
+      #
+      # @param dispatcher [Runtime::Dispatcher, Runtime::RemoteDispatcher] the just-booted
+      #   dispatcher `Privacy::Marking.Mark` dispatches through
+      # @param registry [Runtime::Registry] the just-booted registry `pending_privacy_markings`
+      #   was recorded on
+      # @return [void]
+      def self.seed_privacy_markings!(dispatcher, registry)
+        return if registry.pending_privacy_markings.empty?
+        return unless registry.bluebook("Privacy")
+
+        already_marked_by_domain = registry.pending_privacy_markings.map { |marking| marking[:domain] }.uniq.to_h do |domain|
+          [domain, dispatcher.query("Privacy::Marking.ForDomain", domain: domain).map { |row| row[:attribute_path][:value] }]
+        end
+
+        registry.pending_privacy_markings.each do |marking|
+          next if already_marked_by_domain[marking[:domain]].include?(marking[:attribute_path])
+
+          dispatcher.dispatch_flat("Privacy::Marking.Mark", marking)
+        end
+      end
+
       # The explicit-file form — `paths` names the exact bluebook/hecksagon/
       # world files to boot, in place, wherever they actually live. `boot`
       # above only ever takes a directory and globs it; that is the right
@@ -91,6 +137,18 @@ module Hecks
       # first real path in `paths` — genuinely on disk, not a copy — so
       # every downstream path (`EraCheck`, `persisted_by`, `shared_root`)
       # resolves exactly as an ordinary directory boot's would.
+      #
+      # @param paths [Array<String>, String] the exact bluebook/hecksagon/world file paths
+      #   to boot, in the order they should load
+      # @param shared [String, nil] an explicit shared ports/adapters root override; nil
+      #   resolves it by walking up from `File.dirname` of the first path
+      # @param install_facade [Boolean] whether to install the `Widget::Item.Add(...)`
+      #   facade sugar
+      # @param environment [String, nil] the environment overlay to load after the
+      #   named files (e.g. `"production"`); nil loads none
+      # @return [Runtime::Dispatcher, Runtime::RemoteDispatcher] the booted dispatcher
+      # @raise [Runtime::WiringError] if a boot gate finds a wiring problem (an undeclared
+      #   bind, a compute/rekey rule with no persistence plugin loaded, …)
       def self.boot_files(paths, shared: nil, install_facade: true, environment: nil)
         loading   = Ports::Loading.bootstrap
         files     = Array(paths).map { |path| File.expand_path(path) }
@@ -109,9 +167,11 @@ module Hecks
         install_facade ? bind_runtime(dispatcher) : dispatcher
       end
 
-      # ADR 0031 — replaces two previously-hardcoded, unconditional calls
-      # with a per-boot `BootGates` instance holding exactly the gates this
-      # registry's own bound adapters have a capability for. Ordering is
+      # Runs every registered boot gate against `registry`, in order.
+      #
+      # ADR 0031 — a per-boot `BootGates` instance holds exactly the gates this
+      # registry's own bound adapters have a capability for, rather than two
+      # hardcoded, unconditional calls. Ordering is
       # preserved: era-checking (when a persistence plugin contributes one)
       # still runs before `verify!`, saga rehydration still runs after
       # (conservative — see `SagaPersistence#rehydrate_sagas!`'s own
@@ -124,6 +184,13 @@ module Hecks
       # `:post_verify` gates generically; `:saga_rehydration` is the one
       # gate core still registers directly, because ADR 0031 already
       # proved it's not era-specific.
+      #
+      # @param registry [Runtime::Registry] the registry mid-boot, with its bluebooks,
+      #   hecksagons, ports, adapters and worlds already loaded
+      # @param directory [String] the domain directory the gates report against in a refusal
+      # @return [Runtime::BootGates] the gates instance built and run for this boot
+      # @raise [Runtime::WiringError] if `registry.verify!` or any contributed gate finds
+      #   a wiring problem
       def self.run_boot_gates!(registry, directory)
         gates = BootGates.new
         Ports::Persistence.each_plugin { |plugin| plugin.contribute_boot_gates(registry, gates) }
@@ -149,6 +216,12 @@ module Hecks
       # the real, adapter-aware version of this check and refuses by name
       # ("...is bound to Memory") long before this ever would; this only
       # fires when nothing did, because nothing was loaded to.
+      #
+      # @param registry [Runtime::Registry] the registry mid-boot, whose declared
+      #   `translations` are checked
+      # @return [void]
+      # @raise [Runtime::WiringError] if any translation declares a `computes`/`rekeys`
+      #   rule while no persistence plugin is loaded to interpret it
       def self.check_compute_rules_backstop!(registry)
         return if Ports::Persistence.plugins_loaded?
 
@@ -183,6 +256,12 @@ module Hecks
       # this landed. A domain opts in explicitly, the same way
       # `persisted_by("PostgresEra")` is never inferred from anything
       # else either.
+      #
+      # @param registry [Runtime::Registry] the just-booted registry, whose just-booted
+      #   domain's `.world` is checked for `dispatched_by("Lambda")`
+      # @return [Runtime::Dispatcher, Runtime::RemoteDispatcher] a `RemoteDispatcher`
+      #   bound to `registry` if the domain declares `dispatched_by("Lambda")`, a plain
+      #   `Dispatcher` otherwise
       def self.dispatcher_for(registry)
         domain = registry.bluebooks.keys.first
         settings = registry.world(domain)&.for_verb("dispatched_by") || {}
@@ -191,11 +270,18 @@ module Hecks
         RemoteDispatcher.new(registry, region: settings.fetch(:region, "us-east-1"), function: settings[:function])
       end
 
-      # The door is installed here, not stamped. This used to write the
-      # dispatcher onto every aggregate's class (`ruby_class.runtime =`) — the
-      # class-level global that made two boots in one process share one
-      # name. The facade's modules close over this dispatcher instead, so the
-      # binding lives in the surface a boot installs, not on anything shared.
+      # Installs the facade sugar (`Widget::Item.Add(...)`), closed over
+      # `dispatcher`, and hands `dispatcher` back.
+      #
+      # The door is installed here, not stamped: the facade's modules close
+      # over this dispatcher, so the binding lives in the surface a boot
+      # installs rather than in a class-level global (`ruby_class.runtime =`
+      # on every aggregate's class) that would make two boots in one process
+      # share one name.
+      #
+      # @param dispatcher [Runtime::Dispatcher, Runtime::RemoteDispatcher] the
+      #   just-booted dispatcher the facade should call into
+      # @return [Runtime::Dispatcher, Runtime::RemoteDispatcher] `dispatcher`, unchanged
       def self.bind_runtime(dispatcher)
         Facade::Surface.install(dispatcher)
         dispatcher

data/lib/hecks/runtime/outbox.rb

@@ -13,7 +13,9 @@ module Hecks
     # outbound port operation) the external effects those reactions
     # cause. `future-features.md` item 8, built.
     #
-    # **The shape**. One row per (event, consumer). A consumer is a named
+    # ## The shape
+    #
+    # One row per (event, consumer). A consumer is a named
     # policy or process manager that would react to the event — resolved
     # at enqueue time from the registry (`Fanout`), so the outbox records
     # who was owed what, not just that an event happened. Rows move
@@ -33,18 +35,22 @@ module Hecks
     #              tracks delivery, not the domain's answer.
     #   failed     the consumer raised a defect (non-refusal error).
     #
-    # **Delivery is inline by default** — the dispatcher drains the rows it
+    # ## Delivery is inline by default
+    #
+    # The dispatcher drains the rows it
     # just wrote, in the same call, in the order C10.2 fixes (per event
     # in `emits` order: that event's policy rows, then its saga rows —
     # the emitting domain's own policies before other domains'). Nothing about the
     # happy path is deferred or asynchronous; a caller still sees every
     # reaction settled when `dispatch` returns. What changes is the
-    # crash window: a process that dies between commit and reaction
-    # used to lose the reaction silently. Now the row survives, and
-    # `Relay#redrive!` — run at boot by `Loader.run_boot_gates!` —
+    # crash window: without a durable row, a process that dies between
+    # commit and reaction loses the reaction silently. The row survives,
+    # and `Relay#redrive!` — run at boot by `Loader.run_boot_gates!` —
     # finds it.
     #
-    # **What redrive does, and deliberately doesn't**. A `pending` row is
+    # ## What redrive does, and deliberately doesn't
+    #
+    # A `pending` row is
     # redriven: its consumer provably never started (claiming is the
     # first thing delivery does), so running it now is exactly-once by
     # construction. A `claimed` row is not auto-redriven: the consumer
@@ -57,7 +63,9 @@ module Hecks
     # unique per store, so a re-enqueue of the same fact to the same
     # consumer is a no-op rather than a second row.
     #
-    # **Which adapters**. Memory (in-process rows — visible to specs,
+    # ## Which adapters
+    #
+    # Memory (in-process rows — visible to specs,
     # gone with the process, exactly like everything else Memory holds),
     # Sqlite and Postgres (a `hecks_outbox` table in the aggregate's own
     # database — the only way the enqueue can share the save's
@@ -71,13 +79,30 @@ module Hecks
 
       Row = Struct.new(:id, :delivery_id, :event_uid, :aggregate, :domain, :kind, :consumer, :event,
                        :status, :attempts, :error, keyword_init: true) do
+        # Reports whether this row is still waiting to be claimed.
+        #
+        # @return [Boolean] true if this row's status is `"pending"`
         def pending?   = status == "pending"
+
+        # Reports whether this row's consumer is currently running.
+        #
+        # @return [Boolean] true if this row's status is `"claimed"`
         def claimed?   = status == "claimed"
+
+        # Reports whether this row's consumer ran to completion.
+        #
+        # @return [Boolean] true if this row's status is `"delivered"`
         def delivered? = status == "delivered"
+
+        # Reports whether this row's consumer raised a defect.
+        #
+        # @return [Boolean] true if this row's status is `"failed"`
         def failed?    = status == "failed"
 
         # Wire-shaped — what an adapter persists. `event` is the event's
         # own `to_h` plus correlation; `Row.event_from` reverses it.
+        #
+        # @return [Hash{Symbol => Object}] this row's own fields, keyed by name
         def to_h
           { id: id, delivery_id: delivery_id, event_uid: event_uid, aggregate: aggregate, domain: domain,
             kind: kind, consumer: consumer, event: event, status: status, attempts: attempts, error: error }
@@ -89,6 +114,12 @@ module Hecks
 
       module_function
 
+      # Renders an event as the wire-shaped Hash an outbox row's own `event`
+      # field stores.
+      #
+      # @param event [Runtime::Event] the event to serialize
+      # @return [Hash{Symbol => Object}] `event`'s own `to_h`, with `correlation`
+      #   merged in
       def serialize_event(event)
         event.to_h.merge(correlation: event.correlation)
       end
@@ -96,11 +127,21 @@ module Hecks
       # The emitting domain's own bluebook first, then the rest in load
       # order (C10.2) — the one policy ordering both `PolicyInterpreter#
       # policies_for` and `Fanout.policies` read.
+      #
+      # @param registry [Runtime::Registry] the booted registry whose loaded
+      #   bluebooks are ordered
+      # @param domain [String, Symbol] the emitting domain, sorted first
+      # @return [Array<Bluebook::Chapter>] every loaded chapter, `domain`'s own first
       def bluebooks_home_first(registry, domain)
         home, others = registry.bluebooks.each_value.partition { |bluebook| bluebook.name == domain }
         home + others
       end
 
+      # Rebuilds a frozen event from an outbox row's own stored `event` field.
+      #
+      # @param hash [Hash{String, Symbol => Object}] the wire-shaped event Hash,
+      #   as `serialize_event` built it (String or Symbol keys either way)
+      # @return [Runtime::Event] the rebuilt, frozen event
       def event_from(hash)
         hash = hash.transform_keys(&:to_sym)
         Event.new(
@@ -113,6 +154,12 @@ module Hecks
         ).emit!
       end
 
+      # Recursively symbolizes every Hash key reachable from `value`.
+      #
+      # @param value [Object] the value to symbolize; typically a Hash or Array,
+      #   possibly nested
+      # @return [Object] `value` with every Hash key (at any depth) turned into a
+      #   Symbol; a non-Hash, non-Array value passes through unchanged
       def deep_symbolize(value)
         case value
         when Hash  then value.to_h { |k, v| [k.to_sym, deep_symbolize(v)] }
@@ -137,6 +184,12 @@ module Hecks
         # this consumer".
         # Row order is delivery order (C10.2): per event, in `emits`
         # order — that event's policy rows, then its saga rows.
+        #
+        # @param registry [Runtime::Registry] the booted registry every candidate
+        #   consumer is resolved against
+        # @param events [Array<Runtime::Event>] the just-emitted events to build rows for
+        # @param domain [String, Symbol] the emitting domain
+        # @return [Array<Runtime::Outbox::Row>] one pending row per (event, consumer)
         def rows_for(registry, events, domain)
           uids = events.to_h { |event| [event, SecureRandom.uuid] }
           events.flat_map do |event|
@@ -144,6 +197,16 @@ module Hecks
           end
         end
 
+        # Builds one pending row per policy `event` triggers.
+        #
+        # @param registry [Runtime::Registry] the booted registry policies are
+        #   resolved against
+        # @param event [Runtime::Event] the just-emitted event
+        # @param domain [String, Symbol] the emitting domain
+        # @param uid [String] this event's own enqueue-time UID, shared by every row
+        #   built for it
+        # @return [Array<Runtime::Outbox::Row>] one pending row per matching policy,
+        #   emitting domain's own bluebook first
         def policies(registry, event, domain, uid)
           emitting = Naming.demodulise(event.aggregate)
           Outbox.bluebooks_home_first(registry, domain).flat_map do |bluebook|
@@ -159,6 +222,18 @@ module Hecks
           end
         end
 
+        # Builds one pending row per process manager `event` advances, in `domain`
+        # only (a saga never reacts across domains).
+        #
+        # @param registry [Runtime::Registry] the booted registry process managers
+        #   are resolved against
+        # @param event [Runtime::Event] the just-emitted event
+        # @param domain [String, Symbol] the domain whose declared process managers
+        #   are checked
+        # @param uid [String] this event's own enqueue-time UID, shared by every row
+        #   built for it
+        # @return [Array<Runtime::Outbox::Row>] one pending row per process manager
+        #   `event` starts, ends, or advances
         def sagas(registry, event, domain, uid)
           bluebook = registry.bluebook(domain)
           return [] unless bluebook
@@ -170,6 +245,13 @@ module Hecks
           end
         end
 
+        # Reports whether `event` starts, ends, or advances `process_manager`.
+        #
+        # @param process_manager [Bluebook::ProcessManager] the declared process
+        #   manager to check
+        # @param event [Runtime::Event] the just-emitted event
+        # @return [Boolean] true if `event` names `process_manager`'s own
+        #   `starts_on`, `ends_on`, or a declared handler
         def listens?(process_manager, event)
           process_manager.starts_on == event.name || process_manager.ends_on == event.name ||
             !process_manager.handler_for(event.name).nil?
@@ -179,6 +261,14 @@ module Hecks
         # operation — the row is the durable record that an external
         # call was owed, claimed right before the adapter is asked and
         # settled right after. Everything else is a plain "reaction".
+        #
+        # @param registry [Runtime::Registry] the booted registry the trigger's own
+        #   aggregate/port are resolved against
+        # @param policy [Bluebook::Policy] the policy whose trigger is classified
+        # @param home_domain [String, Symbol] the domain `policy` is declared in,
+        #   used when `policy` declares no `target_domain`
+        # @return [String] `"effect"` when the trigger resolves to an outbound port
+        #   operation, `"reaction"` otherwise
         def kind_for(registry, policy, home_domain)
           target = "#{policy.target_domain || home_domain}::#{policy.trigger_command}"
           parsed = Naming.split_verb(target)
@@ -204,11 +294,16 @@ module Hecks
         # by the Rust kernel (`spec/rust_conformance_spec.rb`); this is
         # an additive, Ruby-only log, the same rule `saga_dispatch_log`
         # and `policy_dispatch_log` already follow.
+        #
+        # @param registry [Runtime::Registry] the booted registry this relay drains
+        #   rows for
         def initialize(registry)
           @registry = registry
           @log      = []
         end
 
+        # Attaches the interpreters a delivered row's own consumer runs through.
+        #
         # A Dispatcher hands over the interpreters a consumer runs
         # through (`Dispatcher#initialize`). Until then this relay can
         # enqueue (that needs only the registry) but not deliver — and
@@ -216,20 +311,38 @@ module Hecks
         # to. The registry holds one relay for its lifetime; a second
         # dispatcher fronting the same registry re-attaches, which is
         # fine because both dispatchers share every log and store.
+        #
+        # @param policies [Runtime::PolicyInterpreter] the interpreter a `"policy:"`
+        #   consumer reacts through
+        # @param sagas [Runtime::SagaInterpreter] the interpreter a `"saga:"` consumer
+        #   advances through
+        # @return [Runtime::Outbox::Relay] self
         def attach(policies:, sagas:)
           @policies = policies
           @sagas    = sagas
           self
         end
 
+        # Reports whether a dispatcher has attached its interpreters.
+        #
+        # @return [Boolean] true once `attach` has run
         def attached? = !@policies.nil?
 
+        # Writes one pending row per (event, consumer) `events` owes a reaction to.
+        #
         # Called inside the save transaction by `Interpreting` for the
         # command/entity paths, and outside one by `Dispatcher` for port
         # operations (which save nothing, so there is no transaction to
         # share). Returns the rows as stored (ids assigned), or nil when
         # the repository has no outbox — the dispatcher then reacts
         # directly, exactly as before.
+        #
+        # @param repository [Persistence::AppendOnly] the repository whose store the
+        #   rows are enqueued into; a no-op unless it has an outbox
+        # @param events [Array<Runtime::Event>] the events this dispatch just emitted
+        # @param domain [String, Symbol] the emitting domain
+        # @return [Array<Runtime::Outbox::Row>, nil] the stored rows, `id` assigned;
+        #   `nil` when `repository` has no outbox; `[]` when `events` is empty
         def enqueue(repository, events, domain)
           return nil unless repository.outbox?
           return [] if events.empty?
@@ -241,6 +354,15 @@ module Hecks
 
         # Drain the rows a dispatch just committed. `rows` nil means "no
         # outbox here" — react directly, the pre-outbox path.
+        #
+        # @param rows [Array<Runtime::Outbox::Row>, nil] the just-enqueued rows to
+        #   deliver; nil to react directly instead (no outbox on this repository)
+        # @param events [Array<Runtime::Event>] the events this dispatch just emitted,
+        #   read when `rows` is nil
+        # @param domain [String, Symbol] the emitting domain
+        # @param repository [Persistence::AppendOnly] the repository `rows` were
+        #   enqueued into
+        # @return [void]
         def deliver(rows, events, domain, repository)
           if rows.nil?
             # Per event, in `emits` order — its policies, then its sagas
@@ -258,6 +380,11 @@ module Hecks
 
         # One row: claim, run its consumer, settle. A claim that fails
         # means another relay (or this one, re-entrantly) already has it.
+        #
+        # @param row [Runtime::Outbox::Row] the row to claim and deliver
+        # @param repository [Persistence::AppendOnly] the repository `row` is stored in
+        # @return [Boolean] true when this call claimed and delivered `row`; false
+        #   when the claim failed, or the consumer raised a defect (recorded on `log`)
         def deliver_row(row, repository)
           return false unless repository.outbox_claim(row.id)
 
@@ -283,13 +410,24 @@ module Hecks
         end
 
         # Every row in every bound store, newest last. `status:` narrows.
+        #
+        # @param status [String, Symbol, nil] keep only rows with this status; nil
+        #   for every row
+        # @return [Array<Runtime::Outbox::Row>] copies of the matching rows, across
+        #   every store with an outbox
         def rows(status: nil)
           stores.flat_map { |repository| repository.outbox_rows(status: status) }
         end
 
+        # Runs the boot-time reconciliation over every bound store.
+        #
         # **Boot-time reconciliation**. Redrives `pending` rows (never
         # claimed — safe by construction); surfaces `claimed` rows and
         # redrives them only when told to (`claimed: true`).
+        #
+        # @param claimed [Boolean] whether to also redrive `claimed` rows (an
+        #   explicit operator decision); false leaves them surfaced and untouched
+        # @return [Array<Runtime::Outbox::Row>] every row this call actually delivered
         def redrive!(claimed: false)
           redriven = []
           stores.each do |repository|

data/lib/hecks/runtime/policy_interpreter.rb

@@ -16,11 +16,18 @@ module Hecks
     class PolicyInterpreter
       attr_reader :registry
 
+      # @param registry [Runtime::Registry] the booted registry whose loaded
+      #   bluebooks are scanned for candidate policies
+      # @param door [Runtime::Dispatcher] the dispatcher reactions re-enter through,
+      #   and whose reaction-depth guard is checked before each delivery
       def initialize(registry, door:)
         @registry = registry
         @door     = door
       end
 
+      # Fires every declared policy `event` triggers, recording each outcome on
+      # the registry's reaction log.
+      #
       # `deliver` returns `nil` for a policy whose `where` did not hold —
       # silently, the same as a policy `policies_for` never selected at all
       # (an `event_qualifier` miss carries no reaction_log entry either) —
@@ -32,6 +39,13 @@ module Hecks
       # way of running exactly the consumer a row names (`Runtime::
       # Outbox::Relay#run_consumer`) instead of every policy that
       # matches the event. Selection is otherwise identical.
+      #
+      # @param event [Runtime::Event] the just-emitted event to react to
+      # @param domain [String, Symbol] the domain `event`'s own aggregate belongs
+      #   to, the emitting domain's policies fire first
+      # @param only [Array(Bluebook::Policy, String), nil] one `[policy, home_domain]`
+      #   pair to run exactly, instead of scanning every loaded bluebook for candidates
+      # @return [void]
       def react(event, domain, only: nil)
         selected = only ? [only] : policies_for(event, domain)
         selected.each do |policy, home_domain|
@@ -195,14 +209,13 @@ module Hecks
       # The event's own identity is a fact too, not only its payload. A
       # for_each query commonly filters by the emitting record's own
       # identity (`OpenForCustomer`'s own `reference:`, scoping by the
-      # very customer who was just suspended) — which used to arrive for
-      # free because legacy dispatch left the self-addressing key riding
-      # along in `event.payload` unfiltered. Routing separated from
-      # payload (`to:`/`with:`, what the facade's own bang-methods always
-      # use) correctly stopped carrying it there, which left this query
-      # silently seeing neither the field it needs nor any error saying
-      # why — an empty result read as "nothing to freeze" instead of "the
-      # customer" the whole reaction exists to catch.
+      # very customer who was just suspended) — a fact routing keeps
+      # separate from payload (`to:`/`with:`, what the facade's own
+      # bang-methods always use), so `event.payload` alone does not carry
+      # it. Without this, the query would silently see neither the field
+      # it needs nor any error saying why — an empty result read as
+      # "nothing to freeze" instead of "the customer" the whole reaction
+      # exists to catch.
       #
       # Merged in only when the query declares an argument by that exact
       # name and the emitting aggregate's own identity is genuinely what
@@ -261,7 +274,7 @@ module Hecks
           label:     "#{policy.name}'s trigger"
         )
 
-        # **The raw inputs `args` was resolved from** — same additive,
+        # The raw inputs `args` was resolved from — same additive,
         # Ruby-only shape SagaInterpreter#deliver_saga_dispatch's own
         # saga_dispatch_log gets, for Properties.dispatch_binding_
         # fidelity's own independent re-derivation of Policy#with_spec's

data/lib/hecks/runtime/port_operation_interpreter.rb

@@ -25,6 +25,10 @@ module Hecks
         refuse_unknown_arguments refuse_absent_arguments normalize_args resolve_references resolve_route emit
       ].freeze
 
+      # @param registry [Runtime::Registry] the booted registry this interpreter dispatches
+      #   against
+      # @param rules [Runtime::CommandRules] the shared command-rule checks (references) this
+      #   interpreter's steps call
       def initialize(registry, rules:)
         @registry = registry
         @rules    = rules
@@ -32,6 +36,22 @@ module Hecks
 
       # `invocation` — the `Runtime::Invocation` `Dispatcher` built;
       # `ctx.args` is its `to_args`, `ctx.route` its `target`.
+      #
+      # @param domain [String] the domain the aggregate belongs to
+      # @param aggregate [Bluebook::Aggregate] the aggregate the port operation belongs to
+      # @param operation [Bluebook::PortOperation] the port operation to dispatch
+      # @param invocation [Runtime::Invocation] the invocation `Dispatcher` built for this call
+      # @return [Array<Runtime::Event>] the events recorded: the operation's own `emits` for
+      #   an inbound operation, or a single `answers`/`refuses` event for an outbound one
+      #   (an adapter failure is recorded as a `refuses` event, not raised)
+      # @raise [Runtime::UnknownArgument] if `invocation` offers an argument the operation
+      #   does not declare
+      # @raise [Runtime::AbsentArgument] if `invocation` omits a non-optional declared
+      #   argument
+      # @raise [Runtime::TypeMismatch] if an offered argument does not coerce to its declared
+      #   type
+      # @raise [Runtime::NotFound] if an offered reference or the operation's own receiving
+      #   record cannot be found
       def call(domain, aggregate, operation, invocation)
         ctx = Context.new(domain, aggregate, operation, invocation.to_args)
         ctx.invocation = invocation