solid_errors 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef3e4cca2bd412b918d7b7c36b3e754d79fefbc06e754a54fd58d5b04ef02a79
-  data.tar.gz: 1ca69a12aa28386778c66d7cd9114c06d20fbce1f846bf78391cfcad6796ff63
+  metadata.gz: eb0e5daf78d8b51d88fd8e153e81c76cf7714fb622ab1257f32ae6e129e09114
+  data.tar.gz: 8ef8871cfa529fd24a008f0d6d9c013a741c412d731b103a4bc6e181515305c7
 SHA512:
-  metadata.gz: 1d5313d9fd88ce1d75bbd1faf09bd47bca8caaafd61ea7930f982e02b117957b11b077406c5c8109531d7d718a37ee344b136f9fbf483fe371271951ee137b55
-  data.tar.gz: cd5a876a317307109b4660e39b11be2e80b6fa2b7a5a33db00c3edac84bcf27d0a3dc777a2a3f49837411e4a3168483f2c57656bc18e6d24903d5106400a697c
+  metadata.gz: f20c5fda185ac458cdcabd3a7d451f049144fe570c0c5c3fa5594296a832e5f217199167bbc94abfa2d5a0e00915eb86e03bff674d999ab242108d5451194591
+  data.tar.gz: 969d7c226e9be6f9ab75ca98713ba241430fae9a6c713c7834034d37ae3076ecc65af2becef30b29cef52a74fab9b6aff8682d21d0a8d875d97433c96ed86dfd

data/README.md

@@ -49,7 +49,40 @@ After installing the gem, run the installer:
 $ rails generate solid_errors:install
 ```
 
-This will copy the required migration over to your app.
+This will create the `db/errors_schema.rb` file.
+
+You will then have to add the configuration for the errors database in `config/database.yml`. If you're using sqlite, it'll look something like this:
+
+```yaml
+production:
+  primary:
+    <<: *default
+    database: storage/production.sqlite3
+  errors:
+    <<: *default
+    database: storage/production_errors.sqlite3
+    migrations_paths: db/errors_migrate
+```
+
+...or if you're using MySQL/PostgreSQL/Trilogy:
+
+```yaml
+production:
+  primary: &primary_production
+    <<: *default
+    database: app_production
+    username: app
+    password: <%= ENV["APP_DATABASE_PASSWORD"] %>
+  errors:
+    <<: *primary_production
+    database: app_production_errors
+    migrations_paths: db/errors_migrate
+```
+
+> [!NOTE]
+> Calling `bin/rails solid_errors:install` will automatically add `config.solid_errors.connects_to = { database: { writing: :errors } }` to `config/environments/production.rb`, so no additional configuration is needed there (although you must make sure that you use the errors name in database.yml for this to match!). But if you want to use Solid Queue in a different environment (like staging or even development), you'll have to manually add that `config.solid_errors.connects_to` line to the respective environment file. And, as always, make sure that the name you're using for the database in `config/database.yml` matches the name you use in `config.solid_errors.connects_to`.
+
+Then run `db:prepare` in production to ensure the database is created and the schema is loaded.
 
 Then mount the engine in your `config/routes.rb` file:
 ```ruby

data/config/routes.rb

@@ -1,5 +1,5 @@
 SolidErrors::Engine.routes.draw do
-  get "/" => "errors#index", :as => :root
+  get "/", to: "errors#index", as: :root
 
   resources :errors, only: [:index, :show, :update, :destroy], path: ""
 end

data/lib/generators/solid_errors/install/USAGE

@@ -5,4 +5,4 @@ Example:
     bin/rails generate solid_errors:install
 
     This will perform the following:
-        Installs solid_errors migrations
+        Adds solid_errors db schema

data/lib/generators/solid_errors/install/install_generator.rb

@@ -1,32 +1,30 @@
 # frozen_string_literal: true
 
-require "rails/generators"
-require "rails/generators/active_record"
-
 module SolidErrors
   #
   # Rails generator used for setting up SolidErrors in a Rails application.
   # Run it with +bin/rails g solid_errors:install+ in your console.
   #
   class InstallGenerator < Rails::Generators::Base
