command_tower 0.16.0 → 0.18.0

data/app/services/command_tower/messaging/rendering/inbox_document_renderer.rb

@@ -0,0 +1,224 @@
+# frozen_string_literal: true
+
+require "uri"
+
+module CommandTower
+  module Messaging
+    module Rendering
+      # Internal Messaging::Rendering collaborator (peer of `ChannelRenderer`,
+      # not a host-facing service). Builds the `InboxDocument` shown at Inbox
+      # detail read time.
+      #
+      # Generic path: one `paragraph` block from `communication.body`, plus an
+      # optional `cta` block with a typed `destination` — internal
+      # (`metadata["deep_link_path"]`, origin-free, host-navigation-owned) if
+      # present and safe, else external (`metadata["deep_link"]`) if that is
+      # a safe href (D-INBOX-GENERIC; typed destination added Slice 2.6.4).
+      #
+      # Optional per-`notification_type_key` override: a pure-Ruby composer
+      # class (`declaration.inbox_document_composer`, resolved via
+      # `NotificationTypes.lookup` + `.constantize`), `.call(communication:) ->
+      # InboxDocument`. Any failure (unregistered type, absent composer,
+      # unresolvable class name, a raising composer, or a composer returning
+      # something other than an `InboxDocument`) fails open to the generic
+      # document — the Inbox read path must never 500 on a bad type composer
+      # (D-INBOX-TYPE). This replaces the Rich Messaging Campaign 2 ERB/JSON
+      # authoring path entirely — see
+      # artifacts/visual-improvements/rich-messaging/authority/RICH_MESSAGING_RUBY_INBOX_DEFINITION_DISCOVERY.md.
+      #
+      # After the document (type-specific or generic) is built, any
+      # `"presentation"` block is resolved against
+      # `CommandTower.config.registry.inbox_presentations` — at most one
+      # attempted/resolved presentation capability per document (Rich
+      # Messaging Slice 2.5). The budget is consumed the instant a
+      # `"presentation"`-typed block is seen, before lookup or composition,
+      # regardless of outcome, so a malformed/unregistered first node cannot
+      # fail open and then let a second node still execute composer domain
+      # I/O.
+      #
+      # A stored `inbox_presentation_snapshot` replaces that live resolution.
+      # Null means there is no retained presentation (legacy rows, or a
+      # document with no presentation node) and the live composer still runs.
+      # An omitted snapshot drops the presentation node and does not call
+      # the composer. A stored payload is rendered as-is.
+      #
+      # The composer's raw result is always projected down to the
+      # registration's declared `output_keys` before it reaches
+      # `content.blocks[].data` (corrective slice — presentation
+      # ServiceResult/context leak fix). Composer inputs and any other
+      # incidental context/result keys never reach the wire, regardless of
+      # whether the composer is `ApplicationService`-shaped or a plain Hash.
+      class InboxDocumentRenderer
+        UNSAFE_SCHEMES = %w[javascript data vbscript].freeze
+        DEFAULT_CTA_LABEL = "Open"
+
+        def self.render(communication:, recipient_id:)
+          new(communication:, recipient_id:).render
+        end
+
+        def self.compose_shell(communication)
+          new(communication:, recipient_id: nil).compose_shell
+        end
+
+        def initialize(communication:, recipient_id:)
+          @communication = communication
+          @recipient_id = recipient_id
+          @presentation_attempted = false
+        end
+
+        def render
+          document = compose_shell
+          snapshot = stored_presentation_snapshot
+          return resolve_presentation_blocks(document) if snapshot.nil?
+          return drop_presentation_blocks(document) if InboxPresentationSnapshot.omitted?(snapshot)
+
+          apply_stored_presentation(document, snapshot)
+        end
+
+        def compose_shell
+          build_from_type_composer || build_generic
+        end
+
+        private
+
+        attr_reader :communication, :recipient_id
+
+        def build_from_type_composer
+          declaration = CommandTower::Messaging::NotificationTypes.lookup(communication.notification_type_key)
+          composer_name = declaration.inbox_document_composer
+          return nil if composer_name.nil?
+
+          document = composer_name.constantize.call(communication:)
+          document.is_a?(InboxDocument) ? document : nil
+        rescue StandardError
+          # Fail-open: unregistered type, unresolvable class name, a raising
+          # composer, or a composer returning invalid data must never surface
+          # as a 500 on the Inbox read path (D-INBOX-TYPE).
+          nil
+        end
+
+        def build_generic
+          blocks = []
+          blocks << paragraph_block(communication.body) if communication.body.present?
+          cta = generic_cta_block
+          blocks << cta if cta
+
+          InboxDocument.build(blocks:)
+        end
+
+        # Re-walks the already-validated blocks array (produced either by a
+        # trusted Ruby composer via `InboxDocument::Builder` or by
+        # `build_generic`), resolving any `"presentation"` node in place.
+        # There is no untrusted JSON to parse/whitelist here — every block was
+        # already constructed via a whitelisted `Builder` method or this
+        # class's own `paragraph_block`/`cta_block` helpers.
+        def resolve_presentation_blocks(document)
+          resolved = document.blocks.map do |block|
+            block[:type] == "presentation" ? presentation_block(block) : block
+          end.compact
+
+          InboxDocument.build(blocks: resolved)
+        end
+
+        def presentation_block(block)
+          return nil if @presentation_attempted
+
+          @presentation_attempted = true
+          InboxPresentationResolver.resolve(communication:, recipient_id:, block:)
+        end
+
+        def stored_presentation_snapshot
+          raw = communication.inbox_presentation_snapshot
+          return nil if raw.blank?
+          return nil unless raw.respond_to?(:stringify_keys)
+
+          raw.stringify_keys
+        end
+
+        def drop_presentation_blocks(document)
+          InboxDocument.build(blocks: document.blocks.reject { |block| block[:type] == "presentation" })
+        end
+
+        def apply_stored_presentation(document, snapshot)
+          applied = false
+          blocks = document.blocks.filter_map do |block|
+            next block unless block[:type] == "presentation"
+            next nil if applied
+
+            applied = true
+            stored_presentation_block(snapshot)
+          end
+
+          InboxDocument.build(blocks:)
+        end
+
+        def stored_presentation_block(snapshot)
+          data = snapshot["data"].respond_to?(:to_h) ? snapshot["data"].to_h.deep_symbolize_keys : {}
+          {
+            type: "presentation",
+            key: snapshot["key"].to_s,
+            variant: snapshot["variant"],
+            data:,
+          }.freeze
+        end
+
+        def paragraph_block(text)
+          return nil unless text.is_a?(String)
+          return nil if text.empty?
+
+          { type: "paragraph", text: }.freeze
+        end
+
+        def generic_cta_block
+          cta_block(
+            label: metadata_value("cta_label"),
+            path: metadata_value("deep_link_path"),
+            href: metadata_value("deep_link")
+          )
+        end
+
+        # Internal (`path`) takes precedence over external (`href`) when
+        # both are present — a `cta` only ever means one navigation intent
+        # (Slice 2.6.4 typed destination; see artifacts/visual-improvements/
+        # rich-messaging/plans/2.6.4-ct-fe-inbox-navigation-capability.md).
+        def cta_block(label:, path: nil, href: nil)
+          destination = cta_destination(path:, href:)
+          return nil unless destination
+
+          resolved_label = label.is_a?(String) && !label.strip.empty? ? label : DEFAULT_CTA_LABEL
+          { type: "cta", label: resolved_label, destination: }.freeze
+        end
+
+        def cta_destination(path:, href:)
+          if safe_internal_path?(path)
+            { kind: "internal", path: }
+          elsif safe_href?(href)
+            { kind: "external", href: }
+          end
+        end
+
+        # A leading `//` is rejected even though it "starts with a slash" —
+        # it is a protocol-relative URL, not a safe same-app-only destination.
+        def safe_internal_path?(path)
+          path.is_a?(String) && path.start_with?("/") && !path.start_with?("//")
+        end
+
+        def safe_href?(href)
+          return false unless href.is_a?(String) && !href.strip.empty?
+
+          scheme = URI.parse(href).scheme&.downcase
+          scheme.present? && UNSAFE_SCHEMES.exclude?(scheme)
+        rescue URI::InvalidURIError
+          false
+        end
+
+        def metadata_value(key)
+          metadata = communication.metadata
+          return nil unless metadata.is_a?(Hash)
+
+          metadata[key] || metadata[key.to_sym]
+        end
+      end
+    end
+  end
+end

