deimos-ruby 2.0.3 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fac86a45a84b2698c358a6c94476567047ef006b53dcf4cfd005451d9f78a10
-  data.tar.gz: b547072ec4e0c9bb18880a497e28d567169da144397bba748d65f5bcf2b53e17
+  metadata.gz: 277d2715eefd6d0ddc262ee4e514fe3df2542aacf13c60854f66f326a46664ae
+  data.tar.gz: 6a5b890b14258eeba1d08b9e84f146030a7c9f37784008a8840311dbafca49a1
 SHA512:
-  metadata.gz: 2e871a8e7aa75c568f6c8cfd0fadce2acf955d6703842b784385d32f55f579f4f239924c589066d088dd9dc3bc88e789e4597494aabc4c61bf6fc37979cca5c6
-  data.tar.gz: a595322011ec7bda0d80d6bad141c0dfbcc49dff3609c15299d3ad7ff9fab225cb8063343fdcab2443ac7bde60dc4e16557568912a0df8d630b9b65266df9e4e
+  metadata.gz: e8c0f52c88c5106c8a22acb6a15f7e850b307aa8e34aa5ac5cc140a1bd7d10cebc891ad5ac26d386ecc8f76e080c53791e9a5d841dc1db56a170df49fc596daf
+  data.tar.gz: b2f50f1d14dd55330a78159645bc335e82217ce59284066cd02f37e98cc66d932bf8ff78ae54d01f942602cf1759ab513239a90898042a400d4047c55dbc11e2

data/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## UNRELEASED
 
+## 2.0.4 - 2025-03-17
+
+- Feature: Added `producers.truncate_columns` config.
+
 ## 2.0.3 - 2025-03-12
 - Fix: `ActiveRecordProducer.config` could crash if there were non-producer configs.
 

data/docs/CONFIGURATION.md

@@ -43,11 +43,12 @@ things you need to reference into local variables before calling `configure`.
 
 ### Producer Configuration
 
-| Config name            | Default        | Description                                                                                                                                                                                    |
-|------------------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| producers.topic_prefix | nil            | Add a prefix to all topic names. This can be useful if you're using the same Kafka broker for different environments that are producing the same topics.                                       |
-| producers.disabled     | false          | Disable all actual message producing. Generally more useful to use the `disable_producers` method instead.                                                                                     |
-| producers.backend      | `:kafka_async` | Currently can be set to `:db`, `:kafka`, or `:kafka_async`. If using Kafka directly, a good pattern is to set to async in your user-facing app, and sync in your consumers or delayed workers. |
+| Config name                | Default        | Description                                                                                                                                                                                    |
+|----------------------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| producers.topic_prefix     | nil            | Add a prefix to all topic names. This can be useful if you're using the same Kafka broker for different environments that are producing the same topics.                                       |
+| producers.disabled         | false          | Disable all actual message producing. Generally more useful to use the `disable_producers` method instead.                                                                                     |
+| producers.backend          | `:kafka_async` | Currently can be set to `:db`, `:kafka`, or `:kafka_async`. If using Kafka directly, a good pattern is to set to async in your user-facing app, and sync in your consumers or delayed workers. |
+| producers.truncate_columns | false          | If set to true, will truncate values to their database limits when using KafkaSource.                                                                                                          |
 
 ### Schema Configuration
 

data/lib/deimos/config/configuration.rb

@@ -133,6 +133,10 @@ module Deimos # rubocop:disable Metrics/ModuleLength
       # sync in your consumers or delayed workers.
       # @return [Symbol]
       setting :backend, :kafka_async
+
+      # If set to true, KafkaSource will automatically truncate fields to match the column
+      # length in the database.
+      setting :truncate_columns
     end
 
     setting :schema do

data/lib/deimos/kafka_source.rb

@@ -6,10 +6,6 @@ module Deimos
   module KafkaSource
     extend ActiveSupport::Concern
 
-    # @return [String]
-    DEPRECATION_WARNING = 'The kafka_producer interface will be deprecated ' \
-        'in future releases. Please use kafka_producers instead.'
-
     included do
       after_create(:send_kafka_event_on_create)
       after_update(:send_kafka_event_on_update)
@@ -22,6 +18,7 @@ module Deimos
       return unless self.persisted?
       return unless self.class.kafka_config[:create]
 
+      self.truncate_columns if Deimos.config.producers.truncate_columns
       self.class.kafka_producers.each { |p| p.send_event(self) }
     end
 
@@ -39,6 +36,7 @@ module Deimos
         field_change.present? && field_change[0] != field_change[1]
       end
       return unless any_changes
+      self.truncate_columns if Deimos.config.producers.truncate_columns
 
       producers.each { |p| p.send_event(self) }
     end
@@ -124,5 +122,17 @@ module Deimos
         results
       end
     end
+
+    # check if any field has value longer than the field limit
+    def truncate_columns
+      self.class.columns.each do |col|
+        next unless col.type == :string
+        next if self[col.name].blank?
+        if self[col.name].to_s.length > col.limit
+          self[col.name] = self[col.name][0..col.limit - 1]
+        end
+      end
+      false
+    end
   end
 end

data/lib/deimos/version.rb

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

data/spec/kafka_source_spec.rb

@@ -10,7 +10,7 @@ module KafkaSourceSpec
         t.integer(:widget_id)
         t.string(:description)
         t.string(:model_id, default: '')
-        t.string(:name)
+        t.string(:name, limit: 100)
         t.timestamps
       end
       ActiveRecord::Base.connection.add_index(:widgets, :widget_id)
@@ -105,6 +105,54 @@ module KafkaSourceSpec
       expect('my-topic-the-second').to have_sent(nil, widget.id)
     end
 
+    context 'with truncation off' do
+      before(:each) do
+        Deimos.config.producers.truncate_columns = false
+      end
+      it 'should not truncate values' do
+        widget = Widget.create!(widget_id: 1, name: 'a'*500)
+        expect('my-topic').to have_sent({
+                                          widget_id: 1,
+                                          name: 'a'*500,
+                                          id: widget.id,
+                                          created_at: anything,
+                                          updated_at: anything
+                                        }, 1)
+        widget.update_attribute(:name, 'b'*500)
+        expect('my-topic').to have_sent({
+                                          widget_id: 1,
+                                          name: 'b'*500,
+                                          id: widget.id,
+                                          created_at: anything,
+                                          updated_at: anything
+                                        }, 1)
+      end
+    end
+
+    context 'with truncation on' do
+      before(:each) do
+        Deimos.config.producers.truncate_columns = true
+      end
+      it 'should truncate values' do
+        widget = Widget.create!(widget_id: 1, name: 'a'*500)
+        expect('my-topic').to have_sent({
+                                          widget_id: 1,
+                                          name: 'a'*100,
+                                          id: widget.id,
+                                          created_at: anything,
+                                          updated_at: anything
+                                        }, 1)
+        widget.update_attribute(:name, 'b'*500)
+        expect('my-topic').to have_sent({
+                                          widget_id: 1,
+                                          name: 'b'*100,
+                                          id: widget.id,
+                                          created_at: anything,
+                                          updated_at: anything
+                                        }, 1)
+      end
+    end
+
     it 'should send events on import' do
       widgets = (1..3).map do |i|
         Widget.new(widget_id: i, name: "Widget #{i}")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deimos-ruby
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.4
 platform: ruby
 authors:
 - Daniel Orner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-12 00:00:00.000000000 Z
+date: 2025-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avro_turf