sbmt-kafka_consumer 3.0.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7af7925acd4a61d131a66dd3cd290064ba11aac749ee64ca00841912bd038adc
-  data.tar.gz: 9cd1e1f789c6e4252adedf3dd3115f512c62240b75edadc38d1590e4a85b6000
+  metadata.gz: 884f55960d86ac5b756f5b7defc30298e6918a543a168f69613972b6f4dd1282
+  data.tar.gz: 4521497f45d7c2bdf7fb78de36ddba7b077a51aee92c5c7aab41057e9b0e1f5a
 SHA512:
-  metadata.gz: 60dbd904786ddc419e9efbb0f02904c6035089a3b23fcb4035d41c85c8db303ae807138fa1e26c042688521c34a355f0314799e82addc73ef6308fc3fe6cad15
-  data.tar.gz: ca1d3af3c319695cbb33e11f9f66a384efb2c1884a387a233d5b197ae9ed5d3a3852c49662586a67ba15eb497ed325b92363cfe65ce8e086c6319b48dfb0569e
+  metadata.gz: d25efefade51458b46dd3f060983143f9de35d71d7e007dd082daf5f4a6d8a8a635daff400337d38a8621cdda1ad694e115f4816594cb9f94bd408ec8ddd2b9a
+  data.tar.gz: 7fcf377249867d6694515bf006af17de6ade409ddf813bffc63471d437cd1752f659c72d210f071fcf937f6be99f75bf4028e25a3b803d7abfd04e8fd464fdb3

data/CHANGELOG.md

@@ -13,6 +13,18 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Fixed
 
+## [3.2.0] - 2024-09-17
+
+### Added
+
+- For synchronous messages and errors, we place logs in tags
+
+## [3.1.0] - 2024-09-09
+
+### Fixed
+
+- Refactor consumer class initialization
+
 ## [3.0.0] - 2024-09-04
 
 ## BREAKING
@@ -25,6 +37,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 - Support consumer group mappers to support backward compatibility of consumer group naming
 
+## [2.8.0] - 2024-09-09
+
+### Fixed
+
+- Refactor consumer class initialization
+
 ## [2.7.1] - 2024-08-01
 
 ### Fixed

data/lib/sbmt/kafka_consumer/base_consumer.rb

@@ -3,15 +3,20 @@
 module Sbmt
   module KafkaConsumer
     class BaseConsumer < Karafka::BaseConsumer
-      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))
+      class_attribute :skip_on_error, instance_writer: false, default: false
+      class_attribute :middlewares, instance_writer: false, default: []
 
+      def self.consumer_klass(skip_on_error: nil, middlewares: nil)
+        klass = Class.new(self) do
           def self.name
             superclass.name
           end
         end
+
+        # defaults are set in class_attribute definition
+        klass.skip_on_error = skip_on_error if skip_on_error
+        klass.middlewares = middlewares.map(&:constantize) if middlewares
+        klass
       end
 
       def consume
