solid_errors 0.1.0 → 0.2.1

data/app/views/solid_errors/errors/_actions.html.erb

@@ -0,0 +1,12 @@
+<div class="inline-flex items-center justify-start flex-wrap gap-3 whitespace-nowrap">
+  <% if current_controller.errors? && !current_action.errors_index? %>
+    <%= link_to errors_path, class: button_classes(icon: true) do %>
+      <%= bootstrap_svg "arrow-left" %>
+      <span>Back to errors</span>
+    <% end %>
+  <% end %>
+
+  <%= button_to error_path(error), method: :patch, class: button_classes(type: :primary_ghost), params: { error: { resolved_at: Time.now } } do %>
+    Resolve Error<span class="sr-only"> #<%= error.id %></span>
+  <% end %>
+</div>

data/app/views/solid_errors/errors/_error.html.erb

@@ -0,0 +1,24 @@
+<tr class="even:bg-gray-50 align-top">
+  <td scope="col" class="whitespace-wrap py-4 pl-4 pr-3 font-medium text-gray-900 sm:pl-3">
+    <div>
+      <%= error.emoji %>
+      <%= link_to error_path(error), class: "text-blue-400 underline inline-flex items-baseline gap-1" do %>
+        <strong><code><%= error.exception_class %></code></strong>
+      <% end %>
+      from
+      <em><code><%= error.source %></code></em>
+    </div>
+    <pre class="ml-6 mt-4"><%= error.message %></pre>
+  </td>
+  <td scope="col" class="whitespace-nowrap px-3 py-4 pt-7 text-gray-500 text-right">
+    <%= error.occurrences.size %>
+  </td>
+  <td scope="col" class="whitespace-nowrap px-3 py-4 pt-7 text-gray-500 text-right">
+    <%= time_ago_in_words error.occurrences.maximum(:created_at), scope: 'datetime.distance_in_words.short' %>
+  </td>
+  <td class="relative whitespace-nowrap py-4 pl-3 pr-4 text-right text-sm font-medium sm:pr-3">
+    <%= button_to error_path(error), method: :patch, class: button_classes(type: :primary_ghost), params: { error: { resolved_at: Time.now } } do %>
+      Resolve<span class="sr-only">, Error #<%= error.id %></span>
+    <% end %>
+  </td>
+</tr>

data/app/views/solid_errors/errors/index.html.erb

@@ -0,0 +1,18 @@
+<table class="min-w-full divide-y divide-gray-300">
+  <thead>
+    <tr>
+      <th scope="col" class="py-3.5 pl-4 pr-3 text-left text-sm font-semibold text-gray-900 sm:pl-3">Error</th>
+      <th scope="col" class="px-3 py-3.5 text-right text-sm font-semibold text-gray-900">Count</th>
+      <th scope="col" class="px-3 py-3.5 text-right text-sm font-semibold text-gray-900">Last</th>
+      <th scope="col" class="relative py-3.5 pl-3 pr-4 sm:pr-3">
+        <span class="sr-only">Resolve</span>
+      </th>
+    </tr>
+  </thead>
+
+  <tbody class="bg-white">
+    <%= render partial: "solid_errors/errors/error", collection: @errors %>
+  </tbody>
+</table>
+
+<%#= @errors.count %>

data/app/views/solid_errors/errors/show.html.erb

@@ -0,0 +1,101 @@
+<%= tag.section id: dom_id(@error), class: "space-y-6" do %>
+  <div class="flex justify-between items-center">
+    <%= tag.h1 class: "font-bold flex items-center text-2xl gap-2" do %>
+      <%= @error.emoji %>
+      <code><%= @error.exception_class %></code>
+      from
+      <em><code><%= @error.source %></code></em>
+    <% end %>
+
+    <small class="text-base">
+      #<code><%= @error.id %></code>
+    </small>
+  </div>
+
+  <pre class=""><%= @error.message %></pre>
+
+  <dl class="flex-1 grid grid-cols-2 gap-x-4">
+    <div class="flex items-center justify-between flex-wrap gap-x-2">
+      <dt class="font-bold">
+        <%= SolidErrors::Error.human_attribute_name(:first_seen) %>
+      </dt>
+      <dd class="inline-flex items-center gap-1">
+        <% first_seen_at = @error.occurrences.minimum(:created_at) %>
+
+        <abbr title="<%= first_seen_at.iso8601 %>" class="cursor-help">
+          <%= time_tag first_seen_at, "#{time_ago_in_words(first_seen_at)} ago" %>
+        </abbr>
+      </dd>
+    </div>
+    <div class="flex items-center justify-between flex-wrap gap-x-2">
+      <dt class="font-bold">
+        <%= SolidErrors::Error.human_attribute_name(:last_seen) %>
+      </dt>
+      <dd class="inline-flex items-center gap-1">
+        <% last_seen_at = @error.occurrences.maximum(:created_at) %>
+
+        <abbr title="<%= last_seen_at.iso8601 %>" class="cursor-help">
+          <%= time_tag last_seen_at, "#{time_ago_in_words(last_seen_at)} ago" %>
+        </abbr>
+      </dd>
+    </div>
+    <div class="flex items-center justify-between flex-wrap gap-x-2">
+      <dt class="font-bold">
+        <%= SolidErrors::Error.human_attribute_name(:occurrences) %>
+      </dt>
+      <dd class="inline-flex items-center gap-1">
+        <%= @error.occurrences.size %>
+      </dd>
+    </div>
+    <div class="flex items-center justify-between flex-wrap gap-x-2">
+      <dt class="font-bold">
+        <%= SolidErrors::Error.human_attribute_name(:exception_class) %>
+      </dt>
+      <dd class="inline-flex items-center gap-1">
+        <code><%= @error.exception_class %></code>
+      </dd>
+    </div>
+    <div class="flex items-center justify-between flex-wrap gap-x-2">
+      <dt class="font-bold">
+        <%= SolidErrors::Error.human_attribute_name(:severity) %>
+      </dt>
+      <dd class="inline-flex items-center gap-1">
+        <span class="<%= badge_classes %>">
+          <%= @error.severity %>
+        </span>
+      </dd>
+    </div>
+    <div class="flex items-center justify-between flex-wrap gap-x-2">
+      <dt class="font-bold">
+        <%= SolidErrors::Error.human_attribute_name(:source) %>
+      </dt>
+      <dd class="inline-flex items-center gap-1">
+        <em><%= @error.source %></em>
+      </dd>
+    </div>
+    <div class="flex items-center justify-between flex-wrap gap-x-2">
+      <dt class="font-bold">
+        <%= SolidErrors::Error.human_attribute_name(:project_root) %>
+      </dt>
+      <dd class="inline-flex items-center gap-1">
+        <span><%= SolidErrors::BacktraceLine::RAILS_ROOT %></span>
+      </dd>
+    </div>
+    <div class="flex items-center justify-between flex-wrap gap-x-2">
+      <dt class="font-bold">
+        <%= SolidErrors::Error.human_attribute_name(:gem_root) %>
+      </dt>
+      <dd class="inline-flex items-center gap-1">
+        <span><%= Gem.path.join("\n") %></span>
+      </dd>
+    </div>
+  </dl>
+
+  <%= render "solid_errors/errors/actions", error: @error %>
+<% end %>
+
+<hr class="mt-4 pb-4">
+
+<%= render "solid_errors/occurrences/collection",
+      occurrences: @error.occurrences,
+      titled: true %>

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

@@ -0,0 +1,25 @@
+<% titled ||= false %>
+
+<section id="occurrences" class="sm:rounded-md mt-4 -mx-2 sm:mx-0">
+  <% if titled %>
+    <div class="flex justify-between items-center mb-3 border-b">
+      <h2 class="font-bold text-2xl">
+        Occurrences
+      </h2>
+      <p class="text-right">
+        Total: <strong><%= occurrences.size %></strong>
+      </p>
+    </div>
+  <% end %>
+
+  <div class="min-w-full">
+    <% if occurrences.any? %>
+      <%= render occurrences %>
+    <% else %>
+      <div class="flex items-center justify-center gap-2">
+        <%= bootstrap_svg "list-ul" %>
+        <span class="text-2xl">No occurrences yet&hellip;</span>
+      </div>
+    <% end %>
+  </div>
+</section>

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

@@ -0,0 +1,46 @@
+<% seen_at = occurrence.created_at %>
+<% backtrace = occurrence.parsed_backtrace %>
+
+<%= tag.section id: dom_id(occurrence), class: "" do %>
+  <%= tag.details open: occurrence_counter.zero? do %>
+    <summary class="hover:bg-gray-50 p-2 rounded cursor-pointer">
+      <%= time_tag seen_at, seen_at %>
+      (<em><%= time_ago_in_words(seen_at) %> ago</em>)
+    </summary>
+    <div class="">
+      <dl class="ml-6">
+        <% occurrence.context&.each do |key, value| %>
+          <div class="flex items-center justify-between flex-wrap gap-x-2">
+            <dt class="font-bold">
+              <%= SolidErrors::Occurrence.human_attribute_name(key) %>
+            </dt>
+            <dd class="">
+              <%= value %>
+            </dd>
+          </div>
+        <% end %>
+        <div class="">
+          <dt class="font-bold">
+            <%= SolidErrors::Occurrence.human_attribute_name(:backtrace) %>
+          </dt>
+          <dd class="">
+            <% backtrace.lines.each_with_index do |line, i| %>
+              <%= tag.details open: line.application? || i.zero? do %>
+                <summary class="hover:bg-gray-50 px-2 py-1 rounded cursor-pointer">
+                  <span class="text-gray-500"><%= File.dirname(line.filtered_file) %>/</span><span class="text-blue-500"><%= File.basename(line.filtered_file) %></span>:<span class="text-gray-900"><%= line.filtered_number %></span>
+                  <span class="text-gray-500">in</span>
+                  <code class="text-green-500"><%= line.filtered_method %></code>
+                </summary>
+                <div><pre class="debug_dump"><code class="torchlight"><% line.source.each do |n, code| %>
+                  <div class="line"><span class="mr-2 text-right select-none text-gray-600"><%= n %></span><span><%= code %></span></div>
+                  <% end %></code></pre></div>
+              <% end %>
+            <% end %>
+          </dd>
+        </div>
+      </dl>
+    </div>
+  <% end %>
+<% end %>
+
+<hr class="mt-4 pb-4">

data/config/routes.rb

@@ -0,0 +1,5 @@
+SolidErrors::Engine.routes.draw do
+  root to: "errors#index"
+
+  resources :errors, only: [:index, :show, :update]
+end

data/lib/solid_errors/backtrace.rb

@@ -0,0 +1,48 @@
+module SolidErrors
+  class Backtrace
+    # Holder for an Array of Backtrace::Line instances.
+    attr_reader :lines, :application_lines
+
+    def self.parse(ruby_backtrace, opts = {})
+      ruby_lines = ruby_backtrace.to_a
+
+      lines = ruby_lines.collect do |unparsed_line|
+        BacktraceLine.parse(unparsed_line.to_s, opts)
+      end.compact
+
+      instance = new(lines)
+    end
+
+    def initialize(lines)
+      self.lines = lines
+      self.application_lines = lines.select(&:application?)
+    end
+
+    # Convert Backtrace to array.
+    #
+    # Returns array containing backtrace lines.
+    def to_ary
+      lines.take(1000).map { |l| { :number => l.filtered_number, :file => l.filtered_file, :method => l.filtered_method, :source => l.source } }
+    end
+    alias :to_a :to_ary
+
+    # JSON support.
+    #
+    # Returns JSON representation of backtrace.
+    def as_json(options = {})
+      to_ary
+    end
+
+    def to_s
+      lines.map(&:to_s).join("\n")
+    end
+
+    def inspect
+      "<Backtrace: " + lines.collect { |line| line.inspect }.join(", ") + ">"
+    end
+
+    private
+
+    attr_writer :lines, :application_lines
+  end
+end

data/lib/solid_errors/backtrace_line.rb

