solid_errors 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 389a4c6c9c7910c471dfc93caf7003790e1afa6c0a6781f010d6453b99731ec2
-  data.tar.gz: 0ad0508538e6ff2f523a865e4230ff371400a56b8e897b6078c47570dd71eccc
+  metadata.gz: 1d793218b26cf26f6f6d6a4a87f8e14088cf555739d5ea007894a75cef13646a
+  data.tar.gz: a4bfc87e5a230db9ba392991ac37624ea58e5027a487260e9c3982eb13b4ef8c
 SHA512:
-  metadata.gz: c91d2c051098cd1f3530592f76f85b9dffe8aa264f693950673f1ac8110a09f1c0b6afa86ec7eb3b071d52825899cf71cf17e75ad01f394639446df4fbf21fbd
-  data.tar.gz: 7947a0212c04437d205c822da7a0a96fccba64907d5ad3a062afe6919934767d4d533da0f977e6d48218b7c7f6bd9d992a10cf5d157c2a661154edb0921488bc
+  metadata.gz: 230583bf528c6765a6205fcfbb1981d935fb866c28126fec475800dc0a11aab1e1a0aaad4a03f631e5b58a166d3d4a805f288b0b4e270ae95a949b0dd4bca7dc
+  data.tar.gz: 903a70c2663cf40335e5697ee882728e8aeb56e34519be322fa78be3a3505a2255f16eb78552ad0d7ba2d5bd6602ff8204beeaf63041a0b1b5c65bbf998d32aa

data/README.md

@@ -157,14 +157,21 @@ end
 
 ### What each occurrence records
 
-Every occurrence stores the backtrace and the error's context. Rails adds the current request or job to that context, and Solid Errors records it as:
+Every occurrence stores the backtrace and the error's context. Rails adds the current request or job to that context, and Solid Errors records which one it was: the controller action (`UsersController#show`), or the job's class, id and queue.
 
