Fix use of withFallback introduced when dropping Play 2.7
#451
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
This fixes #449, the problem with server startup that was released with play-secret-rotation v8.1.0.
rtyley
changed the title
withFallback made when dropping Play 2.7withFallback introduced when dropping Play 2.7
|
@rtyley has published a preview version of this PR with release workflow run #35, based on commit d1a385e: 8.2.1-PREVIEW.fix-dropping-play-27.2024-04-09T1528.d1a385ed Want to make another preview release?Click 'Run workflow' in the GitHub UI, specifying the fix-dropping-play-2.7 branch, or use the GitHub CLI command: gh workflow run release.yml --ref fix-dropping-play-2.7 Want to make a full release after this PR is merged?Click 'Run workflow' in the GitHub UI, leaving the branch as the default, or use the GitHub CLI command: gh workflow run release.yml |
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.
This fixes #449, the problem with server startup that was introduced by dropping Play 2.7 support in PR #446 and released with play-secret-rotation v8.1.0.
Dropping Play 2.7 support meant that we could use the
Configuration.withFallback()method introduced with Play 2.8 and playframework/playframework#9674, rather than the deprecated++method. However (as the documentation does say), the++andwithFallback()methods override in opposite directions -withFallback()means that the firstConfigurationis tried first, and the second config is tried second - which is opposite to how++works.I missed this, and so, in PR #446, failed to reverse the order of the arguments. This meant that when
play-secret-rotationwas actually in a Play server running in Production mode, the code would attempt to evaluate theplay.http.secret.keykey insuper.configuration(and blow up with an integrity test error), rather than get the trash value back thatConfiguration("play.http.secret.key" -> nonRotatingSecretOnlyUsedToSatisfyConfigChecks)supplied - only To Satisfy Config Checks.Reversing the order of the arguments makes the hack work as intended, and the server can start up again 👍 ✨
It would be lovely to avoid such hackage, but that will require a resolution for playframework/playframework#12520!
Testing
This has been tried out with https://github.com/guardian/ophan/pull/6005, which demonstrated that the change fixes the problem.