deimos-ruby 2.4.0.pre.beta1 → 2.4.0.pre.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 597f226ba74e9b5acce2906ee0fea563a3ff2b7a5b47bef0d4e66d840410ed42
-  data.tar.gz: 876b9a70bc598bb99084a0bad47d6285c728efa54d98346761346c4313dda968
+  metadata.gz: bc23c10fe732ab1eb2b6c0e2daf5bdb943a939510624b821456d0d383224f579
+  data.tar.gz: 84fdb7e495d76bb27b0592572f13249a7c8e28c3d123c68d15ac5d30ff883421
 SHA512:
-  metadata.gz: 58d7dfcf2cfbbbda7c4ce3459931a89ba6bf6261f6bd4a2cdf1bc2de640200fdc2a9a36f0af414bbcfef3de45fe8b3053795cdd5b139cf10a747a16a82989ccc
-  data.tar.gz: 35ab518ca7bcbc48d2810ec67ce30a9331816fdc08caa52c602406f6b79346f7bf806af3adc50b427e5d412ce478c55f5e29b49f0bc61f2c88dc1ca81b11f993
+  metadata.gz: 9b47d42b33e3c66ed3fd852570490e6a719d55c6709b706b38b58144a192b40a5edef6c6b5be516c89c3798069ea22f6be2134e1000f41ba3110f92b5face15d
+  data.tar.gz: 3fea215d836fbcc1e10df7971e7112194ada61a95dab4be1524cafc275d523b7ee186887298a0a89e162945aeaf2b83d5826031844e9b26dd25039d7797d6c75

data/README.md

@@ -91,10 +91,11 @@ Currently we have the following possible schema backends:
 * Avro Schema Registry (use the Confluent Schema Registry)
 * Avro Validation (validate using an Avro schema but leave decoded - this is useful
   for unit testing and development)
+* Protobuf Local (use pure Protobuf)
 * Protobuf Schema Registry (use Protobuf with the Confluent Schema Registry)
 * Mock (no actual encoding/decoding).
 
-Other possible schemas could [JSONSchema](https://json-schema.org/), etc. Feel free to
+Other possible schemas could include [JSONSchema](https://json-schema.org/), etc. Feel free to
 contribute!
 
 To create a new schema backend, please see the existing examples [here](lib/deimos/schema_backends).
@@ -281,7 +282,7 @@ MyProducer.publish({
 ```
 
 > [!IMPORTANT]
-> Protobuf should *not* be used as a key schema, since the binary encoding is [unstable](https://protobuf.dev/programming-guides/encoding/#implications) and may break partitioning. Deimos will automatically convert key fields to plain values and key hashes to JSON.
+> Protobuf should *not* be used as a key schema, since the binary encoding is [unstable](https://protobuf.dev/programming-guides/encoding/#implications) and may break partitioning. Deimos will automatically convert keys to sorted JSON, and will use JSON Schema in the schema registry.
 
 ## Instrumentation
 
@@ -1010,7 +1011,13 @@ end
 # test can have the same settings every time it is run
 after(:each) do
   Deimos.config.reset!
-  Deimos.config.schema.backend = :avro_validation
+  # set specific settings here
+  Deimos.config.schema.path = 'my/schema/path'
+end
+
+around(:each) do |ex|
+  # replace e.g. avro_schema_registry with avro_validation, proto_schema_registry with proto_local
+  Deimos::TestHelpers.with_mock_backends { ex.run }
 end
 ```
 

data/lib/deimos/message.rb

@@ -38,10 +38,19 @@ module Deimos
     def add_fields(fields)
       return if @payload.to_h.with_indifferent_access.except(:payload_key, :partition_key).blank?
 
-      if fields.include?('message_id')
+      if @payload.respond_to?(:message_id)
+        if fields.include?('message_id') && @payload.message_id.blank?
+          @payload.message_id = SecureRandom.uuid
+        end
+      elsif fields.include?('message_id')
         @payload['message_id'] ||= SecureRandom.uuid
       end
-      if fields.include?('timestamp')
+
+      if @payload.respond_to?(:timestamp)
+        if fields.include?('timestamp') && @payload.timestamp.blank?
+          @payload.timestamp = Time.now.in_time_zone.to_s
+        end
+      elsif fields.include?('timestamp')
         @payload['timestamp'] ||= Time.now.in_time_zone.to_s
       end
     end

data/lib/deimos/schema_backends/proto_base.rb

@@ -56,7 +56,7 @@ module Deimos
 
       # @param hash [Hash]
       # @return [String]
-      def encode_proto_key(hash, topic: nil)
+      def encode_proto_key(hash, topic: nil, field: nil)
         hash.sort.to_h.to_json
       end
 

data/lib/deimos/schema_backends/proto_schema_registry.rb

@@ -8,6 +8,11 @@ module Deimos
     # Encode / decode using the Protobuf schema registry.
     class ProtoSchemaRegistry < ProtoBase
 
+      # @override
+      def self.mock_backend
+        :proto_local
+      end
+
       # @override
       def decode_payload(payload, schema:)
         self.class.schema_registry.decode(payload)

data/lib/deimos/test_helpers.rb

@@ -50,6 +50,13 @@ module Deimos
         warn("unit_test! is deprecated and can be replaced by setting Deimos's schema backend " \
              'to `:avro_validation`. All other test behavior is provided by Karafka.')
       end
+
+      def with_mock_backends
+        Deimos.mock_backends = true
+        yield
+        Deimos.mock_backends = false
+      end
+
     end
 
     # get the difference of 2 hashes.

data/lib/deimos/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Deimos
-  VERSION = '2.4.0-beta1'
+  VERSION = '2.4.0-beta2'
 end

data/lib/deimos.rb

@@ -54,6 +54,9 @@ module Deimos
 
   class << self
 
+    # @return [Boolean] for use in unit tests
+    attr_accessor :mock_backends
+
     # @param backend [Symbol, nil]
     # @return [Class<Deimos::SchemaBackends::Base>]
     def schema_backend_class(backend: nil)
@@ -61,7 +64,12 @@ module Deimos
 
       require "deimos/schema_backends/#{backend}"
 
-      "Deimos::SchemaBackends::#{backend.to_s.classify}".constantize
+      klass = "Deimos::SchemaBackends::#{backend.to_s.classify}".constantize
+      if self.mock_backends
+        require "deimos/schema_backends/#{klass.mock_backend}"
+        klass = "Deimos::SchemaBackends::#{klass.mock_backend.to_s.classify}".constantize
+      end
+      klass
     end
 
     # @param schema [String, Symbol]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: deimos-ruby
 version: !ruby/object:Gem::Version
-  version: 2.4.0.pre.beta1
+  version: 2.4.0.pre.beta2
 platform: ruby
 authors:
 - Daniel Orner