debug_socket 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92e2954364c7dd4e35377fcf428a18359e1f0e08155976d3991d39b9c64445ae
-  data.tar.gz: 5c970a58fca9e9c995b0223b988c48b2aea894906161bd336e566b4fbbdcab5f
+  metadata.gz: 8d2dbd80985d505fb3e16fe6c52dc1a52c7e597edca008a244edbd063246cf64
+  data.tar.gz: bf6e4ad9977359e46c8639a4791ef68f9b9a80b458183a23eb253bf5a9a375f1
 SHA512:
-  metadata.gz: 603356c14c52452afcd8453a26dd657a0ef033b09f7b3df3ad0f50425ef9ea08d14998f430aceb1e85dc57d7819f7391acce142efc1466bbd4ede6ed758e1ac2
-  data.tar.gz: 11ff34cbba7b9a01f7632fa59b5893427c8eeb2782387198946eb792724791c6c0cd7f9dded065c8934e8e3dc43b601d6cef6db081d2abf3b19113630ac05a1c
+  metadata.gz: 3041feb5fbad526e6eeb456adf2b769df4fde7dec715769e7cce7f2a20637652828613111c6f608edb6a03471bc6093e7a02c123f23dce9fdc9fe6149e4c0883
+  data.tar.gz: c4d468b0d3d142ab6b1be8d76dbb36ec2bace7b4d839ead868fb527b989bfe8b9cc549a740b3a407222044db71cba436aa24ca5e30b82fdbb4e40f466336c148

data/.github/workflows/ruby.yml

@@ -0,0 +1,34 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.1', '3.2', '3.3', '3.4']
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/.rubocop.yml

@@ -1,15 +1,25 @@
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 3.1
   DisplayCopNames: true
+  NewCops: enable
 
-Style/FrozenStringLiteralComment:
-  Enabled: true
+plugins:
+  - rubocop-rake
+  - rubocop-rspec
 
+Layout/LineLength:
+  Enabled: false
 Metrics:
   Enabled: false
-
+RSpec/DescribedClass:
+  Enabled: false
+RSpec/ExampleLength:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Enabled: false
 Style/Documentation:
   Enabled: false
-
+Style/FrozenStringLiteralComment:
+  Enabled: true
 Style/StringLiterals:
   EnforcedStyle: double_quotes

data/CHANGES.md

@@ -1,3 +1,15 @@
+### 0.1.9 2025-04-03
+
+- [#17](https://github.com/square/debug_socket/pull/17)
+  Refactor error handling. Previously all errors (including `eval` errors) were caught in the same `rescue Exception`.
+  Now, we only `rescue Exception` for `eval` errors. For `DebugSocket` errors, we only `rescue StandardError` and we
+  allow 20 consecutive errors before `DebugSocket` gives up and dies permanently.
+  (@nerdrew)
+
+- [#16](https://github.com/square/debug_socket/pull/16)
+  Allow external auditing of debug sessions.
+  (@doctown)
+
 ### 0.1.8 2022-10-10
 
 - [#15](https://github.com/square/debug_socket/pull/15)

data/Gemfile

@@ -5,7 +5,13 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in debug_socket.gemspec
 gemspec
 
-gem "pry"
+gem "base64"
+gem "ostruct"
+gem "pry-byebug"
 gem "rake"
 gem "rspec", "~> 3.8"
-gem "rubocop", "0.59.1"
+gem "rubocop", "1.73.1"
+gem "rubocop-rake"
+gem "rubocop-rspec"
+gem "ruby-lsp", require: false
+gem "syntax_tree", require: false

data/debug_socket.gemspec

@@ -17,4 +17,7 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  spec.required_ruby_version = ">= 3.1"
 end

data/exe/debug-socket

@@ -12,8 +12,10 @@ end
 socket_path = ARGV[0]
 command = ARGV[1] || "backtrace"
 
-warn "\nSending `#{command}` to the following socket: #{socket_path}"\
+warn(
+  "\nSending `#{command}` to the following socket: #{socket_path}" \
   "----------------------------------------------------------\n\n"
+)
 
 UNIXSocket.open(socket_path) do |socket|
   socket.write(command)

data/lib/debug_socket/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DebugSocket
-  VERSION = "0.1.8"
+  VERSION = "0.1.9"
 end

data/lib/debug_socket.rb

@@ -5,6 +5,30 @@ require "socket"
 require "time"
 
 module DebugSocket
+  module Commands
+    # When running `eval`, we don't want the input to overwrite local variables etc. `eval` runs in the current scope,
+    # so we have an empty scope here that runs in a module that only has other shortcut commands the client might want
+    # to run.
+    def self.isolated_eval(input)
+      eval(input) # rubocop:disable Security/Eval
+    # We rescue Exception here because the input could have SyntaxErrors etc.
+    rescue Exception => e # rubocop:disable Lint/RescueException
+      DebugSocket.logger&.error { "debug-socket-error=#{e.inspect} input=#{input.inspect} path=#{@path} backtrace=#{e.backtrace.inspect}" }
+      "#{e.class.name}: #{e.message}\n#{e.backtrace.join("\n")}"
+    end
+
+    # Print the backtrace for every Thread
+    def self.backtrace
+      pid = Process.pid
+      "#{Time.now.utc.iso8601} #{$PROGRAM_NAME}\n" + Thread.list.map do |thread|
+        output = "#{Time.now.utc.iso8601} pid=#{pid} thread.object_id=#{thread.object_id} thread.status=#{thread.status}"
+        backtrace = thread.backtrace || []
+        output << "\n#{backtrace.join("\n")}" if backtrace
+        output
+      end.join("\n\n")
+    end
+  end
+
   @thread = nil
   @pid = Process.pid
 
@@ -16,10 +40,10 @@ module DebugSocket
     return @logger if defined?(@logger)
 
     require "logger"
-    @logger = Logger.new(STDERR)
+    @logger = Logger.new($stderr)
   end
 
-  def self.start(path)
+  def self.start(path, &block)
     pid = Process.pid
     raise "debug socket thread already running for this process" if @thread && @pid == pid
 
@@ -32,18 +56,27 @@ module DebugSocket
 
     server = UNIXServer.new(@path)
     @thread = Thread.new do
+      errors = 0
       loop do
-        begin
-          socket = server.accept
-          input = socket.read
-          logger&.warn("debug-socket-command=#{input.inspect}")
-          socket.puts(eval(input)) # rubocop:disable Security/Eval
-        rescue Exception => e # rubocop:disable Lint/RescueException
-          logger&.error { "debug-socket-error=#{e.inspect} backtrace=#{e.backtrace.inspect}" }
-        ensure
-          socket&.close
-        end
+        socket = server.accept
+        input = socket.read
+        logger&.warn("debug-socket-command=#{input.inspect}")
+
+        perform_audit(input, &block) if block
+        socket.puts(Commands.isolated_eval(input))
+
+        errors = 0
+      rescue StandardError => e
+        errors += 1
+        logger&.error { "debug-socket-error=#{e.inspect} errors=#{errors} path=#{@path} backtrace=#{e.backtrace.inspect}" }
+        raise e if errors > 20
+
+        sleep(1)
+      ensure
+        socket&.close
       end
+    rescue Exception => e # rubocop:disable Lint/RescueException
+      logger&.error { "debug-socket-error=#{e.inspect} DebugSocket is broken now path=#{@path} backtrace=#{e.backtrace.inspect}" }
     end
 
     logger&.unknown { "Debug socket listening on #{@path}" }
@@ -61,14 +94,10 @@ module DebugSocket
     @path = nil
   end
 
-  def self.backtrace
-    pid = Process.pid
-    "#{Time.now.utc.iso8601} #{$PROGRAM_NAME}\n" + Thread.list.map do |thread|
-      output =
-        +"#{Time.now.utc.iso8601} pid=#{pid} thread.object_id=#{thread.object_id} thread.status=#{thread.status}"
-      backtrace = thread.backtrace || []
-      output << "\n#{backtrace.join("\n")}" if backtrace
-      output
-    end.join("\n\n")
+  # Allow debug socket input commands to be audited by an external callback
+  private_class_method def self.perform_audit(input)
+    yield input
+  rescue Exception => e # rubocop:disable Lint/RescueException
+    logger&.error "debug-socket-error=callback unsuccessful: #{e.inspect} for #{input.inspect} path=#{@path} backtrace=#{e.backtrace.inspect}"
   end
 end

metadata

@@ -1,16 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: debug_socket
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Andrew Lazarus
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-17 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
-description:
 email:
 - lazarus@squareup.com
 executables:
@@ -18,10 +16,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGES.md
 - Gemfile
 - LICENSE.txt
@@ -35,8 +33,8 @@ files:
 - lib/debug_socket/version.rb
 homepage: https://github.com/square/debug_socket
 licenses: []
-metadata: {}
-post_install_message:
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -44,15 +42,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Debug Socket for running ruby processes
 test_files: []

data/.travis.yml

@@ -1,11 +0,0 @@
-language: ruby
-rvm:
-  - 2.3.4
-  - 2.4.1
-  - jruby-9.1.13.0
-  - ruby-head
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-  fast_finish: true
-sudo: false