berkeley_library-logging 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91d0f1a398e99a9e138f90946025b7d5576cda6a4b6e4e8c137b77ec8febbd2f
-  data.tar.gz: 1300926d8af70a24e6fff33e3ac1e8af79c428e7c35302fab335d255f713d7a1
+  metadata.gz: cafd11d3f9d11029ae88c9ed475e08d9c5227d56f2924085145e6363fe76bfc1
+  data.tar.gz: 42eb37cd205ee71cbe710d86ddafd0a342ca31b3f54b40d988b16d5786ef6335
 SHA512:
-  metadata.gz: 2271582ebc293b95a3f9dc18c9c922b780abf1ab1636f549f9ac1093a4b72dabd8a6c224bd51e53be7b128b0f65759dd639bef744f7586659b98fcbd4eb19431
-  data.tar.gz: 874db3c599bfa7a1a00d9b15c35bc85120f1ed573ba5088c99c83bc12ef81ea1ab8e5c2fd081996c6ac684a0c2befc573de57547c951111b6e9e41c726847e64
+  metadata.gz: bc1a877b7dd123c92aa2cbfdcb8f55676bb6ef2257857f4af395e19c2d27fb950e3fcbf69813a0a639dd372f50a711e3b5cc84dfd593aa67dd5035534447a339
+  data.tar.gz: 2fc6bbf11a1d51aa90a15d0841df1c49a38aad8add0a824e1dfcab0bfe4d3489bb6a40d8afe56e3da255d6caac62d68535acfd726f4673604fb1548f5c71d0d0

data/.idea/inspectionProfiles/Project_Default.xml

@@ -7,6 +7,7 @@
     <inspection_tool class="Rubocop" enabled="false" level="WARNING" enabled_by_default="false" />
     <inspection_tool class="RubyCaseWithoutElseBlockInspection" enabled="false" level="WARNING" enabled_by_default="false" />
     <inspection_tool class="RubyNilAnalysis" enabled="true" level="WEAK WARNING" enabled_by_default="true" />
+    <inspection_tool class="RubyParameterNamingConvention" enabled="false" level="WARNING" enabled_by_default="false" />
     <inspection_tool class="RubyStringKeysInHashInspection" enabled="true" level="INFORMATION" enabled_by_default="true" />
     <inspection_tool class="SpellCheckingInspection" enabled="false" level="TYPO" enabled_by_default="false">
       <option name="processCode" value="true" />
@@ -14,4 +15,4 @@
       <option name="processComments" value="true" />
     </inspection_tool>
   </profile>
-</component>
+</component>

data/.idea/logging.iml

@@ -4,11 +4,7 @@
     <shared />
   </component>
   <component name="NewModuleRootManager">
-    <content url="file://$MODULE_DIR$">
-      <sourceFolder url="file://$MODULE_DIR$/features" isTestSource="true" />
-      <sourceFolder url="file://$MODULE_DIR$/spec" isTestSource="true" />
-      <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
-    </content>
+    <content url="file://$MODULE_DIR$" />
     <orderEntry type="jdk" jdkName="RVM: ruby-2.7.4" jdkType="RUBY_SDK" />
     <orderEntry type="sourceFolder" forTests="false" />
     <orderEntry type="library" scope="PROVIDED" name="actioncable (v6.1.4.1, RVM: ruby-2.7.4) [gem]" level="application" />
