upkeep-rails 0.2.5-aarch64-linux-gnu

data/lib/upkeep/rails.rb

@@ -0,0 +1,466 @@
+# frozen_string_literal: true
+
+require "active_support/notifications"
+require_relative "capture/request"
+require_relative "subscriptions/registrar"
+require_relative "rails/configuration"
+require_relative "rails/cluster_guard"
+require_relative "rails/activation_token"
+require_relative "rails/replay"
+require_relative "rails/action_view_capture"
+require_relative "rails/cable"
+require_relative "rails/client_subscription"
+require_relative "rails/controller_runtime"
+require_relative "rails/job_runtime"
+require_relative "rails/install"
+require_relative "rails/testing"
+require_relative "rails/railtie" if defined?(::Rails::Railtie)
+
+module Upkeep
+  module Rails
+    SUBSCRIPTION_IDENTITY = "upkeep.subscription_identity"
+    REQUEST_CAPTURE = "request_capture.upkeep"
+    DELIVERY_ENQUEUE = "delivery_enqueue.upkeep"
+    DELIVERY_ENQUEUE_ERROR = "delivery_enqueue_error.upkeep"
+    INTERNAL_DELIVERY_TABLES = %w[
+      upkeep_subscriptions
+      upkeep_subscription_index_entries
+      upkeep_subscription_shape_index_entries
+    ].freeze
+
+    class << self
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      def configure
+        yield configuration
+      end
+
+      def subscriptions
+        discard_subscription_store! if @subscriptions && subscription_store_config_changed?
+        @subscriptions ||= build_subscription_store
+      end
+
+      def transport
+        @transport ||= Delivery::BroadcastTransport.new
+      end
+
+      def reset_runtime!
+        @delivery_dispatcher&.shutdown
+        @delivery_dispatcher = nil
+        @subscription_shape_cache&.reset
+        @subscription_registrar = nil
+        discard_subscription_store! if @subscriptions
+        @subscriptions = build_subscription_store
+        @subscriptions.reset
+        @transport = Delivery::BroadcastTransport.new
+      end
+
+      def register_controller_subscription(controller, capture)
+        return unless subscription_response?(controller, capture)
+
+        unless capture.recorder.reactive?
+          decision = Cable::SubscriberIdentity.decision_for(controller.request, recorder: capture.recorder)
+          request_subscription_reload(controller, "refused_boundary") if controller.request.headers["Turbo-Frame"].present?
+          instrument_subscription_identity(
+            decision,
+            registered: false,
+            deopt_reason: "refused_boundary",
+            refused_boundaries: capture.recorder.refused_boundaries.map(&:reason)
+          )
+          return
+        end
+
+        recorder, base_subscription = controller_subscription_recorder(controller, capture)
+        return unless recorder
+
+        decision = Cable::SubscriberIdentity.decision_for(controller.request, recorder: recorder)
+
+        identity = Cable::SubscriberIdentity.derive_from_request(
+          controller.request,
+          recorder: recorder,
+          decision: decision
+        )
+        unless replacement_identity_valid?(base_subscription, identity)
+          request_subscription_reload(controller, "subscriber_identity_changed")
+          instrument_subscription_identity(decision, registered: false, deopt_reason: "subscriber_identity_changed")
+          return
+        end
+
+        request_signature = base_subscription ?
+          metadata_value(base_subscription, :request_signature) :
+          capture.signature
+        registration = subscription_registrar.register(
+          identity: identity,
+          decision: decision,
+          recorder: recorder,
+          signature: request_signature,
+          metadata: identity_metadata(decision).merge(
+            path: base_subscription ? metadata_value(base_subscription, :path) : controller.request.fullpath,
+            stream_name: identity.stream_name,
+            request_signature: request_signature.respond_to?(:to_h) ? request_signature.to_h : request_signature,
+            replaces_subscription_id: base_subscription&.id
+          )
+        )
+        instrument_subscription_identity(decision, registered: true, subscription: registration.subscription)
+
+        registration
+      rescue Cable::UnidentifiedSubscriber => error
+        instrument_subscription_identity(
+          decision || Cable::SubscriberIdentity.decision_for(controller.request, recorder: recorder),
+          registered: false,
+          deopt_reason: "unidentified_identity",
+          error: error.message
+        )
+        nil
+      end
+
+      # Dispatches committed application changes onto the in-process delivery
+      # dispatcher (or synchronously when config.deliver_inline is set).
+      #
+      # ControllerRuntime calls this automatically after non-GET actions. Apps
+      # usually should not call it from controllers or models.
+      #
+      # @param changes [Array<#to_h>] change events to deliver. Defaults to the
+      #   current runtime change log.
+      # @return [Upkeep::Delivery::Transport::DispatchReport]
+      def deliver_changes!(changes = Runtime::ChangeLog.drain)
+        changes = deliverable_changes(changes)
+        record_testing_change_facts(changes)
+        return Delivery::Transport::DispatchReport.new([]) if changes.empty?
+
+        dispatch_changes(changes)
+      rescue StandardError => error
+        instrument_delivery_enqueue_error(changes, error)
+        Delivery::Transport::DispatchReport.new([])
+      end
+
+      # Delivers committed application changes immediately in the current
+      # process.
+      #
+      # This is used by inline delivery (config.deliver_inline). Tests that
+      # need deterministic async delivery should use Upkeep::Rails::Testing
+      # instead of calling this directly.
+      #
+      # @param changes [Array<#to_h>] change events to deliver. Defaults to the
+      #   current runtime change log.
+      # @return [Upkeep::Delivery::TurboStreams::Batch, Upkeep::Delivery::Transport::DispatchReport]
+      def deliver_changes_now!(changes = Runtime::ChangeLog.drain)
+        changes = deliverable_changes(changes)
+        record_testing_change_facts(changes)
+        return Delivery::Transport::DispatchReport.new([]) if changes.empty?
+
+        batch = delivery_batch_for([changes])
+        deliver_batch(batch)
+      end
+
+      def validate_configuration!(environment: rails_environment)
+        return true unless configuration.enabled
+
+        validate_subscription_store!(environment: environment)
+        validate_cluster_safety!(environment: environment)
+        true
+      end
+
+      private
+
+      def delivery_dispatcher
+        @delivery_dispatcher ||= Delivery::AsyncDispatcher.new(batch_window: configuration.delivery_batch_window) do |change_sets|
+          batch = delivery_batch_for(change_sets)
+          deliver_batch(batch)
+        end
+      end
+
+      def drain_delivery_dispatcher!
+        @delivery_dispatcher&.drain
+      end
+
+      def dispatch_changes(changes)
+        payload = {
+          inline: configuration.deliver_inline,
+          change_count: changes.size
+        }
+
+        ActiveSupport::Notifications.instrument(DELIVERY_ENQUEUE, payload) do
+          if configuration.deliver_inline
+            deliver_changes_now!(changes)
+          else
+            delivery_dispatcher.enqueue(changes)
+          end
+        end
+      end
+
+      def instrument_delivery_enqueue_error(changes, error)
+        ActiveSupport::Notifications.instrument(
+          DELIVERY_ENQUEUE_ERROR,
+          inline: configuration.deliver_inline,
+          change_count: changes.size,
+          error_class: error.class.name,
+          error_message: error.message
+        )
+      end
+
+      def subscription_registrar
+        @subscription_registrar ||= Subscriptions::Registrar.new(
+          store: subscriptions,
+          shape_cache: subscription_shape_cache
+        )
+      end
+
+      def subscription_shape_cache
+        @subscription_shape_cache ||= Subscriptions::ShapeCache.new
+      end
+
+      def delivery_batch_for(change_sets)
+        change_sets = compact_change_sets(change_sets)
+        return Delivery::TurboStreams::Batch.new([]) if change_sets.empty?
+
+        planner = Invalidation::Planner.new(store: subscriptions)
+        plans = change_sets.map { |changes| planner.plan(changes) }
+        plans = plans.reject { |plan| plan.targets.empty? }
+        return Delivery::TurboStreams::Batch.new([]) if plans.empty?
+
+        Delivery::TurboStreams.new.build_many(plans)
+      end
+
+      def deliver_batch(batch)
+        record_testing_delivery_batch(batch)
+        transport.deliver(batch)
+      end
+
+      def compact_change_sets(change_sets)
+        change_sets
+          .map { |changes| deliverable_changes(changes) }
+          .reject(&:empty?)
+          .uniq { |changes| change_set_key(changes) }
+      end
+
+      def deliverable_changes(changes)
+        Array(changes).reject { |change| internal_delivery_change?(change) }
+      end
+
+      def record_testing_change_facts(changes)
+        return unless defined?(Testing) && Testing.respond_to?(:record_change_facts)
+        return if Testing.respond_to?(:capturing_change_facts?) && !Testing.capturing_change_facts?
+
+        Testing.record_change_facts(changes)
+      end
+
+      def record_testing_delivery_batch(batch)
+        return unless defined?(Testing) && Testing.respond_to?(:record_delivery_batch)
+        return if Testing.respond_to?(:capturing_broadcasts?) && !Testing.capturing_broadcasts?
+
+        Testing.record_delivery_batch(batch)
+      end
+
+      def internal_delivery_change?(change)
+        INTERNAL_DELIVERY_TABLES.include?(change_value(change, :table).to_s)
+      end
+
+      def change_set_key(changes)
+        changes.map { |change| change_key(change) }.sort
+      end
+
+      def change_key(change)
+        [
+          change_value(change, :type).to_s,
+          change_value(change, :table).to_s,
+          change_value(change, :model).to_s,
+          change_value(change, :id).to_s,
+          Array(change_value(change, :changed_attributes)).map(&:to_s).sort,
+          change_value(change, :old_values).inspect,
+          change_value(change, :new_values).inspect
+        ]
+      end
+
+      def change_value(change, key)
+        return unless change.respond_to?(:[])
+
+        change[key] || change[key.to_s]
+      end
+
+      def discard_subscription_store!
+        @subscriptions&.shutdown
+        @subscriptions = nil
+        @subscription_registrar = nil
+      end
+
+      def identity_metadata(decision)
+        {
+          identity_mode: decision.mode,
+          anonymous: decision.anonymous,
+          anonymous_deopt_reason: decision.deopt_reason,
+          identity_sources: decision.identity_sources,
+          identity_names: decision.identity_names
+        }.compact
+      end
+
+      def instrument_subscription_identity(decision, registered:, subscription: nil, deopt_reason: nil, **extra)
+        ActiveSupport::Notifications.instrument(
+          SUBSCRIPTION_IDENTITY,
+          {
+            registered: registered,
+            subscription_id: subscription&.id,
+            subscriber_id: subscription&.subscriber_id,
+            identity_mode: decision&.mode,
+            anonymous: decision&.anonymous,
+            anonymous_deopt_reason: deopt_reason || decision&.deopt_reason,
+            identity_sources: decision&.identity_sources,
+            identity_names: decision&.identity_names
+          }.merge(extra)
+        )
+      end
+
+      def subscription_response?(controller, capture)
+        controller.request.get? &&
+          capture.successful? &&
+          capture.html_response? &&
+          capture.html.include?("</") &&
+          capture.recorder.graph.frame_nodes.any?
+      end
+
+      def controller_subscription_recorder(controller, capture)
+        target_id = controller.request.headers["Turbo-Frame"].to_s
+        return [capture.recorder, nil] if target_id.empty?
+
+        subscription_id = controller.request.headers[ClientSubscription::ID_HEADER].to_s
+        token = controller.request.headers[ClientSubscription::TOKEN_HEADER].to_s
+        return [capture.recorder, nil] if subscription_id.empty? && token.empty?
+
+        unless !subscription_id.empty? && ActivationToken.valid_for_subscription?(token, subscription_id)
+          request_subscription_reload(controller, "invalid_base_subscription")
+          return
+        end
+
+        base_subscription = subscriptions.fetch_for_composition(subscription_id)
+        scope_id = "turbo_frame:#{target_id}"
+        recorder = base_subscription.recorder.replace_scope(scope_id, capture.recorder)
+        [recorder, base_subscription]
+      rescue KeyError
+        request_subscription_reload(controller, "missing_frame_scope")
+        nil
+      end
+
+      def replacement_identity_valid?(base_subscription, identity)
+        return true unless base_subscription
+        return true if metadata_value(base_subscription, :identity_mode) == Cable::SubscriberIdentity::ANONYMOUS_PUBLIC_MODE
+
+        base_subscription.subscriber_id == identity.subscriber_id
+      end
+
+      def request_subscription_reload(controller, reason)
+        controller.response.headers[ClientSubscription::ACTION_HEADER] = "reload"
+        controller.response.headers["X-Upkeep-Subscription-Reason"] = reason
+      end
+
+      def metadata_value(subscription, key)
+        subscription.metadata[key] || subscription.metadata[key.to_s]
+      end
+
+      def build_subscription_store
+        case configuration.subscription_store
+        when :active_record
+          schema_errors = Subscriptions::ActiveRecordStore.schema_errors(connect: true)
+          unless schema_errors.empty?
+            raise ConfigurationError,
+              active_record_subscription_store_error(schema_errors)
+          end
+
+          Subscriptions::ActiveRecordStore.new
+        when :memory
+          Subscriptions::Store.new
+        end.tap do
+          @subscription_store_name = configuration.subscription_store
+        end
+      end
+
+      def validate_subscription_store!(environment:)
+        if production_environment?(environment) && configuration.subscription_store == :memory
+          raise ConfigurationError,
+            "Upkeep subscription_store=:memory is only for development/test; production requires :active_record."
+        end
+
+        return true unless production_environment?(environment)
+        return true unless configuration.subscription_store == :active_record
+        schema_errors = Subscriptions::ActiveRecordStore.schema_errors(connect: true)
+        return true if schema_errors.empty?
+
+        raise ConfigurationError, active_record_subscription_store_error(schema_errors, production: true)
+      end
+
+      def active_record_subscription_store_error(schema_errors, production: false)
+        prefix = if production
+          "Upkeep production boot requires compatible upkeep_subscriptions, " \
+            "upkeep_subscription_index_entries, and upkeep_subscription_shape_index_entries tables " \
+            "for subscription_store=:active_record."
+        else
+          "Upkeep subscription_store=:active_record requires compatible upkeep_subscriptions, " \
+            "upkeep_subscription_index_entries, and upkeep_subscription_shape_index_entries tables."
+        end
+
+        "#{prefix} Schema errors: #{schema_errors.join("; ")}. Run bin/rails generate upkeep:install " \
+          "and bin/rails db:migrate, rebuild stale development/test databases, or set " \
+          "config.upkeep.subscription_store = :memory in development/test."
+      end
+
+      def validate_cluster_safety!(environment:, guard: nil)
+        guard ||= ClusterGuard.new(
+          cable_adapter: resolved_action_cable_adapter,
+          worker_count: detected_worker_count,
+          subscription_store: configuration.subscription_store,
+          environment: environment
+        )
+        return true if guard.problems.empty?
+        raise ConfigurationError, guard.message if guard.error?
+
+        log_cluster_warning(guard.message)
+        true
+      end
+
+      def log_cluster_warning(message)
+        return if @cluster_warning_logged
+
+        @cluster_warning_logged = true
+        if defined?(::Rails) && ::Rails.respond_to?(:logger) && ::Rails.logger
+          ::Rails.logger.warn("[upkeep] #{message}")
+        else
+          warn("[upkeep] #{message}")
+        end
+      end
+
+      def resolved_action_cable_adapter
+        return unless defined?(::ActionCable) && ::ActionCable.respond_to?(:server)
+
+        cable = ::ActionCable.server.config.cable
+        cable && (cable["adapter"] || cable[:adapter])
+      rescue StandardError
+        nil
+      end
+
+      def detected_worker_count
+        puma_worker_count || ENV["WEB_CONCURRENCY"].to_i
+      end
+
+      def puma_worker_count
+        return unless defined?(::Puma) && ::Puma.respond_to?(:cli_config)
+
+        ::Puma.cli_config&.options&.[](:workers)
+      rescue StandardError
+        nil
+      end
+
+      def production_environment?(environment)
+        environment.to_s == "production"
+      end
+
+      def rails_environment
+        ::Rails.env if defined?(::Rails) && ::Rails.respond_to?(:env)
+      end
+
+      def subscription_store_config_changed?
+        @subscription_store_name != configuration.subscription_store
+      end
+    end
+  end
+end