Core SDK that can be used as a base for all other Temporal SDKs.
See the Architecture doc for some high-level information.
This repo uses a subtree for upstream protobuf files. The path protos/api_upstream is a
subtree. To update it, use:
git subtree pull --prefix protos/api_upstream/ git://github.com/temporalio/api.git master --squash
- Protobuf compiler
All of the following commands are enforced for each pull request.
You can buld and test the project using cargo:
cargo build
cargo test
Run integ tests with cargo integ-test. You will need to already be running the server:
docker-compose -f .buildkite/docker/docker-compose.yaml up
To format all code run:
cargo fmt --all
We are using clippy for linting.
You can run it using:
cargo clippy --all -- -D warnings
The crate uses tracing to help with debugging. To enable it for a test, insert the below snippet at the start of the test. By default, tracing data is output to stdout in a (reasonably) pretty manner.
crate::telemetry::telemetry_init(Default::default());
let s = info_span!("Test start");
let _enter = s.enter();The passed in options to initialization can be customized to export to an OTel collector, etc.
To run integ tests with OTel collection on, you can use integ-with-otel.sh. You will want to make
sure you are running the collector via docker, which can be done like so:
docker-compose -f .buildkite/docker/docker-compose.yaml -f .buildkite/docker/docker-compose-telem.yaml up
If you are working on a language SDK, you are expected to initialize tracing early in your main
equivalent.
Any error which is returned from a public interface should be well-typed, and we use thiserror for that purpose.
Errors returned from things only used in testing are free to use anyhow for less verbosity.