pg_eventstore 1.9.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c0936a5580f6340a43f65d5b1b3362855b30e78fb25bdd498bf21c759458fcb
-  data.tar.gz: d18a05c7c6917e66c83de05013afcf6b9f25aaf7027e32fb1345553f5398a120
+  metadata.gz: c3ff0f3d0cf7c80ebe381ca1da32b921766c10055832f05b94d15e2f25b73d55
+  data.tar.gz: a00e2ef1bc9435b2e5b7732e0dd5ee85a3a3ed6e457c5d106f654f035ff7c3e3
 SHA512:
-  metadata.gz: b11fcbc08f2853a69c288dcd08498a5e40277cdeaf32ccba71ade48eac03cf3fd0c157abe0058daedb27aca945406afa8f3078f149e045ff63d89a47ca12da36
-  data.tar.gz: c021e192cfd8f61364235fa7ccdd2d97a37c39fe304f9167fe7cda508acd7c65b84bc2d168687a1cec185cf07870183b70fc849508a434ea13935398687cbea4
+  metadata.gz: 23c6bd66a79199cf49411e73635d4829c5bef802a97c3e37f3d46513a1c7b8163163fa665b99d47bd870829ba2059650c4d8b9798c95991c37834e478b352aa4
+  data.tar.gz: af188405be2d0a13c8694840dc6dcb5eef435ada27979a2f570be1ccacf33c465930d4bb9237ad6d7c78c7bde2edc5d0cfa61064dd7dc8c2c0c6a11856f39980

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [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
+- Admin IU: Add "Copy to clipboard" button near stream id that copies ruby stream definition
+- Admin UI: allow deletion of streams with empty attribute values
+
 ## [1.9.0]
 
 - Implement an ability to delete a stream

data/lib/pg_eventstore/subscriptions/subscription.rb

@@ -6,6 +6,9 @@ module PgEventstore
     include Extensions::UsingConnectionExtension
     include Extensions::OptionsExtension
 
+    # @return [Time]
+    DEFAULT_TIMESTAMP = Time.at(0).utc.freeze
+
     # @!attribute id
     #   @return [Integer, nil]
     attribute(:id)
@@ -164,7 +167,7 @@ module PgEventstore
         last_restarted_at: nil,
         max_restarts_number: max_restarts_number,
         chunk_query_interval: chunk_query_interval,
-        last_chunk_fed_at: Time.at(0).utc,
+        last_chunk_fed_at: DEFAULT_TIMESTAMP,
         last_chunk_greatest_position: nil,
         last_error: nil,
         last_error_occurred_at: nil,

data/lib/pg_eventstore/version.rb

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

data/lib/pg_eventstore/web/application.rb

@@ -282,14 +282,35 @@ module PgEventstore
         redirect(redirect_back_url(fallback_url: '/'))
       end
 
-      post '/delete_stream/:context/:stream_name/:stream_id' do
-        attrs = Hash[params.slice(:context, :stream_name, :stream_id)].transform_keys(&:to_sym)
-        stream = PgEventstore::Stream.new(**attrs)
-        PgEventstore.maintenance(current_config).delete_stream(stream)
-        self.flash_message = {
-          message: "Stream #{stream.to_hash} has been successfully deleted.",
-          kind: 'success'
+      post '/delete_stream' do
+        attrs = {
+          context: params[:context]&.to_s,
+          stream_name: params[:stream_name]&.to_s,
+          stream_id: params[:stream_id]&.to_s,
         }
+
+        err_message = ->(attrs) {
+          self.flash_message = {
+            message: "Could not delete #{attrs}. It is not valid stream for deletion.",
+            kind: 'error'
+          }
+        }
+
+        if attrs.values.none?(&:nil?)
+          stream = PgEventstore::Stream.new(**attrs)
+          if stream.system?
+            err_message.call(stream.to_hash)
+          else
+            PgEventstore.maintenance(current_config).delete_stream(stream)
+            self.flash_message = {
+              message: "Stream #{stream.to_hash} has been successfully deleted.",
+              kind: 'success'
+            }
+          end
+        else
+          err_message.call(attrs)
+        end
+
         redirect(redirect_back_url(fallback_url: '/'))
       end
     end

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

@@ -196,14 +196,14 @@ $(function(){
     let $confirmationModal = $('#confirmation-modal');
 
     $confirmationModal.on('hide.bs.modal', function(){
-        $(this).find('.modal-title').html('');
-        $(this).find('.modal-body').html('');
+        $(this).find('.modal-title').text('');
+        $(this).find('.modal-body').text('');
         $(this).find('.confirm').off();
     });
     let showConfirmation = function(el, callback){
         let $el = $(el);
-        $confirmationModal.find('.modal-body').html($el.data('confirm'));
-        $confirmationModal.find('.modal-title').html($el.data('confirm-title'));
+        $confirmationModal.find('.modal-body').text($el.data('confirm'));
+        $confirmationModal.find('.modal-title').text($el.data('confirm-title'));
         $confirmationModal.modal('show');
         $confirmationModal.one('click', '.confirm', callback);
     }
@@ -323,3 +323,32 @@ $(function () {
     $flashMessage.addClass(alertClass).removeClass('d-none');
     Cookies.remove(window.flashMessageCookie);
 });
+
+// Copy to clipboard with a tooltip implementation
+$(function () {
+    "use strict";
+
+    let $selector = $(".copy-to-clipboard");
+
+    $selector.tooltip({
+        container: "body",
+        title: function(){
+            let $this = $(this);
+
+            return $this.data("temp-title") || $this.data("title");
+        }
+    });
+
+    $selector.click(function () {
+        let $this = $(this);
+
+        navigator.clipboard.writeText($this.data("clipboard-content"));
+
+        $this.data("temp-title", "Copied!");
+        $this.data("bs.tooltip").hide();
+        $this.one("shown.bs.tooltip", function(){
+            $this.data("temp-title", null);
+        });
+        $this.data("bs.tooltip").show();
+    });
+});

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

@@ -79,28 +79,41 @@ module PgEventstore
         # @param updated_at [Time]
         # @return [String] html status
         def colored_state(state, interval, updated_at)
-          if state == RunnerState::STATES[:running]
-            # -1 is added as a margin to prevent false-positive result
-            if updated_at < Time.now.utc - interval - 1
-              title = <<~TEXT
-                Something is wrong. Last update was more than #{interval} seconds ago(#{updated_at}).
-              TEXT
-              <<~HTML
-                <span class="text-warning text-nowrap">
-                  #{state}
-                  <i class="fa fa-question-circle" data-toggle="tooltip" title="#{title}"></i>
-                </span>              
-              HTML
+          text_class =
+            case state
+            when RunnerState::STATES[:running]
+              alive?(interval, updated_at) ? 'text-success' : 'text-warning'
+            when RunnerState::STATES[:dead]
+              'text-danger'
             else
-              "<span class=\"text-success\">#{state}</span>"
+              'text-info'
             end
-          elsif state == RunnerState::STATES[:dead]
-            "<span class=\"text-danger\">#{state}</span>"
+
+          if alive?(interval, updated_at)
+            <<~HTML
+              <span class="#{text_class}">#{state}</span>
+            HTML
           else
-            "<span class=\"text-info\">#{state}</span>"
+            title = <<~TEXT
+              Something is wrong. Last update was more than #{interval} seconds ago(#{updated_at}).
+            TEXT
+            <<~HTML
+              <span class="#{text_class} text-nowrap">
+                #{state}
+                <i class="fa fa-question-circle" data-toggle="tooltip" title="#{title}"></i>
+              </span>
+            HTML
           end
         end
 
+        # @param interval [Integer]
+        # @param last_updated_at [Time]
+        # @return [Boolean]
+        def alive?(interval, last_updated_at)
+          # -1 is added as a margin to prevent false-positive result
+          last_updated_at > Time.now.utc - interval - 1
+        end
+
         # @param ids [Array<Integer>]
         # @return [String]
         def delete_all_subscriptions_url(ids)
@@ -117,7 +130,8 @@ module PgEventstore
         # @param stream_attrs [Hash]
         # @return [String]
         def delete_stream_url(stream_attrs)
-          url("/delete_stream/#{stream_attrs[:context]}/#{stream_attrs[:stream_name]}/#{stream_attrs[:stream_id]}")
+          encoded_params = Rack::Utils.build_nested_query(stream_attrs)
+          url("/delete_stream?#{encoded_params}")
         end
       end
     end

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

@@ -4,7 +4,13 @@
     <td><%= event.stream_revision %></td>
     <td><%= h event.stream.context %></td>
     <td><%= h event.stream.stream_name %></td>
-    <td><a href="<%= stream_path(event) %>"><%= event.stream.stream_id %></a></td>
+    <td>
+      <a href="<%= stream_path(event) %>"><%= 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>
       <% if event.link %>

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

@@ -85,14 +85,16 @@
                                   Restore
                                 </a>
                               <% end %>
-                              <% if PgEventstore::RunnerState::STATES.values_at(:running, :dead).include?(subscriptions_set.state) %>
+                              <% if PgEventstore::RunnerState::STATES.values_at(:running, :dead).include?(subscriptions_set.state) && alive?(PgEventstore::SubscriptionsSetLifecycle::HEARTBEAT_INTERVAL, subscriptions_set.updated_at) %>
                                 <a class="btn btn-warning" data-confirm="You are about to stop SubscriptionsSet#<%= subscriptions_set.id %>. This will also delete it and will result in stopping all related Subscriptions. If you used pg_eventstore CLI to start subscriptions - the related process will also be stopped.  Continue?" data-confirm-title="Stop SubscriptionsSet" data-method="post" href="<%= subscriptions_set_cmd_url(subscriptions_set.id, subscriptions_set_cmd('Stop')) %>" data-toggle="tooltip" title="This action will delete Subscriptions Set and release all related Subscriptions.">
                                   Stop
                                 </a>
                               <% end %>
-                              <a class="btn btn-danger" data-confirm="You are about to delete SubscriptionsSet#<%= subscriptions_set.id %>. Continue?" data-confirm-title="Delete SubscriptionsSet" data-method="post" href="<%= url("/delete_subscriptions_set/#{subscriptions_set.id}") %>" data-toggle="tooltip" title="Use this action only on stuck Subscriptions Set - to clean it up.">
-                                Delete
-                              </a>
+                              <% unless alive?(PgEventstore::SubscriptionsSetLifecycle::HEARTBEAT_INTERVAL, subscriptions_set.updated_at) %>
+                                <a class="btn btn-danger" data-confirm="You are about to delete SubscriptionsSet#<%= subscriptions_set.id %>. Continue?" data-confirm-title="Delete SubscriptionsSet" data-method="post" href="<%= url("/delete_subscriptions_set/#{subscriptions_set.id}") %>" data-toggle="tooltip" title="Use this action only on stuck Subscriptions Set - to clean it up.">
+                                  Delete
+                                </a>
+                              <% end %>
                             </td>
                           </tr>
                           <% if subscriptions_set.last_error %>
@@ -160,7 +162,7 @@
                             </td>
                             <td><%= subscription.current_position %></td>
                             <td><%= subscription.chunk_query_interval %>s</td>
-                            <td><%= subscription.last_chunk_fed_at %></td>
+                            <td><%= subscription.last_chunk_fed_at if subscription.last_chunk_fed_at > PgEventstore::Subscription::DEFAULT_TIMESTAMP %></td>
                             <td><%= colored_state(subscription.state, PgEventstore::SubscriptionsLifecycle::HEARTBEAT_INTERVAL, subscription.updated_at) %></td>
                             <td>
                               <% if subscription.average_event_processing_time %>

data/sig/pg_eventstore/subscriptions/subscription.rbs

@@ -1,5 +1,7 @@
 module PgEventstore
   class Subscription
+    DEFAULT_TIMESTAMP: Time
+
     include PgEventstore::Extensions::UsingConnectionExtension
     include PgEventstore::Extensions::OptionsExtension
 

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

@@ -2,6 +2,8 @@ module PgEventstore
   module Web
     module Subscriptions
       module Helpers
+        def alive?: (Integer interval, Time last_updated_at)-> bool
+
         def delete_event_url: (Integer global_position)-> String
 
         def delete_stream_url: (({ context: String, stream_name: String, stream_id: String }) stream_attrs)-> String

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_eventstore
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.0
 platform: ruby
 authors:
 - Ivan Dzyzenko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-03-14 00:00:00.000000000 Z
+date: 2025-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg