error_ready 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54c1d662e9dc0e27d2c488f68e32a26bba5182884dcb6937bcf470bc61db8662
-  data.tar.gz: 7a72b704734f9ae5644442df7d589571bff00488a705c0261d0daaf45964c2de
+  metadata.gz: 1e90f8389acb8f9a4e9779fe63efb2c309122728f81e22c50e39442473c7ea07
+  data.tar.gz: 625c141100d154184fec324588b2d18eefda838d87d2b1abb5645969cc1edf20
 SHA512:
-  metadata.gz: 2fd231f46958d06ec1aef6421e52113b6172ae3470e9f93fd3e2134224be7a3c7ddadd102a30c95cd928ef85e4a96c81d7ea476fa3c31a3a35c12f2b1c739b8d
-  data.tar.gz: bcaa37cfcbf86880a73fac9eb7de3b0795f867520eb56137b14bf2e9af1bc2606c8f8a638c4ccf5af2b0622c33e655ba9bf910f72339f2f336aa5bbcd7de98e8
+  metadata.gz: 4e1054614f11a5b695482511fe73dcc905673f2e9c405a2b081a2256711526db81b420d189a85611a93faa4067485e805e9c42a70f84318f227453579b874640
+  data.tar.gz: c993186bf5697f498401411d49f0f03f3aa355fa06fd0de8f7102339687aca2a22b9511d0e39d2e2f097cf19d2f3354bcb324b2cb48c904a22e7c37b83f8c4a4

data/README.md

@@ -1,7 +1,5 @@
 # ErrorReady
-A plugin thats records errors and store them in the database you already have.
-
-![Showcase image](app/assets/images/error_ready/showcase.png)
+Error recording for Rails 7 applications
 
 ## Usage
 coming soon

data/lib/error_ready/configuration.rb

@@ -0,0 +1,9 @@
+module ErrorReady
+  class Configuration
+    include ActiveSupport::Configurable
+
+    config_accessor :host, default: "https://errorready.com/api/problems"
+    config_accessor :database_notifier, default: false
+    config_accessor :app_secret
+  end
+end

data/lib/error_ready/formatter.rb

@@ -1,23 +1,32 @@
 module ErrorReady
   class Formatter
     def initialize(error:, handled:, severity:, context:, source: nil)
-      @error = error 
       @handled = handled
       @severity = severity
       @context = context
       @source = source
+      @error = wrapped_exception(error)
     end
 
     def format
       {
-        message: @error.message,
-        err_class: @error.class.to_s,
-        backtrace: @error.backtrace,
+        message: @error.exception.message,
+        err_class: @error.exception.class.to_s,
         severity: @severity.to_s,
-        context: @context.transform_values(&:to_s),
         source: @source,
-        environment: Rails.env
+        environment: Rails.env,
+        context: @context.transform_values(&:to_s),
+        source_to_show: @error.source_extracts[@error.source_to_show_id],
+        application_trace: @error.application_trace,
+        full_trace: @error.full_trace
       }
     end
+
+    def wrapped_exception(error)
+      ActionDispatch::ExceptionWrapper.new(
+        Rails::BacktraceCleaner.new,
+        error
+      )
+    end
   end
 end

data/lib/error_ready/{rack_middleware.rb → middlewares/rack_middleware.rb}

@@ -5,10 +5,14 @@ module ErrorReady
     end
 
     def call(env)
+      # Load session
+      env["rack.session"]["init"] = true
+
       Rails.error.set_context(
         server_name: env["SERVER_NAME"],
         http_host: env["HTTP_HOST"],
-        http_user_agent: env["HTTP_USER_AGENT"]
+        http_user_agent: env["HTTP_USER_AGENT"],
+        session: env["rack.session"].to_json
       )
 
       Rails.error.record do

data/lib/error_ready/notifiers/async_sender.rb

@@ -0,0 +1,11 @@
+module ErrorReady
+  class AsyncSender
+    def initialize(formatted_error)
+      @error = formatted_error
+    end
+
+    def call
+      SyncSender.new(@error).async.call
+    end
+  end
+end

data/lib/error_ready/notifiers/sync_sender.rb

@@ -0,0 +1,52 @@
+require "net/http"
+
+module ErrorReady
+  class SyncSender
+    include Concurrent::Async
+
+    def initialize(formatted_error)
+      @error = formatted_error
+    end
+
+    def call
+      handle_response(send_request)
+    end
+
+    def send_request
+      http = Net::HTTP.new(uri.hostname, uri.port)
+      http.use_ssl = true if uri.port == 443
+      req = Net::HTTP::Post.new(uri)
+      req["Content-type"] = "application/json"
+      req["APP-SECRET"] = app_secret
+      req.body = @error.to_json
+      http.request(req)
+    end
+
+    def handle_response(response)
+      case response
+      when Net::HTTPSuccess, Net::HTTPOK
+        log_message("error sent to #{uri.hostname}", :green)
+      when Net::HTTPUnauthorized
+        log_message("unauthorized, ensure you add app_secret on config file")
+      when Net::HTTPBadRequest
+        log_message("bad request")
+      when HTTPServerError
+        log_message("server error")
+      else
+        log_message("something wrong")
+      end
+    end
+
+    def app_secret
+      ErrorReady.configuration.app_secret
+    end
+
+    def log_message(msg, color = :red)
+      Rails.logger.debug ActiveSupport::LogSubscriber.new.send(:color, "ErrorReady: #{msg}", color, true)
+    end
+
+    def uri
+      @uri ||= URI(ErrorReady.configuration.host)
+    end
+  end
+end

data/lib/error_ready/subscriber.rb

@@ -2,15 +2,15 @@ module ErrorReady
   class Subscriber
     def report(error, handled:, severity:, context:, source: nil)
       formatted_error = Formatter.new(
-        error: error, 
+        error: error,
         handled: handled,
         severity: severity,
-        context: context, 
+        context: context,
         source: source
       ).format
 
-      # Save to database
-      Database.new(formatted_error).call
+      # send Async
+      AsyncSender.new(formatted_error).call
     end
   end
 end

data/lib/error_ready/version.rb

@@ -1,3 +1,3 @@
 module ErrorReady
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/error_ready.rb

@@ -3,9 +3,27 @@ require "error_ready/engine"
 
 module ErrorReady
   autoload :Subscriber, "error_ready/subscriber"
-  autoload :RackMiddleware, "error_ready/rack_middleware"
-  autoload :Formatter, 'error_ready/formatter'
+  autoload :Formatter, "error_ready/formatter"
+  autoload :Configuration, "error_ready/configuration"
+
+  # middlewares
+  autoload :RackMiddleware, "error_ready/middlewares/rack_middleware"
 
   # notifiers
-  autoload :Database, "error_ready/notifiers/database"
+  autoload :SyncSender, "error_ready/notifiers/sync_sender"
+  autoload :AsyncSender, "error_ready/notifiers/async_sender"
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+
+    def root
+      File.dirname __dir__
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: error_ready
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Moses Gathuku
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-07 00:00:00.000000000 Z
+date: 2022-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,6 +24,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.0.4
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Description of ErrorReady.
 email:
 - mosesgathuku95@gmail.com
@@ -34,30 +76,13 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/assets/config/error_ready_manifest.js
-- app/assets/images/error_ready/showcase.png
-- app/assets/stylesheets/error_ready/application.css
-- app/controllers/error_ready/application_controller.rb
-- app/controllers/error_ready/problems_controller.rb
-- app/helpers/error_ready/application_helper.rb
-- app/helpers/error_ready/problems_helper.rb
-- app/jobs/error_ready/application_job.rb
-- app/mailers/error_ready/application_mailer.rb
-- app/models/error_ready/application_record.rb
-- app/models/error_ready/notice.rb
-- app/models/error_ready/problem.rb
-- app/views/error_ready/problems/_problem.html.erb
-- app/views/error_ready/problems/index.html.erb
-- app/views/error_ready/problems/show.html.erb
-- app/views/layouts/error_ready/application.html.erb
-- config/routes.rb
-- db/migrate/20221005120809_create_error_ready_problems.rb
-- db/migrate/20221005135120_create_error_ready_notices.rb
 - lib/error_ready.rb
+- lib/error_ready/configuration.rb
 - lib/error_ready/engine.rb
 - lib/error_ready/formatter.rb
-- lib/error_ready/notifiers/database.rb
-- lib/error_ready/rack_middleware.rb
+- lib/error_ready/middlewares/rack_middleware.rb
+- lib/error_ready/notifiers/async_sender.rb
+- lib/error_ready/notifiers/sync_sender.rb
 - lib/error_ready/subscriber.rb
 - lib/error_ready/version.rb
 - lib/tasks/error_ready_tasks.rake

data/app/assets/config/error_ready_manifest.js

@@ -1 +0,0 @@
-//= link_directory ../stylesheets/error_ready .css

data/app/assets/stylesheets/error_ready/application.css

@@ -1,15 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
- * files in this directory. Styles in this file should be added after the last require_* statement.
- * It is generally better to create a new file per style scope.
- *
- *= require_tree .
- *= require_self
- */

data/app/controllers/error_ready/application_controller.rb

@@ -1,4 +0,0 @@
-module ErrorReady
-  class ApplicationController < ActionController::Base
-  end
-end

data/app/controllers/error_ready/problems_controller.rb

@@ -1,26 +0,0 @@
-module ErrorReady
-  class ProblemsController < ApplicationController
-    before_action :set_problem, only: %i[ show destroy ]
-
-    # GET /problems
-    def index
-      @problems = Problem.latest_first
-    end
-
-    # GET /problems/1
-    def show
-    end
-
-    # DELETE /problems/1
-    def destroy
-      @problem.destroy
-      redirect_to problems_url, notice: "Problem was successfully destroyed."
-    end
-
-    private
-      # Use callbacks to share common setup or constraints between actions.
-      def set_problem
-        @problem = Problem.find(params[:id])
-      end
-  end
-end

data/app/helpers/error_ready/application_helper.rb

@@ -1,4 +0,0 @@
-module ErrorReady
-  module ApplicationHelper
-  end
-end

data/app/helpers/error_ready/problems_helper.rb

@@ -1,4 +0,0 @@
-module ErrorReady
-  module ProblemsHelper
-  end
-end

data/app/jobs/error_ready/application_job.rb

@@ -1,4 +0,0 @@
-module ErrorReady
-  class ApplicationJob < ActiveJob::Base
-  end
-end

data/app/mailers/error_ready/application_mailer.rb

@@ -1,6 +0,0 @@
-module ErrorReady
-  class ApplicationMailer < ActionMailer::Base
-    default from: "from@example.com"
-    layout "mailer"
-  end
-end

data/app/models/error_ready/application_record.rb

@@ -1,5 +0,0 @@
-module ErrorReady
-  class ApplicationRecord < ActiveRecord::Base
-    self.abstract_class = true
-  end
-end

data/app/models/error_ready/notice.rb

@@ -1,5 +0,0 @@
-module ErrorReady
-  class Notice < ApplicationRecord
-    belongs_to :problem, foreign_key: "error_ready_problem_id"
-  end
-end

data/app/models/error_ready/problem.rb

@@ -1,15 +0,0 @@
-module ErrorReady
-  class Problem < ApplicationRecord
-
-    has_many :notices, foreign_key: "error_ready_problem_id"
-
-    attribute :first_notice_at, :datetime, default: Time.current
-    attribute :last_notice_at, :datetime, default: Time.current
-    attribute :notices_count, :integer, default: 0
-
-    scope :resolved, -> { where.not(resolved_at: nil) }
-    scope :unresolved,  -> { where(resolved_at: nil) }
-    scope :latest_first, -> { order(last_notice_at: :desc)}
-
-  end
-end

data/app/views/error_ready/problems/_problem.html.erb

@@ -1,33 +0,0 @@
-   <li>
-      <%= link_to problem_path(problem), class:"block hover:bg-gray-50" do %>
-        <div class="flex items-center py-4 ">
-          <div class="min-w-0 flex-1 sm:flex sm:items-center sm:justify-between">
-            <div class="truncate">
-              <div class="flex text-sm">
-                <p class="truncate font-medium text-indigo-600"><%= problem.err_class %></p>
-                <p class="ml-1 flex-shrink-0 font-normal text-gray-500">in <%= problem.environment %></p>
-              </div>
-              <div class="mt-2">
-                <div class="flex items-center text-sm text-gray-500">
-                  <!-- Heroicon name: mini/calendar -->
-                  <svg class="mr-1.5 h-5 w-5 flex-shrink-0 text-gray-400" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20" fill="currentColor" aria-hidden="true">
-                    <path fill-rule="evenodd" d="M5.75 2a.75.75 0 01.75.75V4h7V2.75a.75.75 0 011.5 0V4h.25A2.75 2.75 0 0118 6.75v8.5A2.75 2.75 0 0115.25 18H4.75A2.75 2.75 0 012 15.25v-8.5A2.75 2.75 0 014.75 4H5V2.75A.75.75 0 015.75 2zm-1 5.5c-.69 0-1.25.56-1.25 1.25v6.5c0 .69.56 1.25 1.25 1.25h10.5c.69 0 1.25-.56 1.25-1.25v-6.5c0-.69-.56-1.25-1.25-1.25H4.75z" clip-rule="evenodd" />
-                  </svg>
-                  <p>
-                    Last notice on
-                    <time datetime="2020-01-07"><%= problem.last_notice_at %></time>
-                  </p>
-                </div>
-                <div class="mt-2">
-                  <span class="text-gray-700 text-sm truncate"><%= problem.message %></span>
-                </div>
-              </div>
-            </div>
-            
-          </div>
-          <div class="ml-5 flex-shrink-0 text-green-600">
-            <svg class="w-6 h-6" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M9 12l2 2 4-4m6 2a9 9 0 11-18 0 9 9 0 0118 0z"></path></svg>
-          </div>
-        </div>
-      <% end %>
-    </li>

data/app/views/error_ready/problems/index.html.erb

@@ -1,10 +0,0 @@
-<p style="color: green"><%= notice %></p>
-<div class="mt-3">
-  <h1 class="font-bold text-gray-700 leading-tight text-2xl">Problems</h1>
-
-  <div id="problems" class="mt-3">
-    <ul class="divide-y">
-     <%= render @problems %>
-    </ul>
-  </div>
-</div>

data/app/views/error_ready/problems/show.html.erb

@@ -1,28 +0,0 @@
-
-<div class="mt-6">
- <div class="flex justify-between items-center">
-    <span class="font-bold text-gray-700 text-xl"><%= @problem.err_class %></span>
-    <span class="bg-gray-200 rounded-md p-2 text-gray-800">Resolve</span>
- </div>
-
- <div>
-  <span class="block font-semibold">message:</span>
-  <%= @problem.message %>
- </div>
-
- <div class="mt-3">
-  <span class="font-semibold">Context:</span>
-  <% @problem.notices.first.context.each do |k,v| %>
-    <span class="block"><%= k.gsub('_', ' ').capitalize %>: <%= v %></span>
-  <% end %>
- </div>
-
- <div class="mt-3">
-  <span class="font-semibold">Backtrace:</span>
-  <div class="text-sm bg-gray-200 p-2">
-   <% @problem.notices.first.backtrace.each do |trace| %>
-   <span class="block"><%= trace %></span>
-   <% end %>
-  </div>
- </div>
-</div>

data/app/views/layouts/error_ready/application.html.erb

@@ -1,16 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>Error ready | <%= Rails.application.class.module_parent_name %></title>
-  <%= csrf_meta_tags %>
-  <%= csp_meta_tag %>
-
-  <%= stylesheet_link_tag    "error_ready/application", media: "all" %>
-  <script src="https://cdn.tailwindcss.com"></script>
-</head>
-<body class="min-h-screen">
-  <div class="mx-auto md:max-w-4xl">
-    <%= yield %>
-  </div>
-</body>
-</html>

data/config/routes.rb

@@ -1,3 +0,0 @@
-ErrorReady::Engine.routes.draw do
-  resources :problems
-end

data/db/migrate/20221005120809_create_error_ready_problems.rb

@@ -1,16 +0,0 @@
-class CreateErrorReadyProblems < ActiveRecord::Migration[7.0]
-  def change
-    create_table :error_ready_problems do |t|
-      t.text :message
-      t.string :err_class
-      t.string :environment
-      t.string :severity
-      t.datetime :first_notice_at
-      t.datetime :last_notice_at
-      t.integer :notices_count
-      t.datetime :resolved_at
-
-      t.timestamps
-    end
-  end
-end

data/db/migrate/20221005135120_create_error_ready_notices.rb

@@ -1,11 +0,0 @@
-class CreateErrorReadyNotices < ActiveRecord::Migration[7.0]
-  def change
-    create_table :error_ready_notices do |t|
-      t.references :error_ready_problem, null: false, foreign_key: true
-      t.json :backtrace
-      t.json :context
-
-      t.timestamps
-    end
-  end
-end

data/lib/error_ready/notifiers/database.rb

@@ -1,33 +0,0 @@
-module ErrorReady
-  class Database
-    def initialize(formatted_error)
-      @error = formatted_error
-    end
-    
-    def call
-      problem = ErrorReady::Problem.find_or_create_by(
-        message: @error[:message],
-        err_class: @error[:err_class],
-        environment: @error[:environment],
-        severity: @error[:severity]
-      )
-      
-      create_notice(problem)
-    end
-
-    def create_notice(problem)
-      ActiveRecord::Base.transaction do
-        ErrorReady::Notice.create(
-          problem: problem,
-          backtrace: @error[:backtrace],
-          context: @error[:context]
-        )
-
-        problem.update(
-          notices_count: problem.notices_count + 1,
-          last_notice_at: Time.current,
-        )
-      end
-    end
-  end
-end