moesif_rack 2.1.1 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d3b35f6574397e6afb25a0a8ad055d3a172ac217584ef7c67e4b895b4f2ab19
-  data.tar.gz: 6814b22faf3fc95704b19a5a0b0cc53c7015af87d18d04a69263645c6ef08fd7
+  metadata.gz: d22e96756a6c9b59c31a4615d96968dd2ab335540396a65389ddda9d8604b8b2
+  data.tar.gz: 40e942e0599207bb00917b0894f09f3cd42260bbf1bf3fa8e50c54abde0b57c3
 SHA512:
-  metadata.gz: e8fba367126b816b88bfafbb58dee2efdb903d4db3613f29ccf135881e3cbbbd1940ccb67bef1461bfcde52fc1ef9daeb8248fdae4de7387d387d80360341d25
-  data.tar.gz: df26774570df0d934d90e419b4b49e7cfc935f77b62326fba96b13d0129c38a4bc48788ca50f5af0d4828e544b2cda40dd448020bb6e190f19ead8fdf852016d
+  metadata.gz: 8fcff7759ab68baa2d7fad3c41e34816da6fb401106ade305e199347293971d52a9be62d52114915e318e46a945060608345bfa85619a1f364680af7211bef4d
+  data.tar.gz: f4740cb9b0181e73884d250b6c16bcdc9223366af390ebfb399e6731c4528a8c5d20ddb04c582234d0c7e763d58991c146d6cbf4da5ebe45d8a9ef69b303cd31

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2021 Moesif, Inc
+Copyright (c) 2023 Moesif, Inc
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/README.md

@@ -262,7 +262,7 @@ Optional. int, default 200, Maximum batch size when sending to Moesif.
 Optional. int in seconds Default 2.	This is the maximum wait time (approximately) before triggering flushing of the queue and sending to Moesif.
 
 #### __`event_queue_size`__
-Optional. int, Default 1000, Maximum number of events to hold in queue before sending to Moesif. In case of network issues when not able to connect/send event to Moesif, skips adding new to event to queue to prevent memory overflow.
+Optional. int, Default 1000000, Maximum number of events to hold in queue before sending to Moesif. In case of network issues when not able to connect/send event to Moesif, skips adding new to event to queue to prevent memory overflow.
 
 #### __`capture_outgoing_requests`__
 Optional. Boolean, Default `false`. Set to `true` to capture all outgoing API calls from your app to third parties like Stripe, Github or to your own dependencies while using [Net::HTTP](https://ruby-doc.org/stdlib-2.6.3/libdoc/net/http/rdoc/Net/HTTP.html) package. The options below is applied to outgoing API calls. When the request is outgoing, for options functions that take request and response as input arguments, the request and response objects passed in are [Request](https://www.rubydoc.info/stdlib/net/Net/HTTPRequest) request and [Response](https://www.rubydoc.info/stdlib/net/Net/HTTPResponse) response objects.

data/lib/moesif_rack/moesif_helpers.rb

@@ -38,4 +38,23 @@ class MoesifHelpers
     log_debug 'failed to convert replacement body ' + e.to_s
     [replacement_body.to_json.to_s]
   end
+
+  def parse_multipart(multipart_form_data, content_type)
+    log_debug("try to parse multiple part #{content_type}")
+
+    sanitized_multipart_form_data = multipart_form_data.gsub(/\r?\n/, "\r\n")
+
+    io = StringIO.new(sanitized_multipart_form_data)
+    tempfile = Rack::Multipart::Parser::TEMPFILE_FACTORY
+    bufsize = Rack::Multipart::Parser::BUFSIZE
+    query_parser = Rack::Utils.default_query_parser
+    result = Rack::Multipart::Parser.parse(io, sanitized_multipart_form_data.length, content_type, tempfile, bufsize,
+                                           query_parser)
+
+    log_debug('multipart parse result')
+    log_debug(result.inspect)
+
+    # this is a hash should be treated as JSON down the road.
+    result.params
+  end
 end

data/lib/moesif_rack/moesif_middleware.rb

@@ -18,7 +18,7 @@ module MoesifRack
       @app = app
       raise 'application_id required for Moesif Middleware' unless options['application_id']
 
-      @api_client = MoesifApi::MoesifAPIClient.new(options['application_id'], 'moesif-rack/2.1.1')
+      @api_client = MoesifApi::MoesifAPIClient.new(options['application_id'], 'moesif-rack/2.2.2')
       @api_controller = @api_client.api
 
       @api_version = options['api_version']
@@ -59,7 +59,7 @@ module MoesifRack
 
       @moesif_helpers.log_debug 'Start Capturing outgoing requests'
       require_relative '../../moesif_capture_outgoing/httplog'
-      MoesifCaptureOutgoing.start_capture_outgoing(options, @app_config, @events_queue)
+      MoesifCaptureOutgoing.start_capture_outgoing(options, @app_config, method(:add_to_queue), @moesif_helpers)
     end
 
     def update_user(user_profile)
@@ -94,31 +94,6 @@ module MoesifRack
       [Base64.encode64(body), 'base64']
     end
 
-    def @moesif_helpers.log_debug(message)
-      return unless @debug
-
-      puts("#{Time.now} [Moesif Middleware] PID #{Process.pid} TID #{Thread.current.object_id} #{message}")
-    end
-
-    def parse_multipart(multipart_form_data, content_type)
-      @moesif_helpers.log_debug("try to parse multiple part #{content_type}")
-
-      sanitized_multipart_form_data = multipart_form_data.gsub(/\r?\n/, "\r\n")
-
-      io = StringIO.new(sanitized_multipart_form_data)
-      tempfile = Rack::Multipart::Parser::TEMPFILE_FACTORY
-      bufsize = Rack::Multipart::Parser::BUFSIZE
-      query_parser = Rack::Utils.default_query_parser
-      result = Rack::Multipart::Parser.parse(io, sanitized_multipart_form_data.length, content_type, tempfile, bufsize,
-                                             query_parser)
-
-      @moesif_helpers.log_debug('multipart parse result')
-      @moesif_helpers.log_debug(result.inspect)
-
-      # this is a hash shold be treated as JSON down the road.
-      result.params
-    end
-
     def parse_body(body, headers)
       begin
         if body.instance_of?(Hash) || body.instance_of?(Array)
@@ -128,7 +103,7 @@ module MoesifRack
           parsed_body = JSON.parse(body)
           transfer_encoding = 'json'
         elsif headers.key?('content-type') && (headers['content-type'].downcase.include? 'multipart/form-data')
-          parsed_body = parse_multipart(body, headers['content-type'])
+          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)
@@ -143,6 +118,7 @@ module MoesifRack
     end
 
     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
@@ -182,6 +158,18 @@ module MoesifRack
       end
     end
 
+    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
+
     def call(env)
       start_time = Time.now.utc.iso8601(3)
 
@@ -303,10 +291,9 @@ module MoesifRack
       end
 
       process_send = lambda do |_event_model|
-        @moesif_helpers.log_debug 'sending data to moesif'
+        @moesif_helpers.log_debug 'incoming event to add to queue for sending to moesif'
         @moesif_helpers.log_debug _event_model.to_json
 
-        # Perform the API call through the SDK function
         begin
           random_percentage = Random.rand(0.00..100.00)
 
@@ -322,15 +309,7 @@ module MoesifRack
 
           if sampling_percentage > random_percentage
             _event_model.weight = @app_config.calculate_weight(sampling_percentage)
-            # 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)
+            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

data/moesif_capture_outgoing/httplog/adapters/net_http.rb

@@ -7,10 +7,14 @@ module Net
     def request(request, body = nil, &block)
       # Request Start Time
       request_time = Time.now.utc.iso8601(3)
-
       # URL
       url = "https://#{@address}#{request.path}"
 
+      if (not request.body_stream.nil?) && MoesifCaptureOutgoing.should_capture_body
+        req_body_from_stream = request.body_stream.read
+        request.body_stream.rewind
+      end
+
       # Response
       @response = orig_request(request, body, &block)
 
@@ -18,7 +22,8 @@ module Net
       response_time = Time.now.utc.iso8601(3)
 
       # Log Event to Moesif
-      MoesifCaptureOutgoing.call(url, request, request_time, @response, response_time) if started?
+      body_from_req_call = body
+      MoesifCaptureOutgoing.call(url, request, request_time, @response, response_time, body_from_req_call, req_body_from_stream) if started?
 
       @response
     end

data/moesif_capture_outgoing/httplog/http_log.rb

@@ -7,7 +7,7 @@ require_relative '../../lib/moesif_rack/app_config'
 
 module MoesifCaptureOutgoing
   class << self
-    def start_capture_outgoing(options, app_config_manager, events_queue)
+    def start_capture_outgoing(options, app_config_manager, add_to_queue, moesif_helpers)
       @moesif_options = options
       raise 'application_id required for Moesif Middleware' unless @moesif_options['application_id']
 
@@ -23,15 +23,21 @@ module MoesifCaptureOutgoing
       @log_body_outgoing = options.fetch('log_body_outgoing', true)
 
       @app_config = app_config_manager
-      # @app_config and @events_queue should be shared instance from the middleware
-      # so that we can use the same queue and same loaded @app_config
-      @events_queue = events_queue
+      # @app_config is shared instance from the middleware
+      # so same loaded @app_config
+      # add_to_queue is method from the middleware so that we can add to the same queue
+      @add_to_queue = add_to_queue
       @sampling_percentage = 100
       @last_updated_time = Time.now.utc
+      @moesif_helpers = moesif_helpers
     end
 
-    def call(url, request, request_time, response, response_time)
-      send_moesif_event(url, request, request_time, response, response_time)
+    def should_capture_body
+      @moesif_options.nil? ? false : @moesif_options['capture_outgoing_requests'] && @log_body_outgoing
+    end
+
+    def call(url, request, request_time, response, response_time, body_from_req_call, req_body_from_stream)
+      send_moesif_event(url, request, request_time, response, response_time, body_from_req_call, req_body_from_stream)
     end
 
     def get_response_body(response)
@@ -44,18 +50,30 @@ module MoesifCaptureOutgoing
       Rack::Utils::HTTP_STATUS_CODES.detect { |_k, v| v.to_s.casecmp(response_code_name.to_s).zero? }.first
     end
 
-    def send_moesif_event(url, request, request_time, response, response_time)
+    def send_moesif_event(url, request, request_time, response, response_time, body_from_req_call, req_body_from_stream)
       if url.downcase.include? 'moesif'
-        puts 'Skip sending as it is moesif Event' if @debug
+        @moesif_helpers.log_debug 'Skip adding to queue as it is moesif Event'
       else
         response.code = transform_response_code(response.code) if response.code.is_a?(Symbol)
 
+        # Request headers
+        req_headers = request.each_header.collect.to_h
+        req_content_type = req_headers['content-type'].nil? ? req_headers['Content-Type'] : req_headers['content-type']
+
         # Request Body
-        req_body_string = request.body.nil? || request.body.empty? ? nil : request.body
+        req_body_string = request.body.nil? || request.body.empty? ? body_from_req_call : request.body
         req_body_transfer_encoding = nil
         req_body = nil
 
-        if @log_body_outgoing && (req_body_string && req_body_string.length != 0)
+        if @log_body_outgoing && (not req_content_type.nil?) && (req_content_type.downcase.include? 'multipart/form-data')
+          @moesif_helpers.log_debug 'outgoing request is multipart, parsing req_body_from_stream'
+          begin
+            req_body = @moesif_helpers.parse_multipart(req_body_from_stream, req_content_type)
+          rescue StandardError => e
+            @moesif_helpers.log_debug 'outgoing request is multipart, but failed to process req_body_from_stream: ' + req_body_from_stream.to_s + e.to_s
+            req_body = nil
+          end
+        elsif @log_body_outgoing && (req_body_string && req_body_string.length != 0)
           begin
             req_body = JSON.parse(req_body_string)
           rescue StandardError
@@ -83,8 +101,9 @@ module MoesifCaptureOutgoing
         event_req.time = request_time
         event_req.uri = url
         event_req.verb = request.method.to_s.upcase
-        event_req.headers = request.each_header.collect.to_h
+        event_req.headers = req_headers
         event_req.api_version = nil
+
         event_req.body = req_body
         event_req.transfer_encoding = req_body_transfer_encoding
 
@@ -155,19 +174,14 @@ module MoesifCaptureOutgoing
 
             if @sampling_percentage > @random_percentage
               event_model.weight = @app_config.calculate_weight(@sampling_percentage)
-              if @debug
-                puts 'Sending Outgoing Request Data to Moesif'
-                puts event_model.to_json
-              end
-
-              # we put in the queue and format abot it.
-              unless @events_queue.nil?
-                @events_queue << event_model
-                puts('Outgoing Event successfully added to event queue') if @debug
-                return
-              end
-            elsif @debug
-              puts('Skipped outgoing Event due to sampling percentage: ' + @sampling_percentage.to_s + ' and random percentage: ' + @random_percentage.to_s)
+              @moesif_helpers.log_debug 'Adding Outgoing Request Data to Queue'
+              @moesif_helpers.log_debug event_model.to_json
+              # we put in the queue and forget it.
+              @add_to_queue.call(event_model)
+              @moesif_helpers.log_debug 'Finished adding outgoing request data to Queue'
+
+            else
+              @moesif_helpers.log_debug('Skipped outgoing Event due to sampling percentage: ' + @sampling_percentage.to_s + ' and random percentage: ' + @random_percentage.to_s)
             end
           rescue MoesifApi::APIException => e
             if e.response_code.between?(401, 403)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moesif_rack
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.2
 platform: ruby
 authors:
 - Moesif, Inc
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-26 00:00:00.000000000 Z
+date: 2023-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit