deimos-ruby 1.22.2 → 1.22.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5aa472d5bdd8c86fe0502451f7554598d189fa0d5004603d8970561feed38d9f
-  data.tar.gz: 669d564cb23fccc41a9b5a3dd37c49a17787adf7fcecd486746f9d91031d8367
+  metadata.gz: 8204d945b6997589a67a4c8df92ad9d6b5a6d626d16ac7425e640e0f0b30e8f4
+  data.tar.gz: 364be699486b78896319d4a79cb61288b25cf0ac35078fa263b75547db19d68e
 SHA512:
-  metadata.gz: 3f49565845478349949d7dd5909b7d276590f91201d0848123c42a0b433114ce2a31cda8a0d43058f6f3f76114d3dfc1d32b8ee53a2a291588865ed5aaa8a8ec
-  data.tar.gz: 295802ba93bbf1e8a9c6ca95ac1944b85d3676881c3cb37854f883d42630f68f11a8971527611f1bf1c4681e5b8fab4aa202c1bcd2b1863296236b9a175bd253
+  metadata.gz: ff2f512454da6f4ac478e793ff228e35fac87e7a3c1b58431b6e137672d57014f1ae5dc7cb2d46515481137e9a6ac0a4549950925d802023a224e74b4a1b4d82
+  data.tar.gz: 73551186d75d2192c0e13dee3647516ae4315fabc42ab73cd27c2c550d7e7fc759ca8897b8e988e5f608d1915097c3c27f69092a002e8b93cf967bf374c2b4ba

data/CHANGELOG.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## UNRELEASED
 
+# 1.22.4 - 2023-07-05
+- Feature: Add support for message headers.
+
+# 1.22.3 - 2023-06-13
+
+- Fix: Don't update last_sent to current time on every poll.
+- Feature: Allow for infinite retries in DB poller.
+
 # 1.22.2 - 2023-05-10
 - Feature: Add `DEIMOS_TASK_NAME` env variable when running a task (consumer, DB poller, DB producer).
 

data/README.md

@@ -123,6 +123,7 @@ class MyProducer < Deimos::Producer
       }
       # You can also publish an array with self.publish_list(payloads)
       # You may specify the topic here with self.publish(payload, topic: 'my-topic')
+      # You may also specify the headers here with self.publish(payload, headers: { 'foo' => 'bar' })
       self.publish(payload)
     end
     
@@ -1171,13 +1172,14 @@ end
                             
 # A matcher which allows you to test that a message was sent on the given
 # topic, without having to know which class produced it.                         
