fix: #434: confusing empty debug.log generation in gem users root (#474)

* fix: #434: confusing empty debug.log generation in general gem users root

* change STDERR to $stderr

* Update lib/algolia/logger_helper.rb

Co-authored-by: Devin Beeuwkes <[email protected]>

Co-authored-by: Devin Beeuwkes <[email protected]>

Author: kiyohara

lib/algolia/analytics_client.rb

@@ -13,7 +13,7 @@ class Client
       def initialize(analytics_config, opts = {})
         @config      = analytics_config
         adapter      = opts[:adapter] || Defaults::ADAPTER
-        logger       = opts[:logger] || LoggerHelper.create('debug.log')
+        logger       = opts[:logger] || LoggerHelper.create
         requester    = opts[:http_requester] || Defaults::REQUESTER_CLASS.new(adapter, logger)
         @transporter = Transport::Transport.new(@config, requester)
       end

lib/algolia/insights_client.rb

@@ -13,7 +13,7 @@ class Client
       def initialize(insights_config, opts = {})
         @config      = insights_config
         adapter      = opts[:adapter] || Defaults::ADAPTER
-        logger       = opts[:logger] || LoggerHelper.create('debug.log')
+        logger       = opts[:logger] || LoggerHelper.create
         requester    = opts[:http_requester] || Defaults::REQUESTER_CLASS.new(adapter, logger)
         @transporter = Transport::Transport.new(@config, requester)
       end

lib/algolia/logger_helper.rb

@@ -5,7 +5,7 @@ class LoggerHelper
     # @param debug_file [nil|String] file used to output the logs
     #
     def self.create(debug_file = nil)
-      file              = debug_file || File.new('debug.log')
+      file              = debug_file || (ENV['ALGOLIA_DEBUG'] ? File.new('debug.log') : $stderr)
       instance          = ::Logger.new file
       instance.progname = 'algolia'
       instance

lib/algolia/personalization_client.rb

@@ -11,7 +11,7 @@ class Client
       def initialize(personalization_config, opts = {})
         @config      = personalization_config
         adapter      = opts[:adapter] || Defaults::ADAPTER
-        logger       = opts[:logger] || LoggerHelper.create('debug.log')
+        logger       = opts[:logger] || LoggerHelper.create
         requester    = opts[:http_requester] || Defaults::REQUESTER_CLASS.new(adapter, logger)
         @transporter = Transport::Transport.new(@config, requester)
       end

lib/algolia/recommend_client.rb

@@ -18,7 +18,7 @@ class Client
       def initialize(recommend_config, opts = {})
         @config      = recommend_config
         adapter      = opts[:adapter] || Defaults::ADAPTER
-        logger       = opts[:logger] || LoggerHelper.create('debug.log')
+        logger       = opts[:logger] || LoggerHelper.create
         requester    = opts[:http_requester] || Defaults::REQUESTER_CLASS.new(adapter, logger)
         @transporter = Transport::Transport.new(@config, requester)
       end

lib/algolia/search_client.rb

@@ -19,7 +19,7 @@ class Client
       def initialize(search_config, opts = {})
         @config      = search_config
         adapter      = opts[:adapter] || Defaults::ADAPTER
-        logger       = opts[:logger] || LoggerHelper.create('debug.log')
+        logger       = opts[:logger] || LoggerHelper.create
         requester    = opts[:http_requester] || Defaults::REQUESTER_CLASS.new(adapter, logger)
         @transporter = Transport::Transport.new(@config, requester)
       end