Skip to content

Fixed rails_performance.enabled setting having no effect - #8205

Merged
david-yz-liu merged 2 commits into
MarkUsProject:masterfrom
david-yz-liu:fix-rails-performance-enabled-setting
Oct 4, 2026
Merged

david-yz-liu merged 2 commits into
MarkUsProject:masterfrom
david-yz-liu:fix-rails-performance-enabled-setting

Conversation

@david-yz-liu

@david-yz-liu david-yz-liu commented Oct 3, 2026 •

Copy link
Copy Markdown
Collaborator

Proposed Changes

Setting rails_performance.enabled: false in MarkUs's settings did not actually disable rails_performance.

config/initializers/rails_performance.rb set RailsPerformance.enabled inside an after_initialize hook. But the rails_performance engine reads RailsPerformance.enabled in its own initializers, which run before after_initialize and so always saw the gem's default (true). As a result, even with the setting disabled, the engine still inserted its request-tracing middleware (which records every request to Redis), started its resource monitor thread, and subscribed its metrics collector. Only the dashboard itself was effectively disabled (its controller actions are defined conditionally at class load time).

This PR sets RailsPerformance.enabled and RailsPerformance.duration in a config.before_initialize block in config/application.rb, which runs before any engine initializers regardless of initializer ordering. The remaining options (home_link, mount_at, redis) are only read at request time, so they stay in the existing initializer. duration is also now only applied when present, since it is optional in the settings schema.

Screenshots of your changes (if applicable)

Type of Change

(Write an X or a brief description next to the type or types that best describe your changes.)

Type Applies?
🚨 Breaking change (fix or feature that would cause existing functionality to change)
✨ New feature (non-breaking change that adds functionality)
🐛 Bug fix (non-breaking change that fixes an issue) X
🎨 User interface change (change to user interface; provide screenshots)
♻️ Refactoring (internal change to codebase, without changing functionality)
🚦 Test update (change that only adds or modifies tests)
📦 Dependency update (change that updates a dependency)
📖 Documentation update (change that updates documentation)
🔧 Internal (change that only affects developers or continuous integration)

Checklist

(Complete each of the following items for your pull request. Indicate that you have completed an item by changing the [ ] into a [x] in the raw text, or by clicking on the checkbox in the rendered description on GitHub.)

Before opening your pull request:

  • I have performed a self-review of my changes.
    • Check that all changed files included in this pull request are intentional changes.
    • Check that all changes are relevant to the purpose of this pull request, as described above.
  • I have added tests for my changes, if applicable.
    • This is required for all bug fixes and new features.
  • I have updated the project documentation, if applicable.
    • This is required for new features.
  • If this is my first contribution, I have added myself to the list of contributors.

After opening your pull request:

  • I have updated the project Changelog (this is required for all changes).
  • I have verified that the pre-commit.ci checks have passed.
  • I have verified that the CI tests have passed.
  • I have reviewed the test coverage changes reported by Coveralls.
  • I have requested a review from a project maintainer.

Questions and Comments

No automated test is included: the bug depends on what happens at application boot, before RSpec runs, so a spec would need to boot a separate Rails process with the setting overridden.

🤖 Generated with Claude Code

david-yz-liu and others added 2 commits October 3, 2026 19:52
RailsPerformance.enabled was set in an after_initialize hook, which runs
after the rails_performance engine's own initializers have already read
it (defaulting to true). As a result, setting rails_performance.enabled
to false did not prevent the engine's middleware and resource monitor
from being installed. Set enabled and duration in a before_initialize
hook instead, so the engine sees the configured values.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@coveralls

coveralls commented Oct 4, 2026 •

Copy link
Copy Markdown
Collaborator

Coverage Report for CI Build 37163188914

Coverage remained the same at 90.86%

Details

  • Coverage remained the same as the base build.
  • Patch coverage: 3 of 3 lines across 1 file are fully covered (100%).
  • No coverage regressions found.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

No coverage regressions found.


Coverage Stats

Coverage Status
Relevant Lines: 53366
Covered Lines: 49530
Line Coverage: 92.81%
Relevant Branches: 2545
Covered Branches: 1271
Branch Coverage: 49.94%
Branches in Coverage %: Yes
Coverage Strength: 127.0 hits per line

💛 - Coveralls

@david-yz-liu
david-yz-liu merged commit bb98ca7 into MarkUsProject:master Oct 4, 2026
8 checks passed
@david-yz-liu
david-yz-liu deleted the fix-rails-performance-enabled-setting branch October 4, 2026 00:16
@david-yz-liu david-yz-liu added this to the v2.10.5 milestone Oct 4, 2026
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.

2 participants