upkeep-rails 0.2.5-aarch64-linux-gnu

data/lib/upkeep/rails/cluster_guard.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Upkeep
+  module Rails
+    # Detects boot configurations where live updates silently break across
+    # cluster workers: an in-process cable adapter or an in-memory
+    # subscription store cannot reach browsers or subscriptions held by
+    # another process.
+    class ClusterGuard
+      IN_PROCESS_CABLE_ADAPTERS = %w[async].freeze
+
+      attr_reader :cable_adapter, :worker_count, :subscription_store, :environment
+
+      def initialize(cable_adapter:, worker_count:, subscription_store:, environment:)
+        @cable_adapter = cable_adapter.to_s
+        @worker_count = worker_count.to_i
+        @subscription_store = subscription_store&.to_sym
+        @environment = environment.to_s
+      end
+
+      def clustered?
+        worker_count.positive?
+      end
+
+      def problems
+        return [] unless clustered?
+
+        problems = []
+        if IN_PROCESS_CABLE_ADAPTERS.include?(cable_adapter)
+          problems << "the #{cable_adapter} Action Cable adapter is in-process, so broadcasts from one worker " \
+            "never reach sockets held by another; configure a cross-process cable adapter such as solid_cable " \
+            "or redis in config/cable.yml"
+        end
+        if subscription_store == :memory
+          problems << "subscription_store=:memory is per-process, so subscriptions registered in one worker are " \
+            "invisible to the others; set config.upkeep.subscription_store = :active_record"
+        end
+        problems
+      end
+
+      def error?
+        problems.any? && environment == "production"
+      end
+
+      def warning?
+        problems.any? && !error?
+      end
+
+      def message
+        return if problems.empty?
+
+        "Upkeep detected a clustered server (#{worker_count} workers) with a configuration that cannot " \
+          "deliver live updates across processes: #{problems.join("; ")}."
+      end
+    end
+  end
+end

data/lib/upkeep/rails/configuration.rb

@@ -0,0 +1,252 @@
+# frozen_string_literal: true
+
+module Upkeep
+  module Rails
+    class ConfigurationError < StandardError; end
+
+    class Configuration
+      SUBSCRIPTION_STORES = [:active_record, :memory].freeze
+      REFUSED_BOUNDARY_BEHAVIORS = [:raise, :warn].freeze
+      REQUEST_ACTIVATIONS = [:all, :opt_in].freeze
+      IDENTITY_SOURCES = [:current, :session, :cookie, :warden].freeze
+
+      class IdentityDefinition
+        attr_reader :name, :source, :source_key, :subscribe_block
+
+        def initialize(name:, source:, source_key:, subscribe_block:, absent_block: nil)
+          @name = name.to_sym
+          @source = source.to_sym
+          @source_key = source_key
+          @subscribe_block = subscribe_block
+          @absent_block = absent_block
+        end
+
+        def matches_dependency?(dependency)
+          case source
+          when :current
+            dependency.source == :current_attribute &&
+              metadata_value(dependency, :owner) == source_key.fetch(:owner) &&
+              metadata_value(dependency, :name) == source_key.fetch(:name)
+          when :session
+            dependency.source == :session && metadata_value(dependency, :key) == source_key
+          when :cookie
+            dependency.source == :cookie && metadata_value(dependency, :key) == source_key
+          when :warden
+            dependency.source == :warden_user && metadata_value(dependency, :scope) == source_key
+          else
+            false
+          end
+        end
+
+        def matches_source?(source, key)
+          source = source.to_sym
+
+          case self.source
+          when :current
+            source == :current &&
+              key.fetch(:owner).to_s == source_key.fetch(:owner) &&
+              key.fetch(:name).to_s == source_key.fetch(:name)
+          when :session, :cookie, :warden
+            source == self.source && key.to_s == source_key
+          else
+            false
+          end
+        end
+
+        def absent?(value)
+          return value.nil? unless @absent_block
+
+          @absent_block.arity == 1 ? @absent_block.call(value) : @absent_block.call
+        end
+
+        def absent_dependency?(dependency)
+          Upkeep::Dependencies.identity_absent_for?(dependency, name)
+        end
+
+        def source_label
+          case source
+          when :current
+            "#{source_key.fetch(:owner)}.#{source_key.fetch(:name)}"
+          when :session
+            "session[:#{source_key}]"
+          when :cookie
+            "cookies[:#{source_key}]"
+          when :warden
+            "warden.user(:#{source_key})"
+          end
+        end
+
+        private
+
+        def metadata_value(dependency, key)
+          value = dependency.metadata[key] || dependency.metadata[key.to_s]
+          value.to_s
+        end
+      end
+
+      class IdentityBuilder
+        attr_reader :subscribe_block, :absent_block
+
+        def absent_if(&block)
+          @absent_block = block
+        end
+
+        def subscribe(&block)
+          @subscribe_block = block
+        end
+      end
+
+      attr_accessor :enabled
+      attr_accessor :activation_token_expires_in
+      attr_accessor :delivery_batch_window
+      # Seconds a subscription may go untouched before it counts as abandoned
+      # and becomes eligible for pruning. Connected pages are kept alive by the
+      # cable channel heartbeat, which fires far more often than this TTL.
+      attr_accessor :subscription_ttl
+      # Test/console hook: deliver changes synchronously in the caller instead
+      # of on the in-process background dispatcher.
+      attr_accessor :deliver_inline
+      attr_reader :subscription_store
+      attr_reader :request_activation
+
+      def initialize
+        @enabled = true
+        @subscription_store = :active_record
+        @deliver_inline = false
+        @delivery_batch_window = 0.01
+        @refused_boundary_behavior = nil
+        @request_activation = :all
+        @activation_token_expires_in = 24 * 60 * 60
+        @subscription_ttl = 24 * 60 * 60
+        @identity_definitions = {}
+      end
+
+      def subscription_store=(value)
+        value = value.to_sym if value.respond_to?(:to_sym)
+
+        unless SUBSCRIPTION_STORES.include?(value)
+          raise ConfigurationError,
+            "Unknown Upkeep subscription_store #{value.inspect}; expected one of #{SUBSCRIPTION_STORES.join(", ")}"
+        end
+
+        @subscription_store = value
+      end
+
+      def refused_boundary_behavior
+        @refused_boundary_behavior || default_refused_boundary_behavior
+      end
+
+      def refused_boundary_behavior=(value)
+        value = value.to_sym if value.respond_to?(:to_sym)
+
+        unless REFUSED_BOUNDARY_BEHAVIORS.include?(value)
+          raise ConfigurationError,
+            "Unknown Upkeep refused_boundary_behavior #{value.inspect}; expected one of #{REFUSED_BOUNDARY_BEHAVIORS.join(", ")}"
+        end
+
+        @refused_boundary_behavior = value
+      end
+
+      def request_activation=(value)
+        value = value.to_sym if value.respond_to?(:to_sym)
+
+        unless REQUEST_ACTIVATIONS.include?(value)
+          raise ConfigurationError,
+            "Unknown Upkeep request_activation #{value.inspect}; expected one of #{REQUEST_ACTIVATIONS.join(", ")}"
+        end
+
+        @request_activation = value
+      end
+
+      def identify(name, current: nil, session: nil, cookie: nil, warden: nil, &block)
+        source, source_key = identity_source(current: current, session: session, cookie: cookie, warden: warden)
+        builder = IdentityBuilder.new
+        if block
+          block.arity == 1 ? block.call(builder) : builder.instance_eval(&block)
+        end
+
+        unless builder.subscribe_block
+          raise ConfigurationError, "config.identify :#{name} requires a subscribe block"
+        end
+
+        @identity_definitions[name.to_sym] = IdentityDefinition.new(
+          name: name,
+          source: source,
+          source_key: source_key,
+          subscribe_block: builder.subscribe_block,
+          absent_block: builder.absent_block
+        )
+      end
+
+      def identity_presence_metadata(source:, key:, value:)
+        definitions = identity_definitions.select { |definition| definition.matches_source?(source, key) }
+        absent_by_name = definitions.to_h do |definition|
+          [definition.name.to_s, definition.absent?(value)]
+        end
+
+        {
+          partitioning: if definitions.any?
+            absent_by_name.values.any? { |absent| !absent }
+          else
+            !value.nil?
+          end,
+          absent_by_name: absent_by_name
+        }
+      end
+
+      def identity_definitions
+        @identity_definitions.values
+      end
+
+      def identity_definition(name)
+        @identity_definitions.fetch(name.to_sym)
+      end
+
+      def clear_identities!
+        @identity_definitions.clear
+      end
+
+      private
+
+      def identity_source(current:, session:, cookie:, warden:)
+        sources = {
+          current: current,
+          session: session,
+          cookie: cookie,
+          warden: warden
+        }.compact
+
+        unless sources.size == 1
+          raise ConfigurationError,
+            "config.identify requires exactly one source: #{IDENTITY_SOURCES.join(", ")}"
+        end
+
+        source, value = sources.first
+        [source, normalize_identity_source(source, value)]
+      end
+
+      def normalize_identity_source(source, value)
+        case source
+        when :current
+          owner, name = Array(value)
+          unless owner && name
+            raise ConfigurationError,
+              "config.identify current: expects [CurrentClass, :attribute]"
+          end
+
+          { owner: owner.to_s, name: name.to_s }
+        when :session, :cookie, :warden
+          value.to_s
+        end
+      end
+
+      def default_refused_boundary_behavior
+        if defined?(::Rails) && ::Rails.respond_to?(:env) && ::Rails.env.to_s == "production"
+          :warn
+        else
+          :raise
+        end
+      end
+    end
+  end
+end

data/lib/upkeep/rails/controller_runtime.rb

@@ -0,0 +1,187 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Upkeep
+  module Rails
+    module ControllerRuntime
+      extend ActiveSupport::Concern
+
+      SUPPRESS_KEY = :upkeep_rails_controller_runtime_suppressed
+
+      included do
+        class_attribute :upkeep_reactive_actions, instance_accessor: false, default: [].freeze
+        prepend_around_action :upkeep_capture_request
+      end
+
+      class_methods do
+        def upkeep_reactive(only:)
+          self.upkeep_reactive_actions = Array(only).map(&:to_s).freeze
+        end
+      end
+
+      # Public override point for host controllers. Return false to skip subscription
+      # capture and registration for this request. Writes are still captured and can
+      # update subscribed pages.
+      def upkeep_reactive_request?
+        return true if Upkeep::Rails.configuration.request_activation == :all
+
+        self.class.upkeep_reactive_actions.include?(action_name) || upkeep_reactive_continuation_request?
+      end
+
+      module_function
+
+      def install
+        return if @installed
+        return unless defined?(::ActionController::Base)
+
+        ::ActionController::Base.include(self)
+        @installed = true
+      end
+
+      def installed?
+        !!@installed
+      end
+
+      def reset!
+        @installed = false
+      end
+
+      def suppress
+        previous = Thread.current[SUPPRESS_KEY]
+        Thread.current[SUPPRESS_KEY] = true
+        yield
+      ensure
+        Thread.current[SUPPRESS_KEY] = previous
+      end
+
+      def suppressed?
+        Thread.current[SUPPRESS_KEY]
+      end
+
+      private
+
+      def upkeep_capture_request(&action)
+        return action.call if ControllerRuntime.suppressed?
+        return action.call if Upkeep::Runtime::Observation.recorder
+
+        payload = {
+          controller: self.class.name,
+          action: action_name,
+          method: request.request_method,
+          path: request.fullpath,
+          subscription_request: upkeep_subscription_request?
+        }
+        ActiveSupport::Notifications.instrument(Upkeep::Rails::REQUEST_CAPTURE, payload) do
+          upkeep_capture_request_with_timing(action, payload)
+        end
+      end
+
+      def upkeep_capture_request_with_timing(action, payload)
+        measure_phase(payload, :deliver_pending_ms) { Upkeep::Rails.deliver_changes_now! }
+
+        result = nil
+        capture = nil
+        changes = []
+        measure_phase(payload, :change_capture_ms) do
+          _captured, changes = Upkeep::Runtime::ChangeLog.capture do
+            if payload.fetch(:subscription_request)
+              capture = Upkeep::Capture::Request.call(self, profile: request_capture_profile?) { action.call }
+              result = capture.action_result
+            else
+              measure_phase(payload, :action_ms) { result = action.call }
+            end
+          end
+        end
+        changes = upkeep_stamp_change_request_id(changes)
+        record_capture_payload(payload, capture) if capture
+
+        measure_phase(payload, :deliver_changes_ms) do
+          if capture
+            Upkeep::Rails.deliver_changes_now!(changes)
+          else
+            Upkeep::Rails.deliver_changes!(changes)
+          end
+        end
+
+        registration = nil
+        if capture
+          measure_phase(payload, :register_ms) do
+            registration = Upkeep::Rails.register_controller_subscription(self, capture)
+          end
+        end
+        payload[:registered] = !!registration
+        if capture && registration
+          measure_phase(payload, :inject_ms) do
+            Upkeep::Rails::ClientSubscription.headers_for(
+              identity: registration.identity,
+              subscription: registration.subscription
+            ).each { |name, value| response.headers[name] = value }
+            response.body = Upkeep::Rails::ClientSubscription.inject(
+              capture.html,
+              identity: registration.identity,
+              subscription: registration.subscription
+            )
+          end
+          payload[:subscription_id] = registration.subscription.id
+        end
+
+        result
+      end
+
+      # GET writes can otherwise self-refresh in a loop. Mutation deliveries must
+      # still reach the originating tab when the response omits an affected region.
+      def upkeep_stamp_change_request_id(changes)
+        return changes unless request.get? || request.head?
+
+        request_id = upkeep_turbo_request_id
+        return changes unless request_id
+
+        changes.map { |change| change.respond_to?(:merge) ? change.merge(request_id: request_id) : change }
+      end
+
+      def upkeep_turbo_request_id
+        turbo_request_id = ::Turbo.current_request_id if defined?(::Turbo) && ::Turbo.respond_to?(:current_request_id)
+        turbo_request_id || request.headers["X-Turbo-Request-Id"]
+      end
+
+      def record_capture_payload(payload, capture)
+        payload[:response_status] = capture.response_status
+        payload[:response_content_type] = capture.response_content_type
+        payload[:response_media_type] = capture.response_media_type
+        payload[:html_response] = capture.html_response?
+        payload[:response_successful] = capture.successful?
+        payload[:html_bytes] = capture.html.bytesize
+        payload[:graph_frames] = capture.recorder.graph.frame_nodes.size
+        payload[:graph_dependencies] = capture.recorder.graph.dependency_nodes.size
+        capture.timings.each do |phase, ms|
+          payload[:"capture_#{phase}"] = ms
+        end
+        capture.counters.each do |counter, value|
+          payload[:"capture_#{counter}"] = value
+        end
+      end
+
+      def measure_phase(payload, key)
+        started_at = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        yield
+      ensure
+        payload[key] = ((Process.clock_gettime(Process::CLOCK_MONOTONIC) - started_at) * 1000.0).round(3)
+      end
+
+      def upkeep_subscription_request?
+        upkeep_reactive_request? && request.format.html? && (request.get? || request.head?)
+      end
+
+      def upkeep_reactive_continuation_request?
+        request.headers["Turbo-Frame"].present? &&
+          request.headers[ClientSubscription::ID_HEADER].present? &&
+          request.headers[ClientSubscription::TOKEN_HEADER].present?
+      end
+
+      def request_capture_profile?
+        ActiveSupport::Notifications.notifier.listening?(Upkeep::Rails::REQUEST_CAPTURE)
+      end
+    end
+  end
+end

data/lib/upkeep/rails/install.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Upkeep
+  module Rails
+    module Install
+      module_function
+
+      def call
+        return unless Upkeep::Rails.configuration.enabled
+
+        Runtime::Install.call if defined?(::ActiveRecord::Base)
+        ActionViewCapture.install if defined?(::ActionView::Template)
+        ControllerRuntime.install if defined?(::ActionController::Base)
+        JobRuntime.install if defined?(::ActiveJob::Base)
+
+        @installed = true
+      end
+
+      def installed?
+        !!@installed
+      end
+
+      def reset!
+        @installed = false
+      end
+    end
+  end
+end

data/lib/upkeep/rails/job_runtime.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Upkeep
+  module Rails
+    module JobRuntime
+      extend ActiveSupport::Concern
+
+      included do
+        around_perform :upkeep_capture_job
+      end
+
+      module_function
+
+      def install
+        return if @installed
+        return unless defined?(::ActiveJob::Base)
+
+        ::ActiveJob::Base.include(self)
+        @installed = true
+      end
+
+      def installed?
+        !!@installed
+      end
+
+      def reset!
+        @installed = false
+      end
+
+      private
+
+      def upkeep_capture_job
+        return yield if Upkeep::Runtime::ChangeLog.capturing?
+
+        result, changes = Upkeep::Runtime::ChangeLog.capture { yield }
+        Upkeep::Rails.deliver_changes!(changes)
+        result
+      end
+    end
+  end
+end

data/lib/upkeep/rails/railtie.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Upkeep
+  module Rails
+    class Railtie < ::Rails::Railtie
+      config.upkeep = ActiveSupport::OrderedOptions.new
+
+      initializer "upkeep_rails.configure" do |app|
+        Upkeep::Rails.configure do |config|
+          config.enabled = app.config.upkeep.fetch(:enabled, true)
+          config.subscription_store = app.config.upkeep.fetch(:subscription_store, config.subscription_store)
+          config.deliver_inline = app.config.upkeep.fetch(:deliver_inline, config.deliver_inline)
+          config.delivery_batch_window =
+            app.config.upkeep.fetch(:delivery_batch_window, config.delivery_batch_window)
+          config.activation_token_expires_in =
+            app.config.upkeep.fetch(:activation_token_expires_in, config.activation_token_expires_in)
+          config.request_activation =
+            app.config.upkeep.fetch(:request_activation, config.request_activation)
+          config.refused_boundary_behavior =
+            app.config.upkeep.fetch(:refused_boundary_behavior, config.refused_boundary_behavior)
+        end
+      end
+
+      initializer "upkeep_rails.install", after: "turbo.helpers" do
+        ActiveSupport.on_load(:active_record) { Upkeep::Rails::Install.call }
+        ActiveSupport.on_load(:active_job) { Upkeep::Rails::Install.call }
+        ActiveSupport.on_load(:action_controller_base) { Upkeep::Rails::Install.call }
+        ActiveSupport.on_load(:action_view) { Upkeep::Rails::Install.call }
+      end
+
+      initializer "upkeep_rails.validate_configuration", after: "upkeep_rails.install" do |app|
+        app.config.after_initialize do
+          Upkeep::Rails.validate_configuration! unless Railtie.rake_task?
+        end
+      end
+
+      def self.rake_task?
+        defined?(::Rake) &&
+          ::Rake.respond_to?(:application) &&
+          ::Rake.application.top_level_tasks.any?
+      end
+    end
+  end
+end