Scala 2.13: Fix ReverseRouting exhaustive match compilation error #25360
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
The Play Framework has had reverse routing problems with match exhaustiveness before: playframework/playframework#465 Unfortunately the fix in that PR doesn't fix the compilation erros because Scala 2.13 cannot understand that this generated code does have an exhaustive match: https://gist.github.com/ioannakok/3dcf08ebffa4ebd7deb23aa1cda3f35b ``` [error] /Users/ioanna_kokkini/Projects/frontend/identity/conf/routes:23:1: match may not be exhaustive. [error] It would fail on the following input: (_, _) [error] GET /form/:formReference controllers.FormstackController.formstackForm(formReference: String, composer: Boolean = false) [error] /Users/ioanna_kokkini/Projects/frontend/applications/conf/routes:51:1: match may not be exhaustive. [error] It would fail on the following input: (_, _, _, _, _) [error] GET /embed/atom/:atomType/:id controllers.AtomPageController.render(atomType: String, id: String, isJsEnabled: Boolean = true, hasVerticalScrollbar: Boolean = false, inApp: Boolean = false) ``` One fix is to make sure that the routes are pointing to specific methods so that reverse routing doesn't try to pattern match on the parameters. We've introduced wrapper methods with different names so that the choice is explicit. We're removing the route /embed/atom/:atomType/inapp because it became obsolete in 2019: https://github.com/guardian/frontend/pull/21897/files#r941555632 We have verified that this endpoint is not called anymore: https://logs.gutools.co.uk/s/dotcom/goto/4f0cdb70-1801-11ed-b499-9b0038f50029 Co-authored-by: Roberto Tyley <roberto.tyley@guardian.co.uk>
rtyley
approved these changes
Aug 10, 2022
| def render( | ||
| atomType: String, | ||
| id: String, | ||
| isJsEnabled: Boolean, | ||
| hasVerticalScrollbar: Boolean, | ||
| inApp: Boolean, |
|
Seen on PROD (merged by @ioannakok 4 hours, 6 minutes and 25 seconds ago)
|
ioannakok
added a commit
that referenced
this pull request
Aug 11, 2022
…ions/conf/routes After this PR: #25360 this commit is making the same changes in `dev-build/conf/routes` to make `dev-build` compile as this is used for local development.
rtyley
added
the
Scala 2.13
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.
The Play Framework has had reverse routing problems with match exhaustiveness before: playframework/playframework#465
Unfortunately the fix in that PR doesn't fix the compilation errors because Scala 2.13 cannot understand that this generated code does have an exhaustive match: https://gist.github.com/ioannakok/3dcf08ebffa4ebd7deb23aa1cda3f35b
One fix is to make sure that the routes are pointing to specific methods so that reverse routing doesn't try to pattern match on the parameters. We've introduced wrapper methods with different names so that the choice is explicit.
We're removing the route
/embed/atom/:atomType/inappbecause it became obsolete in 2019: https://github.com/guardian/frontend/pull/21897/files#r941555632We have verified that this endpoint is not called anymore: https://logs.gutools.co.uk/s/dotcom/goto/4f0cdb70-1801-11ed-b499-9b0038f50029