web-console 2.3.0 → 4.2.0

data/lib/web_console/templates/error_page.js.erb

@@ -8,15 +8,13 @@ for (var i = 0; i < traceFrames.length; i++) {
     e.preventDefault();
     var target = e.target;
     var frameId = target.dataset.frameId;
+    var exceptionObjectId = target.dataset.exceptionObjectId;
 
     // Change the binding of the console.
-    changeBinding(frameId, function() {
-      if (selectedFrame) {
-        selectedFrame.className = selectedFrame.className.replace("selected", "");
-      }
-
-      target.className += " selected";
+    changeBinding(frameId, exceptionObjectId, function() {
+      // Rails already handles toggling the select class
       selectedFrame = target;
+      return target.innerHTML;
     });
 
     // Change the extracted source code
@@ -24,8 +22,9 @@ for (var i = 0; i < traceFrames.length; i++) {
   });
 }
 
-function changeBinding(frameId, callback) {
-  REPLConsole.currentSession.switchBindingTo(frameId, callback);
+// Change the binding of the current session and prompt the user.
+function changeBinding(frameId, exceptionObjectId, callback) {
+  REPLConsole.currentSession.switchBindingTo(frameId, exceptionObjectId, callback);
 }
 
 function changeSourceExtract(frameId) {

data/lib/web_console/templates/index.html.erb

@@ -6,3 +6,7 @@
 <% only_on_error_page do %>
   <%= render_javascript 'error_page' %>
 <% end %>
+
+<% only_on_regular_page do %>
+  <%= render_javascript 'regular_page' %>
+<% end %>

data/lib/web_console/templates/layouts/inlined_string.erb

@@ -1 +1 @@
-"<%= j yield %>"
+`<%= j yield %>`

data/lib/web_console/templates/layouts/javascript.erb

@@ -1,4 +1,4 @@
-<script type="text/javascript">
+<script type="text/javascript" data-template="<%= @template %>" nonce="<%= @nonce %>">
 (function() {
   <%= yield %>
 }).call(this);

data/lib/web_console/templates/regular_page.js.erb

@@ -0,0 +1,24 @@
+// Push the error page body upwards the size of the console.
+document.addEventListener('DOMContentLoaded', function() {
+  var consoleElement = document.getElementById('console');
+  var resizerElement = consoleElement.getElementsByClassName('resizer')[0];
+  var bodyElement = document.body;
+
+  function setBodyElementBottomMargin(pixels) {
+    bodyElement.style.marginBottom = pixels + 'px';
+  }
+
+  var currentConsoleElementHeight = consoleElement.offsetHeight;
+  setBodyElementBottomMargin(currentConsoleElementHeight);
+
+  resizerElement.addEventListener('mousedown', function(event) {
+    function recordConsoleElementHeight(event) {
+      resizerElement.removeEventListener('mouseup', recordConsoleElementHeight);
+
+      var currentConsoleElementHeight = consoleElement.offsetHeight;
+      setBodyElementBottomMargin(currentConsoleElementHeight);
+    }
+
+    resizerElement.addEventListener('mouseup', recordConsoleElementHeight);
+  });
+});

data/lib/web_console/templates/style.css.erb

@@ -1,27 +1,182 @@
-.console .pos-absolute { position: absolute; }
-.console .pos-fixed { position: fixed; }
-.console .pos-right { right: 0; }
-.console .border-box { box-sizing: border-box; }
-.console .layer { width: 100%; height: 100%; }
-.console .layer.console-outer { z-index: 1; }
-.console .layer.resizer { z-index: 2; }
-.console { position: fixed; left: 0; bottom: 0; width: 100%; height: 148px; padding: 0; margin: 0; background: none repeat scroll 0% 0% #333; z-index: 9999; }
-.console .console-outer { overflow: auto; padding-top: 4px; }
-.console .console-inner { font-family: monospace; font-size: 11px; width: 100%; height: 100%; overflow: none; background: #333; }
-.console .console-prompt-box { color: #FFF; }
-.console .console-message { color: #1AD027; margin: 0; border: 0; white-space: pre-wrap; background-color: #333; padding: 0; }
-.console .console-message.error-message { color: #fc9; }
-.console .console-focus .console-cursor { background: #FEFEFE; color: #333; font-weight: bold; }
-.console .resizer { background: #333; width: 100%; height: 4px; cursor: ns-resize; }
-.console .console-actions { padding-right: 3px; }
-.console .console-actions .button { float: left; }
-.console .button { cursor: pointer; border-radius: 1px; font-family: monospace; font-size: 13px; width: 14px; height: 14px; line-height: 14px; text-align: center; color: #ccc; }
-.console .button:hover { background: #666; color: #fff; }
-.console .button.close-button:hover { background: #966; }
-.console .clipboard { height: 0px; padding: 0px; margin: 0px; width: 0px; margin-left: -1000px; }
-.console .console-prompt-label { display: inline; color: #FFF; background: none repeat scroll 0% 0% #333; border: 0; padding: 0; }
-.console .console-prompt-display { display: inline; color: #FFF; background: none repeat scroll 0% 0% #333; border: 0; padding: 0; }
-.console.full-screen { height: 100%; }
-.console.full-screen .console-outer { padding-top: 3px; }
-.console.full-screen .resizer { display: none; }
-.console.full-screen .close-button { display: none; }
+.console .pos-absolute {
+  position: absolute;
+}
+
+.console .pos-fixed {
+  position: fixed;
+}
+
+.console .pos-right {
+  right: 0;
+}
+
+.console .border-box {
+  box-sizing: border-box;
+}
+
+.console .layer {
+  width: 100%;
+  height: 100%;
+}
+
+.console .layer.console-outer {
+  z-index: 1;
+}
+
+.console .layer.resizer {
+  z-index: 2;
+}
+
+.console {
+  position: fixed;
+  left: 0;
+  bottom: 0;
+  width: 100%;
+  height: 148px;
+  padding: 0;
+  margin: 0;
+  background: none repeat scroll 0% 0% #333;
+  z-index: 9999;
+}
+
+.console .console-outer {
+  overflow: auto;
+  padding-top: 4px;
+}
+
+.console .console-inner {
+  font-family: monospace;
+  font-size: 11px;
+  width: 100%;
+  height: 100%;
+  overflow: unset;
+  background: #333;
+}
+
+.console .console-prompt-box {
+  color: #fff;
+}
+
+.console .console-message {
+  color: #1ad027;
+  margin: 0;
+  border: 0;
+  white-space: pre-wrap;
+  background-color: #333;
+  padding: 0;
+}
+
+.console .console-message.error-message {
+  color: #fc9;
+}
+
+.console .console-message.notification-message {
+  color: #99f;
+}
+
+.console .console-message.auto-complete {
+  word-break: break-all;
+}
+
+.console .console-message.auto-complete .keyword {
+  margin-right: 11px;
+}
+
+.console .console-message.auto-complete .keyword.selected {
+  background: #fff;
+  color: #000;
+}
+
+.console .console-message.auto-complete .hidden {
+  display: none;
+}
+
+.console .console-message.auto-complete .trimmed {
+  display: none;
+}
+
+.console .console-hint {
+  color: #096;
+}
+
+.console .console-focus .console-cursor {
+  background: #fefefe;
+  color: #333;
+  font-weight: bold;
+}
+
+.console .resizer {
+  background: #333;
+  width: 100%;
+  height: 4px;
+  cursor: ns-resize;
+}
+
+.console .console-actions {
+  padding-right: 3px;
+}
+
+.console .console-actions .button {
+  float: left;
+}
+
+.console .button {
+  cursor: pointer;
+  border-radius: 1px;
+  font-family: monospace;
+  font-size: 13px;
+  width: 14px;
+  height: 14px;
+  line-height: 14px;
+  text-align: center;
+  color: #ccc;
+}
+
+.console .button:hover {
+  background: #666;
+  color: #fff;
+}
+
+.console .button.close-button:hover {
+  background: #966;
+}
+
+.console .clipboard {
+  height: 0px;
+  padding: 0px;
+  margin: 0px;
+  width: 0px;
+  margin-left: -1000px;
+}
+
+.console .console-prompt-label {
+  display: inline;
+  color: #fff;
+  background: none repeat scroll 0% 0% #333;
+  border: 0;
+  padding: 0;
+}
+
+.console .console-prompt-display {
+  display: inline;
+  color: #fff;
+  background: none repeat scroll 0% 0% #333;
+  border: 0;
+  padding: 0;
+}
+
+.console.full-screen {
+  height: 100%;
+}
+
+.console.full-screen .console-outer {
+  padding-top: 3px;
+}
+
+.console.full-screen .resizer {
+  display: none;
+}
+
+.console.full-screen .close-button {
+  display: none;
+}

data/lib/web_console/testing/erb_precompiler.rb

@@ -1,5 +1,7 @@
-require 'web_console/testing/helper'
-require 'web_console/testing/fake_middleware'
+# frozen_string_literal: true
+
+require "web_console/testing/helper"
+require "web_console/testing/fake_middleware"
 
 module WebConsole
   module Testing
@@ -8,7 +10,7 @@ module WebConsole
       def initialize(path)
         @erb  = ERB.new(File.read(path))
         @view = FakeMiddleware.new(
-          view_path: Helper.gem_root.join('lib/web_console/templates'),
+          view_path: Helper.gem_root.join("lib/web_console/templates"),
         ).view
       end
 

data/lib/web_console/testing/fake_middleware.rb

@@ -1,16 +1,13 @@
-require 'action_view'
-require 'action_dispatch'
-require 'active_support/core_ext/string/access'
-require 'json'
-require 'web_console/whitelist'
-require 'web_console/request'
-require 'web_console/view'
-require 'web_console/testing/helper'
+# frozen_string_literal: true
+
+require "action_view"
+require "web_console"
+require "web_console/testing/helper"
 
 module WebConsole
   module Testing
     class FakeMiddleware
-      I18n.load_path.concat(Dir[Helper.gem_root.join('lib/web_console/locales/*.yml')])
+      I18n.load_path.concat(Dir[Helper.gem_root.join("lib/web_console/locales/*.yml")])
 
       DEFAULT_HEADERS = { "Content-Type" => "application/javascript" }
 
@@ -25,7 +22,7 @@ module WebConsole
       end
 
       def view
-        @view ||= View.new(@view_path)
+        @view = View.new(@view_path)
       end
 
       private

data/lib/web_console/testing/helper.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module WebConsole
   module Testing
     module Helper
       def self.gem_root
-        Pathname(File.expand_path('../../../../', __FILE__))
+        Pathname(File.expand_path("../../../../", __FILE__))
       end
     end
   end

data/lib/web_console/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebConsole
-  VERSION = '2.3.0'
+  VERSION = "4.2.0"
 end

data/lib/web_console/view.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebConsole
   class View < ActionView::Base
     # Execute a block only on error pages.
@@ -5,7 +7,12 @@ module WebConsole
     # The error pages are special, because they are the only pages that
     # currently require multiple bindings. We get those from exceptions.
     def only_on_error_page(*args)
-      yield if @env['web_console.exception'].present?
+      yield if Thread.current[:__web_console_exception].present?
+    end
+
+    # Execute a block only on regular, non-error, pages.
+    def only_on_regular_page(*args)
+      yield if Thread.current[:__web_console_binding].present?
     end
 
     # Render JavaScript inside a script tag and a closure.
@@ -14,7 +21,9 @@ module WebConsole
     # script tag and enclosed in a closure, so you don't have to worry for
     # leaking globals, unless you explicitly want to.
     def render_javascript(template)
-      render(template: template, layout: 'layouts/javascript')
+      assign(template: template)
+      assign(nonce: @env["action_dispatch.content_security_policy_nonce"])
+      render(template: template, layout: "layouts/javascript")
     end
 
     # Render inlined string to be used inside of JavaScript code.
@@ -22,7 +31,19 @@ module WebConsole
     # The inlined string is returned as an actual JavaScript string. You
     # don't need to wrap the result yourself.
     def render_inlined_string(template)
-      render(template: template, layout: 'layouts/inlined_string')
+      render(template: template, layout: "layouts/inlined_string")
+    end
+
+    # Custom ActionView::Base#render wrapper which silences all the log
+    # printings.
+    #
+    # Helps to keep the Rails logs clean during errors.
+    def render(*)
+      if (logger = WebConsole.logger) && logger.respond_to?(:silence)
+        WebConsole.logger.silence { super }
+      else
+        super
+      end
     end
 
     # Override method for ActionView::Helpers::TranslationHelper#t.

data/lib/web_console/whiny_request.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 module WebConsole
   # Noisy wrapper around +Request+.
   #
-  # If any calls to +from_whitelisted_ip?+ and +acceptable_content_type?+
+  # If any calls to +permitted?+ and +acceptable_content_type?+
   # return false, an info log message will be displayed in users' logs.
   class WhinyRequest < SimpleDelegator
-    def from_whitelited_ip?
-      whine_unless request.from_whitelited_ip? do
-        "Cannot render console from #{request.remote_ip}! " \
-          "Allowed networks: #{request.whitelisted_ips}"
+    def permitted?
+      whine_unless request.permitted? do
+        "Cannot render console from #{request.strict_remote_ip}! " \
+          "Allowed networks: #{request.permissions}"
       end
     end
 
@@ -21,7 +23,7 @@ module WebConsole
       end
 
       def logger
-        env['action_dispatch.logger'] || WebConsole.logger
+        env["action_dispatch.logger"] || WebConsole.logger
       end
 
       def request

data/lib/web_console.rb

@@ -1,25 +1,33 @@
-require 'binding_of_caller'
+# frozen_string_literal: true
 
-require 'active_support/lazy_load_hooks'
-require 'active_support/logger'
-
-require 'web_console/integration'
-require 'web_console/railtie'
-require 'web_console/errors'
-require 'web_console/helper'
-require 'web_console/evaluator'
-require 'web_console/session'
-require 'web_console/template'
-require 'web_console/middleware'
-require 'web_console/whitelist'
-require 'web_console/request'
-require 'web_console/response'
-require 'web_console/view'
-require 'web_console/whiny_request'
+require "active_support/dependencies/autoload"
+require "active_support/logger"
 
 module WebConsole
-  mattr_accessor :logger
-  @@logger = ActiveSupport::Logger.new($stderr)
+  extend ActiveSupport::Autoload
+
+  autoload :View
+  autoload :Evaluator
+  autoload :ExceptionMapper
+  autoload :Session
+  autoload :Injector
+  autoload :Interceptor
+  autoload :Request
+  autoload :WhinyRequest
+  autoload :Permissions
+  autoload :Template
+  autoload :Middleware
+  autoload :Context
+  autoload :SourceLocation
 
-  ActiveSupport.run_load_hooks(:web_console, self)
+  autoload_at "web_console/errors" do
+    autoload :Error
+    autoload :DoubleRenderError
+  end
+
+  def self.logger
+    Rails.logger || (@logger ||= ActiveSupport::Logger.new($stderr))
+  end
 end
+
+require "web_console/railtie"