concise_errors 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 746b9cdaa164daed16b8bc70adba8cb822ef52c9039a441ab1fc29d92c53e48f
-  data.tar.gz: 6af78b52ef0ce3cae853b72a379e9c744b55c06d6324acfd66d776d7870dc6c1
+  metadata.gz: 27769238dc3e569de3a89c3c9ff4f3fcbd43d858f7c77533df92571b66abce74
+  data.tar.gz: f4bb5b6d61033967083e9ddcbc069d05acabbf155c8ce806e1dfb32076731a97
 SHA512:
-  metadata.gz: 4695c72ba6c43566bc957f975fb1c190f1bcbd66572d847554f8ea725fec6686be2990e8862c9b040f7367f3a169a1699a501b083965885c173ac69574410471
-  data.tar.gz: 4097761cb0f2a54d2d2f3c40eab9870c842c00f7a4efbbb82c4d31baa5316077e8160656ce891e96d76f9cd4134343a9cab61b33d69fb3f40320b049897b70be
+  metadata.gz: bc5f4bbff9b8ec08847430d9d5dfd5feec8eccbf29a6d8a3fa77f598d9674bc2f36ed8a0426a056aac703218710c1dea1a1a2eaeff319fc84b1e4491abaef767
+  data.tar.gz: 70e5c1412e25f8e379a9e2058eb1bcddeb65169783d3d3661adb9dce1ee8432ebe2909884bc59216984ff8da6f809ac8a5439be9430374fcd1b6a6418a7598b4

data/.rubocop.yml

@@ -8,3 +8,11 @@ Style/StringLiterals:
 
 Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
+
+Metrics/ClassLength:
+  Exclude:
+    - "lib/concise_errors/formatter.rb"
+
+Metrics/MethodLength:
+  Exclude:
+    - "lib/concise_errors/formatter.rb"

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [0.2.0] - 2025-10-25
+
+- Add a "View full Rails error page" button to the HTML view.
+  - Clicking the button replays the request (method, headers, and body when applicable)
+    to the same URL with the `concise_errors_full=1` flag, letting Rails render its
+    original full-featured debug page (or Web Console when present).
+  - Configurable via `config.concise_errors.full_error_param` (defaults to
+    `"concise_errors_full"`). Set to `nil` or empty to disable the button entirely.
+
 ## [0.1.0] - 2025-10-22
 
 - Initial release

data/README.md

@@ -8,6 +8,7 @@ ConciseErrors swaps Rails’ `ActionDispatch::DebugExceptions` middleware with a
 - Optional single-file HTML view optimised for dark/light mode without external CSS.
 - Configurable backtrace depth with an omission indicator.
 - Automatic fallback to `text/plain` when the request is `xhr?` or clients negotiate non-HTML `Accept` headers.
+- HTML view includes a button to open Rails' full-featured error page.
 
 ## Installation
 
@@ -21,7 +22,7 @@ Run `bundle install` and restart your Rails server. ConciseErrors automatically
 
 ## Configuration
 
-ConciseErrors ships with opinionated defaults — HTML output, no CSS, and Web Console middleware is automaticallyremoved in development — so simply installing the gem is enough. Override anything you need from `config/application.rb` or an environment-specific config:
+ConciseErrors ships with opinionated defaults — HTML output, no CSS, and Web Console middleware is automatically removed in development — so simply installing the gem is enough. Override anything you need from `config/application.rb` or an environment-specific config:
 
 ```ruby
 # config/environments/development.rb
@@ -32,6 +33,7 @@ Rails.application.configure do
     cfg.enabled = true          # flip to false to restore the stock debug page
     cfg.application_root = Rails.root.to_s # optional: trim this prefix from traces
     cfg.logger = Rails.logger              # optional: reuse your preferred logger
+    cfg.full_error_param = "concise_errors_full" # optional: query param to trigger full page; set nil/"" to disable
   end
 end
 ```
@@ -40,6 +42,13 @@ You can also steer the default format via `ENV["CONCISE_ERRORS_FORMAT"]` (`text`
 
 ConciseErrors only affects the debug middleware (the screen you see when `config.consider_all_requests_local` is true). Production 500 pages continue to use whatever `ActionDispatch::ShowExceptions` is configured to serve.
 
+### Viewing the full Rails error page
+
+When rendering HTML, ConciseErrors shows a "View full Rails error page" button. Clicking it performs a same-origin request back to the same URL with the `concise_errors_full=1` flag (or your configured `full_error_param`). The original request method, CSRF token, and content type are preserved; for non-GET/HEAD requests the request body is replayed.
+
+- To disable the button entirely, set `config.concise_errors.full_error_param = nil` or `""`.
+- If Web Console is installed, the fallback will go through its middleware; otherwise Rails' stock `ActionDispatch::DebugExceptions` page is shown.
+
 ## Sample Output
 
 Plain text format (default):

data/lib/concise_errors/configuration.rb

@@ -6,7 +6,7 @@ module ConciseErrors
     DEFAULT_STACK_LINES = 10
     DEFAULT_FORMAT = :text
 
-    attr_accessor :stack_trace_lines, :enabled, :logger, :application_root, :cleaner
+    attr_accessor :stack_trace_lines, :enabled, :logger, :application_root, :cleaner, :full_error_param
 
     def initialize
       reset!
@@ -31,6 +31,7 @@ module ConciseErrors
       @logger = nil
       @application_root = nil
       @cleaner = nil
+      @full_error_param = "concise_errors_full"
     end
   end
 end

data/lib/concise_errors/debug_exceptions.rb

@@ -10,6 +10,12 @@ module ConciseErrors
   # Replacement middleware that keeps the existing API while producing concise output.
   class DebugExceptions < ::ActionDispatch::DebugExceptions
     def call(env)
+      request = ActionDispatch::Request.new(env)
+
+      return fallback_web_console.call(env) if web_console_request?(request)
+
+      return fallback_web_console.call(env) if full_error_requested?(request)
+
       env["action_dispatch.backtrace_cleaner"] ||= ConciseErrors.configuration.cleaner
       super
     end
@@ -24,5 +30,31 @@ module ConciseErrors
     def logger(request)
       ConciseErrors.logger || super
     end
+
+    def full_error_requested?(request)
+      flag = ConciseErrors.configuration.full_error_param
+      return false if flag.nil? || flag.to_s.empty?
+
+      request.query_parameters.key?(flag.to_s)
+    end
+
+    def web_console_request?(request)
+      return false unless defined?(WebConsole::Middleware)
+
+      mount_point = WebConsole::Middleware.mount_point
+      return false if mount_point.nil? || mount_point.empty?
+
+      request.path.start_with?(mount_point)
+    end
+
+    def fallback_debug_exceptions
+      @fallback_debug_exceptions ||= ::ActionDispatch::DebugExceptions.new(@app)
+    end
+
+    def fallback_web_console
+      return fallback_debug_exceptions unless defined?(WebConsole::Middleware)
+
+      @fallback_web_console ||= WebConsole::Middleware.new(fallback_debug_exceptions)
+    end
   end
 end

data/lib/concise_errors/formatter.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "erb"
+require "json"
 require "rack/utils"
 
 module ConciseErrors
@@ -48,6 +49,7 @@ module ConciseErrors
             <h1>#{html_escape(heading_line)}</h1>
             <p>#{html_escape(status_line)}</p>
             <pre>#{html_escape(truncated_trace.join("\n"))}</pre>
+            #{full_error_controls}
           </body>
         </html>
       HTML
@@ -91,5 +93,125 @@ module ConciseErrors
 
       line.sub(%r{\A#{Regexp.escape(root)}/?}, "./")
     end
+
+    def full_error_controls
+      return "" unless flag_parameter
+
+      payload = full_error_payload
+      return "" unless payload
+
+      button_id = "concise-errors-view-full"
+      payload_id = "#{button_id}-payload"
+      payload_json = ERB::Util.json_escape(JSON.generate(payload))
+
+      <<~HTML
+        <button type="button" id="#{button_id}">View full Rails error page</button>
+        <script type="application/json" id="#{payload_id}">#{payload_json}</script>
+        <script>
+          (function() {
+            var button = document.getElementById("#{button_id}");
+            var payloadScript = document.getElementById("#{payload_id}");
+            if (!button || !payloadScript) { return; }
+
+            if (!window.fetch) {
+              button.addEventListener("click", function() {
+                window.location.assign("#{html_escape(payload.fetch(:url))}");
+              });
+              return;
+            }
+
+            var payloadText = payloadScript.textContent || payloadScript.innerText || "{}";
+            var data;
+
+            try {
+              data = JSON.parse(payloadText);
+            } catch (error) {
+              console.error("Failed to parse full error request payload", error);
+              return;
+            }
+
+            button.addEventListener("click", function(event) {
+              event.preventDefault();
+
+              var options = {
+                method: data.method,
+                credentials: "same-origin"
+              };
+
+              if (data.headers && Object.keys(data.headers).length > 0) {
+                options.headers = data.headers;
+              }
+
+              if (data.body && data.body.length > 0 && data.method !== "GET" && data.method !== "HEAD") {
+                options.body = data.body;
+              }
+
+              fetch(data.url, options).then(function(response) {
+                return response.text().then(function(html) {
+                  var doc = document;
+                  doc.open();
+                  doc.write(html);
+                  doc.close();
+                });
+              }).catch(function(error) {
+                console.error("Failed to load full Rails error page", error);
+              });
+            });
+          })();
+        </script>
+      HTML
+    end
+
+    def full_error_payload
+      return unless flagged_url
+
+      {
+        method: request.request_method,
+        url: flagged_url,
+        body: replay_body,
+        headers: replay_headers
+      }
+    end
+
+    def replay_body
+      return "" if %w[GET HEAD].include?(request.request_method)
+
+      request.raw_post.to_s
+    rescue EOFError
+      ""
+    end
+
+    def replay_headers
+      headers = {}
+      content_type = request.get_header("CONTENT_TYPE").to_s
+      headers["Content-Type"] = content_type unless content_type.empty?
+
+      csrf = request.get_header("HTTP_X_CSRF_TOKEN").to_s
+      headers["X-CSRF-Token"] = csrf unless csrf.empty?
+
+      headers
+    end
+
+    def flagged_url
+      flag = flag_parameter
+      return unless flag
+
+      params = request.query_parameters.dup
+      params[flag] = "1"
+
+      query = Rack::Utils.build_nested_query(params)
+      base_path = request.fullpath.split("?", 2).first
+      return base_path if query.empty?
+
+      "#{base_path}?#{query}"
+    end
+
+    def flag_parameter
+      value = configuration.full_error_param
+      return if value.nil?
+
+      string = value.to_s.strip
+      string.empty? ? nil : string
+    end
   end
 end

data/lib/concise_errors/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ConciseErrors
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/sig/concise_errors.rbs

@@ -9,12 +9,14 @@ module ConciseErrors
     @logger: untyped
     @application_root: String?
     @cleaner: untyped
+    @full_error_param: String?
 
     attr_accessor stack_trace_lines: Integer?
     attr_accessor enabled: bool
     attr_accessor logger: untyped
     attr_accessor application_root: String?
     attr_accessor cleaner: untyped
+    attr_accessor full_error_param: String?
 
     def initialize: () -> void
     def format: () -> Symbol

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: concise_errors
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Obie Fernandez
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-10-23 00:00:00.000000000 Z
+date: 2025-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack