karafka-web 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ffbcae8c8e094bdd72518fa41694bb9b6b658c713010ca09ff9f3ca8f857666
-  data.tar.gz: 4e9d38e683197bb003afb3732e333a19d603e2b8fd3e8ff4fa7b8d0d1cc5f3c3
+  metadata.gz: 3a70fc5cb35d0e6e60a348e3efe91113b54d0c62310b7c3af4e7584aa70cfb70
+  data.tar.gz: 43a96b7e7a4622721dbc6ba144852335aecbfe907049bc47ab563ea07f40eb54
 SHA512:
-  metadata.gz: ba7f91646a8062b56380afe9ccde45802c18c12d5a7581fce4b99db24480b730aa0f9743af825dd24006725424887f63cf5a2dbf17d32c541d7a4df83f823c34
-  data.tar.gz: 19084a9683d9d8023fbef859a428d418a375c2b44d588ad9d065de6e2a89f913cc505258836f717c2e5a095e3a0d76b15d0d2d6c23df95682d41e042ec1d16f8
+  metadata.gz: db0b153569ca93f1164a851216e0f224acc56e6a7533a35a86a44f6f2f8bffc1630e5ccf7c2e53a14455206401c45b59b1728eb266c59360be8f952794d3011b
+  data.tar.gz: 794c77edb27f7f9a397c3de891b146f9020653b84bad46e1f1b537a1d547ffc793211e7bd5ffb0f426c0b8fa9b6359230bb3fe3ee8fa5ec668cb0e1d39782d5a

data/CHANGELOG.md

@@ -1,8 +1,15 @@
 # Karafka Web changelog
 
+## 0.1.3 (2023-02-14)
+- Skip topics creation if web topics already exist (do not raise error)
+- Support ability to provide replication factor in the install command
+- Provide ability to reset the state with a `reset` command. It will remove and re-create the topics.
+- Provide ability to uninstall the web via the CLI `uninstall` command
+- Remove the `Karafka::Web.bootstrap!` method as the install should happen via `bundle exec karafka-web install`
+
 ## 0.1.2 (2023-02-10)
 - Provide more comprehensive info when lag stored and stored offset are not available.
-- Setup rspec scaffold
+- Setup rspec scaffold.
 
 ## 0.1.1 (2023-01-30)
 - Rename `Karafka::Web.bootstrap_topics!` to `Karafka::Web.bootstrap!` and expand it with the zero state injection.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    karafka-web (0.1.2)
+    karafka-web (0.1.3)
       erubi (~> 1.4)
       karafka (>= 2.0.29, < 3.0.0)
       karafka-core (>= 2.0.10, < 3.0.0)

data/bin/karafka-web

@@ -4,30 +4,5 @@ require 'karafka'
 require 'karafka/web'
 
 ::Karafka::Cli::Base.load
-include ::Karafka::Helpers::Colorize
 
-case ARGV[0]
-when 'install'
-  puts
-  puts 'Installing Karafka Web UI...'
-  puts
-  puts 'Creating necessary topics and populating state data...'
-  Karafka::Web.bootstrap!
-  puts 'Updating the Karafka boot file...'
-
-  enabler = 'Karafka::Web.enable!'
-
-  if File.read(Karafka.boot_file).include?(enabler)
-    puts "Web UI #{green('already')} installed."
-  else
-    File.open(Karafka.boot_file, 'a') do |f|
-      f << "\n#{enabler}\n"
-    end
-  end
-
-  puts
-  puts("Installation #{green('completed')}. Have fun!")
-  puts
-else
-  raise NotImplementedError, "#{ARGV[0]} is not supported"
-end
+::Karafka::Web::Cli.start

data/lib/karafka/web/cli.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Web
+    # Karafka itself depends on Thor, so we can use it
+    class Cli < Thor
+      include ::Karafka::Helpers::Colorize
+
+      # Code that is needed in the `karafka.rb` to connect Web UI to Karafka
+      ENABLER_CODE = 'Karafka::Web.enable!'
+
+      private_constant :ENABLER_CODE
+
+      package_name 'Karafka Web'
+
+      desc 'install', 'Installs the Web UI'
+      method_option(
+        :replication_factor,
+        desc: 'Replication factor for created topics',
+        default: 1,
+        type: :numeric
+      )
+      # Installs Karafka Web
+      def install
+        puts
+        puts 'Installing Karafka Web UI...'
+        puts
+        puts 'Creating necessary topics and populating state data...'
+
+        Karafka::Web::Installer.new.bootstrap!(replication_factor: options[:replication_factor])
+
+        puts 'Updating the Karafka boot file...'
+
+        if File.read(Karafka.boot_file).include?(ENABLER_CODE)
+          puts "Web UI #{green('already')} installed."
+        else
+          File.open(Karafka.boot_file, 'a') do |f|
+            f << "\n#{ENABLER_CODE}\n"
+          end
+        end
+
+        puts
+        puts("Installation #{green('completed')}. Have fun!")
+        puts
+      end
+
+      desc 'reset', 'Resets the Web UI by removing all the Web topics and creating them again'
+      # Resets Karafka Web
+      def reset
+        puts
+        puts 'Resetting Karafka Web UI...'
+        Karafka::Web::Installer.new.reset!
+        puts
+        puts("Resetting #{green('completed')}. Have fun!")
+        puts
+      end
+
+      desc 'uninstall', 'Removes all the Web UI topics and the enabled code'
+      # Uninstalls Karafka Web
+      def uninstall
+        puts
+        puts 'Uninstalling Karafka Web UI...'
+        Karafka::Web::Installer.new.uninstall!
+
+        puts 'Updating the Karafka boot file...'
+
+        karafka_rb = File.readlines(Karafka.boot_file)
+        if karafka_rb.any? { |line| line.include?(ENABLER_CODE) }
+          karafka_rb.delete_if { |line| line.include?(ENABLER_CODE) }
+
+          File.write(Karafka.boot_file, karafka_rb.join)
+        end
+
+        puts
+        puts("Uninstalling #{green('completed')}. Goodbye!")
+        puts
+      end
+    end
+  end
+end

