sourced-message 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3c83eaa51d67e2693a9437766624a7331535d0580e3d7481a6b97baeb58f63f
-  data.tar.gz: 892f3f3a82b5d9063d830516d167c3f3e7b16b86e8ac2047f1614e787142b48f
+  metadata.gz: c32c4b5ea1020c0623e0f572d67a529a70630e21dd9d865a43386c4ca318915b
+  data.tar.gz: b1bf6ccf2eadf06ea8c5bf301f692a520bb9cb84de37c07a5a340a0395177ff5
 SHA512:
-  metadata.gz: 0264f5b499a6d287ed286e0e80158dad36d171dd0da3ff9dfe8425dff0bab2884b64c2405eae964db1dcee415f20763df415b6938d95247e56e937f7d196daf8
-  data.tar.gz: 57dd69b783f5d076babe42d2e05ff4c654fc710da47098dafa8f20907f98347a6c0e3728e43505a9acf30a81b7cfb8635d35d16b388c88f8250a20010bffcc35
+  metadata.gz: c9d6eb69097f9e6f70df79786f8a285c638d7a985f762ba15d70463109058b5884117d838242834db8771a1ee6996434695d5ab4a4dac4d9809a2d25c0456ffa
+  data.tar.gz: a1b78a345ee0f8463372e729d9cce17ad28ce9c9da6a2d137da72c174ed10d668148018b7fdb7f13529d2c6d9db78a14f8401e0d976781457f95ec52944998ba

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [0.3.0]
+
+- Add `Sourced::Message#correlation_type`, the type counterpart of `correlation_id`:
+  the type of the message at the root of a causal chain. `#correlate` now records the
+  source's `correlation_type` under `metadata[:correlation_type]` on the target, so
+  every consequence of a command carries the command's type. A message that was never
+  correlated answers with its own `type`. A target whose metadata already holds a
+  `correlation_type` keeps it, which starts a new chain.
+- `Sourced::Message::VERSION` is now `0.3.0`.
+
 ## [0.2.0]
 
 - Add `Sourced::Message::Codec`, the abstract serializer: it compiles a

data/lib/sourced/message.rb

@@ -22,7 +22,7 @@ module Sourced
   # +Sourced::Message.registry[type]+ resolves a type registered under any
   # subclass. Resolve from this root to see the whole tree.
   class Message < Plumb::Types::Data
-    VERSION = '0.2.1'
+    VERSION = '0.3.0'
 
     EMPTY_ARRAY = [].freeze
 
@@ -231,8 +231,33 @@ module Sourced
 
     alias in at
 
+    # Metadata key under which {#correlate} records the {#correlation_type}.
+    CORRELATION_TYPE_KEY = :correlation_type
+
+    # The type of the message at the root of this message's causal chain —
+    # the type counterpart of {#correlation_id}.
+    #
+    # A message that was not produced by {#correlate} is its own root, so
+    # this is its own {#type}. A correlated message inherits its source's
+    # +correlation_type+, so every consequence of a command — the events it
+    # produced, the commands those events triggered, their events in turn —
+    # answers with the originating command's type. This is what lets a
+    # subscriber that only knows the command it sent recognise everything
+    # that came of it, without knowing the shape of each downstream message.
+    #
+    # Setting +metadata[:correlation_type]+ explicitly on a message before it
+    # is correlated starts a new chain from it: the target's own metadata wins
+    # the merge in {#correlate}.
+    #
+    # @return [String] a message type string
+    def correlation_type
+      metadata.fetch(CORRELATION_TYPE_KEY, type)
+    end
+
     # Set causation and correlation IDs on another message, establishing
-    # a causal link from this message to +message+. Merges metadata.
+    # a causal link from this message to +message+. Merges metadata, with the
+    # target's keys winning, and records this message's {#correlation_type}
+    # under {CORRELATION_TYPE_KEY} unless the target already carries one.
     #
     # @param message [Message] the message to correlate
     # @return [Message] a copy of +message+ with causation/correlation set
@@ -241,11 +266,14 @@ module Sourced
     #   caused = source_event.correlate(SomeCommand.new(payload: { ... }))
     #   caused.causation_id  # => source_event.id
     #   caused.correlation_id # => source_event.correlation_id
+    #   caused.correlation_type # => source_event.correlation_type
     def correlate(message)
       attrs = {
         causation_id: id,
         correlation_id: correlation_id,
-        metadata: metadata.merge(message.metadata || Plumb::BLANK_HASH)
+        metadata: { CORRELATION_TYPE_KEY => correlation_type }
+          .merge(metadata)
+          .merge(message.metadata || Plumb::BLANK_HASH)
       }
       message.with(attrs)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sourced-message
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Ismael Celis
@@ -13,16 +13,16 @@ dependencies:
   name: plumb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0.beta.2
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0.beta.2
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: fugit
   requirement: !ruby/object:Gem::Requirement