@@ -40,9 +45,7 @@ module Sbmt
 
       def with_instrumentation(message)
         logger.tagged(
-          trace_id: trace_id,
-          topic: message.metadata.topic, partition: message.metadata.partition,
-          key: message.metadata.key, offset: message.metadata.offset
+          trace_id: trace_id
         ) do
           ::Sbmt::KafkaConsumer.monitor.instrument(
             "consumer.consumed_one",
@@ -112,14 +115,6 @@ module Sbmt
         end
       end
 
-      def skip_on_error
-        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

data/lib/sbmt/kafka_consumer/inbox_consumer.rb

@@ -6,17 +6,20 @@ 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, 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
-          end
-        end
+      class_attribute :inbox_item_class, instance_writer: false, default: nil
+      class_attribute :event_name, instance_writer: false, default: nil
+
+      def self.consumer_klass(inbox_item:, event_name: nil, skip_on_error: nil, name: nil, middlewares: nil)
+        # defaults are set in class_attribute definition
+        klass = super(skip_on_error: skip_on_error, middlewares: middlewares)
+        klass.inbox_item_class = inbox_item.constantize
+        klass.event_name = event_name if event_name
+        klass
+      end
+
+      def initialize
+        raise Sbmt::KafkaConsumer::Error, "inbox_item param is not set" if inbox_item_class.blank?
+        super
       end
 
       def extra_message_attrs(_message)
@@ -101,14 +104,6 @@ module Sbmt
         message.metadata.headers.fetch(IDEMPOTENCY_HEADER_NAME, nil).presence
       end
 
-      def inbox_item_class
-        @inbox_item_class ||= self.class::INBOX_ITEM_CLASS_NAME.constantize
-      end
-
-      def event_name
-        @event_name ||= self.class::EVENT_NAME
-      end
-
       def inbox_name
         inbox_item_class.box_name
       end

data/lib/sbmt/kafka_consumer/instrumentation/logger_listener.rb

@@ -20,30 +20,56 @@ module Sbmt
 
           logger.tagged(
             type: type,
+            stacktrace: log_backtrace(error),
             **tags
           ) do
             logger.error(error_message(error))
-            log_backtrace(error)
           end
         end
 
         # BaseConsumer events
         def on_consumer_consumed_one(event)
-          logger.info("Successfully consumed message in #{event.payload[:time]} ms")
+          log_with_tags(log_tags(event), "Successfully consumed message")
         end
 
         def on_consumer_mark_as_consumed(event)
-          logger.info("Processing message in #{event.payload[:time]} ms")
+          log_with_tags(log_tags(event), "Processing message")
         end
 
         def on_consumer_process_message(event)
-          logger.info("Commit offset in #{event.payload[:time]} ms")
+          log_with_tags(log_tags(event), "Commit offset")
         end
 
         # InboxConsumer events
         def on_consumer_inbox_consumed_one(event)
-          logger.tagged(status: event[:status]) do
-            logger.info("Successfully consumed message with uuid: #{event[:message_uuid]} in #{event.payload[:time]} ms")
+          log_tags = log_tags(event).merge!(status: event[:status])
+          msg = "Successfully consumed message with uuid: #{event[:message_uuid]}"
+
+          log_with_tags(log_tags, msg)
+        end
+
+        private
+
+        def log_tags(event)
+          metadata = event.payload[:message].metadata
+
+          {
+            kafka: {
+              topic: metadata.topic,
+              partition: metadata.partition,
+              key: metadata.key,
+              offset: metadata.offset,
+              consumer_group: event.payload[:caller].topic.consumer_group.id,
+              consume_duration_ms: event.payload[:time]
+            }
+          }
+        end
+
+        def log_with_tags(log_tags, msg)
+          return unless logger.respond_to?(:tagged)
+
+          logger.tagged(log_tags) do
+            logger.send(:info, msg)
           end
         end
       end

data/lib/sbmt/kafka_consumer/testing/shared_contexts/with_sbmt_karafka_consumer.rb

@@ -16,9 +16,8 @@ RSpec.shared_context "with sbmt karafka consumer" do
   let(:kafka_client) { instance_double(Karafka::Connection::Client) }
   let(:null_deserializer) { Sbmt::KafkaConsumer::Serialization::NullDeserializer.new }
 
-  let(:consumer) {
-    build_consumer(described_class.new)
-  }
+  let(:consumer_class) { described_class.consumer_klass }
+  let(:consumer) { build_consumer(consumer_class.new) }
 
   before {
     Sbmt::KafkaConsumer::ClientConfigurer.configure!

data/lib/sbmt/kafka_consumer/version.rb

@@ -2,6 +2,6 @@
 
 module Sbmt
   module KafkaConsumer
-    VERSION = "3.0.0"
+    VERSION = "3.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sbmt-kafka_consumer
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Kuper Ruby-Platform Team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-05 00:00:00.000000000 Z
+date: 2024-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -565,7 +565,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Ruby gem for consuming Kafka messages