solid_objects 0.2.1 → 0.3.0

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,25 @@ 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/turbo_stream_renderer"
 require "solid_objects/actor_snapshot"
+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 +79,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 +101,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 +127,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 +141,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/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
 
@@ -160,6 +178,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 +194,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/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/configuration.rbs

@@ -2,16 +2,22 @@
 
 module SolidObjects
   class Configuration
-    @max_attempts: Integer
-
-    @retry_delay: Proc
-
-    @process_heartbeat_interval: Float
+    @table_name_prefix: String
 
     @process_alive_threshold: Float
 
     @shutdown_timeout: Float
 
+    @message_retention: Numeric
+
+    @message_retention_by_actor_type: Hash[String, Numeric]
+
+    @instance_retention_by_actor_type: Hash[String, Numeric]
+
+    @process_retention: Numeric
+
+    @prune_batch_size: Integer
+
     @worker_count: Integer
 
     @effect_worker_count: Integer
@@ -40,8 +46,6 @@ module SolidObjects
 
     @authorize_administration: Proc
 
-    @table_name_prefix: String
-
     @polling_interval: Float
 
     @sync_polling_interval: Float
@@ -66,6 +70,12 @@ module SolidObjects
 
     @max_result_bytes: Integer
 
+    @max_attempts: Integer
+
+    @retry_delay: Proc
+
+    @process_heartbeat_interval: Float
+
     attr_accessor table_name_prefix: untyped
 
     attr_accessor polling_interval: untyped
@@ -102,6 +112,16 @@ module SolidObjects
 
     attr_accessor shutdown_timeout: untyped
 
+    attr_accessor message_retention: untyped
+
+    attr_accessor message_retention_by_actor_type: untyped
+
+    attr_accessor instance_retention_by_actor_type: untyped
+
+    attr_accessor process_retention: untyped
+
+    attr_accessor prune_batch_size: untyped
+
     attr_accessor worker_count: untyped
 
     attr_accessor effect_worker_count: untyped

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

@@ -36,6 +36,15 @@ module SolidObjects
 
     attr_reader fixed_connection: untyped
 
+    # @rbs (untyped) { () -> untyped } -> untyped
+    def with_transaction_deadline: (untyped) { () -> untyped } -> untyped
+
+    # @rbs (untyped) -> void
+    def configure_transaction_deadline: (untyped) -> void
+
+    # @rbs (Exception) -> bool
+    def deadline_error?: (Exception) -> bool
+
     # @rbs () { (untyped) -> untyped } -> untyped
     def with_connection: () { (untyped) -> untyped } -> untyped
   end

data/sig/generated/lib/solid_objects/database_adapters/mysql.rbs

@@ -11,6 +11,14 @@ module SolidObjects
 
       # @rbs () -> String
       def current_time_expression: () -> String
+
+      private
+
+      # @rbs (untyped) { () -> untyped } -> untyped
+      def with_transaction_deadline: (untyped) { () -> untyped } -> untyped
+
+      # @rbs (Exception) -> bool
+      def deadline_error?: (Exception) -> bool
     end
   end
 end

data/sig/generated/lib/solid_objects/database_adapters/postgresql.rbs

@@ -8,6 +8,14 @@ module SolidObjects
 
       # @rbs () -> String
       def claim_lock: () -> String
+
+      private
+
+      # @rbs (untyped) -> void
+      def configure_transaction_deadline: (untyped) -> void
+
+      # @rbs (Exception) -> bool
+      def deadline_error?: (Exception) -> bool
     end
   end
 end

data/sig/generated/lib/solid_objects/database_adapters/sqlite.rbs

@@ -5,6 +5,14 @@ module SolidObjects
     class Sqlite < DatabaseAdapter
       # @rbs () -> String
       def current_time_expression: () -> String
+
+      private
+
+      # @rbs (untyped) { () -> untyped } -> untyped
+      def with_transaction_deadline: (untyped) { () -> untyped } -> untyped
+
+      # @rbs (Exception) -> bool
+      def deadline_error?: (Exception) -> bool
     end
   end
 end

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

@@ -4,6 +4,9 @@ module SolidObjects
   class Error < StandardError
   end
 
+  class NonRetryableError < Error
+  end
+
   class UnsupportedDatabase < Error
   end
 
@@ -40,7 +43,122 @@ module SolidObjects
   class ActorDestroyed < LostActivation
   end
 
+  class DatabaseDeadlineExceeded < Error
+  end
+
+  class SyncEnqueueTimeout < Error
+    @timeout: Numeric
+
+    @actor_type: String
+
+    @actor_id: String
+
+    @message_name: String
+
+    attr_reader timeout: untyped
+
+    attr_reader actor_type: untyped
+
+    attr_reader actor_id: untyped
+
+    attr_reader message_name: untyped
+
+    # @rbs (timeout: Numeric, actor_type: String, actor_id: String, message_name: String) -> void
+    def initialize: (timeout: Numeric, actor_type: String, actor_id: String, message_name: String) -> void
+  end
+
   class SyncTimeout < Error
+    @timeout: Numeric
+
+    @actor_type: String
+
+    @actor_id: String
+
+    @message_name: String
+
+    @message_id: Integer
+
+    @request_id: String
+
+    @sequence: Integer
+
+    @status: String
+
+    @waiting_on: String
+
+    @activation: Hash[String, untyped]
+
+    @blocker: Hash[String, untyped]?
+
+    attr_reader timeout: untyped
+
+    attr_reader actor_type: untyped
+
+    attr_reader actor_id: untyped
+
+    attr_reader message_name: untyped
+
+    attr_reader message_id: untyped
+
+    attr_reader request_id: untyped
+
+    attr_reader sequence: untyped
+
+    attr_reader status: untyped
+
+    attr_reader waiting_on: untyped
+
+    attr_reader activation: untyped
+
+    attr_reader blocker: untyped
+
+    # @rbs (timeout: Numeric, actor_type: String, actor_id: String, message_name: String, message_id: Integer, request_id: String, sequence: Integer, status: String, waiting_on: String, activation: Hash[String, untyped], blocker: Hash[String, untyped]?) -> void
+    def initialize: (timeout: Numeric, actor_type: String, actor_id: String, message_name: String, message_id: Integer, request_id: String, sequence: Integer, status: String, waiting_on: String, activation: Hash[String, untyped], blocker: Hash[String, untyped]?) -> void
+
+    # @rbs () -> MessageReference
+    def message_reference: () -> MessageReference
+  end
+
+  class SyncInsideTransaction < Error
+    @actor_type: String
+
+    @actor_id: String
+
+    @message_name: String
+
+    attr_reader actor_type: untyped
+
+    attr_reader actor_id: untyped
+
+    attr_reader message_name: untyped
+
+    # @rbs (actor_type: String, actor_id: String, message_name: String) -> void
+    def initialize: (actor_type: String, actor_id: String, message_name: String) -> void
+  end
+
+  class ApplicationWriteForbidden < NonRetryableError
+    @actor_type: String
+
+    @actor_id: String
+
+    @message_name: String
+
+    attr_reader actor_type: untyped
+
+    attr_reader actor_id: untyped
+
+    attr_reader message_name: untyped
+
+    # @rbs (actor_type: String, actor_id: String, message_name: String) -> void
+    def initialize: (actor_type: String, actor_id: String, message_name: String) -> void
+  end
+
+  class CommitActionUnavailable < NonRetryableError
+    # @rbs (actor_type: String, actor_id: String, message_name: String) -> void
+    def initialize: (actor_type: String, actor_id: String, message_name: String) -> void
+  end
+
+  class UnknownCommitAction < NonRetryableError
   end
 
   class Rejected < Error

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

@@ -21,6 +21,9 @@ module SolidObjects
     # @rbs () -> Actor
     def actor: () -> Actor
 
+    # @rbs (MessageContext) -> untyped
+    def invoke_actor: (MessageContext) -> untyped
+
     # @rbs (Hash[String, untyped]) -> void
     def ensure_query_did_not_mutate_state!: (Hash[String, untyped]) -> void
 
@@ -30,6 +33,15 @@ module SolidObjects
     # @rbs (untyped, Hash[String, untyped]) -> void
     def complete: (untyped, Hash[String, untyped]) -> void
 
+    # @rbs (Array[Actor::CommitActionIntent]) -> void
+    def execute_commit_actions: (Array[Actor::CommitActionIntent]) -> void
+
+    # @rbs (Actor::CommitActionIntent, Proc, CommitActionContext) -> untyped
+    def execute_commit_action: (Actor::CommitActionIntent, Proc, CommitActionContext) -> untyped
+
+    # @rbs () -> void
+    def ensure_application_database_is_shared!: () -> void
+
     # @rbs (Message, Instance, Array[Actor::EffectIntent]) -> Array[Effect]
     def enqueue_effects: (Message, Instance, Array[Actor::EffectIntent]) -> Array[Effect]
 

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

@@ -0,0 +1,36 @@
+# Generated from lib/solid_objects/instance_pruner.rb with RBS::Inline
+
+module SolidObjects
+  class InstancePruner
+    @now: Time
+
+    @batch_size: Integer
+
+    # @rbs (?now: Time, ?batch_size: Integer) -> void
+    def initialize: (?now: Time, ?batch_size: Integer) -> void
+
+    # @rbs () -> Integer
+    def preview: () -> Integer
+
+    # @rbs () -> Integer
+    def prune: () -> Integer
+
+    private
+
+    attr_reader now: untyped
+
+    attr_reader batch_size: untyped
+
+    # @rbs () -> Array[ActiveRecord::Relation[Instance]]
+    def policy_relations: () -> Array[ActiveRecord::Relation[Instance]]
+
+    # @rbs () -> ActiveRecord::Relation[Instance]
+    def prunable: () -> ActiveRecord::Relation[Instance]
+
+    # @rbs (ActiveRecord::Relation[Instance]) -> Integer
+    def prune_relation: (ActiveRecord::Relation[Instance]) -> Integer
+
+    # @rbs (Integer, ActiveRecord::Relation[Instance]) -> Integer
+    def prune_instance: (Integer, ActiveRecord::Relation[Instance]) -> Integer
+  end
+end

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

@@ -0,0 +1,42 @@
+# Generated from lib/solid_objects/message_pruner.rb with RBS::Inline
+
+module SolidObjects
+  class MessagePruner
+    @now: Time
+
+    @batch_size: Integer
+
+    # @rbs (?now: Time, ?batch_size: Integer) -> void
+    def initialize: (?now: Time, ?batch_size: Integer) -> void
+
+    # @rbs () -> Integer
+    def preview: () -> Integer
+
+    # @rbs () -> Integer
+    def prune: () -> Integer
+
+    private
+
+    attr_reader now: untyped
+
+    attr_reader batch_size: untyped
+
+    # @rbs () -> Array[ActiveRecord::Relation[Message]]
+    def policy_relations: () -> Array[ActiveRecord::Relation[Message]]
+
+    # @rbs () -> ActiveRecord::Relation[Message]
+    def prunable: () -> ActiveRecord::Relation[Message]
+
+    # @rbs (ActiveRecord::Relation[Message]) -> Integer
+    def prune_relation: (ActiveRecord::Relation[Message]) -> Integer
+
+    # @rbs () -> Numeric
+    def default_retention: () -> Numeric
+
+    # @rbs () -> Hash[String, Numeric]
+    def retention_overrides: () -> Hash[String, Numeric]
+
+    # @rbs (Numeric) -> Time
+    def retention_cutoff: (Numeric) -> Time
+  end
+end

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

@@ -33,5 +33,8 @@ module SolidObjects
 
     # @rbs () -> untyped
     def result: () -> untyped
+
+    # @rbs (?timeout: Numeric, ?authorization_context: untyped) -> untyped
+    def wait: (?timeout: Numeric, ?authorization_context: untyped) -> untyped
   end
 end