karafka-web 0.7.6 → 0.7.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32657edc369df2240e6788c6972d0c83073263ad3e2cc416ff4d24bde1677f18
-  data.tar.gz: d013c25e74a87d1820f60912805888c42c8432a24e1ed33674276f8647328585
+  metadata.gz: 1e4dd8f19fdad3697e837ed96aa8fafabae6eac4efe8cbf75aaa788eccebc44c
+  data.tar.gz: 33814043050afda80109fc14082a09de0f5499041fe2f4a24a90b25f7cd501c8
 SHA512:
-  metadata.gz: 148e9fbe63c0029b1181aece3569f2822e108240b94c78e960b7e24a2921553dc64cd5c3d59f95fe555df2265bfd216fac97ba8906dbae2cb8c8611a66963400
-  data.tar.gz: c015c0c8cc8d15351c2620e3a4a87ee10a986277bf1f3e50fc0c7d2e9d66f839d596bf94273b067eac7fb2f1f231453ac91119ec125cea90fb8bd6eff8943333
+  metadata.gz: 8c84de9a33977904aadffa3ff51af275f4301e7375f9194343b4980d82b6b4fdf4dc57aeb0f1e0cef8c66499b048fb595ec4cf7d1bdbd3011995a0223c4a70ad
+  data.tar.gz: 4c82722b6fab042562ee3f390d10775b1de7e0c77406c623e7e17f36860a9954ef132cbc540d30449c1212a9d507203e8fb9500393c92b2be09ccbc06c281f0d

data/.github/workflows/ci.yml

@@ -68,7 +68,7 @@ jobs:
     strategy:
       fail-fast: false
     steps:
-      - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
@@ -89,7 +89,7 @@ jobs:
     strategy:
       fail-fast: false
     steps:
-      - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Run Coditsu

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Karafka Web changelog
 
+## 0.7.7 (2023-10-20)
+- [Fix] Remove `thor` as a CLI engine due to breaking changes.
+
 ## 0.7.6 (2023-10-10)
 - [Fix] Fix nested SASL/SAML data visible in the routing details (#173)
 

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    karafka-web (0.7.6)
+    karafka-web (0.7.7)
       erubi (~> 1.4)
-      karafka (>= 2.2.6, < 3.0.0)
+      karafka (>= 2.2.8.beta1, < 3.0.0)
       karafka-core (>= 2.2.2, < 3.0.0)
       roda (~> 3.68, >= 3.69)
       tilt (~> 2.0)
@@ -11,35 +11,45 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.8)
+    activesupport (7.1.1)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
+    base64 (0.1.1)
+    bigdecimal (3.1.4)
     byebug (11.1.3)
     concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
     diff-lcs (1.5.0)
     docile (1.4.0)
+    drb (2.1.1)
+      ruby2_keywords
     erubi (1.12.0)
     factory_bot (6.3.0)
       activesupport (>= 5.0.0)
-    ffi (1.15.5)
+    ffi (1.16.3)
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    karafka (2.2.6)
+    karafka (2.2.8.beta1)
       karafka-core (>= 2.2.2, < 2.3.0)
-      thor (>= 0.20)
       waterdrop (>= 2.6.6, < 3.0.0)
       zeitwerk (~> 2.3)
-    karafka-core (2.2.2)
+    karafka-core (2.2.3)
       concurrent-ruby (>= 1.1)
-      karafka-rdkafka (>= 0.13.1, < 0.14.0)
-    karafka-rdkafka (0.13.4)
+      karafka-rdkafka (>= 0.13.6, < 0.14.0)
+    karafka-rdkafka (0.13.6)
       ffi (~> 1.15)
       mini_portile2 (~> 2.6)
       rake (> 12)
     mini_portile2 (2.8.4)
     minitest (5.20.0)
+    mutex_m (0.1.2)
     rack (3.0.8)
     rack-test (2.1.0)
       rack (>= 1.3)
@@ -47,7 +57,7 @@ GEM
       rack (>= 3.0.0.beta1)
       webrick
     rake (13.0.6)
