deimos-ruby 1.16.3 → 1.16.5

data/lib/deimos/active_record_consumer.rb

@@ -23,14 +23,16 @@ module Deimos
     include ActiveRecordConsume::BatchConsumption
 
     class << self
-      # param klass [Class < ActiveRecord::Base] the class used to save to the
+      # @param klass [Class<ActiveRecord::Base>] the class used to save to the
       # database.
+      # @return [void]
       def record_class(klass)
         config[:record_class] = klass
       end
 
-      # param val [Boolean] Turn pre-compaction of the batch on or off. If true,
+      # @param val [Boolean] Turn pre-compaction of the batch on or off. If true,
       # only the last message for each unique key in a batch is processed.
+      # @return [void]
       def compacted(val)
         config[:compacted] = val
       end
@@ -50,14 +52,15 @@ module Deimos
 
     # Override this method (with `super`) if you want to add/change the default
     # attributes set to the new/existing record.
-    # @param payload [Hash|Deimos::SchemaClass::Record]
+    # @param payload [Hash,Deimos::SchemaClass::Record]
     # @param _key [String]
+    # @return [Hash]
     def record_attributes(payload, _key=nil)
       @converter.convert(payload)
     end
 
     # Override this message to conditionally save records
-    # @param _payload [Hash|Deimos::SchemaClass::Record] The kafka message
+    # @param _payload [Hash,Deimos::SchemaClass::Record] The kafka message
     # @return [Boolean] if true, record is created/update.
     #   If false, record processing is skipped but message offset is still committed.
     def process_message?(_payload)

data/lib/deimos/active_record_producer.rb

@@ -17,6 +17,7 @@ module Deimos
       # @param refetch [Boolean] if true, and we are given a hash instead of
       # a record object, refetch the record to pass into the `generate_payload`
       # method.
+      # @return [void]
       def record_class(klass, refetch: true)
         config[:record_class] = klass
         config[:refetch_record] = refetch
@@ -24,12 +25,14 @@ module Deimos
 
       # @param record [ActiveRecord::Base]
       # @param force_send [Boolean]
+      # @return [void]
       def send_event(record, force_send: false)
         send_events([record], force_send: force_send)
       end
 
       # @param records [Array<ActiveRecord::Base>]
       # @param force_send [Boolean]
+      # @return [void]
       def send_events(records, force_send: false)
         primary_key = config[:record_class]&.primary_key
         messages = records.map do |record|

data/lib/deimos/backends/base.rb

@@ -5,8 +5,9 @@ module Deimos
     # Abstract class for all publish backends.
     class Base
       class << self
-        # @param producer_class [Class < Deimos::Producer]
+        # @param producer_class [Class<Deimos::Producer>]
         # @param messages [Array<Deimos::Message>]
+        # @return [void]
         def publish(producer_class:, messages:)
           Deimos.config.logger.info(
             message: 'Publishing messages',
@@ -21,8 +22,9 @@ module Deimos
           execute(producer_class: producer_class, messages: messages)
         end
 
-        # @param producer_class [Class < Deimos::Producer]
+        # @param producer_class [Class<Deimos::Producer>]
         # @param messages [Array<Deimos::Message>]
+        # @return [void]
         def execute(producer_class:, messages:)
           raise NotImplementedError
         end

data/lib/deimos/backends/kafka.rb

@@ -7,6 +7,7 @@ module Deimos
       include Phobos::Producer
 
       # Shut down the producer if necessary.
+      # @return [void]
       def self.shutdown_producer
         producer.sync_producer_shutdown if producer.respond_to?(:sync_producer_shutdown)
         producer.kafka_client&.close

data/lib/deimos/backends/kafka_async.rb

@@ -7,6 +7,7 @@ module Deimos
       include Phobos::Producer
 
       # Shut down the producer cleanly.
+      # @return [void]
       def self.shutdown_producer
         producer.async_producer_shutdown
         producer.kafka_client&.close

data/lib/deimos/config/configuration.rb

@@ -32,6 +32,7 @@ module Deimos
   end
 
   # Loads generated classes
+  # @return [void]
   def self.load_generated_schema_classes
     if Deimos.config.schema.generated_class_path.nil?
       raise 'Cannot use schema classes without schema.generated_class_path. Please provide a directory.'
@@ -43,6 +44,7 @@ module Deimos
   end
 
   # Ensure everything is set up correctly for the DB backend.
+  # @!visibility private
   def self.validate_db_backend
     begin
       require 'activerecord-import'
@@ -56,6 +58,7 @@ module Deimos
 
   # Validate that consumers are configured correctly, including their
   # delivery mode.
+  # @!visibility private
   def self.validate_consumers
     Phobos.config.listeners.each do |listener|
       handler_class = listener.handler.constantize
@@ -74,6 +77,7 @@ module Deimos
     end
   end
 
+  # @!visibility private
   # @param kafka_config [FigTree::ConfigStruct]
   def self.configure_producer_or_consumer(kafka_config)
     klass = kafka_config.class_name.constantize

data/lib/deimos/config/phobos_config.rb

@@ -20,7 +20,7 @@ module Deimos
       }.to_h
     end
 
-    # :nodoc:
+    # @return [void]
     def reset!
       super
       Phobos.configure(self.phobos_config)
@@ -115,6 +115,7 @@ module Deimos
     end
 
     # Legacy method to parse Phobos config file
+    # @!visibility private
     def phobos_config_file=(file)
       pconfig = YAML.load(ERB.new(File.read(File.expand_path(file))).result). # rubocop:disable Security/YAMLLoad
         with_indifferent_access

data/lib/deimos/consume/batch_consumption.rb

@@ -9,7 +9,9 @@ module Deimos
       extend ActiveSupport::Concern
       include Phobos::BatchHandler
 
-      # :nodoc:
+      # @param batch [Array<String>]
+      # @param metadata [Hash]
+      # @return [void]
       def around_consume_batch(batch, metadata)
         payloads = []
         _with_span do
@@ -36,12 +38,14 @@ module Deimos
       # Consume a batch of incoming messages.
       # @param _payloads [Array<Phobos::BatchMessage>]
       # @param _metadata [Hash]
+      # @return [void]
       def consume_batch(_payloads, _metadata)
         raise NotImplementedError
       end
 
     protected
 
+      # @!visibility private
       def _received_batch(payloads, metadata)
         Deimos.config.logger.info(
           message: 'Got Kafka batch event',
@@ -70,6 +74,7 @@ module Deimos
         end
       end
 
+      # @!visibility private
       # @param exception [Throwable]
       # @param payloads [Array<Hash>]
       # @param metadata [Hash]
@@ -91,6 +96,7 @@ module Deimos
         _error(exception, payloads, metadata)
       end
 
+      # @!visibility private
       # @param time_taken [Float]
       # @param payloads [Array<Hash>]
       # @param metadata [Hash]
@@ -122,6 +128,7 @@ module Deimos
         )
       end
 
+      # @!visibility private
       # Get payload identifiers (key and message_id if present) for logging.
       # @param payloads [Array<Hash>]
       # @param metadata [Hash]

data/lib/deimos/consume/message_consumption.rb

@@ -8,7 +8,9 @@ module Deimos
       extend ActiveSupport::Concern
       include Phobos::Handler
 
-      # :nodoc:
+      # @param payload [String]
+      # @param metadata [Hash]
+      # @return [void]
       def around_consume(payload, metadata)
         decoded_payload = payload.nil? ? nil : payload.dup
         new_metadata = metadata.dup
@@ -28,6 +30,7 @@ module Deimos
       # Consume incoming messages.
       # @param _payload [String]
       # @param _metadata [Hash]
+      # @return [void]
       def consume(_payload, _metadata)
         raise NotImplementedError
       end

data/lib/deimos/instrumentation.rb

@@ -8,23 +8,29 @@ module Deimos
   # Copied from Phobos instrumentation.
   module Instrumentation
     extend ActiveSupport::Concern
+
+    # @return [String]
     NAMESPACE = 'Deimos'
 
     # :nodoc:
     module ClassMethods
-      # :nodoc:
+      # @param event [String]
+      # @return [void]
       def subscribe(event)
         ActiveSupport::Notifications.subscribe("#{NAMESPACE}.#{event}") do |*args|
           yield(ActiveSupport::Notifications::Event.new(*args)) if block_given?
         end
       end
 
-      # :nodoc:
+      # @param subscriber [ActiveSupport::Subscriber]
+      # @return [void]
       def unsubscribe(subscriber)
         ActiveSupport::Notifications.unsubscribe(subscriber)
       end
 
-      # :nodoc:
+      # @param event [String]
+      # @param extra [Hash]
+      # @return [void]
       def instrument(event, extra={})
         ActiveSupport::Notifications.instrument("#{NAMESPACE}.#{event}", extra) do |extra2|
           yield(extra2) if block_given?
@@ -39,7 +45,8 @@ module Deimos
   module KafkaListener
     # Listens for any exceptions that happen during publishing and re-publishes
     # as a Deimos event.
-    # @param event [ActiveSupport::Notification]
+    # @param event [ActiveSupport::Notifications::Event]
+    # @return [void]
     def self.send_produce_error(event)
       exception = event.payload[:exception_object]
       return if !exception || !exception.respond_to?(:failed_messages)

data/lib/deimos/kafka_message.rb

@@ -10,6 +10,7 @@ module Deimos
     # Ensure it gets turned into a string, e.g. for testing purposes. It
     # should already be a string.
     # @param mess [Object]
+    # @return [void]
     def message=(mess)
       write_attribute(:message, mess ? mess.to_s : nil)
     end

data/lib/deimos/kafka_source.rb

@@ -6,6 +6,7 @@ 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.'
 
@@ -16,6 +17,7 @@ module Deimos
     end
 
     # Send the newly created model to Kafka.
+    # @return [void]
     def send_kafka_event_on_create
       return unless self.persisted?
       return unless self.class.kafka_config[:create]
@@ -24,6 +26,7 @@ module Deimos
     end
 
     # Send the newly updated model to Kafka.
+    # @return [void]
     def send_kafka_event_on_update
       return unless self.class.kafka_config[:update]
 
@@ -41,6 +44,7 @@ module Deimos
     end
 
     # Send a deletion (null payload) event to Kafka.
+    # @return [void]
     def send_kafka_event_on_destroy
       return unless self.class.kafka_config[:delete]
 
@@ -80,6 +84,7 @@ module Deimos
       # the inputs (arrays, hashes, records etc.)
       # Basically we want to first do the import, then reload the records
       # and send them to Kafka.
+      # @!visibility private
       def import_without_validations_or_callbacks(column_names,
                                                   array_of_attributes,
                                                   options={})

data/lib/deimos/kafka_topic_info.rb

@@ -50,6 +50,7 @@ module Deimos
       # moves on to the next one.
       # @param topic [String]
       # @param lock_id [String]
+      # @return [void]
       def clear_lock(topic, lock_id)
         self.where(topic: topic, locked_by: lock_id).
           update_all(locked_by: nil,
@@ -66,6 +67,7 @@ module Deimos
       # 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.
+      # @return [void]
       def ping_empty_topics(except_topics)
         records = KafkaTopicInfo.where(locked_by: nil).
           where('topic not in(?)', except_topics)
@@ -79,6 +81,7 @@ module Deimos
       # and allows the caller to continue to the next topic.
       # @param topic [String]
       # @param lock_id [String]
+      # @return [void]
       def register_error(topic, lock_id)
         record = self.where(topic: topic, locked_by: lock_id).last
         attr_hash = { locked_by: nil,
@@ -93,6 +96,7 @@ module Deimos
       # working on those messages and to continue.
       # @param topic [String]
       # @param lock_id [String]
+      # @return [void]
       def heartbeat(topic, lock_id)
         self.where(topic: topic, locked_by: lock_id).
           update_all(locked_at: Time.zone.now)

data/lib/deimos/message.rb

@@ -3,11 +3,26 @@
 module Deimos
   # Basically a struct to hold the message as it's processed.
   class Message
-    attr_accessor :payload, :key, :partition_key, :encoded_key,
-                  :encoded_payload, :topic, :producer_name
+    # @return [Hash]
+    attr_accessor :payload
+    # @return [Hash, String, Integer]
+    attr_accessor :key
+    # @return [Integer]
+    attr_accessor :partition_key
+    # @return [String]
+    attr_accessor  :encoded_key
+    # @return [String]
+    attr_accessor  :encoded_payload
+    # @return [String]
+    attr_accessor  :topic
+    # @return [String]
+    attr_accessor  :producer_name
 
     # @param payload [Hash]
     # @param producer [Class]
+    # @param topic [String]
+    # @param key [String, Integer, Hash]
+    # @param partition_key [Integer]
     def initialize(payload, producer, topic: nil, key: nil, partition_key: nil)
       @payload = payload&.with_indifferent_access
       @producer_name = producer&.name
@@ -19,6 +34,7 @@ module Deimos
     # Add message_id and timestamp default values if they are in the
     # schema and don't already have values.
     # @param fields [Array<String>] existing name fields in the schema.
+    # @return [void]
     def add_fields(fields)
       return if @payload.except(:payload_key, :partition_key).blank?
 
@@ -31,6 +47,7 @@ module Deimos
     end
 
     # @param encoder [Deimos::SchemaBackends::Base]
+    # @return [void]
     def coerce_fields(encoder)
       return if payload.nil?
 

data/lib/deimos/metrics/datadog.rb

@@ -6,7 +6,8 @@ module Deimos
   module Metrics
     # A Metrics wrapper class for Datadog.
     class Datadog < Metrics::Provider
-      # :nodoc:
+      # @param config [Hash]
+      # @param logger [Logger]
       def initialize(config, logger)
         raise 'Metrics config must specify host_ip' if config[:host_ip].nil?
         raise 'Metrics config must specify host_port' if config[:host_port].nil?

data/lib/deimos/metrics/mock.rb

@@ -5,8 +5,8 @@ require 'deimos/metrics/provider'
 module Deimos
   module Metrics
     # A mock Metrics wrapper which just logs the metrics
-    class Mock
-      # :nodoc:
+    class Mock < Provider
+      # @param logger [Logger,nil]
       def initialize(logger=nil)
         @logger = logger || Logger.new(STDOUT)
         @logger.info('MockMetricsProvider initialized')

data/lib/deimos/metrics/provider.rb

@@ -7,20 +7,25 @@ module Deimos
       # Send an counter increment metric
       # @param metric_name [String] The name of the counter metric
       # @param options [Hash] Any additional options, e.g. :tags
+      # @return [void]
       def increment(metric_name, options={})
         raise NotImplementedError
       end
 
       # Send an counter increment metric
       # @param metric_name [String] The name of the counter metric
+      # @param count [Integer]
       # @param options [Hash] Any additional options, e.g. :tags
+      # @return [void]
       def gauge(metric_name, count, options={})
         raise NotImplementedError
       end
 
       # Send an counter increment metric
       # @param metric_name [String] The name of the counter metric
+      # @param count [Integer]
       # @param options [Hash] Any additional options, e.g. :tags
+      # @return [void]
       def histogram(metric_name, count, options={})
         raise NotImplementedError
       end
@@ -28,6 +33,7 @@ module Deimos
       # Time a yielded block, and send a timer metric
       # @param metric_name [String] The name of the metric
       # @param options [Hash] Any additional options, e.g. :tags
+      # @return [void]
       def time(metric_name, options={})
         raise NotImplementedError
       end

data/lib/deimos/monkey_patches/phobos_cli.rb

@@ -2,7 +2,7 @@
 
 require 'phobos/cli/start'
 
-# :nodoc:
+#@!visibility private
 module Phobos
   # :nodoc:
   module CLI

data/lib/deimos/monkey_patches/phobos_producer.rb

@@ -2,6 +2,7 @@
 
 require 'phobos/producer'
 
+#@!visibility private
 module Phobos
   module Producer
     # :nodoc:

data/lib/deimos/producer.rb

@@ -11,7 +11,8 @@ module Deimos
     # Run a block without allowing any messages to be produced to Kafka.
     # Optionally add a list of producer classes to limit the disabling to those
     # classes.
-    # @param producer_classes [Array<Class>|Class]
+    # @param producer_classes [Array<Class>, Class]
+    # @return [void]
     def disable_producers(*producer_classes, &block)
       if producer_classes.any?
         _disable_producer_classes(producer_classes, &block)
@@ -31,7 +32,7 @@ module Deimos
       end
     end
 
-    # :nodoc:
+    # @!visibility private
     def _disable_producer_classes(producer_classes)
       Thread.current[:frk_disabled_producers] ||= Set.new
       producers_to_disable = producer_classes -
@@ -43,6 +44,7 @@ module Deimos
 
     # Are producers disabled? If a class is passed in, check only that class.
     # Otherwise check if the global disable flag is set.
+    # @param producer_class [Class]
     # @return [Boolean]
     def producers_disabled?(producer_class=nil)
       Thread.current[:frk_disable_all_producers] ||
@@ -54,6 +56,7 @@ module Deimos
   class Producer
     include SharedConfig
 
+    # @return [Integer]
     MAX_BATCH_SIZE = 500
 
     class << self
@@ -87,19 +90,21 @@ module Deimos
       end
 
       # Publish the payload to the topic.
-      # @param payload [Hash|SchemaClass::Record] with an optional payload_key hash key.
+      # @param payload [Hash, SchemaClass::Record] with an optional payload_key hash key.
       # @param topic [String] if specifying the topic
+      # @return [void]
       def publish(payload, topic: self.topic)
         publish_list([payload], topic: topic)
       end
 
       # Publish a list of messages.
-      # @param payloads [Array<Hash|SchemaClass::Record>] with optional payload_key hash key.
+      # @param payloads [Array<Hash, SchemaClass::Record>] with optional payload_key hash key.
       # @param sync [Boolean] if given, override the default setting of
       # whether to publish synchronously.
       # @param force_send [Boolean] if true, ignore the configured backend
       # and send immediately to Kafka.
       # @param topic [String] if specifying the topic
+      # @return [void]
       def publish_list(payloads, sync: nil, force_send: false, topic: self.topic)
         return if Deimos.config.kafka.seed_brokers.blank? ||
                   Deimos.config.producers.disabled ||
@@ -124,7 +129,7 @@ module Deimos
 
       # @param sync [Boolean]
       # @param force_send [Boolean]
-      # @return [Class < Deimos::Backend]
+      # @return [Class<Deimos::Backends::Base>]
       def determine_backend_class(sync, force_send)
         backend = if force_send
                     :kafka
@@ -140,8 +145,9 @@ module Deimos
       end
 
       # Send a batch to the backend.
-      # @param backend [Class < Deimos::Backend]
+      # @param backend [Class<Deimos::Backends::Base>]
       # @param batch [Array<Deimos::Message>]
+      # @return [void]
       def produce_batch(backend, batch)
         backend.publish(producer_class: self, messages: batch)
       end

data/lib/deimos/schema_backends/base.rb

@@ -3,11 +3,19 @@
 module Deimos
   # Represents a field in the schema.
   class SchemaField
-    attr_accessor :name, :type, :enum_values, :default
+    # @return [String]
+    attr_accessor :name
+    # @return [String]
+    attr_accessor :type
+    # @return [Array<String>]
+    attr_accessor :enum_values
+    # @return [Object]
+    attr_accessor :default
 
     # @param name [String]
     # @param type [Object]
     # @param enum_values [Array<String>]
+    # @param default [Object]
     def initialize(name, type, enum_values=[], default=:no_default)
       @name = name
       @type = type
@@ -19,9 +27,14 @@ module Deimos
   module SchemaBackends
     # Base class for encoding / decoding.
     class Base
-      attr_accessor :schema, :namespace, :key_schema
+      # @return [String]
+      attr_accessor :schema
+      # @return [String]
+      attr_accessor :namespace
+      # @return [String]
+      attr_accessor :key_schema
 
-      # @param schema [String|Symbol]
+      # @param schema [String,Symbol]
       # @param namespace [String]
       def initialize(schema:, namespace: nil)
         @schema = schema
@@ -30,7 +43,7 @@ module Deimos
 
       # Encode a payload with a schema. Public method.
       # @param payload [Hash]
-      # @param schema [Symbol|String]
+      # @param schema [String,Symbol]
       # @param topic [String]
       # @return [String]
       def encode(payload, schema: nil, topic: nil)
@@ -40,7 +53,7 @@ module Deimos
 
       # Decode a payload with a schema. Public method.
       # @param payload [String]
-      # @param schema [Symbol|String]
+      # @param schema [String,Symbol]
       # @return [Hash,nil]
       def decode(payload, schema: nil)
         return nil if payload.nil?
@@ -90,25 +103,26 @@ module Deimos
 
       # Encode a payload. To be defined by subclass.
       # @param payload [Hash]
-      # @param schema [Symbol|String]
+      # @param schema [String,Symbol]
       # @param topic [String]
       # @return [String]
-      def encode_payload(_payload, schema:, topic: nil)
+      def encode_payload(payload, schema:, topic: nil)
         raise NotImplementedError
       end
 
       # Decode a payload. To be defined by subclass.
       # @param payload [String]
-      # @param schema [String|Symbol]
+      # @param schema [String,Symbol]
       # @return [Hash]
-      def decode_payload(_payload, schema:)
+      def decode_payload(payload, schema:)
         raise NotImplementedError
       end
 
       # Validate that a payload matches the schema. To be defined by subclass.
       # @param payload [Hash]
-      # @param schema [String|Symbol]
-      def validate(_payload, schema:)
+      # @param schema [String,Symbol]
+      # @return [void]
+      def validate(payload, schema:)
         raise NotImplementedError
       end
 
@@ -124,7 +138,7 @@ module Deimos
       # @param field [SchemaField]
       # @param value [Object]
       # @return [Object]
-      def coerce_field(_field, _value)
+      def coerce_field(field, value)
         raise NotImplementedError
       end
 
@@ -140,19 +154,19 @@ module Deimos
       end
 
       # Encode a message key. To be defined by subclass.
-      # @param key [String|Hash] the value to use as the key.
-      # @param key_id [Symbol|String] the field name of the key.
+      # @param key [String,Hash] the value to use as the key.
+      # @param key_id [String,Symbol] the field name of the key.
       # @param topic [String]
       # @return [String]
-      def encode_key(_key, _key_id, topic: nil)
+      def encode_key(key, key_id, topic: nil)
         raise NotImplementedError
       end
 
       # Decode a message key. To be defined by subclass.
       # @param payload [Hash] the message itself.
-      # @param key_id [Symbol|String] the field in the message to decode.
+      # @param key_id [String,Symbol] the field in the message to decode.
       # @return [String]
-      def decode_key(_payload, _key_id)
+      def decode_key(payload, key_id)
         raise NotImplementedError
       end
 

data/lib/deimos/schema_backends/mock.rb

@@ -15,7 +15,7 @@ module Deimos
       end
 
       # @override
-      def validate(_payload, schema:)
+      def validate(payload, schema:)
       end
 
       # @override
@@ -24,7 +24,7 @@ module Deimos
       end
 
       # @override
-      def coerce_field(_type, value)
+      def coerce_field(field, value)
         value
       end