rails_error_dashboard 0.11.6 → 0.11.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31b48d634cb3ef3737bfc4744993cd315deec8555bc6a0a7da55d6a3e3b011d5
-  data.tar.gz: 32fbeecb52dcbb0b48bf3f10f9fcc6da854ac20e0f1236a8fe0d37d1a3288475
+  metadata.gz: d8f2e404fb451057a68a9210eaf1035282a061b1e9cdf1ad22f9831d6c85974a
+  data.tar.gz: cd2feb750eb08095785468bdaef7cc5968e197482f735f7b529d971029a12223
 SHA512:
-  metadata.gz: 76346c5b3c5b5ba64e272d27024dc29a4635eca2024458a10b1eff9b0a842dd5cb96bbd671566d59ce3b53f44d5ca7d61250f4f620f6b4e0e4212f09d2c884d4
-  data.tar.gz: e9fcc3afb33b3d550c830453e1d8e1325081e6f182103975855dc337c56ea1735fbfccc3879b8af35cb1fdb119eb925ccff5b516108a2eb9d3eb300ff5094e8f
+  metadata.gz: 5d320b2ab1fa0d4ff60f469d1cc895c52c78645c217a85baf776438b116fdac046b6c9c96645bfea7fb0d6874f0a139028613cecf9d5b7891ef8efa786323888
+  data.tar.gz: 82edc71f3850c9d75d8e40afdf9839ad79446537f4334c6c998acce167dcf7ffeccc4863b89f8165263cf4468ce9cba948d802eb9085fa3c6414d046095013a1

data/db/migrate/20260325000001_fix_swallowed_exceptions_index_for_mysql.rb

@@ -38,6 +38,13 @@ class FixSwallowedExceptionsIndexForMysql < ActiveRecord::Migration[7.0]
 
   def down
     return unless table_exists?(:rails_error_dashboard_swallowed_exceptions)
+    # The pre-migration shape (500-char locations under a five-column unique
+    # index) is exactly what MySQL cannot create — that is why this migration
+    # exists — so there is nothing valid to roll back to there.
+    if connection.adapter_name.match?(/mysql|trilogy/i)
+      raise ActiveRecord::IrreversibleMigration,
+            "the previous swallowed_exceptions index exceeds MySQL's 3072-byte key limit; this migration cannot be reversed on MySQL"
+    end
 
     if index_name_exists?(:rails_error_dashboard_swallowed_exceptions, "index_swallowed_exceptions_upsert_key")
       remove_index :rails_error_dashboard_swallowed_exceptions, name: "index_swallowed_exceptions_upsert_key"

data/db/migrate/20260908220001_add_missing_postgresql_indexes_to_error_logs.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# Fresh PostgreSQL installs never got two indexes the query layer was written
+# for: 20251225071314_add_optimized_indexes_to_error_logs returns early once
+# its composite indexes exist, and the squashed first migration creates those
+# composites but not the PostgreSQL-only partial index on unresolved rows or
+# the GIN index behind full-text message search. Existing installs that ran
+# the incremental chain have them; this adds them wherever they are missing.
+# No-op on other adapters.
+class AddMissingPostgresqlIndexesToErrorLogs < ActiveRecord::Migration[7.0]
+  TABLE = :rails_error_dashboard_error_logs
+
+  def up
+    return unless postgresql?
+    return unless table_exists?(TABLE)
+
+    unless index_name_exists?(TABLE, "index_error_logs_on_occurred_at_unresolved")
+      add_index TABLE, :occurred_at, where: "resolved = false",
+                name: "index_error_logs_on_occurred_at_unresolved"
+    end
+
+    execute <<-SQL
+      CREATE INDEX IF NOT EXISTS index_error_logs_on_message_gin
+      ON rails_error_dashboard_error_logs
+      USING gin(to_tsvector('english', message))
+    SQL
+  end
+
+  def down
+    return unless postgresql?
+    return unless table_exists?(TABLE)
+
+    remove_index TABLE, name: "index_error_logs_on_occurred_at_unresolved", if_exists: true
+    execute "DROP INDEX IF EXISTS index_error_logs_on_message_gin"
+  end
+
+  private
+
+  def postgresql?
+    connection.adapter_name.downcase == "postgresql"
+  end
+end

