pg_eventstore 2.0.0 → 3.0.0

data/sig/pg_eventstore/commands/system_stream_read_paginated.rbs

@@ -1,25 +1,20 @@
 module PgEventstore
   module Commands
-    class SystemStreamReadPaginated < PgEventstore::AbstractCommand
-      # _@param_ `stream`
-      #
-      # _@param_ `options`
-      %a{rbs:test:skip} def call: (PgEventstore::Stream stream, ?options: ::Hash[untyped, untyped]) -> ::Enumerator[Array[PgEventstore::Event], void]
+    class SystemStreamReadPaginated < AbstractCommand
+      # Skip this type check because rbs duplicates calls to Enumerator#next
+      %a{rbs:test:skip} def call: (Stream stream, deserializer: EventDeserializer,
+          ?options: ::Hash[untyped, untyped]) -> ::Enumerator[Array[Event], void]
 
-      # _@param_ `events`
-      #
-      # _@param_ `max_count`
-      def end_reached?: (::Array[PgEventstore::Event] events, Integer max_count) -> bool
+      private
 
-      # _@param_ `events`
-      #
-      # _@param_ `direction`
-      def calc_next_position: (::Array[PgEventstore::Event] events, (String | Symbol)? direction) -> Integer
+      def end_reached?: (::Array[Event] events, Integer max_count) -> bool
+
+      def calc_next_position: (::Array[Event] events, (String | Symbol)? direction) -> Integer
 
       # _@param_ `direction`
       def forwards?: ((String | Symbol)? direction) -> bool
 
-      def read_cmd: () -> PgEventstore::Commands::Read
+      def read_cmd: () -> Commands::Read
     end
   end
 end

data/sig/pg_eventstore/config.rbs

@@ -1,9 +1,14 @@
 module PgEventstore
-  class Config
-    include PgEventstore::Extensions::OptionsExtension
+  class Config < BasicConfig
+    module NodeRole
+      PRIMARY: Symbol
+      REPLICA: Symbol
+      STANDALONE: Symbol
 
-    # _@param_ `name` — config's name. Its value matches the appropriate key in PgEventstore.config hash
-    def initialize: (name: Symbol, **untyped options) -> void
+      def self.maintainable: -> Array[Symbol]
+
+      def self.writable: -> Array[Symbol]
+    end
 
     def connection_options: () -> ::Hash[untyped, untyped]
 
@@ -21,8 +26,6 @@ module PgEventstore
     # _@param_ `options`
     def init_default_values: (::Hash[untyped, untyped] options) -> void
 
-    attr_reader name: untyped
-
     attr_accessor pg_uri: String
 
     # _@return_ — Number of events to return in one response when reading from a stream
@@ -51,5 +54,11 @@ module PgEventstore
     attr_accessor subscriptions_set_retries_interval: Integer
 
     attr_accessor subscription_graceful_shutdown_timeout: Integer | Float
+
+    attr_accessor events_subscription_position_update_interval: Integer | Float
+
+    attr_accessor eventstore_role: Symbol
+
+    attr_accessor max_events_to_replicate: Integer
   end
 end

data/sig/pg_eventstore/connection.rbs

@@ -1,32 +1,25 @@
 module PgEventstore
   class Connection
-    module Ruby30Patch
-    end
+    @pool: ConnectionPool[PgConnection]?
 
-    include PgEventstore::Connection::Ruby30Patch
+    attr_accessor uri: String
+    attr_accessor pool_size: Integer
+    attr_accessor pool_timeout: Integer
 
-    # _@param_ `uri` — PostgreSQL connection URI. Example: "postgresql://postgres:postgres@localhost:5432/eventstore"
-    #
-    # _@param_ `pool_size` — Connection pool size
-    #
-    # _@param_ `pool_timeout` — Connection pool timeout in seconds
     def initialize: (uri: String, ?pool_size: Integer, ?pool_timeout: Integer) -> void
 
-    def shutdown: -> untyped
+    def discard_current_connection: -> void
 
-    def with: () { (PG::Connection connection) -> untyped } -> untyped
+    def establish_connection: -> void
 
-    def init_pool: () -> ConnectionPool[untyped]
+    def shutdown: -> void
 
-    def pg_type_registry: () -> PG::BasicTypeRegistry
+    def with: () { (PgConnection connection) -> untyped } -> untyped
 
-    # Returns the value of attribute uri.
-    attr_accessor uri: String
+    private
 
-    # Returns the value of attribute pool_size.
-    attr_accessor pool_size: Integer
+    def init_pool: () -> ConnectionPool[PgConnection]
 
-    # Returns the value of attribute pool_timeout.
-    attr_accessor pool_timeout: Integer
+    def pg_type_registry: () -> PG::BasicTypeRegistry
   end
 end

data/sig/pg_eventstore/errors.rbs

@@ -5,28 +5,31 @@ module PgEventstore
     def to_h: () -> ::Hash[untyped, untyped]
   end
 
-  class StreamNotFoundError < PgEventstore::Error
+  class StreamNotFoundError < Error
     # _@param_ `stream`
-    def initialize: (PgEventstore::Stream stream) -> void
+    def initialize: (Stream stream) -> void
 
     # Returns the value of attribute stream.
-    attr_accessor stream: PgEventstore::Stream
+    attr_accessor stream: Stream
   end
 
-  class SystemStreamError < PgEventstore::Error
+  class SystemStreamError < Error
     # _@param_ `stream`
-    def initialize: (PgEventstore::Stream stream) -> void
+    def initialize: (Stream stream) -> void
 
-    attr_accessor stream: PgEventstore::Stream
+    attr_accessor stream: Stream
   end
 
-  class WrongExpectedRevisionError < PgEventstore::Error
-    # _@param_ `revision`
-    #
-    # _@param_ `expected_revision`
-    #
-    # _@param_ `stream`
-    def initialize: (revision: Integer, expected_revision: (Integer | Symbol), stream: PgEventstore::Stream) -> void
+  class WrongExpectedRevisionError < Error
+
+    attr_accessor stream: Stream
+    attr_accessor revision: Integer
+    attr_accessor expected_revision: (Integer | Symbol)
+    attr_accessor verdict: Symbol
+
+    def initialize: (revision: Integer, expected_revision: (Integer | Symbol), stream: Stream, verdict: Symbol) -> void
+
+    private
 
     def user_friendly_message: () -> String
 
@@ -39,28 +42,52 @@ module PgEventstore
     def unmatched_stream_revision: () -> String
 
     def stream_descr: () -> String
+  end
 
-    attr_accessor stream: PgEventstore::Stream
+  class WrongExpectedTypesRevisionError < Error
+    class Verdict
+      include Extensions::OptionsExtension
+      include Extensions::OptionsDefaults
 
-    attr_accessor revision: Integer
+      attr_accessor verdict: Symbol
+      attr_accessor event_type: String | Symbol
+      attr_accessor current_revision: Integer
+      attr_accessor expected_revision: Integer | Symbol
+      attr_accessor expected_markers: Array[String]?
+    end
 
-    attr_accessor expected_revision: (Integer | Symbol)
-  end
+    attr_accessor stream: Stream
+    attr_accessor verdicts: Array[Verdict]
 
-  class RecordNotFound < PgEventstore::Error
-    # _@param_ `table_name`
-    #
-    # _@param_ `id`
-    def initialize: (String table_name, (Integer | String) id) -> void
+    def initialize: (stream: Stream, verdicts: Array[Verdict]) -> void
 
-    def user_friendly_message: () -> String
+    private
 
+    def event_descr: (Verdict verdict) -> String
+
+    def event_is_absent: (Verdict verdict) -> String
+
+    def event_is_present: (Verdict verdict) -> String
+
+    def event_revision_does_not_match: (Verdict verdict) -> String
+
+    def revision_descr: (Verdict verdict) -> String
+
+    def stream_descr: -> String
+
+    def user_friendly_message: -> String
+  end
+
+  class RecordNotFound < Error
     attr_accessor table_name: String
+    attr_accessor id: untyped
+
+    def initialize: (String table_name, untyped id) -> void
 
-    attr_accessor id: (Integer | String)
+    def user_friendly_message: () -> String
   end
 
-  class SubscriptionAlreadyLockedError < PgEventstore::Error
+  class SubscriptionAlreadyLockedError < Error
     # _@param_ `set` — subscriptions set name
     #
     # _@param_ `name` — subscription's name
@@ -77,7 +104,7 @@ module PgEventstore
     attr_accessor lock_id: Integer
   end
 
-  class WrongLockIdError < PgEventstore::Error
+  class WrongLockIdError < Error
     # _@param_ `set` — subscriptions set name
     #
     # _@param_ `name` — subscription's name
@@ -94,7 +121,7 @@ module PgEventstore
     attr_accessor lock_id: Integer
   end
 
-  class NotPersistedEventError < PgEventstore::Error
+  class NotPersistedEventError < Error
     # _@param_ `event`
     def initialize: (PgEventstore::Event event) -> void
 
@@ -103,32 +130,35 @@ module PgEventstore
     attr_accessor event: PgEventstore::Event
   end
 
