deimos-ruby 1.7.0.pre.beta1 → 1.8.1.pre.beta3

data/lib/deimos/consume/message_consumption.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Deimos
+  module Consume
+    # Methods used by message-by-message (non-batch) consumers. These consumers
+    # are invoked for every individual message.
+    module MessageConsumption
+      extend ActiveSupport::Concern
+      include Phobos::Handler
+
+      # :nodoc:
+      def around_consume(payload, metadata)
+        decoded_payload = payload.dup
+        new_metadata = metadata.dup
+        benchmark = Benchmark.measure do
+          _with_span do
+            new_metadata[:key] = decode_key(metadata[:key]) if self.class.config[:key_configured]
+            decoded_payload = payload ? self.class.decoder.decode(payload) : nil
+            _received_message(decoded_payload, new_metadata)
+            yield decoded_payload, new_metadata
+          end
+        end
+        _handle_success(benchmark.real, decoded_payload, new_metadata)
+      rescue StandardError => e
+        _handle_error(e, decoded_payload, new_metadata)
+      end
+
+      # Consume incoming messages.
+      # @param _payload [String]
+      # @param _metadata [Hash]
+      def consume(_payload, _metadata)
+        raise NotImplementedError
+      end
+
+    private
+
+      def _received_message(payload, metadata)
+        Deimos.config.logger.info(
+          message: 'Got Kafka event',
+          payload: payload,
+          metadata: metadata
+        )
+        Deimos.config.metrics&.increment('handler', tags: %W(
+                                           status:received
+                                           topic:#{metadata[:topic]}
+                                         ))
+        _report_time_delayed(payload, metadata)
+      end
+
+      # @param exception [Throwable]
+      # @param payload [Hash]
+      # @param metadata [Hash]
+      def _handle_error(exception, payload, metadata)
+        Deimos.config.metrics&.increment(
+          'handler',
+          tags: %W(
+            status:error
+            topic:#{metadata[:topic]}
+          )
+        )
+        Deimos.config.logger.warn(
+          message: 'Error consuming message',
+          handler: self.class.name,
+          metadata: metadata,
+          data: payload,
+          error_message: exception.message,
+          error: exception.backtrace
+        )
+
+        _error(exception, payload, metadata)
+      end
+
+      # @param time_taken [Float]
+      # @param payload [Hash]
+      # @param metadata [Hash]
+      def _handle_success(time_taken, payload, metadata)
+        Deimos.config.metrics&.histogram('handler', time_taken, tags: %W(
+                                           time:consume
+                                           topic:#{metadata[:topic]}
+                                         ))
+        Deimos.config.metrics&.increment('handler', tags: %W(
+                                           status:success
+                                           topic:#{metadata[:topic]}
+                                         ))
+        Deimos.config.logger.info(
+          message: 'Finished processing Kafka event',
+          payload: payload,
+          time_elapsed: time_taken,
+          metadata: metadata
+        )
+      end
+    end
+  end
+end

data/lib/deimos/consumer.rb

@@ -1,97 +1,104 @@
 # frozen_string_literal: true
 
-require 'deimos/base_consumer'
-require 'deimos/shared_config'
-require 'phobos/handler'
-require 'active_support/all'
+require 'deimos/consume/batch_consumption'
+require 'deimos/consume/message_consumption'
 
-# Class to consume messages coming from the pipeline topic
+# Class to consume messages coming from a Kafka topic
 # Note: According to the docs, instances of your handler will be created
-# for every incoming message. This class should be lightweight.
+# for every incoming message/batch. This class should be lightweight.
 module Deimos
-  # Parent consumer class.
-  class Consumer < BaseConsumer
-    include Phobos::Handler
+  # Basic consumer class. Inherit from this class and override either consume
+  # or consume_batch, depending on the delivery mode of your listener.
+  # `consume` -> use `delivery :message` or `delivery :batch`
+  # `consume_batch` -> use `delivery :inline_batch`
+  class Consumer
+    include Consume::MessageConsumption
+    include Consume::BatchConsumption
+    include SharedConfig
 
