Merge pull request #12 from wshihadeh/DEVOPS-2012-fix-memory-leak

Close #/DEVOPS-2012 fix memory leak

Author: Al-Waleed Shihadeh

.gitignore

@@ -13,3 +13,4 @@ rdoc
 spec/reports
 tmp
 .byebug_history
+Gemfile.lock

README.md

@@ -37,7 +37,6 @@ That's it now Delayed job logs should show the *X-Request-Id* from the http requ
 RequestHeadersLogger.configure do |config|
   config[:logger_format] = 'json'         # Options [text json] default: text
   config[:tag_format] = 'key_val'         # Options: [val key_val] default: val
-  config[:loggers] << MessageQueue.logger # List of all loggers used.
 end
 ```
 

lib/request_headers_logger.rb

@@ -6,6 +6,7 @@
 require 'request_headers_logger/text_formatter'
 require 'request_headers_logger/delayed_job/delayed_job'
 require 'request_headers_logger/message_queue/message_queue'
+require 'request_headers_logger/railtie' if defined?(Rails)
 
 module RequestHeadersLogger # :nodoc:
   extend self
@@ -34,19 +35,13 @@ def loggers
     @configuration[:loggers]
   end
 
-  def prepare_loggers
-    loggers.each do |logger|
-      logger_formatter logger
-    end
-  end
-
-  private
-
   def logger_formatter(logger)
     logger.formatter ||= Logger::Formatter.new
     logger.formatter.extend formatter_class
   end
 
+  private
+
   def formatter_class
     RequestHeadersLogger.const_get("#{log_format.capitalize}Formatter")
   end

lib/request_headers_logger/configuration.rb

@@ -10,7 +10,6 @@ def initialize(key)
 
     CONFIG_KEYS = [
       :log_format, # [logger_format] default or json
-      :loggers,    # [Loggers]  List of all loggers used.
       :tag_format, # [tag_format]
     ].freeze
 
@@ -20,7 +19,6 @@ def initialize(key)
     def initialize
       @configs = {
         log_format: LOG_FORMATS.first,
-        loggers: [],
         tag_format: TAG_FORMATS.first
       }
     end

lib/request_headers_logger/delayed_job/request_header_delayed_plugin.rb

@@ -13,23 +13,12 @@ class RequestHeadersDelayedPlugin < Delayed::Plugin
 
       lifecycle.before(:perform) do |worker, job|
         RequestHeadersMiddleware.store = job.payload_object.instance_variable_get(:@store)
-        set_dj_loggers
       end
 
       lifecycle.after(:perform) do |worker, job|
         RequestHeadersMiddleware.store = {}
       end
     end
-
-    def self.set_dj_loggers
-      RequestHeadersLogger.configure do |config|
-        loggers = [Delayed::Worker.logger]
-        loggers << ::Rails.logger
-
-        config[:loggers].push(loggers).flatten!.uniq!
-      end
-      RequestHeadersLogger.prepare_loggers
-    end
   end
 end
 

lib/request_headers_logger/message_queue/message_queue_plugin.rb

@@ -24,21 +24,12 @@ def symbolize(obj = {})
       lifecycle.before(:consume) do |delivery_info, properties, payload|
         store = symbolize(properties.headers)&.dig(:store) || {}
         RequestHeadersMiddleware.store = store
-
-        set_mq_loggers
       end
 
       lifecycle.after(:consume) do |delivery_info, properties, payload|
         RequestHeadersMiddleware.store = {}
       end
     end
-
-    def self.set_mq_loggers
-      RequestHeadersLogger.configure do |config|
-        config[:loggers] << MessageQueue.logger
-      end
-      RequestHeadersLogger.prepare_loggers
-    end
   end
 end
 

lib/request_headers_logger/railtie.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RequestHeadersLogger
+  class Railtie < ::Rails::Railtie
+    config.after_initialize do
+      RequestHeadersLogger.logger_formatter(MessageQueue.logger) if defined?(MessageQueue)
+      if defined?(Delayed)
+        RequestHeadersLogger.logger_formatter(Delayed::Worker.logger)
+        RequestHeadersLogger.logger_formatter(Rails.logger)
+      end
+    end
+  end
+end

lib/request_headers_logger/text_formatter.rb

@@ -7,11 +7,22 @@ module TextFormatter
     def call(severity, time, progname, msg)
       format(::Logger::Formatter::Format,
              severity_name(severity)[0],
-             format_datetime(time),
+             format_time(time),
              $PID,
              severity_name(severity),
              progname,
-             msg2str("#{tags_text}#{msg}"))
+             "#{tags_text}#{to_string(msg)}")
+    end
+
+    def format_time(time)
+      return format_datetime(time) if respond_to? :format_datetime
+      time.strftime(@datetime_format || '%Y-%m-%dT%H:%M:%S.%6N ')
+    end
+
+    def to_string(msg)
+      return msg2str(msg) if respond_to? :format_datetime
+      return msg.inspect unless msg.is_a? String
+      msg
     end
 
     def severity_name(severity)

lib/request_headers_logger/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RequestHeadersLogger
-  VERSION = '0.0.4'
+  VERSION = '1.0.0'
 end

spec/configuration_spec.rb

@@ -41,21 +41,13 @@
     it 'return text as default for log_format' do
       expect(config[:log_format]).to eq('text')
     end
-
-    it 'return empty array as default for loggers' do
-      expect(config[:loggers]).to eq([])
-    end
   end
 
   describe '[]=' do
     it 'assign valid config keys' do
-      logger = Logger.new(STDOUT)
-
       config[:log_format] = 'json'
-      config[:loggers] << logger
 
       expect(config[:log_format]).to eq('json')
-      expect(config[:loggers].first).to eq(logger)
     end
 
     it 'raise an error for invalid configs ' do