karafka-web 0.10.3 → 0.11.0.beta1

data/lib/karafka/web/pro/commanding/handlers/partitions/tracker.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
+# See LICENSE for details.
+
+module Karafka
+  module Web
+    module Pro
+      module Commanding
+        module Handlers
+          module Partitions
+            # Tracker used to record incoming partition related operational requests until they are
+            # executable or invalid. It stores the requests as they come for execution pre-polling.
+            class Tracker
+              include Singleton
+
+              # Empty array for internal usage
+              EMPTY_ARRAY = [].freeze
+
+              private_constant :EMPTY_ARRAY
+
+              def initialize
+                @mutex = Mutex.new
+                @requests = Hash.new { |h, k| h[k] = [] }
+              end
+
+              # Adds the given command into the tracker so it can be retrieved when needed.
+              #
+              # @param command [Request] command we want to schedule
+              # @note We accumulate requests per subscription group because this is the layer of
+              #   applicability of those even for partition related requests.
+              def <<(command)
+                @mutex.synchronize do
+                  @requests[command[:subscription_group_id]] << command
+                end
+              end
+
+              # Selects all incoming command requests for given subscription group and iterates
+              # over them. It removes selected requests during iteration.
+              #
+              # @param subscription_group_id [String] id of the subscription group for which we
+              #   want to get all the requests. Subscription groups ids (not names) are unique
+              #   within the application, so it is unique "enough".
+              # @param block [Proc]
+              #
+              # @yieldparam [Request] given command request for the requested subscription group
+              def each_for(subscription_group_id, &block)
+                requests = nil
+
+                @mutex.synchronize do
+                  requests = @requests.delete(subscription_group_id)
+                end
+
+                (requests || EMPTY_ARRAY).each(&block)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/karafka/web/pro/commanding/listener.rb

@@ -1,15 +1,7 @@
 # frozen_string_literal: true
 
-# This Karafka component is a Pro component under a commercial license.
-# This Karafka component is NOT licensed under LGPL.
-#
-# All of the commercial components are present in the lib/karafka/pro directory of this
-# repository and their usage requires commercial license agreement.
-#
-# Karafka has also commercial-friendly license, commercial support and commercial components.
-#
-# By sending a pull request to the pro components, you are agreeing to transfer the copyright of
-# your code to Maciej Mensfeld.
+# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
+# See LICENSE for details.
 
 module Karafka
   module Web
@@ -34,7 +26,7 @@ module Karafka
             t_config = Karafka::Web.config.topics
 
             iterator = Karafka::Pro::Iterator.new(
-              { t_config.consumers.commands => true },
+              { t_config.consumers.commands.name => true },
               settings: c_config.kafka,
               yield_nil: true,
               max_wait_time: c_config.max_wait_time
@@ -87,7 +79,7 @@ module Karafka
               'error.occurred',
               error: error,
               caller: self,
-              type: 'web.controlling.controller.error'
+              type: 'web.commanding.listener.error'
             )
           end
         end

data/lib/karafka/web/pro/commanding/manager.rb

@@ -1,15 +1,7 @@
 # frozen_string_literal: true
 
-# This Karafka component is a Pro component under a commercial license.
-# This Karafka component is NOT licensed under LGPL.
-#
-# All of the commercial components are present in the lib/karafka/pro directory of this
-# repository and their usage requires commercial license agreement.
-#
-# Karafka has also commercial-friendly license, commercial support and commercial components.
-#
-# By sending a pull request to the pro components, you are agreeing to transfer the copyright of
-# your code to Maciej Mensfeld.
+# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
+# See LICENSE for details.
 
 module Karafka
   module Web
@@ -70,26 +62,46 @@ module Karafka
             @listener.each do |message|
               next unless @matcher.matches?(message)
 
-              control(message.payload[:command][:name])
+              control(
+                Request.new(message.payload[:command])
+              )
             end
+          # This should not happen, if this is happening, please report this as a bug
+          rescue StandardError => e
+            ::Karafka.monitor.instrument(
+              'error.occurred',
+              error: e,
+              caller: self,
+              type: 'web.commanding.manager.error'
+            )
+
+            raise e
           end
 
           # Runs the expected command
           #
-          # @param command [String] command expected to run
+          # @param command [Request] command request
           def control(command)
-            case command
-            when 'trace'
-              Commands::Trace.new.call
-            when 'stop'
-              Commands::Stop.new.call
-            when 'quiet'
-              Commands::Quiet.new.call
-            else
-              # We raise it and will be rescued, reported and ignored. We raise it as this should
-              # not happen unless there are version conflicts
-              raise ::Karafka::Errors::UnsupportedCaseError, command
-            end
+            action = case command.name
+                     when Commands::Consumers::Trace.name
+                       Commands::Consumers::Trace
+                     when Commands::Consumers::Stop.name
+                       Commands::Consumers::Stop
+                     when Commands::Consumers::Quiet.name
+                       Commands::Consumers::Quiet
+                     when Commands::Partitions::Seek.name
+                       Commands::Partitions::Seek
+                     when Commands::Partitions::Resume.name
+                       Commands::Partitions::Resume
+                     when Commands::Partitions::Pause.name
+                       Commands::Partitions::Pause
+                     else
+                       # We raise it and will be rescued, reported and ignored. We raise it as
+                       # this should not happen unless there are version conflicts
+                       raise ::Karafka::Errors::UnsupportedCaseError, command.name
+                     end
+
+            action.new(command).call
           end
         end
       end

