Merge pull request #2110 from grosser/grosser/logging

fix done not logging when using with_context in a worker

lib/sidekiq/logging.rb

@@ -5,6 +5,8 @@ module Sidekiq
   module Logging
 
     class Pretty < Logger::Formatter
+      SPACE = " "
+
       # Provide a call() method that returns the formatted message.
       def call(severity, time, program_name, message)
         "#{time.utc.iso8601(3)} #{::Process.pid} TID-#{Thread.current.object_id.to_s(36)}#{context} #{severity}: #{message}\n"
@@ -12,17 +14,16 @@ module Sidekiq
 
       def context
         c = Thread.current[:sidekiq_context]
-        c ? " #{c}" : ''
+        " #{c.join(SPACE)}" if c && c.any?
       end
     end
 
     def self.with_context(msg)
-      begin
-        Thread.current[:sidekiq_context] = msg
-        yield
-      ensure
-        Thread.current[:sidekiq_context] = nil
-      end
+      Thread.current[:sidekiq_context] ||= []
+      Thread.current[:sidekiq_context] << msg
+      yield
+    ensure
+      Thread.current[:sidekiq_context].pop
     end
 
     def self.initialize_logger(log_target = STDOUT)

test/test_logging.rb

@@ -0,0 +1,34 @@
+require 'helper'
+require 'sidekiq/logging'
+
+class TestFetcher < Sidekiq::Test
+  describe Sidekiq::Logging do
+    describe "#with_context" do
+      def context
+        Sidekiq::Logging.logger.formatter.context
+      end
+
+      it "has no context by default" do
+        context.must_equal nil
+      end
+
+      it "can add a context" do
+        Sidekiq::Logging.with_context "xx" do
+          context.must_equal " xx"
+        end
+        context.must_equal nil
+      end
+
+      it "can use multiple contexts" do
+        Sidekiq::Logging.with_context "xx" do
+          context.must_equal " xx"
+          Sidekiq::Logging.with_context "yy" do
+            context.must_equal " xx yy"
+          end
+          context.must_equal " xx"
+        end
+        context.must_equal nil
+      end
+    end
+  end
+end