deimos-ruby 1.22.4 → 1.22.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8204d945b6997589a67a4c8df92ad9d6b5a6d626d16ac7425e640e0f0b30e8f4
-  data.tar.gz: 364be699486b78896319d4a79cb61288b25cf0ac35078fa263b75547db19d68e
+  metadata.gz: 997678ce4ed796037a0f554a7d0897a9ab58f810f437573da7684a6c23fa5d40
+  data.tar.gz: e13fc14fb0bf985a02c38ff628a527198aa1e3bbf1eaab52510ea63832a03f37
 SHA512:
-  metadata.gz: ff2f512454da6f4ac478e793ff228e35fac87e7a3c1b58431b6e137672d57014f1ae5dc7cb2d46515481137e9a6ac0a4549950925d802023a224e74b4a1b4d82
-  data.tar.gz: 73551186d75d2192c0e13dee3647516ae4315fabc42ab73cd27c2c550d7e7fc759ca8897b8e988e5f608d1915097c3c27f69092a002e8b93cf967bf374c2b4ba
+  metadata.gz: 90062c59b953e4fff9b1f5ddb0c5107e08f98028a7e221c78637bd9cb57c8d13c081a7417dedad57274e4b2df470a58d31ed5a1a1fd985f853ecca9ab53527fc
+  data.tar.gz: fa07d49754b91fdfc48fd6edb46a1906f057ddbd9d0b11d0a66d14382ae1907a0ff7fbd2526e4653e6fc74ed53e78db78203fc043621111193fca370e50da777

data/CHANGELOG.md

@@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## UNRELEASED
 
+# 1.22.5 - 2023-07-18
+- Fix: Fixed buffer overflow crash with DB producer.
+
 # 1.22.4 - 2023-07-05
 - Feature: Add support for message headers.
 

data/lib/deimos/kafka_message.rb

@@ -39,11 +39,12 @@ module Deimos
     def self.decoded(messages=[])
       return [] if messages.empty?
 
-      decoder = self.decoder(messages.first.topic)&.new
+      decoder_class = self.decoder(messages.first.topic)
+      decoder = decoder_class&.new
       messages.map do |m|
         {
           key: m.key.present? ? decoder&.decode_key(m.key) || m.key : nil,
-          payload: decoder&.decoder&.decode(m.message) || m.message
+          payload: decoder_class&.decoder&.decode(m.message) || m.message
         }
       end
     end

data/lib/deimos/utils/db_producer.rb

@@ -97,11 +97,16 @@ module Deimos
         Deimos.instrument('db_producer.produce', topic: @current_topic, messages: compacted_messages) do
           begin
             produce_messages(compacted_messages.map(&:phobos_message))
-          rescue Kafka::BufferOverflow, Kafka::MessageSizeTooLarge, Kafka::RecordListTooLarge
+          rescue Kafka::BufferOverflow, Kafka::MessageSizeTooLarge, Kafka::RecordListTooLarge => e
             delete_messages(messages)
             @logger.error('Message batch too large, deleting...')
-            @logger.error(Deimos::KafkaMessage.decoded(messages))
-            raise
+            begin
+              @logger.error(Deimos::KafkaMessage.decoded(messages))
+            rescue StandardError => logging_exception # rubocop:disable Naming/RescuedExceptionsVariableName
+              @logger.error("Large message details logging failure: #{logging_exception.message}")
+            ensure
+              raise e
+            end
           end
         end
         delete_messages(messages)

data/lib/deimos/version.rb

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

data/spec/utils/db_producer_spec.rb

@@ -2,12 +2,13 @@
 
 each_db_config(Deimos::Utils::DbProducer) do
   let(:producer) do
-    producer = described_class.new
+    producer = described_class.new(logger)
     allow(producer).to receive(:sleep)
     allow(producer).to receive(:producer).and_return(phobos_producer)
     producer
   end
 
+  let(:logger) { nil }
   let(:phobos_producer) do
     pp = instance_double(Phobos::Producer::PublicAPI)
     allow(pp).to receive(:publish_list)
@@ -308,35 +309,6 @@ each_db_config(Deimos::Utils::DbProducer) do
       Deimos.unsubscribe(subscriber)
     end
 
-    it 'should delete messages on buffer overflow' do
-      messages = (1..4).map do |i|
-        Deimos::KafkaMessage.create!(
-          id: i,
-          topic: 'my-topic',
-          message: "mess#{i}",
-          partition_key: "key#{i}"
-        )
-      end
-      (5..8).each do |i|
-        Deimos::KafkaMessage.create!(
-          id: i,
-          topic: 'my-topic2',
-          message: "mess#{i}",
-          partition_key: "key#{i}"
-        )
-      end
-
-      expect(Deimos::KafkaTopicInfo).to receive(:lock).
-        with('my-topic', 'abc').and_return(true)
-      expect(producer).to receive(:produce_messages).and_raise(Kafka::BufferOverflow)
-      expect(producer).to receive(:retrieve_messages).and_return(messages)
-      expect(Deimos::KafkaTopicInfo).to receive(:register_error)
-
-      expect(Deimos::KafkaMessage.count).to eq(8)
-      producer.process_topic('my-topic')
-      expect(Deimos::KafkaMessage.count).to eq(4)
-    end
-
     it 'should retry deletes and not re-publish' do
       messages = (1..4).map do |i|
         Deimos::KafkaMessage.create!(
@@ -388,6 +360,102 @@ each_db_config(Deimos::Utils::DbProducer) do
       expect { producer.delete_messages(messages) }.to raise_exception('OH NOES')
     end
 
+    context 'with buffer overflow exception' do
+      let(:messages) do
+        (1..4).map do |i|
+          Deimos::KafkaMessage.create!(
+            id: i,
+            key: i,
+            topic: 'my-topic',
+            message: { message: "mess#{i}" },
+            partition_key: "key#{i}"
+          )
+        end
+      end
+      let(:logger) do
+        logger = instance_double(Logger)
+        allow(logger).to receive(:error)
+        logger
+      end
+      let(:message_producer) do
+        Deimos.config.schema.backend = :mock
+        Deimos::ActiveRecordProducer.topic('my-topic')
+        Deimos::ActiveRecordProducer.key_config
+        Deimos::ActiveRecordProducer
+      end
+
+      around(:each) do |example|
+        config = Deimos::ActiveRecordProducer.config.clone
+        backend = Deimos.config.schema.backend
+
+        example.run
+      ensure
+        Deimos::ActiveRecordProducer.instance_variable_set(:@config, config)
+        Deimos.config.schema.backend = backend
+      end
+
+      before(:each) do
+        message_producer
+        (5..8).each do |i|
+          Deimos::KafkaMessage.create!(
+            id: i,
+            topic: 'my-topic2',
+            message: "mess#{i}",
+            partition_key: "key#{i}"
+          )
+        end
+        allow(Deimos::KafkaTopicInfo).to receive(:lock).
+          with('my-topic', 'abc').and_return(true)
+        allow(producer).to receive(:produce_messages).and_raise(Kafka::BufferOverflow)
+        allow(producer).to receive(:retrieve_messages).and_return(messages)
+        allow(Deimos::KafkaTopicInfo).to receive(:register_error)
+      end
+
+      it 'should delete messages on buffer overflow' do
+        expect(Deimos::KafkaMessage.count).to eq(8)
+        producer.process_topic('my-topic')
+        expect(Deimos::KafkaMessage.count).to eq(4)
+      end
+
+      it 'should notify on buffer overflow' do
+        subscriber = Deimos.subscribe('db_producer.produce') do |event|
+          expect(event.payload[:exception_object].message).to eq('Kafka::BufferOverflow')
+          expect(event.payload[:messages]).to eq(messages)
+        end
+        producer.process_topic('my-topic')
+        Deimos.unsubscribe(subscriber)
+        expect(logger).to have_received(:error).with('Message batch too large, deleting...')
+        expect(logger).to have_received(:error).with(
+          [
+            { key: '1', payload: 'payload-decoded' },
+            { key: '2', payload: 'payload-decoded' },
+            { key: '3', payload: 'payload-decoded' },
+            { key: '4', payload: 'payload-decoded' }
+          ]
+        )
+      end
+
+      context 'with exception on error logging attempt' do
+        let(:message_producer) do
+          Deimos::ActiveRecordProducer.topic('my-topic')
+          Deimos::ActiveRecordProducer
+        end
+
+        it 'should notify on buffer overflow disregarding decoding exception' do
+          subscriber = Deimos.subscribe('db_producer.produce') do |event|
+            expect(event.payload[:exception_object].message).to eq('Kafka::BufferOverflow')
+            expect(event.payload[:messages]).to eq(messages)
+          end
+          producer.process_topic('my-topic')
+          Deimos.unsubscribe(subscriber)
+          expect(logger).to have_received(:error).with('Message batch too large, deleting...')
+          expect(logger).to have_received(:error).with(
+            'Large message details logging failure: '\
+            'No key config given - if you are not decoding keys, please use `key_config plain: true`'
+          )
+        end
+      end
+    end
   end
 
   describe '#send_pending_metrics' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deimos-ruby
 version: !ruby/object:Gem::Version
-  version: 1.22.4
+  version: 1.22.5
 platform: ruby
 authors:
 - Daniel Orner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-05 00:00:00.000000000 Z
+date: 2023-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avro_turf