Replace task run() return result with custom enum
#2429
Conversation
| @@ -137,8 +138,7 @@ impl RunnableService for SyncTask { | |||
|
|
|||
| #[async_trait::async_trait] | |||
| impl RunnableTask for SyncTask { | |||
| #[tracing::instrument(level = "debug", skip_all, err, ret)] | |||
There was a problem hiding this comment.
Had to remove this from a couple locations since the instrument macro assumes the function returns Result
| @@ -196,11 +197,15 @@ impl RunnableService for GraphqlService { | |||
|
|
|||
| #[async_trait::async_trait] | |||
| impl RunnableTask for Task { | |||
| async fn run(&mut self, _: &mut StateWatcher) -> anyhow::Result<bool> { | |||
| self.server.as_mut().await?; | |||
There was a problem hiding this comment.
This change introduces a non-trivial amount of noise with the removal of the ? operators.
AFAICT, there isn't a way to implement Try for arbitrary types in Rust which is a real bummer.
MitchTurner
requested review from
AurelienFT,
xgreenx and
Dentosal
as code owners
| } | ||
| } | ||
| } | ||
| should_continue = true; | ||
| } | ||
| } | ||
|
|
||
| Ok(should_continue) | ||
| TaskRunResult::should_continue(should_continue) |
There was a problem hiding this comment.
I though the idea was to remove should_continue variable and replace with the usage of the enum=D
| let da_block_costs = self.source.request_da_block_cost().await?; | ||
| self.shared_state.0.send(da_block_costs)?; | ||
| continue_running = true; | ||
| match self.source.request_da_block_cost().await.and_then(|da_block_costs| self.shared_state.0.send(da_block_costs).map_err(|err| anyhow::anyhow!(err))) { |
There was a problem hiding this comment.
It is very hard to read, maybe we could it inside of the function and process the result of the function?=)
| let block = match l2_block_res { | ||
| Ok(block) => block, | ||
| Err(err) => { | ||
| return anyhow!(err).into() | ||
| } | ||
| }; |
There was a problem hiding this comment.
I see this pattern in many places. Maybe it would be simpler to defined a helper trait with into_continue_task_result which either returns TaskRunResult::Continue or TaskRunResult::ErrorContinue
Linked Issues/PRs
N/A
Description
Before any
RunnableTaskwould return aResult<bool>where, implicitly, theboolwas telling the service runner if it should re-run the task.This is confusing from the customer perspective since you need to understand the behavior of
ServiceRunnerin order to choose the right response: i.e.Ok(true)meant you want to rerun. Instead this PR adds theContinueandStopvariants.It was also confusing with
Errorsince, unintuitively, anErrorwould result in the task being run again. This PR adds theErrorContinuevariant, so the implementer know explicitly what the behavior is.Checklist
Before requesting review
After merging, notify other teams
[Add or remove entries as needed]