pg_eventstore 3.0.1 → 3.1.2

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

@@ -30,7 +30,7 @@ module PgEventstore
 
         # @return [String]
         def first_page_link
-          path = build_path(params.slice(*(params.keys - ['starting_id'])))
+          path = url(build_path(params.slice(*(params.keys - ['starting_id']))))
           <<~HTML
             <li class="page-item">
               <a class="page-link" href="#{path}" tabindex="-1">First</a>
@@ -41,17 +41,19 @@ module PgEventstore
         # @param per_page [String] string representation of items per page. E.g. "10", "20", etc.
         # @return [String]
         def per_page_url(per_page)
-          build_path(params.merge(per_page:))
+          url(build_path(params.merge(per_page:)))
         end
 
         # @param order [String] "asc"/"desc"
         # @return [String]
         def sort_url(order)
-          build_path(params.merge(order:))
+          url(build_path(params.merge(order:)))
         end
 
+        # @param should_resolve [Boolean]
+        # @return [String]
         def resolve_link_tos_url(should_resolve)
-          build_path(params.merge(resolve_link_tos: should_resolve))
+          url(build_path(params.merge(resolve_link_tos: should_resolve)))
         end
 
         # @param number [Integer] total number of events by the current filter
@@ -82,27 +84,29 @@ module PgEventstore
 
         # @param stream [PgEventstore::Stream]
         # @return [String]
-        def stream_path(stream)
-          build_path(
-            {
-              filter: {
-                streams: [
-                  {
-                    context: escape_empty_string(stream.context),
-                    stream_name: escape_empty_string(stream.stream_name),
-                    stream_id: escape_empty_string(stream.stream_id),
-                  },
-                ],
+        def stream_url(stream)
+          url(
+            build_path(
+              {
+                filter: {
+                  streams: [
+                    {
+                      context: escape_empty_string(stream.context),
+                      stream_name: escape_empty_string(stream.stream_name),
+                      stream_id: escape_empty_string(stream.stream_id),
+                    },
+                  ],
+                },
               },
-            },
-            base_url: '/'
+              base_path: '/'
+            )
           )
         end
 
         # @param marker [String]
         # @return [String]
-        def event_marker_path(marker)
-          build_path({ filter: { markers: [escape_empty_string(marker)] } }, base_url: '/')
+        def event_marker_url(marker)
+          url(build_path({ filter: { markers: [escape_empty_string(marker)] } }, base_path: '/'))
         end
 
         # @param str [String]
@@ -120,16 +124,16 @@ module PgEventstore
         def build_starting_id_link(starting_id)
           return 'javascript: void(0);' unless starting_id
 
-          build_path(params.merge(starting_id:))
+          url(build_path(params.merge(starting_id:)))
         end
 
         # @param params [Hash, Array]
         # @return [String]
-        def build_path(params, base_url: request.path)
+        def build_path(params, base_path: request.path_info)
           encoded_params = Rack::Utils.build_nested_query(params)
-          return base_url if encoded_params.empty?
+          return base_path if encoded_params.empty?
 
-          "#{base_url}?#{encoded_params}"
+          "#{base_path}?#{encoded_params}"
         end
       end
     end

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

@@ -12,7 +12,7 @@
     <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.stream) %>"><%= empty_characters_fallback(h event.stream.stream_id) %></a>
+      <a href="<%= stream_url(event.stream) %>"><%= 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>
@@ -33,9 +33,11 @@
       <a href="javascript: void(0);" class="d-inline-block text-nowrap toggle-event-data">
         JSON <i class="fa fa-eye"></i>
       </a>
-      <a href="javascript: void(0);" class="ml-2 btn btn-danger btn-small delete-event-btn" data-global-position="<%= event.global_position %>" data-url="<%= delete_event_url(event.global_position) %>" data-toggle="modal" data-target="#delete-event-modal">
-        Delete
-      </a>
+      <% if can_delete? %>
+        <a href="javascript: void(0);" class="ml-2 btn btn-danger btn-small delete-event-btn" data-global-position="<%= event.global_position %>" data-url="<%= delete_event_url(event.global_position) %>" data-toggle="modal" data-target="#delete-event-modal">
+          Delete
+        </a>
+      <% end %>
     </td>
   </tr>
   <tr class="event-payload d-none">
@@ -55,7 +57,7 @@
               <% event.feature_markers.each do |feature_marker| %>
                 <li>
                   <%= "#{h feature_marker.description}:" if feature_marker.description %>
-                  <a href="<%= event_marker_path(feature_marker.marker) %>">
+                  <a href="<%= event_marker_url(feature_marker.marker) %>">
                     <%= empty_characters_fallback(h feature_marker.marker) %>
                   </a>
                 </li>
@@ -66,7 +68,7 @@
             Event markers
             <ul>
               <% event.markers.each do |marker| %>
-                <li> <a href="<%= event_marker_path(marker) %>"><%= empty_characters_fallback(h marker) %></a> </li>
+                <li> <a href="<%= event_marker_url(marker) %>"><%= empty_characters_fallback(h marker) %></a> </li>
               <% end %>
             </ul>
           <% end %>

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

@@ -39,7 +39,7 @@
     <a class="btn btn-default remove-filter" href="javascript: void(0);">
       <i class="fa fa-minus-circle"></i>
     </a>
-    <% if stream[:context] && stream[:stream_name] && stream[:stream_id] %>
+    <% if stream[:context] && stream[:stream_name] && stream[:stream_id] && can_delete? %>
       <a class="btn btn-danger btn-small delete-stream" data-confirm="You are about to delete all events in <%= h stream.inspect %> stream. This action is irreversible Continue?" data-confirm-title="Delete Stream" data-method="post" href="<%= delete_stream_url(stream) %>">
         Delete stream
       </a>

data/lib/pg_eventstore/web/views/streams/partials/streams.erb

@@ -4,7 +4,7 @@
     <td><%= empty_characters_fallback(h stream.context) %></td>
     <td><%= empty_characters_fallback(h stream.stream_name) %></td>
     <td>
-      <a href="<%= stream_path(stream) %>" target="_blank"><%= empty_characters_fallback(h stream.stream_id) %></a>
+      <a href="<%= stream_url(stream) %>" target="_blank"><%= empty_characters_fallback(h stream.stream_id) %></a>
     </td>
     <td><%= stream.stream_revision %></td>
   </tr>

data/lib/pg_eventstore/web.rb

@@ -19,6 +19,14 @@ require_relative 'web/subscriptions/with_state/set_collection'
 require_relative 'web/subscriptions/with_state/subscriptions'
 require_relative 'web/subscriptions/with_state/subscriptions_set'
 require_relative 'web/subscriptions/helpers'
+require_relative 'web/metrics/metric_family'
+require_relative 'web/metrics/formatter'
+require_relative 'web/metrics/collectors/base'
+require_relative 'web/metrics/collectors/subscriptions_latency'
+require_relative 'web/metrics/collectors/subscriptions_health'
+require_relative 'web/metrics/collectors/subscriptions_throughput'
+require_relative 'web/metrics/helpers'
+require_relative 'web/metrics/application'
 require_relative 'web/application'
 
 module PgEventstore

data/rbs_collection.lock.yaml

@@ -6,7 +6,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: 0cb6351d218704700cf4df797ff8966b3a418fcd
+    revision: 9ab762c8247028f90620fc93c4e7aac20eb693d7
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: forwardable

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

@@ -15,7 +15,7 @@ module PgEventstore
         Integer events_number
       ) -> void
 
-    def self.update_subscription_error: (Subscription subscription, WrappedException error) -> void
+    def self.update_subscription_error: (Subscription subscription, StandardError error) -> void
 
     def self.update_subscription_chunk_stats: (Subscription subscription, Integer subscription_position) -> void
 

data/sig/pg_eventstore/subscriptions/runner_recovery_strategies/report_subscription_unrecoverable_error.rbs

@@ -0,0 +1,15 @@
+module PgEventstore
+  module RunnerRecoveryStrategies
+    class ReportSubscriptionUnrecoverableError
+      include RunnerRecoveryStrategy
+
+      @failed_subscription_notifier: _FailedSubscriptionNotifier?
+      @subscription: Subscription
+
+      def initialize: (
+          subscription: Subscription,
+          failed_subscription_notifier: _FailedSubscriptionNotifier?
+        )-> untyped
+    end
+  end
+end

