Class: MoesifRack::MoesifMiddleware

Inherits:
Object
  • Object
show all
Defined in:
lib/moesif_rack/moesif_middleware.rb

Instance Method Summary collapse

Constructor Details

#initialize(app, options = {}) ⇒ MoesifMiddleware

Returns a new instance of MoesifMiddleware.



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/moesif_rack/moesif_middleware.rb', line 17

def initialize(app, options = {})
  @app = app
  raise 'application_id required for Moesif Middleware' unless options['application_id']

  @api_client = MoesifApi::MoesifAPIClient.new(options['application_id'], 'moesif-rack/2.2.3')
  @api_controller = @api_client.api

  @api_version = options['api_version']
  @identify_user = options['identify_user']
  @identify_company = options['identify_company']
  @get_metadata = options['get_metadata']
  @identify_session = options['identify_session']
  @mask_data = options['mask_data']
  @skip = options['skip']
  @debug = options['debug']
  @app_config = AppConfig.new(@debug)
  @moesif_helpers = MoesifHelpers.new(@debug)

  @disable_transaction_id = options['disable_transaction_id'] || false
  @log_body = options.fetch('log_body', true)
  @batch_size = options['batch_size'] || 200
  @event_queue_size = options['event_queue_size'] || 1000000
  @batch_max_time = options['batch_max_time'] || 2
  @events_queue = Queue.new
  @event_response_config_etag = nil
  @governance_manager = GovernanceRules.new(@debug)

  # start the worker and Update the last worker run
  @last_worker_run = Time.now.utc
  start_worker

  begin
    @app_config.get_config(@api_controller)
    @governance_manager.load_rules(@api_controller)
  rescue StandardError => e
    @moesif_helpers.log_debug 'Error while parsing application configuration on initialization'
    @moesif_helpers.log_debug e.to_s
  end
  # backwards compatibility for a typo in docs
  @capture_outoing_requests = options['capture_outoing_requests']
  @capture_outgoing_requests = options['capture_outgoing_requests']
  return unless @capture_outoing_requests || @capture_outgoing_requests

  @moesif_helpers.log_debug 'Start Capturing outgoing requests'
  require_relative '../../moesif_capture_outgoing/httplog'
  MoesifCaptureOutgoing.start_capture_outgoing(options, @app_config, method(:add_to_queue), @moesif_helpers)
end

Instance Method Details

#add_to_queue(_event_model) ⇒ Object 



161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/moesif_rack/moesif_middleware.rb', line 161

def add_to_queue(_event_model)
  # Add Event to the queue
  if @events_queue.size >= @event_queue_size
    @moesif_helpers.log_debug("Skipped Event due to events_queue size [#{@events_queue.size}] is over max #{@event_queue_size} ")
  else
    @events_queue << _event_model
    @moesif_helpers.log_debug('Event added to the queue ')
  end

  start_worker if Time.now.utc > (@last_worker_run + 60)
end

#base64_encode_body(body) ⇒ Object 



93
94
95
 
# File 'lib/moesif_rack/moesif_middleware.rb', line 93

def base64_encode_body(body)
  [Base64.encode64(body), 'base64']
end

#call(env) ⇒ Object 



173
174
175
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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/moesif_rack/moesif_middleware.rb', line 173

