feat(logger): allow the logger to be configurable by the parent application (#467)

Co-authored-by: Kevin Prettre <[email protected]>

Author: jeffladiray

config/initializers/logger.rb

@@ -3,21 +3,24 @@ module ForestLiana
   class Logger
     class << self
       def log
-        logger = ::Logger.new(STDOUT)
-        logger_colors = {
-          DEBUG: 34,
-          WARN: 33,
-          ERROR: 31,
-          INFO: 37
-        }
+        if ForestLiana.logger != nil
+          logger = ForestLiana.logger
+        else
+          logger = ::Logger.new(STDOUT)
+          logger_colors = {
+            DEBUG: 34,
+            WARN: 33,
+            ERROR: 31,
+            INFO: 37
+          }
 
-        logger.formatter = proc do |severity, datetime, progname, message|
-          displayed_message = "[#{datetime.to_s(:db)}] Forest 🌳🌳🌳  " \
-            "#{message}\n"
-          "\e[#{logger_colors[severity.to_sym]}m#{displayed_message}\033[0m"
+          logger.formatter = proc do |severity, datetime, progname, message|
+            displayed_message = "[#{datetime.to_s(:db)}] Forest 🌳🌳🌳  " \
+                  "#{message}\n"
+                "\e[#{logger_colors[severity.to_sym]}m#{displayed_message}\033[0m"
+            end
+          logger
         end
-
-        logger
       end
     end
   end

lib/forest_liana.rb

@@ -27,6 +27,7 @@ module UserSpace
   mattr_accessor :user_class_name
   mattr_accessor :names_overriden
   mattr_accessor :meta
+  mattr_accessor :logger
   # TODO: Remove once lianas prior to 2.0.0 are not supported anymore.
   mattr_accessor :names_old_overriden
 
@@ -38,6 +39,7 @@ module UserSpace
   self.user_class_name = nil
   self.names_overriden = {}
   self.meta = {}
+  self.logger = nil
 
   @config_dir = 'lib/forest_liana/**/*.rb'
 

spec/config/initializers/logger_spec.rb

@@ -0,0 +1,30 @@
+module ForestLiana
+  describe Logger do
+    describe 'self.log' do
+      describe 'with a logger overload' do
+        it 'should return the given logger' do
+          logger = ActiveSupport::Logger.new($stdout)
+          logger.formatter = proc do |severity, datetime, progname, msg|
+            {:message => msg}.to_json
+          end
+          ForestLiana.logger = logger
+
+          expect(Logger.log.is_a?(ActiveSupport::Logger)).to be_truthy
+          expect { Logger.log.error "[error] override logger" }.to output({:message => "[error] override logger"}.to_json).to_stdout_from_any_process
+          expect { Logger.log.info "[info] override logger" }.to output({:message => "[info] override logger"}.to_json).to_stdout_from_any_process
+        end
+      end
+
+      describe 'with no logger overload' do
+        it 'should return an instance of ::Logger' do
+          ForestLiana.logger = nil
+
+          expect(Logger.log.is_a?(::Logger)).to be_truthy
+          # RegExp is used to check for the forestadmin logger format
+          expect { Logger.log.error "[error] default logger" }.to output(/\[\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\] Forest .* \[error\]/).to_stdout_from_any_process
+          expect { Logger.log.info "[info] default logger" }.to output(/\[\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\] Forest .* \[info\]/).to_stdout_from_any_process
+        end
+      end
+    end
+  end
+end