Change messaging #211
Merged
Change messaging #211
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
JaCoCo Code Coverage 77.75% ✅
Generated by 🚫 Danger |
|
I think these messages are a bit cryptic, however, I don't think including these extra parameters is that useful. It might be better to document common causes of this exception and link to it. |
Laimiux
reviewed
Jun 7, 2021
| @@ -101,7 +101,7 @@ internal class ScopedCallbacks private constructor( | |||
|
|
|||
| private fun ensureNotRunning() { | |||
| if (!enabled) { | |||
| throw java.lang.IllegalStateException("cannot call this callback $currentKey after evaluation finished.") | |||
| throw java.lang.IllegalStateException("cannot call this callback after evaluation finished. See https://instacart.github.io/formula/faq/#after-evaluation-finished") | |||
There was a problem hiding this comment.
Could we capitalize cannot?
Laimiux
reviewed
Jun 7, 2021
| @@ -42,7 +42,7 @@ class FormulaContextImpl<State> internal constructor( | |||
|
|
|||
| private fun ensureNotRunning() { | |||
| if (transitionCallback.running) { | |||
| throw IllegalStateException("cannot call this transition $transitionId after evaluation finished.") | |||
| throw IllegalStateException("cannot call this transition after evaluation finished. See https://instacart.github.io/formula/faq/#after-evaluation-finished") | |||
There was a problem hiding this comment.
Could we capitalize cannot?
Laimiux
reviewed
Jun 7, 2021
docs/faq.md
Outdated
| within the `evaluate` function itself, passing the data you might be using from the `onEvent` into | ||
| the `State` defined for that Formula. For example, instead of: | ||
| ``` | ||
| class RelatedSearchesFormula @Inject constructor( |
There was a problem hiding this comment.
The description is perfect, however, I think the example might be a bit too complicated and actually doesn't contain the context.callback usage. I wonder if we could use a simple task example, such as
RxStream.fromObservable { repo.fetchTask(input.taskId) }.onEvent { task ->
val renderModel = TaskDetailRenderModel(
title = task.title,
// Don't do: calling context.callback within "onEvent" will cause a crash described above
onDeleteSelected = context.callback {
...
}
)
transition(state.copy(task = renderModel))
}
|
@Laimiux updated, what do you think? |
Laimiux
approved these changes
Jun 7, 2021
Looks great, merged the PR! |
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.
Seeing the error message
cannot call this after evaluation finished.is a little unactionable and hard to tell where it is coming from or what it is referring to unless you look at the source of Formula. So, this should make it a little more clear.