pg_eventstore 1.5.0 → 1.6.0

data/lib/pg_eventstore/subscriptions/subscriptions_manager.rb

@@ -36,20 +36,32 @@ module PgEventstore
     attr_reader :config
     private :config
 
-    def_delegators :@subscription_feeder, :stop, :force_lock!
+    def_delegators :@subscription_feeder, :stop, :running?
+    def_delegators :@subscriptions_lifecycle, :force_lock!
 
     # @param config [PgEventstore::Config]
     # @param set_name [String]
     # @param max_retries [Integer, nil] max number of retries of failed SubscriptionsSet
     # @param retries_interval [Integer, nil] a delay between retries of failed SubscriptionsSet
-    def initialize(config:, set_name:, max_retries: nil, retries_interval: nil)
+    # @param force_lock [Boolean] whether to force-lock subscriptions
+    def initialize(config:, set_name:, max_retries: nil, retries_interval: nil, force_lock: false)
       @config = config
       @set_name = set_name
+      @subscriptions_set_lifecycle = SubscriptionsSetLifecycle.new(
+        config_name,
+        {
+          name: set_name,
+          max_restarts_number: max_retries || config.subscriptions_set_max_retries,
+          time_between_restarts: retries_interval || config.subscriptions_set_retries_interval
+        }
+      )
+      @subscriptions_lifecycle = SubscriptionsLifecycle.new(
+        config_name, @subscriptions_set_lifecycle, force_lock: force_lock
+      )
       @subscription_feeder = SubscriptionFeeder.new(
-        config_name: config.name,
-        set_name: set_name,
-        max_retries: max_retries || config.subscriptions_set_max_retries,
-        retries_interval: retries_interval || config.subscriptions_set_retries_interval
+        config_name: config_name,
+        subscriptions_set_lifecycle: @subscriptions_set_lifecycle,
+        subscriptions_lifecycle: @subscriptions_lifecycle
       )
     end
 
@@ -97,30 +109,52 @@ module PgEventstore
         failed_subscription_notifier: failed_subscription_notifier
       )
 
-      @subscription_feeder.add(runner)
+      @subscriptions_lifecycle.runners.push(runner)
       true
     end
 
     # @return [Array<PgEventstore::Subscription>]
     def subscriptions
-      @subscription_feeder.read_only_subscriptions
+      @subscriptions_lifecycle.subscriptions.map(&:dup)
     end
 
     # @return [PgEventstore::SubscriptionsSet, nil]
     def subscriptions_set
-      @subscription_feeder.read_only_subscriptions_set
+      @subscriptions_set_lifecycle.subscriptions_set&.dup
+    end
+
+    # @return [PgEventstore::BasicRunner]
+    # @raise [PgEventstore::SubscriptionAlreadyLockedError]
+    def start!
+      run_cli_callbacks do
+        @subscription_feeder.start
+      end
     end
 
     # @return [PgEventstore::BasicRunner, nil]
     def start
-      @subscription_feeder.start
+      start!
     rescue PgEventstore::SubscriptionAlreadyLockedError => e
       PgEventstore.logger&.warn(e.message)
       nil
     end
 
+    # @return [Symbol]
+    def config_name
+      @config.name
+    end
+
     private
 
+    # @return [Object] the result of the passed block
+    def run_cli_callbacks
+      return yield unless defined?(::PgEventstore::CLI)
+
+      PgEventstore::CLI.callbacks.run_callbacks(:start_manager, self) do
+        yield
+      end
+    end
+
     # @param middlewares [Array<Symbol>, nil]
     # @param handler [#call]
     # @return [Proc]

data/lib/pg_eventstore/subscriptions/subscriptions_set_lifecycle.rb

@@ -27,7 +27,7 @@ module PgEventstore
 
     # @return [PgEventstore::SubscriptionsSet]
     def persisted_subscriptions_set
-      @subscriptions_set ||= SubscriptionsSet.using_connection(@config_name).create(**@subscriptions_set_attrs)
+      @subscriptions_set ||= SubscriptionsSet.using_connection(@config_name).create(@subscriptions_set_attrs)
     end
 
     # @return [void]

data/lib/pg_eventstore/utils.rb

@@ -69,6 +69,38 @@ module PgEventstore
       def original_global_position(raw_event)
         raw_event['link'] ? raw_event['link']['global_position'] : raw_event['global_position']
       end
