Class: Legion::Extensions::Actors::Subscription

Inherits:
Object
  • Object
show all
Extended by:
Dsl
Includes:
Concurrent::Async, Base, Helpers::Transport
Defined in:
lib/legion/extensions/actors/subscription.rb

Constant Summary

Constants included from Helpers::Base

Helpers::Base::NAMESPACE_BOUNDARIES

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Dsl

define_dsl_accessor

Methods included from Helpers::Base

#actor_class, #actor_const, #actor_name, #amqp_prefix, #calling_class, #calling_class_array, #find_gem_path, #from_json, #full_path, #lex_class, #lex_const, #lex_name, #lex_slug, #log_tag, #normalize, #runner_class, #runner_const, #runner_name, #segments, #settings_path, #table_prefix, #to_dotted_hash

Methods included from Base

#args, #check_subtask?, #enabled?, #function, #generate_task?, included, #manual, #remote_invocable?, #runner, #use_runner?

Methods included from Helpers::Lex

#default_settings, included, #runner_desc

Methods included from Helpers::Task

#generate_task_id, #generate_task_log, #task_update

Methods included from Helpers::Logger

#handle_runner_exception

Methods included from Helpers::Secret

reset_identity!, resolve_identity!, #secret

Methods included from Helpers::Core

#find_setting

Constructor Details

#initialize(**_options) ⇒ Subscription

Returns a new instance of Subscription.



33
34
35
36
37
38
39
 
# File 'lib/legion/extensions/actors/subscription.rb', line 33

def initialize(**_options)
  super()
  @queue = queue.new
  @queue.channel.prefetch(prefetch) if defined? prefetch
rescue StandardError => e
  handle_exception(e, level: :fatal)
end

Class Method Details

.pattern(routing_key = nil) ⇒ Object 



27
28
29
30
31
 
# File 'lib/legion/extensions/actors/subscription.rb', line 27

def self.pattern(routing_key = nil)
  return routing_key_hint unless routing_key

  routing_key_hint(routing_key)
end

Instance Method Details

#activate ⇒ Object 



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/legion/extensions/actors/subscription.rb', line 110

def activate
  unless @consumer
    log.warn "[Subscription] skipping activate for #{lex_name}/#{runner_name}: no consumer (prepare failed?)"
    return
  end

  if @queue.channel.open?
    @queue.subscribe_with(@consumer)
  else
    log.warn "[Subscription] channel closed before activate for #{lex_name}/#{runner_name}, re-preparing"
    prepare
    if @consumer && @queue.channel.open?
      @queue.subscribe_with(@consumer)
    else
      log.error "[Subscription] re-prepare failed for #{lex_name}/#{runner_name}, skipping activate"
      return
    end
  end

  log.info "[Subscription] activated: #{lex_name}/#{runner_name} (consumer registered)"
end

#cancel ⇒ Object 



58
59
60
61
62
63
64
65
 
# File 'lib/legion/extensions/actors/subscription.rb', line 58

def cancel
  return true unless @queue.channel.active

  log.debug "Closing subscription to #{@queue.name}"
  @consumer.cancel
  @queue.channel.close
  true
end

#create_queue ⇒ Object 



41
42
43
44
45
46
47
 
# File 'lib/legion/extensions/actors/subscription.rb', line 41

def create_queue
  queues.const_set(actor_const, Class.new(Legion::Transport::Queue))
  exchange_object = default_exchange.new
  queue_object = Kernel.const_get(queue_string).new

  queue_object.bind(exchange_object, routing_key: "#{amqp_prefix}.runners.#{runner_name}.#")
end

#find_function(message = {}) ⇒ Object 



167
168
169
170
171
172
173
174
 
# File 'lib/legion/extensions/actors/subscription.rb', line 167

def find_function(message = {})
  return runner_function if actor_class.method_defined?(:runner_function, false)
  return function if actor_class.method_defined?(:function, false)
  return action if actor_class.method_defined?(:action, false)
  return message[:function] if message.key? :function

  function
end

#include_metadata_in_message? ⇒ Boolean

Returns:

  • (Boolean) 


132
133
134
 
# File 'lib/legion/extensions/actors/subscription.rb', line 132

def include_metadata_in_message?
  true
end

#prepare ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/legion/extensions/actors/subscription.rb', line 67

def prepare
  @dedicated_channel = create_dedicated_channel
  @queue = queue.new
  reassign_queue_channel(@queue, @dedicated_channel)
  @dedicated_channel.prefetch(prefetch) if defined? prefetch
  consumer_tag = "#{Legion::Settings[:client][:name]}_#{lex_name}_#{runner_name}_#{SecureRandom.uuid}"
  @consumer = Bunny::Consumer.new(@queue.channel, @queue, consumer_tag, false, false)
  @consumer.on_delivery do |delivery_info, metadata, payload|
    fn = nil
    message = process_message(payload, metadata, delivery_info)
    fn = find_function(message)
    log.debug "[Subscription] message received: #{lex_name}/#{fn}" if defined?(log)

    affinity_result = check_region_affinity(message)
    if affinity_result == :reject
      log.warn '[Subscription] nack: region affinity mismatch'
      @queue.reject(delivery_info.delivery_tag) if manual_ack
      next
    end

    record_cross_region_metric(message) if affinity_result == :remote

    if use_runner?
      dispatch_runner(message, runner_class, fn, check_subtask?, generate_task?)
    else
      runner_class.send(fn, **message)
    end
    @queue.acknowledge(delivery_info.delivery_tag) if manual_ack

    cancel if Legion::Settings[:client][:shutting_down]
  rescue UnrecoverableMessageError => e
    handle_exception(e, lex: lex_name, fn: fn, routing_key: delivery_info.routing_key)
    log.warn "[Subscription] dead-lettering unrecoverable message for #{lex_name}/#{fn}: #{e.message}"
    @queue.reject(delivery_info.delivery_tag, requeue: false) if manual_ack
  rescue StandardError => e
    handle_exception(e, lex: lex_name, fn: fn, routing_key: delivery_info.routing_key)
    reject_or_retry(delivery_info, metadata, payload) if manual_ack
  end
  log.info "[Subscription] prepared: #{lex_name}/#{runner_name}"