data/app/services/command_tower/messaging/rendering/inbox_presentation_resolver.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module CommandTower
+  module Messaging
+    module Rendering
+      # Resolves one presentation block through the inbox presentation registry.
+      # Returns the projected block, or nil when the capability is missing,
+      # the composer fails, or the composer raises. Does not persist and does
+      # not perform network I/O. Callers own the one-presentation budget.
+      class InboxPresentationResolver
+        def self.resolve(communication:, recipient_id:, block:)
+          new(communication:, recipient_id:, block:).resolve
+        end
+
+        def initialize(communication:, recipient_id:, block:)
+          @communication = communication
+          @recipient_id = recipient_id
+          @block = block
+        end
+
+        def resolve
+          definition = CommandTower.config.registry.inbox_presentations.fetch(block[:key])
+          raw_data = unwrap(definition.composer_class.constantize.call(communication:, recipient_id:))
+          return nil if raw_data.nil?
+
+          {
+            type: "presentation",
+            key: block[:key],
+            variant: block[:variant],
+            data: raw_data.to_h.slice(*definition.output_keys),
+          }.freeze
+        rescue StandardError
+          nil
+        end
+
+        private
+
+        attr_reader :communication, :recipient_id, :block
+
+        def unwrap(composer_result)
+          if composer_result.respond_to?(:success?)
+            return nil unless composer_result.success?
+
+            composer_result.data
+          else
+            composer_result
+          end
+        end
+      end
+    end
+  end
+end