-    # :nodoc:
-    def around_consume(payload, metadata)
-      decoded_payload = payload.dup
-      new_metadata = metadata.dup
-      benchmark = Benchmark.measure do
-        _with_span do
-          new_metadata[:key] = decode_key(metadata[:key]) if self.class.config[:key_configured]
-          decoded_payload = payload ? self.class.decoder.decode(payload) : nil
-          _received_message(decoded_payload, new_metadata)
-          yield decoded_payload, new_metadata
-        end
+    class << self
+      # @return [Deimos::SchemaBackends::Base]
+      def decoder
+        @decoder ||= Deimos.schema_backend(schema: config[:schema],
+                                           namespace: config[:namespace])
+      end
+
+      # @return [Deimos::SchemaBackends::Base]
+      def key_decoder
+        @key_decoder ||= Deimos.schema_backend(schema: config[:key_schema],
+                                               namespace: config[:namespace])
       end
-      _handle_success(benchmark.real, decoded_payload, new_metadata)
-    rescue StandardError => e
-      _handle_error(e, decoded_payload, new_metadata)
     end
 
-    # Consume incoming messages.
-    # @param _payload [String]
-    # @param _metadata [Hash]
-    def consume(_payload, _metadata)
-      raise NotImplementedError
+    # Helper method to decode an encoded key.
+    # @param key [String]
+    # @return [Object] the decoded key.
+    def decode_key(key)
+      return nil if key.nil?
+
+      config = self.class.config
+      unless config[:key_configured]
+        raise 'No key config given - if you are not decoding keys, please use '\
+          '`key_config plain: true`'
+      end
+
+      if config[:key_field]
+        self.class.decoder.decode_key(key, config[:key_field])
+      elsif config[:key_schema]
+        self.class.key_decoder.decode(key, schema: config[:key_schema])
+      else # no encoding
+        key
+      end
     end
 
   private
 
-    def _received_message(payload, metadata)
-      Deimos.config.logger.info(
-        message: 'Got Kafka event',
-        payload: payload,
-        metadata: metadata
+    def _with_span
+      @span = Deimos.config.tracer&.start(
+        'deimos-consumer',
+        resource: self.class.name.gsub('::', '-')
       )
-      Deimos.config.metrics&.increment('handler', tags: %W(
-                                         status:received
+      yield
+    ensure
+      Deimos.config.tracer&.finish(@span)
+    end
+
+    def _report_time_delayed(payload, metadata)
+      return if payload.nil? || payload['timestamp'].blank?
+
+      begin
+        time_delayed = Time.now.in_time_zone - payload['timestamp'].to_datetime
+      rescue ArgumentError
+        Deimos.config.logger.info(
+          message: "Error parsing timestamp! #{payload['timestamp']}"
+        )
+        return
+      end
+      Deimos.config.metrics&.histogram('handler', time_delayed, tags: %W(
+                                         time:time_delayed
                                          topic:#{metadata[:topic]}
                                        ))
-      _report_time_delayed(payload, metadata)
     end
 
-    # @param exception [Throwable]
-    # @param payload [Hash]
-    # @param metadata [Hash]
-    def _handle_error(exception, payload, metadata)
-      Deimos.config.metrics&.increment(
-        'handler',
-        tags: %W(
-          status:error
-          topic:#{metadata[:topic]}
-        )
-      )
-      Deimos.config.logger.warn(
-        message: 'Error consuming message',
-        handler: self.class.name,
-        metadata: metadata,
-        data: payload,
-        error_message: exception.message,
-        error: exception.backtrace
-      )
-      super
+    # Overrideable method to determine if a given error should be considered
+    # "fatal" and always be reraised.
+    # @param _error [Exception]
+    # @param _payload [Hash]
+    # @param _metadata [Hash]
+    # @return [Boolean]
+    def fatal_error?(_error, _payload, _metadata)
+      false
     end
 
-    # @param time_taken [Float]
+    # @param exception [Exception]
     # @param payload [Hash]
     # @param metadata [Hash]
-    def _handle_success(time_taken, payload, metadata)
-      Deimos.config.metrics&.histogram('handler', time_taken, tags: %W(
-                                         time:consume
-                                         topic:#{metadata[:topic]}
-                                       ))
-      Deimos.config.metrics&.increment('handler', tags: %W(
-                                         status:success
-                                         topic:#{metadata[:topic]}
-                                       ))
-      Deimos.config.logger.info(
-        message: 'Finished processing Kafka event',
-        payload: payload,
-        time_elapsed: time_taken,
-        metadata: metadata
-      )
+    def _error(exception, payload, metadata)
+      Deimos.config.tracer&.set_error(@span, exception)
+
+      raise if Deimos.config.consumers.reraise_errors ||
+               Deimos.config.consumers.fatal_error&.call(exception, payload, metadata) ||
+               fatal_error?(exception, payload, metadata)
     end
   end
 end

data/lib/deimos/instrumentation.rb

@@ -46,13 +46,18 @@ module Deimos
 
       messages = exception.failed_messages
       messages.group_by(&:topic).each do |topic, batch|
-        next if batch.empty?
+        producer = Deimos::Producer.descendants.find { |c| c.topic == topic }
+        next if batch.empty? || !producer
 
-        producer = batch.first.metadata[:producer_name]
-        payloads = batch.map { |m| m.metadata[:decoded_payload] }
+        decoder = Deimos.schema_backend(schema: producer.config[:schema],
+                                        namespace: producer.config[:namespace])
+        payloads = batch.map { |m| decoder.decode(m.value) }
 
-        Deimos.config.metrics&.count('publish_error', payloads.size,
-                                     tags: %W(topic:#{topic}))
+        Deimos.config.metrics&.increment(
+          'publish_error',
+          tags: %W(topic:#{topic}),
+          by: payloads.size
+        )
         Deimos.instrument(
           'produce_error',
           producer: producer,

data/lib/deimos/kafka_message.rb

@@ -42,7 +42,7 @@ module Deimos
       messages.map do |m|
         {
           key: m.key.present? ? decoder&.decode_key(m.key) || m.key : nil,
-          payload: decoder&.decoder&.decode(self.message) || self.message
+          payload: decoder&.decoder&.decode(m.message) || m.message
         }
       end
     end

data/lib/deimos/kafka_topic_info.rb

@@ -13,7 +13,7 @@ module Deimos
       def lock(topic, lock_id)
         # Try to create it - it's fine if it already exists
         begin
-          self.create(topic: topic)
+          self.create(topic: topic, last_processed_at: Time.zone.now)
         rescue ActiveRecord::RecordNotUnique
           # continue on
         end
@@ -52,7 +52,26 @@ module Deimos
       # @param lock_id [String]
       def clear_lock(topic, lock_id)
         self.where(topic: topic, locked_by: lock_id).
-          update_all(locked_by: nil, locked_at: nil, error: false, retries: 0)
+          update_all(locked_by: nil,
+                     locked_at: nil,
+                     error: false,
+                     retries: 0,
+                     last_processed_at: Time.zone.now)
+      end
+
+      # Update all topics that aren't currently locked and have no messages
+      # waiting. It's OK if some messages get inserted in the middle of this
+      # because the point is that at least within a few milliseconds of each
+      # other, it wasn't locked and had no messages, meaning the topic
+      # was in a good state.
+      # @param except_topics [Array<String>] the list of topics we've just
+      # realized had messages in them, meaning all other topics were empty.
+      def ping_empty_topics(except_topics)
+        records = KafkaTopicInfo.where(locked_by: nil).
+          where('topic not in(?)', except_topics)
+        records.each do |info|
+          info.update_attribute(:last_processed_at, Time.zone.now)
+        end
       end
 
       # The producer calls this if it gets an error sending messages. This

data/lib/deimos/message.rb

@@ -10,7 +10,7 @@ module Deimos
     # @param producer [Class]
     def initialize(payload, producer, topic: nil, key: nil, partition_key: nil)
       @payload = payload&.with_indifferent_access
-      @producer_name = producer.name
+      @producer_name = producer&.name
       @topic = topic
       @key = key
       @partition_key = partition_key
@@ -70,5 +70,10 @@ module Deimos
     def ==(other)
       self.to_h == other.to_h
     end
+
+    # @return [Boolean] True if this message is a tombstone
+    def tombstone?
+      payload.nil?
+    end
   end
 end

data/lib/deimos/schema_backends/avro_base.rb

@@ -33,6 +33,30 @@ module Deimos
         decode(payload, schema: @key_schema['name'])[field_name]
       end
 
+      # :nodoc:
+      def sql_type(field)
+        type = field.type.type
+        return type if %w(array map record).include?(type)
+
+        if type == :union
+          non_null = field.type.schemas.reject { |f| f.type == :null }
+          if non_null.size > 1
+            warn("WARNING: #{field.name} has more than one non-null type. Picking the first for the SQL type.")
+          end
+          return non_null.first.type
+        end
+        return type.to_sym if %w(float boolean).include?(type)
+        return :integer if type == 'int'
+        return :bigint if type == 'long'
+
+        if type == 'double'
+          warn('Avro `double` type turns into SQL `float` type. Please ensure you have the correct `limit` set.')
+          return :float
+        end
+
+        :string
+      end
+
       # @override
       def coerce_field(field, value)
         AvroSchemaCoercer.new(avro_schema).coerce_type(field.type, value)
@@ -40,7 +64,10 @@ module Deimos
 
       # @override
       def schema_fields
-        avro_schema.fields.map { |field| SchemaField.new(field.name, field.type) }
+        avro_schema.fields.map do |field|
+          enum_values = field.type.type == 'enum' ? field.type.symbols : []
+          SchemaField.new(field.name, field.type, enum_values)
+        end
       end
 
       # @override
@@ -55,6 +82,11 @@ module Deimos
         :avro_validation
       end
 
+      # @override
+      def self.content_type
+        'avro/binary'
+      end
+
     private
 
       # @param schema [String]

data/lib/deimos/schema_backends/avro_schema_coercer.rb

@@ -10,18 +10,37 @@ module Deimos
       @schema = schema
     end
 
-    # @param type [Symbol]
+    # Coerce sub-records in a payload to match the schema.
+    # @param type [Avro::Schema::UnionSchema]
+    # @param val [Object]
+    # @return [Object]
+    def coerce_union(type, val)
+      union_types = type.schemas.map { |s| s.type.to_sym }
+      return nil if val.nil? && union_types.include?(:null)
+
+      schema_type = type.schemas.find { |s| s.type.to_sym != :null }
+      coerce_type(schema_type, val)
+    end
+
+    # Coerce sub-records in a payload to match the schema.
+    # @param type [Avro::Schema::RecordSchema]
+    # @param val [Object]
+    # @return [Object]
+    def coerce_record(type, val)
+      record = val.map do |name, value|
+        field = type.fields.find { |f| f.name == name }
+        coerce_type(field.type, value)
+      end
+      val.keys.zip(record).to_h
+    end
+
+    # Coerce values in a payload to match the schema.
+    # @param type [Avro::Schema]
     # @param val [Object]
     # @return [Object]
     def coerce_type(type, val)
       int_classes = [Time, ActiveSupport::TimeWithZone]
       field_type = type.type.to_sym
-      if field_type == :union
-        union_types = type.schemas.map { |s| s.type.to_sym }
-        return nil if val.nil? && union_types.include?(:null)
-
-        field_type = union_types.find { |t| t != :null }
-      end
 
       case field_type
       when :int, :long
@@ -32,14 +51,12 @@ module Deimos
         else
           val # this will fail
         end
-
       when :float, :double
         if val.is_a?(Numeric) || _is_float_string?(val)
           val.to_f
         else
           val # this will fail
         end
-
       when :string
         if val.respond_to?(:to_str)
           val.to_s
@@ -54,8 +71,10 @@ module Deimos
         else
           true
         end
-      else
-        val
+      when :union
+        coerce_union(type, val)
+      when :record
+        coerce_record(type, val)
       end
     end