def call(env)
  start_time = Time.now.utc.iso8601(3)

  @moesif_helpers.log_debug('Calling Moesif middleware')

  status, headers, body = @app.call env
  end_time = Time.now.utc.iso8601(3)

  make_event_model = lambda do
    req = Rack::Request.new(env)
    complex_copy = env.dup

    # Filter hash to only have keys of type string
    complex_copy = complex_copy.select { |k, _v| k.is_a? String }

    req_headers = {}
    complex_copy.select { |k, _v| k.start_with?('HTTP_', 'CONTENT_') }.each do |key, val|
      new_key = key.sub(/^HTTP_/, '')
      new_key = new_key.sub('_', '-')
      req_headers[new_key] = val
    end

    # rewind first in case someone else already read the body
    req.body.rewind
    req_body_string = req.body.read
    req.body.rewind
    req_body_transfer_encoding = nil
    req_body = nil

    if @log_body && (req_body_string && req_body_string.length != 0)
      req_body, req_body_transfer_encoding = parse_body(req_body_string,
                                                        transform_headers(req_headers))
    end

    rsp_headers = headers.dup

    rsp_body_string = get_response_body(body)
    rsp_body_transfer_encoding = nil
    rsp_body = nil

    if @log_body && (rsp_body_string && rsp_body_string.length != 0)
      rsp_body, rsp_body_transfer_encoding = parse_body(rsp_body_string,
                                                        transform_headers(rsp_headers))
    end

    event_req = MoesifApi::EventRequestModel.new
    event_req.time = start_time
    event_req.uri = req.url
    event_req.verb = req.request_method

    event_req.api_version = @api_version if @api_version

    # Add Transaction Id to the Request Header
    unless @disable_transaction_id
      req_trans_id = req_headers['X-MOESIF_TRANSACTION_ID']
      if !req_trans_id.nil?
        transaction_id = req_trans_id
        transaction_id = SecureRandom.uuid if transaction_id.strip.empty?
      else
        transaction_id = SecureRandom.uuid
      end
      # Add Transaction Id to Request Header
      req_headers['X-Moesif-Transaction-Id'] = transaction_id
      # Filter out the old key as HTTP Headers case are not preserved
      req_headers = req_headers.except('X-MOESIF_TRANSACTION_ID') if req_headers.key?('X-MOESIF_TRANSACTION_ID')
    end

    # Add Transaction Id to the Response Header
    rsp_headers['X-Moesif-Transaction-Id'] = transaction_id unless transaction_id.nil?

    # Add Transaction Id to the Repsonse Header sent to the client
    headers['X-Moesif-Transaction-Id'] = transaction_id unless transaction_id.nil?

    event_req.ip_address = get_client_address(req.env)
    event_req.headers = req_headers
    event_req.body = req_body
    event_req.transfer_encoding = req_body_transfer_encoding

    event_rsp = MoesifApi::EventResponseModel.new
    event_rsp.time = end_time
    event_rsp.status = status
    event_rsp.headers = rsp_headers
    event_rsp.body = rsp_body
    event_rsp.transfer_encoding = rsp_body_transfer_encoding

    _event_model = MoesifApi::EventModel.new
    _event_model.request = event_req
    _event_model.response = event_rsp
    _event_model.direction = 'Incoming'

    if @identify_user
      @moesif_helpers.log_debug 'calling identify user proc'
      _event_model.user_id = @identify_user.call(env, headers, body)
    end

    if @identify_company
      @moesif_helpers.log_debug 'calling identify company proc'
      _event_model.company_id = @identify_company.call(env, headers, body)
    end

    if @get_metadata
      @moesif_helpers.log_debug 'calling get_metadata proc'
      _event_model.metadata = @get_metadata.call(env, headers, body)
    end

    if @identify_session
      @moesif_helpers.log_debug 'calling identify session proc'
      _event_model.session_token = @identify_session.call(env, headers, body)
    end
    if @mask_data
      @moesif_helpers.log_debug 'calling mask_data proc'
      _event_model = @mask_data.call(_event_model)
    end

    return _event_model
  rescue StandardError => e
    @moesif_helpers.log_debug 'Error making event model'
    @moesif_helpers.log_debug e.to_s
  end

  process_send = lambda do |_event_model|
    @moesif_helpers.log_debug 'incoming event to add to queue for sending to moesif'
    @moesif_helpers.log_debug _event_model.to_json

    begin
      random_percentage = Random.rand(0.00..100.00)

      begin
        sampling_percentage = @app_config.get_sampling_percentage(_event_model, _event_model.user_id,
                                                                  _event_model.company_id)
        @moesif_helpers.log_debug "Using sample rate #{sampling_percentage}"
      rescue StandardError => e
        @moesif_helpers.log_debug 'Error while getting sampling percentage, assuming default behavior'
        @moesif_helpers.log_debug e.to_s
        sampling_percentage = 100
      end

      if sampling_percentage > random_percentage
        _event_model.weight = @app_config.calculate_weight(sampling_percentage)
        add_to_queue(_event_model)
      else
        @moesif_helpers.log_debug('Skipped Event due to sampling percentage: ' + sampling_percentage.to_s + ' and random percentage: ' + random_percentage.to_s)
      end
    rescue StandardError => e
      @moesif_helpers.log_debug 'Error adding event to the queue '
      @moesif_helpers.log_debug e.to_s
    end
  end

  should_skip = false

  should_skip = true if @skip && @skip.call(env, headers, body)

  should_govern = @governance_manager.has_rules

  event_model = make_event_model.call if !should_skip || should_govern

  if should_govern
    # now we can do govern based on
    # override_response = govern(env, event_model)
    # return override_response if override_response
    new_response = @governance_manager.govern_request(@app_config.config, env, event_model, status, headers, body)

    # update the event model
    if new_response
      @moesif_helpers.log_debug 'new response back from govern' + new_response.to_json

      # replace headers since it might be non blocking rules that adds headers
      headers = new_response.fetch(:headers, headers)

      # replace in event_model
      event_model.response.headers = new_response.fetch(:headers, headers).dup

      blocked_by = new_response.fetch(:block_rule_id, nil)

      unless blocked_by.nil?
        # we only replace body and status if it is blocked.
        body = @moesif_helpers.format_replacement_body(new_response.fetch(:body, nil), body)
        status = new_response.fetch(:status, status)

        # replace the event model.
        event_model.blocked_by = blocked_by
        event_model.response.status = new_response.fetch(:status, status)
        replaced_body = new_response.fetch(:body, event_model.response.body)
        event_model.response.body = replaced_body
        # replaced body is always json should not be transfer encoding needed.
        event_model.response.transfer_encoding = 'json'
      end
    end
  end

  if !should_skip
    begin
      process_send.call(event_model)
    rescue StandardError => e
      @moesif_helpers.log_debug 'Error while logging event - '
      @moesif_helpers.log_debug e.to_s
      @moesif_helpers.log_debug e.backtrace
    end
  else
    @moesif_helpers.log_debug 'Skipped Event using should_skip configuration option.'
  end

  [status, headers, body]