data/app/services/command_tower/messaging/rendering/inbox_presentation_snapshot.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module CommandTower
+  module Messaging
+    module Rendering
+      # Captures the first presentation node's projected data at Accept time.
+      # Returns nil when the document has no presentation node. Returns an
+      # omitted marker when a presentation node was seen and capture failed.
+      # Never persists and never performs network I/O.
+      class InboxPresentationSnapshot
+        VERSION = 1
+
+        def self.capture(communication:, recipient_id:)
+          new(communication:, recipient_id:).capture
+        end
+
+        def self.omitted?(snapshot)
+          snapshot.is_a?(Hash) && snapshot.stringify_keys["omitted"] == true
+        end
+
+        def initialize(communication:, recipient_id:)
+          @communication = communication
+          @recipient_id = recipient_id
+        end
+
+        def capture
+          block = first_presentation_block
+          return nil if block.nil?
+
+          capture_seen_block(block)
+        end
+
+        private
+
+        attr_reader :communication, :recipient_id
+
+        def capture_seen_block(block)
+          resolved = InboxPresentationResolver.resolve(communication:, recipient_id:, block:)
+          resolved.nil? ? omitted_marker : payload(resolved)
+        rescue StandardError
+          omitted_marker
+        end
+
+        def first_presentation_block
+          document = InboxDocumentRenderer.compose_shell(communication)
+          document.blocks.find { |block| block[:type] == "presentation" }
+        end
+
+        def payload(resolved)
+          {
+            "v" => VERSION,
+            "key" => resolved[:key].to_s,
+            "variant" => resolved[:variant],
+            "data" => resolved[:data].deep_stringify_keys,
+          }
+        end
+
+        def omitted_marker
+          { "v" => VERSION, "omitted" => true }
+        end
+      end
+    end
+  end
+end

data/app/services/command_tower/messaging/rendering/template_resolver.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require "action_view"
+
+module CommandTower
+  module Messaging
+    module Rendering
+      # Internal Execution-pipeline collaborator (not a Service/Workflow/Controller).
+      #
+      # Resolves one rendered-destination basename (e.g. "email", "sms") to an
+      # ActionView template, preferring a `notification_type_key`-specific view
+      # over the generic one, and preferring the host application's `app/views`
+      # over CommandTower's own engine views for either.
+      #
+      # Host convention (documentation, not code):
+      #
+      #   app/views/command_tower/messaging/rendering/
+      #     email.html.erb                     # optional host override of the generic chrome
+      #     <notification_type_key>/email.html.erb  # optional type-specific override
+      #
+      # Hosts customize by dropping ERB files at that path; they never call this
+      # class directly. `ChannelRenderer` remains the only public Ruby entry into
+      # rendering. `prepend_view_path`/`reset_view_paths!` exist solely as a
+      # messaging spec fixture seam (mirrors Rails' own `prepend_view_path`
+      # testing idiom) and are not part of any host-facing contract.
+      class TemplateResolver
+        TEMPLATE_PREFIX = "command_tower/messaging/rendering"
+        TYPE_KEY_PATTERN = /\A[a-z0-9_]+\z/
+
+        class << self
+          def render(basename:, format:, notification_type_key:, generic_locals:, type_locals:)
+            new.render(
+              basename:,
+              format:,
+              notification_type_key:,
+              generic_locals:,
+              type_locals:,
+            )
+          end
+
+          # Spec-only seam: prepend an additional view root ahead of the host
+          # and engine defaults so fixture views can prove override precedence.
+          def prepend_view_path(path)
+            extra_view_paths.unshift(path.to_s)
+          end
+
+          def reset_view_paths!
+            extra_view_paths.clear
+          end
+
+          # Type-only, no-generic-fallback resolution: returns `nil` when
+          # there is no matching type template (invalid/sanitized-out key, or
+          # the type directory/basename simply does not exist) instead of
+          # raising `Errno::ENOENT` like `.render` does. Callers that have no
+          # generic ERB file to fall back to (e.g. `InboxDocumentRenderer`,
+          # whose generic path is a pure-Ruby builder) use this instead of
+          # `.render`. A template that is *found* but raises mid-render still
+          # propagates (via `render_named`'s `ActionView::Template::Error`
+          # unwrap) so callers can distinguish "no type content" from "type
+          # content is broken" if they choose to.
+          def render_type_template(basename:, format:, notification_type_key:, locals:)
+            new.render_type_template(basename:, format:, notification_type_key:, locals:)
+          end
+
+          def extra_view_paths
+            @extra_view_paths ||= []
+          end
+        end
+
+        def render(basename:, format:, notification_type_key:, generic_locals:, type_locals:)
+          type_key = sanitized_type_key(notification_type_key)
+
+          if type_key
+            begin
+              return render_named("#{TEMPLATE_PREFIX}/#{type_key}/#{basename}", format, type_locals)
+            rescue ActionView::MissingTemplate
+              # No type-specific template for this basename; fall through to generic.
+            end
+          end
+
+          begin
+            render_named("#{TEMPLATE_PREFIX}/#{basename}", format, generic_locals)
+          rescue ActionView::MissingTemplate
+            raise Errno::ENOENT, "missing template #{basename}.#{format}.erb"
+          end
+        end
+
+        def render_type_template(basename:, format:, notification_type_key:, locals:)
+          type_key = sanitized_type_key(notification_type_key)
+          return nil unless type_key
+
+          render_named("#{TEMPLATE_PREFIX}/#{type_key}/#{basename}", format, locals)
+        rescue ActionView::MissingTemplate
+          nil
+        end
+
+        private
+
+        def sanitized_type_key(notification_type_key)
+          key = notification_type_key.to_s
+          key.match?(TYPE_KEY_PATTERN) ? key : nil
+        end
+
+        def render_named(template_name, format, locals)
+          view.render(template: template_name, formats: [format], locals:)
+        rescue ActionView::Template::Error => error
+          # ActionView wraps any error raised while executing a *found*
+          # template in `ActionView::Template::Error`. Legacy plain-ERB
+          # rendering never wrapped errors, so unwrap here to preserve the
+          # original `error_class` that `ChannelRenderer#render`'s outer
+          # rescue surfaces on `RenderError`.
+          raise(error.cause || error)
+        end
+
+        def view
+          @view ||= ActionView::Base.with_empty_template_cache.with_view_paths(view_paths)
+        end
+
+        def view_paths
+          self.class.extra_view_paths + [
+            Rails.root.join("app/views").to_s,
+            CommandTower::Engine.root.join("app/views").to_s,
+          ]
+        end
+      end
+    end
+  end
+end

data/app/services/command_tower/messaging.rb

@@ -13,7 +13,9 @@ module CommandTower
       metadata: nil,
       preference_state: nil,
       platform_enabled_channels:,
-      message_overrides: nil
+      message_overrides: nil,
+      conversation_key: nil,
+      conversation_title: nil
     )
       Accept::Coordinator.call(
         recipient_id:,
@@ -25,6 +27,8 @@ module CommandTower
         preference_state:,
         platform_enabled_channels:,
         message_overrides:,
+        conversation_key:,
+        conversation_title:,
       )
     end