moesif_rack 1.5.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed6afe67a6d8b2aa3c05b23a704d2ccfaadf9afdb078e9d66998f69fd7ed3f45
-  data.tar.gz: 3cb56517e37769f179aabf0f1621c0969259558a46fa8594c017f85098f77423
+  metadata.gz: ad15d06f64a1f2617468e24773e1be77bda0b774474e8a1f5aa91574b05f5576
+  data.tar.gz: 5456b4c5efc5b9239361603192cb0c3d0635cb63ed0be8ebd89fddaca96777b0
 SHA512:
-  metadata.gz: 91987307ffe2aaf10763dc39e0dce6acc1d91ed8f614144811b2a0d7c579b06d4f4f112cf6de10a983153aa81f45d5dac3450be5c38658af71728656d4426d5c
-  data.tar.gz: f6a677544fd723f0ab6842e5496586d93f22b8ddf77fc5ceb1c4fb98f770ce5443461a66f6c744f03b03a428acfa1c55c669d4f4f09841191c99842a40e614f6
+  metadata.gz: d162f1712129b7527cb40a7cb3d10387acd677f0e073c3ae8ae543eaff35b1ac72b797d0e5c09726fd725d07ee2b9db841ff173cd63be1f879d3e2bb8bd15f32
+  data.tar.gz: 11290586d6235cb8be998b95c43636d8c57b477e0007cb13dd4fb5272432f552c4ad7012f4895b9096b6f8e8761b4e889b3ddb65a43dc68efb0a1499b688e0e9

data/lib/moesif_rack/app_config.rb

@@ -7,18 +7,37 @@ require_relative './moesif_helpers'
 require_relative './regex_config_helper'
 
 class AppConfig
+  attr_accessor :config, :recent_etag, :last_download_time
+
   def initialize(debug)
     @debug = debug
     @moesif_helpers = MoesifHelpers.new(debug)
     @regex_config_helper = RegexConfigHelper.new(debug)
   end
 
+  def should_reload(etag_from_create_event)
+    if @last_download_time.nil?
+      return true
+    elsif Time.now.utc > (@last_download_time + 300)
+      return true
+    elsif !etag_from_create_event.nil? && !@recent_etag.nil?
+      @moesif_helpers.log_debug('comparing if etag from event and recent etag match ' + etag_from_create_event + ' ' + @recent_etag)
+
+      return etag_from_create_event != @recent_etag
+    end
+    @moesif_helpers.log_debug('should skip reload config')
+    return false;
+  end
+
   def get_config(api_controller)
     # Get Application Config
-    config_api_response = api_controller.get_app_config
+    @moesif_helpers.log_debug('try to loading etag')
+    config_json, _context = api_controller.get_app_config
+    @config = config_json
+    @recent_etag = _context.response.headers[:x_moesif_config_etag]
+    @last_download_time = Time.now.utc
     @moesif_helpers.log_debug('new config downloaded')
-    @moesif_helpers.log_debug(config_api_response.to_s)
-    config_api_response
+    @moesif_helpers.log_debug(config_json.to_s)
   rescue MoesifApi::APIException => e
     if e.response_code.between?(401, 403)
       @moesif_helpers.log_debug 'Unauthorized access getting application configuration. Please check your Appplication Id.'
@@ -29,38 +48,15 @@ class AppConfig
     @moesif_helpers.log_debug e.to_s
   end
 
