Fix loading gem due missing PrometheusExporter constant #224
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a bug were the prometheus_exporter gem was incorrectly required by the module. It was unable to find the top level module name "PrometheusExporter" and need to be explicity required.
This delays the require of prometheus_exporter until the configure method is called. This prevents the library from being required by apps the don't need it.
The initialiser modules loads middleware into Rack and explicity depends on Rails being present.
marcpomfret
approved these changes
Mar 4, 2022
kevindew
added a commit
to alphagov/manuals-publisher
that referenced
this pull request
Mar 7, 2022
This resolves the build errors for version 4.4.0. See: alphagov/govuk_app_config#224
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix issue where GovukPrometheusExporter module prevented the gem to load due to missing constant. It was unable to find the top level module name "PrometheusExporter" and need to be explicity required.
Lazy load the prometheus_exporter dependency for only apps that use GovukPrometheusExporter. This prevents the library from being required by apps the don't need it.
Load GovukPrometheusExporter only for Rails apps, as it loads middleware into Rack and explicitly depends on Rails being present.