+
+      # @param message [String]
+      # @return [void]
+      def deprecation_warning(message)
+        PgEventstore.logger&.warn("\e[31m[DEPRECATED]: #{message}\e[0m")
+      end
+
+      # @param file_path [String]
+      # @param content [String]
+      # @return [void]
+      def write_to_file(file_path, content)
+        file = File.open(file_path, "w")
+        file.write(content)
+        file.close
+      end
+
+      # @param file_path [String]
+      # @return [void]
+      def remove_file(file_path)
+        File.delete(file_path)
+      rescue Errno::ENOENT
+      end
+
+      # @param file_path [String]
+      # @return [String, nil]
+      def read_pid(file_path)
+        file = File.open(file_path, "r")
+        file.readline.strip.tap do
+          file.close
+        end
+      rescue Errno::ENOENT
+      end
     end
   end
 end

data/lib/pg_eventstore/version.rb

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

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

@@ -3,7 +3,7 @@
     <select name="filter[events][]" class="form-control mb-2" data-placeholder="Event type" data-url="<%= url('/event_types_filtering') %>">
       <option></option>
       <% if event_type %>
-        <option value="<%= event_type %>" selected><%= event_type %></option>
+        <option value="<%= h event_type %>" selected><%= h event_type %></option>
       <% end %>
     </select>
   </div>

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

@@ -2,11 +2,11 @@
   <tr>
     <td><%= event.global_position %></td>
     <td><%= event.stream_revision %></td>
-    <td><%= event.stream.context %></td>
-    <td><%= event.stream.stream_name %></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>
-      <%= event.type %>
+      <%= h event.type %>
       <% if event.link %>
         <i class="fa fa-link"></i>
       <% end %>
@@ -19,9 +19,9 @@
   <tr class="event-payload d-none">
     <td colspan="8">
       <strong>Data:</strong>
-      <pre><%= JSON.pretty_generate(event.data) %></pre>
+      <pre><%= h JSON.pretty_generate(event.data) %></pre>
       <strong>Metadata:</strong>
-      <pre><%= JSON.pretty_generate(event.metadata) %></pre>
+      <pre><%= h JSON.pretty_generate(event.metadata) %></pre>
     </td>
   </tr>
 <% end %>

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

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

data/lib/pg_eventstore/web/views/layouts/application.erb

@@ -82,13 +82,13 @@
           <ul class="navbar-right" style="height: 29px;">
             <li class="nav-item dropdown open" style="padding-left: 15px;">
               <a href="javascript: void(0);" class="user-profile dropdown-toggle" aria-haspopup="true" id="navbarDropdown" data-toggle="dropdown" aria-expanded="false">
-                <strong>Current config:</strong> <%= current_config.inspect %>
+                <strong>Current config:</strong> <%= h current_config.inspect %>
               </a>
               <div class="dropdown-menu dropdown-usermenu pull-right" aria-labelledby="navbarDropdown">
                 <% PgEventstore.available_configs.each do |config| %>
                   <form action="<%= url('/change_config') %>" method="POST">
-                    <input type="hidden" name="config" value="<%= config %>">
-                    <button type="submit" class="dropdown-item"><%= config.inspect %></button>
+                    <input type="hidden" name="config" value="<%= h config %>">
+                    <button type="submit" class="dropdown-item"><%= h config.inspect %></button>
                   </form>
                 <% end %>
               </div>

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

@@ -24,7 +24,7 @@
       <% @set_collection.names.each do |set_name| %>
         <li class="nav-item">
           <a class="nav-link <%= "active bg-dark text-white" if @current_set == set_name %>" href="<%= subscriptions_state ? subscriptions_state_url(state: subscriptions_state, set_name: set_name) : subscriptions_url(set_name: set_name) %>">
-            <%= set_name %>
+            <%= h set_name %>
           </a>
         </li>
       <% end %>
@@ -86,7 +86,7 @@
                                 </a>
                               <% end %>
                               <% if PgEventstore::RunnerState::STATES.values_at(:running, :dead).include?(subscriptions_set.state) %>
-                                <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. 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.">
+                                <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 %>
@@ -98,7 +98,7 @@
                           <% if subscriptions_set.last_error %>
                             <tr class="collapse" id="last-set-error-<%= subscriptions_set.id %>">
                               <td colspan="9">
-                                <pre><%= JSON.pretty_generate(subscriptions_set.last_error) %></pre>
+                                <pre><%= h JSON.pretty_generate(subscriptions_set.last_error) %></pre>
                               </td>
                             </tr>
                           <% end %>
@@ -151,7 +151,7 @@
                         <% subscriptions.each do |subscription| %>
                           <tr>
                             <td><%= subscription.id %></td>
-                            <td><%= subscription.name %></td>
+                            <td><%= h subscription.name %></td>
                             <td><%= subscription.total_processed_events %></td>
                             <td>
                               <a data-toggle="collapse" href="#options-<%= subscription.id %>" aria-controls="options-<%= subscription.id %>" role="button" aria-expanded="false" class="d-inline-block text-nowrap">
@@ -209,13 +209,13 @@
                           </tr>
                           <tr class="collapse" id="options-<%= subscription.id %>">
                             <td colspan="16">
-                              <pre><%= JSON.pretty_generate(subscription.options) %></pre>
+                              <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">
-                                <pre><%= JSON.pretty_generate(subscription.last_error) %></pre>
+                                <pre><%= h JSON.pretty_generate(subscription.last_error) %></pre>
                               </td>
                             </tr>
                           <% end %>

data/lib/pg_eventstore.rb

@@ -74,13 +74,16 @@ module PgEventstore
     # @param subscription_set [String]
     # @param max_retries [Integer, nil] max number of retries of failed SubscriptionsSet
     # @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, subscription_set:, max_retries: nil, retries_interval: nil,
+                              force_lock: false)
       SubscriptionsManager.new(
         config: config(config_name),
         set_name: subscription_set,
         max_retries: max_retries,
-        retries_interval: retries_interval
+        retries_interval: retries_interval,
+        force_lock: force_lock
       )
     end
 

data/sig/pg_eventstore/callbacks.rbs

@@ -2,6 +2,8 @@ module PgEventstore
   class Callbacks
     def initialize: () -> void
 
+    def clear: -> void
+
     # _@param_ `action` — an object, that represents your action. In most cases you want to use a symbol there
     #
     # _@param_ `filter` — callback filter. Supported values are :before, :after and :around
@@ -9,6 +11,8 @@ module PgEventstore
     # _@param_ `callback`
     def define_callback: (untyped action, Symbol filter, _Callback callback) -> void
 
+    def remove_callback: (untyped action, Symbol filter, _Callback callback) -> void
+
     # _@param_ `action` — an action to run
     def run_callbacks: (untyped action, *untyped args, **untyped kwargs) ?{ () -> untyped } -> untyped
 

data/sig/pg_eventstore/cli/commands/base_command.rbs

@@ -0,0 +1,13 @@
+module PgEventstore
+  module CLI
+    module Commands
+      class BaseCommand
+        attr_reader options: PgEventstore::CLI::ParserOptions::BaseOptions
+
+        %a{rbs:test:skip} def initialize: (PgEventstore::CLI::ParserOptions::BaseOptions options) -> untyped
+
+        def call: -> Integer
+      end
+    end
+  end
+end

data/sig/pg_eventstore/cli/commands/callback_handlers/start_cmd_handlers.rbs

@@ -0,0 +1,14 @@
+module PgEventstore
+  module CLI
+    module Commands
+      module CallbackHandlers
+        class StartCmdHandlers
+          def self.handle_start_up: (Proc action, PgEventstore::SubscriptionsManager manager) -> void
+
+          def self.register_managers: (Set[PgEventstore::SubscriptionsManager] subscription_managers,
+              PgEventstore::SubscriptionsManager manager) -> void
+        end
+      end
+    end
+  end
+end

data/sig/pg_eventstore/cli/commands/help_command.rbs

@@ -0,0 +1,13 @@
+module PgEventstore
+  module CLI
+    module Commands
+      class HelpCommand
+        attr_reader options: PgEventstore::CLI::ParserOptions::BaseOptions
+
+        def initialize: (PgEventstore::CLI::ParserOptions::BaseOptions options) -> void
+
+        %a{rbs:test:skip} def call: -> Integer
+      end
+    end
+  end
+end

data/sig/pg_eventstore/cli/commands/start_subscriptions_command.rbs