data/db/migrate/20260909000001_replace_message_gin_with_searchable_text_index.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+# The dashboard's PostgreSQL full-text search (Queries::ErrorsList#filter_by_search)
+# matches against message, backtrace and error_type together:
+#
+#   to_tsvector('english', COALESCE(message, '') || ' ' || COALESCE(backtrace, '') || ' ' || COALESCE(error_type, ''))
+#
+# PostgreSQL uses an expression index only when the query's expression is
+# identical to the index's, so of the two GIN indexes defined over time only
+# one can serve that search:
+#
+#   index_error_logs_on_message_gin       to_tsvector('english', message)              never used by any query
+#   index_error_logs_on_searchable_text   the expression above                          the one the search needs
+#
+# Which of them a host has depends on how it was installed. Hosts that ran the
+# incremental chain got both; hosts installed from the squashed first migration
+# got neither (the later index migrations skip themselves once the squash's
+# composite indexes exist), and 0.11.7 then added only the message-only one.
+#
+# This converges every install on index_error_logs_on_searchable_text alone.
+# No-op on other adapters.
+class ReplaceMessageGinWithSearchableTextIndex < ActiveRecord::Migration[7.0]
+  TABLE = :rails_error_dashboard_error_logs
+
+  def up
+    return unless postgresql?
+    return unless table_exists?(TABLE)
+
+    execute <<~SQL
+      CREATE INDEX IF NOT EXISTS index_error_logs_on_searchable_text
+      ON rails_error_dashboard_error_logs
+      USING gin(to_tsvector('english',
+        COALESCE(message, '') || ' ' || COALESCE(backtrace, '') || ' ' || COALESCE(error_type, '')
+      ))
+    SQL
+
+    execute "DROP INDEX IF EXISTS index_error_logs_on_message_gin"
+  end
+
+  def down
+    return unless postgresql?
+
+    # There is no single state to return to: before this migration a host had
+    # either both indexes or only the message-only one, depending on its
+    # install path. Dropping searchable_text here would take away, on
+    # incremental-chain hosts, an index they had before, and nothing needs
+    # message_gin back. Earlier gem versions run unchanged against the
+    # converged schema.
+    raise ActiveRecord::IrreversibleMigration,
+          "this migration converges two index layouts (see its header); the previous layout is not recoverable"
+  end
+
+  private
+
+  def postgresql?
+    connection.adapter_name.downcase == "postgresql"
+  end
+end

data/lib/rails_error_dashboard/version.rb

@@ -1,3 +1,3 @@
 module RailsErrorDashboard
-  VERSION = "0.11.6"
+  VERSION = "0.11.8"
 end

data/lib/tasks/error_dashboard.rake

@@ -52,6 +52,30 @@ namespace :error_dashboard do
       checks_failed += 1
     end
 
+    # 3b. MySQL only: named-zone conversion needs the server's time zone
+    # tables; without them groupdate (charts, baselines) raises.
+    begin
+      conn = RailsErrorDashboard::ErrorLogsRecord.connection
+      if conn.adapter_name.match?(/mysql|trilogy/i)
+        print "  MySQL time zone tables... "
+        zone = (Time.zone || ActiveSupport::TimeZone["UTC"]).tzinfo.name
+        converted = conn.select_value("SELECT CONVERT_TZ(NOW(), '+00:00', #{conn.quote(zone)})")
+        if converted.nil?
+          puts "MISSING"
+          puts "    CONVERT_TZ to '#{zone}' returned NULL: the server has no time zone tables,"
+          puts "    so the dashboard's time-bucketed charts and baselines will raise."
+          puts "    Fix (on the MySQL server): mysql_tzinfo_to_sql /usr/share/zoneinfo | mysql -u root mysql"
+          puts "    See docs/guides/DATABASE_OPTIONS.md (MySQL)."
+          warnings += 1
+        else
+          puts "OK (#{zone})"
+          checks_passed += 1
+        end
+      end
+    rescue => e
+      puts "SKIPPED (#{e.message.truncate(60)})"
+    end
+
     # 4. Tables check
     print "  Required tables... "
     required_tables = %w[

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_error_dashboard
 version: !ruby/object:Gem::Version
-  version: 0.11.6
+  version: 0.11.8
 platform: ruby
 authors:
 - Anjan Jagirdar
@@ -409,6 +409,8 @@ files:
 - db/migrate/20260824000001_add_user_agent_to_rack_attack_events.rb
 - db/migrate/20260826000001_add_environment_to_error_logs.rb
 - db/migrate/20260908000001_add_release_to_error_occurrences.rb
+- db/migrate/20260908220001_add_missing_postgresql_indexes_to_error_logs.rb
+- db/migrate/20260909000001_replace_message_gin_with_searchable_text_index.rb
 - lib/generators/rails_error_dashboard/install/install_generator.rb
 - lib/generators/rails_error_dashboard/install/templates/README
 - lib/generators/rails_error_dashboard/install/templates/initializer.rb
@@ -577,7 +579,7 @@ metadata:
   funding_uri: https://github.com/sponsors/AnjanJ
 post_install_message: |
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
-    RED (Rails Error Dashboard) v0.11.6
+    RED (Rails Error Dashboard) v0.11.8
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
   First install: