debug_socket 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb25e218ef23ecf95a88462d1d5bdbbe43a17aa8
-  data.tar.gz: 0d946d025dfe5a19bc3abc2c6472df2f49c99ecc
+  metadata.gz: 14eca78815c548cdb4782e8cda4588b6d7b66951
+  data.tar.gz: 457c0294ab9f9be83b45bb57ecc99784878c9882
 SHA512:
-  metadata.gz: a733d2731cbc2c64c5787a22854bc56b3df8878dd1b03fb02ef0c55f5978cbf259546d7baaf582b9b7b73663d619f5b7eef3326189d92b58c11779ae8f2b782d
-  data.tar.gz: 58b09d9b73546d106f8e6f48c117af70bc1383adc4d064e691df0bfe6139c3981cb0edf4ea8f88d353212e9b14131012ae84b5db84516600f3a290e2bf6ee76d
+  metadata.gz: f35b1bef6088c4693197602a2d7951408f242fd6eb6ab1bc3f11c7dc520b0de51607002fa2a185112871529f89f916a41759a74174657eb88e02b411801a07d8
+  data.tar.gz: 971bd7cece3daf3110e01edac0c599f524993f1ac56ef9eb94215d853f39cfe336580ab97b644dea57afee3904dde1d33b39b041c1f0226e4609fd8e07ede0d9

data/.rspec

@@ -1,2 +1,5 @@
 --format documentation
 --color
+--require spec_helper
+--warnings
+--order rand

data/.rubocop.yml

@@ -13,6 +13,9 @@ Encoding:
 Metrics/AbcSize:
   Max: 50
 
+Metrics/BlockLength:
+  Enabled: false
+
 Metrics/CyclomaticComplexity:
   Max: 25
 

data/.travis.yml

@@ -1,10 +1,8 @@
-bundler_args: --without development
 language: ruby
 rvm:
-  - 2.1
-  - 2.2
-  - 2.3
-  - jruby-9.0
+  - 2.3.3
+  - 2.4.0
+  - jruby-9.1.7.0
   - ruby-head
 matrix:
   allow_failures:

data/CHANGES.md

@@ -0,0 +1,6 @@
+### 0.1.3 2017-02-23
+- Handle syntax errors (and other errors that do not inherit from StandardError) in eval.
+- Cleanup logging and change log message format
+
+### 0.1.2 2016-08-24
+- Initial Release

data/Gemfile

@@ -2,3 +2,8 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in debug_socket.gemspec
 gemspec
+
+gem "pry"
+gem "rake"
+gem "rspec", "~> 3.5"
+gem "rubocop", "0.47.1"

data/README.md

@@ -2,6 +2,7 @@
 
 A unix domain socket that listens for debug commands.
 