-    roda (3.71.0)
+    roda (3.73.0)
       rack
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -62,21 +72,21 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.1)
+    ruby2_keywords (0.0.5)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    thor (1.2.2)
-    tilt (2.2.0)
+    tilt (2.3.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     waterdrop (2.6.7)
       karafka-core (>= 2.1.1, < 3.0.0)
       zeitwerk (~> 2.3)
     webrick (1.8.1)
-    zeitwerk (2.6.11)
+    zeitwerk (2.6.12)
 
 PLATFORMS
   x86_64-linux

data/README.md

@@ -8,6 +8,9 @@ Karafka Web UI is a user interface for the [Karafka framework](https://github.co
 
 It allows for easy access to various metrics, such as the number of messages consumed, the number of errors, and the number of consumers operating. It also provides a way to view the different Kafka topics, consumers, and groups that are being used by the application.
 
+> [!IMPORTANT]
+> All of Karafka ecosystems components documentation, including the Web UI, can be found [here](https://karafka.io/docs/#web-ui).
+
 ## Getting started
 
 Karafka Web UI documentation is part of the Karafka framework documentation and can be found [here](https://karafka.io/docs).

data/bin/karafka-web

@@ -3,6 +3,7 @@
 require 'karafka'
 require 'karafka/web'
 
-::Karafka::Cli::Base.load
+ENV['KARAFKA_CLI'] = 'true'
 
+::Karafka::Cli::Base.load
 ::Karafka::Web::Cli.start

data/docker-compose.yml

@@ -21,3 +21,5 @@ services:
       KAFKA_CONTROLLER_QUORUM_VOTERS: 1@127.0.0.1:9093
       ALLOW_PLAINTEXT_LISTENER: 'yes'
       KAFKA_AUTO_CREATE_TOPICS_ENABLE: 'true'
+      KAFKA_TRANSACTION_STATE_LOG_REPLICATION_FACTOR: 1
+      KAFKA_TRANSACTION_STATE_LOG_MIN_ISR: 1

data/karafka-web.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.licenses    = %w[LGPL-3.0 Commercial]
 
   spec.add_dependency 'erubi', '~> 1.4'
-  spec.add_dependency 'karafka', '>= 2.2.6', '< 3.0.0'
+  spec.add_dependency 'karafka', '>= 2.2.8.beta1', '< 3.0.0'
   spec.add_dependency 'karafka-core', '>= 2.2.2', '< 3.0.0'
   spec.add_dependency 'roda', '~> 3.68', '>= 3.69'
   spec.add_dependency 'tilt', '~> 2.0'
@@ -36,7 +36,7 @@ Gem::Specification.new do |spec|
   spec.metadata = {
     'funding_uri' => 'https://karafka.io/#become-pro',
     'homepage_uri' => 'https://karafka.io',
-    'changelog_uri' => 'https://github.com/karafka/karafka-web/blob/master/CHANGELOG.md',
+    'changelog_uri' => 'https://karafka.io/docs/Changelog-Karafka-Web-UI',
     'bug_tracker_uri' => 'https://github.com/karafka/karafka-web/issues',
     'source_code_uri' => 'https://github.com/karafka/karafka-web',
     'documentation_uri' => 'https://karafka.io/docs',

data/lib/karafka/web/cli/base.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Web
+    class Cli
+      # Base command for all the Web Cli commands
+      class Base < Karafka::Cli::Base
+        include ::Karafka::Helpers::Colorize
+
+        class << self
+          # @return [Array<Class>] available commands
+          def commands
+            ObjectSpace
+              .each_object(Class)
+              .select { |klass| klass.superclass == Karafka::Web::Cli::Base }
+              .reject { |klass| klass.to_s.end_with?('::Base') }
+              .sort_by(&:name)
+          end
+        end
+
+        private
+
+        # Takes the CLI user provided replication factor but if not present, uses the brokers count
+        # to decide. For non-dev clusters (with one broker) we usually want to have replication of
+        # two, just to have some redundancy.
+        # @param cli_replication_factor [Integer, false] user requested replication factor or false
+        #   if we are supposed to compute the factor automatically
+        # @return [Integer] replication factor for Karafka Web UI topics
+        def compute_replication_factor(cli_replication_factor)
+          cli_replication_factor || (Ui::Models::ClusterInfo.fetch.brokers.size > 1 ? 2 : 1)
+        end
+      end
+    end
+  end
+end

data/lib/karafka/web/cli/help.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Web
+    class Cli
+      # Displays help
+      class Help < Base
+        desc 'Describes available commands'
+
+        # Print available commands
+        def call
+          # Find the longest command for alignment purposes
+          max_command_length = self.class.commands.map(&:name).map(&:size).max
+
+          puts 'Karafka Web UI commands:'
+
+          # Print each command formatted with its description
+          self.class.commands.each do |command|
+            puts "  #{command.name.ljust(max_command_length)}    # #{command.desc}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/karafka/web/cli/install.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Web
+    class Cli
+      # Installs Web UI
+      class Install < Base
+        desc 'Installs the Web UI'
+
+        option(
+          :replication_factor,
+          'Replication factor for created topics',
+          Integer,
+          ['--replication_factor [FACTOR]']
+        )
+
+        # Installs Karafka Web. Creates all needed topics, populates the data and adds the needed
+        # code to `karafka.rb`.
+        def call
+          Karafka::Web::Installer.new.install(
+            replication_factor: compute_replication_factor(options[:replication_factor])
+          )
+        end
+      end
+    end
+  end
+end

data/lib/karafka/web/cli/migrate.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Web
+    class Cli
+      # Migrates the Web UI topics and states if needed
+      class Migrate < Base
+        desc 'Runs necessary migrations of Web UI topics and states'
+
+        option(
+          :replication_factor,
+          'Replication factor for created topics',
+          Integer,
+          ['--replication_factor [FACTOR]']
+        )
+
+        # Creates new topics (if any) and populates missing data.
+        # It does **not** remove topics and will not populate data if it is already there.
+        #
+        # Useful in two scenarios:
+        #   1. When setting up Web-UI in a new environment, so the Web-UI has the proper initial
+        #      state.
+        #   2. When upgrading Web-UI in-between versions that would require extra topics and/or
+        #      extra states populated.
+        def call
+          Karafka::Web::Installer.new.migrate(
+            replication_factor: compute_replication_factor(options[:replication_factor])
+          )
+        end
+      end
+    end
+  end
+end

data/lib/karafka/web/cli/reset.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Web
+    class Cli
+      # Resets the Web UI
+      class Reset < Base
+        desc 'Resets the Web UI by removing all the Web topics and creating them again'
+
+        option(
+          :replication_factor,
+          'Replication factor for created topics',
+          Integer,
+          ['--replication_factor [FACTOR]']
+        )
+
+        # Resets Karafka Web. Removes the topics, creates them again and populates the initial
+        # state again. This is useful in case the Web-UI metrics or anything else got corrupted.
+        def call
+          Karafka::Web::Installer.new.reset(
+            replication_factor: compute_replication_factor(options[:replication_factor])
+          )
+        end
+      end
+    end
+  end
+end

data/lib/karafka/web/cli/uninstall.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Web
+    class Cli
+      # Uninstalls the Web UI
+      class Uninstall < Base
+        desc 'Removes all the Web UI topics and the enabled code'
+
+        # Uninstalls Karafka Web
+        def call
+          Karafka::Web::Installer.new.uninstall
+        end
+      end
+    end
+  end
+end

data/lib/karafka/web/cli.rb

@@ -2,82 +2,15 @@
 
 module Karafka
   module Web
-    # Karafka itself depends on Thor, so we can use it
-    class Cli < Thor
-      include ::Karafka::Helpers::Colorize
-
-      package_name 'Karafka Web'
-
-      desc 'install', 'Installs the Web UI'
-      method_option(
-        :replication_factor,
-        desc: 'Replication factor for created topics',
-        default: false,
-        check_default_type: false,
-        type: :numeric
-      )
-      # Installs Karafka Web. Creates all needed topics, populates the data and adds the needed
-      # code to `karafka.rb`.
-      def install
-        Karafka::Web::Installer.new.install(
-          replication_factor: compute_replication_factor(options[:replication_factor])
-        )
-      end
-
-      desc 'migrate', 'Creates necessary topics if not present and populates state data'
-      method_option(
-        :replication_factor,
-        desc: 'Replication factor for created topics',
-        default: false,
-        check_default_type: false,
-        type: :numeric
-      )
-      # Creates new topics (if any) and populates missing data.
-      # It does **not** remove topics and will not populate data if it is already there.
-      #
-      # Useful in two scenarios:
-      #   1. When setting up Web-UI in a new environment, so the Web-UI has the proper initial
-      #      state.
-      #   2. When upgrading Web-UI in-between versions that would require extra topics and/or extra
-      #      states populated.
-      def migrate
-        Karafka::Web::Installer.new.migrate(
-          replication_factor: compute_replication_factor(options[:replication_factor])
-        )
-      end
-
-      desc 'reset', 'Resets the Web UI by removing all the Web topics and creating them again'
-      method_option(
-        :replication_factor,
-        desc: 'Replication factor for created topics',
-        default: false,
-        check_default_type: false,
-        type: :numeric
-      )
-      # Resets Karafka Web. Removes the topics, creates them again and populates the initial state
-      # again. This is useful in case the Web-UI metrics or anything else got corrupted.
-      def reset
-        Karafka::Web::Installer.new.reset(
-          replication_factor: compute_replication_factor(options[:replication_factor])
-        )
-      end
-
-      desc 'uninstall', 'Removes all the Web UI topics and the enabled code'
-      # Uninstalls Karafka Web
-      def uninstall
-        Karafka::Web::Installer.new.uninstall
-      end
-
-      private
-
-      # Takes the CLI user provided replication factor but if not present, uses the brokers count
-      # to decide. For non-dev clusters (with one broker) we usually want to have replication of
-      # two, just to have some redundancy.
-      # @param cli_replication_factor [Integer, false] user requested replication factor or false
-      #   if we are supposed to compute the factor automatically
-      # @return [Integer] replication factor for Karafka Web UI topics
-      def compute_replication_factor(cli_replication_factor)
-        cli_replication_factor || Ui::Models::ClusterInfo.fetch.brokers.size > 1 ? 2 : 1
+    # Web CLI
+    class Cli < Karafka::Cli
+      class << self
+        private
+
+        # @return [Array<Class>] command classes
+        def commands
+          Base.commands
+        end
       end
     end
   end

data/lib/karafka/web/version.rb

@@ -3,6 +3,6 @@
 module Karafka
   module Web
     # Current gem version
-    VERSION = '0.7.6'
+    VERSION = '0.7.7'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karafka-web
 version: !ruby/object:Gem::Version
-  version: 0.7.6
+  version: 0.7.7
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -35,7 +35,7 @@ cert_chain:
   AnG1dJU+yL2BK7vaVytLTstJME5mepSZ46qqIJXMuWob/YPDmVaBF39TDSG9e34s
   msG3BiCqgOgHAnL23+CN3Rt8MsuRfEtoTKpJVcCfoEoNHOkc
   -----END CERTIFICATE-----
-date: 2023-10-10 00:00:00.000000000 Z
+date: 2023-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubi
@@ -57,7 +57,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.6
+        version: 2.2.8.beta1
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
@@ -67,7 +67,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.6
+        version: 2.2.8.beta1
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
@@ -173,6 +173,12 @@ files:
 - lib/karafka/web.rb
 - lib/karafka/web/app.rb
 - lib/karafka/web/cli.rb
+- lib/karafka/web/cli/base.rb
+- lib/karafka/web/cli/help.rb
+- lib/karafka/web/cli/install.rb
+- lib/karafka/web/cli/migrate.rb
+- lib/karafka/web/cli/reset.rb
+- lib/karafka/web/cli/uninstall.rb
 - lib/karafka/web/config.rb
 - lib/karafka/web/contracts/base.rb
 - lib/karafka/web/contracts/config.rb
@@ -447,7 +453,7 @@ licenses:
 metadata:
   funding_uri: https://karafka.io/#become-pro
   homepage_uri: https://karafka.io
-  changelog_uri: https://github.com/karafka/karafka-web/blob/master/CHANGELOG.md
+  changelog_uri: https://karafka.io/docs/Changelog-Karafka-Web-UI
   bug_tracker_uri: https://github.com/karafka/karafka-web/issues
   source_code_uri: https://github.com/karafka/karafka-web
   documentation_uri: https://karafka.io/docs