-* **Requests:** the controller action (`UsersController#show`) and its params, with your `config.filter_parameters` applied.
-* **Background jobs:** the job class, its id and queue, and its arguments, also filtered.
+Request params and job arguments are not recorded unless you opt in, because they often carry user content that `config.filter_parameters` can't catch: it matches keys, so positional job arguments, mail delivery jobs (the mail's recipients and body) and webhook payloads would be stored and emailed as they are.
+
+```ruby
+config.solid_errors.record_params = true    # the request's params, with filter_parameters applied
+config.solid_errors.record_arguments = true # the job's arguments, with filter_parameters applied
+```
+
+Context you set yourself takes precedence. For example, `Rails.error.set_context(params: ...)` in a `before_action` replaces the recorded params.
 
 Any Active Record object in the context is stored as its [GlobalID](https://github.com/rails/globalid) (`gid://my-app/User/1`), so you can tell which record was involved. Add your own context with `Rails.error.set_context(...)` or the `context:` option shown above.
 
 Errors raised in background jobs reach Solid Errors when your job backend runs jobs inside the Rails executor, as Solid Queue, Sidekiq and GoodJob do. You don't need any extra setup for this.
+
 ### Configuration
 
 You can configure Solid Errors via the Rails configuration object, under the `solid_errors` key. Currently, the following configuration options are available:
@@ -181,6 +188,7 @@ You can configure Solid Errors via the Rails configuration object, under the `so
 * `email_subject` - A proc that builds the subject line for email notifications. See [Email notifications](#email-notifications) for more information.
 * `base_controller_class` - Specify a different controller as the base class for the Solid Errors controller. See [Authentication](#authentication) for more information.
 * `destroy_after` - If set, Solid Errors will periodically destroy resolved records that are older than the value specified. See [Automatically destroying old records](#automatically-destroying-old-records) for more information.
+* `record_params` / `record_arguments` - Whether to record request params and job arguments with each occurrence. Both default to `false`. See [What each occurrence records](#what-each-occurrence-records).
 * `ignored_errors` - Error classes, or their names, to never record, in addition to the built-in list in `SolidErrors::Subscriber::IGNORED_ERRORS`. For example, `config.solid_errors.ignored_errors = ["ActiveStorage::FileNotFoundError"]`.
 
 ### Database Configuration

data/app/views/layouts/solid_errors/_style.html.erb

@@ -1190,4 +1190,189 @@
       padding-right: 0.75rem
     }
   }
+
+  /*
+  Dark mode follows the operating system. Rather than adding `dark:` variants to
+  the markup, it remaps the light utilities above to their dark counterparts, so
+  the views and the classes the backtrace toggle swaps stay the same.
+  */
+
+  :root{
+    color-scheme: light dark
+  }
+
+  @media (prefers-color-scheme: dark){
+    *, ::before, ::after{
+      border-color: #374151
+    }
+
+    body{
+      background-color: rgb(17 24 39);
+      color: rgb(229 231 235)
+    }
+
+    .divide-gray-300 > :not([hidden]) ~ :not([hidden]){
+      --tw-divide-opacity: 1;
+      border-color: rgb(55 65 81 / var(--tw-divide-opacity))
+    }
+
+    .border-black{
+      --tw-border-opacity: 1;
+      border-color: rgb(209 213 219 / var(--tw-border-opacity))
+    }
+
+    .border-blue-500{
+      --tw-border-opacity: 1;
+      border-color: rgb(96 165 250 / var(--tw-border-opacity))
+    }
+
+    .border-gray-300{
+      --tw-border-opacity: 1;
+      border-color: rgb(75 85 99 / var(--tw-border-opacity))
+    }
+
+    .border-red-500{
+      --tw-border-opacity: 1;
+      border-color: rgb(248 113 113 / var(--tw-border-opacity))
+    }
+
+    .bg-gray-100{
+      --tw-bg-opacity: 1;
+      background-color: rgb(31 41 55 / var(--tw-bg-opacity))
+    }
+
+    .bg-green-50{
+      --tw-bg-opacity: 1;
+      background-color: rgb(5 46 22 / var(--tw-bg-opacity))
+    }
+
+    .bg-red-50{
+      --tw-bg-opacity: 1;
+      background-color: rgb(69 10 10 / var(--tw-bg-opacity))
+    }
+
+    .bg-white{
+      --tw-bg-opacity: 1;
+      background-color: rgb(17 24 39 / var(--tw-bg-opacity))
+    }
+
+    .text-black{
+      --tw-text-opacity: 1;
+      color: rgb(243 244 246 / var(--tw-text-opacity))
+    }
+
+    .bg-blue-100{
+      background-color: rgb(30 58 138 / 0.5)
+    }
+
+    .bg-red-100{
+      background-color: rgb(127 29 29 / 0.5)
+    }
+
+    .bg-yellow-100{
+      background-color: rgb(113 63 18 / 0.5)
+    }
+
+    .bg-green-100{
+      background-color: rgb(20 83 45 / 0.5)
+    }
+
+    .bg-violet-100{
+      background-color: rgb(76 29 149 / 0.5)
+    }
+
+    .text-blue-500{
+      --tw-text-opacity: 1;
+      color: rgb(96 165 250 / var(--tw-text-opacity))
+    }
+
+    .text-gray-500{
+      --tw-text-opacity: 1;
+      color: rgb(156 163 175 / var(--tw-text-opacity))
+    }
+
+    .text-gray-900{
+      --tw-text-opacity: 1;
+      color: rgb(243 244 246 / var(--tw-text-opacity))
+    }
+
+    .text-green-500{
+      --tw-text-opacity: 1;
+      color: rgb(74 222 128 / var(--tw-text-opacity))
+    }
+
+    .text-red-500{
+      --tw-text-opacity: 1;
+      color: rgb(248 113 113 / var(--tw-text-opacity))
+    }
+
+    .text-blue-800{
+      --tw-text-opacity: 1;
+      color: rgb(191 219 254 / var(--tw-text-opacity))
+    }
+
+    .text-red-800{
+      --tw-text-opacity: 1;
+      color: rgb(254 202 202 / var(--tw-text-opacity))
+    }
+
+    .text-yellow-800{
+      --tw-text-opacity: 1;
+      color: rgb(254 240 138 / var(--tw-text-opacity))
+    }
+
+    .text-green-800{
+      --tw-text-opacity: 1;
+      color: rgb(187 247 208 / var(--tw-text-opacity))
+    }
+
+    .text-violet-800{
+      --tw-text-opacity: 1;
+      color: rgb(221 214 254 / var(--tw-text-opacity))
+    }
+
+    .even\:bg-gray-50:nth-child(even){
+      background-color: rgb(31 41 55 / 0.5)
+    }
+
+    .hover\:bg-gray-50:hover{
+      --tw-bg-opacity: 1;
+      background-color: rgb(31 41 55 / var(--tw-bg-opacity))
+    }
+
+    .hover\:ring-blue-200:hover{
+      --tw-ring-opacity: 1;
+      --tw-ring-color: rgb(30 58 138 / var(--tw-ring-opacity))
+    }
+
+    .hover\:ring-gray-200:hover{
+      --tw-ring-opacity: 1;
+      --tw-ring-color: rgb(55 65 81 / var(--tw-ring-opacity))
+    }
+
+    .hover\:ring-red-200:hover{
+      --tw-ring-opacity: 1;
+      --tw-ring-color: rgb(127 29 29 / var(--tw-ring-opacity))
+    }
+
+    .hover\:bg-black:hover{
+      --tw-bg-opacity: 1;
+      background-color: rgb(243 244 246 / var(--tw-bg-opacity))
+    }
+
+    .hover\:text-white:hover{
+      --tw-text-opacity: 1;
+      color: rgb(17 24 39 / var(--tw-text-opacity))
+    }
+
+    .hover\:text-gray-700:hover{
+      --tw-text-opacity: 1;
+      color: rgb(229 231 235 / var(--tw-text-opacity))
+    }
+
+    .hover\:border-gray-300:hover{
+      --tw-border-opacity: 1;
+      border-color: rgb(107 114 128 / var(--tw-border-opacity))
+    }
+  }
 </style>

data/app/views/solid_errors/occurrences/_collection.html.erb

@@ -10,7 +10,7 @@
         <p class="text-right">
           <% page_count = page.count %>
           <% if page_count.zero? %>
-            No posts found
+            No occurrences found
           <% elsif page.pages == 1 %>
             <strong><%= page_count %></strong> total
           <% else %>
@@ -53,7 +53,9 @@
             collection: occurrences, as: :occurrence %>
     <% else %>
       <div class="flex items-center justify-center gap-2">
-        <%= bootstrap_svg "list-ul" %>
+        <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-list-ul" viewBox="0 0 16 16">
+          <path fill-rule="evenodd" d="M5 11.5a.5.5 0 0 1 .5-.5h9a.5.5 0 0 1 0 1h-9a.5.5 0 0 1-.5-.5m0-4a.5.5 0 0 1 .5-.5h9a.5.5 0 0 1 0 1h-9a.5.5 0 0 1-.5-.5m0-4a.5.5 0 0 1 .5-.5h9a.5.5 0 0 1 0 1h-9a.5.5 0 0 1-.5-.5m-3 1a1 1 0 1 0 0-2 1 1 0 0 0 0 2m0 4a1 1 0 1 0 0-2 1 1 0 0 0 0 2m0 4a1 1 0 1 0 0-2 1 1 0 0 0 0 2"/>
+        </svg>
         <span class="text-2xl">No occurrences yet&hellip;</span>
       </div>
     <% end %>

data/lib/solid_errors/subscriber.rb

@@ -52,13 +52,13 @@ module SolidErrors
       context = context.dup
       if defined?(ActionController::Metal) && (controller = context[:controller]).is_a?(ActionController::Metal)
         context[:controller] = "#{controller.class.name}##{controller.action_name}"
-        context[:params] ||= controller.request.filtered_parameters.except("controller", "action")
+        context[:params] ||= controller.request.filtered_parameters.except("controller", "action") if SolidErrors.record_params
       end
       if defined?(ActiveJob::Base) && (job = context[:job]).is_a?(ActiveJob::Base)
         context[:job] = job.class.name
         context[:job_id] ||= job.job_id
         context[:queue] ||= job.queue_name
-        context[:arguments] ||= parameter_filter.filter(arguments: s(job.arguments))[:arguments]
+        context[:arguments] ||= parameter_filter.filter(arguments: s(job.arguments))[:arguments] if SolidErrors.record_arguments
       end
       context
     end

data/lib/solid_errors/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SolidErrors
-  VERSION = "0.9.0"
+  VERSION = "0.9.1"
 end

data/lib/solid_errors.rb

@@ -21,6 +21,9 @@ module SolidErrors
   }
   mattr_accessor :destroy_after
   mattr_accessor :ignored_errors, default: []
+  # Request params and job arguments carry user content that filter_parameters' key matching misses
+  mattr_accessor :record_params, default: false
+  mattr_accessor :record_arguments, default: false
   mattr_writer :url_helper_name, :url_options
 
   class << self

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solid_errors
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Stephen Margheim