rescue StandardError => e
  handle_exception(e, level: :fatal)
end

#process_message(message, metadata, delivery_info) ⇒ Object 



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/legion/extensions/actors/subscription.rb', line 136

def process_message(message, metadata, delivery_info)
  payload = if metadata.content_encoding && metadata.content_encoding == 'encrypted/cs'
              headers = metadata.headers || {}
              iv = headers['iv'] || headers[:iv]
              raise UnrecoverableMessageError, "encrypted/cs message missing iv header (#{lex_name}/#{runner_name})" if iv.nil?

              Legion::Crypt.decrypt(message, iv)
            elsif metadata.content_encoding && metadata.content_encoding == 'encrypted/pk'
              Legion::Crypt.decrypt_from_keypair(metadata.headers[:public_key], message)
            else
              message
            end

  message = if metadata.content_type == 'application/json'
              Legion::JSON.load(payload)
            else
              { value: payload }
            end
  if include_metadata_in_message?
    message = message.merge(metadata.headers.transform_keys(&:to_sym)) unless metadata.headers.nil?
    message[:routing_key] = delivery_info[:routing_key]
  end

  message[:message_id] ||= metadata.message_id if metadata.respond_to?(:message_id) && metadata.message_id
  message[:correlation_id] ||= metadata.correlation_id if metadata.respond_to?(:correlation_id) && metadata.correlation_id

  message[:timestamp] = (message[:timestamp_in_ms] / 1000).round if message.key?(:timestamp_in_ms) && !message.key?(:timestamp)
  message[:datetime] = Time.at(message[:timestamp].to_i).to_datetime.to_s if message.key?(:timestamp)
  message
end

#queue ⇒ Object 



49
50
51
52
 
# File 'lib/legion/extensions/actors/subscription.rb', line 49

def queue
  create_queue unless queues.const_defined?(actor_const, false)
  queues.const_get(actor_const, false)
end

#queue_string ⇒ Object 



54
55
56
 
# File 'lib/legion/extensions/actors/subscription.rb', line 54

def queue_string
  @queue_string ||= "#{queues}::#{actor_const}"
end

#subscribe ⇒ Object 



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/legion/extensions/actors/subscription.rb', line 176

def subscribe
  log.info "[Subscription] subscribing: #{lex_name}/#{runner_name}"
  sleep(delay_start) if delay_start.positive?
  consumer_tag = "#{Legion::Settings[:client][:name]}_#{lex_name}_#{runner_name}_#{SecureRandom.uuid}"
  on_cancellation = block { cancel }

  @consumer = @queue.subscribe(manual_ack: manual_ack, block: false, consumer_tag: consumer_tag, on_cancellation: on_cancellation) do |*rmq_message|
    delivery_info = nil
    metadata = nil
    payload = nil
    fn = nil

    delivery_info = rmq_message.first
    metadata = rmq_message.last
    payload = rmq_message.pop
    message = process_message(payload, metadata, delivery_info)
    fn = find_function(message)
    log.debug "[Subscription] message received: #{lex_name}/#{fn}" if defined?(log)

    affinity_result = check_region_affinity(message)
    if affinity_result == :reject
      log.warn "[Subscription] nack: region affinity mismatch region=#{message[:region]} affinity=#{message[:region_affinity]}"
      @queue.reject(delivery_info.delivery_tag) if manual_ack
      next
    end

    if affinity_result == :remote
      log.debug 'Processing remote-region message ' \
                "(region=#{message[:region]}, affinity=#{message[:region_affinity]})"
      record_cross_region_metric(message)
    end

    if use_runner?
      dispatch_runner(message, runner_class, fn, check_subtask?, generate_task?)
    else
      runner_class.send(fn, **message)
    end
    @queue.acknowledge(delivery_info.delivery_tag) if manual_ack

    cancel if Legion::Settings[:client][:shutting_down]
  rescue UnrecoverableMessageError => e
    handle_exception(e, lex: lex_name, fn: fn)
    log.warn "[Subscription] dead-lettering unrecoverable message for #{lex_name}/#{fn}: #{e.message}"
    @queue.reject(delivery_info.delivery_tag, requeue: false) if manual_ack && delivery_info
  rescue StandardError => e
    handle_exception(e)
    log.warn "[Subscription] retry-or-dlq for #{lex_name}/#{fn}"
    reject_or_retry(delivery_info, metadata, payload) if manual_ack && delivery_info
  end
  log.info "[Subscription] subscribed: #{lex_name}/#{runner_name} (consumer registered)" if defined?(log)
end