@@ -0,0 +1,28 @@
+module PgEventstore
+  module CLI
+    module Commands
+      class StartSubscriptionsCommand
+        KEEP_ALIVE_INTERVAL: Integer
+
+        @running: bool
+        @subscription_managers: Set[PgEventstore::SubscriptionsManager]
+
+        def initialize: (PgEventstore::CLI::ParserOptions::BaseOptions options) -> void
+
+        %a{rbs:test:skip} def call: -> Integer
+
+        private
+
+        def attach_callbacks: -> void
+
+        def keep_process_alive: -> void
+
+        def persist_pid: -> void
+
+        def running_subscriptions?: -> bool
+
+        def setup_killsig: -> void
+      end
+    end
+  end
+end

data/sig/pg_eventstore/cli/commands/stop_subscriptions_command.rbs

@@ -0,0 +1,11 @@
+module PgEventstore
+  module CLI
+    module Commands
+      class StopSubscriptionsCommand
+        %a{rbs:test:skip} def call: -> Integer
+
+        def initialize: (PgEventstore::CLI::ParserOptions::BaseOptions options) -> void
+      end
+    end
+  end
+end

data/sig/pg_eventstore/cli/exit_codes.rbs

@@ -0,0 +1,8 @@
+module PgEventstore
+  module CLI
+    module ExitCodes
+      ERROR: Integer
+      SUCCESS: Integer
+    end
+  end
+end

data/sig/pg_eventstore/cli/parser_options/base_options.rbs

@@ -0,0 +1,15 @@
+module PgEventstore
+  module CLI
+    module ParserOptions
+      class BaseOptions
+        include PgEventstore::Extensions::OptionsExtension
+
+        def attach_parser_handlers: (OptionParser parser) -> void
+
+        def option: (Symbol option) -> PgEventstore::Extensions::OptionsExtension::Option
+
+        def to_parser_opts: (Symbol option) -> Array[String]
+      end
+    end
+  end
+end

data/sig/pg_eventstore/cli/parser_options/default_options.rbs

@@ -0,0 +1,8 @@
+module PgEventstore
+  module CLI
+    module ParserOptions
+      class DefaultOptions
+      end
+    end
+  end
+end

data/sig/pg_eventstore/cli/parser_options/metadata.rbs

@@ -0,0 +1,11 @@
+module PgEventstore
+  module CLI
+    module ParserOptions
+      class Metadata
+        include PgEventstore::Extensions::OptionsExtension
+
+        def to_parser_opts: -> Array[String]
+      end
+    end
+  end
+end

data/sig/pg_eventstore/cli/parser_options/subscription_options.rbs

@@ -0,0 +1,9 @@
+module PgEventstore
+  module CLI
+    module ParserOptions
+      class SubscriptionOptions
+        def attach_parser_handlers: (OptionParser parser) -> void
+      end
+    end
+  end
+end

data/sig/pg_eventstore/cli/parsers/base_parser.rbs

@@ -0,0 +1,18 @@
+module PgEventstore
+  module CLI
+    module Parsers
+      class BaseParser
+        @parser: OptionParser
+
+        def self.banner: -> String
+
+        attr_reader args: Array[String]
+        attr_reader options: PgEventstore::CLI::ParserOptions::BaseOptions
+
+        def initialize: (Array[String] args, PgEventstore::CLI::ParserOptions::BaseOptions options) -> void
+
+        def parse: -> [Array[String], PgEventstore::CLI::ParserOptions::BaseOptions]
+      end
+    end
+  end
+end

data/sig/pg_eventstore/cli/parsers/default_parser.rbs

@@ -0,0 +1,9 @@
+module PgEventstore
+  module CLI
+    module Parsers
+      class DefaultParser
+        def self.banner: -> String
+      end
+    end
+  end
+end

data/sig/pg_eventstore/cli/parsers/subscription_parser.rbs

@@ -0,0 +1,9 @@
+module PgEventstore
+  module CLI
+    module Parsers
+      class SubscriptionParser
+        def self.banner: -> String
+      end
+    end
+  end
+end

data/sig/pg_eventstore/cli/try_to_delete_subscriptions_set.rbs