-expect(topic_name).to have_sent(payload, key=nil)
+expect(topic_name).to have_sent(payload, key=nil, partition_key=nil, headers=nil)
 
 # Inspect sent messages
 message = Deimos::Backends::Test.sent_messages[0]
 expect(message).to eq({
   message: {'some-key' => 'some-value'},
   topic: 'my-topic',
+  headers: { 'foo' => 'bar' },
   key: 'my-id'
 })
 ```

data/lib/deimos/backends/base.rb

@@ -37,6 +37,10 @@ module Deimos
             log_message.merge!(
               payloads_count: messages.count
             )
+          when :headers
+            log_message.merge!(
+              payload_headers: messages.map(&:headers)
+            )
           else
             log_message.merge!(
               payloads: messages.map do |message|

data/lib/deimos/config/configuration.rb

@@ -474,7 +474,8 @@ module Deimos # rubocop:disable Metrics/ModuleLength
       # time, it will run again immediately and the timeout
       # will be pushed to the next e.g. 1 minute.
       setting :run_every, 60
-      # The number of times to retry production when encountering a *non-Kafka* error.
+      # The number of times to retry production when encountering a *non-Kafka* error. Set to nil
+      # for infinite retries.
       setting :retries, 1
       # Amount of time, in seconds, to wait before catching updates, to allow transactions
       # to complete but still pick up the right records. Should only be set for time-based mode.

data/lib/deimos/message.rb

@@ -7,6 +7,8 @@ module Deimos
     attr_accessor :payload
     # @return [Hash, String, Integer]
     attr_accessor :key
+    # @return [Hash]
+    attr_accessor :headers
     # @return [Integer]
     attr_accessor :partition_key
     # @return [String]
@@ -23,11 +25,12 @@ module Deimos
     # @param topic [String]
     # @param key [String, Integer, Hash]
     # @param partition_key [Integer]
-    def initialize(payload, producer, topic: nil, key: nil, partition_key: nil)
+    def initialize(payload, producer, topic: nil, key: nil, headers: nil, partition_key: nil)
       @payload = payload&.with_indifferent_access
       @producer_name = producer&.name
       @topic = topic
       @key = key
+      @headers = headers&.with_indifferent_access
       @partition_key = partition_key
     end
 
@@ -59,13 +62,14 @@ module Deimos
       {
         topic: @topic,
         key: @encoded_key,
+        headers: @headers,
         partition_key: @partition_key || @encoded_key,
         payload: @encoded_payload,
         metadata: {
           decoded_payload: @payload,
           producer_name: @producer_name
         }
-      }
+      }.delete_if { |k, v| k == :headers && v.nil? }
     end
 
     # @return [Hash]
@@ -73,13 +77,14 @@ module Deimos
       {
         topic: @topic,
         key: @key,
+        headers: @headers,
         partition_key: @partition_key || @key,
         payload: @payload,
         metadata: {
           decoded_payload: @payload,
           producer_name: @producer_name
         }
-      }
+      }.delete_if { |k, v| k == :headers && v.nil? }
     end
 
     # @param other [Message]

data/lib/deimos/producer.rb

@@ -95,9 +95,10 @@ module Deimos
       # Publish the payload to the topic.
       # @param payload [Hash, SchemaClass::Record] with an optional payload_key hash key.
       # @param topic [String] if specifying the topic
+      # @param headers [Hash] if specifying headers
       # @return [void]
-      def publish(payload, topic: self.topic)
-        publish_list([payload], topic: topic)
+      def publish(payload, topic: self.topic, headers: nil)
+        publish_list([payload], topic: topic, headers: headers)
       end
 
       # Publish a list of messages.
@@ -107,8 +108,9 @@ module Deimos
       # @param force_send [Boolean] if true, ignore the configured backend
       # and send immediately to Kafka.
       # @param topic [String] if specifying the topic
+      # @param headers [Hash] if specifying headers
       # @return [void]
-      def publish_list(payloads, sync: nil, force_send: false, topic: self.topic)
+      def publish_list(payloads, sync: nil, force_send: false, topic: self.topic, headers: nil)
         return if Deimos.config.kafka.seed_brokers.blank? ||
                   Deimos.config.producers.disabled ||
                   Deimos.producers_disabled?(self)
@@ -122,7 +124,7 @@ module Deimos
           topic: topic,
           payloads: payloads
         ) do
-          messages = Array(payloads).map { |p| Deimos::Message.new(p.to_h, self) }
+          messages = Array(payloads).map { |p| Deimos::Message.new(p.to_h, self, headers: headers) }
           messages.each { |m| _process_message(m, topic) }
           messages.in_groups_of(MAX_BATCH_SIZE, false) do |batch|
             self.produce_batch(backend_class, batch)

data/lib/deimos/test_helpers.rb

@@ -133,7 +133,7 @@ module Deimos
       str + "\nAll Messages received:\n#{message_string}"
     end
 
-    RSpec::Matchers.define :have_sent do |msg, key=nil, partition_key=nil|
+    RSpec::Matchers.define :have_sent do |msg, key=nil, partition_key=nil, headers=nil|
       message = if msg.respond_to?(:with_indifferent_access)
                   msg.with_indifferent_access
                 else
@@ -147,7 +147,14 @@ module Deimos
                             m[:payload]&.with_indifferent_access) &&
             topic == m[:topic] &&
             (key.present? ? key == m[:key] : true) &&
-            (partition_key.present? ? partition_key == m[:partition_key] : true)
+            (partition_key.present? ? partition_key == m[:partition_key] : true) &&
+            if headers.present?
+              hash_matcher.send(:match,
+                                headers&.with_indifferent_access,
+                                m[:headers]&.with_indifferent_access)
+            else
+              true
+            end
         end
       end
 

data/lib/deimos/utils/db_poller/base.rb

@@ -124,7 +124,7 @@ module Deimos
             retry
           rescue StandardError => e
             Deimos.config.logger.error("Error publishing through DB poller: #{e.message}}")
-            if retries < @config.retries
+            if @config.retries.nil? || retries < @config.retries
               retries += 1
               sleep(0.5)
               retry

data/lib/deimos/utils/db_poller/state_based.rb

@@ -12,20 +12,23 @@ module Deimos
         def process_updates
           Deimos.config.logger.info("Polling #{log_identifier}")
           status = PollStatus.new(0, 0, 0)
+          first_batch = true
 
           # poll_query gets all the relevant data from the database, as defined
           # by the producer itself.
           loop do
             Deimos.config.logger.debug("Polling #{log_identifier}, batch #{status.current_batch}")
             batch = fetch_results.to_a
-            if batch.empty?
-              @info.touch(:last_sent)
-              break
-            end
+            break if batch.empty?
 
+            first_batch = false
             success = process_batch_with_span(batch, status)
             finalize_batch(batch, success)
           end
+
+          # If there were no results at all, we update last_sent so that we still get a wait
+          # before the next poll.
+          @info.touch(:last_sent) if first_batch
           Deimos.config.logger.info("Poll #{log_identifier} complete (#{status.report}")
         end
 

data/lib/deimos/utils/db_poller/time_based.rb

@@ -30,20 +30,23 @@ module Deimos
           time_to = Time.zone.now - @config.delay_time
           Deimos.config.logger.info("Polling #{log_identifier} from #{time_from} to #{time_to}")
           status = PollStatus.new(0, 0, 0)
+          first_batch = true
 
           # poll_query gets all the relevant data from the database, as defined
           # by the producer itself.
           loop do
             Deimos.config.logger.debug("Polling #{log_identifier}, batch #{status.current_batch}")
             batch = fetch_results(time_from, time_to).to_a
-            if batch.empty?
-              @info.touch(:last_sent)
-              break
-            end
+            break if batch.empty?
 
+            first_batch = false
             process_and_touch_info(batch, status)
             time_from = last_updated(batch.last)
           end
+
+          # If there were no results at all, we update last_sent so that we still get a wait
+          # before the next poll.
+          @info.touch(:last_sent) if first_batch
           Deimos.config.logger.info("Poll #{log_identifier} complete at #{time_to} (#{status.report})")
         end
 

data/lib/deimos/version.rb

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

data/lib/deimos.rb

@@ -23,7 +23,6 @@ require 'deimos/utils/schema_class'
 require 'deimos/schema_class/enum'
 require 'deimos/schema_class/record'
 
-require 'deimos/monkey_patches/phobos_producer'
 require 'deimos/monkey_patches/phobos_cli'
 
 require 'deimos/railtie' if defined?(Rails)

data/spec/message_spec.rb

@@ -16,4 +16,24 @@ RSpec.describe(Deimos::Message) do
     expect { described_class.new({ a: 1, b: 2 }, nil, key: { c: 3, d: 4 }) }.
       not_to raise_exception
   end
+
+  describe 'headers' do
+    it 'returns nil when not set' do
+      expect(described_class.new({ v: 'val1' }, nil, key: 'key1')).
+        to have_attributes(headers: nil)
+    end
+
+    it 'can set and get headers' do
+      expect(described_class.new({ v: 'val1' }, nil, key: 'key1', headers: { a: 1 })).
+        to have_attributes(headers: { a: 1 })
+    end
+
+    it 'includes headers when converting to Hash' do
+      expect(described_class.new({ v: 'val1' }, nil, key: 'key1', headers: { a: 1 }).to_h).
+        to include(headers: { a: 1 })
+
+      expect(described_class.new({ v: 'val1' }, nil, key: 'key1', headers: { a: 1 }).encoded_hash).
+        to include(headers: { a: 1 })
+    end
+  end
 end

data/spec/producer_spec.rb

@@ -110,18 +110,20 @@ module ProducerTest
       expect('my-topic').not_to have_sent('test_id' => 'foo2', 'some_int' => 123)
     end
 
-    it 'should allow setting the topic from publish_list' do
+    it 'should allow setting the topic and headers from publish_list' do
       expect(described_class).to receive(:produce_batch).once.with(
         Deimos::Backends::Test,
         [
           Deimos::Message.new({ 'test_id' => 'foo', 'some_int' => 123 },
                               MyProducer,
                               topic: 'a-new-topic',
+                              headers: { 'foo' => 'bar' },
                               partition_key: 'foo',
                               key: 'foo'),
           Deimos::Message.new({ 'test_id' => 'bar', 'some_int' => 124 },
                               MyProducer,
                               topic: 'a-new-topic',
+                              headers: { 'foo' => 'bar' },
                               partition_key: 'bar',
                               key: 'bar')
         ]
@@ -130,9 +132,10 @@ module ProducerTest
       MyProducer.publish_list(
         [{ 'test_id' => 'foo', 'some_int' => 123 },
          { 'test_id' => 'bar', 'some_int' => 124 }],
-        topic: 'a-new-topic'
+        topic: 'a-new-topic',
+        headers: { 'foo' => 'bar' }
       )
-      expect('a-new-topic').to have_sent('test_id' => 'foo', 'some_int' => 123)
+      expect('a-new-topic').to have_sent({ 'test_id' => 'foo', 'some_int' => 123 }, nil, nil, { 'foo' => 'bar' })
       expect('my-topic').not_to have_sent('test_id' => 'foo', 'some_int' => 123)
       expect('my-topic').not_to have_sent('test_id' => 'foo2', 'some_int' => 123)
     end

data/spec/utils/db_poller_spec.rb

@@ -324,13 +324,18 @@ each_db_config(Deimos::Utils::DbPoller::Base) do
         poller.process_updates
         poller.process_updates
 
-        expect(MyProducer).to have_received(:poll_query).twice.
+        expect(MyProducer).to have_received(:poll_query).
           with(time_from: time_value(secs: -1),
                time_to: time_value(secs: 120), # plus 122 seconds minus 2 seconds
                column_name: :updated_at,
                min_id: last_widget.id)
+        expect(MyProducer).to have_received(:poll_query).
+          with(time_from: time_value(secs: 122),
+               time_to: time_value(secs: 120), # yes this is weird but it's because of travel_to
+               column_name: :updated_at,
+               min_id: last_widget.id)
         expect(Deimos.config.logger).to have_received(:info).
-          with('Poll my-topic-with-id complete at 2015-05-05 00:59:58 -0400 (3 batches, 0 errored batches, 7 processed messages)')
+          with('Poll MyProducer: ["my-topic-with-id"] complete at 2015-05-05 00:59:58 -0400 (3 batches, 0 errored batches, 7 processed messages)')
       end
 
       it 'should update PollInfo timestamp after processing' do
@@ -382,7 +387,7 @@ each_db_config(Deimos::Utils::DbPoller::Base) do
           expect(info.last_sent.in_time_zone).to eq(time_value(mins: -61, secs: 30))
           expect(info.last_sent_id).to eq(widgets[6].id)
           expect(Deimos.config.logger).to have_received(:info).
-            with('Poll my-topic-with-id complete at 2015-05-05 00:59:58 -0400 (2 batches, 1 errored batches, 7 processed messages)')
+            with('Poll MyProducer: ["my-topic-with-id"] complete at 2015-05-05 00:59:58 -0400 (2 batches, 1 errored batches, 7 processed messages)')
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deimos-ruby
 version: !ruby/object:Gem::Version
-  version: 1.22.2
+  version: 1.22.4
 platform: ruby
 authors:
 - Daniel Orner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-10 00:00:00.000000000 Z
+date: 2023-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avro_turf
@@ -459,7 +459,6 @@ files:
 - lib/deimos/metrics/mock.rb
 - lib/deimos/metrics/provider.rb
 - lib/deimos/monkey_patches/phobos_cli.rb
-- lib/deimos/monkey_patches/phobos_producer.rb
 - lib/deimos/poll_info.rb
 - lib/deimos/producer.rb
 - lib/deimos/railtie.rb

data/lib/deimos/monkey_patches/phobos_producer.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-require 'phobos/producer'
-
-#@!visibility private
-module Phobos
-  module Producer
-    # :nodoc:
-    class PublicAPI
-      # :nodoc:
-      def publish(topic, payload, key=nil, partition_key=nil)
-        class_producer.publish(topic, payload, key, partition_key)
-      end
-
-      # :nodoc:
-      def async_publish(topic, payload, key=nil, partition_key=nil)
-        class_producer.async_publish(topic, payload, key, partition_key)
-      end
-    end
-
-    # :nodoc:
-    module ClassMethods
-      # :nodoc:
-      class PublicAPI
-        # :nodoc:
-        def publish(topic, payload, key=nil, partition_key=nil)
-          publish_list([{ topic: topic, payload: payload, key: key,
-                          partition_key: partition_key }])
-        end
-
-        # :nodoc:
-        def async_publish(topic, payload, key=nil, partition_key=nil)
-          async_publish_list([{ topic: topic, payload: payload, key: key,
-                                partition_key: partition_key }])
-        end
-
-      private
-
-        # :nodoc:
-        def produce_messages(producer, messages)
-          messages.each do |message|
-            partition_key = message[:partition_key] || message[:key]
-            producer.produce(message[:payload],
-                             topic: message[:topic],
-                             key: message[:key],
-                             partition_key: partition_key)
-          end
-        end
-      end
-    end
-  end
-end