waterdrop 2.0.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 616222bb9061a061dbe807b3c490c04fc368b0f457dc70e27b27c5cc049b1271
-  data.tar.gz: f6330179e3db7aea799360ca51a09fa56d9d7bbc757925bf482a901c90e4e76d
+  metadata.gz: 0bd7288d6c0c7a6f356f050af309899cad41e6fcf202c945229231d7058194e1
+  data.tar.gz: 727738b727dccf8e2d7b4eb7c3f25b1c7ed761eb958eae4ba818c7402839a6c7
 SHA512:
-  metadata.gz: e09358bf7a02acca118f62f869f3f53bf417356e9f28f32187c578af5debfd6d602463b13082cfc79a3a12042e2e2efcedb000fd45009802bc186249dee4a6bb
-  data.tar.gz: 81fe2d98e27704662201408c47746f8a800a955143f260afcbc2e4f3c3d44f34b5b27fbfdedb7bfe642e1fd3df966265f2e69585cc59cc3c4941005e17238079
+  metadata.gz: 95f69c8cd00d33e04747f1447ca9fe40de88941869925662116427b14da7f0eb0a04c7eada0e00ea6c226dd8be90484b7e97e6d34f9c7f0a11333bfede37e03c
+  data.tar.gz: fa43e25469180c9d9e65f31b4d79554b35c090e79d8812586d614a77acafe04bb873f24ed58f739c4523696282bef8dfa05e0fa0358ca808bfd2df038bf3d55b

data/.github/workflows/ci.yml

@@ -1,6 +1,9 @@
 name: ci
 
+concurrency: ci-${{ github.ref }}
+
 on:
+  pull_request:
   push:
   schedule:
     - cron:  '0 1 * * *'
@@ -8,16 +11,16 @@ on:
 jobs:
   specs:
     runs-on: ubuntu-latest
+    needs: diffend
     strategy:
       fail-fast: false
       matrix:
         ruby:
+          - '3.1'
+          - '3.0'
           - '2.7'
-          - '2.6'
-          - '2.5'
-          - 'jruby'
         include:
-          - ruby: '2.7'
+          - ruby: '3.1'
             coverage: 'true'
     steps:
       - uses: actions/checkout@v2
@@ -27,6 +30,12 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{matrix.ruby}}
+      - name: Run Kafka with docker-compose
+        # We need to give Kafka enough time to start and create all the needed topics, etc
+        # If anyone has a better idea on how to do it smart and easily, please contact me
+        run: |
+          docker-compose up -d
+          sleep 5
       - name: Install latest bundler
         run: |
           gem install bundler --no-document
@@ -35,12 +44,30 @@ jobs:
         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
+
+  diffend:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.1
+      - name: Install latest bundler
+        run: gem install bundler --no-document
+      - name: Install Diffend plugin
+        run: bundle plugin install diffend
+      - name: Bundle Secure
+        run: bundle secure
+
   coditsu:
     runs-on: ubuntu-latest
     strategy:

data/.ruby-version

@@ -1 +1 @@
-2.7.2
+3.1.2

data/CHANGELOG.md

@@ -1,5 +1,85 @@
 # WaterDrop changelog
 
+## 2.4.0 (2022-07-28)
+- Small refactor of the DataDog/Statsd listener to align for future extraction to `karafka-common`.
+- Replace `dry-monitor` with home-brew notification layer (API compatible) and allow for usage with `ActiveSupport::Notifications`.
+- Remove all the common code into `karafka-core` and add it as a dependency.
+
+## 2.3.3 (2022-07-18)
+- Replace `dry-validation` with home-brew validation layer and drop direct dependency on `dry-validation`.
+- Remove indirect dependency on dry-configurable from DataDog listener (no changes required).
+
+## 2.3.2 (2022-07-17)
+- Replace `dry-configurable` with home-brew config and drop direct dependency on `dry-configurable`.
+
+## 2.3.1 (2022-06-17)
+- Update rdkafka patches to align with `0.12.0` and `0.11.1` support.
+
+## 2.3.0 (2022-04-03)
+-  Rename StdoutListener to LoggerListener (#240)
+
+## 2.2.0 (2022-02-18)
+- Add Datadog listener for metrics + errors publishing
+- Add Datadog example dashboard template
+- Update Readme to show Dd instrumentation usage
+- Align the directory namespace convention with gem name (waterdrop => WaterDrop)
+- Introduce a common base for validation contracts
+- Drop CI support for ruby 2.6
+- Require all `kafka` settings to have symbol keys (compatibility with Karafka 2.0 and rdkafka)
+
+## 2.1.0 (2022-01-03)
+- Ruby 3.1 support
+- Change the error notification key from `error.emitted` to `error.occurred`.
+- Normalize error tracking and make all the places publish errors into the same notification endpoint (`error.occurred`).
+- Start semantic versioning WaterDrop.
+
+## 2.0.7 (2021-12-03)
+- Source code metadata url added to the gemspec
+- Replace `:producer` with `:producer_id` in events and update `StdoutListener` accordingly. This change aligns all the events in terms of not publishing the whole producer object in the events.
+- Add `error.emitted` into the `StdoutListener`.
+- Enable `StdoutLogger` in specs for additional integration coverage.
+
+## 2.0.6 (2021-12-01)
+- #218 - Fixes a case, where dispatch of callbacks the same moment a new producer was created could cause a concurrency issue in the manager.
+- Fix some unstable specs.
+
+## 2.0.5 (2021-11-28)
+
+### Bug fixes
+
+- Fixes an issue where multiple producers would emit stats of other producers causing the same stats to be published several times (as many times as a number of producers). This could cause invalid reporting for multi-kafka setups.
+- Fixes a bug where emitted statistics would contain their first value as the first delta value for first stats emitted.
+- Fixes a bug where decorated statistics would include a delta for a root field with non-numeric values.
+
+### Changes and features
+- Introduces support for error callbacks instrumentation notifications with `error.emitted` monitor emitted key for tracking background errors that would occur on the producer (disconnects, etc).
+- Removes the `:producer` key from `statistics.emitted` and replaces it with `:producer_id` not to inject whole producer into the payload
+- Removes the `:producer` key from `message.acknowledged` and replaces it with `:producer_id` not to inject whole producer into the payload
+- Cleanup and refactor of callbacks support to simplify the API and make it work with Rdkafka way of things.
+- Introduces a callbacks manager concept that will also be within in Karafka `2.0` for both statistics and errors tracking per client.
+- Sets default Kafka `client.id` to `waterdrop` when not set.
+- Updates specs to always emit statistics for better test coverage.
+- Adds statistics and errors integration specs running against Kafka.
+- Replaces direct `RSpec.describe` reference with auto-discovery
+- Patches `rdkafka` to provide functionalities that are needed for granular callback support.
+
+## 2.0.4 (2021-09-19)
+- Update `dry-*` to the recent versions and update settings syntax to match it
+- Update Zeitwerk requirement
+
+## 2.0.3 (2021-09-05)
+- Remove rdkafka patch in favour of spec topic pre-creation
+- Do not close client that was never used upon closing producer
+
+## 2.0.2 (2021-08-13)
+- Add support for `partition_key`
+- Switch license from `LGPL-3.0` to  `MIT`
+- Switch flushing on close to sync
+
+## 2.0.1 (2021-06-05)
+- Remove Ruby 2.5 support and update minimum Ruby requirement to 2.6
+- Fix the `finalizer references object to be finalized` warning issued with 3.0
+
 ## 2.0.0 (2020-12-13)
 - Redesign of the whole API (see `README.md` for the use-cases and the current API)
 - Replace `ruby-kafka` with `rdkafka`

data/Gemfile

@@ -6,8 +6,6 @@ plugin 'diffend'
 
 gemspec
 
-gem 'rdkafka'
-
 group :development do
   gem 'byebug'
 end

data/Gemfile.lock

@@ -1,120 +1,69 @@
 PATH
   remote: .
   specs:
-    waterdrop (2.0.0)
-      concurrent-ruby (>= 1.1)
-      dry-configurable (~> 0.8)
-      dry-monitor (~> 0.3)
-      dry-validation (~> 1.3)
-      rdkafka (>= 0.6.0)
-      zeitwerk (~> 2.1)
+    waterdrop (2.4.0)
+      karafka-core (~> 2.0)
+      rdkafka (>= 0.10)
+      zeitwerk (~> 2.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.0)
+    activesupport (7.0.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
     byebug (11.1.3)
-    concurrent-ruby (1.1.7)
-    diff-lcs (1.4.4)
-    docile (1.3.2)
-    dry-configurable (0.11.6)
-      concurrent-ruby (~> 1.0)
-      dry-core (~> 0.4, >= 0.4.7)
-      dry-equalizer (~> 0.2)
-    dry-container (0.7.2)
-      concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.5.0)
-      concurrent-ruby (~> 1.0)
-    dry-equalizer (0.3.0)
-    dry-events (0.2.0)
-      concurrent-ruby (~> 1.0)
-      dry-core (~> 0.4)
-      dry-equalizer (~> 0.2)
-    dry-inflector (0.2.0)
-    dry-initializer (3.0.4)
-    dry-logic (1.0.8)
-      concurrent-ruby (~> 1.0)
-      dry-core (~> 0.2)
-      dry-equalizer (~> 0.2)
-    dry-monitor (0.3.2)
-      dry-configurable (~> 0.5)
-      dry-core (~> 0.4)
-      dry-equalizer (~> 0.2)
-      dry-events (~> 0.2)
-    dry-schema (1.5.6)
-      concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.8, >= 0.8.3)
-      dry-core (~> 0.4)
-      dry-equalizer (~> 0.2)
-      dry-initializer (~> 3.0)
-      dry-logic (~> 1.0)
-      dry-types (~> 1.4)
-    dry-types (1.4.0)
-      concurrent-ruby (~> 1.0)
-      dry-container (~> 0.3)
-      dry-core (~> 0.4, >= 0.4.4)
-      dry-equalizer (~> 0.3)
-      dry-inflector (~> 0.1, >= 0.1.2)
-      dry-logic (~> 1.0, >= 1.0.2)
-    dry-validation (1.6.0)
-      concurrent-ruby (~> 1.0)
-      dry-container (~> 0.7, >= 0.7.1)
-      dry-core (~> 0.4)
-      dry-equalizer (~> 0.2)
-      dry-initializer (~> 3.0)
-      dry-schema (~> 1.5, >= 1.5.2)
-    factory_bot (6.1.0)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    factory_bot (6.2.1)
       activesupport (>= 5.0.0)
-    ffi (1.13.1)
-    i18n (1.8.5)
+    ffi (1.15.5)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    mini_portile2 (2.5.0)
-    minitest (5.14.2)
-    rake (13.0.1)
-    rdkafka (0.8.1)
-      ffi (~> 1.9)
-      mini_portile2 (~> 2.1)
-      rake (>= 12.3)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.0)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.0)
+    karafka-core (2.0.0)
+      concurrent-ruby (>= 1.1)
+    mini_portile2 (2.8.0)
+    minitest (5.16.2)
+    rake (13.0.6)
+    rdkafka (0.12.0)
+      ffi (~> 1.15)
+      mini_portile2 (~> 2.6)
+      rake (> 12)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.0)
-    simplecov (0.20.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.2)
-    tzinfo (2.0.3)
+    simplecov_json_formatter (0.1.4)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
-    zeitwerk (2.4.2)
+    zeitwerk (2.6.0)
 
 PLATFORMS
-  ruby
   x86_64-linux
 
 DEPENDENCIES
   byebug
   factory_bot
-  rdkafka
   rspec
   simplecov
   waterdrop!
 
 BUNDLED WITH
-   2.2.0
+   2.3.15

data/MIT-LICENSE

@@ -0,0 +1,18 @@
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.