end

#decompress_body(body) ⇒ Object 



85
86
87
 
# File 'lib/moesif_rack/moesif_middleware.rb', line 85

def decompress_body(body)
  Zlib::GzipReader.new(StringIO.new(body)).read
end

#get_response_body(response) ⇒ Object 



379
380
381
382
383
384
385
 
# File 'lib/moesif_rack/moesif_middleware.rb', line 379

def get_response_body(response)
  body = response.respond_to?(:body) ? response.body : response
  return body if body.instance_of?(Hash) || body.instance_of?(Array)

  body = body.inject('') { |i, a| i << a } if body.respond_to?(:each) && body.respond_to?(:inject)
  body.to_s
end

#parse_body(body, headers) ⇒ Object 



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/moesif_rack/moesif_middleware.rb', line 97

def parse_body(body, headers)
  begin
    if body.instance_of?(Hash) || body.instance_of?(Array)
      parsed_body = body
      transfer_encoding = 'json'
    elsif start_with_json(body)
      parsed_body = JSON.parse(body)
      transfer_encoding = 'json'
    elsif headers.key?('content-type') && (headers['content-type'].downcase.include? 'multipart/form-data')
      parsed_body = @moesif_helpers.parse_multipart(body, headers['content-type'])
      transfer_encoding = 'json'
    elsif headers.key?('content-encoding') && (headers['content-encoding'].downcase.include? 'gzip')
      uncompressed_string = decompress_body(body)
      parsed_body, transfer_encoding = base64_encode_body(uncompressed_string)
    else
      parsed_body, transfer_encoding = base64_encode_body(body)
    end
  rescue StandardError
    parsed_body, transfer_encoding = base64_encode_body(body)
  end
  [parsed_body, transfer_encoding]
end

#start_with_json(body) ⇒ Object 



81
82
83
 
# File 'lib/moesif_rack/moesif_middleware.rb', line 81

def start_with_json(body)
  body.start_with?('{') || body.start_with?('[')
end

#start_worker ⇒ Object 



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/moesif_rack/moesif_middleware.rb', line 120

def start_worker
  @moesif_helpers.log_debug('start worker');
  Thread.new do
    loop do
      # Update the last worker run, in case the events_queue is empty
      @last_worker_run = Time.now.utc
      begin
        until @events_queue.empty?
          # Update the last worker run in case sending events take more than 60 seconds
          @last_worker_run = Time.now.utc
          # Populate the batch events from queue
          batch_events = []
          batch_events << @events_queue.pop until batch_events.size == @batch_size || @events_queue.empty?
          @moesif_helpers.log_debug("Sending #{batch_events.size} events to Moesif")
          event_api_response = @api_controller.create_events_batch(batch_events)
          @event_response_config_etag = event_api_response[:x_moesif_config_etag]
          @moesif_helpers.log_debug(event_api_response.to_s)
          @moesif_helpers.log_debug('Events successfully sent to Moesif')
        end

        @moesif_helpers.log_debug('No events to read from the queue') if @events_queue.empty?

        if @app_config.should_reload(@event_response_config_etag)
          @app_config.get_config(@api_controller)
          @governance_manager.load_rules(@api_controller)
        end

        sleep @batch_max_time
      rescue MoesifApi::APIException => e
        if e.response_code.between?(401, 403)
          puts 'Unathorized accesss sending event to Moesif. Please verify your Application Id.'
          @moesif_helpers.log_debug(e.to_s)
        end
        @moesif_helpers.log_debug("Error sending event to Moesif, with status code #{e.response_code}")
      rescue StandardError => e
        @moesif_helpers.log_debug(e.to_s)
      end
    end
  end
end

#transform_headers(headers) ⇒ Object 



89
90
91
 
# File 'lib/moesif_rack/moesif_middleware.rb', line 89

def transform_headers(headers)
  Hash[headers.map { |k, v| [k.downcase, v] }]
end

#update_companies_batch(company_profiles) ⇒ Object 



77
78
79
 
# File 'lib/moesif_rack/moesif_middleware.rb', line 77

def update_companies_batch(company_profiles)
  CompanyHelper.new.update_companies_batch(@api_controller, @debug, company_profiles)
end

#update_company(company_profile) ⇒ Object 



73
74
75
 
# File 'lib/moesif_rack/moesif_middleware.rb', line 73

def update_company(company_profile)
  CompanyHelper.new.update_company(@api_controller, @debug, company_profile)
end

#update_user(user_profile) ⇒ Object 



65
66
67
 
# File 'lib/moesif_rack/moesif_middleware.rb', line 65

def update_user()
  UserHelper.new.update_user(@api_controller, @debug, )
end

#update_users_batch(user_profiles) ⇒ Object 



69
70
71
 
# File 'lib/moesif_rack/moesif_middleware.rb', line 69

def update_users_batch(user_profiles)
  UserHelper.new.update_users_batch(@api_controller, @debug, user_profiles)
end