berkeley_library-logging 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c60520b7195f791061df89827e2a6c7b00ac1352262d7cf750511a125d30c02
-  data.tar.gz: bcb3ddb18cb7bfa442a52bbe5116316b74ae7f6d7c4e2e414812a5838e4a84fa
+  metadata.gz: 2d520b09c106d1976a6d47efb671ba9c9ee8696f573e4aeb2571cdd1706744ae
+  data.tar.gz: f801c8ee42f5e4cfee28f4148775b2142d3dfe26bb0f6e3633292bb7cd5ef747
 SHA512:
-  metadata.gz: '085e7cc941c61021cfa90d6c2f2cb7c53d05d8900dc067aa87cc2ba6302e96032e31683ff3e9d1d2ba62770556569ebda96566f81c8eee0eec50c7683ed00b36'
-  data.tar.gz: 0ca861efeca0e9b7c94cf87bbf410a0d826cfd9a1918e5b351148f102a9b8bbc64e4e7979aeb6044ab122def7d6bf82e798447ed19fe36ef7a34b47fa502ad61
+  metadata.gz: 3ecb69bb4608198f67eed2b4215ddc105096f86a469b504f72ff331ef3380616afe83c9fe0a63f375f09453f7d23eca8a8032b6e8452db8ae84811ad079e996f
+  data.tar.gz: f9c681893d8e25c2e1588fa5fa51b44db09cf8c782bf650a9b4606b9ffa26f380a6678155a23692025f149791684ec2201e1ec41c9c90bd8ea2c1ea39f957aba

data/CHANGES.md

@@ -1,3 +1,8 @@
+# 0.2.3 (2021-09-02)
+
+- JSON formatter now strips all ANSI 7-bit C1 escapes from strings
+  (fixes [#1](https://github.com/BerkeleyLibrary/logging/issues/1) properly)
+
 # 0.2.2 (2021-09-02)
 
 - JSON formatter now strips ANSI color escapes from strings

data/README.md

@@ -1,7 +1,7 @@
 # BerkeleyLibrary::Logging
 
 [![Build Status](https://github.com/BerkeleyLibrary/logging/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/BerkeleyLibrary/logging/actions/workflows/build.yml)
-[![Gem Version](https://img.shields.io/gem/v/berkeley_library-logging.svg)](https://github.com/BerkeleyLibrary/logging/releases)
+[![Gem Version](https://img.shields.io/gem/v/berkeley_library-logging.svg)](https://rubygems.org/gems/berkeley_library-logging/)
 
 Opinionated logging for UCB Library IT Rails applications.
 

data/berkeley_library-logging.gemspec

@@ -34,7 +34,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'brakeman', '~> 4.9'
   spec.add_development_dependency 'bundle-audit', '~> 0.1'
   spec.add_development_dependency 'ci_reporter_rspec', '~> 1.0'
-  spec.add_development_dependency 'colorize', '~> 0.8'
   spec.add_development_dependency 'dotenv', '~> 2.7'
   spec.add_development_dependency 'irb', '~> 1.2' # workaroundfor https://github.com/bundler/bundler/issues/6929
   spec.add_development_dependency 'listen', '>= 3.0.5', '< 3.2'

data/lib/berkeley_library/logging/formatters.rb

@@ -5,6 +5,10 @@ module BerkeleyLibrary
     module Formatters
 
       class << self
+
+        # See https://stackoverflow.com/a/14693789/27358
+        ANSI_7C1_RE = %r{\x1B(?:[@-Z\\-_]|\[[0-?]*[ -/]*[@-~])}.freeze
+
         def new_json_formatter
           Bunyan.new
         end
@@ -24,11 +28,11 @@ module BerkeleyLibrary
           { msg: message }
         end
 
-        def decolorize(message)
+        def strip_ansi_escapes(message)
           return unless message
-          return message.uncolorize if message.is_a?(String)
-          return message.map { |v| decolorize(v) } if message.is_a?(Array)
-          return message.transform_values { |v| decolorize(v) } if message.is_a?(Hash)
+          return message.gsub(ANSI_7C1_RE, '') if message.is_a?(String)
+          return message.map { |v| strip_ansi_escapes(v) } if message.is_a?(Array)
+          return message.transform_values { |v| strip_ansi_escapes(v) } if message.is_a?(Hash)
 
           message
         end
@@ -87,7 +91,7 @@ module BerkeleyLibrary
 
         def _call(severity, time, progname, data)
           original_data = Formatters.ensure_hash(data)
-          decolorized_data = Formatters.decolorize(original_data)
+          decolorized_data = Formatters.strip_ansi_escapes(original_data)
 
           # Ougai::Formatters::Bunyan replaces the human-readable severity string
           # with a numeric level, so we add it here as a separate attribute

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.2'.freeze
+      VERSION = '0.2.3'.freeze
       HOMEPAGE = 'https://github.com/BerkeleyLibrary/logging'.freeze
 
       private_class_method :new

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

@@ -67,6 +67,15 @@ module BerkeleyLibrary
           expect(additional_data['another_string']).to eq(expected_string)
           expect(additional_data['more_strings']).to eq([expected_string, expected_string])
         end
+
+        it 'removes ANSI formatting from ActiveRecord logs' do
+          original = "  \e[1m\e[36mLendingItem Load (2.0ms)\e[0m  \e[1m\e[34mSELECT \"lending_items\".* FROM \"lending_items\" WHERE \"lending_items\".\"directory\" = $1 LIMIT $2\e[0m  [[\"directory\", \"b135297126_C068087930\"], [\"LIMIT\", 1]]"
+          expected = '  LendingItem Load (2.0ms)  SELECT "lending_items".* FROM "lending_items" WHERE "lending_items"."directory" = $1 LIMIT $2  [["directory", "b135297126_C068087930"], ["LIMIT", 1]]'
+          logger.info(original)
+          logged_json = JSON.parse(out.string)
+          msg = logged_json['msg']
+          expect(msg).to eq(expected)
+        end
       end
 
       describe :ensure_hash do

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

@@ -65,6 +65,15 @@ module BerkeleyLibrary
           expect(additional_data['another_string']).to eq(expected_string)
           expect(additional_data['more_strings']).to eq([expected_string, expected_string])
         end
+
+        it 'removes ANSI formatting from ActiveRecord logs' do
+          original = "  \e[1m\e[36mLendingItem Load (2.0ms)\e[0m  \e[1m\e[34mSELECT \"lending_items\".* FROM \"lending_items\" WHERE \"lending_items\".\"directory\" = $1 LIMIT $2\e[0m  [[\"directory\", \"b135297126_C068087930\"], [\"LIMIT\", 1]]"
+          expected = '  LendingItem Load (2.0ms)  SELECT "lending_items".* FROM "lending_items" WHERE "lending_items"."directory" = $1 LIMIT $2  [["directory", "b135297126_C068087930"], ["LIMIT", 1]]'
+          logger.info(original)
+          logged_json = JSON.parse(out.string)
+          msg = logged_json['msg']
+          expect(msg).to eq(expected)
+        end
       end
 
       describe :ensure_hash do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: berkeley_library-logging
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - David Moles
@@ -122,20 +122,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: colorize
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement