cm_logger 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 761ebd63f3ecf80b8db7fbd5204718aac9982f9a43eb0866f77bba371af2ea8f
-  data.tar.gz: '091b2e075ec1eca95507c5bd6875787e39785e14c86294210b39e30cc719f1c0'
+  metadata.gz: 183fba83980c764b15c0d3fd5db0da99bc09a29521d21dbb6a458231b49806ef
+  data.tar.gz: cd567fbe9b2ee857b73ad081ef91c216066bed2affe81449496b5d8152d8e713
 SHA512:
-  metadata.gz: 35951ffbc63e2f1a1fec2f67c429a99c874fe481056515b0f1d91b3a4a3b70850568c2d6eb3c011565c3b982f9b1f4e9a29b1b5d49ca05bd18ce5914b8ede53a
-  data.tar.gz: b5caf453fe5c9e44ac3e5516aa0acdf242291f88f77e94d56909528084e62adf30aabcb064a3efc050fbeebc9f4e5a3451517b3513d27760906519f612e33095
+  metadata.gz: 1d76a2918fdf9ec8d1038aec501bd7cfaa7a88652119f2632cd49279128763db4c1d7d2dd5883a428e0e77b575ac11724ffecc58b7c7a50cb8cbef8673fd0ac0
+  data.tar.gz: db8c0e0eefc9a54484c62a3fc7cc774a04c132da2cc0c95ea9ba748ad0d872ef97d76d214c97651a5e00694e524742a2c81a233633070451abbb911579a5fa87

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.0.2
+- **BREAKING CHANGE** Adjust `CmLogger::SidekiqFormatter` implementation, extends from `Sidekiq::Logger::Formatters::Base` to avoid exposing details. Require sidekiq 6

data/Gemfile.lock

@@ -7,11 +7,14 @@ GEM
   remote: https://rubygems.org/
   specs:
     coderay (1.1.2)
+    connection_pool (2.2.3)
     diff-lcs (1.3)
     method_source (1.0.0)
     pry (0.13.0)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    rack (2.2.3)
+    redis (4.2.1)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -25,6 +28,10 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
+    sidekiq (6.1.1)
+      connection_pool (>= 2.2.2)
+      rack (~> 2.0)
+      redis (>= 4.2.0)
 
 PLATFORMS
   ruby
@@ -33,6 +40,7 @@ DEPENDENCIES
   cm_logger!
   pry
   rspec (~> 3.9.0)
+  sidekiq (~> 6.1.1)
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/cm_logger.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
 
 Gem::Specification.new do |s|
   s.name        = 'cm_logger'
-  s.version     = '0.0.1'
+  s.version     = '0.0.2'
   s.date        = '2020-04-09'
   s.summary     = "Log related stuff for Rails"
   s.description = "Log related stuff for Rails"
@@ -15,4 +15,5 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 2.6'
 
   s.add_development_dependency("rspec", ["~> 3.9.0"])
+  s.add_development_dependency("sidekiq", ["~> 6.1.1"])
 end

data/lib/sidekiq_formatter.rb

@@ -1,38 +1,46 @@
-require 'logger'
-require 'time'
+require 'sidekiq'
 
 module CmLogger
-  class SidekiqFormatter < Logger::Formatter
+  class SidekiqFormatter < ::Sidekiq::Logger::Formatters::Base
     def call(severity, time, program_name, message)
-      clean_message = message.gsub('"', '\'').gsub("\n", ' ').slice(0, 100)
-
       log_hash = {
         time: time.utc.iso8601(3),
         pid: ::Process.pid,
-        tid: Thread.current.object_id.to_s(36),
+        tid: tid,
         severity: severity,
-        message: "\"#{clean_message}\""
-      }.merge(context)
+        message: message,
+        worker_name: extract_worker_name,
+        jid: extract_jid,
+        elapsed: extract_elapsed
+      }.compact
 
       log_hash.keys.map do |key|
-        "#{key}=#{log_hash[key]}"
+        "#{key}=#{sanitize(log_hash[key])}"
       end.join(" ") + "\n"
     end
 
-    def context
-      c = Thread.current[:sidekiq_context]
-      if c && c.any?
-        tokens = c.map(&:split).flatten
-        worker_name = tokens.find { |token| token.end_with?('Worker') }
-        jid = tokens.find { |token| token.start_with?('JID') }
-
-        {
-          worker_name: worker_name,
-          jid: jid
-        }.compact
+    private
+
+    def sanitize(message)
+      result = message.to_s.gsub('"', '\'').gsub("\n", ' ').slice(0, 100)
+
+      if /\s/.match?(result)
+        "\"#{result}\""
       else
-        {}
+        result
       end
     end
+
+    def extract_worker_name
+      ctx[:class]
+    end
+
+    def extract_jid
+      ctx[:jid]
+    end
+
+    def extract_elapsed
+      ctx[:elapsed]
+    end
   end
-end
+end

data/spec/sidekiq_formatter_spec.rb

@@ -6,7 +6,7 @@ describe 'CmLogger::SidekiqFormatter' do
       CmLogger::SidekiqFormatter.new
     end
     let(:severity) { "INFO" }
-    let(:message) { "xxx" }
+    let(:message) { "xxx xxx" }
     let(:time) { Time.now }
     let(:program_name) { "program_name" }
 
@@ -15,9 +15,8 @@ describe 'CmLogger::SidekiqFormatter' do
 
       result = formatter.call(*args)
 
-      tid = Thread.current.object_id.to_s(36)
       pid = ::Process.pid
-      expect(result).to eq("time=#{time.utc.iso8601(3)} pid=#{pid} tid=#{tid} severity=#{severity} message=\"#{message}\"\n")
+      expect(result).to eq("time=#{time.utc.iso8601(3)} pid=#{pid} tid=#{formatter.tid} severity=#{severity} message=\"#{message}\"\n")
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cm_logger
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - ben
@@ -24,12 +24,28 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.1
 description: Log related stuff for Rails
 email: ben@arc.dev
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - README.md