maglev-webtools 0.2.1

data/LICENSE.txt

@@ -0,0 +1,25 @@
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011 VMware, Inc
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.rdoc

@@ -0,0 +1,121 @@
+= WebTools Example
+
+The WebTools Sinatra application running in MagLev allows you to explore a
+MagLev Ruby application's Classes, Modules, Methods, Constants, and Ancestors
+in a web browser.
+
+It will also allow you to explore GemStone/S Smalltalk code, and to examine
+detailed statistics about all processes connected to GemStone/S.
+
+=== Setup
+
+1. Download and install MagLev using instructions at
+   https://github.com/MagLev/maglev/blob/master/README.rdoc
+
+2. Start the MagLev server
+    $ cd $MAGLEV_HOME
+    $ maglev start
+
+3. Install necessary gems:
+    $ cd <to this directory>
+    $ $MAGLEV_HOME/bin/bundle install
+
+    ### Temporary workaround for https://magtrac.gemstone.com/ticket/879 ###
+    $ maglev-gem pristine rack
+
+== Viewing Ruby code
+
+Run the WebTools Sinatra application
+
+    $ rake
+
+This will start WEBrick in your current window. Hit Ctl-C to stop.
+
+Browse to http://localhost:9292/, click on a class or module, then
+click on a constant or method. Results appear in the bottom pane, file
+locations with line numbers in the bottom status line, and time spent
+on the server/network/client in the top status line.
+
+=== Add classes and modules from ActiveModel
+
+<b>WARNING: If you already have an application loaded into MagLev, do not
+run <code>rake meta</code> since it persists RubyGems and ActiveModel.
+Use WebTools to explore <i>your application</i> instead. If you run
+<code>rake meta</code>, run <code>maglev force-reload</code> afterwards
+to load an empty database.</b>
+
+    $ rake meta
+
+Click on "Refresh View" in WebTools. Note that AValidPerson now appears in the
+class list, as do a number of classes/modules from ActiveModel and ActiveSupport.
+
+Click on the class AValidPerson and compare it with the source
+(meta_demo.rb). Some things to note:
+
+1. You can see all the methods generated by metaprogramming.
+2. You can see the file and line number of the code that generated each
+   method. This makes it simpler to track down which part of ActiveWhatever
+   is messing with your code.
+3. The <code>initialize</code> method is unchanged from the code
+   in <code>meta_demo.rb</code>
+4. The instance method <code>_callback_before_1</code> generated from
+   <code>$MAGLEV_HOME/lib/maglev/gems/1.8/gems/activesupport-3.0.5/lib/active_support/callbacks.rb</code>
+   shows the actual method name <code>_callback_before_1</code> instead of <code>#{method_name}</code>.
+
+=== Modify meta_demo.rb and view new generated methods
+
+Edit the file meta_demo.rb. Add :age to both validates_presence_of and attr_accessor.
+The changed lines should look like
+
+    validates_presence_of :first_name, :last_name, :age
+    attr_accessor :first_name, :last_name, :age
+
+Then
+
+    $ rake meta
+
+Click on "Refresh View" in WebTools. AValidPerson will now include the
+new instance methods age and age=.
+
+=== Add some data
+
+    $ rake demodata
+
+Click on "Refresh View" in WebTools. Note that AAADemo now appears in the
+class list. Click on the class AAADemo and compare it with the source
+(demo_data.rb).
+
+== Viewing GemStone/S code, processes and statistics
+
+The code for this example was inspired by the Smalltalk example found in
+$MAGLEV_HOME/gemstone/examples/www. The Smalltalk example code can be
+invoked from ruby (a demonstration of how to invoke Smalltalk from Ruby),
+via:
+
+    $ rake smalltalk:run
+
+Then browse to http://localhost:8080/ and explore
+
+Hit Ctl-C in the terminal window to stop.
+
+== Known problems
+
+Network timeouts are not caught. EAGAIN is not handled. If you're running WebTools on
+a slow network, this may cause data to not appear in the bottom pane.
+
+The line number displayed for evals is always 2. This will be fixed at a later date.
+
+== Contributing
+
+* Fork the project from https://github.com/MagLev/webtools
+* Start a feature or topic branch
+* Commit and push until you are happy with your contribution
+* Add some tests to ensure we don't break things in a future release
+* Make sure to test with the latest MagLev
+* Send a pull request
+
+MagLev Ruby code in this project is MIT licensed. See LICENSE.txt in this directory.
+<b>By sending a pull request, you agree your contributed code is also MIT licensed.</b>
+
+This project includes a copy of CodeMirror, copyrighted by Marijn Haverbeke.
+See public/CodeMirror/LICENSE.

data/bin/webtools

@@ -0,0 +1,15 @@
+#!/usr/bin/env maglev-ruby
+$LOAD_PATH.unshift(File.expand_path("../../lib", __FILE__))
+require 'rack'
+require 'web_tools'
+
+app = Rack::Builder.new do
+  WebTools::UI.set :root, File.expand_path("../..", __FILE__)
+  ui = WebTools::UI.new
+  redirect = proc { |env| [301,
+                    {'Content-Type' => 'text/html', 'Location' => '/webtools/'},
+                    '<a href="/webtools">Moved permanently</a>'] }
+  map('/webtools/') { run ui }
+  map('/') { run redirect }
+end
+Rack::Handler.default.run(app, :Port => 9292)

data/lib/web_tools/#debugger.rb#

@@ -0,0 +1,212 @@
+require 'sinatra'
+require 'web_tools'
+require 'web_tools/support/service_helper'
+require 'rack/contrib/jsonp'
+require 'maglev/debugger'
+require 'maglev/method_source'
+
+module WebTools
+  class Debugger < Sinatra::Base
+    include WebTools::Support::ServiceHelper
+    use Rack::JSONP
+
+    def respond_json(obj)
+      content_type :json
+      result = case obj
+               when Maglev::Debugger::Wrapper
+                 obj.to_hash
+               else
+                 if obj.is_a? Array and
+                     obj.all? {|e| e.is_a? Maglev::Debugger::Wrapper}
+                   obj.collect(&:to_hash)
+                 else
+                   case obj
+                   when Array, Hash
+                     obj
+                   else
+                     details_for(obj)
+                   end
+                 end
+               end
+      body(result.to_json)
+    end
+
+    def process
+      Maglev::Debugger::Process.new(ObjectSpace._id2ref(params[:oop].to_i))
+    end
+
+    def frames
+      params.has_key?("all") ? process.frames : process.ruby_frames
+    end
+
+    def frame
+      f = frames[params[:idx].to_i]
+      f.debug_info!
+      f
+    end
+
+    def objects
+      instance_variables_for(object)
+    end
+
+    def object
+      ctxt = frame.debug_info[:context]
+      obj = nil
+      variable_list = params[:splat].first.split("/objects/")
+      variable_list.each do |name|
+        name = name[0...(-"/objects".size)] if name.end_with? "/objects"
+        obj = ctxt[name.to_sym]
+        ctxt = instance_variables_for(obj)
+      end
+      obj
+    end
+
+    def instance_variables_for(object)
+      object.instance_variables.inject({}) do |hash, var|
+        hash[var.to_sym] = object.instance_variable_get(var)
+        hash
+      end
+    end
+    
+    def details_for(object)
+      { "instance_variables" => instance_variables_for(object),
+        "self" => object,
+        "inspect" => object.inspect,
+        "class" => object.class,
+        "do-it" => nil,
+        "do-it-result" => nil }
+    end
+
+    before do
+      Maglev.abort_transaction
+    end
+
+    # => list of errors
+    get "/process" do
+      errors = ObjectLog.errors.collect {|e| Maglev::Debugger::Process.new(e) }
+      processes = Thread.list.select(&:stop?).collect do |e|
+        Maglev::Debugger::Process.new(e)
+      end
+      respond_json (errors + processes)
+    end
+
+    get "/process/:oop" do
+      respond_json process
+    end
+
+    get "/process/:oop/frames" do
+      respond_json frames
+    end
+
+    get "/process/:oop/frames/:idx" do
+      respond_json frame
+    end
+
+    get "/process/:oop/frames/:idx/objects" do
+      respond_json frame.debug_info[:context]
+    end
+
+    get "/process/:oop/frames/:idx/objects/*" do
+      if params[:splat].first.end_with? "objects"
+        respond_json objects
+      else
+        respond_json details_for(object)
+      end
+    end
+
+    delete "/process/:oop" do
+      respond_json process.delete
+    end
+
+    delete "/process/:oop/frames/:idx" do
+      respond_json frame.delete
+    end
+
+    post "/process/:oop" do
+      p = process
+      return 404 if p.is_a? Maglev::Debugger::ObjectLogError
+      if params["running"] == "true" and p.thread.alive? and p.thread.stop?
+        p.thread.wakeup
+        p.thread.join
+        if (result = p.thread[:result]).is_a? Maglev::Debugger::Process
+          p.thread.kill
+          raise result.exception
+        else
+          result
+        end
+      else
+        404
+      end
+    end
+
+    put "/process/:oop/frames/:idx" do
+      current_frame = frame.to_hash
+      # TODO: Really check the posted document
+      if doIt = params["do-it"]
+        begin
+          result = frame.context_eval(doIt)
+        rescue Exception => e
+          result = e
+        end
+        current_frame[:"do-it"] = doIt
+        current_frame[:"do-it-result"] = details_for(result)
+        respond_json current_frame
+      elsif params["index"] == "1" and params[:idx] == "0"
+        until frame.method_name != current_frame[:method_name]
+          frame.step(:into) # Step into until we find the next ruby frame
+        end
+        respond_json frame
+      elsif di = params["debug_info"]
+        if di["stepOffset"] && di["stepOffset"] != current_frame[:debug_info][:stepOffset]
+          return 404 unless params[:idx] == 0
+          while di["stepOffset"].to_i > frame[:debug_info][:stepOffset].to_i
+            frame.step(:over)
+          end
+          respond_json frame
+        elsif di["source"] && di["source"] != current_frame[:debug_info][:source]
+          klass = current_frame[:defining_class]
+          frame_above = frames[params[:idx].to_i + 1]
+          # Pop to one frame before the modified one
+          frame_above.delete
+          # Recompile the method
+          klass.set_method_source(current_frame[:method_name], di["source"])
+          # Step into the modified method
+          process.frames.first.step(:into)
+          params[:idx] = 0
+          respond_json frame # Retreive the frame again, to show the updated source
+        end
+      else
+        status 404
+        respond_json frame
+      end
+    end
+
+    put "/process/:oop/frames/:idx/objects/*" do
+      return 404 if params[:splat].first.end_with? "objects"
+
+      if doIt = params["do-it"]
+        begin
+          result = object.instance_eval(doIt)
+        rescue Exception => e
+          result = e
+        end
+        return_value = details_for(object)
+        return_value["do-it"] = doIt
+        return_value["do-it-result"] = details_for(result)
+        respond_json return_value
+      else
+        404
+      end
+    end
+
+    # XXX: Remove me, please
+    options '*' do
+      [200,
+       { 'Access-Control-Allow-Origin' => '*',
+         'Access-Control-Allow-Methods' => 'PUT, POST, GET, DELETE, OPTIONS',
+         'Access-Control-Max-Age' => '1000',
+         'Access-Control-Allow-Headers' => '*' },
+       [""]]
+    end
+  end
+end

data/lib/web_tools/browser.rb

@@ -0,0 +1,45 @@
+require 'sinatra/base'
+require 'web_tools'
+require 'web_tools/support/code_browser'
+require 'web_tools/support/service_helper'
+
+class WebTools::Browser < Sinatra::Base
+  include WebTools::Support::ServiceHelper
+
+  before do
+    @ts = Time.now
+    @stack = nil
+    @browser = WebTools::CodeBrowser.new
+    content_type :json
+  end
+
+  get '/modulelist' do
+    prepare_data(WebTools::CodeBrowser.class_and_module_list)
+  end
+
+  get '/module/:name' do
+    prepare_data(@browser.select_module(params[:name]))
+  end
+
+  get '/module/:module_name/constant/:const_name' do
+    prepare_data(@browser.select_constant(params[:module_name],
+                                          params[:const_name]))
+  end
+
+  get '/module/:module_name/method' do
+    flag = params[:is_instance_method] == 'true' ? true : false
+    prepare_data(@browser.select_method(params[:module_name],
+                                        params[:method_name],
+                                        flag))
+  end
+
+  get '/objectspace/:object_id' do
+    prepare_data(@browser.object_info(params[:object_id]))
+  end
+
+  get '/transaction/abort' do
+    Maglev.abort_transaction
+    prepare_data(WebTools::CodeBrowser.class_and_module_list)
+  end
+end
+

data/lib/web_tools/debugger.rb

@@ -0,0 +1,219 @@
+require 'sinatra'
+require 'web_tools'
+require 'web_tools/support/service_helper'
+require 'rack/contrib/jsonp'
+require 'maglev/debugger'
+require 'maglev/method_source'
+
+module WebTools
+  class Debugger < Sinatra::Base
+    include WebTools::Support::ServiceHelper
+    use Rack::JSONP
+
+    def respond_json(obj)
+      content_type :json
+      result = case obj
+               when Maglev::Debugger::Wrapper
+                 obj.to_hash
+               else
+                 if obj.is_a? Array and
+                     obj.all? {|e| e.is_a? Maglev::Debugger::Wrapper}
+                   obj.collect(&:to_hash)
+                 else
+                   case obj
+                   when Array, Hash
+                     obj
+                   else
+                     details_for(obj)
+                   end
+                 end
+               end
+      body(result.to_json)
+    end
+
+    def process
+      Maglev::Debugger::Process.new(ObjectSpace._id2ref(params[:oop].to_i))
+    end
+
+    def frames
+      params.has_key?("all") ? process.frames : process.ruby_frames
+    end
+
+    def frame
+      f = frames[params[:idx].to_i]
+      f.debug_info!
+      f
+    end
+
+    def objects
+      instance_variables_for(object)
+    end
+
+    def object
+      ctxt = frame.debug_info[:context]
+      obj = nil
+      variable_list = params[:splat].first.split("/objects/")
+      variable_list.each do |name|
+        name = name[0...(-"/objects".size)] if name.end_with? "/objects"
+        obj = ctxt[name.to_sym]
+        ctxt = instance_variables_for(obj)
+      end
+      obj
+    end
+
+    def instance_variables_for(object)
+      object.instance_variables.inject({}) do |hash, var|
+        hash[var.to_sym] = object.instance_variable_get(var)
+        hash
+      end
+    end
+
+    def details_for(object)
+      { "instance_variables" => instance_variables_for(object),
+        "self" => object,
+        "inspect" => object.inspect,
+        "class" => object.class,
+        "do-it" => nil,
+        "do-it-result" => nil }
+    end
+
+    before do
+      Maglev.abort_transaction
+    end
+
+    # => list of errors
+    get "/process" do
+      errors = ObjectLog.errors.collect {|e| Maglev::Debugger::Process.new(e) }
+      processes = Thread.list.select(&:stop?).collect do |e|
+        Maglev::Debugger::Process.new(e)
+      end
+      respond_json (errors + processes)
+    end
+
+    get "/process/:oop" do
+      respond_json process
+    end
+
+    get "/process/:oop/frames" do
+      respond_json frames
+    end
+
+    get "/process/:oop/frames/:idx" do
+      respond_json frame
+    end
+
+    get "/process/:oop/frames/:idx/objects" do
+      respond_json frame.debug_info[:context]
+    end
+
+    get "/process/:oop/frames/:idx/objects/*" do
+      if params[:splat].first.end_with? "objects"
+        respond_json objects
+      else
+        respond_json details_for(object)
+      end
+    end
+
+    delete "/process/:oop" do
+      respond_json process.delete
+    end
+
+    delete "/process/:oop/frames/:idx" do
+      respond_json frame.delete
+    end
+
+    post "/process/:oop" do
+      p = process
+      return 404 if p.is_a? Maglev::Debugger::ObjectLogError
+      if params["running"] == "true" and p.thread.alive? and p.thread.stop?
+        p.thread.run
+        Thread.pass
+        Thread.pass
+        p.thread.join
+        if (result = p.thread[:result]).is_a? Maglev::Debugger::Process
+          if params["debugging"] == "true"
+            status 500
+            body result.exception.inspect
+          else
+            p.thread.kill
+            Thread.pass
+            raise result.exception
+          end
+        else
+          result
+        end
+      else
+        404
+      end
+    end
+
+    put "/process/:oop/frames/:idx" do
+      # TODO: Really check the posted document
+      if doIt = params["do-it"]
+        begin
+          result = frame.context_eval(doIt)
+        rescue Exception => e
+          result = e
+        end
+        current_frame = frame.to_hash
+        current_frame[:"do-it"] = doIt
+        current_frame[:"do-it-result"] = details_for(result)
+        respond_json current_frame
+      elsif params["index"] == "1" and params[:idx] == "0"
+        current_frame = frame.to_hash
+        until frame.method_name != current_frame[:method_name]
+          frame.step(:into) # Step into until we find the next ruby frame
+        end
+        respond_json frame
+      elsif di = params["debug_info"]
+        current_frame = frame.to_hash
+        if di["stepOffset"] && di["stepOffset"] != current_frame[:debug_info][:stepOffset]
+          return 404 unless params[:idx] == "0"
+          while di["stepOffset"].to_i > frame[:debug_info][:stepOffset].to_i
+            frame.step(:over)
+          end
+          respond_json frame
+        elsif di["source"] && di["source"] != current_frame[:debug_info][:source]
+          current_frame = frame
+          return 404 if frame.block_nesting > 0 # cannot change nested frames
+          klass = current_frame.defining_class
+          klass.set_method_source(current_frame.method_name, di["source"])
+          current_frame.delete
+          params[:idx] = "0"
+          respond_json frame # Retreive the frame again, to show the updated source
+        end
+      else
+        status 404
+        respond_json frame
+      end
+    end
+
+    put "/process/:oop/frames/:idx/objects/*" do
+      return 404 if params[:splat].first.end_with? "objects"
+
+      if doIt = params["do-it"]
+        begin
+          result = object.instance_eval(doIt)
+        rescue Exception => e
+          result = e
+        end
+        return_value = details_for(object)
+        return_value["do-it"] = doIt
+        return_value["do-it-result"] = details_for(result)
+        respond_json return_value
+      else
+        404
+      end
+    end
+
+    # XXX: Remove me, please
+    options '*' do
+      [200,
+       { 'Access-Control-Allow-Origin' => '*',
+         'Access-Control-Allow-Methods' => 'PUT, POST, GET, DELETE, OPTIONS',
+         'Access-Control-Max-Age' => '1000',
+         'Access-Control-Allow-Headers' => '*' },
+       [""]]
+    end
+  end
+end

data/lib/web_tools/info.rb

@@ -0,0 +1,29 @@
+require 'sinatra/base'
+require 'web_tools'
+require 'web_tools/support/app_model'
+require 'web_tools/support/service_helper'
+
+class WebTools::Info < Sinatra::Base
+  include WebTools::Support::ServiceHelper
+
+  before do
+    @ts = Time.now
+    @stack = nil
+    @model = WebTools::AppModel.new
+  end
+
+  get '/version' do
+    content_type :json
+    prepare_data @model.version_report
+  end
+
+  get '/sessions' do
+    content_type :json
+    prepare_data @model.session_report
+  end
+
+  get '/tools' do
+    content_type :json
+    prepare_data(@model.tools)
+  end
+end