deimos-ruby 1.19.4 → 1.19.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebc86e599570ecca44db7513b6867291ab15dc40e1d0449874bace006560905c
-  data.tar.gz: 3d840e13761a83f44ea03babbe55956367e490efdb22c15e4fa969f2621e715e
+  metadata.gz: 6be8380428e48dd415fd6ec606832fab6204a280effc65e65e967ef72dca1c32
+  data.tar.gz: 1096e0da58a961c3875b5d8545a6c226ba60ebacd5c60639f09acce4dcb73374
 SHA512:
-  metadata.gz: ef1ad52fedf17ebc3310ea4921072a2480c1c651168ab4f78c4522332e28580a82d17e63129b4fc1fb03c46df64433f9c8e2fb96bf79d7148c9852ef58a0a1ae
-  data.tar.gz: bfa9b9ca8d2685ff98e715d98f60e845c8d360799e996b578fb47f8e86027c7c2d8ee4f79c29c479b37390bf20abe6089598887ed8d73216cbd716b123dcf170
+  metadata.gz: 7770d8bf7eb8c9b1db538891a025586411c24c076cfe49474e312ca859386366d24cf57007c0e1230fa98dd2aa17ca3b0fc1c0f9324003918a7df00e0738944f
+  data.tar.gz: '02019bdab7dd827f9373de64250c10119ab56dcf441369f3bec7c023e3c524f403fcdb35202c4e92cdfa0b66175ca17905c86ab407cc8f45fea49bad1d33c6b5'

data/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## UNRELEASED
 
+# 1.19.5 - 2023-03-29
+
+- Feature: add additional setting to Deimos.config - payload_log
+
 # 1.19.4 - 2023-03-23
 
 - Feature: Limit amount of transactions in a single database call with `max_db_batch_size`

data/docs/CONFIGURATION.md

@@ -10,12 +10,13 @@ Nested configuration is denoted in simple dot notation:
 configurations.
 
 ## Base Configuration
-Config name|Default|Description
------------|-------|-----------
-logger|`Logger.new(STDOUT)`|The logger that Deimos will use.
-phobos_logger|`Deimos.config.logger`|The logger passed to Phobos.
-metrics|`Deimos::Metrics::Mock.new`|The metrics backend use for reporting.
-tracer|`Deimos::Tracing::Mock.new`|The tracer backend used for debugging.
+Config name| Default                     |Description
+-----------|-----------------------------|-----------
+logger| `Logger.new(STDOUT)`        |The logger that Deimos will use.
+payload_log| `:full`                     |Determines how much data is logged per payload.</br>`:full` - all keys and payloads are logged.</br>`:keys` - only keys are logged.</br>`:count` - only the total count of messages are logged.
+phobos_logger| `Deimos.config.logger`      |The logger passed to Phobos.
+metrics| `Deimos::Metrics::Mock.new` |The metrics backend use for reporting.
+tracer| `Deimos::Tracing::Mock.new` |The tracer backend used for debugging.
 
 ## Defining Producers
 

data/lib/deimos/backends/base.rb

@@ -9,16 +9,7 @@ module Deimos
         # @param messages [Array<Deimos::Message>]
         # @return [void]
         def publish(producer_class:, messages:)
-          Deimos.config.logger.info(
-            message: 'Publishing messages',
-            topic: messages.first&.topic,
-            payloads: messages.map do |message|
-              {
-                payload: message.payload,
-                key: message.key
-              }
-            end
-          )
+          Deimos.config.logger.info(log_message(messages))
           execute(producer_class: producer_class, messages: messages)
         end
 
@@ -28,6 +19,37 @@ module Deimos
         def execute(producer_class:, messages:)
           raise NotImplementedError
         end
+
+      private
+
+        def log_message(messages)
+          log_message = {
+            message: 'Publishing messages',
+            topic: messages.first&.topic
+          }
+
+          case Deimos.config.payload_log
+          when :keys
+            log_message.merge!(
+              payload_keys: messages.map(&:key)
+            )
+          when :count
+            log_message.merge!(
+              payloads_count: messages.count
+            )
+          else
+            log_message.merge!(
+              payloads: messages.map do |message|
+                {
+                  payload: message.payload,
+                  key: message.key
+                }
+              end
+            )
+          end
+
+          log_message
+        end
       end
     end
   end

data/lib/deimos/config/configuration.rb

@@ -95,6 +95,9 @@ module Deimos
     # @return [Logger]
     setting :logger, Logger.new(STDOUT)
 
+    # @return [Symbol]
+    setting :payload_log, :full
+
     # @return [Logger]
     setting :phobos_logger, default_proc: proc { Deimos.config.logger.clone }
 

data/lib/deimos/test_helpers.rb

@@ -143,7 +143,7 @@ module Deimos
         Deimos::Backends::Test.sent_messages.any? do |m|
           hash_matcher = RSpec::Matchers::BuiltIn::Match.new(message)
           hash_matcher.send(:match,
-                            message.to_h,
+                            message&.respond_to?(:to_h) ? message.to_h : message,
                             m[:payload]&.with_indifferent_access) &&
             topic == m[:topic] &&
             (key.present? ? key == m[:key] : true) &&

data/lib/deimos/version.rb

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

data/spec/backends/base_spec.rb

@@ -7,4 +7,28 @@ RSpec.describe Deimos::Backends::Base do
       with(messages: messages, producer_class: MyProducer)
     described_class.publish(producer_class: MyProducer, messages: messages)
   end
+
+  describe 'payload_log method' do
+    it 'should return whole payload (default behavior)' do
+      log_message = described_class.send(:log_message, messages)
+      expect(log_message[:payloads].count).to eq(3)
+      expect(log_message[:payloads].first[:payload]).to eq({ 'foo' => 1 })
+      expect(log_message[:payloads].first[:key]).to eq('foo1')
+    end
+
+    it 'should return only keys of messages' do
+      Deimos.config.payload_log = :keys
+      log_message = described_class.send(:log_message, messages)
+      expect(log_message[:payload_keys].count).to eq(3)
+      expect(log_message[:payload_keys]).to be_a(Array)
+      expect(log_message[:payload_keys].first).to eq('foo1')
+    end
+
+    it 'should return only messages count' do
+      Deimos.config.payload_log = :count
+      log_message = described_class.send(:log_message, messages)
+      expect(log_message[:payloads_count]).to be_a(Integer)
+      expect(log_message[:payloads_count]).to eq(3)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deimos-ruby
 version: !ruby/object:Gem::Version
-  version: 1.19.4
+  version: 1.19.5
 platform: ruby
 authors:
 - Daniel Orner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-23 00:00:00.000000000 Z
+date: 2023-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avro_turf