data/lib/karafka/web/installer.rb

@@ -13,6 +13,30 @@ module Karafka
         bootstrap_state!
       end
 
+      # Removes all the Karafka topics and creates them again with the same replication factor
+      def reset!
+        states_topic = ::Karafka::Web.config.topics.consumers.states
+        replication_factor = ::Karafka::Admin
+                             .cluster_info
+                             .topics
+                             .find { |topic| topic[:topic_name] == states_topic }
+                             .fetch(:partitions)
+                             .first
+                             .fetch(:replica_count)
+
+        uninstall!
+        bootstrap!(replication_factor: replication_factor)
+      end
+
+      # Removes all the Karafka Web topics
+      def uninstall!
+        [
+          ::Karafka::Web.config.topics.consumers.states,
+          ::Karafka::Web.config.topics.consumers.reports,
+          ::Karafka::Web.config.topics.errors
+        ].each { |topic_name| ::Karafka::Admin.delete_topic(topic_name) }
+      end
+
       # Adds the extra needed consumer group, topics and routes for Web UI to be able to operate
       def enable!
         ::Karafka::App.routes.draw do
@@ -61,36 +85,49 @@ module Karafka
       #
       # @param replication_factor [Integer]
       def bootstrap_topics!(replication_factor = 1)
-        # This topic needs to have one partition
-        ::Karafka::Admin.create_topic(
-          ::Karafka::Web.config.topics.consumers.states,
-          1,
-          replication_factor,
-          # We care only about the most recent state, previous are irrelevant
-          { 'cleanup.policy': 'compact' }
-        )
+        existing_topics = ::Karafka::Admin.cluster_info.topics.map { |topic| topic[:topic_name] }
 
-        # This topic needs to have one partition
-        ::Karafka::Admin.create_topic(
-          ::Karafka::Web.config.topics.consumers.reports,
-          1,
-          replication_factor,
-          # We do not need to to store this data for longer than 7 days as this data is only used
-          # to materialize the end states
-          # On the other hand we do not want to have it really short-living because in case of a
-          # consumer crash, we may want to use this info to catch up and backfill the state
-          { 'retention.ms': 7 * 24 * 60 * 60 * 1_000 }
-        )
+        consumers_states_topic = ::Karafka::Web.config.topics.consumers.states
+        consumers_reports_topic = ::Karafka::Web.config.topics.consumers.reports
+        errors_topic = ::Karafka::Web.config.topics.errors
 
-        # All the errors will be dispatched here
-        # This topic can have multiple partitions but we go with one by default. A single Ruby
-        # process should not crash that often and if there is an expectation of a higher volume
-        # of errors, this can be changed by the end user
-        ::Karafka::Admin.create_topic(
-          ::Karafka::Web.config.topics.errors,
-          1,
-          replication_factor
-        )
+        # Create only if needed
+        unless existing_topics.include?(consumers_states_topic)
+          # This topic needs to have one partition
+          ::Karafka::Admin.create_topic(
+            consumers_states_topic,
+            1,
+            replication_factor,
+            # We care only about the most recent state, previous are irrelevant
+            { 'cleanup.policy': 'compact' }
+          )
+        end
+
+        unless existing_topics.include?(consumers_reports_topic)
+          # This topic needs to have one partition
+          ::Karafka::Admin.create_topic(
+            consumers_reports_topic,
+            1,
+            replication_factor,
+            # We do not need to to store this data for longer than 7 days as this data is only used
+            # to materialize the end states
+            # On the other hand we do not want to have it really short-living because in case of a
+            # consumer crash, we may want to use this info to catch up and backfill the state
+            { 'retention.ms': 7 * 24 * 60 * 60 * 1_000 }
+          )
+        end
+
+        unless existing_topics.include?(errors_topic)
+          # All the errors will be dispatched here
+          # This topic can have multiple partitions but we go with one by default. A single Ruby
+          # process should not crash that often and if there is an expectation of a higher volume
+          # of errors, this can be changed by the end user
+          ::Karafka::Admin.create_topic(
+            errors_topic,
+            1,
+            replication_factor
+          )
+        end
 
         bootstrap_state!
       end

data/lib/karafka/web/version.rb

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

data/lib/karafka/web.rb

@@ -27,12 +27,6 @@ module Karafka
         Config.config
       end
 
-      # Creates all the needed topics for the admin UI to work and populates initial (empty) set
-      # of data, so the UI will work even when no Karafka servers are started
-      def bootstrap!
-        Installer.new.bootstrap!
-      end
-
       # Activates all the needed routing and sets up listener, etc
       # This needs to run **after** the optional configuration of the web component
       def enable!

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karafka-web
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -35,7 +35,7 @@ cert_chain:
   Qf04B9ceLUaC4fPVEz10FyobjaFoY4i32xRto3XnrzeAgfEe4swLq8bQsR3w/EF3
   MGU0FeSV2Yj7Xc2x/7BzLK8xQn5l7Yy75iPF+KP3vVmDHnNl
   -----END CERTIFICATE-----
-date: 2023-02-10 00:00:00.000000000 Z
+date: 2023-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubi
@@ -163,6 +163,7 @@ files:
 - karafka-web.gemspec
 - lib/karafka/web.rb
 - lib/karafka/web/app.rb
+- lib/karafka/web/cli.rb
 - lib/karafka/web/config.rb
 - lib/karafka/web/deserializer.rb
 - lib/karafka/web/errors.rb