@@ -0,0 +1,24 @@
+module PgEventstore
+  module CLI
+    class TryToDeleteSubscriptionsSet
+      def self.try_to_delete: (Symbol config_name, Integer subscriptions_set_id) -> bool
+
+      attr_reader config_name: Symbol
+      attr_reader subscriptions_set_id: Integer
+
+      def initialize: (Symbol config_name, Integer subscriptions_set_id) -> void
+
+      def try_to_delete: -> bool
+
+      private
+
+      def config: -> PgEventstore::Config
+
+      def connection: -> PgEventstore::Connection
+
+      def subscriptions_set_commands_queries: -> PgEventstore::SubscriptionsSetCommandQueries
+
+      def subscriptions_set_queries: -> PgEventstore::SubscriptionsSetQueries
+    end
+  end
+end

data/sig/pg_eventstore/cli/try_unlock_subscriptions_set.rbs

@@ -0,0 +1,7 @@
+module PgEventstore
+  module CLI
+    class TryUnlockSubscriptionsSet
+      def self.try_unlock: (Symbol config_name, Integer subscriptions_set_id) -> bool
+    end
+  end
+end

data/sig/pg_eventstore/cli/wait_for_subscriptions_set_shutdown.rbs

@@ -0,0 +1,26 @@
+module PgEventstore
+  module CLI
+    class WaitForSubscriptionsSetShutdown
+      SHUTDOWN_CHECK_INTERVAL: Float
+
+      def self.wait_for_shutdown: (Symbol config_name, Integer subscriptions_set_id) -> bool
+
+      attr_reader config_name: Symbol
+      attr_reader subscriptions_set_id: Integer
+
+      def initialize: (Symbol config_name, Integer subscriptions_set_id) -> void
+
+      def wait_for_shutdown: -> bool
+
+      private
+
+      def config: -> PgEventstore::Config
+
+      def connection: -> PgEventstore::Connection
+
+      def find_set!: -> PgEventstore::SubscriptionsSet
+
+      def subscriptions_set_queries: -> PgEventstore::SubscriptionsSetQueries
+    end
+  end
+end

data/sig/pg_eventstore/cli.rbs

@@ -0,0 +1,10 @@
+module PgEventstore
+  module CLI
+    COMMANDS: Hash[Array[String], singleton(PgEventstore::CLI::Commands::BaseCommand)]
+    OPTIONS_PARSER: Hash[String, [singleton(PgEventstore::CLI::Parsers::BaseParser), singleton(PgEventstore::CLI::ParserOptions::BaseOptions)]]
+
+    def self.callbacks: -> PgEventstore::Callbacks
+
+    def self.execute: (Array[String] args) -> void
+  end
+end

data/sig/pg_eventstore/extensions/options_extension.rbs

@@ -1,6 +1,23 @@
 module PgEventstore
   module Extensions
     module OptionsExtension
+      class Option
+        attr_reader name: Symbol
+        attr_reader metadata: untyped?
+
+        def initialize: (Symbol name, ?untyped? metadata) -> untyped
+
+        def ==: (untyped other_option) -> bool
+
+        def eql?: (untyped other_option) -> bool
+
+        def hash: () -> Integer
+      end
+
+      class Options
+        def []: (Symbol option) -> PgEventstore::Extensions::OptionsExtension::Option?
+      end
+
       def self.included: (untyped klass) -> untyped
 
       def initialize: (**untyped options) -> void
@@ -25,7 +42,7 @@ module PgEventstore
         # _@param_ `opt_name` — option name
         #
         # _@param_ `blk` — provide define value using block. It will be later evaluated in the context of your object to determine the default value of the option
-        def option: (Symbol opt_name) ?{ () -> untyped } -> Symbol
+        def option: (Symbol opt_name, ?metadata: untyped?) ?{ () -> untyped } -> Symbol
 
         def inherited: (untyped klass) -> untyped
 

data/sig/pg_eventstore/subscriptions/command_handlers/subscription_feeder_commands.rbs

@@ -1,6 +1,10 @@
 module PgEventstore
   module CommandHandlers
     class SubscriptionFeederCommands
+      @config_name: Symbol
+
+      @subscription_feeder: PgEventstore::SubscriptionFeeder
+
       # _@param_ `config_name`
       #
       # _@param_ `subscription_feeder`
@@ -11,6 +15,10 @@ module PgEventstore
       def queries: () -> PgEventstore::SubscriptionsSetCommandQueries
 
       def connection: () -> PgEventstore::Connection
+
+      private
+
+      def commands: () -> Array[PgEventstore::SubscriptionFeederCommands::Base]
     end
   end
 end