-  class MissingPartitions < PgEventstore::Error
+  class MissingPartitions < Error
     # _@param_ `stream`
     #
     # _@param_ `event_types`
-    def initialize: (PgEventstore::Stream stream, ::Array[String] event_types) -> void
+    def initialize: (Stream stream, ::Array[String] event_types) -> void
 
-    attr_accessor stream: PgEventstore::Stream
+    attr_accessor stream: Stream
 
     attr_accessor event_types: ::Array[String]
   end
 
-  class TooManyRecordsToLockError < PgEventstore::Error
-    def initialize: (PgEventstore::Stream stream, Integer number_of_records) -> void
+  class TooManyRecordsToLockError < Error
+    def initialize: (Stream stream, Integer number_of_records) -> void
 
-    attr_accessor stream: PgEventstore::Stream
+    attr_accessor stream: Stream
 
     attr_accessor number_of_records: Integer
 
     def user_friendly_message: -> String
   end
 
-  class WrappedException < PgEventstore::Error
+  class WrappedException < Error
     def initialize: (StandardError original_exception, Hash[Symbol, untyped] extra) -> void
 
     attr_accessor original_exception: StandardError
 
     attr_accessor extra: Hash[Symbol, untyped]
   end
+
+  class NotSupportedError < Error
+  end
 end

data/sig/pg_eventstore/event.rbs

@@ -1,9 +1,13 @@
 module PgEventstore
   class Event
-    include Extensions::OptionsExtension
-
+    MARKERS_METADATA_KEY: String
+    NON_EXISTING_EVENT_REVISION: Integer
     LINK_TYPE: String
     PRIMARY_TABLE_NAME: String
+    SYSTEM_KEY_PREFIX: String
+    SYSTEM_SYMBOL: String
+
+    include Extensions::OptionsExtension
 
     def ==: ((Object | Event) other) -> bool
 
@@ -35,6 +39,10 @@ module PgEventstore
 
     attr_accessor data: ::Hash[untyped, untyped]
 
+    attr_accessor markers: ::Array[String]
+
+    attr_accessor feature_markers: ::Array[FeatureMarker]
+
     attr_accessor metadata: ::Hash[untyped, untyped]
 
     attr_accessor link_global_position: Integer?
@@ -44,5 +52,11 @@ module PgEventstore
     attr_accessor link: Event?
 
     attr_accessor created_at: Time?
+
+    attr_accessor caused_by: Event?
+
+    attr_accessor correlation_id: String?
+
+    attr_accessor causation_id: String?
   end
 end

data/sig/pg_eventstore/event_deserializer.rbs

@@ -1,19 +1,14 @@
 module PgEventstore
   class EventDeserializer
-    # _@param_ `middlewares`
-    #
-    # _@param_ `event_class_resolver`
-    def initialize: (::Array[PgEventstore::Middleware] middlewares, _EventClassResolver event_class_resolver) -> void
+    def initialize: (::Array[Middleware] middlewares, _EventClassResolver event_class_resolver) -> void
 
-    # _@param_ `raw_events`
-    def deserialize_many: (::Array[::Hash[untyped, untyped]] raw_events) -> ::Array[PgEventstore::Event]
+    def deserialize_many: (::Array[::Hash[untyped, untyped]] | Enumerator[Hash[untyped, untyped]] raw_events) -> ::Array[Event]
 
-    # _@param_ `attrs`
-    def deserialize: (::Hash[untyped, untyped] attrs) -> PgEventstore::Event
+    def deserialize: (::Hash[untyped, untyped] attrs) -> Event
 
-    def without_middlewares: () -> PgEventstore::EventDeserializer
+    def without_middlewares: () -> EventDeserializer
 
-    attr_accessor middlewares: ::Array[PgEventstore::Middleware]
+    attr_accessor middlewares: ::Array[Middleware]
 
     attr_accessor event_class_resolver: _EventClassResolver
   end

data/sig/pg_eventstore/event_global_index.rbs

@@ -0,0 +1,60 @@
+module PgEventstore
+  class EventGlobalIndex
+    include Extensions::OptionsExtension
+    include Extensions::OptionsDefaults
+
+    def self.create_representation: (Hash[untyped, untyped] attributes,
+        repr: Symbol?) -> (EventGlobalIndex | SubscriptionRepr | ReadApiRepr | WriteApiRepr | RevisionCheckRepr)
+
+    attr_accessor global_position: Integer
+    attr_accessor subscription_position: Integer?
+    attr_accessor stream_revision: Integer
+    attr_accessor context_partition_id: Integer
+    attr_accessor stream_name_partition_id: Integer
+    attr_accessor event_type_partition_id: Integer
+    attr_accessor streams_global_index_id: Integer
+
+    module ReprType
+      REVISION_CHECK: Symbol
+      SUBSCRIPTION: Symbol
+      READ_API: Symbol
+      WRITE_API: Symbol
+    end
+
+    class SubscriptionRepr
+      include Extensions::OptionsExtension
+      include Extensions::OptionsDefaults
+
+      attr_accessor global_position: Integer
+      attr_accessor subscription_position: Integer
+      attr_accessor event_type_partition_id: Integer
+
+      def to_subscription_position_attrs: -> { global_position: Integer, subscription_position: Integer }
+    end
+
+    class ReadApiRepr
+      include Extensions::OptionsExtension
+      include Extensions::OptionsDefaults
+
+      attr_accessor global_position: Integer
+      attr_accessor event_type_partition_id: Integer
+    end
+
+    class WriteApiRepr
+      include Extensions::OptionsExtension
+      include Extensions::OptionsDefaults
+
+      attr_accessor global_position: Integer
+      attr_accessor event_type_partition_id: Integer
+      attr_accessor stream_revision: Integer
+    end
+
+    class RevisionCheckRepr
+      include Extensions::OptionsExtension
+      include Extensions::OptionsDefaults
+
+      attr_accessor sequence_number: Integer
+      attr_accessor stream_revision: Integer
+    end
+  end
+end

data/sig/pg_eventstore/event_marker.rbs

@@ -0,0 +1,9 @@
+module PgEventstore
+  class EventMarker
+    include Extensions::OptionsExtension
+    include Extensions::OptionsDefaults
+
+    attr_accessor id: Integer
+    attr_accessor name: String
+  end
+end

data/sig/pg_eventstore/event_marker_index.rbs

@@ -0,0 +1,12 @@
+module PgEventstore
+  class EventMarkerIndex
+    include Extensions::OptionsExtension
+    include Extensions::OptionsDefaults
+
+    attr_accessor marker_id: Integer
+    attr_accessor streams_global_index_id: Integer
+    attr_accessor event_type_partition_id: Integer
+    attr_accessor global_position: Integer
+    attr_accessor stream_revision: Integer
+  end
+end

data/sig/pg_eventstore/extensions/acts_as_configurable.rbs

@@ -0,0 +1,29 @@
+module PgEventstore
+  module Extensions
+    module ActsAsConfigurable
+      def acts_as_configurable: (?default_config: Symbol, config_class: Class) -> void
+
+      module Configurable
+        @config: Hash[Symbol, Extensions::OptionsExtension]
+
+        @connection: Hash[Symbol, Connection]
+
+        attr_reader mutex: Thread::Mutex
+
+        def configure: (?name: Symbol) { (BasicConfig) -> untyped } -> untyped
+
+        def config: (?Symbol name) -> BasicConfig
+
+        def available_configs: () -> ::Array[Symbol]
+
+        def connection: (?Symbol name) -> Connection
+
+        private
+
+        def connection_options: (BasicConfig config) -> Hash[untyped, untyped]
+
+        def init_variables: -> void
+      end
+    end
+  end
+end

data/sig/pg_eventstore/extensions/options_defaults.rbs

@@ -0,0 +1,7 @@
+module PgEventstore
+  module Extensions
+    module OptionsDefaults
+      def ==: (untyped) -> bool
+    end
+  end
+end

data/sig/pg_eventstore/feature_marker.rbs

@@ -0,0 +1,10 @@
+module PgEventstore
+  class FeatureMarker
+    include Extensions::OptionsExtension
+    include Extensions::OptionsDefaults
+
+    attr_accessor marker: String
+    attr_accessor description: String?
+    attr_accessor purpose: Symbol?
+  end
+end

data/sig/pg_eventstore/maintenance.rbs

@@ -1,19 +1,23 @@
 module PgEventstore
   class Maintenance
-    @config: PgEventstore::Config
+    @config: Config
 
-    attr_reader config: PgEventstore::Config
+    attr_reader config: Config
 
-    def initialize: (PgEventstore::Config config) -> void
+    def initialize: (Config config) -> void
 
-    def connection: () -> PgEventstore::Connection
+    def connection: () -> Connection
 
-    def delete_event: (PgEventstore::Event event, ?force: bool)-> bool
+    def delete_event: (Event event, ?force: bool)-> bool
 
-    def delete_stream: (PgEventstore::Stream stream)-> bool
+    def delete_stream: (Stream stream)-> bool
 
