karafka 1.1.0 → 1.3.0

data/lib/karafka/setup/configurators/water_drop.rb

@@ -2,23 +2,30 @@
 
 module Karafka
   module Setup
-    class Configurators
+    # Configurators are used to post setup some of the components of Karafka after the core
+    # framework is initialized
+    module Configurators
       # Class responsible for setting up WaterDrop configuration
-      class WaterDrop < Base
+      class WaterDrop
         # Sets up a WaterDrop settings
-        def setup
+        # @param config [Karafka::Setup::Config] Config we can user to setup things
+        # @note This will also inject Karafka monitor as a default monitor into WaterDrop,
+        #   so we have the same monitor within whole Karafka framework (same with logger)
+        def call(config)
           ::WaterDrop.setup do |water_config|
             water_config.deliver = true
 
-            Karafka::App.config.to_h.except(:kafka).each do |k, v|
+            config.to_h.reject { |k, _v| k == :kafka }.each do |k, v|
               key_assignment = :"#{k}="
               next unless water_config.respond_to?(key_assignment)
+
               water_config.public_send(key_assignment, v)
             end
 
-            Karafka::App.config.kafka.to_h.each do |k, v|
+            config.kafka.to_h.each do |k, v|
               key_assignment = :"#{k}="
               next unless water_config.kafka.respond_to?(key_assignment)
+
               water_config.kafka.public_send(key_assignment, v)
             end
           end

data/lib/karafka/setup/dsl.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Setup
+    # Dsl for allowing to work with the configuration from the Karafka::App
+    # @note Despite providing methods, everything is still persisted and fetched
+    # from the Karafka::Setup::Config
+    module Dsl
+      # Sets up the whole configuration
+      # @param [Block] block configuration block
+      def setup(&block)
+        Setup::Config.setup(&block)
+      end
+
+      # @return [Karafka::Config] config instance
+      def config
+        Setup::Config.config
+      end
+    end
+  end
+end

data/lib/karafka/status.rb

@@ -3,15 +3,16 @@
 module Karafka
   # App status monitor
   class Status
-    include Singleton
-
     # Available states and their transitions
     STATES = {
       initializing: :initialize!,
+      initialized: :initialized!,
       running: :run!,
-      stopped: :stop!
+      stopping: :stop!
     }.freeze
 
+    private_constant :STATES
+
     STATES.each do |state, transition|
       define_method :"#{state}?" do
         @status == state
@@ -19,6 +20,9 @@ module Karafka
 
       define_method transition do
         @status = state
+        # Trap context disallows to run certain things that we instrument
+        # so the state changes are executed from a separate thread
+        Thread.new { Karafka.monitor.instrument("app.#{state}") }.join
       end
     end
   end

