web-console 2.0.0.beta2 → 2.0.0.beta3

data/app/assets/stylesheets/web_console/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/assets/stylesheets/web_console/console_sessions.css.erb

@@ -0,0 +1,6 @@
+<% WebConsole.config.style.instance_eval do %>
+  body { color: <%= colors.foreground %>; background: <%= colors.background %>; margin: 0; padding: 0; }
+
+  .terminal { float: left; overflow: hidden; font: <%= font %>; }
+  .terminal-cursor { color: <%= colors.background %>; background: <%= colors.foreground %>; }
+<% end %>

data/app/controllers/web_console/application_controller.rb

@@ -0,0 +1,13 @@
+module WebConsole
+  class ApplicationController < ActionController::Base
+    before_action :prevent_unauthorized_requests!
+
+    private
+
+      def prevent_unauthorized_requests!
+        unless request.remote_ip.in?(WebConsole.config.whitelisted_ips)
+          render nothing: true, status: :unauthorized
+        end
+      end
+  end
+end

data/app/controllers/web_console/console_sessions_controller.rb

@@ -0,0 +1,43 @@
+require_dependency 'web_console/application_controller'
+
+module WebConsole
+  class ConsoleSessionsController < ApplicationController
+    rescue_from ConsoleSession::Unavailable do |exception|
+      render json: exception, status: :gone
+    end
+
+    rescue_from ConsoleSession::Invalid do |exception|
+      render json: exception, status: :unprocessable_entity
+    end
+
+    def index
+      @console_session = ConsoleSession.create
+    end
+
+    def input
+      @console_session = ConsoleSession.find(params[:id])
+      @console_session.send_input(console_session_params[:input])
+
+      render nothing: true
+    end
+
+    def configuration
+      @console_session = ConsoleSession.find(params[:id])
+      @console_session.configure(console_session_params)
+
+      render nothing: true
+    end
+
+    def pending_output
+      @console_session = ConsoleSession.find(params[:id])
+
+      render json: { output: @console_session.pending_output }
+    end
+
+    private
+
+      def console_session_params
+        params.permit(:id, :input, :width, :height)
+      end
+  end
+end

data/app/helpers/web_console/application_helper.rb

@@ -0,0 +1,4 @@
+module WebConsole
+  module ApplicationHelper
+  end
+end

data/app/helpers/web_console/console_session_helper.rb

@@ -0,0 +1,4 @@
+module WebConsole
+  module ConsoleSessionHelper
+  end
+end

data/app/models/web_console/console_session.rb

@@ -0,0 +1,96 @@
+module WebConsole
+  # Manage and persist (in memory) WebConsole::Slave instances.
+  class ConsoleSession
+    include ActiveModel::Model
+
+    # In-memory storage for the console sessions. Session preservation is
+    # troubled on servers with multiple workers and threads.
+    INMEMORY_STORAGE = {}
+
+    # Base error class for ConsoleSession specific exceptions.
+    #
+    # Provides #to_json implementation, so all subclasses are JSON
+    # serializable.
+    class Error < StandardError
+      def to_json(*)
+        { error: to_s }.to_json
+      end
+    end
+
+    # Raised when trying to find a session that is no longer in the in-memory
+    # session storage or when the slave process exited.
+    Unavailable = Class.new(Error)
+
+    # Raised when an operation transition to an invalid state.
+    Invalid = Class.new(Error)
+
+    class << self
+      # Finds a session by its pid.
+      #
+      # Raises WebConsole::ConsoleSession::Expired if there is no such session.
+      def find(pid)
+        INMEMORY_STORAGE[pid.to_i] or raise Unavailable, 'Session unavailable'
+      end
+
+      # Creates an already persisted consolse session.
+      #
+      # Use this method if you need to persist a session, without providing it
+      # any input.
+      def create
+        new.persist
+      end
+    end
+
+    def initialize
+      @slave = WebConsole::Slave.new
+    end
+
+    # Explicitly persist the model in the in-memory storage.
+    def persist
+      INMEMORY_STORAGE[pid] = self
+    end
+
+    # Returns true if the current session is persisted in the in-memory storage.
+    def persisted?
+      self == INMEMORY_STORAGE[pid]
+    end
+
+    # Returns an Enumerable of all key attributes if any is set, regardless if
+    # the object is persisted or not.
+    def to_key
+      [pid] if persisted?
+    end
+
+    private
+
+      def delegate_and_call_slave_method(name, *args, &block)
+        # Cache the delegated method, so we don't have to hit #method_missing
+        # on every call.
+        define_singleton_method(name) do |*inner_args, &inner_block|
+          begin
+            @slave.public_send(name, *inner_args, &inner_block)
+          rescue ArgumentError => exc
+            raise Invalid, exc
+          rescue Slave::Closed => exc
+            raise Unavailable, exc
+          end
+        end
+
+        # Now call the method, since that's our most common use case. Delegate
+        # the method and than call it.
+        public_send(name, *args, &block)
+      end
+
+      def method_missing(name, *args, &block)
+        if @slave.respond_to?(name)
+          delegate_and_call_slave_method(name, *args, &block)
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(name, include_all = false)
+        @slave.respond_to?(name) or super
+      end
+  end
+end

data/app/views/layouts/web_console/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>WebConsole</title>
+  <%= stylesheet_link_tag    "web_console/application", media: "all" %>
+  <%= javascript_include_tag "web_console/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/web_console/console_sessions/index.html.erb

@@ -0,0 +1,15 @@
+<script>
+  var config = {
+    terminal: {
+      colors: <%= raw WebConsole.config.style.colors.to_json %>
+    },
+
+    transport: {
+      url: {
+        input: "<%= web_console.input_console_session_path(@console_session) %>",
+        pendingOutput: "<%= web_console.pending_output_console_session_path(@console_session) %>",
+        configuration: "<%= web_console.configuration_console_session_path(@console_session) %>"
+      }
+    }
+  };
+</script>

data/config/routes.rb

@@ -0,0 +1,11 @@
+WebConsole::Engine.routes.draw do
+  root to: 'console_sessions#index'
+
+  resources :console_sessions do
+    member do
+      put :input
+      get :pending_output
+      put :configuration
+    end
+  end
+end

data/lib/action_dispatch/debug_exceptions.rb

@@ -30,86 +30,86 @@ module ActionDispatch
 
     private
 
-    def update_repl_session(id, input)
-      console_session = WebConsole::REPLSession.find(id)
-      response = console_session.save({ input: input })
-      [200, { "Content-Type" => "text/plain; charset=utf-8" }, [response.to_json]]
-    end
-
-    def change_stack_trace(id, frame_id)
-      console_session = WebConsole::REPLSession.find(id)
-      binding = console_session.binding_stack[frame_id.to_i]
-      console_session.binding = binding
-      [200, { "Content-Type" => "text/plain; charset=utf-8" }, [JSON.dump("success")]]
-    end
+      def update_repl_session(id, input)
+        console_session = WebConsole::REPLSession.find(id)
+        response = console_session.save(input: input)
+        [ 200, { "Content-Type" => "text/plain; charset=utf-8" }, [ response.to_json ] ]
+      end
 
-    def render_exception(env, exception)
-      if exception.respond_to?(:original_exception) && exception.original_exception
-        exception = exception.original_exception
+      def change_stack_trace(id, frame_id)
+        console_session = WebConsole::REPLSession.find(id)
+        binding = console_session.binding_stack[frame_id.to_i]
+        console_session.binding = binding
+        [ 200, { "Content-Type" => "text/plain; charset=utf-8" }, [ JSON.dump("success") ] ]
       end
 
-      wrapper = ExceptionWrapper.new(env, exception)
-      traces = traces_from_wrapper(wrapper)
-      extract_sources = wrapper.extract_sources
-      console_session = WebConsole::REPLSession.create(
-        binding: binding_from_exception(exception),
-        binding_stack: exception.__web_console_bindings_stack
-      )
-      log_error(env, wrapper)
-
-      if env['action_dispatch.show_detailed_exceptions']
-        request = Request.new(env)
-        template = ActionView::Base.new([RESCUES_TEMPLATE_PATH],
-          request: request,
-          exception: wrapper.exception,
-          application_trace: traces[:application_trace],
-          framework_trace: traces[:framework_trace],
-          full_trace: traces[:full_trace],
-          routes_inspector: routes_inspector(exception),
-          extract_sources: extract_sources,
-          console_session: console_session
-        )
-        file = "rescues/#{wrapper.rescue_template}"
+      def render_exception(env, exception)
+        if exception.respond_to?(:original_exception) && exception.original_exception
+          exception = exception.original_exception
+        end
 
-        if request.xhr?
-          body = template.render(template: file, layout: false, formats: [:text])
-          format = "text/plain"
+        wrapper = ExceptionWrapper.new(env, exception)
+        traces = traces_from_wrapper(wrapper)
+        extract_sources = wrapper.extract_sources
+        console_session = WebConsole::REPLSession.create(
+          binding: binding_from_exception(exception),
+          binding_stack: exception.__web_console_bindings_stack
+        )
+        log_error(env, wrapper)
+
+        if env['action_dispatch.show_detailed_exceptions']
+          request = Request.new(env)
+          template = ActionView::Base.new([ RESCUES_TEMPLATE_PATH ],
+            request: request,
+            exception: wrapper.exception,
+            application_trace: traces[:application_trace],
+            framework_trace: traces[:framework_trace],
+            full_trace: traces[:full_trace],
+            routes_inspector: routes_inspector(exception),
+            extract_sources: extract_sources,
+            console_session: console_session
+          )
+          file = "rescues/#{wrapper.rescue_template}"
+
+          if request.xhr?
+            body = template.render(template: file, layout: false, formats: [ :text ])
+            format = "text/plain"
+          else
+            body = template.render(template: file, layout: 'rescues/layout')
+            format = "text/html"
+          end
+
+          [ wrapper.status_code, { 'Content-Type' => "#{format}; charset=#{Response.default_charset}", 'Content-Length' => body.bytesize.to_s }, [ body ] ]
         else
-          body = template.render(template: file, layout: 'rescues/layout')
-          format = "text/html"
+          raise exception
         end
-
-        [wrapper.status_code, {'Content-Type' => "#{format}; charset=#{Response.default_charset}", 'Content-Length' => body.bytesize.to_s}, [body]]
-      else
-        raise exception
       end
-    end
 
-    # Augment the exception traces by providing ids for all unique stack frame
-    def traces_from_wrapper(wrapper)
-      id_counter = 0
+      # Augment the exception traces by providing ids for all unique stack frames.
+      def traces_from_wrapper(wrapper)
+        id_counter = 0
 
-      application_trace = wrapper.application_trace.map do |trace|
-        prev = id_counter
-        id_counter += 1
-        { id: prev, trace: trace }
-      end
+        application_trace = wrapper.application_trace.map do |trace|
+          prev = id_counter
+          id_counter += 1
+          { id: prev, trace: trace }
+        end
 
-      framework_trace = wrapper.framework_trace.map do |trace|
-        prev = id_counter
-        id_counter += 1
-        { id: prev, trace: trace }
-      end
+        framework_trace = wrapper.framework_trace.map do |trace|
+          prev = id_counter
+          id_counter += 1
+          { id: prev, trace: trace }
+        end
 
-      {
-        application_trace: application_trace,
-        framework_trace: framework_trace,
-        full_trace: application_trace + framework_trace
-      }
-    end
+        {
+          application_trace: application_trace,
+          framework_trace: framework_trace,
+          full_trace: application_trace + framework_trace
+        }
+      end
 
-    def binding_from_exception(exception)
-      exception.__web_console_bindings_stack[0]
-    end
+      def binding_from_exception(exception)
+        exception.__web_console_bindings_stack[0]
+      end
   end
 end

data/lib/action_dispatch/exception_wrapper.rb

@@ -2,8 +2,9 @@ module ActionDispatch
   class ExceptionWrapper
     def extract_sources
       exception.backtrace.map do |trace|
-        file, line = trace.split(":")
+        file, line  = trace.split(":")
         line_number = line.to_i
+
         {
           code: source_fragment(file, line_number) || {},
           file: file,

data/lib/assets/javascripts/web-console.js

@@ -0,0 +1 @@
+//= require ./web_console

data/lib/assets/javascripts/web_console.js

@@ -0,0 +1,41 @@
+//= require term
+
+;(function(BaseTerminal) {
+
+  // Expose the main WebConsole namespace.
+  var WebConsole = this.WebConsole = {};
+
+  // Follow term.js example and expose inherits and EventEmitter.
+  var inherits = WebConsole.inherits = BaseTerminal.inherits;
+  var EventEmitter = WebConsole.EventEmitter = BaseTerminal.EventEmitter;
+
+  var Terminal = WebConsole.Terminal = function(options) {
+    if (typeof options === 'number') {
+      return BaseTerminal.apply(this, arguments);
+    }
+
+    BaseTerminal.call(this, options || (options = {}));
+
+    this.open();
+
+    if (!(options.rows || options.cols) || !options.geometry) {
+      this.fitScreen();
+    }
+  };
+
+  // Make WebConsole.Terminal inherit from BaseTerminal (term.js).
+  inherits(Terminal, BaseTerminal);
+
+  Terminal.prototype.fitScreen = function() {
+    var width  = Math.floor(this.element.clientWidth / this.cols);
+    var height = Math.floor(this.element.clientHeight / this.rows);
+
+    var rows = Math.floor(window.innerHeight / height);
+    var cols = Math.floor(this.parent.clientWidth / width);
+
+    this.resize(cols, rows);
+
+    return [cols, rows];
+  };
+
+}).call(this, Terminal);