enhanced_errors 0.1.8 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edc10f9326ea041bd8b367e57eb1037767847df8359408529445160ae76876b2
-  data.tar.gz: d5a4aee4cd8f3cca01a57fb10c25b120f5d3e7e1f5bf0255ef107255823704ef
+  metadata.gz: 42e0ffde5da4be326f8b1d721652eed031f7bfb20a07d31a256d69c588a383b7
+  data.tar.gz: 5ef8303d0e6dd089253643b2abbf4aeef9a195831c946b2c92396390685e0a5b
 SHA512:
-  metadata.gz: 4f3519f1c11d31cccfe4110deda8a2dcbc26b9cbd7ab0c9a0cd6b9ac65d32c57cc24b35f2a4a0f075888d20be3a69d397a0f631e617741705d1634834096a084
-  data.tar.gz: 0a9d12908d54b1173123cea3f66de3bbfa96863d92fad8990c281459de0bd66b2e26e405910c31cb6336f726f1bba41e99aac2793238835ce144576acdb3004e
+  metadata.gz: cb553e2a7f127a2d7efbf77c25867a9706d500ffb70e6e48060cd42390cdd903f140d60a899ed61f0d3340697b3ec4458a704545aa4380dad928d64a76d9b158
+  data.tar.gz: 467e3f82cb5a170081b43f417dfa0b53c12df77a6a2614d13377d47227a00df0623d515a92707b52fd5cc8461f3862c16ae83c3aa264beff2ee63f88072299ce

data/README.md

@@ -384,7 +384,9 @@ Ruby's TracePoint binding capture very narrowly with no other C API or dependenc
 
 - **TBD**: Memory considerations. This does capture data when an exception happens. EnhancedErrors hides under the bed when it sees **NoMemoryError**.
 
-- **Goal: Production Safety**: The gem is designed to, once vetted, be safe for production use, giving you valuable insights without compromising performance. I suggest letting it get well-vetted before making the leap and testing it for both performance and memory under load internally, as well.
+- **Goal: Production Safety**: The gem is designed to, once vetted, be safe for production use, giving you valuable insights without compromising performance.
+I suggest letting it get well-vetted before making the leap and testing it for both performance and memory under load internally, as well.
+I would not enable it in production *yet*.
 
 ## Contributing
 

data/enhanced_errors.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name = "enhanced_errors"
-  spec.version = "0.1.8"
+  spec.version = "1.0.0"
   spec.authors = ["Eric Beland"]
 
   spec.summary = "Automatically enhance your errors with messages containing variable values from the moment they were raised."

data/lib/enhanced_errors.rb

@@ -7,18 +7,27 @@ require_relative 'colors'
 require_relative 'error_enhancements'
 require_relative 'binding'
 
-# While we could just catch StandardError, we would miss a number of things.
-IGNORED_EXCEPTIONS = [
-  SystemExit,
-  NoMemoryError,
-  SignalException,
-  Interrupt,
-  ScriptError,
-  LoadError,
-  NotImplementedError,
-  SyntaxError,
-  SystemStackError
-]
+# Exception class names to ignore. Using strings to avoid uninitialized constant errors.
+IGNORED_EXCEPTION_NAMES = %w[SystemExit NoMemoryError SignalException Interrupt
+                             ScriptError LoadError NotImplementedError SyntaxError
+                             SystemStackError Psych::BadAlias]
+
+# Helper method to safely resolve class names to constants
+def resolve_exception_class(name)
+  names = name.split('::')
+  names.inject(Object) do |mod, name_part|
+    if mod.const_defined?(name_part, false)
+      mod.const_get(name_part)
+    else
+      return nil
+    end
+  end
+rescue NameError
+  nil
+end
+
+# Attempt to resolve the exception classes, ignoring any that are not defined
+IGNORED_EXCEPTIONS = IGNORED_EXCEPTION_NAMES.map { |name| resolve_exception_class(name) }.compact
 
 # The EnhancedErrors class provides mechanisms to enhance exception handling by capturing
 # additional context such as binding information, variables, and method arguments when exceptions are raised.
