deimos-ruby 2.0.13 → 2.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c18442a9ba85a0b6de4c3cdaee151727d7e7ba9ca70de8129b08a91ad1a100c
-  data.tar.gz: 7db213f9a31a8775f6f23fd10098d284df59f5dbf4b040d0719b9fa10f5af6e6
+  metadata.gz: d6c9d3bcbf085821dc0be156389bd223dbce36ba8c34ff452612cf82ca3b3be4
+  data.tar.gz: fc9bf56f6ad566a9e197e50b5b167af620e9c0d6ec0fd9f50999059b7fded6ee
 SHA512:
-  metadata.gz: 532e1eed51b376e568c1e7e9b424a65a29a7e339e8db91e3f3761328ff826e3ad45a8c12bddbb4155707610df3ab36bf90e1acfe6411b6829be6fe8e45453e75
-  data.tar.gz: 29ca80e081b8c0699ee8b132c31d7ab27eb91f63dca808a03f8c7e3905a70a7f520964abc0631995b033c7bfc72d3581dd7d5dacd93d234b970ebbc92bd99837
+  metadata.gz: 88ac68371a699744e87fcc0c7e8a1294af1b02d4ff6973f95c1667c3754ac8fd0eeda65afddd966a4451058028409e3183e6bca112c553dbf7ac67f72929ffdd
+  data.tar.gz: 30f93b2f6aefbdf3b8554bb0a6b5bac53e6638a88adc75bdded31fde88b783ca6311fb50b652f9b8085d32da6175449181dd8229a1544018e0e1c7c51ddc158f

data/CHANGELOG.md

@@ -7,6 +7,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## UNRELEASED
 
+## 2.0.15 - 2025-05-29
+
+- Fix: Do not force data to JSON when logging payloads. This allows log formatters to handle the payloads on their own (e.g. adding additional fields).
+- Fix: Add topic to "Publishing Messages" log message.
+
+## 2.0.14 - 2025-05-26
+
+- Fix: Log actual payloads by default (was logging "null" for the payload).
+
 ## 2.0.13 - 2025-05-26
 
 - Fix: Outbox producer would crash if no Deimos producer was defined for the topic.

data/lib/deimos/backends/base.rb

@@ -9,9 +9,10 @@ module Deimos
         # @param messages [Array<Hash>]
         # @return [void]
         def publish(producer_class:, messages:)
+          topic = producer_class.topic
           execute(producer_class: producer_class, messages: messages)
           message = ::Deimos::Logging.messages_log_text(producer_class.karafka_config.payload_log, messages)
-          Deimos::Logging.log_info({message: 'Publishing Messages:'}.merge(message))
+          Deimos::Logging.log_info({message: "Publishing Messages for #{topic}:" }.merge(message))
         end
 
         # @param producer_class [Class<Deimos::Producer>]

data/lib/deimos/logging.rb

@@ -5,10 +5,10 @@ module Deimos
       def log_add(method, msg)
         if Karafka.logger.respond_to?(:tagged)
           Karafka.logger.tagged('Deimos') do |logger|
-            logger.send(method, msg.to_json)
+            logger.send(method, msg)
           end
         else
-          Karafka.logger.send(method, msg.to_json)
+          Karafka.logger.send(method, msg)
         end
       end
 
@@ -42,7 +42,7 @@ module Deimos
         if m.respond_to?(:payload)
           m.payload
         elsif m[:label]
-          m.dig(:label, :raw_payload)
+          m.dig(:label, :original_payload)
         else
           m[:payload]
         end

data/lib/deimos/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Deimos
-  VERSION = '2.0.13'
+  VERSION = '2.0.15'
 end

data/spec/producer_spec.rb

@@ -272,6 +272,50 @@ module ProducerTest
                                                       }, '456', '4561')
     end
 
+    describe 'payload logging' do
+      context 'with default / full' do
+        it 'should log full payload' do
+          allow(Karafka.logger).to receive(:info)
+          MyProducerWithID.publish_list(
+            [
+              { 'test_id' => 'foo', 'some_int' => 123, :payload_key => 'key' },
+              { 'test_id' => 'foo2', 'some_int' => 123, :payload_key => 'key2' },
+            ]
+          )
+          expect(Karafka.logger).to have_received(:info).with(match_message({
+            message: 'Publishing Messages for my-topic-with-id:',
+            payloads: [
+              {
+                payload: { 'test_id' => 'foo', 'some_int' => 123 },
+                key: 'key'
+              },
+              {
+                payload: { 'test_id' => 'foo2', 'some_int' => 123 },
+                key: 'key2'
+              }
+            ]
+          }))
+        end
+      end
+
+      context 'with count' do
+        it 'should log only count' do
+          Deimos.karafka_config_for(topic: 'my-topic-with-id').payload_log :count
+          allow(Karafka.logger).to receive(:info)
+          MyProducerWithID.publish_list(
+            [
+              { 'test_id' => 'foo', 'some_int' => 123, :payload_key => 'key' },
+              { 'test_id' => 'foo2', 'some_int' => 123, :payload_key => 'key' }
+            ]
+          )
+          expect(Karafka.logger).to have_received(:info).with(match_message({
+            message: 'Publishing Messages for my-topic-with-id:',
+            payloads_count: 2
+          }))
+        end
+      end
+    end
+
     context 'with Schema Class payloads' do
       it 'should fail on invalid message with error handler' do
         expect(Deimos::ProducerMiddleware).to receive(:call).and_raise('OH NOES')

data/spec/spec_helper.rb

@@ -343,3 +343,17 @@ RSpec.shared_context('with publish_backend') do
     end
   end
 end
+
+RSpec::Matchers.define :match_message do |msg|
+  match do |actual|
+    begin
+      return false unless actual.is_a?(Hash)
+
+      actual[:payloads]&.each do |p|
+        p[:payload].delete('timestamp')
+        p[:payload].delete('message_id')
+      end
+      expect(actual).to match(a_hash_including(msg))
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deimos-ruby
 version: !ruby/object:Gem::Version
-  version: 2.0.13
+  version: 2.0.15
 platform: ruby
 authors:
 - Daniel Orner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-26 00:00:00.000000000 Z
+date: 2025-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avro_turf