Pass more detailed visit errors to apps to avoid ambiguity #317
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
… error information and pass to apps
jayohms
commented
Feb 26, 2024
mbarta
approved these changes
Feb 27, 2024
turbo/src/main/kotlin/dev/hotwire/turbo/visit/TurboVisitError.kt
Outdated
Show resolved
Hide resolved
mbarta
reviewed
Feb 28, 2024
turbo/src/main/kotlin/dev/hotwire/turbo/visit/TurboVisitErrorType.kt
Outdated
Show resolved
Hide resolved
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 resolves error ambiguity issues outlined in #242
Instead of simply passing an
errorCodewhen visits fail, a newTurboVisitError(sealed interface) is passed with one of the following error types:WebError: representsWebViewerrors mapped fromandroidx.webkit.WebViewClientCompatWebSslError: represents SSL errors mapped fromandroid.net.http.SslErrorHttpError: represents HTTP status code error returned from the serverLoadError: represents custom load errors whenturbo.jsfails to load on the pageThis is a minor breaking API change if an app has implemented a custom error view, but the fix is trivial and worth the trade-off. By encapsulating the errors in a custom sealed interface, it allows for future flexibility (without further breaking API changes) if we want to pass along more granular data along with errors, such as helpful descriptions for error views, or add new error types.