pg_eventstore 1.10.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3ff0f3d0cf7c80ebe381ca1da32b921766c10055832f05b94d15e2f25b73d55
-  data.tar.gz: a00e2ef1bc9435b2e5b7732e0dd5ee85a3a3ed6e457c5d106f654f035ff7c3e3
+  metadata.gz: 402dc90a012b5e1ee934da4f62c4af4ba62e69693a45dac1a84d461950da5717
+  data.tar.gz: 6c5d1fdc2e9475eca72b5ef27d0081e0aec6331f76639b7172e676d8b6e63e3d
 SHA512:
-  metadata.gz: 23c6bd66a79199cf49411e73635d4829c5bef802a97c3e37f3d46513a1c7b8163163fa665b99d47bd870829ba2059650c4d8b9798c95991c37834e478b352aa4
-  data.tar.gz: af188405be2d0a13c8694840dc6dcb5eef435ada27979a2f570be1ccacf33c465930d4bb9237ad6d7c78c7bde2edc5d0cfa61064dd7dc8c2c0c6a11856f39980
+  metadata.gz: b20c1124f2108b671bd28f3677fb3b2ae88f3b19d2470eb5a31102eb597d4bd5af1080f9bd337b1528107eef2e4bce6b882d434aa8536abc0a5a80b373bfe3a3
+  data.tar.gz: 9fd5af079cedc277e278b2e0b50e628601880a81ec5bf7c94700595f6472be389b2fa3d3a2ba2f5d311c8844da40de2c4a52e4dc6c2bda2ca3559e94b267f7f2

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [1.11.0]
+
+- Add a global position that caused an error to the subscription's error JSON info. This will help you understand what event caused your subscription to fail.
+- Improve long payloads in JSON preview in admin web UI in the way it does not moves content out of the visible area.
+- Admin UI: adjust events filtering and displaying of stream context, stream name, stream id and event type when values of them contain empty strings or non-displayable characters
+
 ## [1.10.0]
 - Admin UI: Adjust `SubscriptionSet` "Stop"/"Delete" buttons appearance. Now if `SubscriptionsSet` is not alive anymore(the related process is dead or does not exist anymore) - "Delete" button is shown. If `SubscriptionSet` is alive - "Stop" button is shown
 - Admin IU: fixed several potential XSS vulnerabilities

data/lib/pg_eventstore/errors.rb

@@ -243,4 +243,14 @@ module PgEventstore
       "Too many records of #{stream.to_hash.inspect} stream to lock: #{number_of_records}"
     end
   end
+
+  class WrappedException < Error
+    attr_reader :original_exception
+    attr_reader :extra
+
+    def initialize(original_exception, extra)
+      @original_exception = original_exception
+      @extra = extra
+    end
+  end
 end

data/lib/pg_eventstore/subscriptions/callback_handlers/events_processor_handlers.rb

@@ -16,9 +16,9 @@ module PgEventstore
         callbacks.run_callbacks(:process, Utils.original_global_position(raw_event)) do
           handler.call(raw_event)
         end
-      rescue
+      rescue => exception
         raw_events.unshift(raw_event)
-        raise
+        raise Utils.wrap_exception(exception, global_position: Utils.original_global_position(raw_event))
       end
 
       # @param callbacks [PgEventstore::Callbacks]

data/lib/pg_eventstore/subscriptions/callback_handlers/subscription_runner_handlers.rb

@@ -26,7 +26,7 @@ module PgEventstore
       end
 
       # @param subscription [PgEventstore::Subscription]
-      # @param error [StandardError]
+      # @param error [PgEventstore::WrappedException]
       # @return [void]
       def update_subscription_error(subscription, error)
         subscription.update(last_error: Utils.error_info(error), last_error_occurred_at: Time.now.utc)
@@ -36,13 +36,13 @@ module PgEventstore
       # @param restart_terminator [#call, nil]
       # @param failed_subscription_notifier [#call, nil]
       # @param events_processor [PgEventstore::EventsProcessor]
-      # @param error [StandardError]
+      # @param error [PgEventstore::WrappedException]
       # @return [void]
       def restart_events_processor(subscription, restart_terminator, failed_subscription_notifier, events_processor,
                                    error)
         return if restart_terminator&.call(subscription.dup)
         if subscription.restart_count >= subscription.max_restarts_number
-          return failed_subscription_notifier&.call(subscription.dup, error)
+          return failed_subscription_notifier&.call(subscription.dup, Utils.unwrap_exception(error))
         end
 
         Thread.new do

data/lib/pg_eventstore/utils.rb

@@ -46,11 +46,14 @@ module PgEventstore
       # @param error [StandardError]
       # @return [Hash]
       def error_info(error)
+        original_error = unwrap_exception(error)
         {
-          class: error.class,
-          message: error.message,
-          backtrace: error.backtrace
-        }
+          class: original_error.class,
+          message: original_error.message,
+          backtrace: original_error.backtrace
+        }.tap do |attrs|
+          attrs.merge!(error.extra) if error.is_a?(WrappedException)
+        end
       end
 
       # @param str [String]
@@ -101,6 +104,21 @@ module PgEventstore
         end
       rescue Errno::ENOENT
       end
+
+      # @param exception [StandardError]
+      # @param extra [Hash] additional exception info
+      # @return [PgEventstore::WrappedException]
+      def wrap_exception(exception, **extra)
+        WrappedException.new(exception, extra)
+      end
+
+      # @param wrapped_exception [StandardError, PgEventstore::WrappedException]
+      # @return [StandardError]
+      def unwrap_exception(wrapped_exception)
+        return wrapped_exception.original_exception if wrapped_exception.is_a?(WrappedException)
+
+        wrapped_exception
+      end
     end
   end
 end

data/lib/pg_eventstore/version.rb

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

data/lib/pg_eventstore/web/application.rb

@@ -13,6 +13,11 @@ module PgEventstore
       # @return [String]
       COOKIES_FLASH_MESSAGE_KEY = 'flash_message'
 
+      # Defines a replacement for empty string value in a stream attributes filter or in an event type filter. This
+      # replacement is needed to differentiate a user selection vs default placeholder value.
+      # @return [String]
+      EMPTY_STRING_SIGN = "\x00".freeze
+
       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 }
@@ -69,8 +74,11 @@ module PgEventstore
         # @param collection [PgEventstore::Web::Paginator::BaseCollection]
         # @return [void]
         def paginated_json_response(collection)
+          results = collection.collection.map do |attrs|
+            attrs.transform_values { escape_empty_string(_1) }
+          end
           halt 200, {
-            results: collection.collection,
+            results: results,
             pagination: { more: !collection.next_page_starting_id.nil?, starting_id: collection.next_page_starting_id }
           }.to_json
         end
@@ -108,9 +116,25 @@ module PgEventstore
             COOKIES_FLASH_MESSAGE_KEY, { value: val, http_only: false, same_site: :lax, path: '/' }
           )
         end
+
+        # @param string [String, nil]
+        # @return [String, nil]
+        def escape_empty_string(string)
+          string == '' ? EMPTY_STRING_SIGN : string
+        end
+
+        # @param string [String, nil]
+        # @return [String, nil]
+        def unescape_empty_string(string)
+          string == EMPTY_STRING_SIGN ? '' : string
+        end
       end
 
       get '/' do
