pg_eventstore 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff514958069cbf4b819b2ad959eac80ca9f24445bca19690ed4cb3ff23989804
-  data.tar.gz: bd91be800c3739a43edf4c17c996156642f00f0d977446201c84784a1bcc6e74
+  metadata.gz: ac379ed7a4c1c8ca46edd8e4ec537dafd575dd50749a140d15c49c24a1ece1c1
+  data.tar.gz: c5f83c5aa8fccc6f7100172270c951fda96ca7926c7a1b6b37f90217024e3e09
 SHA512:
-  metadata.gz: 1d4946c58c314f0bfb04c0c20ca1308e4c8afe915adacee8722fcd703404b26dbc429bdda5bc5a44f94654cb366813065226b42c930620bf30fcd4a345f592b1
-  data.tar.gz: 89738f55a626cbcd4eab9d336b7f4b9ff2e3520fc30a7fc7d87dfac5e755cd6431392438d1522cec706188aa855942db4cfd6fa96bc83c5e0b67086d6e05cef8
+  metadata.gz: 6ffbe0ddbfff6207069a527c7f41693e59d00a3217f68697c851fb2582300fefc569be8035f30924a225b95522ee5ef29ec26c9c6134fe705b31f6b32d0c39a3
+  data.tar.gz: 3b1860f5f351f5ffcd56f09c557661796a98f46a49c9a9bf8945667074ad8705f7cb9998639031fe07a4a2dfb89a0bf636b1e8157a21374da869cf4e76377792

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [1.8.0]
+- Introduce default config for admin web UI. Now if you define `:admin_web_ui` config - it will be preferred over default config
+- Fix pagination of events in admin UI
+- Improve partial index for `$streams` system stream
+
 ## [1.7.0]
 - Implement reading from `"$streams"` system stream
 - Disable Host authorization introduced in sinatra v4.1

data/db/migrations/8_improve_0_revision_partial_index.sql

@@ -0,0 +1,2 @@
+DROP INDEX IF EXISTS idx_events_0_stream_revision_global_position;
+CREATE INDEX idx_events_0_stream_revision_global_position ON events USING btree (global_position) WHERE stream_revision = 0;

data/docs/admin_ui.md

@@ -10,7 +10,13 @@
 
 ## Authorization
 
-Admin UI is implemented as a rack application. It doesn't have any built-in authentication/authorization mechanism - it is your responsibility to take care of it.
+Admin UI is implemented as a rack application. It doesn't have any built-in authentication/authorization mechanism - it is your responsibility to take care of it. Admin UI tries to look for `:admin_web_ui` config with a fallback to `:default` config. Thus, you can setup Admin UI-specific config, e.g. without some middlewares or so. Example:
+
+```ruby
+PgEventstore.configure(name: :admin_web_ui) do |config|
+  config.middlewares = { my_admin_ui_middleware: AdminUIMiddleware.new }
+end
+```
 
 ### Rails integration
 

data/docs/events_and_streams.md

@@ -16,7 +16,9 @@
 - `stream_revision` - Integer(optional, read only). A revision of an event inside its stream.
 - `data` - Hash(optional). Event's payload data. For example, if you have a `DescriptionChanged` event class, then you may want to have a description value in the event payload data. Example: `DescriptionChanged.new(data: { 'description' => 'Description of something', 'post_id' => SecureRandom.uuid })`
 - `metadata` - Hash(optional). Event metadata. Event meta information which is not part of an events data payload. Example: `{ published_by: publishing_user.id }`
-- `link_id` - String(UUIDv4, optional, read only). If an event is a link event (link events are pointers to other events), this attribute contains the `id` of the original event. Manually assigning this attribute has no effect. It is internally set when appending an event to the given stream or when reading events from the database.
+- `link_id` - String(UUIDv4, optional, read only). If an event is a link event (link events are pointers to other events), this attribute contains an `id` of the original event. Manually assigning this attribute has no effect. It is internally set when appending an event to the given stream or when reading events from the database.
+- `link_partition_id` - Integer(optional, read only). If an event is a link event - this attribute contains a partition `id` of original event. Manually assigning this attribute has no effect. It is internally set when appending an event to the given stream or when reading events from the database.
+- `link` - PgEventstore::Event(optional, read only). When reading from a stream using `resolve_link_tos: true`, if an event is resolved from a link - this attribute contains a `PgEventstore::Event` object which corresponds to that link. Manually assigning this attribute has no effect. It is internally set when reading events from the database.
 - `created_at` - Time(optional, read only). Database's timestamp when an event was appended to a stream. You may want to put your own timestamp into a `metadata` attribute - it may be useful when migrating between different databases. Manually assigning this attribute has no effect. It is internally set when appending an event to the given stream or when reading events from the database.
 
 Example:
@@ -40,7 +42,21 @@ PgEventstore::Stream.new(context: 'Sales', stream_name: 'Customer', stream_id: '
 PgEventstore::Stream.new(context: 'Sales', stream_name: 'Customer', stream_id: 'f37b82f2-4152-424d-ab6b-0cc6f0a53aae')
 ```
 
-There is a special stream, called the "all" stream. You can get this object by calling the`PgEventstore::Stream.all_stream` method. Read more about the "all" stream in the `Reading from the "all" stream` section of [Reading events](reading_events.md) chapter.
+### "all" stream
+
+There is a special stream, called the "all" stream. You can get this object by calling the `PgEventstore::Stream.all_stream` method. Read more about the "all" stream in the `Reading from the "all" stream` section of [Reading events](reading_events.md) chapter.
+
+### System streams
+
+System stream is a special stream, the representation of which is pre-defined by the gem. System stream object can be created in next way:
+
+```ruby
+PgEventstore::Stream.system_stream(stream_name)
+```
+
+Current list of system streams is:
+
+- `"$streams"`. Reading from this stream will return 0 revision events. This allows effectively loop through a list of streams. Read more in [Reading events](reading_events.md#streams-stream-filtering) chapter.
 
 ## Important note
 

data/docs/multiple_commands.md

@@ -44,3 +44,7 @@ old_email =
 # Sending email outside multiple block to prevent potential re-triggering of it 
 UserMailer.notify_email_changed(user.id, old_email: old_email, new_email: user.email).deliver_later
 ```
+
+## Side effect of internal implementation
+
+Please note that when publishing an event with a type as part of a `multiple` block that does not yet exist in the database, the block will run twice as the first attempt to publish will always fail due to the way `append_to_stream` is implemented. Consider this when writing expectations in your tests for example.

data/lib/pg_eventstore/version.rb

@@ -2,5 +2,5 @@
 
 module PgEventstore
   # @return [String]
-  VERSION = "1.7.0"
+  VERSION = "1.8.0"
 end

data/lib/pg_eventstore/web/application.rb

@@ -5,6 +5,11 @@ require 'securerandom'
 module PgEventstore
   module Web
     class Application < Sinatra::Base
+      # @return [Symbol]
+      DEFAULT_ADMIN_UI_CONFIG = :admin_web_ui
+      # @return [String]
+      COOKIES_CONFIG_KEY = 'current_config'
+
       set :static_cache_control, [:private, max_age: 86400]
       set :environment, -> { (ENV['RACK_ENV'] || ENV['RAILS_ENV'] || ENV['APP_ENV'])&.to_sym || :development }
       set :logging, -> { environment == :development || environment == :test }
@@ -34,14 +39,23 @@ module PgEventstore
 
         # @return [Symbol]
         def current_config
-          config = request.cookies['current_config']&.to_s&.to_sym
-          PgEventstore.available_configs.include?(config) ? config : :default
+          resolve_config_by_name(request.cookies[COOKIES_CONFIG_KEY]&.to_s&.to_sym)
+        end
+
+        # @param config_name [Symbol, nil]
+        # @return [Symbol]
+        def resolve_config_by_name(config_name)
+          existing_config = [config_name, DEFAULT_ADMIN_UI_CONFIG].find do |name|
+            PgEventstore.available_configs.include?(name)
+          end
+
+          existing_config || PgEventstore::DEFAULT_CONFIG
         end
 
         # @param val [Object]
         # @return [void]
         def current_config=(val)
-          response.set_cookie('current_config', { value: val.to_s, http_only: true, same_site: :lax })
+          response.set_cookie(COOKIES_CONFIG_KEY, { value: val.to_s, http_only: true, same_site: :lax })
         end
 
         # @return [PgEventstore::Connection]
@@ -137,9 +151,7 @@ module PgEventstore
       end
 
       post '/change_config' do
-        config = params[:config]&.to_sym
-        config = :default unless PgEventstore.available_configs.include?(config)
-        self.current_config = config
+        self.current_config = resolve_config_by_name(params[:config]&.to_s&.to_sym)
         redirect(redirect_back_url(fallback_url: '/'))
       end
 

data/lib/pg_eventstore/web/paginator/events_collection.rb

@@ -34,8 +34,7 @@ module PgEventstore
         def collection
           @_collection ||= PgEventstore.client(config_name).read(
             @stream,
-            options: options.merge(from_position: starting_id, max_count: per_page, direction: order),
-            middlewares: []
+            options: options.merge(from_position: starting_id, max_count: per_page, direction: order)
           )
         end
 
@@ -60,7 +59,7 @@ module PgEventstore
           ).to_sql_builder.unselect.select('global_position').offset(1)
           sql, params = sql_builder.to_exec_params
           sql = "SELECT * FROM (#{sql}) events ORDER BY global_position #{order} LIMIT 1"
-          PgEventstore.connection.with  do |conn|
+          connection.with  do |conn|
             conn.exec_params(sql, params)
           end.to_a.dig(0, 'global_position')
         end

data/lib/pg_eventstore.rb

@@ -18,6 +18,9 @@ require_relative 'pg_eventstore/middleware'
 require_relative 'pg_eventstore/subscriptions/subscriptions_manager'
 
 module PgEventstore
+  # @return [Symbol]
+  DEFAULT_CONFIG = :default
+
   class << self
     # @!attribute mutex
     #   @return [Thread::Mutex]
@@ -27,7 +30,7 @@ module PgEventstore
     # Creates a Config if not exists and yields it to the given block.
     # @param name [Symbol] a name to assign to a config
     # @return [Object] a result of the given block
-    def configure(name: :default)
+    def configure(name: DEFAULT_CONFIG)
       mutex.synchronize do
         @config[name] ||= Config.new(name: name)
         connection_config_was = @config[name].connection_options
@@ -48,7 +51,7 @@ module PgEventstore
 
     # @param name [Symbol]
     # @return [PgEventstore::Config]
-    def config(name = :default)
+    def config(name = DEFAULT_CONFIG)
       return @config[name] if @config[name]
 
       error_message = <<~TEXT
@@ -64,7 +67,7 @@ module PgEventstore
     # thread-safe
     # @param name [Symbol]
     # @return [PgEventstore::Connection]
-    def connection(name = :default)
+    def connection(name = DEFAULT_CONFIG)
       mutex.synchronize do
         @connection[name] ||= Connection.new(**config(name).connection_options)
       end
@@ -76,7 +79,7 @@ module PgEventstore
     # @param retries_interval [Integer, nil] a delay between retries of failed SubscriptionsSet
     # @param force_lock [Boolean] whether to force-lock subscriptions
     # @return [PgEventstore::SubscriptionsManager]
-    def subscriptions_manager(config_name = :default, subscription_set:, max_retries: nil, retries_interval: nil,
+    def subscriptions_manager(config_name = DEFAULT_CONFIG, subscription_set:, max_retries: nil, retries_interval: nil,
                               force_lock: false)
       SubscriptionsManager.new(
         config: config(config_name),
@@ -89,7 +92,7 @@ module PgEventstore
 
     # @param name [Symbol]
     # @return [PgEventstore::Client]
-    def client(name = :default)
+    def client(name = DEFAULT_CONFIG)
       Client.new(config(name))
     end
 
@@ -108,7 +111,7 @@ module PgEventstore
 
     # @return [void]
     def init_variables
-      @config = { default: Config.new(name: :default) }
+      @config = { DEFAULT_CONFIG => Config.new(name: DEFAULT_CONFIG) }
       @connection = {}
       @mutex = Thread::Mutex.new
     end

data/sig/pg_eventstore/web/application.rbs

@@ -1,6 +1,9 @@
 module PgEventstore
   module Web
     class Application
+      COOKIES_CONFIG_KEY: String
+      DEFAULT_ADMIN_UI_CONFIG: Symbol
+
       def asset_url: (String path) -> String
 
       def connection: -> PgEventstore::Connection
@@ -17,6 +20,8 @@ module PgEventstore
 
       def redirect_back_url: (fallback_url: String) -> String
 
+      def resolve_config_by_name: (Symbol? config_name)-> Symbol
+
       def resolve_link_tos?: -> bool
 
       def streams_filter: -> Array[Hash[untyped, untyped]]?

data/sig/pg_eventstore.rbs

@@ -1,4 +1,6 @@
 module PgEventstore
+  DEFAULT_CONFIG: Symbol
+
   # _@param_ `name` — a name to assign to a config
   #
   # _@return_ — a result of the given block

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_eventstore
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Ivan Dzyzenko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-01-10 00:00:00.000000000 Z
+date: 2025-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -78,6 +78,7 @@ files:
 - db/migrations/5_partitions.sql
 - db/migrations/6_add_commands_data.sql
 - db/migrations/7_support_reading_streams_system_stream.sql
+- db/migrations/8_improve_0_revision_partial_index.sql
 - docs/admin_ui.md
 - docs/appending_events.md
 - docs/configuration.md