web-console 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d094505aa19a48af7f886c9312bf1fbc3142d29a8c2496768534547fa67746d
-  data.tar.gz: ebf85636acebd8cf99b267d207278efe65c5c7e6413c06262e61093ea046a723
+  metadata.gz: 1e582f6eaaeff0b5fd7bedde53a6101c43eb8b5b86cda5f2a0e5a535b10c7bfc
+  data.tar.gz: 5ed7fe9a6bbb404eb7c1a9d4e594a559ca7e65f5184f342a1882cb33152aac2b
 SHA512:
-  metadata.gz: a3740d1276a4760788a73fb1c04c818f7e2527adabddef1351d1501b815b118be6683124e3f95b15f6ba4a896d8553acaf0bd030b6dba47e6c21396b8e17962a
-  data.tar.gz: c89399b48b173ca0bebebf4c60f098eb93357d536d8eab99c016185f26fdf9f132baeb6c7dc4d667889d3367fe582583d18108a43b38dbda7a33925bb4deded7
+  metadata.gz: 9805b430a93e04d8b1865efbb1c10824cd198f79fe8ba3bb2e4b934de2eed777f09c13200d3f07a4db82cf09285c8ea6e60b505186d86ac0d52e45ab937f3130
+  data.tar.gz: ac73f59d7603a019b5a0c96cb7d2583ee8280198dbd719a071c7b77af71650cfd7333c7bb481f98552ba7ed933ddbc3ee00e235292a4c337e2520d71e10975a9

data/CHANGELOG.markdown

@@ -2,14 +2,38 @@
 
 ## master (unreleased)
 
+## 4.1.0
+
+* [#304](https://github.com/rails/web-console/pull/304) Add support for Rails 6.1 ([@stephannv])
+* [#298](https://github.com/rails/web-console/pull/298) Prevent deprecation warnings by removing template formats ([@mikelkew])
+* [#297](https://github.com/rails/web-console/pull/297) Use MutationObserver instead of Mutation Events ([@mikelkew])
+* [#296](https://github.com/rails/web-console/pull/296) Add CSP nonce to injected scripts and styles ([@mikelkew])
+
+## 4.0.4
+
+* [fb483743](https://github.com/rails/web-console/commit/fb483743a6a2a4168cdc0b2e03f48fc393991b73) Fix a crash on webrick with Rack 2.2.3 ([@gsamokovarov])
+
+## 4.0.3
+
+* [#291](https://github.com/rails/web-console/pull/291) Deprecate config.web_console.whitelisted_ips ([@JuanitoFatas])
+* [#290](https://github.com/rails/web-console/pull/290) Fix Content-Length for rack >= 2.1.0 ([@p8])
+
+## 4.0.2
+
+* [#285](https://github.com/rails/web-console/pull/285) Increase timeout on paste ([@celvro])
+
+## 4.0.1
+
+* [#279](https://github.com/rails/web-console/pull/279) Fix initial config.web_console.permissions value ([@patorash])
+
 ## 4.0.0
 
-* [|61c](https://github.com/rails/web-console/commit/61ce65b599f56809de1bd8da6590a80acbd92017) Move to config.web_console.permissions ([@gsamokovarov])
-* [|961](https://github.com/rails/web-console/commit/96127aac143e1e653fffdc4bb65e1ce0b5ff342d) Introduce Binding#console as an alternative interface ([@gsamokovarov])
-* [|d45](https://github.com/rails/web-console/commit/d4591ca5396ed15a08818f3da11134852a485b27) Introduce Rails 6 support ([@gsamokovarov])
-* [|f97](https://github.com/rails/web-console/commit/f97d8a889a38366485e5c5e8985995c19bf61d13) Introduce Ruby 2.6 support ([@gsamokovarov])
-* [|d6d](https://github.com/rails/web-console/commit/d6deacd9d5fcaabf3e3051d6985b53f924f86956) Drop Rails 5 support ([@gsamokovarov])
-* [|90f](https://github.com/rails/web-console/commit/90fda8789d402f05647c18f8cdf8e5c3d01692dd) Drop Ruby 2.4 support ([@gsamokovarov])
+* [61ce65b5](https://github.com/rails/web-console/commit/61ce65b599f56809de1bd8da6590a80acbd92017) Move to config.web_console.permissions ([@gsamokovarov])
+* [96127ac1](https://github.com/rails/web-console/commit/96127aac143e1e653fffdc4bb65e1ce0b5ff342d) Introduce Binding#console as an alternative interface ([@gsamokovarov])
+* [d4591ca5](https://github.com/rails/web-console/commit/d4591ca5396ed15a08818f3da11134852a485b27) Introduce Rails 6 support ([@gsamokovarov])
+* [f97d8a88](https://github.com/rails/web-console/commit/f97d8a889a38366485e5c5e8985995c19bf61d13) Introduce Ruby 2.6 support ([@gsamokovarov])
+* [d6deacd9](https://github.com/rails/web-console/commit/d6deacd9d5fcaabf3e3051d6985b53f924f86956) Drop Rails 5 support ([@gsamokovarov])
+* [90fda878](https://github.com/rails/web-console/commit/90fda8789d402f05647c18f8cdf8e5c3d01692dd) Drop Ruby 2.4 support ([@gsamokovarov])
 * [#265](https://github.com/rails/web-console/pull/265) Add support for nested exceptions ([@yuki24])
 
 ## 3.7.0
@@ -128,6 +152,8 @@ go to 3.1.0 instead.
 * [#84](https://github.com/rails/web-console/pull/84) Allow Rails 5 as dependency in gemspec ([@jonatack])
 * [#69](https://github.com/rails/web-console/pull/69) Introduce middleware for request dispatch and console rendering ([@gsamokovarov])
 
+[@stephannv]: https://github.com/stephannv
+[@mikelkew]: https://github.com/mikelkew
 [@jonatack]: https://github.com/jonatack
 [@ryandao]: https://github.com/ryandao
 [@jeffnv]: https://github.com/jeffnv
@@ -149,3 +175,7 @@ go to 3.1.0 instead.
 [@timomeh]: https://github.com/timomeh
 [@causztic]: https://github.com/causztic
 [@yuki24]: https://github.com/yuki24
+[@patorash]: https://github.com/patorash
+[@celvro]: https://github.com/celvro
+[@JuanitoFatas]: https://github.com/JuanitoFatas
+[@p8]: https://github.com/p8

data/README.markdown

@@ -1,7 +1,8 @@
 <p align=right>
-  Documentation for:
+  <strong>Current version: 4.1.0</strong> Documentation for:
   <a href=https://github.com/rails/web-console/tree/v1.0.4>v1.0.4</a>
   <a href=https://github.com/rails/web-console/tree/v2.2.1>v2.2.1</a>
+  <a href=https://github.com/rails/web-console/tree/v3.7.0>v3.7.0</a>
 </p>
 
 # Web Console [![Build Status](https://travis-ci.org/rails/web-console.svg?branch=master)](https://travis-ci.org/rails/web-console)
@@ -66,7 +67,7 @@ By default, only requests coming from IPv4 and IPv6 localhosts are allowed.
 `config.web_console.permissions` lets you control which IP's have access to
 the console.
 
-You can whitelist single IP's or whole networks. Say you want to share your
+You can allow single IP's or whole networks. Say you want to share your
 console with `192.168.0.100`:
 
 ```ruby
@@ -75,7 +76,7 @@ class Application < Rails::Application
 end
 ```
 
-If you want to whitelist the whole private network:
+If you want to allow the whole private network:
 
 ```ruby
 Rails.application.configure do

data/lib/web_console/injector.rb

@@ -13,9 +13,11 @@ module WebConsole
     end
 
     def inject(content)
-      # Remove any previously set Content-Length header because we modify
-      # the body. Otherwise the response will be truncated.
-      @headers.delete("Content-Length")
+      # Set Content-Length header to the size of the current body
+      # + the extra content. Otherwise the response will be truncated.
+      if @headers["Content-Length"]
+        @headers["Content-Length"] = (@body.bytesize + content.bytesize).to_s
+      end
 
       [
         if position = @body.rindex("</body>")

data/lib/web_console/permissions.rb

@@ -4,7 +4,7 @@ require "ipaddr"
 
 module WebConsole
   class Permissions
-    # IPv4 and IPv6 localhost should be always whitelisted.
+    # IPv4 and IPv6 localhost should be always allowed.
     ALWAYS_PERMITTED_NETWORKS = %w( 127.0.0.0/8 ::1 )
 
     def initialize(networks = nil)

data/lib/web_console/railtie.rb

@@ -5,7 +5,6 @@ require "rails/railtie"
 module WebConsole
   class Railtie < ::Rails::Railtie
     config.web_console = ActiveSupport::OrderedOptions.new
-    config.web_console.permissions = %w( 127.0.0.1 ::1 )
 
     initializer "web_console.initialize" do
       require "bindex"
@@ -53,8 +52,22 @@ module WebConsole
     end
 
     initializer "web_console.permissions" do
-      if permissions = config.web_console.permissions || config.web_console.whitelisted_ips
-        Request.permissions = Permissions.new(permissions)
+      permissions = web_console_permissions
+      Request.permissions = Permissions.new(permissions)
+    end
+
+    def web_console_permissions
+      case
+      when config.web_console.permissions
+        config.web_console.permissions
+      when config.web_console.allowed_ips
+        config.web_console.allowed_ips
+      when config.web_console.whitelisted_ips
+        ActiveSupport::Deprecation.warn(<<-MSG.squish)
+          The config.web_console.whitelisted_ips is deprecated and will be ignored in future release of web_console.
+          Please use config.web_console.allowed_ips instead.
+        MSG
+        config.web_console.whitelisted_ips
       end
     end
 

data/lib/web_console/template.rb

@@ -17,7 +17,7 @@ module WebConsole
 
     # Render a template (inferred from +template_paths+) as a plain string.
     def render(template)
-      view = View.new(ActionView::LookupContext.new(template_paths), instance_values)
+      view = View.with_empty_template_cache.with_view_paths(template_paths, instance_values)
       view.render(template: template, layout: false)
     end
   end

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

@@ -251,12 +251,14 @@ Autocomplete.prototype.removeView = function() {
 }
 
 // HTML strings for dynamic elements.
-var consoleInnerHtml = <%= render_inlined_string '_inner_console_markup.html' %>;
-var promptBoxHtml = <%= render_inlined_string '_prompt_box_markup.html' %>;
+var consoleInnerHtml = <%= render_inlined_string '_inner_console_markup' %>;
+var promptBoxHtml = <%= render_inlined_string '_prompt_box_markup' %>;
 // CSS
-var consoleStyleCss = <%= render_inlined_string 'style.css' %>;
+var consoleStyleCss = <%= render_inlined_string 'style' %>;
 // Insert a style element with the unique ID
 var styleElementId = 'sr02459pvbvrmhco';
+// Nonce to use for CSP
+var styleElementNonce = '<%= @nonce %>';
 
 // REPLConsole Constructor
 function REPLConsole(config) {
@@ -380,8 +382,13 @@ REPLConsole.prototype.install = function(container) {
     var clientHeightStart   = consoleOuter.clientHeight;
 
     var doDrag = function(e) {
-      container.style.height = (startHeight + startY - e.clientY) + 'px';
+      var height = startHeight + startY - e.clientY;
       consoleOuter.scrollTop = scrollTopStart + (clientHeightStart - consoleOuter.clientHeight);
+      if (height > document.documentElement.clientHeight) {
+        container.style.height = document.documentElement.clientHeight;
+      } else {
+        container.style.height = height + 'px';
+      }
       shiftConsoleActions();
     };
 
@@ -411,6 +418,14 @@ REPLConsole.prototype.install = function(container) {
     }
   }
 
+  var observer = new MutationObserver(function(mutationsList) {
+    for (let mutation of mutationsList) {
+      if (mutation.type === 'childList' && mutation.addedNodes.length > 0) {
+        shiftConsoleActions();
+      }
+    }
+  });
+
   // Initialize
   this.container = container;
   this.outer = consoleOuter;
@@ -422,7 +437,7 @@ REPLConsole.prototype.install = function(container) {
 
   findChild(container, 'resizer').addEventListener('mousedown', resizeContainer);
   findChild(consoleActions, 'close-button').addEventListener('click', closeContainer);
-  consoleOuter.addEventListener('DOMNodeInserted', shiftConsoleActions);
+  observer.observe(consoleOuter, { childList: true, subtree: true });
 
   REPLConsole.currentSession = this;
 };
@@ -436,6 +451,9 @@ REPLConsole.prototype.insertCss = function() {
   style.type = 'text/css';
   style.innerHTML = consoleStyleCss;
   style.id = styleElementId;
+  if (styleElementNonce.length > 0) {
+    style.nonce = styleElementNonce;
+  }
   document.getElementsByTagName('head')[0].appendChild(style);
 };
 
@@ -755,7 +773,7 @@ REPLConsole.prototype.onKeyDown = function(ev) {
         _this.addToInput(_this.clipboard.value);
         _this.clipboard.value = "";
         _this.clipboard.blur();
-      }, 10);
+      }, 100);
     }
   }
 

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

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

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

@@ -1,34 +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-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; }
+.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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WebConsole
-  VERSION = "4.0.0"
+  VERSION = "4.1.0"
 end

data/lib/web_console/view.rb

@@ -22,6 +22,7 @@ module WebConsole
     # leaking globals, unless you explicitly want to.
     def render_javascript(template)
       assign(template: template)
+      assign(nonce: @env["action_dispatch.content_security_policy_nonce"])
       render(template: template, layout: "layouts/javascript")
     end
 

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: web-console
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Charlie Somerville
 - Genadi Samokovarov
 - Guillermo Iguaran
 - Ryan Dao
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-04-29 00:00:00.000000000 Z
+date: 2020-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -19,42 +19,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0.a
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0.a
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0.a
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0.a
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: actionview
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0.a
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0.a
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: bindex
   requirement: !ruby/object:Gem::Requirement
@@ -69,7 +69,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.0
-description: 
+description:
 email:
 - charlie@charliesomerville.com
 - gsamokovarov@gmail.com
@@ -123,7 +123,7 @@ homepage: https://github.com/rails/web-console
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -139,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A debugging tool for your Ruby on Rails applications.
 test_files: []