@@ -0,0 +1,113 @@
+module SolidErrors
+  class BacktraceLine
+    # Backtrace line regexp (optionally allowing leading X: for windows support).
+    INPUT_FORMAT = %r{^((?:[a-zA-Z]:)?[^:]+):(\d+)(?::in `([^']+)')?$}.freeze
+    STRING_EMPTY = ''.freeze
+    GEM_ROOT = '[GEM_ROOT]'.freeze
+    PROJECT_ROOT = '[PROJECT_ROOT]'.freeze
+    PROJECT_ROOT_CACHE = {}
+    GEM_ROOT_CACHE = {}
+    RELATIVE_ROOT = Regexp.new('^\.\/').freeze
+    RAILS_ROOT = ::Rails.root.to_s.dup.freeze
+    ROOT_REGEXP = Regexp.new("^#{ Regexp.escape(RAILS_ROOT) }").freeze
+    BACKTRACE_FILTERS = [
+      lambda { |line|
+        return line unless defined?(Gem)
+        GEM_ROOT_CACHE[line] ||= Gem.path.reduce(line) do |line, path|
+          line.sub(path, GEM_ROOT)
+        end
+      },
+      lambda { |line|
+        c = (PROJECT_ROOT_CACHE[RAILS_ROOT] ||= {})
+        return c[line] if c.has_key?(line)
+        c[line] ||= line.sub(ROOT_REGEXP, PROJECT_ROOT)
+      },
+      lambda { |line| line.sub(RELATIVE_ROOT, STRING_EMPTY) }
+    ].freeze
+
+    attr_reader :file
+    attr_reader :number
+    attr_reader :method
+    attr_reader :filtered_file, :filtered_number, :filtered_method
+
+    # Parses a single line of a given backtrace
+    #
+    # @param [String] unparsed_line The raw line from +caller+ or some backtrace.
+    #
+    # @return The parsed backtrace line.
+    def self.parse(unparsed_line, opts = {})
+      filtered_line = BACKTRACE_FILTERS.reduce(unparsed_line) do |line, proc|
+        proc.call(line)
+      end
+
+      if filtered_line
+        match = unparsed_line.match(INPUT_FORMAT) || [].freeze
+        fmatch = filtered_line.match(INPUT_FORMAT) || [].freeze
+
+        file, number, method = match[1], match[2], match[3]
+        filtered_args = [fmatch[1], fmatch[2], fmatch[3]]
+        new(file, number, method, *filtered_args, opts.fetch(:source_radius, 2))
+      else
+        nil
+      end
+    end
+
+    def initialize(file, number, method, filtered_file = file,
+                    filtered_number = number, filtered_method = method,
+                    source_radius = 2)
+      self.filtered_file   = filtered_file
+      self.filtered_number = filtered_number
+      self.filtered_method = filtered_method
+      self.file            = file
+      self.number          = number
+      self.method          = method
+      self.source_radius   = source_radius
+    end
+
+    # Reconstructs the line in a readable fashion.
+    def to_s
+      "#{filtered_file}:#{filtered_number}:in `#{filtered_method}'"
+    end
+
+    def ==(other)
+      to_s == other.to_s
+    end
+
+    def inspect
+      "<Line:#{to_s}>"
+    end
+
+    # Determines if this line is part of the application trace or not.
+    def application?
+      (filtered_file =~ /^\[PROJECT_ROOT\]/i) && !(filtered_file =~ /^\[PROJECT_ROOT\]\/vendor/i)
+    end
+
+    def source
+      @source ||= get_source(file, number, source_radius)
+    end
+
+    private
+
+    attr_writer :file, :number, :method, :filtered_file, :filtered_number, :filtered_method
+
+    attr_accessor :source_radius
+
+    # Open source file and read line(s).
+    #
+    # Returns an array of line(s) from source file.
+    def get_source(file, number, radius = 2)
+      return {} unless file && File.exist?(file)
+
+      before = after = radius
+      start = (number.to_i - 1) - before
+      start = 0 and before = 1 if start <= 0
+      duration = before + 1 + after
+
+      l = 0
+      File.open(file) do |f|
+        start.times { f.gets ; l += 1 }
+        return Hash[duration.times.map { (line = f.gets) ? [(l += 1), line] : nil }.compact]
+      end
+    end
+  end
+end

data/lib/solid_errors/engine.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module SolidErrors
+  class Engine < ::Rails::Engine
+    isolate_namespace SolidErrors
+
+    rake_tasks do
+      load "solid_errors/tasks.rb"
+    end
+
+    config.solid_errors = ActiveSupport::OrderedOptions.new
+
+    initializer "solid_errors.config" do
+      config.solid_errors.each do |name, value|
+        SolidErrors.public_send("#{name}=", value)
+      end
+    end
+
+    initializer "solid_errors.active_record.error_subscriber" do
+      Rails.error.subscribe(SolidErrors::Subscriber.new)
+    end
+  end
+end

data/lib/solid_errors/subscriber.rb

@@ -0,0 +1,59 @@
+module SolidErrors
+  class Subscriber
+    IGNORED_ERRORS = ['ActionController::RoutingError',
+                      'AbstractController::ActionNotFound',
+                      'ActionController::MethodNotAllowed',
+                      'ActionController::UnknownHttpMethod',
+                      'ActionController::NotImplemented',
+                      'ActionController::UnknownFormat',
+                      'ActionController::InvalidAuthenticityToken',
+                      'ActionController::InvalidCrossOriginRequest',
+                      'ActionDispatch::Http::Parameters::ParseError',
+                      'ActionController::BadRequest',
+                      'ActionController::ParameterMissing',
+                      'ActiveRecord::RecordNotFound',
+                      'ActionController::UnknownAction',
+                      'ActionDispatch::Http::MimeNegotiation::InvalidType',
+                      'Rack::QueryParser::ParameterTypeError',
+                      'Rack::QueryParser::InvalidParameterError',
+                      'CGI::Session::CookieStore::TamperedWithCookie',
+                      'Mongoid::Errors::DocumentNotFound',
+                      'Sinatra::NotFound',
+                      'Sidekiq::JobRetry::Skip'].map(&:freeze).freeze
+
+
+    def report(error, handled:, severity:, context:, source: nil)
+      return if ignore_by_class?(error.class.name)
+
+      error_attributes = {
+        exception_class: error.class.name,
+        message: s(error.message),
+        severity: severity,
+        source: source
+      }
+      if (record = SolidErrors::Error.find_by(error_attributes))
+        record.update!(resolved_at: nil, updated_at: Time.now)
+      else
+        record = SolidErrors::Error.create!(error_attributes)
+      end
+
+      SolidErrors::Occurrence.create(
+        error_id: record.id,
+        backtrace: error.backtrace.join("\n"),
+        context: s(context)
+      )
+    end
+
+    def s(data)
+      Sanitizer.sanitize(data)
+    end
+
+    def ignore_by_class?(error_class_name)
+      IGNORED_ERRORS.any? do |ignored_class|
+        ignored_class_name = ignored_class.respond_to?(:name) ? ignored_class.name : ignored_class
+
+        ignored_class_name == error_class_name
+      end
+    end
+  end
+end

data/lib/solid_errors/version.rb

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

data/lib/solid_errors.rb

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
 require_relative "solid_errors/version"
+require_relative "solid_errors/subscriber"
+require_relative "solid_errors/backtrace"
+require_relative "solid_errors/backtrace_line"
+require_relative "solid_errors/engine"
 
 module SolidErrors
-  class Error < StandardError; end
-  # Your code goes here...
+  mattr_accessor :connects_to
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: solid_errors
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Stephen Margheim
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 2024-01-14 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 description:
 email:
 - stephen.margheim@gmail.com
@@ -17,24 +31,32 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".standard.yml"
-- CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- Gemfile
-- LICENSE.txt
 - README.md
 - Rakefile
+- app/controllers/solid_errors/errors_controller.rb
+- app/models/solid_errors/error.rb
+- app/models/solid_errors/occurrence.rb
+- app/models/solid_errors/record.rb
+- app/views/layouts/application.html.erb
+- app/views/solid_errors/errors/_actions.html.erb
+- app/views/solid_errors/errors/_error.html.erb
+- app/views/solid_errors/errors/index.html.erb
+- app/views/solid_errors/errors/show.html.erb
+- app/views/solid_errors/occurrences/_collection.html.erb
+- app/views/solid_errors/occurrences/_occurrence.html.erb
+- config/routes.rb
 - lib/solid_errors.rb
+- lib/solid_errors/backtrace.rb
+- lib/solid_errors/backtrace_line.rb
+- lib/solid_errors/engine.rb
+- lib/solid_errors/subscriber.rb
 - lib/solid_errors/version.rb
-- sig/solid_errors.rbs
-- solid_errors.gemspec
 homepage: https://github.com/fractaledmind/solid_errors
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/fractaledmind/solid_errors
   source_code_uri: https://github.com/fractaledmind/solid_errors
-  changelog_uri: https://github.com/fractaledmind/solid_errors/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:

data/.standard.yml

@@ -1,3 +0,0 @@
-# For available configuration options, see:
-#   https://github.com/testdouble/standard
-ruby_version: 2.6

data/CHANGELOG.md

@@ -1,5 +0,0 @@
-## [Unreleased]
-
-## [0.1.0] - 2024-01-14
-
-- Initial release