data/lib/karafka/templates/{application_controller.rb.example → application_consumer.rb.erb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-# Application controller from which all Karafka controllers should inherit
+# Application consumer from which all Karafka consumers should inherit
 # You can rename it if it would conflict with your current code base (in case you're integrating
 # Karafka with other frameworks)
-class ApplicationController < Karafka::BaseController
+class ApplicationConsumer < Karafka::BaseConsumer
 end

data/lib/karafka/templates/karafka.rb.erb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+<% if rails? -%>
+ENV['RAILS_ENV'] ||= 'development'
+ENV['KARAFKA_ENV'] = ENV['RAILS_ENV']
+require ::File.expand_path('../config/environment', __FILE__)
+Rails.application.eager_load!
+
+# This lines will make Karafka print to stdout like puma or unicorn
+if Rails.env.development?
+  Rails.logger.extend(
+    ActiveSupport::Logger.broadcast(
+      ActiveSupport::Logger.new($stdout)
+    )
+  )
+end
+<% else -%>
+# This file is auto-generated during the install process.
+# If by any chance you've wanted a setup for Rails app, either run the `karafka:install`
+# command again or refer to the install templates available in the source codes
+
+ENV['RACK_ENV'] ||= 'development'
+ENV['KARAFKA_ENV'] ||= ENV['RACK_ENV']
+Bundler.require(:default, ENV['KARAFKA_ENV'])
+
+# Zeitwerk custom loader for loading the app components before the whole
+# Karafka framework configuration
+APP_LOADER = Zeitwerk::Loader.new
+APP_LOADER.enable_reloading
+
+%w[
+  lib
+  app/consumers
+  app/responders
+  app/workers
+].each(&APP_LOADER.method(:push_dir))
+
+APP_LOADER.setup
+APP_LOADER.eager_load
+<% end -%>
+
+class KarafkaApp < Karafka::App
+  setup do |config|
+    config.kafka.seed_brokers = %w[kafka://127.0.0.1:9092]
+    config.client_id = 'example_app'
+<% if rails? -%>
+    config.logger = Rails.logger
+<% end -%>
+  end
+
+  # Comment out this part if you are not using instrumentation and/or you are not
+  # interested in logging events for certain environments. Since instrumentation
+  # notifications add extra boilerplate, if you want to achieve max performance,
+  # listen to only what you really need for given environment.
+  Karafka.monitor.subscribe(WaterDrop::Instrumentation::StdoutListener.new)
+  Karafka.monitor.subscribe(Karafka::Instrumentation::StdoutListener.new)
+  Karafka.monitor.subscribe(Karafka::Instrumentation::ProctitleListener.new)
+
+  # Uncomment that in order to achieve code reload in development mode
+  # Be aware, that this might have some side-effects. Please refer to the wiki
+  # for more details on benefits and downsides of the code reload in the
+  # development mode
+  #
+  # Karafka.monitor.subscribe(
+  #   Karafka::CodeReloader.new(
+  #     <%= rails? ? '*Rails.application.reloaders' : 'APP_LOADER' %>
+  #   )
+  # )
+
+  consumer_groups.draw do
+    # topic :example do
+    #   consumer ExampleConsumer
+    # end
+
+    # consumer_group :bigger_group do
+    #   topic :test do
+    #     consumer TestConsumer
+    #   end
+    #
+    #   topic :test2 do
+    #     consumer Test2Consumer
+    #   end
+    # end
+  end
+end
+
+Karafka.monitor.subscribe('app.initialized') do
+  # Put here all the things you want to do after the Karafka framework
+  # initialization
+end
+
+KarafkaApp.boot!

data/lib/karafka/version.rb

@@ -3,5 +3,5 @@
 # Main module namespace
 module Karafka
   # Current Karafka version
-  VERSION = '1.1.0'
+  VERSION = '1.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karafka
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -9,53 +9,107 @@ authors:
 - Adam Gwozdowski
 autorequire: 
 bindir: bin
-cert_chain: []
-date: 2017-11-07 00:00:00.000000000 Z
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEODCCAqCgAwIBAgIBATANBgkqhkiG9w0BAQsFADAjMSEwHwYDVQQDDBhtYWNp
+  ZWovREM9bWVuc2ZlbGQvREM9cGwwHhcNMTkwNzMwMTQ1NDU0WhcNMjAwNzI5MTQ1
+  NDU0WjAjMSEwHwYDVQQDDBhtYWNpZWovREM9bWVuc2ZlbGQvREM9cGwwggGiMA0G
+  CSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQC9fCwtaHZG2SyyNXiH8r0QbJQx/xxl
+  dkvwWz9QGJO+O8rEx20FB1Ab+MVkfOscwIv5jWpmk1U9whzDPl1uFtIbgu+sk+Zb
+  uQlZyK/DPN6c+/BbBL+RryTBRyvkPLoCVwm7uxc/JZ1n4AI6eF4cCZ2ieZ9QgQbU
+  MQs2QPqs9hT50Ez/40GnOdadVfiDDGz+NME2C4ms0BriXwZ1tcRTfJIHe2xjIbbb
+  y5qRGfsLKcgMzvLQR24olixyX1MR0s4+Wveq3QL/gBhL4veUcv+UABJA8IJR0kyB
+  seHHutusiwZ1v3SjjjW1xLLrc2ARV0mgCb0WaK2T4iA3oFTGLh6Ydz8LNl31KQFv
+  94nRd8IhmJxrhQ6dQ/WT9IXoa5S9lfT5lPJeINemH4/6QPABzf9W2IZlCdI9wCdB
+  TBaw57MKneGAYZiKjw6OALSy2ltQUCl3RqFl3VP7n8uFy1U987Q5VIIQ3O1UUsQD
+  Oe/h+r7GUU4RSPKgPlrwvW9bD/UQ+zF51v8CAwEAAaN3MHUwCQYDVR0TBAIwADAL
+  BgNVHQ8EBAMCBLAwHQYDVR0OBBYEFJNIBHdfEUD7TqHqIer2YhWaWhwcMB0GA1Ud
+  EQQWMBSBEm1hY2llakBtZW5zZmVsZC5wbDAdBgNVHRIEFjAUgRJtYWNpZWpAbWVu
+  c2ZlbGQucGwwDQYJKoZIhvcNAQELBQADggGBAKA4eqko6BTNhlysip6rfBkVTGri
+  ZXsL+kRb2hLvsQJS/kLyM21oMlu+LN0aPj3qEFR8mE/YeDD8rLAfruBRTltPNbR7
+  xA5eE1gkxY5LfExUtK3b2wPqfmo7mZgfcsMwfYg/tUXw1WpBCnrhAJodpGH6SXmp
+  A40qFUZst0vjiOoO+aTblIHPmMJXoZ3K42dTlNKlEiDKUWMRKSgpjjYGEYalFNWI
+  hHfCz2r8L2t+dYdMZg1JGbEkq4ADGsAA8ioZIpJd7V4hI17u5TCdi7X5wh/0gN0E
+  CgP+nLox3D+l2q0QuQEkayr+auFYkzTCkF+BmEk1D0Ru4mcf3F4CJvEmW4Pzbjqt
+  i1tsCWPtJ4E/UUKnKaWKqGbjrjHJ0MuShYzHkodox5IOiCXIQg+1+YSzfXUV6WEK
+  KJG/fhg1JV5vVDdVy6x+tv5SQ5ctU0feCsVfESi3rE3zRd+nvzE9HcZ5aXeL1UtJ
+  nT5Xrioegu2w1jPyVEgyZgTZC5rvD0nNS5sFNQ==
+  -----END CERTIFICATE-----
+date: 2019-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: dry-configurable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: dry-configurable
+  name: dry-inflector
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: dry-monitor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: dry-validation
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: envlogic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: irb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -97,61 +151,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '11.3'
 - !ruby/object:Gem::Dependency
-  name: require_all
+  name: ruby-kafka
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 0.7.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 0.7.8
 - !ruby/object:Gem::Dependency
-  name: ruby-kafka
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.20'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.20'
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: waterdrop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
-  name: waterdrop
+  name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '2.1'
 description: Framework used to simplify Apache Kafka based Ruby applications development
 email:
 - maciej@coditsu.io
@@ -162,8 +216,11 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coditsu/ci.yml"
 - ".console_irbrc"
-- ".github/ISSUE_TEMPLATE.md"
+- ".github/FUNDING.yml"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".gitignore"
 - ".rspec"
 - ".ruby-gemset"
@@ -177,13 +234,14 @@ files:
 - MIT-LICENCE
 - README.md
 - bin/karafka
+- certs/mensfeld.pem
 - config/errors.yml
 - karafka.gemspec
 - lib/karafka.rb
 - lib/karafka/app.rb
 - lib/karafka/attributes_map.rb
 - lib/karafka/backends/inline.rb
-- lib/karafka/base_controller.rb
+- lib/karafka/base_consumer.rb
 - lib/karafka/base_responder.rb
 - lib/karafka/cli.rb
 - lib/karafka/cli/base.rb
@@ -192,29 +250,44 @@ files:
 - lib/karafka/cli/info.rb
 - lib/karafka/cli/install.rb
 - lib/karafka/cli/server.rb
-- lib/karafka/connection/config_adapter.rb
-- lib/karafka/connection/consumer.rb
+- lib/karafka/code_reloader.rb
+- lib/karafka/connection/api_adapter.rb
+- lib/karafka/connection/batch_delegator.rb
+- lib/karafka/connection/builder.rb
+- lib/karafka/connection/client.rb
 - lib/karafka/connection/listener.rb
-- lib/karafka/connection/processor.rb
-- lib/karafka/controllers/callbacks.rb
-- lib/karafka/controllers/includer.rb
-- lib/karafka/controllers/responders.rb
-- lib/karafka/controllers/single_params.rb
+- lib/karafka/connection/message_delegator.rb
+- lib/karafka/consumers/callbacks.rb
+- lib/karafka/consumers/includer.rb
+- lib/karafka/consumers/metadata.rb
+- lib/karafka/consumers/responders.rb
+- lib/karafka/consumers/single_params.rb
+- lib/karafka/contracts.rb
+- lib/karafka/contracts/config.rb
+- lib/karafka/contracts/consumer_group.rb
+- lib/karafka/contracts/consumer_group_topic.rb
+- lib/karafka/contracts/responder_usage.rb
+- lib/karafka/contracts/server_cli_options.rb
 - lib/karafka/errors.rb
 - lib/karafka/fetcher.rb
 - lib/karafka/helpers/class_matcher.rb
 - lib/karafka/helpers/config_retriever.rb
+- lib/karafka/helpers/inflector.rb
 - lib/karafka/helpers/multi_delegator.rb
-- lib/karafka/loader.rb
-- lib/karafka/logger.rb
-- lib/karafka/monitor.rb
+- lib/karafka/instrumentation/logger.rb
+- lib/karafka/instrumentation/monitor.rb
+- lib/karafka/instrumentation/proctitle_listener.rb
+- lib/karafka/instrumentation/stdout_listener.rb
+- lib/karafka/params/builders/metadata.rb
+- lib/karafka/params/builders/params.rb
+- lib/karafka/params/builders/params_batch.rb
+- lib/karafka/params/metadata.rb
 - lib/karafka/params/params.rb
 - lib/karafka/params/params_batch.rb
-- lib/karafka/parsers/json.rb
-- lib/karafka/patches/dry_configurable.rb
 - lib/karafka/patches/ruby_kafka.rb
-- lib/karafka/persistence/consumer.rb
-- lib/karafka/persistence/controller.rb
+- lib/karafka/persistence/client.rb
+- lib/karafka/persistence/consumers.rb
+- lib/karafka/persistence/topics.rb
 - lib/karafka/process.rb
 - lib/karafka/responders/builder.rb
 - lib/karafka/responders/topic.rb
@@ -225,19 +298,16 @@ files:
 - lib/karafka/routing/router.rb
 - lib/karafka/routing/topic.rb
 - lib/karafka/routing/topic_mapper.rb
-- lib/karafka/schemas/config.rb
-- lib/karafka/schemas/consumer_group.rb
-- lib/karafka/schemas/consumer_group_topic.rb
-- lib/karafka/schemas/responder_usage.rb
-- lib/karafka/schemas/server_cli_options.rb
+- lib/karafka/serialization/json/deserializer.rb
+- lib/karafka/serialization/json/serializer.rb
 - lib/karafka/server.rb
 - lib/karafka/setup/config.rb
-- lib/karafka/setup/configurators/base.rb
 - lib/karafka/setup/configurators/water_drop.rb
+- lib/karafka/setup/dsl.rb
 - lib/karafka/status.rb
-- lib/karafka/templates/application_controller.rb.example
-- lib/karafka/templates/application_responder.rb.example
-- lib/karafka/templates/karafka.rb.example
+- lib/karafka/templates/application_consumer.rb.erb
+- lib/karafka/templates/application_responder.rb.erb
+- lib/karafka/templates/karafka.rb.erb
 - lib/karafka/version.rb
 - log/.gitkeep
 homepage: https://github.com/karafka/karafka
@@ -252,15 +322,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby based framework for working with Apache Kafka