[TaskCenter][5/n] Introduces restate_core::test macro #2352
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 was referenced Nov 22, 2024
Test Results 5 files - 2 5 suites - 2 1m 50s ⏱️ - 2m 40s Results for commit 058539c. ± Comparison against base commit c19fcdf. This pull request removes 2 tests.♻️ This comment has been updated with latest results. |
This was referenced Nov 22, 2024
AhmedSoliman
force-pushed
the
pr2352
branch
2 times, most recently
from
976c909
to
5b387d9
Compare
AhmedSoliman
changed the title
tillrohrmann
approved these changes
Nov 25, 2024
Comment on lines
+978
to
979
| // questionable. | ||
| RocksDbManager::get().shutdown().await; |
There was a problem hiding this comment.
Out of scope: Why are we shutting the db manager in some test cases down and others not?
There was a problem hiding this comment.
In thoery, we should shutdown on every test that init()s rocksdb, but I think historically we only added the shutdown to tests that triggered segfaults on CI
crates/core/derive/src/tc_test.rs
Outdated
| // the Business Source License, use of this software will be governed | ||
| // by the Apache License, Version 2.0. | ||
|
|
||
| //! Some parts of this codebase were taken from https://github.com/tokio-rs/tokio/blob/master/tokio-macros/src/entry.rs |
There was a problem hiding this comment.
Should we put the exact commit they were taken from instead of master?
- Adds `in_tc(&TaskCenter)` and `in_current_tc()` to scope a future to run in a task-center if it'll be dispatched as a task - Introduces a root task (TaskId(0)) in TaskCenter that's used as a default parent/source of task context - Removes unnecessary args from block_on, run_in_scope_sync. (some of those will be changed in future PRs) - Introduces `Metadata::current()` and `Metadata::with_current(F)`
- Improvements to the future extensions (fixing root task context propagation)
- A round of removals of explicit task-center reference passing
- `try_set_global_metadata` is now an associated function
## Example
Before:
```rust
task_center().spawn_child(
TaskKind::RpcServer,
"metadata-store-grpc",
None,
async move {
net_util::run_hyper_server(
&bind_address,
service,
"metadata-store-grpc",
|| health_status.update(MetadataServerStatus::Ready),
|| health_status.update(MetadataServerStatus::Unknown),
)
.await?;
Ok(())
},
)?;
```
After:
```rust
TaskCenter::spawn_child(TaskKind::RpcServer, "metadata-store-grpc", async move {
net_util::run_hyper_server(
&bind_address,
service,
"metadata-store-grpc",
|| health_status.update(MetadataServerStatus::Ready),
|| health_status.update(MetadataServerStatus::Unknown),
)
.await?;
Ok(())
})?;
```
Also, exercises `in_tc()` in some tests. Those will be swapped with `restate_core::test` in next PRs.
Example of impact:
```rust
let bifrost = node_env
.tc
.run_in_scope(
"bifrost init",
None,
Bifrost::init_in_memory(node_env.metadata.clone()),
)
.await;
```
Becomes:
```rust
let bifrost = Bifrost::init_in_memory().in_tc(&node_env.tc).await;
```
Introduces a new macro that creates a default TaskCenter in tests. This should replace usage of `tokio::test` (the code is mostly based on it) and it provides access to `TaskCenter::current()` within the test code. This also introduces a transitional type `TestCoreEnv2`, a clone of `TestCoreEnv` but without TaskCenter. After migration, this will be renamed to `TestCoreEnv` again.
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.
Introduces a new macro that creates a default TaskCenter in tests. This should replace usage of
tokio::test(the code is mostly based on it) and it provides access toTaskCenter::current()within the test code.This also introduces a transitional type
TestCoreEnv2, a clone ofTestCoreEnvbut without TaskCenter. After migration, this will be renamed toTestCoreEnvagain.Stack created with Sapling. Best reviewed with ReviewStack.