-    include ActiveRecord::Generators::Migration
-
     source_root File.expand_path("templates", __dir__)
 
-    class_option :database, type: :string, aliases: %i[--db], desc: "The database for your migration. By default, the current environment's primary database is used."
-    class_option :skip_migrations, type: :boolean, default: nil, desc: "Skip migrations"
-
-    # Generates monolithic migration file that contains all database changes.
-    def create_migration_file
-      return if options[:skip_migrations]
-
-      migration_template "create_solid_errors_tables.rb.erb", File.join(db_migrate_path, "create_solid_errors_tables.rb")
+    def add_solid_errors_db_schema
+      template "db/errors_schema.rb"
     end
 
-    private
-
-    def migration_version
-      "[#{ActiveRecord::VERSION::STRING.to_f}]"
+    def configure_solid_errors
+      insert_into_file Pathname(destination_root).join("config/environments/production.rb"), after: /^([ \t]*).*?(?=\nend)$/ do
+        [
+          "",
+          '\1# Configure Solid Errors',
+          '\1config.solid_errors.connects_to = { database: { writing: :errors } }',
+          '\1config.solid_errors.send_emails = true',
+          '\1config.solid_errors.email_from = ""',
+          '\1config.solid_errors.email_to = ""',
+          '\1config.solid_errors.username = Rails.application.credentials.dig(:solid_errors, :username)',
+          '\1config.solid_errors.password = Rails.application.credentials.dig(:solid_errors, :password)',
+        ].join("\n")
+      end
     end
   end
 end

data/lib/generators/solid_errors/install/templates/errors_schema.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+ActiveRecord::Schema[7.1].define(version: 1) do
+  create_table "solid_errors", force: :cascade do |t|
+    t.text "exception_class", null: false
+    t.text "message", null: false
+    t.text "severity", null: false
+    t.text "source"
+    t.datetime "resolved_at"
+    t.string "fingerprint", limit: 64, null: false
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["fingerprint"], name: "index_solid_errors_on_fingerprint", unique: true
+    t.index ["resolved_at"], name: "index_solid_errors_on_resolved_at"
+  end
+
+  create_table "solid_errors_occurrences", force: :cascade do |t|
+    t.integer "error_id", null: false
+    t.text "backtrace"
+    t.json "context"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["error_id"], name: "index_solid_errors_occurrences_on_error_id"
+  end
+
+  add_foreign_key "solid_errors_occurrences", "solid_errors", column: "error_id"
+end

data/lib/solid_errors/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solid_errors
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Stephen Margheim
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-22 00:00:00.000000000 Z
+date: 2024-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -142,7 +142,7 @@ files:
 - config/routes.rb
 - lib/generators/solid_errors/install/USAGE
 - lib/generators/solid_errors/install/install_generator.rb
-- lib/generators/solid_errors/install/templates/create_solid_errors_tables.rb.erb
+- lib/generators/solid_errors/install/templates/errors_schema.rb
 - lib/solid_errors.rb
 - lib/solid_errors/engine.rb
 - lib/solid_errors/sanitizer.rb
@@ -169,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.17
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Database-backed Rails error subscriber

data/lib/generators/solid_errors/install/templates/create_solid_errors_tables.rb.erb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-class CreateSolidErrorsTables < ActiveRecord::Migration<%= migration_version %>
-  def change
-    create_table :solid_errors do |t|
-      t.text :exception_class, null: false
-      t.text :message, null: false
-      t.text :severity, null: false
-      t.text :source
-      t.datetime :resolved_at, index: true
-      t.string :fingerprint, null: false, limit: 64, index: { unique: true }
-
-      t.timestamps
-    end
-
-    create_table :solid_errors_occurrences do |t|
-      t.belongs_to :error, null: false, foreign_key: { to_table: :solid_errors }
-      t.text :backtrace
-      t.json :context
-
-      t.timestamps
-    end
-  end
-end