karafka 1.2.8 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a4b14c619edcab5a576a211ec9e7a791ebca8e200ee82dccf21d41a9546dcc7
-  data.tar.gz: 67916109c7f400f6be77eef19cbc7f059ed99c77d9e4e6554abe8925cba2b1e5
+  metadata.gz: 45788f5dd509d8a61a1480ff5c1b41f89b683d2100e0dcedaf6e35e6ce3af447
+  data.tar.gz: d5e5638fd2a83b91f78cf1f38d03bd2594fb562a0cc8ad6cf2e45f60e72cc692
 SHA512:
-  metadata.gz: 46311d0b624a9c4b0859fd79fcbe05a3bef67aa33f1eed53ea9a70f114531775e176b5acce4aa2295960c2180e74060f4f77e2bd49f42e1474f00664996ab4fa
-  data.tar.gz: 02f3933639045e38b88d23bf811cc7c5e870cc5e76e8e315cb5fa860833f4a2474c99919d74e073588dca957bc2e6f8832c35db9d580d0edb31df1417a7a3712
+  metadata.gz: 75b2863022df6dc78f23ca557450a9757e137d110f9a6c49a29f572cd701863143e638394c341e8f982bdce4255df923879c8410ce081503c43e3f9a0ce2e777
+  data.tar.gz: ec0eee525c34634d15b04c85a492e329d4749f179ff2c21d3ce2e50cccb4b6d061465c13df322a026b8924974f743277448464db818e13d73ef90f5ce930f796

data/.coditsu/ci.yml

@@ -0,0 +1,3 @@
+repository_id: 'd4482d42-f6b5-44ba-a5e4-00989ac519ee'
+api_key: <%= ENV['CODITSU_API_KEY'] %>
+api_secret: <%= ENV['CODITSU_API_SECRET'] %>

data/.console_irbrc

@@ -1,11 +1,9 @@
 # irbrc for Karafka console
-require 'karafka'
-require Karafka.boot_file
 
 IRB.conf[:AUTO_INDENT] = true
 IRB.conf[:SAVE_HISTORY] = 1000
 IRB.conf[:USE_READLINE] = true
-IRB.conf[:HISTORY_FILE] = "#{Karafka::App.root}/.irb-history"
+IRB.conf[:HISTORY_FILE] = ".irb-history"
 IRB.conf[:LOAD_MODULES] = [] unless IRB.conf.key?(:LOAD_MODULES)
 
 unless IRB.conf[:LOAD_MODULES].include?('irb/completion')

data/.diffend.yml

@@ -0,0 +1,3 @@
+project_id: 'de9b9933-7610-4cc4-b69b-f7e3e3c5e797'
+shareable_id: '68a8c626-b605-40ad-ac45-e3961ad7c57d'
+shareable_key: 'a3ec2dac-fba2-4b6c-b181-49e927b15057'

data/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+open_collective: karafka

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,50 @@
+---
+name: Bug Report
+about: Report an issue with Karafka you've discovered.
+---
+
+*Be clear, concise and precise in your description of the problem.
+Open an issue with a descriptive title and a summary in grammatically correct,
+complete sentences.*
+
+*Use the template below when reporting bugs. Please, make sure that
+you're running the latest stable Karafka and that the problem you're reporting
+hasn't been reported (and potentially fixed) already.*
+
+*Before filing the ticket you should replace all text above the horizontal
+rule with your own words.*
+
+--------
+
+## Expected behavior
+
+Describe here how you expected Karafka to behave in this particular situation.
+
+## Actual behavior
+
+Describe here what actually happened.
+
+## Steps to reproduce the problem
+
+This is extremely important! Providing us with a reliable way to reproduce
+a problem will expedite its solution.
+
+## Your setup details
+
+Please provide kafka version and the output of `karafka info` or `bundle exec karafka info` if using Bundler.
+
+Here's an example:
+
+```
+$ [bundle exec] karafka info
+Karafka version: 1.3.0
+Ruby version: 2.6.3
+Ruby-kafka version: 0.7.9
+Application client id: karafka-local
+Backend: inline
+Batch fetching: true
+Batch consuming: true
+Boot file: /app/karafka/karafka.rb
+Environment: development
+Kafka seed brokers: ["kafka://kafka:9092"]
+```

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature Request
+about: Suggest new Karafka features or improvements to existing features.
+---
+
+## Is your feature request related to a problem? Please describe.
+
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+## Describe the solution you'd like
+
+A clear and concise description of what you want to happen.
+
+## Describe alternatives you've considered
+
+A clear and concise description of any alternative solutions or features you've considered.
+
+## Additional context
+
+Add any other context or screenshots about the feature request here.

