event_rail 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a5dd4da961fafe8b7a42cadb79cc9fcad3f9da337181a6e53f93ac2e2495f80
-  data.tar.gz: adea011ca9a862030527c8178d67e7165e2d9e17b8902328ed96f698910c9835
+  metadata.gz: 3367f3d4d8f5eb0841f1cca4021af4faa7a3fac3bf1a94edb328f5206eccd516
+  data.tar.gz: 795013406723b9b46fc5e5ca4532a0a2b5f35c0ab9ca3a49240bb63c09b13ead
 SHA512:
-  metadata.gz: 382236795f226f5dad4979cb2fbb29cac28fd31a4bd0ca7bc77bd8b7b0f7f7279275a4e97f3df1550d3f7dd5fd826e2ed96a682ccdd8b792d0c6d6bd7af73e3a
-  data.tar.gz: b84bba4b3e33f2fd809c7f833cd8913655f555f298828f7080bc8c27e8925cbd02125e3503d2658444d27f16061bc555749235229935dfa1e9cf4342e2be470b
+  metadata.gz: 3df1e24c288ab7f89544af2286456e5e2a9f64ed7155a83479794fda04728c86b71cbf9f8486d9dc09873a9a35920efe316acf25211be3eeb6111e3be326ee96
+  data.tar.gz: cd069c5dcd53f4195e5171db86cbe75cfece2dfbbf1218c36710cf2fc54e9b5a932a48eaa685d9b5abc8eb6b75ad6cef24fc00bb40bd070032ce5397b1c6a3ed

data/CHANGELOG.md

@@ -13,6 +13,64 @@ here unless a release changes how they behave.
 
 ## [Unreleased]
 
+## [0.4.0] - 2026-09-26
+
+### Changed
+
+- **Breaking: an event with declared identity derives its ID from the fact, not from the
+  job that publishes it.** With `identity_by` or `identity:`, the ID now comes from the
+  event's source, event type and identity only: not the job class, the job's ID, the
+  execution or the schema version. The same fact has one ID wherever and however often it
+  is published, in a controller or in any job, and in every version of its event type.
+  Previously a caller that ran twice enqueued a new job with a new ID and published the same
+  fact under a new event ID.
+- **Breaking: `publish(event, key:)` is now `publish(event, identity:)`.** A key used to be
+  scoped to one job; an identity names a fact across every job. `key:` raises with
+  directions, and `identity:` is refused for a class that declares `identity_by`. An explicit
+  identity derives the same ID as a single string `identity_by` attribute with the same value.
+- **Breaking: every derived ID changes.** The derivation has a new namespace and separate,
+  documented rules for declared facts and for executions, pinned by vectors published in the
+  README so other implementations can reproduce them. Strings are hashed as UTF-8 and invalid
+  UTF-8 is refused.
+- **Breaking: random IDs are UUIDv7**, time-ordered, for events without declared identity
+  published outside a job. Derived IDs remain UUIDv5.
+- An event without declared identity published by a subscriber derives its ID from the
+  handled event's source as well as its ID, so causes from two producers that share an ID are
+  scoped apart.
+- The duplicate check within one execution includes the source, so one job can publish the
+  same fact for two producers, and relay two events that share an ID from different sources.
+- A relayed event keeps its lineage as it arrived: an absent causation is no longer filled
+  from the relaying context. A relay retried with a different payload, occurrence time or
+  extensions is refused, as a local retry is.
+- One publication record per `(source, type, version, id)` within an execution: publishing
+  the stamped event of a failed local publication, for instance to recover from an
+  `EnqueueError`, is its retry, and publishing it after success is a duplicate. A relayed ID
+  is compared as opaque bytes, so an ID that is not valid UTF-8 relays as before.
+- **Breaking: a declared identity attribute cannot be an empty string**, as it cannot be nil:
+  every blank event would otherwise be one fact.
+- `EventRail.with_context` opened inside a running job keeps the job's execution, so an
+  undeclared event published in the block keeps its retry-stable ID and its duplicate check;
+  it used to get a random ID.
+- Versioning: every version of an event type keeps its declared identity values; changing
+  what an event identifies needs a new event type, not a new version.
+
+### Added
+
+- `publish(event, source:)` publishes a locally built event on behalf of another producer,
+  such as an inbound webhook; relaying an event under a different source than it carries is
+  refused.
+
+### Upgrading
+
+- Audit every `identity_by` and every former `key:` before upgrading. A value that was safe
+  within one job, such as a line number or a product ID for a fact that recurs, now names one
+  fact across every job and would merge distinct facts silently. Identity must name the
+  occurrence, not the thing it is about.
+- IDs derived before and after the upgrade differ. A publication retried across the deploy, a
+  delayed job, a backfill or a dead-letter redelivery can deliver a fact again under a new ID;
+  subscribers that also deduplicate on a business key are unaffected. Draining publishing jobs
+  before deploying narrows the window.
+
 ## [0.3.0] - 2026-09-21
 
 ### Changed
@@ -100,7 +158,8 @@ here unless a release changes how they behave.
 - A typed error hierarchy rooted at `EventRail::Error`, distinguishing declaration,
   casting, context, serialization, and publication failures.
 
-[Unreleased]: https://github.com/alexdmtv/event-rail/compare/v0.3.0...HEAD
+[Unreleased]: https://github.com/alexdmtv/event-rail/compare/v0.4.0...HEAD
+[0.4.0]: https://github.com/alexdmtv/event-rail/compare/v0.3.0...v0.4.0
 [0.3.0]: https://github.com/alexdmtv/event-rail/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/alexdmtv/event-rail/compare/v0.1.0...v0.2.0
 [0.1.0]: https://github.com/alexdmtv/event-rail/releases/tag/v0.1.0

data/README.md

@@ -27,7 +27,7 @@ EventRail is narrow on purpose: durable fanout across a boundary inside one appl
 
 ### What it gives you
 
-- **Retry-stable identity**, derived from the publishing execution rather than generated, so a redelivered cause produces the same event rather than a second copy of it. Idempotency holds across hops, not only across one subscriber's retries.
+- **Stable identity.** An event that declares what fact it is has one ID wherever and however often it is published, so a consumer recognises it arriving again; any other event keeps its ID across retries and redeliveries. Idempotency holds across hops, not only across one subscriber's retries.
 - **Subscribers that are the jobs**, each keeping its own queue, retry policy, and concurrency limits rather than sharing the single wrapper job other gems route subscribers through.
 - **Boot-time validation**: a wrong `perform` arity, a missing `EventRail::JobContext`, or a late declaration fails the boot that introduced it rather than the first publication in production.
 - **A typed boundary**: a `Date`, a `BigDecimal`, a record, or a GlobalID is refused rather than serialized into something a worker cannot restore.
@@ -36,8 +36,8 @@ EventRail is narrow on purpose: durable fanout across a boundary inside one appl
 
 ### What it does not do
 
-- **No event log and no synchronous handlers.** No history, replay, read-model rebuild, or browser UI, and every subscriber crosses the queue.
-- **No outbox, and so a dual-write gap.** Publication is refused inside a transaction, so a publisher commits and then publishes, and a process that dies between the two loses the event. Publishing from a job makes that recoverable, because the retry republishes under the same identity (see [Replay-safe publishers](#replay-safe-publishers)); from a controller action there is no such guarantee. An application that wants recovery beyond that can record an intent and republish it from a sweeper, but a republication from a different job derives a different event ID, so the intent's own key belongs in the payload for consumers to deduplicate on.
+- **No event log and no synchronous handlers.** No history, replay, read-model rebuild, or browser UI, and every subscriber crosses the queue. A subscriber can append every event to a store of your own, keyed on `(source, id)`, but that store is a downstream log, not event sourcing: publication follows the commit, with no ordering or expected-version guarantees, so the store is a copy of what happened rather than its source of truth.
+- **No outbox, and so a dual-write gap.** Publication is refused inside a transaction, so a publisher commits and then publishes, and a process that dies between the two loses the event. Publishing from a job makes that recoverable, because the retry republishes under the same identity (see [Replay-safe publishers](#replay-safe-publishers)); a controller action has no retry to repeat the publication, though an event with declared identity keeps its ID when anything does. An application that wants recovery beyond that records the intent to publish in the same transaction as its data, and a sweeper or a relay job publishes it; an event with [declared identity](#identity-occurrence-time-and-source) derives the same ID however many times it is republished, so consumers see a repetition rather than a new fact.
 - **Discovery is enforced, not advisory.** A subscriber outside a [discovery root](#where-discovery-looks) fails the boot rather than being quietly ignored: a silent delivery bug traded for a loud startup error, at the price of a layout rule.
 
 ## Requirements
@@ -230,7 +230,9 @@ Two exceptions. Code that is not reloadable at all, such as a gem or a file plai
 
 ### At-least-once delivery, and what that means for subscribers
 
-Fanout is individual `perform_later` calls, one per subscriber. Jobs already accepted are never rolled back when a later subscriber's enqueue fails, and the retry repeats complete fanout under the same event ID. A subscriber must therefore be idempotent, and `event.id` is the key to be idempotent on: it is stable across retries of the publishing execution and across redeliveries of a subscriber's own cause.
+Fanout is individual `perform_later` calls, one per subscriber. Jobs already accepted are never rolled back when a later subscriber's enqueue fails, and the retry repeats complete fanout under the same event ID. A subscriber must therefore be idempotent. An event's full identity is `(source, id)`, so a subscriber records `(subscriber, event.source, event.id)` in the same transaction as its effect and does nothing when that record already exists; a business-key constraint (one refund per order) remains worth having beside it. The ID is stable across retries of the publishing execution and redeliveries of a subscriber's own cause, and, for an event with [declared identity](#identity-occurrence-time-and-source), across every publication of the fact.
+
+Two copies of one fact, published by different executions, can differ: a later `occurred_at`, another causation, or a payload read from state that has since changed. EventRail stores nothing and orders nothing, so it cannot say which copy is authoritative; each subscriber decides, and publishers keep copies equal by building events from persisted data.
 
 No ordering is promised, between subscribers or between events.
 
@@ -261,22 +263,113 @@ Guarding publication behind "did I already transition?" is the failure mode to a
 
 ## Identity, occurrence time, and source
 
-Inside an opted-in job, an event's ID is derived from a permanent EventRail namespace and the resolved source, executing job class, execution scope, event type, version, and logical identity. The execution scope is the same value the event records as its causation: a regular job's own ID, or, for a subscriber, the ID of the event it is handling. That is what makes identity survive more than one hop: a follow-up event published while handling a redelivered cause derives the ID it derived the first time.
+An event's ID says which fact it is, so a consumer can recognise the same fact arriving again. It is chosen by one of three rules, in order:
+
+1. **An event that already carries an ID** — one reconstructed from an envelope — keeps it, with its source and its lineage.
+2. **An event with declared identity** — its class's `identity_by` attributes, or an `identity:` passed to `publish` — derives its ID from its source, its event type and that identity, and from nothing else: not the job that published it, not the execution, not the schema version. The same fact has the same ID wherever and however often it is published, inside a job or in a controller, and in version 1 or version 2.
+3. **Any other event** derives its ID from the execution publishing it: stable across that job's retries, and, for an event a subscriber publishes, across redeliveries of the event it handles. A separate job publishing it again gets a new ID. Outside a job it gets a random, time-ordered ID.
 
-Logical identity is chosen in this order: an explicit event ID (an inbound external event), an explicit `key:` passed to `publish`, the class's `identity_by` attributes, or a singleton marker for the first publication of that type in the execution. Provide an explicit key when neither declared identity nor the singleton default can tell two legitimate publications apart:
+**Identity names the occurrence, not the thing it is about.** This is the rule to get right, because getting it wrong fails silently. `PaymentCaptured identity_by :reference` is right when a payment is captured once. `PriceChanged identity_by :product_id` is wrong: every price change of that product would carry one ID, and consumers would drop all but the first, with no error anywhere. A fact that can happen again for the same thing keys on what distinguishes each occurrence — a persisted change ID, a revision, an import row — never on a hash of the payload or a loop index:
 
 ```ruby
-EventRail.publish(
-  Docs::OrderPlaced.new(order_id: "A-1003", total: "5.00", placed_at: Time.now.utc.iso8601),
-  key: "adjustment-7"
-)
+module Docs
+  module Inventory
+    # One base class per producer, so its source is declared once.
+    class Event < EventRail::Event
+      default_source "acme.inventory"
+    end
+
+    # Stock is adjusted many times; each adjustment is one fact.
+    class StockAdjusted < Event
+      event_type "docs.stock_adjusted"
+      version 1
+      identity_by :adjustment_id
+
+      attribute :adjustment_id, :string
+      attribute :sku, :string
+      attribute :quantity, :integer
+    end
+
+    class StockCounted < Event
+      event_type "docs.stock_counted"
+      version 1
+
+      attribute :sku, :string
+      attribute :counted, :integer
+    end
+  end
+end
+
+first = EventRail.publish(Docs::Inventory::StockAdjusted.new(adjustment_id: "adj-7", sku: "MUG", quantity: -2)).event
+again = EventRail.publish(Docs::Inventory::StockAdjusted.new(adjustment_id: "adj-7", sku: "MUG", quantity: -2)).event
+raise "one adjustment, one ID" unless first.id == again.id
+
+# A class without identity_by can name the fact at the call site instead.
+EventRail.publish(Docs::Inventory::StockCounted.new(sku: "MUG", counted: 38), identity: "count-2026-09-01-MUG")
 ```
 
-Changing `identity_by`, changing `default_source`, or renaming a subscriber class all change the identities that derive from them, so each is a breaking change. Outside a job execution, events receive random IDs.
+Beside that rule:
 
-`occurred_at` is the logical publication time: an explicit timezone-aware value is preserved as the same instant, and otherwise it is the start of the current execution, stable across that execution's retries and never inherited from a cause. Use a persisted domain timestamp when business occurrence time matters. Stored times are UTC at microsecond precision.
+- **`identity:` names a fact across every job**, so it must be unique per source and event type. It is refused for a class that declares `identity_by`, so the two cannot disagree, and it derives the same ID as a single string `identity_by` attribute with the same value, so a class can move from one to the other without changing IDs; an integer `42` and the string `"42"` are different identities.
+- **A tenant belongs in the identity** (or the source) when tenants number their facts independently; an extension is not part of an event's identity.
+- **Never use personal data as identity.** The derivation is a hash, and a hash over an email address or a name is reversible by guessing.
+- **Events that cross an application boundary should declare identity.** An execution-derived ID changes when the publishing code moves, a declared one does not.
+- **Changing `source`, `event_type` or declared identity changes IDs**, so each is a breaking change. Renaming a subscriber class changes the IDs of undeclared events it publishes.
 
-`source` identifies a logical producer, not an environment, queue, topic, cluster, or deployment. Any bounded non-empty string is accepted; a stable namespaced value such as `acme.orders` is recommended, and EventRail does no URI parsing.
+Upgrading from a release where `publish` took `key:`: that key was scoped to one job and is now `identity:`, scoped to every job. Before renaming it, and for every `identity_by`, check that the value names one occurrence per source and event type; a value that used to be safe inside one job, such as a line number, now merges facts.
+
+`occurred_at` is the logical publication time: an explicit timezone-aware value is preserved as the same instant, and otherwise it is the start of the current execution, stable across that execution's retries and never inherited from a cause. Use a persisted domain timestamp when business occurrence time matters, and build an event from persisted data, so that two publications of one fact carry the same payload. Stored times are UTC at microsecond precision.
+
+`source` names the logical producer of an event — `acme.orders` — not an environment, queue, topic, cluster, or deployment. An event ID is unique within its source, so `(source, id)` is an event's full identity, as in CloudEvents, and the source is half of every declared ID. Choose it for the producer rather than the deployment, and a module can move to another application without its events changing IDs. Declare it once, with `default_source` on a module's base event class; an event built on behalf of another producer can be published with `source:` (see [Crossing a network boundary](#crossing-a-network-boundary)). Any bounded non-empty string is accepted, and EventRail does no URI parsing. A follow-up event records its cause's ID as its causation, not its cause's source.
+
+### How an ID is derived
+
+Other implementations can derive the same IDs. An ID is a UUIDv5 ([RFC 9562](https://www.rfc-editor.org/rfc/rfc9562.html)) under the namespace `21fedac0-42c6-443f-b01c-6980aab52f32`, over a name that concatenates encoded components:
+
+- **Declared identity:** `"fact"`, source, event type, and the identity as a list — the `identity_by` values in declaration order, or the one `identity:` value.
+- **Execution:** `"execution"`, source, job class name, scope, event type, version, and a singleton marker. The scope is a regular job's Active Job ID, or, for a subscriber, the list `[source, id]` of the event it handles.
+
+Each component is encoded as a tag, its byte length in decimal, a colon, and its bytes:
+
+| Value | Tag | Bytes |
+| --- | --- | --- |
+| String | `s` | its UTF-8 bytes, without Unicode normalization; invalid UTF-8 is refused |
+| Integer | `i` | decimal, with a leading `-` when negative |
+| Decimal | `d` | plain notation: an optional `-`, the integer digits, `.`, and the fractional digits with trailing zeros removed but at least one kept (`12.5`, `100.0`, `0.0`, `-0.0`) |
+| Float | `f` | 17 significant digits with trailing zeros removed, as C's `printf("%.17g")` writes them: positional notation, or exponent notation (`1e+22`, `9.9999999999999995e-08`) when the decimal exponent is below -4 or at least 17, the exponent with a sign and at least two digits; `-0` stays distinct from `0`; non-finite is refused |
+| Boolean | `b` | `true` or `false` |
+| Date | `D` | ISO 8601 (`2026-09-01`) |
+| Timestamp | `T` | converted to UTC, truncated to microseconds, and written as ISO 8601 with six fractional digits (`2026-09-01T10:30:00.123456Z`) |
+| List | `L` | the item count in decimal, a colon, then each item encoded |
+| Singleton marker | `*` | empty |
+
+These vectors are part of the contract, and the test suite asserts them. For declared identity the source is `acme.orders` and the event type `orders.order_placed`; for execution, the job class is `Orders::PlaceOrderJob` and the version `1`:
+
+| Vector | Encoded name | ID |
+| --- | --- | --- |
+| a string | `s4:facts11:acme.orderss19:orders.order_placedL8:1:s3:o-1` | `13b2cda9-e1f7-57b6-ba1d-bb12a7553655` |
+| a non-ASCII string | `s4:facts11:acme.orderss19:orders.order_placedL12:1:s7:Zürich` | `8ad8bbf8-3e10-5162-97da-53cb6752973f` |
+| an integer | `s4:facts11:acme.orderss19:orders.order_placedL7:1:i2:42` | `43230f76-4e80-55d0-bfaf-beab63ac76b9` |
+| a negative integer | `s4:facts11:acme.orderss19:orders.order_placedL7:1:i2:-7` | `4feffb91-0dec-5a7b-a5a0-67968abbe971` |
+| true | `s4:facts11:acme.orderss19:orders.order_placedL9:1:b4:true` | `b1a75e27-6aa2-5f7e-9159-fb429bddc17f` |
+| false | `s4:facts11:acme.orderss19:orders.order_placedL10:1:b5:false` | `631f1712-795b-59fa-b497-103b5f951306` |
+| a decimal | `s4:facts11:acme.orderss19:orders.order_placedL9:1:d4:12.5` | `fc8e4be7-4912-5702-b22b-92d63d710e01` |
+| an integral decimal | `s4:facts11:acme.orderss19:orders.order_placedL10:1:d5:100.0` | `4ab51db7-7864-591d-8e1a-b1f5d9567169` |
+| a zero decimal | `s4:facts11:acme.orderss19:orders.order_placedL8:1:d3:0.0` | `0a066901-77e5-55e3-99c4-a973b5018500` |
+| a negative zero decimal | `s4:facts11:acme.orderss19:orders.order_placedL9:1:d4:-0.0` | `784aef76-53c9-517c-ba3f-732053cd537d` |
+| a float | `s4:facts11:acme.orderss19:orders.order_placedL25:1:f19:0.10000000000000001` | `cc223477-2cb1-5a6d-8d0f-6b25aaf989b7` |
+| an integral float | `s4:facts11:acme.orderss19:orders.order_placedL6:1:f1:1` | `901836d7-5477-5780-8e6b-dd39ed49d272` |
+| a large float | `s4:facts11:acme.orderss19:orders.order_placedL10:1:f5:1e+22` | `d4e88ebb-fdaa-5cc4-9dbe-c576abae6f36` |
+| a small float | `s4:facts11:acme.orderss19:orders.order_placedL28:1:f22:9.9999999999999995e-08` | `83b232ee-36bc-53dc-a455-5a9e31a003a2` |
+| negative zero | `s4:facts11:acme.orderss19:orders.order_placedL7:1:f2:-0` | `7cab07fc-874c-59ff-a946-76d00585d229` |
+| a date | `s4:facts11:acme.orderss19:orders.order_placedL16:1:D10:2026-09-01` | `84aaf8b3-7dc1-5446-880d-a002bfe8cab6` |
+| a timestamp | `s4:facts11:acme.orderss19:orders.order_placedL33:1:T27:2026-09-01T10:30:00.123456Z` | `874e797f-7b0c-5742-b8e2-6b05ae3f738a` |
+| a timestamp with an offset and sub-microsecond digits | `s4:facts11:acme.orderss19:orders.order_placedL33:1:T27:2026-09-01T10:30:01.234567Z` | `7fcd39f5-1a94-5ad2-b899-22ac849d510d` |
+| several values | `s4:facts11:acme.orderss19:orders.order_placedL12:2:s3:o-1i1:2` | `fe61e6d0-cbb6-5db0-96a4-1fd78d86dab9` |
+| a regular job's scope | `s9:executions11:acme.orderss21:Orders::PlaceOrderJobs5:job-1s19:orders.order_placedi1:1*0:` | `e3c5921d-a9bf-5816-b9a7-f36f426cb998` |
+| a subscriber's scope | `s9:executions11:acme.orderss21:Orders::PlaceOrderJobL59:2:s13:acme.paymentss36:0b1e2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4ds19:orders.order_placedi1:1*0:` | `a3a31754-e302-5c23-a4a7-ea353accfeb6` |
+
+Random IDs, for events without declared identity published outside a job, are UUIDv7, so a log indexes them in time order, to the millisecond, and the version digit tells a random ID (7) from a derived one (5).
 
 ## Logical context
 
@@ -336,7 +429,9 @@ OpenTelemetry is not required. When standard Active Job instrumentation is insta
 
 ## Versioning events
 
-`event_type` and `version` form the durable, language-neutral contract, independent of Ruby class names. A compatible optional addition may keep the same version: an older worker preserves the unknown field as opaque data with no reader and includes it again on export. Removing, renaming, requiring, or retyping a field, changing its meaning, or changing identity requires a new version and a distinct class, and the old class stays registered while messages that reference it can still arrive.
+`event_type` and `version` form the durable, language-neutral contract, independent of Ruby class names. A compatible optional addition may keep the same version: an older worker preserves the unknown field as opaque data with no reader and includes it again on export. Removing, renaming, requiring, or retyping a field, or changing its meaning requires a new version and a distinct class, and the old class stays registered while messages that reference it can still arrive.
+
+A new version is a new representation of the same fact, so every version of a type keeps the same declared identity values, in the same order (an attribute may be renamed), and a fact with declared identity carries one ID in every version; an ID derived from the execution includes the version. A consumer subscribed to both versions while old messages drain deduplicates them on that ID. Keeping both representations is a different need: an archive stores `(source, id, version)`, and it must receive both, because a broker or inbox that deduplicates on `(source, id)` before routing by version passes only one of them on. Changing what an event identifies is not a new version but a new event type.
 
 EventRail provides no upcasting and no schema registry.
 
@@ -344,7 +439,7 @@ EventRail provides no upcasting and no schema registry.
 
 | Value | Limit |
 | --- | ---: |
-| Event, correlation, causation, or boundary identifier | 512 bytes |
+| Event, correlation, causation, or boundary identifier, or `identity:` | 512 bytes |
 | Source | 255 bytes |
 | Event type | 255 bytes |
 | Extension entries | 32 |
@@ -458,7 +553,18 @@ event_class = ACCEPTED.fetch([ envelope.event_type, envelope.version ])
 EventRail.publish(envelope.to_event(event_class))
 ```
 
-A relayed event keeps its origin's ID, source, occurrence time, correlation, and extensions; the relaying application's own context extensions are not merged into it, and only a missing causation is filled.
+A relayed event keeps its origin's ID, source, occurrence time, correlation, causation (an absent one stays absent), and extensions; the relaying application's own context extensions are not merged into it. Relaying it with a different `source:` is refused rather than re-attributing somebody else's fact.
+
+A producer that sends no event ID, a supplier's webhook say, is mapped to a local event built on the producer's behalf. Its declared identity and the producer's source make a retried delivery the same fact:
+
+```ruby
+EventRail.publish(
+  Docs::Inventory::StockAdjusted.new(adjustment_id: "delivery-4411", sku: "MUG", quantity: 120),
+  source: "supplier.warehouse"
+)
+```
+
+Source is a claim, not a credential. Before relaying, an inbound adapter checks `envelope.source` against the sources that peer may speak for: a declared fact's ID is predictable, so an unchecked envelope claiming a local source could arrive first under a local fact's ID and make consumers drop the genuine one.
 
 Loop prevention is application policy: an export policy that refuses to export an event whose source is not the local application stops a relayed event from bouncing back to the system it came from. EventRail has no concept of internal versus external, direction, topic, or transport marker.
 

data/lib/event_rail/current.rb

@@ -49,7 +49,15 @@ module EventRail
         inherited[:extensions], extensions, error: InvalidContext
       )
 
-      execution = Internal::Execution.new(scope: resolved_message_id, started_at: resolved_originated_at)
+      # A block opened inside a running job stays part of that job's execution: its
+      # publications keep the job's identity rules and its duplicate record. Only a
+      # block with no job around it is a boundary of its own.
+      running = Internal::Execution.current
+      execution = if running&.derives_identity?
+        running
+      else
+        Internal::Execution.new(scope: resolved_message_id, started_at: resolved_originated_at)
+      end
 
       # A nested scope keeps its parent's causation: the message that caused this flow
       # does not change because the application opened an inner block.

data/lib/event_rail/event.rb

@@ -232,17 +232,19 @@ module EventRail
         self.class.send(:__event_rail_copy__, self, state: { :@metadata => stamped_metadata })
       end
 
-      # A declared identity attribute that is nil cannot produce a canonical value, so
-      # the event can never be published. The local constructor is the strict door and
+      # A declared identity attribute that is nil cannot produce a canonical value, and
+      # one that is empty would make every blank event the same fact, so neither can be
+      # published. The local constructor is the strict door and
       # the only place whose backtrace points at the code that left the field empty.
       # Trusted reconstruction stays permissive: an external event of this contract may
       # legitimately omit a field, and it arrives with an identity already assigned.
       def validate_local_identity!
-        missing = self.class.identity_by.select { |name| public_send(name).nil? }
+        missing = self.class.identity_by.select { |name| public_send(name).then { |value| value.nil? || value == "" } }
         return if missing.empty?
 
         raise InvalidEvent,
-          "#{self.class} declares #{missing.sort.join(", ")} as logical identity, so it cannot be nil"
+          "#{self.class} declares #{missing.sort.join(", ")} as logical identity, so it cannot be nil or empty: " \
+          "every event with a blank identity would be one fact"
       end
 
       def unknown_attributes_message(unknown)

data/lib/event_rail/internal/identity.rb

@@ -1,38 +1,56 @@
 require "active_support/core_ext/digest/uuid"
+require "active_support/core_ext/object/blank"
 require "bigdecimal"
 require "date"
 
 module EventRail
   module Internal
-    # Retry-stable publication identity.
+    # Publication identity: the ID an event derives, so that the same fact published
+    # again derives the same ID and a consumer can collapse the duplicates at-least-once
+    # delivery guarantees it will see.
     #
-    # The whole point is that the same logical fact, published again by the same
-    # execution, derives the same event ID -- so a consumer can collapse the
-    # duplicates at-least-once delivery guarantees it will see. That makes both the
-    # namespace and the encoding permanent compatibility state: changing either
-    # silently gives every future publication a different ID for an unchanged fact,
-    # which is why the golden vectors are asserted rather than merely computed.
+    # Two derivations, told apart by a leading tag so their inputs never coincide:
+    #
+    #   fact       ["fact", source, event_type, identity_list]
+    #              for an event with declared identity. Nothing about who published it,
+    #              when, or in which schema version: one fact, one ID, everywhere.
+    #   execution  ["execution", source, job_class, scope, event_type, version, SINGLETON]
+    #              for an event without declared identity, published inside a job. Stable
+    #              across that job's retries and across redeliveries of the event a
+    #              subscriber handles, and nothing more.
+    #
+    # The namespace, the tags, the component order and the byte encoding are permanent
+    # compatibility state, documented in the README with vectors other implementations
+    # can reproduce; changing any of them silently gives every future publication a
+    # different ID for an unchanged fact, which is why the vectors are asserted rather
+    # than merely computed.
     module Identity
       module_function
 
-      # Derived from the URL namespace rather than written as a literal, so the input
-      # that produced it stays visible and a typo cannot masquerade as a deliberate
-      # value. The golden-vector test pins the result.
-      NAMESPACE = Digest::UUID.uuid_v5(
-        Digest::UUID::URL_NAMESPACE, "https://github.com/event_rail/event_rail/identity/v1"
-      ).freeze
+      # A literal, owned by this project and named nowhere else, so no one else's
+      # derivation can land in the same space.
+      NAMESPACE = "21fedac0-42c6-443f-b01c-6980aab52f32".freeze
 
-      # The first publication of an event type in one execution needs no key: there is
-      # nothing to distinguish it from.
+      # Closes the execution rule's name: an undeclared event is identified by the
+      # execution and its type alone, which is why one execution publishes it once.
       SINGLETON = :__event_rail_singleton__
 
-      def derive(source:, job_class:, scope:, event_type:, version:, logical_identity:)
-        Digest::UUID.uuid_v5(
-          NAMESPACE,
-          encode([ source, job_class, scope, event_type, version, logical_identity ])
-        )
+      # `identity` is always a list: the declared attributes' values in declaration
+      # order, or one explicit publication identity. So an explicit "a" and a single
+      # declared attribute whose value is "a" name the same fact.
+      def fact(source:, event_type:, identity:)
+        raise ArgumentError, "fact identity must be a list; got #{identity.inspect}" unless identity.is_a?(Array)
+
+        uuid_v5(encode([ "fact", source, event_type, identity ]))
+      end
+
+      def execution(source:, job_class:, scope:, event_type:, version:)
+        uuid_v5(encode([ "execution", source, job_class, scope, event_type, version, SINGLETON ]))
       end
 
+      def uuid_v5(name) = Digest::UUID.uuid_v5(NAMESPACE, name)
+      private_class_method :uuid_v5
+
       # Length-delimited and type-tagged. Ruby's own Hash#hash is per-process, inspect
       # is not a format, and a plain join makes ["ab", "c"] and ["a", "bc"] the same
       # string. A tag also keeps 1 and "1" apart, so a call site that passes an integer
@@ -44,7 +62,7 @@ module EventRail
       def encode_component(value)
         tag, bytes = case value
         when SINGLETON then [ "*", "" ]
-        when String then [ "s", value.b ]
+        when String then [ "s", utf8_bytes(value) ]
         when true then [ "b", "true" ]
         when false then [ "b", "false" ]
         when Integer then [ "i", value.to_s ]
@@ -67,6 +85,18 @@ module EventRail
         "#{tag}#{bytes.bytesize}:#{bytes}"
       end
 
+      # A string is hashed as its UTF-8 bytes, with no Unicode normalization: the same
+      # text in another normal form is another identity, so a producer must send the same
+      # bytes. Bytes that are not valid UTF-8 have no portable spelling at all.
+      def utf8_bytes(value)
+        utf8 = value.encoding == Encoding::UTF_8 ? value : value.encode(Encoding::UTF_8)
+        reject!(value, "valid UTF-8") unless utf8.valid_encoding?
+        utf8.b
+      rescue EncodingError
+        reject!(value, "valid UTF-8")
+      end
+      private_class_method :utf8_bytes
+
       # An identity component that is a structure cannot be canonicalized without
       # choosing an ordering and a separator that would then be permanent, and one
       # that is null cannot identify anything.

data/lib/event_rail/internal/stamping.rb

@@ -3,7 +3,7 @@ require "securerandom"
 module EventRail
   module Internal
     # Turns a proposal into a stamped fact: resolves source, selects logical identity,
-    # derives a retry-stable ID, fixes occurrence time, and installs lineage. Fanout
+    # derives its ID, fixes occurrence time, and installs lineage. Fanout
     # is a separate concern layered on top of this.
     module Stamping
       module_function
@@ -14,17 +14,21 @@ module EventRail
         end
       end
 
-      def prepare(event, key: nil)
+      def prepare(event, identity: nil, source: nil)
         unless event.is_a?(Event)
           raise InvalidEvent, "#{event.inspect} is not an EventRail::Event"
         end
+        Metadata.validate_source!(source) unless source.nil?
 
-        return relay(event, key: key) if event.stamped?
+        return relay(event, identity: identity, source: source) if event.stamped?
+
+        validate_identity!(event, identity)
+        source = (source || event.class.default_source)&.dup&.freeze
+        raise InvalidMetadata, "source is required to publish #{event.class}" unless source
 
-        validate_key!(key)
         execution = Execution.current
-        logical_identity = resolve_logical_identity(event, key)
-        logical_key = [ event.event_type, event.version, Identity.encode_component(logical_identity) ].freeze
+        derived_id = derive_id(event, execution, source, declared_identity(event, identity))
+        logical_key = record_key(source, event, derived_id)
 
         recorded = execution&.derives_identity? ? execution.record(logical_key) : nil
         if recorded&.succeeded?
@@ -36,8 +40,7 @@ module EventRail
         extensions = Extensions.merge!(Current.extensions, event.extensions, error: InvalidEvent)
         detect_retry_mismatch!(event, recorded, extensions) if recorded
 
-        source = event.class.default_source
-        event_id = recorded&.event&.id || derive_id(event, execution, source, logical_identity)
+        event_id = recorded&.event&.id || derived_id
         occurred_at = event.occurred_at || recorded&.event&.occurred_at || default_occurred_at(execution)
 
         stamped = event.send(
@@ -62,20 +65,26 @@ module EventRail
         execution.record!(prepared.logical_key, event: prepared.event, succeeded: true)
       end
 
-      # A relayed fact belongs to its origin. Its ID, source, occurrence time,
-      # correlation, and extensions are preserved, and the relaying application's own
-      # context extensions are deliberately not merged in: local baggage is not part of
-      # somebody else's event. Only a missing causation is filled, because the local
-      # message genuinely is what caused this relay.
-      def relay(event, key:)
-        unless key.nil?
+      # A relayed fact belongs to its origin. Its ID, source, occurrence time, lineage
+      # -- an absent causation included -- and extensions are preserved, and the relaying
+      # application's own context is deliberately not merged in: local baggage is not
+      # part of somebody else's event. Two producers may use the same ID, so the source is
+      # part of what makes a relay a repetition, and a relay retried with a different
+      # payload is refused exactly as a local publication is.
+      def relay(event, identity:, source:)
+        unless identity.nil?
           raise PublicationError,
             "#{event.event_type.inspect} already carries the event ID #{event.id.inspect}, so a publication " \
-            "key cannot apply to it"
+            "identity cannot apply to it"
+        end
+        if source && source != event.source
+          raise InvalidMetadata,
+            "#{event.event_type.inspect} #{event.id.inspect} already comes from #{event.source.inspect}; " \
+            "publishing it as #{source.inspect} would re-attribute somebody else's fact"
         end
 
         execution = Execution.current
-        logical_key = [ event.event_type, event.version, Identity.encode_component(event.id) ].freeze
+        logical_key = record_key(event.source, event, event.id)
 
         if execution&.derives_identity?
           recorded = execution.record(logical_key)
@@ -84,71 +93,71 @@ module EventRail
               event_type: event.event_type, version: event.version, event_id: event.id
             )
           end
+          detect_retry_mismatch!(event, recorded, event.extensions) if recorded
+          execution.record!(logical_key, event: event, succeeded: false)
         end
 
-        relayed = if event.causation_id.nil? && Current.message_id
-          event.send(
-            :__stamp__,
-            id: event.id,
-            source: event.source,
-            occurred_at: event.occurred_at,
-            correlation_id: event.correlation_id,
-            causation_id: Current.message_id,
-            extensions: event.extensions
-          )
-        else
-          event
-        end
-
-        execution.record!(logical_key, event: relayed, succeeded: false) if execution&.derives_identity?
-
-        Prepared.new(event: relayed, execution: execution, logical_key: logical_key, relayed: true)
+        Prepared.new(event: event, execution: execution, logical_key: logical_key, relayed: true)
       end
       private_class_method :relay
 
-      # 1. An explicit event ID wins, which is the relay path above.
-      # 2. An explicit call-site key.
-      # 3. The event class's declared identity attributes.
-      # 4. A singleton marker, for the first publication of that type in an execution.
-      def resolve_logical_identity(event, key)
-        return key if key
+      # One record per published event, whether it was stamped here or arrives stamped:
+      # so publishing the stamped result of a failed local publication is a retry of it,
+      # and publishing it again after success is a duplicate. Frozen binary copies, so a
+      # caller mutating the string it passed cannot move a record, and so a relayed ID is
+      # compared as the opaque bytes it is, whatever they hold.
+      def record_key(source, event, id)
+        [ source.b.freeze, event.event_type, event.version, id.b.freeze ].freeze
+      end
+      private_class_method :record_key
 
-        declared = event.class.identity_by
-        return Identity::SINGLETON if declared.empty?
+      # The fact an event declares itself to be, as a list: an explicit publication
+      # identity, or the class's declared identity attributes in declaration order. Nil
+      # when it declares none. An explicit identity and a single declared attribute with
+      # the same value name the same fact.
+      def declared_identity(event, identity)
+        return [ identity ] if identity
 
-        declared.map { |name| event.public_send(name) }
+        declared = event.class.identity_by
+        declared.empty? ? nil : declared.map { |name| event.public_send(name) }
       end
-      private_class_method :resolve_logical_identity
+      private_class_method :declared_identity
 
-      # A key spelled as an integer at one call site and as its decimal string at
-      # another would derive two identities for one fact, and nothing would report it.
-      def validate_key!(key)
-        return if key.nil?
+      # A publication identity names a fact across every execution, so it is a string --
+      # an integer at one call site and its decimal spelling at another would be two
+      # facts -- and it cannot contradict an identity the class already declares.
+      def validate_identity!(event, identity)
+        return if identity.nil?
 
-        unless key.is_a?(String) && !key.empty? && key.valid_encoding?
-          raise PublicationError, "publication key must be a non-empty string; got #{key.inspect}"
+        unless event.class.identity_by.empty?
+          raise PublicationError,
+            "#{event.class} declares #{event.class.identity_by.join(", ")} as its identity, so a publication " \
+            "identity cannot apply to it"
+        end
+        unless identity.is_a?(String) && !identity.empty? && identity.valid_encoding?
+          raise PublicationError, "publication identity must be a non-empty string; got #{identity.inspect}"
         end
-        if key.bytesize > Limits::MAX_IDENTIFIER_BYTES
-          raise PublicationError, "publication key exceeds #{Limits::MAX_IDENTIFIER_BYTES} bytes"
+        if identity.bytesize > Limits::MAX_IDENTIFIER_BYTES
+          raise PublicationError, "publication identity exceeds #{Limits::MAX_IDENTIFIER_BYTES} bytes"
         end
       end
-      private_class_method :validate_key!
-
-      def derive_id(event, execution, source, logical_identity)
-        return SecureRandom.uuid.freeze unless execution&.derives_identity?
-
-        unless source
-          raise InvalidMetadata, "source is required to publish #{event.class}"
+      private_class_method :validate_identity!
+
+      # A declared fact's ID depends on nothing but the fact. Without one, an ID derived
+      # from the execution is stable across its retries and redeliveries; outside any
+      # execution there is nothing stable to derive from, and the ID is random, in time
+      # order so a downstream log indexes it well.
+      def derive_id(event, execution, source, declared)
+        if declared
+          Identity.fact(source: source, event_type: event.event_type, identity: declared).freeze
+        elsif execution&.derives_identity?
+          Identity.execution(
+            source: source, job_class: execution.job_class, scope: execution.scope,
+            event_type: event.event_type, version: event.version
+          ).freeze
+        else
+          SecureRandom.uuid_v7.freeze
         end
-
-        Identity.derive(
-          source: source,
-          job_class: execution.job_class,
-          scope: execution.scope,
-          event_type: event.event_type,
-          version: event.version,
-          logical_identity: logical_identity
-        ).freeze
       end
       private_class_method :derive_id
 

data/lib/event_rail/job_context.rb

@@ -106,8 +106,11 @@ module EventRail
           entry["extensions"], error: InvalidContext
         )
 
+        # The scope an undeclared follow-up's ID derives from. A subscriber's is the event
+        # it handles, by source as well as ID, since two producers may use one ID; its
+        # logical message and causation stay the event's ID.
         execution = Internal::Execution.new(
-          job_class: self.class.name, scope: message_id, started_at: started_at
+          job_class: self.class.name, scope: event ? [ event.source, event.id ] : message_id, started_at: started_at
         )
 
         Internal::Context.establish(

data/lib/event_rail/publish.rb

@@ -7,6 +7,9 @@ module EventRail
     #
     #   publication = EventRail.publish(Orders::OrderPlaced.new(order_id: order.id))
     #
+    # `identity:` names the fact for an event whose class declares no `identity_by`;
+    # `source:` publishes a locally built event on behalf of another producer.
+    #
     # Individual enqueue calls, not `perform_all_later`. Bulk enqueue skips each job's
     # own `enqueue` callbacks on several adapters, and those callbacks are exactly where
     # an application puts uniqueness, concurrency, and feature-flag decisions that this
@@ -15,10 +18,17 @@ module EventRail
     # Delivery is at-least-once. Jobs already accepted are not rolled back when a later
     # subscriber's enqueue fails, and the retry repeats complete fanout under the same
     # event ID, so a subscriber may see the same event more than once.
-    def publish(event, key: nil)
+    def publish(event, identity: nil, source: nil, **unknown)
+      if unknown.key?(:key)
+        raise ArgumentError,
+          "publish's key: is now identity:, and it names a fact across every job rather than within one; " \
+          "check the value names one occurrence per source and event type before renaming it"
+      end
+      raise ArgumentError, "unknown keyword#{"s" if unknown.size > 1}: #{unknown.keys.map(&:inspect).join(", ")}" if unknown.any?
+
       Internal::Transaction.check!
 
-      prepared = Internal::Stamping.prepare(event, key: key)
+      prepared = Internal::Stamping.prepare(event, identity: identity, source: source)
       stamped = prepared.event
       subscribers = Internal::Registry.subscribers_for(stamped.class)
 

data/lib/event_rail/version.rb

@@ -1,3 +1,3 @@
 module EventRail
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: event_rail
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Alex Dmitriev
@@ -109,9 +109,9 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
-description: EventRail adds immutable domain events, retry-stable identity, logical
-  context propagation, and Rails-native durable fanout without replacing Active Job
-  or its queue adapter.
+description: EventRail adds immutable domain events, stable, fact-derived identity,
+  logical context propagation, and Rails-native durable fanout without replacing Active
+  Job or its queue adapter.
 email:
 - alexey.dmitriev6238@gmail.com
 executables: []