Skip to content

Audit Rails error reporting API integration points#1141

Open
kitcommerce wants to merge 1 commit intonextfrom
wa-verify-114-error-reporting-api-audit
Open

Audit Rails error reporting API integration points#1141
kitcommerce wants to merge 1 commit intonextfrom
wa-verify-114-error-reporting-api-audit

Conversation

@kitcommerce
Copy link
Contributor

Summary

  • audit Workarea's Rails 7.1 error reporting integration points and document the compatibility result
  • add a focused Workarea::ErrorReporting test covering forwarding, Rails-API absence, and reporter failure swallowing
  • update the migration note with the audited touchpoints and explicit compatibility/client-impact guidance

Findings

  • Core Workarea only touches Rails 7.1 error reporting through Workarea::ErrorReporting, an availability-guarded wrapper around Rails.error.report
  • The wrapper is currently used only for handled exceptions in LatestVersion, PingHomeBase, and Checkout::Fraud::Analyzer
  • Storefront 500 handling still exposes request.env['rack.exception'], so Rack/middleware-based reporters continue to work unchanged
  • No core ActiveSupport::ErrorReporter subscribers, provider-specific integrations, or downstream extension-point breaks were found

Client impact

  • None expected. Host apps and plugins can keep their existing reporting setup; config.error_reporter adoption remains additive and optional.

Verification

  • searched the repo for Rails.error, ActiveSupport::ErrorReporter, error_reporter, reporter, and related exception-reporting hooks
  • reviewed the concrete integration points in:
    • core/lib/workarea/error_reporting.rb
    • core/lib/workarea/latest_version.rb
    • core/lib/workarea/ping_home_base.rb
    • core/app/models/workarea/checkout/fraud/analyzer.rb
    • storefront/app/controllers/workarea/storefront/errors_controller.rb
  • added core/test/lib/workarea/error_reporting_test.rb for the wrapper behavior audit coverage
  • ran ruby -c core/lib/workarea/error_reporting.rb
  • ran ruby -c core/test/lib/workarea/error_reporting_test.rb
  • attempted to run targeted bundled tests, but the repo's existing gemspec declaration (s.required_ruby_version = '>= 2.7.0, < 3.5.0') is currently rejected by the local Bundler/RubyGems environment before the test suite boots

Refs #1138

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant