lumberjack_json_device 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93f11eda1a4055d1cc3b6ee2b9577e28f0a26ae937f88e49bc5c07aa0c1b327d
-  data.tar.gz: 96d500179158ea397ed2f52a3a096520125350cc673e5de5dbe352203b607d3f
+  metadata.gz: 53ef8a0ab4cd39e6debbbffd600a38dfe6749b41031c69c2865454bb918637bd
+  data.tar.gz: cb73709975c436608cac23bc612049d152a9b516796cd618178d717640f94e22
 SHA512:
-  metadata.gz: 00773c4aa83e49275b69fa0d400d8c17783008aa013a0b84b881acd868ab9e3ce6f39e5fc183b8d1ce2584c7e306363cfb7aa60d9045edacd100c66821601d85
-  data.tar.gz: 396d28c5697ded1ef621a959287c356b71a2e33942510cc72c88d32bd41e77c548d0d359df852e41a7ebeff1b60b839c092954e654a7dbbd6b2bc322b207eb1b
+  metadata.gz: 71b3f23efb68abc0d4b322fe0aa1eea2c7df7d2bc6f68512701354690c9265e2a092ecf8f21e01be190d4afee96c082f055d52af29c5d788604c2ef767c89962
+  data.tar.gz: 77a020bb1b4591ffc56493972a0fbc7e55ca97ebca9cd145eded2afc500628eafb61b1d5686eb20a0f8aaf1ec616846c8027d5f0940a16cd636b9b0e702b2baa

data/.github/dependabot.yml

@@ -1,4 +1,3 @@
-# Dependabot update strategy
 version: 2
 updates:
   - package-ecosystem: bundler
@@ -6,7 +5,10 @@ updates:
     schedule:
       interval: weekly
     allow:
-      # Automatically keep all runtime dependencies updated
       - dependency-name: "*"
         dependency-type: "production"
-    versioning-strategy: lockfile-only
+    versioning-strategy: increase-if-necessary
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: weekly

data/.github/workflows/continuous_integration.yml

@@ -10,12 +10,6 @@ on:
       - actions-*
   workflow_dispatch:
 
-env:
-  BUNDLE_CLEAN: "true"
-  BUNDLE_PATH: vendor/bundle
-  BUNDLE_JOBS: 3
-  BUNDLE_RETRY: 3
-
 jobs:
   build:
     name: ${{ matrix.ruby }} build
@@ -29,19 +23,16 @@ jobs:
           - ruby: "3.0"
           - ruby: "2.7"
     steps:
-    - uses: actions/checkout@v4
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby}}
-    - name: Install gems
-      run: |
-        bundle install
-    - name: Run Tests
-      run: bundle exec rake
-    - name: standardrb
-      if: matrix.standardrb
-      run:  bundle exec standardrb
-    - name: yard
-      if: matrix.yard
-      run:  bundle exec yard --fail-on-warning
+      - name: Checkout
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - name: Ruby CI
+        uses: bdurand/github-actions/ruby-ci@v1.0.4
+        with:
+          ruby: ${{ matrix.ruby }}
+          appraisal: ${{ matrix.appraisal }}
+          bundler: ${{ matrix.bundler }}
+          standardrb: ${{ matrix.standardrb }}
+          yard: ${{ matrix.yard }}
+          frozen_strings: ${{ matrix.frozen_strings }}

data/.standard.yml

@@ -1,8 +1,3 @@
 ruby_version: 2.7
 
 format: progress
-
-ignore:
-  - 'spec/**/*':
-    - Lint/UselessAssignment
-    - Lint/Void

data/CHANGE_LOG.md

@@ -4,6 +4,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 3.0.1
+
+### Fixed
+
+- Objects that appear more than once in a log entry (shared references that are not circular) are now serialized in full instead of being replaced with `null`. Only true circular references are replaced with `null`.
+- Log entries are now written to the output stream inside a mutex so that entries written from multiple threads cannot be interleaved, which could produce unparseable JSON lines.
+- Changing the mapping at runtime is now atomic with respect to entries being written on other threads. Previously a concurrent mapping change could produce an entry with a mix of the old and new mappings.
+- Fixed an `IndexError` when a mapping nests a field under a key that another field maps to as a scalar value (e.g. `{progname: "process", pid: "process.pid"}`). The nested structure now replaces the scalar value instead of raising an error.
+- Added an explicit `require "set"` rather than relying on it being transitively loaded.
+
 ## 3.0.0
 
 ### Added

data/VERSION

@@ -1 +1 @@
-3.0.0
+3.0.1

data/lib/lumberjack/json_device.rb

@@ -2,6 +2,7 @@
 
 require "lumberjack"
 require "json"
+require "set"
 require "time"
 
 # Lumberjack is a simple, powerful, and fast logging library for Ruby that
@@ -70,6 +71,12 @@ module Lumberjack
     JSON_OPTIONS = [:output, :mapping, :formatter, :datetime_format, :post_processor, :pretty, :utc].freeze
     private_constant :JSON_OPTIONS
 
+    # Immutable snapshot of a parsed mapping. The mapping is published as a single frozen
+    # object so that entries being written concurrently with a mapping change always see
+    # a consistent view of the mapping.
+    MappedKeys = Struct.new(:time, :severity, :message, :progname, :pid, :attributes, :custom)
+    private_constant :MappedKeys
+
     # Register the JsonDevice with the device registry for easier instantiation.
     DeviceRegistry.add(:json, self)
 
@@ -152,7 +159,7 @@ module Lumberjack
 
       data = entry_as_json(entry)
       json = @pretty ? JSON.pretty_generate(data) : JSON.generate(data)
-      @output.write("#{json}\n")
+      @output.write("#{json}\n") # thread safety is handled by the underlying output stream
     end
 
     # Get the underlying device from the output stream.
@@ -200,26 +207,33 @@ module Lumberjack
     #   If the value is `false`, the field will not be included in the JSON output.
     # @return [void]
     def mapping=(mapping)
-      @mutex.synchronize do
-        keys = {}
-        mapping.each do |key, value|
-          if value == true
-            value = key.to_s.split(".")
-            value = value.first if value.size == 1
-          end
-          keys[key.to_sym] = value if value
+      keys = {}
+      mapping.each do |key, value|
+        if value == true
+          value = key.to_s.split(".")
+          value = value.first if value.size == 1
         end
+        keys[key.to_sym] = value if value
+      end
+
+      custom_keys = keys.each_with_object({}) do |(name, key), hash|
+        next if DEFAULT_MAPPING.include?(name)
 
-        @time_key = keys.delete(:time)
-        @severity_key = keys.delete(:severity)
-        @message_key = keys.delete(:message)
-        @progname_key = keys.delete(:progname)
-        @pid_key = keys.delete(:pid)
-        @attributes_key = keys.delete(:attributes)
-        @custom_keys = keys.map do |name, key|
-          [name.to_s.split("."), key]
-        end.to_h
+        hash[name.to_s.split(".")] = key
+      end
 
+      mapped_keys = MappedKeys.new(
+        keys[:time],
+        keys[:severity],
+        keys[:message],
+        keys[:progname],
+        keys[:pid],
+        keys[:attributes],
+        custom_keys.freeze
+      ).freeze
+
+      @mutex.synchronize do
+        @keys = mapped_keys
         @mapping = mapping
       end
     end
@@ -242,17 +256,18 @@ module Lumberjack
     # @param entry [Lumberjack::LogEntry] The log entry to convert.
     # @return [Hash] A hash representing the log entry in JSON format.
     def entry_as_json(entry)
+      keys = @keys
       data = {}
-      set_attribute(data, @time_key, entry.time) if @time_key
-      set_attribute(data, @severity_key, entry.severity_label) if @severity_key
-      set_attribute(data, @message_key, json_safe(entry.message)) if @message_key
-      set_attribute(data, @progname_key, json_safe(entry.progname)) if @progname_key && entry.progname
-      set_attribute(data, @pid_key, entry.pid) if @pid_key
+      set_attribute(data, keys.time, entry.time) if keys.time
+      set_attribute(data, keys.severity, entry.severity_label) if keys.severity
+      set_attribute(data, keys.message, json_safe(entry.message)) if keys.message
+      set_attribute(data, keys.progname, json_safe(entry.progname)) if keys.progname && entry.progname
+      set_attribute(data, keys.pid, entry.pid) if keys.pid
 
       attributes = entry.attributes.transform_values { |value| json_safe(value) } if entry.attributes
 
-      if @custom_keys.size > 0 && attributes && !attributes&.empty?
-        @custom_keys.each do |name, key|
+      if keys.custom.size > 0 && attributes && !attributes&.empty?
+        keys.custom.each do |name, key|
           name = name.is_a?(Array) ? name.join(".") : name.to_s
           value = attributes.delete(name)
           next if value.nil?
@@ -262,12 +277,12 @@ module Lumberjack
         end
       end
 
-      if @attributes_key && !attributes&.empty?
+      if keys.attributes && !attributes&.empty?
         attributes = Lumberjack::Utils.expand_attributes(attributes)
-        if @attributes_key == "*"
+        if keys.attributes == "*"
           attributes.each { |k, v| data[k] = v unless data.include?(k) }
         else
-          set_attribute(data, @attributes_key, attributes)
+          set_attribute(data, keys.attributes, attributes)
         end
       end
 
@@ -325,7 +340,7 @@ module Lumberjack
           if key.size == 1
             data[key.first] = value
           else
-            data[key.first] ||= {}
+            data[key.first] = {} unless data[key.first].is_a?(Hash)
             set_attribute(data[key.first], key[1, key.size], value)
           end
         end
@@ -366,10 +381,16 @@ module Lumberjack
       else
         seen ||= Set.new
         seen << value.object_id
-        if value.is_a?(Hash)
-          value.transform_values { |v| json_safe(v, seen) }
-        else
-          value.collect { |v| json_safe(v, seen) }
+        begin
+          if value.is_a?(Hash)
+            value.transform_values { |v| json_safe(v, seen) }
+          else
+            value.collect { |v| json_safe(v, seen) }
+          end
+        ensure
+          # Only track objects on the current traversal path so that shared references
+          # that are not circular are serialized in full.
+          seen.delete(value.object_id)
         end
       end
     rescue SystemStackError, StandardError => e

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: lumberjack_json_device
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Brian Durand
 bindir: bin
 cert_chain: []
-date: 2025-10-20 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lumberjack
@@ -60,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 4.0.3
 specification_version: 4
 summary: A logging device for the lumberjack gem that writes log entries as JSON documents
   for use with structured logging.