data/sig/pg_eventstore/subscriptions/subscription_feed_strategy/collection.rbs

@@ -4,7 +4,7 @@ module PgEventstore
       DEFAULT_SUBSCRIPTIONS_NUM_PER_QUERY: Integer
 
       def self.create: (
-          Array[SubscriptionRunner | ReplicaSubscriptionRunner] runners,
+          Hash[SubscriptionRunner | ReplicaSubscriptionRunner, Hash[Symbol, untyped]] runners_query_options,
           Connection connection,
           QueryStrategy query_strategy,
           ?subscriptions_per_query: Integer

data/sig/pg_eventstore/subscriptions/subscription_feed_strategy/index_read_strategy.rbs

@@ -7,7 +7,7 @@ module PgEventstore
 
       @connection: Connection
       @query_strategy: QueryStrategy
-      @runners: Array[SubscriptionRunner]
+      @runners_query_options: Hash[SubscriptionRunner, Hash[Symbol, untyped]]
 
       def initialize: (Connection connection, QueryStrategy query_strategy) -> void
 

data/sig/pg_eventstore/subscriptions/subscription_feed_strategy/replication_strategy.rbs

@@ -7,7 +7,7 @@ module PgEventstore
 
       @connection: Connection
       @query_strategy: QueryStrategy
-      @runners: Array[ReplicaSubscriptionRunner]
+      @runners_query_options: Hash[ReplicaSubscriptionRunner, Hash[Symbol, untyped]]
 
       def initialize: (Connection connection, QueryStrategy query_strategy) -> void
 

data/sig/pg_eventstore/subscriptions/subscription_feed_strategy.rbs

@@ -1,6 +1,6 @@
 module PgEventstore
   module SubscriptionFeedStrategy[unchecked Runner]
-    def add: (*Runner runners) -> Array[Runner]
+    def add: (Runner runner, Hash[Symbol, untyped] query_options) -> void
 
     def any?: -> bool
 

data/sig/pg_eventstore/subscriptions/subscription_runner.rbs

@@ -23,8 +23,6 @@ module PgEventstore
 
     def next_chunk_query_opts: () -> ::Hash[untyped, untyped]
 
-    def time_to_feed?: () -> bool
-
     def next_chunk_global_position: () -> Integer
 
     def estimate_events_number: () -> Integer

data/sig/pg_eventstore/subscriptions/subscription_runners_feeder.rbs

@@ -8,6 +8,8 @@ module PgEventstore
 
     private
 
+    def time_to_feed?: (SubscriptionRunner runner) -> bool
+
     def connection: -> Connection
   end
 end

data/sig/pg_eventstore/web/application.rbs

@@ -11,6 +11,8 @@ module PgEventstore
 
       def asset_url: (String path) -> String
 
+      def can_delete?: -> bool
+
       def connection: -> Connection
 
       def current_config: -> Symbol

data/sig/pg_eventstore/web/metrics/application.rbs

@@ -0,0 +1,11 @@
+module PgEventstore
+  module Web
+    module Metrics
+      class Application
+        def metrics_connection: -> Connection
+
+        def config_name: -> Symbol
+      end
+    end
+  end
+end

data/sig/pg_eventstore/web/metrics/collectors/base.rbs

@@ -0,0 +1,33 @@
+module PgEventstore
+  module Web
+    module Metrics
+      module Collectors
+        class Base
+          STATEMENT_TIMEOUT: Integer
+
+          @connection: Connection
+
+          @sets: Array[String]
+
+          attr_reader connection: Connection
+
+          attr_reader sets: Array[String]
+
+          def initialize: (Connection connection, ?sets: Array[String]) -> void
+
+          def call: -> Array[Web::Metrics::MetricFamily]
+
+          def subscriptions_sql_builder: -> SQLBuilder
+
+          private
+
+          def subscription_labels: (Hash[String, untyped] row) -> Hash[Symbol, untyped]
+
+          def transaction_queries: -> TransactionQueries
+
+          def with_safe_conn: () { (PgConnection conn) -> PG::Result } -> Array[Hash[String, untyped]]
+        end
+      end
+    end
+  end
+end

data/sig/pg_eventstore/web/metrics/collectors/subscriptions_health.rbs

@@ -0,0 +1,15 @@
+module PgEventstore
+  module Web
+    module Metrics
+      module Collectors
+        class SubscriptionsHealth < Base
+          def call: -> Array[MetricFamily]
+
+          private
+
+          def subscription_rows: -> Array[Hash[String, untyped]]
+        end
+      end
+    end
+  end
+end

data/sig/pg_eventstore/web/metrics/collectors/subscriptions_latency.rbs

@@ -0,0 +1,31 @@
+module PgEventstore
+  module Web
+    module Metrics
+      module Collectors
+        class SubscriptionsLatency < Base
+          def call: -> Array[MetricFamily]
+
+          private
+
+          def add_samples: (
+            Hash[String, untyped] row,
+            Hash[Integer, Time] created_at_by_position,
+            Time now,
+            MetricFamily lag_events,
+            MetricFamily lag_seconds
+          ) -> void
+
+          def positions: -> [Integer, Integer]
+
+          def subscription_rows: (Integer frontier_position) -> Array[Hash[String, untyped]]
+
+          def resolve_created_at: (Array[Hash[String, untyped]] subscription_rows) -> Hash[Integer, Time]
+
+          def events_global_index_queries: -> EventsGlobalIndexQueries
+
+          def store_families: (Integer frontier_position, Integer head_global_position) -> Array[MetricFamily]
+        end
+      end
+    end
+  end
+end

data/sig/pg_eventstore/web/metrics/collectors/subscriptions_throughput.rbs

@@ -0,0 +1,15 @@
+module PgEventstore
+  module Web
+    module Metrics
+      module Collectors
+        class SubscriptionsThroughput < Base
+          def call: -> Array[MetricFamily]
+
+          private
+
+          def subscription_rows: -> Array[Hash[String, untyped]]
+        end
+      end
+    end
+  end
+end

data/sig/pg_eventstore/web/metrics/formatter.rbs

@@ -0,0 +1,19 @@
+module PgEventstore
+  module Web
+    module Metrics
+      class Formatter
+        CONTENT_TYPE: String
+
+        def call: (Array[MetricFamily] families) -> String
+
+        private
+
+        def format_family: (MetricFamily family) -> String
+
+        def format_labels: (Hash[Symbol, untyped] labels) -> String
+
+        def escape_label_value: (String value) -> String
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module PgEventstore
+  module Web
+    module Metrics
+      module Helpers
+        def metrics_response: (Array[untyped] collector_classes) -> String
+
+        def requested_sets: -> Array[String]
+      end
+    end
+  end
+end

data/sig/pg_eventstore/web/metrics/metric_family.rbs

@@ -0,0 +1,19 @@
+module PgEventstore
+  module Web
+    module Metrics
+      class MetricFamily
+        attr_reader name: String
+
+        attr_reader type: String
+
+        attr_reader help: String
+
+        attr_reader samples: Array[Hash[Symbol, untyped]]
+
+        def initialize: (name: String, type: String, help: String) -> void
+
+        def add_sample: (labels: Hash[Symbol, untyped], value: Integer | Float) -> void
+      end
+    end
+  end
+end

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

@@ -4,7 +4,7 @@ module PgEventstore
       module Helpers
         def empty_characters_fallback: (String str)-> String
 
-        def event_marker_path: (String marker) -> String
+        def event_marker_url: (String marker) -> String
 
         def previous_page_link: (BaseCollection collection) -> String
 
@@ -14,17 +14,19 @@ module PgEventstore
 
         def per_page_url: (String per_page) -> String
 
+        def resolve_link_tos_url: (bool should_resolve) -> String
+
         def sort_url: (String order) -> String
 
         def total_count: (Integer number) -> String
 
         def number_with_delimiter: (Integer number, ?delimiter: String) -> String
 
-        def stream_path: (Stream stream) -> String
+        def stream_url: (Stream stream) -> String
 
         def build_starting_id_link: ((String | Integer)? starting_id) -> String
 
-        def build_path: ((::Hash[untyped, untyped] | ::Array[untyped]) params, ?base_url: String) -> String
+        def build_path: ((::Hash[untyped, untyped] | ::Array[untyped]) params, ?base_path: String) -> String
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pg_eventstore
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.2
 platform: ruby
 authors:
 - Ivan Dzyzenko
@@ -119,6 +119,7 @@ files:
 - docs/how_it_works.md
 - docs/linking_events.md
 - docs/maintenance.md
+- docs/metrics.md
 - docs/multiple_commands.md
 - docs/reading_events.md
 - docs/reading_streams.md
@@ -265,6 +266,7 @@ files:
 - lib/pg_eventstore/subscriptions/replica_subscription_handler.rb
 - lib/pg_eventstore/subscriptions/replica_subscription_runner.rb
 - lib/pg_eventstore/subscriptions/runner_recovery_strategies.rb
+- lib/pg_eventstore/subscriptions/runner_recovery_strategies/report_subscription_unrecoverable_error.rb
 - lib/pg_eventstore/subscriptions/runner_recovery_strategies/restore_connection.rb
 - lib/pg_eventstore/subscriptions/runner_recovery_strategies/restore_subscription_feeder.rb
 - lib/pg_eventstore/subscriptions/runner_recovery_strategies/restore_subscription_runner.rb
@@ -302,6 +304,14 @@ files:
 - lib/pg_eventstore/version.rb
 - lib/pg_eventstore/web.rb
 - lib/pg_eventstore/web/application.rb
+- lib/pg_eventstore/web/metrics/application.rb
+- lib/pg_eventstore/web/metrics/collectors/base.rb
+- lib/pg_eventstore/web/metrics/collectors/subscriptions_health.rb
+- lib/pg_eventstore/web/metrics/collectors/subscriptions_latency.rb
+- lib/pg_eventstore/web/metrics/collectors/subscriptions_throughput.rb
+- lib/pg_eventstore/web/metrics/formatter.rb
+- lib/pg_eventstore/web/metrics/helpers.rb
+- lib/pg_eventstore/web/metrics/metric_family.rb
 - lib/pg_eventstore/web/paginator/base_collection.rb
 - lib/pg_eventstore/web/paginator/event_types_collection.rb
 - lib/pg_eventstore/web/paginator/events_collection.rb
@@ -494,6 +504,7 @@ files:
 - sig/pg_eventstore/subscriptions/queries/subscriptions_set_queries.rbs
 - sig/pg_eventstore/subscriptions/replica_subscription_handler.rbs
 - sig/pg_eventstore/subscriptions/replica_subscription_runner.rbs
+- sig/pg_eventstore/subscriptions/runner_recovery_strategies/report_subscription_unrecoverable_error.rbs
 - sig/pg_eventstore/subscriptions/runner_recovery_strategies/restore_connection.rbs
 - sig/pg_eventstore/subscriptions/runner_recovery_strategies/restore_subscription_feeder.rbs
 - sig/pg_eventstore/subscriptions/runner_recovery_strategies/restore_subscription_runner.rbs
@@ -529,6 +540,14 @@ files:
 - sig/pg_eventstore/utils.rbs
 - sig/pg_eventstore/version.rbs
 - sig/pg_eventstore/web/application.rbs
+- sig/pg_eventstore/web/metrics/application.rbs
+- sig/pg_eventstore/web/metrics/collectors/base.rbs
+- sig/pg_eventstore/web/metrics/collectors/subscriptions_health.rbs
+- sig/pg_eventstore/web/metrics/collectors/subscriptions_latency.rbs
+- sig/pg_eventstore/web/metrics/collectors/subscriptions_throughput.rbs
+- sig/pg_eventstore/web/metrics/formatter.rbs
+- sig/pg_eventstore/web/metrics/helpers.rbs
+- sig/pg_eventstore/web/metrics/metric_family.rbs
 - sig/pg_eventstore/web/paginator/base_collection.rbs
 - sig/pg_eventstore/web/paginator/event_types_collection.rbs
 - sig/pg_eventstore/web/paginator/events_collection.rbs