data/lib/karafka/web/pro/commanding/matcher.rb

@@ -1,15 +1,7 @@
 # frozen_string_literal: true
 
-# This Karafka component is a Pro component under a commercial license.
-# This Karafka component is NOT licensed under LGPL.
-#
-# All of the commercial components are present in the lib/karafka/pro directory of this
-# repository and their usage requires commercial license agreement.
-#
-# Karafka has also commercial-friendly license, commercial support and commercial components.
-#
-# By sending a pull request to the pro components, you are agreeing to transfer the copyright of
-# your code to Maciej Mensfeld.
+# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
+# See LICENSE for details.
 
 module Karafka
   module Web
@@ -24,17 +16,15 @@ module Karafka
           # @param message [Karafka::Messages::Message] message with command
           # @return [Boolean] is this message dedicated to current process and is actionable
           def matches?(message)
-            matches = true
-
+            # We operate only on commands. Result and other messages should be ignored
+            return false unless message.headers['type'] == 'request'
             # We want to work only with commands that target all processes or our current
-            matches = false unless message.key == '*' || message.key == process_id
-            # We operate only on commands. Result messages should be ignored
-            matches = false unless message.payload[:type] == 'command'
+            return false unless message.key == '*' || message.key == process_id
             # Ignore messages that have different schema. This can happen in the middle of
             # upgrades of the framework. We ignore this not to risk compatibility issues
-            matches = false unless message.payload[:schema_version] == Dispatcher::SCHEMA_VERSION
+            return false unless message.payload[:schema_version] == Dispatcher::SCHEMA_VERSION
 
-            matches
+            true
           end
 
           private

data/lib/karafka/web/pro/commanding/request.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
+# See LICENSE for details.
+
+module Karafka
+  module Web
+    module Pro
+      module Commanding
+        # Encapsulates the command request details not to use a raw hash
+        class Request
+          # @param details [Hash] raw request details
+          def initialize(details)
+            @details = details
+          end
+
+          # @return [String] name of the request
+          def name
+            self[:name]
+          end
+
+          # Fetches the underlying details value and raises key error when not available
+          #
+          # @param key [Symbol]
+          # @return [Object]
+          # @raise [KeyError]
+          def [](key)
+            @details.fetch(key)
+          end
+
+          # @return [Hash] raw details
+          def to_h
+            @details
+          end
+        end
+      end
+    end
+  end
+end

data/lib/karafka/web/pro/commanding.rb

@@ -1,15 +1,7 @@
 # frozen_string_literal: true
 
-# This Karafka component is a Pro component under a commercial license.
-# This Karafka component is NOT licensed under LGPL.
-#
-# All of the commercial components are present in the lib/karafka/pro directory of this
-# repository and their usage requires commercial license agreement.
-#
-# Karafka has also commercial-friendly license, commercial support and commercial components.
-#
-# By sending a pull request to the pro components, you are agreeing to transfer the copyright of
-# your code to Maciej Mensfeld.
+# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
+# See LICENSE for details.
 
 module Karafka
   module Web

data/lib/karafka/web/pro/loader.rb

@@ -1,15 +1,7 @@
 # frozen_string_literal: true
 
-# This Karafka component is a Pro component under a commercial license.
-# This Karafka component is NOT licensed under LGPL.
-#
-# All of the commercial components are present in the lib/karafka/pro directory of this
-# repository and their usage requires commercial license agreement.
-#
-# Karafka has also commercial-friendly license, commercial support and commercial components.
-#
-# By sending a pull request to the pro components, you are agreeing to transfer the copyright of
-# your code to Maciej Mensfeld.
+# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
+# See LICENSE for details.
 
 module Karafka
   module Web
@@ -17,6 +9,25 @@ module Karafka
       # Loader requires and loads all the pro components only when they are needed
       class Loader
         class << self
+          # This loads the pro components into memory in case someone required karafka-web prior
+          # to the license usage. This can happen for users with complex require flows, where
+          # Karafka license is not part of the standard flow
+          #
+          # In such cases Web may not notice that Karafka should operate in a Pro mode when it is
+          # being required via Zeitwerk. In such cases we load Pro components prior to the setup.
+          def load_on_late_setup
+            return if defined?(Karafka::Web::Pro::Commanding)
+
+            loader = Zeitwerk::Loader.new
+            loader.push_dir(
+              File.join(Karafka::Web.gem_root, 'lib/karafka/web/pro'),
+              namespace: Karafka::Web::Pro
+            )
+
+            loader.setup
+            loader.eager_load
+          end
+
           # Loads all the Web UI pro components and configures them wherever it is expected
           # @param config [Karafka::Core::Configurable::Node] web config that we can alter with pro
           #   components
@@ -31,6 +42,13 @@ module Karafka
               setting(:branding, default: Ui::Lib::Branding::Config.config)
               setting(:policies, default: Ui::Lib::Policies::Config.config)
               setting(:search, default: Ui::Lib::Search::Config.config)
+
+              setting :topics do
+                setting :management do
+                  # Should we allow users to manage topics (edit config, resize, etc) from the UI
+                  setting(:active, default: true)
+                end
+              end
             end
           end
 
@@ -42,6 +60,10 @@ module Karafka
             Ui::Lib::Branding.post_setup(config)
             Ui::Lib::Policies.post_setup(config)
             Ui::Lib::Search.post_setup(config)
+
+            config.commanding.listeners.each do |listener|
+              ::Karafka::App.monitor.subscribe(listener)
+            end
           end
         end
       end