Module: Rimless::Extensions::Dependencies

Extended by:
ActiveSupport::Concern
Included in:
Rimless
Defined in:
lib/rimless/extensions/dependencies.rb

Overview

The top-level dependencies helpers.

Class Method Summary collapse

Class Method Details

.configure_avro ⇒ Object

Set sensible defaults for the AvroTurf gem and (re)compile the Apache Avro schema templates (ERB), so the gem can handle them properly.



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/rimless/extensions/dependencies.rb', line 21

def configure_avro
  # No need to configure AvroTurf when no schema registry URL is
  # available. Its fine to skip this for scenarios where the full
  # application configuration is not available (eg. on Rails asset
  # precompilations, etc)
  return if Rimless.configuration.schema_registry_url.blank?

  # Setup a global available Apache Avro decoder/encoder with support
  # for the Confluent Schema Registry, but first create a helper
  # instance
  Rimless.avro_utils = Rimless::AvroUtils.new
  # Compile our Avro schema templates to ready-to-consume Avro schemas
  Rimless.avro_utils.recompile_schemas
  # Register a global Avro messaging instance
  Rimless.avro = AvroTurf::Messaging.new(
    **Rimless.configuration.avro_configure.call(
      logger: Rimless.logger,
      namespace: Rimless.avro_utils.namespace,
      schemas_path: Rimless.avro_utils.output_path,
      registry_url: Rimless.configuration.schema_registry_url
    )
  )
end

.configure_dependencies ⇒ Object

(Re)configure our gem dependencies. We take care of setting up WaterDrop, our Apache Kafka driver and AvroTurf, our Confluent Schema Registry driver.



13
14
15
16
 
# File 'lib/rimless/extensions/dependencies.rb', line 13

def configure_dependencies
  configure_avro
  configure_producer
end

.configure_producer ⇒ Object

Set sensible defaults for the WaterDrop gem.



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/rimless/extensions/dependencies.rb', line 46

def configure_producer
  # Skip WaterDrop configuration when no brokers/client id is
  # available, because it will raise. Its fine to have none available
  # for situations like Rails asset precompilations, etc. - on runtime
  # the settings should be available, otherwise the message producing
  # just fails/raise.
  return if Rimless.configuration.kafka_brokers.empty?
    || Rimless.configuration.client_id.blank?

  # Register a global waterdrop producer instance
  Rimless.producer = WaterDrop::Producer.new do |config|
    # Activate message delivery and use the default logger
    config.deliver = true
    config.logger = Rimless.logger

    # See: https://bit.ly/3OtIfeu (+config.kafka+ settings)

    # An optional identifier of a Kafka consumer (in a consumer group)
    # that is passed to a Kafka broker with every request. A logical
    # application name to be included in Kafka logs and monitoring
    # aggregates.
    config.kafka[:'client.id'] = Rimless.configuration.client_id
    # All the known brokers, at least one. The ruby-kafka driver will
    # discover the whole cluster structure once and when issues occur
    # to dynamically adjust scaling operations.
    config.kafka[:'bootstrap.servers'] =
      Rimless.configuration.kafka_brokers
    # All brokers MUST acknowledge a new message by default
    config.kafka[:'request.required.acks'] = -1

    # Call the user-configurable block with our configuration
    # for customizations
    Rimless.configuration.producer_configure.call(config)
  end
end