solid_objects 0.2.1 → 0.4.0

data/lib/solid_objects/test_helper.rb

@@ -0,0 +1,78 @@
+# rbs_inline: enabled
+
+require "solid_objects"
+
+module SolidObjects
+  module TestHelper
+    class << self
+      # @rbs (Class) -> void
+      def included(test_case)
+        test_case.use_transactional_tests = false if test_case.respond_to?(:use_transactional_tests=)
+        test_case.setup { reset_actors! }
+        test_case.teardown { reset_actors! }
+      end
+
+      # @rbs () -> void
+      def reset_actors!
+        SolidObjects.reset_caller_process!
+        Instance.delete_all
+        Process.delete_all
+      end
+    end
+
+    # @rbs () -> void
+    def reset_actors!
+      TestHelper.reset_actors!
+    end
+
+    # @rbs (?roles: Array[Symbol], ?max_passes: Integer) -> Integer
+    def drain_solid_objects(
+      roles: [ :reminders, :actors, :effects, :broadcasts ],
+      max_passes: 1_000
+    )
+      runners = build_solid_objects_runners(roles)
+      total = 0
+
+      max_passes.times do
+        processed = runners.sum { |runner| solid_objects_runner_result(runner) }
+        break if processed.zero?
+
+        total += processed
+      end
+
+      total
+    ensure
+      runners&.uniq&.each(&:stop)
+    end
+
+    private
+
+    # @rbs (Array[Symbol]) -> Array[Worker | EffectExecutor | ReminderScheduler | BroadcastExecutor]
+    def build_solid_objects_runners(roles)
+      unknown_roles = roles - [ :actors, :effects, :reminders, :broadcasts ]
+      raise ArgumentError, "unknown Solid Objects test roles: #{unknown_roles.join(", ")}" if unknown_roles.any?
+
+      runners = {}
+      runners[:actors] = Worker.new if roles.include?(:actors)
+      runners[:effects] = EffectExecutor.new if roles.include?(:effects)
+      runners[:reminders] = ReminderScheduler.new if roles.include?(:reminders)
+      runners[:broadcasts] = BroadcastExecutor.new if roles.include?(:broadcasts)
+
+      [
+        runners[:reminders],
+        runners[:actors],
+        runners[:effects],
+        runners[:actors],
+        runners[:broadcasts]
+      ].compact
+    end
+
+    # @rbs (Worker | EffectExecutor | ReminderScheduler | BroadcastExecutor) -> Integer
+    def solid_objects_runner_result(runner)
+      result = runner.run_once
+      return result if result.is_a?(Integer)
+
+      result ? 1 : 0
+    end
+  end
+end

data/lib/solid_objects/turbo_stream_renderer.rb

@@ -1,9 +1,13 @@
 # rbs_inline: enabled
 
 require "erb"
+require "base64"
 
 module SolidObjects
   module TurboStreamRenderer
+    INVALIDATION_MARKER = "solid_objects_invalidation:"
+    INVALIDATION_PATTERN = /<!--solid_objects_invalidation:([A-Za-z0-9_=-]+)-->/
+
     module_function
 
     # @rbs (Broadcast) -> String
@@ -12,7 +16,19 @@ module SolidObjects
         actor_type: broadcast.instance.actor_type,
         actor_id: broadcast.instance.actor_id
       )
-      observable_value(reference, broadcast.observable_name, broadcast.value)
+      stream = observable_value(
+        reference,
+        broadcast.observable_name,
+        broadcast.value
+      )
+      metadata = Base64.urlsafe_encode64(
+        JSON.generate(
+          "instance_id" => broadcast.instance_id,
+          "revision" => broadcast.message.sequence,
+          "observable_name" => broadcast.observable_name
+        )
+      )
+      "#{stream}<!--#{INVALIDATION_MARKER}#{metadata}-->"
     end
 
     # @rbs (Reference, Symbol | String, untyped) -> String
@@ -22,6 +38,34 @@ module SolidObjects
       %(<turbo-stream action="replace" target="#{target}"><template><span id="#{target}">#{content}</span></template></turbo-stream>)
     end
 
+    # @rbs (ComponentRegistration, Integer, Integer) -> String
+    def component_refresh(registration, instance_id, revision)
+      target = DomIdentity.component(
+        registration.reference,
+        registration.component_name
+      )
+      source = ERB::Util.html_escape(
+        registration.refresh_url(instance_id, revision)
+      )
+      revision_value = "#{instance_id}:#{revision}"
+      %(<turbo-stream action="replace" target="#{target}"><template><turbo-frame id="#{target}" src="#{source}" data-solid-objects-revision="#{revision_value}"></turbo-frame></template></turbo-stream>)
+    end
+
+    # @rbs (String) -> Hash[String, untyped]?
+    def invalidation(stream)
+      encoded = stream[INVALIDATION_PATTERN, 1]
+      return unless encoded
+
+      payload = JSON.parse(Base64.urlsafe_decode64(encoded))
+      return unless payload["instance_id"].is_a?(Integer)
+      return unless payload["revision"].is_a?(Integer)
+      return unless payload["observable_name"].is_a?(String)
+
+      payload
+    rescue ArgumentError, JSON::ParserError
+      nil
+    end
+
     # @rbs (untyped) -> String
     def display_value(value)
       return value if value.is_a?(String)

data/lib/solid_objects/version.rb

@@ -1,5 +1,5 @@
 # rbs_inline: enabled
 
 module SolidObjects
-  VERSION = "0.2.1"
+  VERSION = "0.4.0"
 end

data/lib/solid_objects/worker.rb

@@ -43,7 +43,7 @@ module SolidObjects
     rescue ActorDestroyed
       release_activation(activation) if activation
       0
-    rescue StateMigrationError, LostActivation => error
+    rescue StateMigrationError, ApplicationWriteForbidden, LostActivation => error
       release_activation(activation) if activation
       SolidObjects.configuration.logger.error(
         event: "solid_objects.worker.error",

data/lib/solid_objects.rb

@@ -12,6 +12,7 @@ require "securerandom"
 
 require "solid_objects/version"
 require "solid_objects/errors"
+require "solid_objects/sync_deadline"
 require "solid_objects/configuration"
 require "solid_objects/instrumentation"
 require "solid_objects/log_subscriber"
@@ -20,19 +21,31 @@ require "solid_objects/context"
 require "solid_objects/actor_registry"
 require "solid_objects/state"
 require "solid_objects/actor_definition"
+require "solid_objects/application_write_guard"
 require "solid_objects/actor"
 require "solid_objects/reference"
 require "solid_objects/message_reference"
 require "solid_objects/dead_letter_manager"
+require "solid_objects/message_pruner"
+require "solid_objects/instance_pruner"
+require "solid_objects/process_pruner"
 require "solid_objects/stream_name"
 require "solid_objects/dom_identity"
 require "solid_objects/stream_token"
+require "solid_objects/component_token"
+require "solid_objects/component_path_resolver"
 require "solid_objects/turbo_stream_renderer"
 require "solid_objects/actor_snapshot"
+require "solid_objects/component_registration"
+require "solid_objects/component_subscriptions"
+require "solid_objects/component_view"
+require "solid_objects/component_renderer"
+require "solid_objects/state_snapshot"
 require "solid_objects/actor_view"
 require "solid_objects/action_cable_broadcast_adapter"
 require "solid_objects/wake_up"
 require "solid_objects/effect_registry"
+require "solid_objects/commit_action_registry"
 require "solid_objects/lease"
 require "solid_objects/lease_renewer"
 require "solid_objects/worker"
@@ -72,6 +85,16 @@ module SolidObjects
       effect_registry.register(name, handler)
     end
 
+    # @rbs () -> CommitActionRegistry
+    def commit_action_registry
+      @commit_action_registry ||= CommitActionRegistry.new
+    end
+
+    # @rbs (String | Symbol) { (Hash[String, untyped], CommitActionContext) -> untyped } -> Proc
+    def register_commit_action(name, &handler)
+      commit_action_registry.register(name, handler)
+    end
+
     # @rbs () -> Client
     def client
       require "solid_objects/client"
@@ -84,6 +107,17 @@ module SolidObjects
       @caller_process ||= CallerProcess.new
     end
 
+    # @rbs () -> bool
+    def reset_caller_process!
+      caller_process = @caller_process
+      @caller_process = nil
+      return false unless caller_process
+
+      caller_process.stop
+    rescue ActiveRecord::ActiveRecordError
+      false
+    end
+
     # @rbs () -> DeadLetterManager
     def dead_letters
       @dead_letters ||= DeadLetterManager.new
@@ -99,6 +133,11 @@ module SolidObjects
       registry.register(type, actor_class)
     end
 
+    # @rbs (untyped) -> untyped
+    def mutable_copy(value)
+      Serialization.deep_copy(value)
+    end
+
     # @rbs () -> void
     def reset!
       @configuration = Configuration.new
@@ -108,6 +147,7 @@ module SolidObjects
       @wake_up = nil
       @caller_process = nil
       @effect_registry = EffectRegistry.new
+      @commit_action_registry = CommitActionRegistry.new
       @dead_letters = nil
     end
 

data/sig/generated/controllers/solid_objects/components_controller.rbs

@@ -0,0 +1,22 @@
+# Generated from app/controllers/solid_objects/components_controller.rb with RBS::Inline
+
+module SolidObjects
+  class ComponentsController < ActionController::Base
+    # @rbs () -> void
+    def show: () -> void
+
+    private
+
+    # @rbs () -> Array[Integer]
+    def requested_revision_key: () -> Array[Integer]
+
+    # @rbs (Array[Integer], ActorSnapshot) -> bool
+    def newer_than_snapshot?: (Array[Integer], ActorSnapshot) -> bool
+
+    # @rbs () -> untyped
+    def component_view_context: () -> untyped
+
+    # @rbs (ComponentRegistration, ActorSnapshot, untyped) -> String
+    def component_frame: (ComponentRegistration, ActorSnapshot, untyped) -> String
+  end
+end

data/sig/generated/lib/solid_objects/activation.rbs

@@ -59,6 +59,9 @@ module SolidObjects
     # @rbs (Instance) -> Actor
     def build_actor: (Instance) -> Actor
 
+    # @rbs () -> void
+    def release_lease: () -> void
+
     # @rbs () -> Message?
     def claim_next_message: () -> Message?
 

data/sig/generated/lib/solid_objects/actor.rbs

@@ -19,6 +19,19 @@ module SolidObjects
       def members: () -> [ :name, :arguments, :success_message_name, :failure_message_name ]
     end
 
+    class CommitActionIntent < Data
+      attr_reader name(): untyped
+
+      attr_reader arguments(): untyped
+
+      def self.new: (untyped name, untyped arguments) -> instance
+                  | (name: untyped, arguments: untyped) -> instance
+
+      def self.members: () -> [ :name, :arguments ]
+
+      def members: () -> [ :name, :arguments ]
+    end
+
     class ReminderIntent < Data
       attr_reader name(): untyped
 
@@ -114,6 +127,8 @@ module SolidObjects
 
     @reminder_intents: Array[ReminderIntent]
 
+    @commit_action_intents: Array[CommitActionIntent]
+
     @effect_intents: Array[EffectIntent]
 
     @state: State
@@ -136,6 +151,9 @@ module SolidObjects
     # @rbs (Symbol | String, ?on_success: Symbol | String?, ?on_failure: Symbol | String?, **untyped) -> nil
     def emit: (Symbol | String, ?on_success: Symbol | String?, ?on_failure: Symbol | String?, **untyped) -> nil
 
+    # @rbs (Symbol | String, **untyped) -> nil
+    def commit_action: (Symbol | String, **untyped) -> nil
+
     # @rbs (Symbol | String, at: Time, ?every: Numeric?, ?missed: Symbol | String, arguments: Hash[Symbol | String, untyped]) -> nil
     def schedule: (Symbol | String, at: Time, arguments: Hash[Symbol | String, untyped], ?every: Numeric?, ?missed: Symbol | String) -> nil
 
@@ -148,6 +166,9 @@ module SolidObjects
     # @rbs () -> Hash[String, untyped]
     def observable_values: () -> Hash[String, untyped]
 
+    # @rbs (Symbol | String) -> untyped
+    def observable_value: (Symbol | String) -> untyped
+
     # @rbs () -> void
     def activate: () -> void
 
@@ -160,6 +181,9 @@ module SolidObjects
     # @rbs () -> Array[EffectIntent]
     def drain_effect_intents: () -> Array[EffectIntent]
 
+    # @rbs () -> Array[CommitActionIntent]
+    def drain_commit_action_intents: () -> Array[CommitActionIntent]
+
     # @rbs () -> Array[ReminderIntent]
     def drain_reminder_intents: () -> Array[ReminderIntent]
 
@@ -173,10 +197,15 @@ module SolidObjects
 
     attr_reader effect_intents: untyped
 
+    attr_reader commit_action_intents: untyped
+
     attr_reader reminder_intents: untyped
 
     attr_reader outbound_message_intents: untyped
 
+    # @rbs (String) { () -> untyped } -> untyped
+    def guard_application_writes: (String) { () -> untyped } -> untyped
+
     # @rbs (Hash[String, untyped]) -> Hash[Symbol, untyped]
     def keyword_arguments: (Hash[String, untyped]) -> Hash[Symbol, untyped]
 

data/sig/generated/lib/solid_objects/actor_channel.rbs

@@ -4,5 +4,25 @@ module SolidObjects
   class ActorChannel < ActionCable::Channel::Base
     # @rbs () -> void
     def subscribed: () -> void
+
+    private
+
+    attr_reader reference: untyped
+
+    attr_reader component_subscriptions: untyped
+
+    attr_reader scalar_observables: untyped
+
+    # @rbs (String) -> void
+    def receive_broadcast: (String) -> void
+
+    # @rbs (ActorSnapshot) -> void
+    def refresh_outdated_components: (ActorSnapshot) -> void
+
+    # @rbs () -> void
+    def validate_scalar_observables!: () -> void
+
+    # @rbs (ActorSnapshot) -> Array[String]
+    def scalar_observable_names: (ActorSnapshot) -> Array[String]
   end
 end

data/sig/generated/lib/solid_objects/actor_snapshot.rbs

@@ -8,20 +8,37 @@ module SolidObjects
 
     @actor: Actor
 
+    @instance_id: Integer
+
+    @revision: Integer
+
+    @observable_values: Hash[String, untyped]?
+
+    @observable_value_cache: Hash[String, untyped]
+
     attr_reader reference: untyped
 
     attr_reader actor_class: untyped
 
     attr_reader actor: untyped
 
+    attr_reader instance_id: untyped
+
+    attr_reader revision: untyped
+
     # @rbs (Reference) -> void
     def initialize: (Reference) -> void
 
     # @rbs () -> Hash[String, untyped]
     def observable_values: () -> Hash[String, untyped]
 
+    # @rbs (Symbol | String) -> untyped
+    def observable_value: (Symbol | String) -> untyped
+
     private
 
+    attr_reader instance: untyped
+
     # @rbs () -> Actor
     def build_actor: () -> Actor
   end

data/sig/generated/lib/solid_objects/actor_view.rbs

@@ -2,6 +2,10 @@
 
 module SolidObjects
   class ActorView
+    @observable_names: Array[String]
+
+    @component_registrations: Array[ComponentRegistration]
+
     @snapshot: ActorSnapshot
 
     @authorization_context: untyped
@@ -18,8 +22,14 @@ module SolidObjects
     # @rbs (Symbol | String) -> untyped
     def value: (Symbol | String) -> untyped
 
-    # @rbs (Symbol | String, ?partial: String?) -> untyped
-    def component: (Symbol | String, ?partial: String?) -> untyped
+    # @rbs (Symbol | String, ?observes: Symbol | String | Array[Symbol | String]?, ?partial: String?) -> untyped
+    def component: (Symbol | String, ?observes: Symbol | String | Array[Symbol | String]?, ?partial: String?) -> untyped
+
+    # @rbs () -> Array[String]
+    def component_tokens: () -> Array[String]
+
+    # @rbs () -> Array[String]
+    def scalar_observable_names: () -> Array[String]
 
     # @rbs () -> State
     def state: () -> State
@@ -38,6 +48,13 @@ module SolidObjects
 
     attr_reader snapshot: untyped
 
+    attr_reader component_registrations: untyped
+
+    attr_reader observable_names: untyped
+
+    # @rbs (String, partial: String?) -> untyped
+    def static_component: (String, partial: String?) -> untyped
+
     # @rbs (Symbol | String) -> void
     def authorize_read!: (Symbol | String) -> void
 
@@ -50,6 +67,18 @@ module SolidObjects
     # @rbs (Symbol | String) -> String
     def normalized_component_name: (Symbol | String) -> String
 
+    # @rbs (Symbol | String | Array[Symbol | String]) -> Array[String]
+    def normalized_dependencies: (Symbol | String | Array[Symbol | String]) -> Array[String]
+
+    # @rbs (Array[String]) -> void
+    def validate_dependencies!: (Array[String]) -> void
+
+    # @rbs (String) -> void
+    def ensure_unique_component!: (String) -> void
+
+    # @rbs () -> Proc | ComponentPathResolver
+    def component_path_resolver: () -> Proc
+
     # @rbs (String) -> String
     def default_partial: (String) -> String
   end

data/sig/generated/lib/solid_objects/application_write_guard.rbs

@@ -0,0 +1,8 @@
+# Generated from lib/solid_objects/application_write_guard.rb with RBS::Inline
+
+module SolidObjects
+  class ApplicationWriteGuard
+    # @rbs (actor_type: String, actor_id: String, operation: String) { () -> untyped } -> untyped
+    def self.call: (actor_type: String, actor_id: String, operation: String) { () -> untyped } -> untyped
+  end
+end

data/sig/generated/lib/solid_objects/caller_process.rbs

@@ -8,12 +8,17 @@ module SolidObjects
 
     @registry: ProcessRegistry?
 
+    @shutdown_hook_installed: bool
+
     # @rbs () -> void
     def initialize: () -> void
 
     # @rbs () -> ProcessRegistry
     def process_registry: () -> ProcessRegistry
 
+    # @rbs () -> bool
+    def stop: () -> bool
+
     private
 
     attr_reader mutex: untyped
@@ -28,5 +33,11 @@ module SolidObjects
 
     # @rbs () -> ProcessRegistry
     def register: () -> ProcessRegistry
+
+    # @rbs () -> void
+    def install_shutdown_hook: () -> void
+
+    # @rbs () -> bool
+    def stop_after_exit: () -> bool
   end
 end

data/sig/generated/lib/solid_objects/cli.rbs

@@ -11,6 +11,15 @@ module SolidObjects
     # @rbs () -> void
     def cleanup: () -> void
 
+    # @rbs () -> void
+    def prune_messages: () -> void
+
+    # @rbs () -> void
+    def prune_instances: () -> void
+
+    # @rbs () -> void
+    def prune_processes: () -> void
+
     # @rbs () -> void
     def dead_letters: () -> void
 
@@ -25,7 +34,7 @@ module SolidObjects
     # @rbs (Symbol, Integer) -> Integer
     def numeric_option: (Symbol, Integer) -> Integer
 
-    # @rbs (Symbol) -> void
-    def authorize_administration!: (Symbol) -> void
+    # @rbs (Symbol, resource: String) -> void
+    def authorize_administration!: (Symbol, resource: String) -> void
   end
 end

data/sig/generated/lib/solid_objects/client.rbs

@@ -13,6 +13,12 @@ module SolidObjects
     # @rbs (Reference, Symbol | String, Hash[Symbol | String, untyped], timeout: Numeric, ?idempotency_key: String?, ?authorization_context: untyped) -> untyped
     def sync: (Reference, Symbol | String, Hash[Symbol | String, untyped], timeout: Numeric, ?idempotency_key: String?, ?authorization_context: untyped) -> untyped
 
+    # @rbs (MessageReference, timeout: Numeric, ?authorization_context: untyped) -> untyped
+    def wait: (MessageReference, timeout: Numeric, ?authorization_context: untyped) -> untyped
+
+    # @rbs (Reference, ?authorization_context: untyped) -> StateSnapshot
+    def snapshot: (Reference, ?authorization_context: untyped) -> StateSnapshot
+
     # @rbs (Reference, ?authorization_context: untyped) -> bool
     def destroy: (Reference, ?authorization_context: untyped) -> bool
 
@@ -20,6 +26,15 @@ module SolidObjects
 
     attr_reader mailbox: untyped
 
+    # @rbs (Reference, Symbol | String, Hash[Symbol | String, untyped], idempotency_key: String?, timeout: Numeric) -> MessageReference
+    def enqueue_sync: (Reference, Symbol | String, Hash[Symbol | String, untyped], idempotency_key: String?, timeout: Numeric) -> MessageReference
+
+    # @rbs (MessageReference, Message) -> void
+    def validate_message_reference!: (MessageReference, Message) -> void
+
+    # @rbs (Reference, Symbol | String) -> void
+    def reject_sync_inside_transaction!: (Reference, Symbol | String) -> void
+
     # @rbs (Proc, Reference, Symbol | String, Hash[Symbol | String, untyped], authorization_context: untyped) -> void
     def authorize!: (Proc, Reference, Symbol | String, Hash[Symbol | String, untyped], authorization_context: untyped) -> void
 

data/sig/generated/lib/solid_objects/commit_action_registry.rbs

@@ -0,0 +1,43 @@
+# Generated from lib/solid_objects/commit_action_registry.rb with RBS::Inline
+
+module SolidObjects
+  class CommitActionContext < Data
+    attr_reader message_id(): untyped
+
+    attr_reader request_id(): untyped
+
+    attr_reader actor_type(): untyped
+
+    attr_reader actor_id(): untyped
+
+    attr_reader activation_generation(): untyped
+
+    def self.new: (untyped message_id, untyped request_id, untyped actor_type, untyped actor_id, untyped activation_generation) -> instance
+                | (message_id: untyped, request_id: untyped, actor_type: untyped, actor_id: untyped, activation_generation: untyped) -> instance
+
+    def self.members: () -> [ :message_id, :request_id, :actor_type, :actor_id, :activation_generation ]
+
+    def members: () -> [ :message_id, :request_id, :actor_type, :actor_id, :activation_generation ]
+  end
+
+  class CommitActionRegistry
+    @handlers: Hash[String, Proc]
+
+    @mutex: Mutex
+
+    # @rbs () -> void
+    def initialize: () -> void
+
+    # @rbs (String | Symbol, Proc) -> Proc
+    def register: (String | Symbol, Proc) -> Proc
+
+    # @rbs (String | Symbol) -> Proc
+    def fetch: (String | Symbol) -> Proc
+
+    private
+
+    attr_reader handlers: untyped
+
+    attr_reader mutex: untyped
+  end
+end

data/sig/generated/lib/solid_objects/component_path_resolver.rbs

@@ -0,0 +1,13 @@
+# Generated from lib/solid_objects/component_path_resolver.rb with RBS::Inline
+
+module SolidObjects
+  class ComponentPathResolver
+    # @rbs (view_context: untyped) -> String
+    def call: (view_context: untyped) -> String
+
+    private
+
+    # @rbs () -> bool
+    def mounted?: () -> bool
+  end
+end