data/.github/workflows/ci.yml

@@ -0,0 +1,52 @@
+name: ci
+
+on:
+  push:
+  schedule:
+    - cron:  '0 1 * * *'
+
+jobs:
+  specs:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - '2.7'
+          - '2.6'
+          - '2.5'
+        include:
+          - ruby: '2.7'
+            coverage: 'true'
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install package dependencies
+        run: "[ -e $APT_DEPS ] || sudo apt-get install -y --no-install-recommends $APT_DEPS"
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{matrix.ruby}}
+      - name: Install latest bundler
+        run: |
+          gem install bundler --no-document
+          bundle config set without 'tools benchmarks docs'
+      - name: Bundle install
+        run: |
+          bundle config set without development
+          bundle install --jobs 4 --retry 3
+      - name: Run Kafka with docker-compose
+        run: docker-compose up -d
+      - name: Run all tests
+        env:
+          GITHUB_COVERAGE: ${{matrix.coverage}}
+        run: bundle exec rspec
+  coditsu:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Run Coditsu
+        run: \curl -sSL https://api.coditsu.io/run/ci | bash

data/.gitignore

@@ -6,6 +6,7 @@
 app.god
 
 # minimal Rails specific artifacts
+/.coditsu/local.yml
 db/*.sqlite3
 /log/development.log
 /log/production.log

data/.ruby-version

@@ -1 +1 @@
-2.5.1
+2.7.1

data/CHANGELOG.md

@@ -1,5 +1,123 @@
 # Karafka framework changelog
 
+## 1.4.0 (2020-09-05)
+- Rename `Karafka::Params::Metadata` to `Karafka::Params::BatchMetadata`
+` Rename consumer `#metadata` to `#batch_metadata`
+- Separate metadata (including Karafka native metadata) from the root of params (backwards compatibility preserved thanks to rabotyaga)
+- Remove metadata hash dependency
+- Remove params dependency on a hash in favour of PORO
+- Remove batch metadata dependency on a hash
+- Remove MultiJson in favour of JSON in the default deserializer
+- allow accessing all the metadata without accessing the payload
+- freeze params and underlying elements except for the mutable payload
+- provide access to raw payload after serialization
+- fixes a bug where a non-deserializable (error) params would be marked as deserialized after first unsuccessful deserialization attempt
+- fixes bug where karafka would mutate internal ruby-kafka state
+- fixes bug where topic name in metadata would not be mapped using topic mappers
+- simplifies the params and params batch API, before `#payload` usage, it won't be deserialized
+- removes the `#[]` API from params to prevent from accessing raw data in a different way than #raw_payload
+- makes the params batch operations consistent as params payload is deserialized only when accessed explicitly
+
+## 1.3.7 (2020-08-11)
+- #599 - Allow metadata access without deserialization attempt (rabotyaga)
+- Sync with ruby-kafka `1.2.0` api
+
+## 1.3.6 (2020-04-24)
+- #583 - Use Karafka.logger for CLI messages (prikha)
+- #582 - Cannot only define seed brokers in consumer groups
+
+## 1.3.5 (2020-04-02)
+- #578 - ThreadError: can't be called from trap context patch
+
+## 1.3.4 (2020-02-17)
+- `dry-configurable` upgrade (solnic)
+- Remove temporary `thor` patches that are no longer needed
+
+## 1.3.3 (2019-12-23)
+- Require `delegate` to fix missing dependency in `ruby-kafka`
+
+## 1.3.2 (2019-12-23)
+- #561 - Allow `thor` 1.0.x usage in Karafka
+- #567 - Ruby 2.7.0 support + unfreeze of a frozen string fix
+
+## 1.3.1 (2019-11-11)
+- #545 - Makes sure the log directory exists when is possible (robertomiranda)
+- Ruby 2.6.5 support
+- #551 - add support for DSA keys
+- #549 - Missing directories after `karafka install` (nijikon)
+
+## 1.3.0 (2019-09-09)
+- Drop support for Ruby 2.4
+- YARD docs tags cleanup
+
+## 1.3.0.rc1 (2019-07-31)
+- Drop support for Kafka 0.10 in favor of native support for Kafka 0.11.
+- Update ruby-kafka to the 0.7 version
+- Support messages headers receiving
+- Message bus unification
+- Parser available in metadata
+- Cleanup towards moving to a non-global state app management
+- Drop Ruby 2.3 support
+- Support for Ruby 2.6.3
+- `Karafka::Loader` has been removed in favor of Zeitwerk
+- Schemas are now contracts
+- #393 - Reorganize responders - removed `multiple_usage` constrain
+- #388 - ssl_client_cert_chain sync
+- #300 - Store value in a value key and replace its content with parsed version - without root merge
+- #331 - Disallow building groups without topics
+- #340 - Instrumentation unification. Better and more consistent naming
+- #340 - Procline instrumentation for a nicer process name
+- #342 - Change default for `fetcher_max_queue_size` from `100` to `10` to lower max memory usage
+- #345 - Cleanup exceptions names
+- #341 - Split connection delegator into batch delegator and single_delegator
+- #351 - Rename `#retrieve!` to `#parse!` on params and `#parsed` to `parse!` on params batch.
+- #351 - Adds '#first' for params_batch that returns parsed first element from the params_batch object.
+- #360 - Single params consuming mode automatically parses data specs
+- #359 - Divide mark_as_consumed into mark_as_consumed and mark_as_consumed!
+- #356 - Provide a `#values` for params_batch to extract only values of objects from the params_batch
+- #363 - Too shallow ruby-kafka version lock
+- #354 - Expose consumer heartbeat
+- #377 - Remove the persistent setup in favor of persistence
+- #375 - Sidekiq Backend parser mismatch
+- #369 - Single consumer can support more than one topic
+- #288 - Drop dependency on `activesupport` gem
+- #371 - SASL over SSL
+- #392 - Move params redundant data to metadata
+- #335 - Metadata access from within the consumer
+- #402 - Delayed reconnection upon critical failures
+- #405 - `reconnect_timeout` value is now being validated
+- #437 - Specs ensuring that the `#437` won't occur in the `1.3` release
+- #426 - ssl client cert key password
+- #444 - add certificate and private key validation
+- #460 - Decouple responder "parser" (generator?) from topic.parser (benissimo)
+- #463 - Split parsers into serializers / deserializers
+- #473 - Support SASL OAuthBearer Authentication
+- #475 - Disallow subscribing to the same topic with multiple consumers
+- #485 - Setting shutdown_timeout to nil kills the app without waiting for anything
+- #487 - Make listeners as instances
+- #29 - Consumer class names must have the word "Consumer" in it in order to work (Sidekiq backend)
+- #491 - irb is missing for console to work
+- #502 - Karafka process hangs when sending multiple sigkills
+- #506 - ssl_verify_hostname sync
+- #483 - Upgrade dry-validation before releasing 1.3
+- #492 - Use Zeitwerk for code reload in development
+- #508 - Reset the consumers instances upon reconnecting to a cluster
+- [#530](https://github.com/karafka/karafka/pull/530) - expose ruby and ruby-kafka version
+- [534](https://github.com/karafka/karafka/pull/534) - Allow to use headers in the deserializer object
+- [#319](https://github.com/karafka/karafka/pull/328) - Support for exponential backoff in pause
+
+## 1.2.11
+- [#470](https://github.com/karafka/karafka/issues/470) Karafka not working with dry-configurable 0.8
+
+## 1.2.10
+- [#453](https://github.com/karafka/karafka/pull/453) require `Forwardable` module
+
+## 1.2.9
+- Critical exceptions now will cause consumer to stop instead of retrying without a break
+- #412 - Fix dry-inflector dependency lock in gemspec
+- #414 - Backport to 1.2 the delayed retry upon failure
+- #437 - Raw message is no longer added to params after ParserError raised
+
 ## 1.2.8
 - #408 - Responder Topic Lookup Bug on Heroku
 
@@ -9,6 +127,7 @@
 ## 1.2.6
 - Lock WaterDrop to 1.2.3
 - Lock Ruby-Kafka to 0.6.x (support for 0.7 will be added in Karafka 1.3)
+- #382 - Full logging with AR, etc for development mode when there is Rails integration
 
 ## 1.2.5
 - #354 - Expose consumer heartbeat
@@ -19,7 +138,8 @@
 
 ## 1.2.3
 - #313 - support PLAINTEXT and SSL for scheme
-- #320 - Pausing indefinetely with nil pause timeout doesn't work
+- #288 - drop activesupport callbacks in favor of notifications
+- #320 - Pausing indefinitely with nil pause timeout doesn't work
 - #318 - Partition pausing doesn't work with custom topic mappers
 - Rename ConfigAdapter to ApiAdapter to better reflect what it does
 - #317 - Manual offset committing doesn't work with custom topic mappers
@@ -147,7 +267,7 @@
 - Switch to multi json so everyone can use their favourite JSON parser
 - Added jruby support in general and in Travis
 - #196 - Topic mapper does not map topics when subscribing thanks to @webandtech
-- #96 - Karafka server - possiblity to run it only for a certain topics
+- #96 - Karafka server - possibility to run it only for a certain topics
 - ~~karafka worker cli option is removed (please use sidekiq directly)~~ - restored, bad idea
 - (optional) pausing upon processing failures ```pause_timeout```
 - Karafka console main process no longer intercepts irb errors
@@ -155,7 +275,7 @@
 - #204 - Long running controllers
 - Better internal API to handle multiple usage cases using ```Karafka::Controllers::Includer```
 - #207 - Rename before_enqueued to after_received
-- #147 - Deattach Karafka from Sidekiq by extracting Sidekiq backend
+- #147 - De-attach Karafka from Sidekiq by extracting Sidekiq backend
 
 ### New features and improvements
 
@@ -240,7 +360,7 @@
 - Waterdrop 0.3.2.1 with kafka.hosts instead of kafka_hosts
 - #105 - Karafka::Monitor#caller_label not working with inherited monitors
 - #99 - Standalone mode (without Sidekiq)
-- #97 - Buffer responders single topics before send (prevalidation)
+- #97 - Buffer responders single topics before send (pre-validation)
 - Better control over consumer thanks to additional config options
 - #111 - Dynamic worker assignment based on the income params
 - Long shutdown time fix
@@ -248,7 +368,7 @@
 ## 0.5.0
 - Removed Zookeeper totally as dependency
 - Better group and partition rebalancing
-- Automatic thread management (no need for tunning) - each topic is a separate actor/thread
+- Automatic thread management (no need for tuning) - each topic is a separate actor/thread
 - Moved from Poseidon into Ruby-Kafka
 - No more max_concurrency setting
 - After you define your App class and routes (and everything else) you need to add execute App.boot!
@@ -264,14 +384,14 @@
 - Ruby 2.2.* support dropped
 - Using App name as a Kafka client_id
 - Automatic Capistrano integration
-- Responders support for handling better responses pipelining and better responses flow description and design (see README for more details)
+- Responders support for handling better responses pipe-lining and better responses flow description and design (see README for more details)
 - Gem bump
 - Readme updates
 - karafka flow CLI command for printing the application flow
-- Some internal refactorings
+- Some internal refactoring
 
 ## 0.4.2
-- #87 - Reconsume mode with crone for better Rails/Rack integration
+- #87 - Re-consume mode with crone for better Rails/Rack integration
 - Moved Karafka server related stuff into separate Karafka::Server class
 - Renamed Karafka::Runner into Karafka::Fetcher
 - Gem bump
@@ -283,7 +403,7 @@
 
 ## 0.4.1
 - Explicit throw(:abort) required to halt before_enqueue (like in Rails 5)
-- #61 - Autodiscover Kafka brokers based on Zookeeper data
+- #61 - autodiscovery of Kafka brokers based on Zookeeper data
 - #63 - Graceful shutdown with current offset state during data processing
 - #65 - Example of NewRelic monitor is outdated
 - #71 - Setup should be executed after user code is loaded
@@ -339,7 +459,7 @@
 - Added Karafka::Monitoring that allows to add custom logging and monitoring with external libraries and systems
 - Moved logging functionality into Karafka::Monitoring default monitoring
 - Added possibility to provide own monitoring as long as in responds to #notice and #notice_error
-- Standarized logging format for all logs
+- Standardized logging format for all logs
 
 ## 0.3.0
 - Switched from custom ParserError for each parser to general catching of Karafka::Errors::ParseError and its descendants
@@ -356,7 +476,7 @@
 
 ## 0.1.19
 - Internal call - schedule naming change
-- Enqueue to perform_async naming in controller to follow Sidekiqs naming convention
+- Enqueue to perform_async naming in controller to follow Sidekiq naming convention
 - Gem bump
 
 ## 0.1.18
@@ -367,7 +487,7 @@
 - Changed Karafka::Connection::Cluster tp Karafka::Connection::ActorCluster to distinguish between a single thread actor cluster for multiple topic connection and a future feature that will allow process clusterization.
 - Add an ability to use user-defined parsers for a messages
 - Lazy load params for before callbacks
-- Automatic loading/initializng all workers classes during startup (so Sidekiq won't fail with unknown workers exception)
+- Automatic loading/initializing all workers classes during startup (so Sidekiq won't fail with unknown workers exception)
 - Params are now private to controller
 - Added bootstrap method to app.rb
 
@@ -408,7 +528,7 @@
 - Added worker logger
 
 ## 0.1.8
-- Droped local env suppot in favour of [Envlogic](https://github.com/karafka/envlogic) - no changes in API
+- Dropped local env support in favour of [Envlogic](https://github.com/karafka/envlogic) - no changes in API
 
 ## 0.1.7
 - Karafka option for Redis hosts (not localhost only)
@@ -438,7 +558,7 @@
 
 ## 0.1.1
 - README updates
-- Raketasks updates
+- Rake tasks updates
 - Rake installation task
 - Changelog file added
 

data/CODE_OF_CONDUCT.md

@@ -34,7 +34,7 @@ This Code of Conduct applies both within project spaces and in public spaces whe
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at maciej@coditsu.io. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at maciej@mensfeld.pl. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
 
 Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
 

data/CONTRIBUTING.md

@@ -4,7 +4,7 @@
 
 First, thank you for considering contributing to karafka! It's people like you that make the open source community such a great community! 😊
 
-We welcome any type of contribution, not only code. You can help with 
+We welcome any type of contribution, not only code. You can help with:
 - **QA**: file bug reports, the more details you can give the better (e.g. screenshots with the console open)
 - **Marketing**: writing blog posts, howto's, printing stickers, ...
 - **Community**: presenting the project at meetups, organizing a dedicated meetup for the local community, ...

data/Gemfile

@@ -2,14 +2,13 @@
 
 source 'https://rubygems.org'
 
-gemspec
+plugin 'diffend'
 
-group :development, :test do
-  gem 'benchmark-ips'
-end
+gemspec
 
 group :test do
+  gem 'byebug'
+  gem 'factory_bot'
   gem 'rspec'
   gem 'simplecov'
-  gem 'timecop'
 end