@@ -22,7 +18,7 @@
     <orderEntry type="library" scope="PROVIDED" name="activerecord (v6.1.4.1, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="activestorage (v6.1.4.1, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="activesupport (v6.1.4.1, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="amazing_print (v1.3.0, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="amazing_print (v1.4.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="ansi (v1.5.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="ast (v2.4.2, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="brakeman (v4.10.1, RVM: ruby-2.7.4) [gem]" level="application" />
@@ -54,7 +50,7 @@
     <orderEntry type="library" scope="PROVIDED" name="minitest (v5.14.4, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="nio4r (v2.5.8, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="nokogiri (v1.12.4, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="oj (v3.13.7, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="oj (v3.13.9, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="ougai (v1.9.1, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="parallel (v1.21.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="parser (v3.0.2.0, RVM: ruby-2.7.4) [gem]" level="application" />
@@ -97,6 +93,10 @@
     <orderEntry type="library" scope="PROVIDED" name="websocket-extensions (v0.1.5, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="zeitwerk (v2.4.2, RVM: ruby-2.7.4) [gem]" level="application" />
   </component>
+  <component name="RModuleSettingsStorage">
+    <LOAD_PATH number="2" string0="$MODULE_DIR$/lib" string1="$MODULE_DIR$/spec" />
+    <I18N_FOLDERS number="0" />
+  </component>
   <component name="RakeTasksCache">
     <option name="myRootTask">
       <RakeTaskImpl id="rake">
@@ -110,7 +110,7 @@
           <RakeTaskImpl description="Remove artifacts directory" fullCommand="clean" id="clean" />
           <RakeTaskImpl description="Run all specs in spec directory, with coverage" fullCommand="coverage" id="coverage" />
           <RakeTaskImpl description="Clean, check, build gem" fullCommand="default" id="default" />
-          <RakeTaskImpl description="Build berkeley_library-logging.gemspec as berkeley_library-logging-0.2.3.gem" fullCommand="gem" id="gem" />
+          <RakeTaskImpl description="Build berkeley_library-logging.gemspec as berkeley_library-logging-0.2.4.gem" fullCommand="gem" id="gem" />
           <RakeTaskImpl description="Run RuboCop" fullCommand="rubocop" id="rubocop" />
           <RakeTaskImpl id="rubocop">
             <subtasks>

data/CHANGES.md

@@ -1,3 +1,8 @@
+# 0.2.5 (2021-11-04)
+
+- Rails event logs now include a subset of session attributes (`session_id` and `_csrf_token`).
+  Set `Rails.config.lograge.verbose_session_logging` to log the full session hash.
+
 # 0.2.4 (2021-11-02)
 
 - Rails event logs now include the following, in addition to the

data/Rakefile

@@ -19,9 +19,11 @@ end
 # ------------------------------------------------------------
 # Custom tasks
 
-desc 'Remove artifacts directory'
+desc 'Remove artifacts directory, except for .keep file'
 task :clean do
   FileUtils.rm_rf('artifacts')
+  FileUtils.mkdir('artifacts')
+  FileUtils.touch(File.join('artifacts', '.keep'))
 end
 
 desc 'Check test coverage, check code style, check gems for vulnerabilities'

data/berkeley_library-logging.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.homepage = BerkeleyLibrary::Logging::ModuleInfo::HOMEPAGE
 
   spec.files = `git ls-files -z`.split("\x0")
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features|artifacts)/})
   spec.require_paths = ['lib']
 
   spec.required_ruby_version = ">= #{ruby_version}"

data/lib/berkeley_library/logging/configurator.rb

@@ -22,9 +22,13 @@ module BerkeleyLibrary
         def configure_lograge(config)
           return unless config.respond_to?(:lograge)
 
-          config.lograge.tap do |lograge|
+          lograge_config = config.lograge
+
+          custom_options = Events.extract_data_for_lograge(lograge_config)
+
+          lograge_config.tap do |lograge|
             lograge.enabled = true
-            lograge.custom_options = Events.extract_data_for_lograge
+            lograge.custom_options = custom_options
             lograge.formatter = Formatters.lograge_formatter
           end
         end

data/lib/berkeley_library/logging/events.rb

@@ -1,41 +1,46 @@
+require 'berkeley_library/logging/safe_serializer'
+
 module BerkeleyLibrary
   module Logging
     module Events
+      LOGGED_REQUEST_ATTRIBUTES = %i[origin base_url x_csrf_token].freeze
+      LOGGED_SESSION_ATTRIBUTES = %i[session_id _csrf_token].freeze
+      LOGGED_PARAMETERS = [:authenticity_token].freeze
+      LOGGED_HEADERS = {
+        # yes, RFC 2616 uses a variant spelling for 'referrer', it's a known issue
+        # https://tools.ietf.org/html/rfc2616#section-14.36
+        referer: 'HTTP_REFERER',
+        request_id: 'action_dispatch.request_id',
+        remote_ip: 'action_dispatch.remote_ip',
+        remote_addr: 'REMOTE_ADDR',
+        x_forwarded_for: 'HTTP_X_FORWARDED_FOR',
+        forwarded: 'HTTP_FORWARDED' # RFC 7239
+      }.freeze
+
       class << self
-        LOGGED_REQUEST_ATTRIBUTES = %i[origin base_url x_csrf_token].freeze
-        LOGGED_PARAMETERS = [:authenticity_token].freeze
-        LOGGED_HEADERS = {
-          # yes, RFC 2616 uses a variant spelling for 'referrer', it's a known issue
-          # https://tools.ietf.org/html/rfc2616#section-14.36
-          referer: 'HTTP_REFERER',
-          request_id: 'action_dispatch.request_id',
-          remote_ip: 'action_dispatch.remote_ip',
-          remote_addr: 'REMOTE_ADDR',
-          x_forwarded_for: 'HTTP_X_FORWARDED_FOR',
-          forwarded: 'HTTP_FORWARDED' # RFC 7239
-        }.freeze
-
-        def extract_data_for_lograge
-          ->(event) { extract_event_data(event) }
-        end
 
-        private
+        def extract_data_for_lograge(lograge_config)
+          verbose_session_logging = lograge_config.verbose_session_logging
 
-        def extract_event_data(event)
-          { time: Time.now }.tap do |event_data|
-            headers = extract_headers(event)
-            event_data.merge!(headers)
+          ->(event) { extract_event_data(event.payload, verbose_session_logging) }
+        end
 
-            request_attributes = extract_request_attributes(event)
-            event_data.merge!(request_attributes)
+        private
 
-            param_values = extract_param_values(event)
-            event_data.merge!(param_values)
+        def extract_event_data(payload, verbose_session_logging)
+          [
+            extract_headers(payload),
+            extract_request_attributes(payload),
+            extract_param_values(payload),
+            extract_session(payload, verbose_session_logging)
+          ].inject({ time: Time.now }) do |data, values|
+            clean_values = SafeSerializer.serialize(values)
+            data.merge(clean_values)
           end
         end
 
-        def extract_param_values(event)
-          return {} unless (params = event.payload[:params])
+        def extract_param_values(payload)
+          return {} unless (params = payload[:params])
 
           LOGGED_PARAMETERS.each_with_object({}) do |param, values|
             next unless (param_val = params[param])
@@ -44,29 +49,46 @@ module BerkeleyLibrary
           end
         end
 
-        def extract_request_attributes(event)
-          return {} unless (request = event.payload[:request])
+        def extract_request_attributes(payload)
+          return {} unless (request = payload[:request])
 
           LOGGED_REQUEST_ATTRIBUTES.each_with_object({}) do |attr, values|
             next unless request.respond_to?(attr)
-            next unless (attr_val = request.send(attr))
+            next if (attr_val = request.send(attr)).nil?
 
             values[attr] = attr_val
           end
         end
 
-        def extract_headers(event)
-          return {} unless (headers = event.payload[:headers])
+        def extract_headers(payload)
+          return {} unless (headers = payload[:headers])
 
           LOGGED_HEADERS.each_with_object({}) do |(key, header), values|
             next unless (header_val = headers[header])
 
-            # Some of these 'headers' include recursive structures
-            # that cause SystemStackErrors in JSON serialization,
-            # so we convert them all to strings
-            values[key] = header_val.to_s
+            values[key] = header_val
           end
         end
+
+        def extract_session(payload, verbose_session_logging)
+          return {} unless (request = payload[:request])
+          return {} unless (session = request.session)
+          return {} unless session.respond_to?(:to_hash)
+
+          session_hash = session_hash(session, verbose_session_logging)
+
+          { session: session_hash }
+        end
+
+        def session_hash(session, verbose)
+          raw_session_hash = session.to_hash
+          return raw_session_hash if verbose
+
+          LOGGED_SESSION_ATTRIBUTES.filter_map do |attr|
+            attr_str = attr.to_s
+            [attr, raw_session_hash[attr_str]] if raw_session_hash.key?(attr_str)
+          end.to_h
+        end
       end
     end
   end

data/lib/berkeley_library/logging/exception_serializer.rb

@@ -0,0 +1,15 @@
+module BerkeleyLibrary
+  module Logging
+    module ExceptionSerializer
+      def serialize_exc(ex, serialized = Set.new)
+        raw_result = { name: ex.class.name, message: ex.message, stack: ex.backtrace }
+        raw_result.tap do |result|
+          next unless (cause = ex.cause)
+          next if (serialized << ex).include?(cause) # prevent circular references
+
+          result[:cause] = serialize_exc(cause, serialized)
+        end
+      end
+    end
+  end
+end

data/lib/berkeley_library/logging/formatters.rb

@@ -1,4 +1,5 @@
 require 'ougai'
+require 'berkeley_library/logging/exception_serializer'
 
 module BerkeleyLibrary
   module Logging
@@ -41,21 +42,8 @@ module BerkeleyLibrary
       # ------------------------------------------------------------
       # Private helper classes
 
-      module ErrorCauseSerializer
-        def serialize_exc(ex, serialized = Set.new)
-          super(ex).tap do |result|
-            next unless (cause = ex.cause)
-            next if (serialized << ex).include?(cause) # prevent circular references
-
-            result[:cause] = serialize_exc(cause, serialized)
-          end
-        end
-      end
-
-      private_constant :ErrorCauseSerializer
-
       class Readable < Ougai::Formatters::Readable
-        include ErrorCauseSerializer
+        include ExceptionSerializer
 
         protected
 
@@ -71,9 +59,11 @@ module BerkeleyLibrary
           "  #{err_hash[:name]} (#{err_hash[:message]}):".tap do |msg|
             next unless (stack = err_hash[:stack])
 
-            msg << "\n"
-            msg << (' ' * @trace_indent)
-            msg << stack
+            trace_indent = (' ' * @trace_indent)
+            trace_separator = "\n#{trace_indent}"
+
+            msg << trace_separator
+            msg << stack.join(trace_separator)
 
             next unless (cause_hash = err_hash[:cause])
 
@@ -87,7 +77,7 @@ module BerkeleyLibrary
 
       class Bunyan < Ougai::Formatters::Bunyan
         include Ougai::Logging::Severity
-        include ErrorCauseSerializer
+        include ExceptionSerializer
 
         def _call(severity, time, progname, data)
           original_data = Formatters.ensure_hash(data)

data/lib/berkeley_library/logging/module_info.rb

@@ -7,7 +7,7 @@ module BerkeleyLibrary
       SUMMARY = 'Opinionated Ruby/Rails logging for UC Berkeley Library'.freeze
       DESCRIPTION = 'A gem providing shared logging code for UC Berkeley Library gems and Rails applications'.freeze
       LICENSE = 'MIT'.freeze
-      VERSION = '0.2.4'.freeze
+      VERSION = '0.2.5'.freeze
       HOMEPAGE = 'https://github.com/BerkeleyLibrary/logging'.freeze
 
       private_class_method :new

data/lib/berkeley_library/logging/safe_serializer.rb

@@ -0,0 +1,77 @@
+require 'time'
+require 'berkeley_library/logging/exception_serializer'
+
+module BerkeleyLibrary
+  module Logging
+    # Some of values include recursive structures
+    # that cause SystemStackErrors in JSON serialization,
+    # so we convert them all to strings
+    class SafeSerializer
+      include ExceptionSerializer
+
+      RAW_TYPES = [NilClass, FalseClass, TrueClass, Numeric, String, Symbol, Date, Time].freeze
+
+      def initialize(value)
+        @value = value
+      end
+
+      class << self
+        def serialize(value)
+          SafeSerializer.new(value).serialized_value
+        end
+
+        def placeholder_for(value)
+          "#<#{value.class}:#{value.object_id}> (recursive reference)"
+        end
+      end
+
+      def serialized_value
+        @serialized_value ||= serialize(@value)
+      end
+
+      private
+
+      # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+      def serialize(value)
+        return value if safe_raw_value?(value)
+        return SafeSerializer.placeholder_for(value) if serialized_values.include?(value)
+
+        serialized_values << value
+
+        return serialize_hash(value) if value.is_a?(Hash)
+        return serialize_hash(value.to_hash) if value.respond_to?(:to_hash)
+        return serialize_array(value) if value.is_a?(Array)
+        return serialize_array(value.to_ary) if value.respond_to?(:to_ary)
+        return serialize_exc(value, serialized_values) if value.is_a?(Exception)
+
+        value.to_s
+      end
+      # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
+
+      def safe_raw_value?(value)
+        return true if rails_time_with_zone?(value)
+
+        RAW_TYPES.any? { |t| value.is_a?(t) }
+      end
+
+      def rails_time_with_zone?(value)
+        defined?(ActiveSupport::TimeWithZone) && value.is_a?(ActiveSupport::TimeWithZone)
+      end
+
+      def serialize_array(value)
+        value.map { |v| serialize(v) }
+      end
+
+      def serialize_hash(value)
+        value.each_with_object({}) do |(k, v), h|
+          k1, v1 = [k, v].map { |x| serialize(x) }
+          h[k1] = v1
+        end
+      end
+
+      def serialized_values
+        @serialized_values ||= Set.new
+      end
+    end
+  end
+end

data/spec/rails/ucblit/logging/configurator_spec.rb

@@ -30,53 +30,105 @@ module BerkeleyLibrary
             expect(lograge.enabled).to eq(true)
           end
 
-          it 'extracts request info from log events' do
-            Configurator.configure(config)
-            lograge = config.lograge
+          context 'events' do
+            let(:params) { { authenticity_token: '8675309' } }
+
+            let(:session_hash) do
+              {
+                'session_id' => '17cd06b1b7cb9744e8fa626ef5f37c67',
+                'user' => {
+                  'id' => 71,
+                  'user_name' => 'Ms. Magoo',
+                  'created_at' => '2021-10-14T09:24:42.730-07:00',
+                  'updated_at' => '2021-10-14T09:24:42.729-07:00',
+                  'user_role' => 'Administrator',
+                  'user_active' => true,
+                  'uid' => 1_684_944,
+                  'updated_by' => 'Dr. Pibb'
+                },
+                'expires_at' => '2021-11-03T12:30:01.281-07:00',
+                '_csrf_token' => 'HiN1xUxFcOvWvoe2nwoBSGlmGSN6x0jprpSqDrzquxA='
+              }
+            end
+
+            let(:request_headers) do
+              {
+                'HTTP_REFERER' => 'value from HTTP_REFERER',
+                'action_dispatch.request_id' => 'value from action_dispatch.request_id',
+                'action_dispatch.remote_ip' => 'value from action_dispatch.remote_ip',
+                'REMOTE_ADDR' => 'value from REMOTE_ADDR',
+                'HTTP_X_FORWARDED_FOR' => 'value from HTTP_X_FORWARDED_FOR',
+                'HTTP_FORWARDED' => 'value from HTTP_FORWARDED'
+              }
+            end
+
+            let(:expected_header_map) do
+              {
+                referer: 'HTTP_REFERER',
+                request_id: 'action_dispatch.request_id',
+                remote_ip: 'action_dispatch.remote_ip',
+                remote_addr: 'REMOTE_ADDR',
+                x_forwarded_for: 'HTTP_X_FORWARDED_FOR',
+                forwarded: 'HTTP_FORWARDED'
+              }
+            end
+
+            attr_reader :session, :request, :payload, :event
+
+            before(:each) do
+              @session = instance_double(ActionDispatch::Request::Session)
+              allow(session).to receive(:to_hash).and_return(session_hash)
+
+              @request = instance_double(ActionDispatch::Request)
+              allow(request).to receive(:origin).and_return('http://example.org:3000')
+              allow(request).to receive(:base_url).and_return('https://example.org:3443')
+              allow(request).to receive(:x_csrf_token).and_return('5551212')
+              allow(request).to receive(:session).and_return(session)
+
+              @payload = {
+                params: params,
+                request: request,
+                headers: request_headers
+              }
+
+              @event = instance_double(ActiveSupport::Notifications::Event)
+              allow(event).to receive(:payload).and_return(payload)
+            end
+
+            it 'extracts request info from log events' do
+              Configurator.configure(config)
+              data = config.lograge.custom_options.call(event)
+
+              expect(data).to be_a(Hash)
+              expect(data[:time]).to be_a(Time)
+              expect(data[:time].to_i).to be_within(60).of(Time.now.to_i)
+
+              expected_header_map.each { |xh, rh| expect(data[xh]).to eq(request_headers[rh]) }
+
+              expect(data[:authenticity_token]).to eq(params[:authenticity_token])
+
+              Events::LOGGED_REQUEST_ATTRIBUTES.each do |attr|
+                expect(data[attr]).to eq(request.send(attr))
+              end
+            end
+
+            it 'includes the entire session if `verbose_session_logging` is true' do
+              config.lograge.verbose_session_logging = true
+              Configurator.configure(config)
+              data = config.lograge.custom_options.call(event)
+
+              expect(data[:session]).to eq(session_hash)
+            end
+
+            it 'includes only the session ID by default' do
+              Configurator.configure(config)
+              data = config.lograge.custom_options.call(event)
+
+              expected_hash = Events::LOGGED_SESSION_ATTRIBUTES.each_with_object({}) do |attr, h|
+                h[attr] = session_hash[attr.to_s]
+              end
 
-            params = { authenticity_token: '8675309' }
-            request = OpenStruct.new(
-              origin: 'http://example.org:3000',
-              base_url: 'https://example.org:3443',
-              x_csrf_token: '5551212'
-            )
-
-            request_headers = {
-              'HTTP_REFERER' => 'value from HTTP_REFERER',
-              'action_dispatch.request_id' => 'value from action_dispatch.request_id',
-              'action_dispatch.remote_ip' => 'value from action_dispatch.remote_ip',
-              'REMOTE_ADDR' => 'value from REMOTE_ADDR',
-              'HTTP_X_FORWARDED_FOR' => 'value from HTTP_X_FORWARDED_FOR',
-              'HTTP_FORWARDED' => 'value from HTTP_FORWARDED'
-            }
-
-            expected_header_map = {
-              referer: 'HTTP_REFERER',
-              request_id: 'action_dispatch.request_id',
-              remote_ip: 'action_dispatch.remote_ip',
-              remote_addr: 'REMOTE_ADDR',
-              x_forwarded_for: 'HTTP_X_FORWARDED_FOR',
-              forwarded: 'HTTP_FORWARDED'
-            }
-
-            payload = {
-              params: params,
-              request: request,
-              headers: request_headers
-            }
-
-            event = instance_double(ActiveSupport::Notifications::Event)
-            allow(event).to receive(:payload).and_return(payload)
-
-            custom_options = lograge.custom_options
-            data = custom_options.call(event)
-            expect(data).to be_a(Hash)
-            expect(data[:time]).to be_a(Time)
-            expect(data[:time].to_i).to be_within(60).of(Time.now.to_i)
-            expected_header_map.each { |xh, rh| expect(data[xh]).to eq(request_headers[rh]) }
-            expect(data[:authenticity_token]).to eq(params[:authenticity_token])
-            %i[origin base_url x_csrf_token].each do |attr|
-              expect(data[attr]).to eq(request.send(attr))
+              expect(data[:session]).to eq(expected_hash)
             end
           end
 

data/spec/rails/ucblit/logging/safe_serializer_spec.rb

@@ -0,0 +1,23 @@
+require 'rails_helper'
+
+require 'active_support/time'
+
+module BerkeleyLibrary
+  module Logging
+    describe SafeSerializer do
+      describe :serialize do
+        it 'handles ActiveSupport::TimeWithZone' do
+          Time.zone = 'America/Los_Angeles'
+
+          t = Time.current
+          expect(t).to be_a(ActiveSupport::TimeWithZone) # just to be sure
+
+          expect(SafeSerializer.serialize(t)).to be(t)
+
+          h = { time: t }
+          expect(SafeSerializer.serialize(h)).to eq(h)
+        end
+      end
+    end
+  end
+end

data/spec/standalone/ucblit/logging/loggers_spec.rb

@@ -132,6 +132,9 @@ module BerkeleyLibrary
         rescue SystemStackError => e
           RSpec::Expectations.fail_with("Expected no SystemStackError, but got #{e}: #{e.backtrace[0]}")
         end
+
+        expect(out.string).to include(msg_outer)
+        expect(out.string).to include(msg_inner)
       end
       # rubocop:enable Naming/RescuedExceptionsVariableName
 

data/spec/standalone/ucblit/logging/safe_serializer_spec.rb

@@ -0,0 +1,137 @@
+require 'standalone_helper'
+
+module BerkeleyLibrary
+  module Logging
+    describe SafeSerializer do
+      describe :serialize do
+        it 'returns primitives unchanged' do
+          values = [
+            nil,
+            false,
+            true,
+            1,
+            1.0,
+            '1/3'.to_r,
+            'a string',
+            :a_symbol,
+            Date.today,
+            Time.now
+          ]
+
+          aggregate_failures do
+            values.each do |original|
+              actual = SafeSerializer.serialize(original)
+              expect(actual).to be(original)
+            end
+          end
+        end
+
+        it 'returns an object as a string' do
+          value = Object.new
+          expect(SafeSerializer.serialize(value)).to eq(value.to_s)
+        end
+
+        it 'returns a hash as a hash' do
+          hash = { a: 1, b: 2 }
+          expect(SafeSerializer.serialize(hash)).to eq(hash)
+        end
+
+        it 'returns an array as an array' do
+          arr = [0, 1, 2, 'elvis', false]
+          expect(SafeSerializer.serialize(arr)).to eq(arr)
+        end
+
+        it 'cleans nested values' do
+          b_value = Object.new
+          c_key = Object.new
+          d_value = Object.new
+
+          d_array = ['d', :d, { d: "\ud7ff", 'd' => d_value }]
+
+          h = {
+            a: 1,
+            b: b_value,
+            c_key => 'c value',
+            0xd => d_array,
+            "\uEEEE" => 0xe
+          }
+
+          expected = {
+            a: 1,
+            b: b_value.to_s,
+            c_key.to_s => 'c value',
+            0xd => ['d', :d, { d: "\ud7ff", 'd' => d_value.to_s }],
+            "\uEEEE" => 0xe
+          }
+
+          actual = SafeSerializer.serialize(h)
+          expect(actual).to eq(expected)
+        end
+
+        it 'handles recursive structures' do
+          a = []
+          h = { a: a }
+          a << h
+
+          h_expected = { a: [SafeSerializer.placeholder_for(h)] }
+          a_expected = [{ a: SafeSerializer.placeholder_for(a) }]
+
+          expect(SafeSerializer.serialize(h)).to eq(h_expected)
+          expect(SafeSerializer.serialize(a)).to eq(a_expected)
+        end
+
+        context 'exceptions' do
+          # rubocop:disable Lint/ConstantDefinitionInBlock
+          before(:each) do
+            class ::TestError < StandardError
+              attr_writer :cause
+
+              def cause
+                @cause || super
+              end
+            end
+          end
+          # rubocop:enable Lint/ConstantDefinitionInBlock
+
+          after(:each) do
+            Object.send(:remove_const, :TestError)
+          end
+
+          # rubocop:disable Naming/RescuedExceptionsVariableName
+          it 'handles exceptions' do
+            msg_outer = 'Help I am trapped in the outer part of a unit test'
+            msg_inner = 'Help I am trapped in the inner part of a unit test'
+
+            begin
+              raise TestError, msg_inner
+            rescue TestError => ex_inner
+              begin
+                raise TestError, msg_outer
+              rescue TestError => ex_outer
+                ex_inner.cause = ex_outer
+              end
+            end
+
+            expect(ex_outer.cause).to eq(ex_inner) # just to be sure
+            expect(ex_inner.cause).to eq(ex_outer) # just to be sure
+
+            expected = {
+              name: 'TestError',
+              message: msg_outer,
+              stack: ex_outer.backtrace,
+              cause: {
+                name: 'TestError',
+                message: msg_inner,
+                stack: ex_inner.backtrace
+              }
+            }
+
+            expect(SafeSerializer.serialize(ex_outer)).to eq(expected)
+          end
+          # rubocop:enable Naming/RescuedExceptionsVariableName
+
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: berkeley_library-logging
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - David Moles
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-03 00:00:00.000000000 Z
+date: 2021-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -297,11 +297,13 @@ files:
 - lib/berkeley_library/logging/configurator.rb
 - lib/berkeley_library/logging/env.rb
 - lib/berkeley_library/logging/events.rb
+- lib/berkeley_library/logging/exception_serializer.rb
 - lib/berkeley_library/logging/formatters.rb
 - lib/berkeley_library/logging/logger.rb
 - lib/berkeley_library/logging/loggers.rb
 - lib/berkeley_library/logging/module_info.rb
 - lib/berkeley_library/logging/railtie.rb
+- lib/berkeley_library/logging/safe_serializer.rb
 - lib/berkeley_library/logging/tagged_logging_extensions.rb
 - rakelib/.rubocop.yml
 - rakelib/bundle.rake
@@ -315,12 +317,14 @@ files:
 - spec/rails/ucblit/logging/formatters_spec.rb
 - spec/rails/ucblit/logging/loggers_spec.rb
 - spec/rails/ucblit/logging/railtie_spec.rb
+- spec/rails/ucblit/logging/safe_serializer_spec.rb
 - spec/rails/ucblit/logging_spec.rb
 - spec/rails_helper.rb
 - spec/spec_helper.rb
 - spec/standalone/ucblit/logging/configurator_spec.rb
 - spec/standalone/ucblit/logging/formatters_spec.rb
 - spec/standalone/ucblit/logging/loggers_spec.rb
+- spec/standalone/ucblit/logging/safe_serializer_spec.rb
 - spec/standalone/ucblit/logging_spec.rb
 - spec/standalone_helper.rb
 homepage: https://github.com/BerkeleyLibrary/logging
@@ -347,17 +351,20 @@ signing_key:
 specification_version: 4
 summary: Opinionated Ruby/Rails logging for UC Berkeley Library
 test_files:
+- artifacts/.keep
 - spec/.rubocop.yml
 - spec/rails/ucblit/logging/configurator_spec.rb
 - spec/rails/ucblit/logging/env_spec.rb
 - spec/rails/ucblit/logging/formatters_spec.rb
 - spec/rails/ucblit/logging/loggers_spec.rb
 - spec/rails/ucblit/logging/railtie_spec.rb
+- spec/rails/ucblit/logging/safe_serializer_spec.rb
 - spec/rails/ucblit/logging_spec.rb
 - spec/rails_helper.rb
 - spec/spec_helper.rb
 - spec/standalone/ucblit/logging/configurator_spec.rb
 - spec/standalone/ucblit/logging/formatters_spec.rb
 - spec/standalone/ucblit/logging/loggers_spec.rb
+- spec/standalone/ucblit/logging/safe_serializer_spec.rb
 - spec/standalone/ucblit/logging_spec.rb
 - spec/standalone_helper.rb