feat: add a bench macro to canbench.
#178
Merged
Conversation
This file contains hidden or 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
1. `canbench` now by default stores results in `canbench_results.yml`. This is a reasonable default and helps simplify the tool's configuration. 2. Rename `benchmark-canisters` to `benchmarks`. 3. Move the benchmarking CI script into .github/workflows. 4. Cleanup dependencies and features in cargo
To more properly organize the benchmarking logic, the code is split into two distinct crates: 1. `canbench-bin`: this is for the `canbench` binary that's used to run the benchmarks, and is agnostic to the language the canister is written in. 2. `canbench-rs`: a rust library for rust canister developers to use write benchmarks and add some profiling logic. With this distinction, it'll be easier to support benchmarking canisters written in other languages such Motoko or TypeScript.
Rather than declaring benchmarks as queries on a canister, we now introduce a special `#[bench]` macro, which offers the following pros: 1. It validates that the benchmark has no parameters. 2. It validates that the benchmark returns a `BenchResult` 3. It namespaces the benchmark with the prefix `__canbench__`. This is particularly useful if a benchmark is added to a production canister, then `canbench` can distinguish which queries are benchmarks.
AlexandraZapuc
approved these changes
Jan 19, 2024
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.
Rather than declaring benchmarks as queries on a canister, we now introduce a special
#[bench]macro, which offers the following pros:BenchResult__canbench__. This is particularly useful if a benchmark is added to a production canister, thencanbenchcan distinguish which queries are benchmarks.