-    def maintenance_queries: () -> PgEventstore::MaintenanceQueries
+    def maintenance_queries: () -> MaintenanceQueries
 
-    def transaction_queries: () -> PgEventstore::TransactionQueries
+    def transaction_queries: () -> TransactionQueries
+
+    private
+
+    def events_global_index_queries: -> EventsGlobalIndexQueries
   end
 end

data/sig/pg_eventstore/middleware/event_trace.rbs

@@ -0,0 +1,14 @@
+module PgEventstore
+  module Middleware
+    class EventTracing
+      include Middleware
+
+      CAUSATION_ID_KEY: String
+      CORRELATION_ID_KEY: String
+
+      def self.causation_marker: (String marker) -> FeatureMarker
+
+      def self.correlation_marker: (String marker) -> FeatureMarker
+    end
+  end
+end

data/sig/pg_eventstore/partition.rbs

@@ -3,13 +3,11 @@ module PgEventstore
     include Extensions::OptionsExtension
 
     attr_accessor id: Integer
-
     attr_accessor context: String
-
     attr_accessor stream_name: String?
-
     attr_accessor event_type: String?
-
     attr_accessor table_name: String
+    attr_accessor parent_context_partition_id: Integer?
+    attr_accessor parent_stream_name_partition_id: Integer?
   end
 end

data/sig/pg_eventstore/pg_connection.rbs

@@ -1,9 +1,17 @@
 module PgEventstore
   class PgConnection < PG::Connection
+    PLACEHOLDER_RE: untyped
+
     def exec: (untyped sql) -> untyped
 
     def exec_params: (untyped sql, untyped params) -> untyped
 
+    def compile: (String sql, Array[untyped] params) -> String
+
+    def prepared_value: (untyped value) -> String
+
+    private
+
     def log: (untyped sql, untyped params) -> untyped
 
     def encode_value: (untyped value) -> untyped

data/sig/pg_eventstore/queries/event_marker_queries.rbs

@@ -0,0 +1,21 @@
+module PgEventstore
+  class EventMarkerQueries
+    @query_strategy: QueryStrategy
+
+    attr_reader connection: Connection
+
+    def initialize: (Connection connection, QueryStrategy query_strategy) -> void
+
+    def create_indexes: (
+        Integer stream_idx_id,
+        Array[EventGlobalIndex::WriteApiRepr] write_api_events_index,
+        Hash[Integer, Set[Integer]] revision_to_marker_ids_map
+      ) -> void
+
+    def find_or_create_by: (Array[String] names) -> Array[EventMarker]
+
+    private
+
+    def deserialize: (PG::Result pg_result) -> Array[EventMarker]
+  end
+end

data/sig/pg_eventstore/queries/event_queries.rbs

@@ -1,47 +1,15 @@
 module PgEventstore
   class EventQueries
-    # _@param_ `connection`
-    #
-    # _@param_ `serializer`
-    #
-    # _@param_ `deserializer`
-    def initialize: (Connection connection, EventSerializer serializer, EventDeserializer deserializer) -> void
-
-    # _@param_ `event`
-    def event_exists?: (Event event) -> bool
-
-    def grouped_events: (Stream stream, Array[Hash[untyped, untyped]] options_by_event_type, **untyped options)-> Array[Event]
-
-    # _@param_ `events`
-    def global_positions_from_db: (::Array[Event] events) -> ::Array[Integer]
+    attr_accessor connection: Connection
 
-    # _@param_ `stream`
-    def stream_revision: (Stream stream) -> Integer?
+    def initialize: (Connection connection) -> void
 
-    # _@param_ `stream`
-    #
-    # _@param_ `options`
-    def stream_events: (Stream stream, ::Hash[untyped, untyped] options) -> ::Array[Event]
+    def insert: (Stream stream, ::Array[Event] events) -> ::Array[Hash[String, untyped]]
 
-    # _@param_ `stream`
-    #
-    # _@param_ `events`
-    def insert: (Stream stream, ::Array[Event] events) -> ::Array[Event]
+    private
 
-    # _@param_ `stream`
-    #
-    # _@param_ `events`
     def prepared_statements: (Stream stream, ::Array[Event] events) -> ::Array[(::Array[String] | ::Array[Object])]
 
     def links_resolver: () -> LinksResolver
-
-    # Returns the value of attribute connection.
-    attr_accessor connection: Connection
-
-    # Returns the value of attribute serializer.
-    attr_accessor serializer: EventSerializer
-
-    # Returns the value of attribute deserializer.
-    attr_accessor deserializer: EventDeserializer
   end
 end