sbmt-kafka_consumer 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 466c2702a664bfe4ad5916c115dddb574e2108a990af6b686c5eea3298fd3a4c
-  data.tar.gz: 140e5ea106e9374df42dab0e372be5ff3c547a33882391a4634e368fc93b8737
+  metadata.gz: 3aaf5a3d0cab0fe477ab5af189b754b642c403036eec6f7329818645a1dff362
+  data.tar.gz: f198d12579b3437f903fff1c7be33246c5121b1b37bb735e861c7c0f9cbb0314
 SHA512:
-  metadata.gz: fc45d190f2cd0646049392a75c3f7d1a77db081669855f13b4d3dedb6f1a143cea6830659dbff9273fbde5517e3f11259e127ecb6c5a48a08cd4f6c71bbd93ea
-  data.tar.gz: 852f8c6da38cdb110cb5832d85f9798001f9b2fbf3db56c5b492cca4e44dcb3fc47639b60e4e5d143c8420a0b3f0c7e1467433f31861100c0578de62c6f49bec
+  metadata.gz: 468be419229e1096fbae7a0892607c33c8913f686478bca5d8ed8816ac83c8932be7683eedbfbc8eeb55225578dd74707c7bc256947691e65fa19d7142fdb095
+  data.tar.gz: 105b7fdd0b37927b92e81819035442705e9a636828469f47b61ce5bb67850db2f1c921e5d45b9bcadedb89eaceb6e929a3fde903672517a9aae5810e68ef0627

data/CHANGELOG.md

@@ -13,6 +13,18 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Fixed
 
+## [2.4.0] - 2024-06-06
+
+### Added
+
+- Added option `midlewares` to add middleware before message processing
+
+## [2.3.1] - 2024-06-05
+
+### Fixed
+
+- Rename from `export_batch` to `process_batch`
+
 ## [2.3.0] - 2024-05-30
 
 ### Added

data/README.md

@@ -183,12 +183,45 @@ consumer_groups:
 #### `consumer.init_attrs` options for `BaseConsumer`
 
 - `skip_on_error` - optional, default false, omit consumer errors in message processing and commit the offset to Kafka
+- `middlewares` - optional, default [], type String, add middleware before message processing
+
+```yaml
+init_attrs:
+  middlewares: ['SomeMiddleware']
+```
+
+```ruby
+class SomeMiddleware
+  def call(message)
+    yield if message.payload.id.to_i % 2 == 0
+  end
+end
+```
+__CAUTION__:
+- ⚠️ `yield` is mandatory for all middleware, as it returns control to the `process_message` method.
 
 #### `consumer.init_attrs` options for `InboxConsumer`
 
 - `inbox_item` - required, name of the inbox item class
 - `event_name` - optional, default nil, used when the inbox item keep several event types
 - `skip_on_error` - optional, default false, omit consumer errors in message processing and commit the offset to Kafka
+- `middlewares` - optional, default [], type String, add middleware before message processing
+
+```yaml
+init_attrs:
+  middlewares: ['SomeMiddleware']
+```
+
+```ruby
+class SomeMiddleware
+  def call(message)
+    yield if message.payload.id.to_i % 2 == 0
+  end
+end
+```
+__CAUTION__:
+- ⚠️ `yield` is mandatory for all middleware, as it returns control to the `process_message` method.
+- ⚠️ Doesn't work with `process_batch`.
 
 #### `deserializer.init_attrs` options
 
@@ -233,14 +266,14 @@ require_relative "config/environment"
 some-extra-configuration
 ```
 
-### `Export batch`
+### `Process batch`
 
-To process messages in batches, you need to add the `export_batch` method in the consumer
+To process messages in batches, you need to add the `process_batch` method in the consumer
 
 ```ruby
 # app/consumers/some_consumer.rb
 class SomeConsumer < Sbmt::KafkaConsumer::BaseConsumer
-  def export_batch(messages)
+  def process_batch(messages)
     # some code 
   end
 end

data/lib/sbmt/kafka_consumer/base_consumer.rb

@@ -5,9 +5,10 @@ module Sbmt
     class BaseConsumer < Karafka::BaseConsumer
       attr_reader :trace_id
 
-      def self.consumer_klass(skip_on_error: false)
+      def self.consumer_klass(skip_on_error: false, middlewares: [])
         Class.new(self) do
           const_set(:SKIP_ON_ERROR, skip_on_error)
+          const_set(:MIDDLEWARES, middlewares.map(&:constantize))
 
           def self.name
             superclass.name
@@ -17,9 +18,9 @@ module Sbmt
 
       def consume
         ::Rails.application.executor.wrap do
-          if export_batch?
+          if process_batch?
             with_batch_instrumentation(messages) do
-              export_batch(messages)
+              process_batch(messages)
               mark_as_consumed!(messages.last)
             end
           else
@@ -30,11 +31,11 @@ module Sbmt
         end
       end
 
-      def export_batch?
-        if @export_batch_memoized.nil?
-          @export_batch_memoized = respond_to?(:export_batch)
+      def process_batch?
+        if @process_batch_memoized.nil?
+          @process_batch_memoized = respond_to?(:process_batch)
         end
-        @export_batch_memoized
+        @process_batch_memoized
       end
 
       private
@@ -93,7 +94,7 @@ module Sbmt
         # so we trigger it explicitly to catch undeserializable message early
         message.payload
 
-        process_message(message)
+        call_middlewares(message, middlewares) { process_message(message) }
 
         mark_as_consumed!(message)
       end
@@ -102,6 +103,10 @@ module Sbmt
         self.class::SKIP_ON_ERROR
       end
 
+      def middlewares
+        self.class::MIDDLEWARES
+      end
+
       # can be overridden in consumer to enable message logging
       def log_payload?
         false
@@ -132,6 +137,21 @@ module Sbmt
       def message_payload(message)
         message.payload || message.raw_payload
       end
+
+      def call_middlewares(message, middlewares)
+        return yield if middlewares.empty?
+
+        chain = middlewares.map { |middleware_class| middleware_class.new }
+
+        traverse_chain = proc do
+          if chain.empty?
+            yield
+          else
+            chain.shift.call(message, &traverse_chain)
+          end
+        end
+        traverse_chain.call
+      end
     end
   end
 end

data/lib/sbmt/kafka_consumer/inbox_consumer.rb

@@ -6,11 +6,12 @@ module Sbmt
       IDEMPOTENCY_HEADER_NAME = "Idempotency-Key"
       DEFAULT_SOURCE = "KAFKA"
 
-      def self.consumer_klass(inbox_item:, event_name: nil, skip_on_error: false, name: nil)
+      def self.consumer_klass(inbox_item:, event_name: nil, skip_on_error: false, name: nil, middlewares: [])
         Class.new(self) do
           const_set(:INBOX_ITEM_CLASS_NAME, inbox_item)
           const_set(:EVENT_NAME, event_name)
           const_set(:SKIP_ON_ERROR, skip_on_error)
+          const_set(:MIDDLEWARES, middlewares.map(&:constantize))
 
           def self.name
             superclass.name

data/lib/sbmt/kafka_consumer/version.rb

@@ -2,6 +2,6 @@
 
 module Sbmt
   module KafkaConsumer
-    VERSION = "2.3.0"
+    VERSION = "2.4.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sbmt-kafka_consumer
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Sbermarket Ruby-Platform Team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-04 00:00:00.000000000 Z
+date: 2024-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails