ladybug 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4240a28699151639735baf1b2a68005222ceea4d
-  data.tar.gz: 1f06bc9dd9b9160624c3fde749432f3f5353516b
+  metadata.gz: b73479c1e9523e9a0f5798daed1707ed24baf74c
+  data.tar.gz: d046e7c87d246a2e3a156ad1bf71c23fc256789c
 SHA512:
-  metadata.gz: 11bb0607a071ac3cad9d837eaa8c325d37ca2c5d8b00bae16f59a06f6b8c0fcad725d375368cabb47e19f4de72276180cdd830a96e93e9776943898f9b831355
-  data.tar.gz: b8d1f5faeaaf0745bcda7416617f3e3720a3aec5c31ca072e781165321fa3880a8cb05f0e553e55d6835a17937bb0c37e1f136ff95e1492bb96656134f251f57
+  metadata.gz: c79d7443d7cebedbb3174fe5a340aa21d2c23d201df2fab87aa6294326c839b3371e187f46eb7d351f4c7c8ad8bf103197882ded9dfb588284f1ae3422eca4ed
+  data.tar.gz: 58f696d4d5dc454c68215c0a3780f9ea2c45d070db1e168f915f2be26bf7ec5e567a02c110439291962f8db88f4e481a4d70978e669f0d7f01c0129c8f8893b4

data/README.md

@@ -6,7 +6,7 @@ Chrome Devtools as a user interface.
 It aims to provide a rich backend debugging experience in a UI that many
 web developers are already familiar with for debugging frontend Javascript.
 
-**This project is currently in a very early experimental phase.** Expect many limitations and bugs, and use at your own risk. If you try it out, please file
+**This project is currently in an early experimental phase.** Expect many limitations and bugs. If you try it out, please file
 Github issues or [email me](mailto:gklitt@gmail.com) to help make this a
 more useful tool.
 
@@ -14,9 +14,9 @@ more useful tool.
 
 ## Get started
 
-1) Install the gem:
+1) Install the gem, or add it to your Gemfile:
 
-`gem install --pre ladybug`
+`gem install ladybug`
 
 2) ladybug is implemented as a Rack middleware, so you'll need to add
 `Ladybug::Middleware` to the Rack middleware stack.
@@ -24,7 +24,7 @@ For example, in Rails 5, add
 the following line to `config/application.rb`:
 
 ```
-config.middleware.insert_before(Rack::Sendfile, Ladybug::Middleware)
+config.middleware.use(Ladybug::Middleware)
 ```
 
 3) Make sure you're using the puma web server, which is currently the
@@ -41,7 +41,11 @@ You should see your server program output something like:
 In the Sources tab, you can view your Ruby source code.
 If you set a breakpoint and then make another request to your server,
 it should pause on the breakpoint and you'll be able to inspect
-some variables in Devtools.
+local and instance variables in Devtools.
+
+6) You can then use the "step over" button to step through your code,
+   or "continue" to continue code execution. "Step into" and "Step out"
+   also work in some contexts.
 
 **Security warning:** This debugger should only be run in local development.
 Running it on a server open to the internet could allow anyone to
@@ -49,11 +53,10 @@ execute code on your server without authenticating.
 
 ## Development status
 
-* basic pause/continue breakpoint control is supported, but "step over" and "step into" aren't fully supported yet.
-* inspecting primtive objects like strings and numbers works okay; support for more complex objects is in development.
 * So far, ladybug has only been tested with simple Rails applications running on
 Rails 5 with the puma web server. Eventually it aims to support more Rack
 applications and web servers (and perhaps even non-Rack applications).
+* inspecting primtive objects like strings and numbers works okay; support for more complex objects is in development.
 
 ## Author
 

data/lib/ladybug/debugger.rb

@@ -25,6 +25,8 @@ module Ladybug
 
       @parsed_files = {}
 
+      @break = nil
+
       # Todo: consider thread safety of mutating this hash
       Thread.new do
         preload_paths.each do |preload_path|
@@ -41,6 +43,20 @@ module Ladybug
       set_trace_func trace_func
     end
 
+    def debug
+      RubyVM::InstructionSequence.compile_option = {
+        trace_instruction: true
+      }
+      Thread.current.set_trace_func trace_func
+
+      yield
+    ensure
+      RubyVM::InstructionSequence.compile_option = {
+        trace_instruction: false
+      }
+      Thread.current.set_trace_func nil
+    end
+
     def on_pause(&block)
       @on_pause = block
     end
@@ -131,12 +147,12 @@ module Ladybug
     # remove ladybug code from a callstack and prepare it for comparison
     # this is a hack implemenetation for now, can be made better
     def clean(callstack)
-      callstack.drop_while { |frame| frame.to_s.include? "ladybug" }
+      callstack.drop_while { |frame| frame.to_s.include? "ladybug/debugger.rb" }
     end
 
     # If we're in step over/in/out mode,
     # detect if we should break even if there's not a breakpoint set here
-    def break_on_step?
+    def break_on_step?(filename:)
       # This is an important early return;
       # we don't want to do anything w/ the callstack unless
       # we're looking for a breakpoint, because
@@ -144,22 +160,21 @@ module Ladybug
       # which makes things really slow
       return false if @break.nil?
 
+      return false if @break == 'step_over' &&
+                      @breakpoint_filename != filename
+
       bp_callstack = clean(@breakpoint_callstack)
       current_callstack = clean(Thread.current.backtrace_locations)
 
       if @break == 'step_over'
-        return bp_callstack[1].to_s == current_callstack[1].to_s
+        return current_callstack[1].to_s == bp_callstack[1].to_s
       elsif @break == 'step_into'
-        return stacks_equal?(bp_callstack, current_callstack[1..-1])
+        return current_callstack[1].to_s == bp_callstack[0].to_s
       elsif @break == 'step_out'
-        return stacks_equal?(current_callstack, bp_callstack[1..-1])
+        return current_callstack[0].to_s == bp_callstack[1].to_s
       end
     end
 
-    def stacks_equal?(stack1, stack2)
-      stack1.map(&:to_s) == stack2.map(&:to_s)
-    end
-
     def trace_func
       proc { |event, filename, line_number, id, binding, klass, *rest|
         # This check is called a lot so perhaps worth making faster,
@@ -168,12 +183,15 @@ module Ladybug
           bp[:filename] == filename && bp[:line_number] == line_number
         end
 
-        if breakpoint_hit || break_on_step?
+        if breakpoint_hit || break_on_step?(filename: filename)
           local_variables =
             binding.local_variables.each_with_object({}) do |lvar, hash|
               hash[lvar] = binding.local_variable_get(lvar)
             end
 
+          # todo: may want to offer classes the ability to
+          # override this and define which instance variables to expose here?
+
           instance_variables =
             binding.eval("instance_variables").each_with_object({}) do |ivar, hash|
               hash[ivar] = binding.eval("instance_variable_get(:#{ivar})")
@@ -215,10 +233,12 @@ module Ladybug
             case message[:command]
             when 'continue'
               @break = nil
+              @breakpoint_filename = nil
               break
             when 'step_over'
               @break = 'step_over'
               @breakpoint_callstack = Thread.current.backtrace_locations
+              @breakpoint_filename = filename
               break
             when 'step_into'
               @break = 'step_into'

data/lib/ladybug/middleware.rb

@@ -31,7 +31,9 @@ module Ladybug
         # Return async Rack response
         ws.rack_response
       else
-        @app.call(env)
+        @debugger.debug do
+          @app.call(env)
+        end
       end
     end
 
@@ -224,42 +226,50 @@ module Ladybug
 
         script = @script_repository.find(absolute_path: info[:filename])
 
-        location = {
-          scriptId: script.id,
-          lineNumber: info[:line_number] - 1,
-          columnNumber: 0
-        }
+        # currently we don't support going into functions
+        # that aren't in the path of our current app.
+        if script.nil?
+          puts "Debugger was paused on file outside of app: #{info[:filename]}"
+          puts "ladybug currently only supports pausing in app files."
+          @debugger.resume
+        else
+          location = {
+            scriptId: script.id,
+            lineNumber: info[:line_number] - 1,
+            columnNumber: 0
+          }
 
-        msg_to_client = {
-          method: "Debugger.paused",
-          params: {
-            callFrames: [
-              {
-                location: location,
-                callFrameId: SecureRandom.uuid,
-                functionName: info[:label],
-                scopeChain: [
-                  {
-                    type: "local",
-                    startLocation: location,
-                    endLocation: location,
-                    object: {
-                      className: "Object",
-                      description: "Object",
-                      type: "object",
-                      objectId: object_id
+          msg_to_client = {
+            method: "Debugger.paused",
+            params: {
+              callFrames: [
+                {
+                  location: location,
+                  callFrameId: SecureRandom.uuid,
+                  functionName: info[:label],
+                  scopeChain: [
+                    {
+                      type: "local",
+                      startLocation: location,
+                      endLocation: location,
+                      object: {
+                        className: "Object",
+                        description: "Object",
+                        type: "object",
+                        objectId: object_id
+                      }
                     }
-                  }
-                ],
-                url: script.virtual_url
-              }
-            ],
-            hitBreakpoints: info[:breakpoint_id] ? [info[:breakpoint_id]] : [],
-            reason: "other"
+                  ],
+                  url: script.virtual_url
+                }
+              ],
+              hitBreakpoints: info[:breakpoint_id] ? [info[:breakpoint_id]] : [],
+              reason: "other"
+            }
           }
-        }
 
-        ws.send(msg_to_client.to_json)
+          ws.send(msg_to_client.to_json)
+        end
       end
 
       @debugger.on_resume do
@@ -271,8 +281,6 @@ module Ladybug
         ws.send(msg_to_client.to_json)
       end
 
-      @debugger.start
-
       ws
     end
   end

data/lib/ladybug/object_manager.rb

@@ -99,12 +99,10 @@ module Ladybug
       elsif object.is_a? Hash
         object.
           map do |key, value|
-            kv = {
+            {
               name: key,
               value: serialize(value)
             }
-
-            kv
           end.
           reject { |property| property[:value].nil? }
       elsif object.is_a? Array

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ladybug
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Geoffrey Litt