+[![Build Status](https://travis-ci.org/square/debug_socket.svg?branch=master)](https://travis-ci.org/square/debug_socket)
 
 ## Warning
 
@@ -35,12 +36,17 @@ in `config/initializers/sidekiq.rb`
 ```ruby
 Sidekiq.configure_server do |_config|
   DebugSocket.logger = Sidekiq::Logging.logger
+  # GOTCHA: if the Rails.root.join("tmp", "sidekiq-debug-#{Process.pid}.sock")
+  # path is too long, this will fail. The max on Linux is 108 characters, MacOS
+  # is 104. If the path is too long, try using a relative path or /tmp/<blah>.
   DebugSocket.start(Rails.root.join("tmp", "sidekiq-debug-#{Process.pid}.sock"))
   at_exit { DebugSocket.stop }
 end
 ```
 
-Then in a terminal:
+You can now send ruby instruction commands through the socket and they'll be
+executed in your running process.  You can use `socat` to write and read
+from the socket and dump to `stdout` like so:
 
 ```
 % echo backtrace | socat - UNIX-CONNECT:~/tmp/puma-debug-1234.sock
@@ -57,6 +63,25 @@ spec/debug_socket_spec.rb:48:in `sleep'
 spec/debug_socket_spec.rb:48:in `block (4 levels) in <top (required)>'
 ```
 
+The gem also provides a helper script that wraps the above command.  The
+`debug-socket` script takes one argument, the path to the unix socket, and it
+will run the `backtrace` command through that socket.
+
+```
+% debug-socket ~/tmp/puma-debug-1234.sock
+2016-08-09T00:51:57Z puma: cluster worker 0: 1234
+2016-08-09T00:51:57Z pid=1234 thread.object_id=70099243629020 thread.status=run
+lib/debug_socket.rb:55:in `backtrace'
+lib/debug_socket.rb:55:in `block in backtrace'
+lib/debug_socket.rb:54:in `map'
+lib/debug_socket.rb:54:in `backtrace'
+spec/debug_socket_spec.rb:48:in `block (3 levels) in <top (required)>'
+
+2016-08-09T00:51:57Z pid=1234 thread.object_id=70121809360520 thread.status=sleep
+spec/debug_socket_spec.rb:48:in `sleep'
+spec/debug_socket_spec.rb:48:in `block (4 levels) in <top (required)>'
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/square/debug_socket.

data/debug_socket.gemspec

@@ -16,10 +16,4 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rubocop", "0.40.0"
 end

data/exe/debug-socket

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+if ARGV[0].nil? || ARGV[0].empty?
+  puts "\nUsage: debug-socket <socket-path>"
+  puts "Default command is backtrace\n"
+  exit 1
+end
+
+puts ""
+puts "Sending `backtrace` to the following socket: #{ARGV[0]}"
+puts "----------------------------------------------------------"
+puts ""
+Kernel.exec("echo backtrace | socat - UNIX-CONNECT:#{ARGV[0]}")

data/lib/debug_socket.rb

@@ -1,7 +1,10 @@
 require "debug_socket/version"
 require "socket"
+require "time"
 
 module DebugSocket
+  @thread = nil
+
   def self.logger=(logger)
     @logger = logger
   end
@@ -16,7 +19,7 @@ module DebugSocket
     raise "debug socket thread already running" if @thread
 
     # make sure socket is only accessible to the process owner
-    old_mask = File.umask(0177)
+    old_mask = File.umask(0o0177)
 
     @path = path.to_s
 
@@ -26,12 +29,11 @@ module DebugSocket
         begin
           socket = server.accept
           input = socket.read
-          logger.warn("[DEBUG SOCKET] #{input.inspect}") if logger
-          socket.puts(eval(input)) # rubocop:disable Lint/Eval
-        rescue => e
+          logger.warn("debug-socket-command=#{input.inspect}") if logger
+          socket.puts(eval(input)) # rubocop:disable Security/Eval
+        rescue Exception => e # rubocop:disable Lint/RescueException
           next unless logger
-          logger.error("[DEBUG SOCKET] error=#{e.inspect}")
-          logger.error(e.backtrace)
+          logger.error("debug-socket-error=#{e.inspect} backtrace=#{e.backtrace.inspect}")
         ensure
           socket.close
         end

data/lib/debug_socket/version.rb

@@ -1,3 +1,3 @@
 module DebugSocket
-  VERSION = "0.1.2".freeze
+  VERSION = "0.1.3".freeze
 end

metadata

@@ -1,89 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: debug_socket
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Andrew Lazarus
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-24 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.11'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.40.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.40.0
+date: 2017-02-23 00:00:00.000000000 Z
+dependencies: []
 description: 
 email:
 - lazarus@squareup.com
-executables: []
+executables:
+- debug-socket
 extensions: []
 extra_rdoc_files: []
 files:
@@ -91,6 +22,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGES.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -98,6 +30,7 @@ files:
 - bin/console
 - bin/setup
 - debug_socket.gemspec
+- exe/debug-socket
 - lib/debug_socket.rb
 - lib/debug_socket/version.rb
 homepage: https://github.com/square/debug_socket
@@ -119,7 +52,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Debug Socket for running ruby processes