@@ -30,10 +39,10 @@ class EnhancedErrors
     # @return [Boolean]
     attr_accessor :enabled
 
-    # The TracePoint object used for tracing exceptions.
+    # The TracePoint objects used for tracing exceptions per thread.
     #
-    # @return [TracePoint, nil]
-    attr_accessor :trace
+    # @return [Hash{Thread => TracePoint}]
+    attr_accessor :traces
 
     # The configuration block provided during enhancement.
     #
@@ -192,7 +201,8 @@ class EnhancedErrors
       if enabled == false
         @original_global_variables = nil
         @enabled = false
-        @trace.disable if @trace
+        # Disable TracePoints in all threads
+        @traces.each_value { |trace| trace.disable } if @traces
       else
         @enabled = true
         @debug = debug
@@ -213,7 +223,20 @@ class EnhancedErrors
         instance_eval(&@config_block) if @config_block
 
         validate_and_set_capture_events(capture_events)
-        start_tracing
+
+        # Initialize @traces hash to keep track of TracePoints per thread
+        @traces ||= {}
+        # Set up TracePoint in the main thread
+        start_tracing(Thread.current)
+
+        # Set up TracePoint in all existing threads
+        Thread.list.each do |thread|
+          next if thread == Thread.current
+          start_tracing(thread)
+        end
+
+        # Hook into Thread creation to set up TracePoint in new threads
+        override_thread_new
       end
     end
 
@@ -296,20 +319,10 @@ class EnhancedErrors
     # @param format [Symbol] The format to use (:json, :plaintext, :terminal).
     # @return [String] The formatted string representation of the binding information.
     def binding_infos_array_to_string(captured_bindings, format = :terminal)
-      case format
-      when :json
-        Colors.enabled = false
-        JSON.pretty_generate(captured_bindings)
-      when :plaintext
-        Colors.enabled = false
-        captured_bindings.map { |binding_info| binding_info_string(binding_info) }.join("\n")
-      when :terminal
-        Colors.enabled = true
-        captured_bindings.map { |binding_info| binding_info_string(binding_info) }.join("\n")
-      else
-        Colors.enabled = false
-        captured_bindings.map { |binding_info| binding_info_string(binding_info) }.join("\n")
-      end
+      Colors.enabled = format == :terminal
+      formatted_bindings = captured_bindings.map { |binding_info| binding_info_string(binding_info) }
+
+      format == :json ? JSON.pretty_generate(captured_bindings) : formatted_bindings.join("\n")
     end
 
     # Determines the default output format based on the current environment.
@@ -418,14 +431,15 @@ class EnhancedErrors
 
     private
 
-    # Starts the TracePoint for capturing exceptions based on configured events.
+    # Starts the TracePoint for capturing exceptions based on configured events in a specific thread.
     #
+    # @param thread [Thread] The thread to start tracing in.
     # @return [void]
-    def start_tracing
-      return if @trace && @trace.enabled?
+    def start_tracing(thread)
+      return if @traces[thread]&.enabled?
       events = @capture_events ? @capture_events.to_a : default_capture_events
-      @trace = TracePoint.new(*events) do |tp|
-        next if Thread.current[:enhanced_errors_processing] || ignored_exception?(tp.raised_exception)
+      trace = TracePoint.new(*events) do |tp|
+        next if Thread.current[:enhanced_errors_processing] || Thread.current[:on_capture] || ignored_exception?(tp.raised_exception)
         Thread.current[:enhanced_errors_processing] = true
         exception = tp.raised_exception
         capture_me = !exception.frozen? && EnhancedErrors.eligible_for_capture.call(exception)
@@ -499,11 +513,14 @@ class EnhancedErrors
 
         if on_capture_hook
           begin
+            Thread.current[:on_capture] = true
             binding_info = on_capture_hook.call(binding_info)
           rescue => e
             # Since the on_capture_hook failed, do not capture this binding_info
             binding_info = nil
             # Optionally, log the error safely if logging is guaranteed not to raise exceptions
+          ensure
+            Thread.current[:on_capture] = false
           end
         end
 
@@ -520,7 +537,36 @@ class EnhancedErrors
         Thread.current[:enhanced_errors_processing] = false
       end
 
-      @trace.enable
+      @traces[thread] = trace
+      trace.enable
+    end
+
+    # Overrides Thread.new and Thread.start to ensure TracePoint is enabled in new threads.
+    #
+    # @return [void]
+    def override_thread_new
+      return if @thread_overridden
+      @thread_overridden = true
+
+      class << Thread
+        alias_method :original_new, :new
+
+        def new(*args, &block)
+          original_new(*args) do |*block_args|
+            EnhancedErrors.send(:start_tracing, Thread.current)
+            block.call(*block_args)
+          end
+        end
+
+        alias_method :original_start, :start
+
+        def start(*args, &block)
+          original_start(*args) do |*block_args|
+            EnhancedErrors.send(:start_tracing, Thread.current)
+            block.call(*block_args)
+          end
+        end
+      end
     end
 
     # Checks if the exception is in the ignored exceptions list.
@@ -711,8 +757,8 @@ class EnhancedErrors
     # @return [String] The string representation or a safe fallback.
     def safe_to_s(variable)
       str = variable.to_s
-      if str.length > 30
-        str[0...30] + '...'
+      if str.length > 120
+        str[0...120] + '...'
       else
         str
       end

data/lib/error_enhancements.rb

@@ -19,46 +19,41 @@ module ErrorEnhancements
 
   def variables_message
     @variables_message ||= begin
-                             bindings_of_interest = []
-                             if defined?(@binding_infos) && @binding_infos && !@binding_infos.empty?
+                             if @binding_infos&.any?
                                bindings_of_interest = select_binding_infos(@binding_infos)
+                               EnhancedErrors.format(bindings_of_interest)
+                             else
+                               ''
                              end
-                             EnhancedErrors.format(bindings_of_interest)
-                           rescue => e
-                             # Avoid using puts; consider logging instead
-                             # Avoid raising exceptions in rescue blocks
-                             ""
+                           rescue
+                             ''
                            end
   end
 
   private
 
-  def select_binding_infos(binding_infos)
-    # Preference:
-    # Grab the first raise binding that isn't a library (gem) binding.
-    # If there are only library bindings, grab the first one.
-    # Grab the last rescue binding if we have one
+    def select_binding_infos(binding_infos)
+      # Preference:
+      # 1. First 'raise' binding that isn't from a library (gem).
+      # 2. If none, the first binding.
+      # 3. The last 'rescue' binding if available.
 
-    bindings_of_interest = []
+      bindings_of_interest = []
 
-    binding_infos.each do |info|
-      if info[:capture_event] == 'raise' && !info[:library]
-        bindings_of_interest << info
-        break
+      first_app_raise = binding_infos.find do |info|
+        info[:capture_event] == 'raise' && !info[:library]
       end
-    end
+      bindings_of_interest << first_app_raise if first_app_raise
 
-    if bindings_of_interest.empty?
-      bindings_of_interest << binding_infos.first if binding_infos.first
-    end
+      if bindings_of_interest.empty? && binding_infos.first
+        bindings_of_interest << binding_infos.first
+      end
 
-    # Find the last rescue binding if there is one
-    binding_infos.reverse.each do |info|
-      if info[:capture_event] == 'rescue'
-        bindings_of_interest << info
-        break
+      last_rescue = binding_infos.reverse.find do |info|
+        info[:capture_event] == 'rescue'
       end
+      bindings_of_interest << last_rescue if last_rescue
+
+      bindings_of_interest
     end
-    bindings_of_interest
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enhanced_errors
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 1.0.0
 platform: ruby
 authors:
 - Eric Beland
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-04 00:00:00.000000000 Z
+date: 2024-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print