+        streams_filter = self.streams_filter&.map do |attrs|
+          attrs.transform_values { unescape_empty_string(_1) }
+        end
+        events_filter = self.events_filter&.map(&method(:unescape_empty_string))
         @collection = Paginator::EventsCollection.new(
           current_config,
           starting_id: params[:starting_id]&.to_i,
@@ -169,7 +193,7 @@ module PgEventstore
       get '/stream_contexts_filtering', provides: :json do
         collection = Paginator::StreamContextsCollection.new(
           current_config,
-          starting_id: params[:starting_id],
+          starting_id: unescape_empty_string(params[:starting_id]),
           per_page: Paginator::StreamContextsCollection::PER_PAGE,
           order: :asc,
           options: { query: params[:term] }
@@ -180,10 +204,10 @@ module PgEventstore
       get '/stream_names_filtering', provides: :json do
         collection = Paginator::StreamNamesCollection.new(
           current_config,
-          starting_id: params[:starting_id],
+          starting_id: unescape_empty_string(params[:starting_id]),
           per_page: Paginator::StreamNamesCollection::PER_PAGE,
           order: :asc,
-          options: { query: params[:term], context: params[:context] }
+          options: { query: params[:term], context: unescape_empty_string(params[:context]) }
         )
         paginated_json_response(collection)
       end
@@ -191,10 +215,14 @@ module PgEventstore
       get '/stream_ids_filtering', provides: :json do
         collection = Paginator::StreamIdsCollection.new(
           current_config,
-          starting_id: params[:starting_id],
+          starting_id: unescape_empty_string(params[:starting_id]),
           per_page: Paginator::StreamIdsCollection::PER_PAGE,
           order: :asc,
-          options: { query: params[:term], context: params[:context], stream_name: params[:stream_name] }
+          options: {
+            query: params[:term],
+            context: unescape_empty_string(params[:context]),
+            stream_name: unescape_empty_string(params[:stream_name])
+          }
         )
         paginated_json_response(collection)
       end
@@ -202,7 +230,7 @@ module PgEventstore
       get '/event_types_filtering', provides: :json do
         collection = Paginator::EventTypesCollection.new(
           current_config,
-          starting_id: params[:starting_id],
+          starting_id: unescape_empty_string(params[:starting_id]),
           per_page: Paginator::EventTypesCollection::PER_PAGE,
           order: :asc,
           options: { query: params[:term] }

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

@@ -88,9 +88,9 @@ module PgEventstore
               filter: {
                 streams: [
                   {
-                    context: event.stream.context,
-                    stream_name: event.stream.stream_name,
-                    stream_id: event.stream.stream_id
+                    context: escape_empty_string(event.stream.context),
+                    stream_name: escape_empty_string(event.stream.stream_name),
+                    stream_id: escape_empty_string(event.stream.stream_id)
                   }
                 ]
               }
@@ -98,6 +98,14 @@ module PgEventstore
           )
         end
 
+        # @param str [String]
+        # @return [String]
+        def empty_characters_fallback(str)
+          return str unless str.strip == ''
+
+          '<i>Non-printable characters</i>'
+        end
+
         private
 
         # @param starting_id [String, Integer, nil]

data/lib/pg_eventstore/web/public/javascripts/pg_eventstore.js

@@ -1,6 +1,30 @@
 $(function(){
     "use strict";
 
+    const EMPTY_STRING_SIGN = "\x00";
+
+    let templateSelection = function(state){
+        if (!state.id)
+            return state.text;
+
+        return filterValueToHuman(state.element && state.element.value, state.text);
+    }
+
+    let templateResult = function(item){
+        return filterValueToHuman(item.text);
+    }
+
+    let filterValueToHuman = function(str, alternativeStr){
+        if(str === EMPTY_STRING_SIGN)
+            return $("<i>Empty String</i>");
+
+        let result = alternativeStr || str;
+        if($.trim(result.replaceAll(EMPTY_STRING_SIGN, '')) === '')
+            return $("<i>Non-printable characters</i>");
+
+        return result;
+    }
+
     let initStreamFilterAutocomplete = function($filter) {
         let $contextSelect = $filter.find('select[name*="context"]');
         let $streamNameSelect = $filter.find('select[name*="stream_name"]');
@@ -22,7 +46,9 @@ $(function(){
                     return data;
                 },
             },
-            allowClear: true
+            allowClear: true,
+            templateSelection: templateSelection,
+            templateResult: templateResult,
         });
         $streamNameSelect.select2({
             ajax: {
@@ -41,7 +67,9 @@ $(function(){
                     return data;
                 },
             },
-            allowClear: true
+            allowClear: true,
+            templateSelection: templateSelection,
+            templateResult: templateResult,
         });
         $streamIdSelect.select2({
             ajax: {
@@ -61,7 +89,9 @@ $(function(){
                     return data;
                 },
             },
-            allowClear: true
+            allowClear: true,
+            templateSelection: templateSelection,
+            templateResult: templateResult,
         });
         $contextSelect.on('change.select2', removeDeleteBtn);
         $streamNameSelect.on('change.select2', removeDeleteBtn);
@@ -89,7 +119,9 @@ $(function(){
                     return data;
                 },
             },
-            allowClear: true
+            allowClear: true,
+            templateSelection: templateSelection,
+            templateResult: templateResult,
         });
     }
 
@@ -130,6 +162,11 @@ $(function(){
         initEventTypeFilterAutocomplete($filtersForm.find('.event-filters').children().last());
     });
 
+    // Because zero-byte character can't be rendered into HTML properly - loop through each option, marked as containing
+    // zero-byte value and assign zero-byte value explicitly. This must be done before we initialize select2 plugin.
+    $('option.zero-byte-val').each(function(){
+        this.value = EMPTY_STRING_SIGN;
+    });
     // Init select2 for stream filters which were initially rendered
     $filtersForm.find('.stream-filters').children().each(function(){
         initStreamFilterAutocomplete($(this));

data/lib/pg_eventstore/web/public/stylesheets/pg_eventstore.css

@@ -4,6 +4,18 @@ tr.collapsing {
     display: none;
 }
 
+td.json-cell {
+    max-width: 1px;
+}
+
+td.json-cell pre {
+    display: block;
+    width: 100%;
+    box-sizing: border-box;
+    overflow-x: auto;
+    white-space: pre;
+}
+
 #confirmation-modal .modal-body {
     font-size: 1.2rem;
 }

data/lib/pg_eventstore/web/views/home/partials/event_filter.erb

@@ -3,7 +3,11 @@
     <select name="filter[events][]" class="form-control mb-2" data-placeholder="Event type" data-url="<%= url('/event_types_filtering') %>" autocomplete="off">
       <option></option>
       <% if event_type %>
-        <option value="<%= h event_type %>" selected><%= h event_type %></option>
+        <% if event_type == PgEventstore::Web::Application::EMPTY_STRING_SIGN %>
+          <option class="zero-byte-val" selected></option>
+        <% else %>
+          <option value="<%= h event_type %>" selected><%= h event_type %></option>
+        <% end %>
       <% end %>
     </select>
   </div>

data/lib/pg_eventstore/web/views/home/partials/events.erb

@@ -2,17 +2,17 @@
   <tr>
     <td><%= event.global_position %></td>
     <td><%= event.stream_revision %></td>
-    <td><%= h event.stream.context %></td>
-    <td><%= h event.stream.stream_name %></td>
+    <td><%= empty_characters_fallback(h event.stream.context) %></td>
+    <td><%= empty_characters_fallback(h event.stream.stream_name) %></td>
     <td>
-      <a href="<%= stream_path(event) %>"><%= h event.stream.stream_id %></a>
+      <a href="<%= stream_path(event) %>"><%= empty_characters_fallback(h event.stream.stream_id) %></a>
       <a role="button" href="#" data-title="Copy stream definition." class="copy-to-clipboard"
          data-clipboard-content="<%= h "PgEventstore::Stream.new(context: #{event.stream.context.inspect}, stream_name: #{event.stream.stream_name.inspect}, stream_id: #{event.stream.stream_id.inspect})" %>">
         <i class="fa fa-clipboard"></i>
       </a>
     </td>
     <td>
-      <p class="float-left"><%= h event.type %></p>
+      <p class="float-left"><%= empty_characters_fallback(h event.type) %></p>
       <% if event.link %>
         <p class="float-left ml-2">
           <i class="fa fa-link"></i>
@@ -32,7 +32,7 @@
     </td>
   </tr>
   <tr class="event-payload d-none">
-    <td colspan="8">
+    <td colspan="9" class="json-cell">
       <strong>Data:</strong>
       <pre><%= h JSON.pretty_generate(event.data) %></pre>
       <strong>Metadata:</strong>

data/lib/pg_eventstore/web/views/home/partials/stream_filter.erb

@@ -3,7 +3,11 @@
     <select name="filter[streams][][context]" class="form-control mb-2" data-placeholder="Context" data-url="<%= url('/stream_contexts_filtering') %>" autocomplete="off">
       <option></option>
       <% if stream[:context] %>
-        <option value="<%= h stream[:context] %>" selected><%= h stream[:context] %></option>
+        <% if stream[:context] == PgEventstore::Web::Application::EMPTY_STRING_SIGN %>
+          <option class="zero-byte-val" selected></option>
+        <% else %>
+          <option value="<%= h stream[:context] %>" selected><%= h stream[:context] %></option>
+        <% end %>
       <% end %>
     </select>
   </div>
@@ -11,7 +15,11 @@
     <select name="filter[streams][][stream_name]" class="form-control mb-2" data-placeholder="Stream name" data-url="<%= url('/stream_names_filtering') %>" autocomplete="off">
       <option></option>
       <% if stream[:stream_name] %>
-        <option value="<%= h stream[:stream_name] %>" selected><%= h stream[:stream_name] %></option>
+        <% if stream[:stream_name] == PgEventstore::Web::Application::EMPTY_STRING_SIGN %>
+          <option class="zero-byte-val" selected></option>
+        <% else %>
+          <option value="<%= h stream[:stream_name] %>" selected><%= h stream[:stream_name] %></option>
+        <% end %>
       <% end %>
     </select>
   </div>
@@ -19,7 +27,11 @@
     <select name="filter[streams][][stream_id]" class="form-control mb-2" data-placeholder="Stream ID" data-url="<%= url('/stream_ids_filtering') %>" autocomplete="off">
       <option></option>
       <% if stream[:stream_id] %>
-        <option value="<%= h stream[:stream_id] %>" selected><%= h stream[:stream_id] %></option>
+        <% if stream[:stream_id] == PgEventstore::Web::Application::EMPTY_STRING_SIGN %>
+          <option class="zero-byte-val" selected></option>
+        <% else %>
+          <option value="<%= h stream[:stream_id] %>" selected><%= h stream[:stream_id] %></option>
+        <% end %>
       <% end %>
     </select>
   </div>

data/lib/pg_eventstore/web/views/subscriptions/index.erb

@@ -210,13 +210,13 @@
                             </td>
                           </tr>
                           <tr class="collapse" id="options-<%= subscription.id %>">
-                            <td colspan="16">
+                            <td colspan="16" class="json-cell">
                               <pre><%= h JSON.pretty_generate(subscription.options) %></pre>
                             </td>
                           </tr>
                           <% if subscription.last_error %>
                             <tr class="collapse" id="last-error-<%= subscription.id %>">
-                              <td colspan="16">
+                              <td colspan="16" class="json-cell">
                                 <pre><%= h JSON.pretty_generate(subscription.last_error) %></pre>
                               </td>
                             </tr>

data/sig/pg_eventstore/errors.rbs

@@ -123,4 +123,12 @@ module PgEventstore
 
     def user_friendly_message: -> String
   end
+
+  class WrappedException < PgEventstore::Error
+    def initialize: (StandardError original_exception, Hash[Symbol, untyped] extra) -> void
+
+    attr_accessor original_exception: StandardError
+
+    attr_accessor extra: Hash[Symbol, untyped]
+  end
 end

data/sig/pg_eventstore/subscriptions/callback_handlers/subscription_runner_handlers.rbs

@@ -4,11 +4,11 @@ module PgEventstore
 
     def self.update_subscription_stats: (PgEventstore::Subscription subscription, PgEventstore::SubscriptionHandlerPerformance stats, Integer current_position) -> void
 
-    def self.update_subscription_error: (PgEventstore::Subscription subscription, StandardError error) -> void
+    def self.update_subscription_error: (PgEventstore::Subscription subscription, PgEventstore::WrappedException error) -> void
 
     def self.restart_events_processor: (PgEventstore::Subscription subscription, _RestartTerminator? restart_terminator,
         _FailedSubscriptionNotifier? failed_subscription_notifier, PgEventstore::EventsProcessor events_processor,
-        StandardError error) -> void
+        PgEventstore::WrappedException error) -> void
 
     def self.update_subscription_chunk_stats: (PgEventstore::Subscription subscription, Integer global_position) -> void
 

data/sig/pg_eventstore/utils.rbs

@@ -20,5 +20,9 @@ module PgEventstore
     def self.underscore_str: (String str) -> String
 
     def self.original_global_position: (Hash[untyped, untyped] raw_event) -> Integer
+
+    def self.unwrap_exception: (PgEventstore::WrappedException | StandardError wrapped_exception)-> StandardError
+
+    def self.wrap_exception: (StandardError exception, **untyped extra)-> PgEventstore::WrappedException
   end
 end

data/sig/pg_eventstore/web/application.rbs

@@ -5,6 +5,8 @@ module PgEventstore
       COOKIES_FLASH_MESSAGE_KEY: String
       DEFAULT_ADMIN_UI_CONFIG: Symbol
 
+      EMPTY_STRING_SIGN: String
+
       def asset_url: (String path) -> String
 
       def connection: -> PgEventstore::Connection
@@ -13,6 +15,8 @@ module PgEventstore
 
       def current_config=: (untyped val) -> void
 
+      def escape_empty_string: (String? string) -> String?
+
       def events_filter: -> Array[String]?
 
       def flash_message=: (({ message: String, kind: String }) val)-> String
@@ -30,6 +34,8 @@ module PgEventstore
       def streams_filter: -> Array[Hash[untyped, untyped]]?
 
       def system_stream: -> String?
+
+      def unescape_empty_string: (String? string) -> String?
     end
   end
 end

data/sig/pg_eventstore/web/paginator/helpers.rbs

@@ -2,6 +2,8 @@ module PgEventstore
   module Web
     module Paginator
       module Helpers
+        def empty_characters_fallback: (String str)-> String
+
         # _@param_ `collection`
         def previous_page_link: (PgEventstore::Web::Paginator::BaseCollection collection) -> String
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_eventstore
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.11.0
 platform: ruby
 authors:
 - Ivan Dzyzenko
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-04-14 00:00:00.000000000 Z
+date: 2025-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -368,7 +368,7 @@ metadata:
   homepage_uri: https://github.com/yousty/pg_eventstore
   source_code_uri: https://github.com/yousty/pg_eventstore
   changelog_uri: https://github.com/yousty/pg_eventstore/blob/main/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -383,8 +383,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: EventStore implementation using PostgreSQL
 test_files: []