appydays 0.8.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfd157bff00c9a41a678f4f8877660e90f9bb094b367ea0bedf153d7ea30d528
-  data.tar.gz: 4da1794259b8f5a2ad0d43544092487b91b56f840439404567ca26467264c8d8
+  metadata.gz: d460b440b0d1e096ac8d1aa9d21da1b8de8b0147ae1698f65242a9d047db7f9b
+  data.tar.gz: bb73da0a0a8dac1afd63ff66ff25427736f79e2ac3e6f16757a8643b04385885
 SHA512:
-  metadata.gz: 85e0c276cb7978298f3a14fadfa71e767b216b2fd419beecda09fe6855eea3de8cf58e9651869eae45a1317a47df659ff0db69de8daf29533040f190eaac07b2
-  data.tar.gz: 0d07c35465caebd19c9cb86a3d2113cdd1bacebe80cfedd2251da076fdaadec46d0fa47c5e147e9c3fee78ec7b1afff39291ea30057b20e562c28010af4710dc
+  metadata.gz: 645fcf14b44cf77ac41ad813b61be5fd0ffb957ed920e068d5bc277372a4b6aba567ed4a86e3017fbfbc76dba1eb3d9315fb5ade7fe4a412cf7903dfbbe8aec7
+  data.tar.gz: 1b551951f4dca1bf41bebadbc0b2f49e84b7bd5a2e2797e8822e953e621624c95fd4db12605a3ae5093a99d7968416de928b94319147feda2bb785f4117ecdff

data/lib/appydays/dotenviable.rb

@@ -24,6 +24,13 @@ require "appydays/version"
 # it won't get used, because .env files don't stomp what is already in the environment
 # (we don't want to use `overload`).
 # So we have some trickery to overwrite only PORT.
+#
+# @param rack_env [nil,String] Value like 'development' or 'production' to use to load .env files.
+#   If not given, use +env['RACK_ENV']+ or +default_rack_env+.
+# @param default_rack_env [String] If +env['RACK_ENV']+ is not set, use this value.
+# @param env [Hash] Hash to read and mutate.
+#   Pass in a different hash to load environment variables into it instead of ENV.
+#   Useful for testing, or to get the config for another environment.
 module Appydays::Dotenviable
   def self.load(rack_env: nil, default_rack_env: "development", env: ENV)
     original_port = env.delete("PORT")
@@ -33,7 +40,17 @@ module Appydays::Dotenviable
       ".env.#{rack_env}",
       ".env",
     ]
+    orig_env = nil
+    if env.object_id != ENV.object_id
+      orig_env = ENV.to_h
+      ENV.replace(env)
+    end
     Dotenv.load(*paths)
+    if orig_env
+      env.merge!(ENV)
+      ENV.replace(orig_env)
+    end
+
     env["PORT"] ||= original_port
     env["RACK_ENV"] ||= rack_env
   end

data/lib/appydays/loggable/sequel_logger.rb

@@ -45,7 +45,7 @@ class Sequel::Database
       :info,
       proc { args ? "#{message}; #{args.inspect}" : message },
       proc do
-        o = {message: message}
+        o = {message:}
         o[:args] = args unless args.nil?
         ["sequel_log", o]
       end,
@@ -62,7 +62,7 @@ class Sequel::Database
       proc { "(#{'%0.6fs' % duration}) #{message}" },
       proc do
         query = AppydaysLogger.truncate_message(message)
-        params = {duration: duration * 1000, query: query}
+        params = {duration: duration * 1000, query:}
         if query != message
           params[:truncated] = true
           was_truncated = true

data/lib/appydays/loggable/sidekiq_job_logger.rb

@@ -20,7 +20,7 @@ class Appydays::Loggable::SidekiqJobLogger < Sidekiq::JobLogger
 
   Sidekiq.logger = self.logger
 
-  def call(item, _queue, &block)
+  def call(item, _queue, &)
     start = self.now
     tags = {
       job_class: item["class"],
@@ -28,7 +28,7 @@ class Appydays::Loggable::SidekiqJobLogger < Sidekiq::JobLogger
       thread_id: self.tid,
     }
     self.with_log_tags(tags) do
-      self.call_inner(start, &block)
+      self.call_inner(start, &)
     end
   end
 

data/lib/appydays/loggable/spec_helpers.rb

@@ -36,7 +36,7 @@ module Appydays::Loggable::SpecHelpers
     loggers.each { |log| log.level = level }
 
     io = StringIO.new
-    appender = SemanticLogger.add_appender(io: io, level: level)
+    appender = SemanticLogger.add_appender(io:, level:)
     appender.formatter = formatter if formatter
     begin
       yield

data/lib/appydays/loggable.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require "semantic_logger"
+require "semantic_logger/formatters/raw"
+require "semantic_logger/formatters/json"
 
 require "appydays/version"
 
@@ -29,6 +31,75 @@ class SemanticLogger::Formatters::Raw
   end
 end
 
+# SemanticLogger Formatter that truncates large strings in the structured log payload.
+# If the emitted JSON log is longer than +max_message_len+:
+# - the payload is walked,
+# - any strings with a length greater than +max_string_len+ are shortened using +shorten_string+.
+#   Override +shorten_string+ for custom behavior.
+# - any key +:stack_trace+ has its array truncated. Stack traces are very large,
+#   but contain short strings. Override +truncate_stack_trace+ for custom behavior.
+class SemanticLogger::Formatters::JsonTrunc < SemanticLogger::Formatters::Raw
+  attr_accessor :max_message_len, :max_string_len
+
+  def initialize(max_message_len: 1024 * 3, max_string_len: 300, **args)
+    super(**args)
+    @max_message_len = max_message_len
+    @max_string_len = max_string_len
+  end
+
+  def truncate_at(max_message_len, max_string_len)
+    @max_message_len = max_message_len
+    @max_string_len = max_string_len
+  end
+
+  def call(log, logger)
+    r = super
+    rj = r.to_json
+    return rj if rj.length <= @max_message_len
+    rshort = self.trim_long_strings(r)
+    return rshort.to_json
+  end
+
+  def trim_long_strings(v)
+    case v
+      when Hash
+        v.each_with_object({}) do |(hk, hv), memo|
+          memo[hk] =
+            if hk == :stack_trace && hv.is_a?(Array)
+              self.truncate_stack_trace(hv)
+            else
+              self.trim_long_strings(hv)
+            end
+        end
+      when Array
+        v.map { |item| self.trim_long_strings(item) }
+      when String
+        if v.size > @max_string_len
+          self.shorten_string(v)
+        else
+          v
+        end
+      else
+        v
+    end
+  end
+
+  # Given a long string, return the truncated string.
+  # @param v [String]
+  # @return [String]
+  def shorten_string(v)
+    return v[..@max_string_len] + "..."
+  end
+
+  # Given a stack trace array, return the array to log.
+  # @param arr [Array]
+  # @return [Array]
+  def truncate_stack_trace(arr)
+    return arr if arr.length <= 4
+    return [arr[0], arr[1], "skipped #{arr.length - 4} frames", arr[-2], arr[-1]]
+  end
+end
+
 ##
 # Helpers for working with structured logging.
 # Use this instead of calling semantic_logger directly.
@@ -94,8 +165,8 @@ module Appydays::Loggable
   end
 
   module Methods
-    def with_log_tags(tags, &block)
-      return SemanticLogger.named_tagged(tags, &block)
+    def with_log_tags(tags, &)
+      return SemanticLogger.named_tagged(tags, &)
     end
   end
 end

data/lib/appydays/spec_helpers.rb

@@ -85,7 +85,7 @@ module Appydays::SpecHelpers
     end
 
     protected def change_tz(t, zone)
-      return t.change(zone: zone) if t.respond_to?(:change)
+      return t.change(zone:) if t.respond_to?(:change)
       prev_tz = ENV.fetch("TZ", nil)
       begin
         ENV["TZ"] = zone

data/lib/appydays/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Appydays
-  VERSION = "0.8.0"
+  VERSION = "0.10.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appydays
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Lithic Tech
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-27 00:00:00.000000000 Z
+date: 2024-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -220,6 +220,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -267,7 +281,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="