-  def parse_configuration(config_api_response)
-    # Parse configuration object and return Etag, sample rate and last updated time
-
-    # Rails return gzipped compressed response body, so decompressing it and getting JSON response body
-    response_body = @moesif_helpers.decompress_gzip_body(config_api_response)
-    @moesif_helpers.log_debug(response_body.to_json)
-
-    # Check if response body is not nil
-    return response_body, config_api_response.headers[:x_moesif_config_etag], Time.now.utc unless response_body.nil?
-
-    # Return Etag, sample rate and last updated time
-
-    @moesif_helpers.log_debug 'Response body is nil, assuming default behavior'
-    # Response body is nil, so assuming default behavior
-    [nil, nil, Time.now.utc]
-  rescue StandardError => e
-    @moesif_helpers.log_debug 'Error while parsing the configuration object, assuming default behavior'
-    @moesif_helpers.log_debug e.to_s
-    # Assuming default behavior
-    [nil, nil, Time.now.utc]
-  end
-
-  def get_sampling_percentage(event_model, config_api_response, user_id, company_id)
+  def get_sampling_percentage(event_model, user_id, company_id)
+    # if we do not have config for some reason we return 100
+    if !@config.nil?
     # Get sampling percentage
-
-    # Check if response body is not nil
-    if !config_api_response.nil?
       @moesif_helpers.log_debug("Getting sample rate for user #{user_id} company #{company_id}")
-      @moesif_helpers.log_debug(config_api_response.to_s)
+      @moesif_helpers.log_debug(@config.to_s)
 
       # Get Regex Sampling rate
-      regex_config = config_api_response.fetch('regex_config', nil)
+      regex_config = @config.fetch('regex_config', nil)
 
       if !regex_config.nil? and !event_model.nil?
         config_mapping = @regex_config_helper.prepare_config_mapping(event_model)
@@ -70,10 +66,10 @@ class AppConfig
       end
 
       # Get user sample rate object
-      user_sample_rate = config_api_response.fetch('user_sample_rate', nil)
+      user_sample_rate = @config.fetch('user_sample_rate', nil)
 
       # Get company sample rate object
-      company_sample_rate = config_api_response.fetch('company_sample_rate', nil)
+      company_sample_rate = @config.fetch('company_sample_rate', nil)
 
       # Get sample rate for the user if exist
       if !user_id.nil? && !user_sample_rate.nil? && user_sample_rate.key?(user_id)
@@ -85,8 +81,8 @@ class AppConfig
         return company_sample_rate.fetch(company_id)
       end
 
-      # Return sample rate
-      config_api_response.fetch('sample_rate', 100)
+      # Return overall sample rate
+      @config.fetch('sample_rate', 100)
     else
       @moesif_helpers.log_debug 'Assuming default behavior as response body is nil - '
       100

data/lib/moesif_rack/governance_rules.rb

@@ -109,10 +109,7 @@ class GovernanceRules
     # Get Application Config
     @last_fetch = Time.now.utc
     @moesif_helpers.log_debug('starting downlaoding rules')
-    rules_response = api_controller.get_rules
-    rules = @moesif_helpers.decompress_gzip_body(rules_response)
-    @moesif_helpers.log_debug('new rules downloaded')
-    @moesif_helpers.log_debug(rules.to_json)
+    rules, _context = api_controller.get_rules
 
     generate_rules_caching(rules)
   rescue MoesifApi::APIException => e

data/lib/moesif_rack/moesif_helpers.rb

@@ -12,30 +12,6 @@ class MoesifHelpers
     puts("#{Time.now} [Moesif Middleware] PID #{Process.pid} TID #{Thread.current.object_id} #{message}")
   end
 
-  def decompress_gzip_body(moesif_api_response)
-    # Decompress gzip response body
-
-    # Check if the content-encoding header exist and is of type zip
-    if moesif_api_response.headers.key?(:content_encoding) && moesif_api_response.headers[:content_encoding].eql?('gzip')
-
-      # Create a GZipReader object to read data
-      gzip_reader = Zlib::GzipReader.new(StringIO.new(moesif_api_response.raw_body.to_s))
-
-      # Read the body
-      uncompressed_string = gzip_reader.read
-
-      # Return the parsed body
-      JSON.parse(uncompressed_string)
-    else
-      @moesif_helpers.log_debug 'Content Encoding is of type other than gzip, returning nil'
-      nil
-    end
-  rescue StandardError => e
-    @moesif_helpers.log_debug 'Error while decompressing the response body'
-    @moesif_helpers.log_debug e.to_s
-    nil
-  end
-
   def format_replacement_body(replacement_body, original_body)
     # replacement_body is an hash or array json in this case.
     # but original body could be in chunks already. we want to follow suit.

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'])
+      @api_client = MoesifApi::MoesifAPIClient.new(options['application_id'], 'moesif-rack/2.0.2')
       @api_controller = @api_client.api
 
       @api_version = options['api_version']
@@ -32,9 +32,6 @@ module MoesifRack
       @app_config = AppConfig.new(@debug)
       @moesif_helpers = MoesifHelpers.new(@debug)
 
-      @config_etag = nil
-      @last_config_download_time = Time.now.utc
-      @config_dict = {}
       @disable_transaction_id = options['disable_transaction_id'] || false
       @log_body = options.fetch('log_body', true)
       @batch_size = options['batch_size'] || 200
@@ -49,22 +46,20 @@ module MoesifRack
       start_worker
 
       begin
-        new_config = @app_config.get_config(@api_controller)
-        unless new_config.nil?
-          @config, @config_etag, @last_config_download_time = @app_config.parse_configuration(new_config)
-        end
+        @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)
+      MoesifCaptureOutgoing.start_capture_outgoing(options, @app_config, @events_queue)
     end
 
     def update_user(user_profile)
@@ -167,20 +162,10 @@ module MoesifRack
             end
 
             @moesif_helpers.log_debug('No events to read from the queue') if @events_queue.empty?
-            if (!@event_response_config_etag.nil? && !@config_etag.nil? && @config_etag != @event_response_config_etag) || (Time.now.utc > (@last_config_download_time + 300))
-              begin
-                @moesif_helpers.log_debug('try to reload config and rules again')
-                new_config = @app_config.get_config(@api_controller)
-                unless new_config.nil?
-                  @config, @config_etag, @last_config_download_time = @app_config.parse_configuration(new_config)
-                end
-                # since logic to reload config is already here for every 5 minutes,
-                # reload rules here also.
-                @governance_manager.load_rules(@api_controller)
-              rescue StandardError => e
-                @moesif_helpers.log_debug 'Error while updating the application configuration'
-                @moesif_helpers.log_debug e.to_s
-              end
+
+            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
@@ -326,7 +311,7 @@ module MoesifRack
           random_percentage = Random.rand(0.00..100.00)
 
           begin
-            sampling_percentage = @app_config.get_sampling_percentage(_event_model, @config, _event_model.user_id,
+            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
@@ -367,7 +352,7 @@ module MoesifRack
         # 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(@config, env, event_model, status, headers, body)
+        new_response = @governance_manager.govern_request(@app_config.config, env, event_model, status, headers, body)
 
         # update the event model
         if new_response

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)
+    def start_capture_outgoing(options, app_config_manager, events_queue)
       @moesif_options = options
       raise 'application_id required for Moesif Middleware' unless @moesif_options['application_id']
 
@@ -21,22 +21,13 @@ module MoesifCaptureOutgoing
       @skip_outgoing = options['skip_outgoing']
       @mask_data_outgoing = options['mask_data_outgoing']
       @log_body_outgoing = options.fetch('log_body_outgoing', true)
-      @app_config = AppConfig.new(@debug)
-      @config_etag = nil
+
+      @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
       @sampling_percentage = 100
       @last_updated_time = Time.now.utc
-      @config_dict = {}
-      begin
-        new_config = @app_config.get_config(@api_controller)
-        unless new_config.nil?
-          @config, @config_etag, @last_config_download_time = @app_config.parse_configuration(new_config)
-        end
-      rescue StandardError => e
-        if @debug
-          puts 'Error while parsing application configuration on initialization'
-          puts e
-        end
-      end
     end
 
     def call(url, request, request_time, response, response_time)
@@ -152,7 +143,7 @@ module MoesifCaptureOutgoing
           begin
             @random_percentage = Random.rand(0.00..100.00)
             begin
-              @sampling_percentage = @app_config.get_sampling_percentage(event_model, @config, event_model.user_id,
+              @sampling_percentage = @app_config.get_sampling_percentage(event_model, event_model.user_id,
                                                                          event_model.company_id)
             rescue StandardError => e
               if @debug
@@ -168,23 +159,13 @@ module MoesifCaptureOutgoing
                 puts 'Sending Outgoing Request Data to Moesif'
                 puts event_model.to_json
               end
-              event_api_response = @api_controller.create_event(event_model)
-              event_response_config_etag = event_api_response[:x_moesif_config_etag]
-
-              if !event_response_config_etag.nil? && !@config_etag.nil? && @config_etag != event_response_config_etag && Time.now.utc > @last_updated_time + 300
-                begin
-                  new_config = @app_config.get_config(@api_controller)
-                  unless new_config.nil?
-                    @config, @config_etag, @last_config_download_time = @app_config.parse_configuration(new_config)
-                  end
-                rescue StandardError => e
-                  if @debug
-                    puts 'Error while updating the application configuration'
-                    puts e
-                  end
-                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
-              puts('Event successfully sent to Moesif') if @debug
             elsif @debug
               puts('Skipped outgoing Event due to sampling percentage: ' + @sampling_percentage.to_s + ' and random percentage: ' + @random_percentage.to_s)
             end

data/test/config_example.json

@@ -1469,9 +1469,5 @@
     ]
   },
   "ip_addresses_blocked_by_name": {},
-  "regex_config": [],
-  "billing_config_jsons": {
-    "stripe": "{\"user_id_field\":\"id\",\"company_id_field\":\"metadata.uuid\"}",
-    "recurly": "{\"user_id_field\":\"account_code\",\"company_id_field\":\"uuid\"}"
-  }
+  "regex_config": []
 }

data/test/test_governance_rules.rb

@@ -1,6 +1,6 @@
 require 'moesif_api'
 require 'test/unit'
-require 'rack'
+
 require 'net/http'
 require_relative '../lib/moesif_rack/app_config'
 require_relative '../lib/moesif_rack'
@@ -61,10 +61,10 @@ class GovernanceRulesTest < Test::Unit::TestCase
     #for user id matched rules it depends on getting from config_rules_values
     #for that particular user id.
     # for this test case I will use this rule as fake input
-    #https://www.moesif.com/wrap/app/88:210-1051:5/governance-rule/64a5b8f9aca3042266d36ebc
+    #https://www.moesif.com/wrap/app/88:210-660:387/governance-rule/64a783a3e7d62b036d16006e
     config_user_rules_values = [
       {
-        "rules" => "64a5b8f9aca3042266d36ebc",
+        "rules" => "64a783a3e7d62b036d16006e",
         "values" => {
           "0" => "rome",
           "1" => "some value for 1",
@@ -105,9 +105,10 @@ class GovernanceRulesTest < Test::Unit::TestCase
     }
     user_id = 'vancouver1'
 
+    # https://www.moesif.com/wrap/app/88:210-660:387/governance-rule/64a783a43660b60f7c766a06
     config_user_rules_values = [
       {
-        "rules" => "64a5b8fa3660b60f7c7662fc",
+        "rules" => "64a783a43660b60f7c766a06",
         "values" => {
           "0" => "city",
           "1" => "some value for 1",

data/test/{moesif_rack_test.rb → test_moesif_rack.rb}

@@ -45,6 +45,7 @@ class MoesifRackTest < Test::Unit::TestCase
       event_model
     }
   }
+
     @moesif_rack_app = MoesifRack::MoesifMiddleware.new(@app, @options)
     @app_config = AppConfig.new(true)
   end
@@ -72,9 +73,9 @@ class MoesifRackTest < Test::Unit::TestCase
     campaign_model = {"utm_source" => "Newsletter",
                       "utm_medium" => "Email"}
 
-    user_model = { "user_id" => "12345", 
+    user_model = { "user_id" => "12345",
                    "company_id" => "67890",
-                   "modified_time" => Time.now.utc.iso8601, 
+                   "modified_time" => Time.now.utc.iso8601,
                    "metadata" => metadata,
                    "campaign" => campaign_model}
 
@@ -91,14 +92,14 @@ class MoesifRackTest < Test::Unit::TestCase
 
     user_models = []
 
-    user_model_A = { "user_id" => "12345", 
+    user_model_A = { "user_id" => "12345",
                    "company_id" => "67890",
-                   "modified_time" => Time.now.utc.iso8601, 
+                   "modified_time" => Time.now.utc.iso8601,
                    "metadata" => metadata }
-    
+
     user_model_B = { "user_id" => "1234",
-                    "company_id" => "6789", 
-                    "modified_time" => Time.now.utc.iso8601, 
+                    "company_id" => "6789",
+                    "modified_time" => Time.now.utc.iso8601,
                     "metadata" => metadata }
 
     user_models << user_model_A << user_model_B
@@ -116,9 +117,10 @@ class MoesifRackTest < Test::Unit::TestCase
   def test_get_config
     @api_client = MoesifApi::MoesifAPIClient.new(@options['application_id'])
     @api_controller = @api_client.api
-    @config = @app_config.get_config(@api_controller)
-    @config_body, @config_etag, @last_updated_time = @app_config.parse_configuration(@config)
-    @sampling_percentage = @app_config.get_sampling_percentage(nil, @config_body, nil, nil)
+    @app_config.get_config(@api_controller)
+    @sampling_percentage = @app_config.get_sampling_percentage(nil, nil, nil)
+    assert_instance_of Hash, @app_config.config
+    print "app config from test " + @app_config.config.to_s
     assert_operator 100, :>=, @sampling_percentage
   end
 
@@ -132,8 +134,8 @@ class MoesifRackTest < Test::Unit::TestCase
     campaign_model = {"utm_source" => "Adwords",
                       "utm_medium" => "Twitter"}
 
-    company_model = { "company_id" => "12345", 
-                      "company_domain" => "acmeinc.com", 
+    company_model = { "company_id" => "12345",
+                      "company_domain" => "acmeinc.com",
                       "metadata" => metadata,
                       "campaign" => campaign_model }
 
@@ -151,11 +153,11 @@ class MoesifRackTest < Test::Unit::TestCase
     company_models = []
 
     company_model_A = { "company_id" => "12345",
-                        "company_domain" => "nowhere.com", 
+                        "company_domain" => "nowhere.com",
                    "metadata" => metadata }
-    
+
     company_model_B = { "company_id" => "1234",
-                        "company_domain" => "acmeinc.com", 
+                        "company_domain" => "acmeinc.com",
                     "metadata" => metadata }
 
     company_models << company_model_A << company_model_B
@@ -163,4 +165,4 @@ class MoesifRackTest < Test::Unit::TestCase
     assert_equal response, nil
   end
 
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moesif_rack
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Moesif, Inc
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-10 00:00:00.000000000 Z
+date: 2023-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -37,14 +37,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.17
+        version: '2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.17
+        version: '2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
 description: Rack/Rails middleware to log API calls to Moesif API analytics and monitoring
 email: xing@moesif.com
 executables: []
@@ -67,8 +73,8 @@ files:
 - moesif_capture_outgoing/httplog/http_log.rb
 - test/config_example.json
 - test/govrule_example.json
-- test/moesif_rack_test.rb
 - test/test_governance_rules.rb
+- test/test_moesif_rack.rb
 homepage: https://moesif.com
 licenses:
 - Apache-2.0
@@ -88,7 +94,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="