Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace "round" with "step" #1922

Merged
merged 2 commits into from
Sep 14, 2023
Merged

Replace "round" with "step" #1922

merged 2 commits into from
Sep 14, 2023

Conversation

tgeoghegan
Copy link
Contributor

@tgeoghegan tgeoghegan commented Sep 13, 2023

When DAP-05 introduced the ping-pong topology, it also started talking about aggregation protocol "steps" instead of "rounds". This commit corrects the word usage across Janus to line up with the specification.

This change is pretty pedantic, but I think it's worth it for readers trying to resolve Janus against the DAP specification.

Relevant to #1669

@tgeoghegan tgeoghegan requested a review from a team as a code owner September 13, 2023 23:53
@tgeoghegan tgeoghegan added the allow-changed-migrations Override the ci-migrations check to allow migrations that have changed. label Sep 13, 2023
Base automatically changed from timg/dap-05-errors to main September 14, 2023 00:34
When DAP-05 introduced the ping-pong topology, it also started talking
about aggregation protocol "steps" instead of "rounds". This commit
corrects the word usage across Janus to line up with the specification.

Relevant to #1669
Copy link
Contributor

@inahga inahga left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not pedantic at all, round meaning step is not obvious, bound to confuse future us or newcomers if not changed.

Uber nit: on messages/src/lib.rs:4565 the comment is // round. (Sorry, I don't think github lets you make a suggestion for code that isn't touched in a PR).

@tgeoghegan tgeoghegan enabled auto-merge (squash) September 14, 2023 19:25
@@ -448,7 +448,7 @@ async fn aggregation_job_mutation_report_aggregations() {
}

#[tokio::test]
async fn aggregation_job_init_two_round_vdaf_idempotence() {
async fn aggregation_job_init_two_step_vdaf_idempotence() {
Copy link
Collaborator

@divergentdave divergentdave Sep 14, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should probably keep this as-is. Poplar1 is two rounds, so this will still take one DAP step, just testing different code paths.

Suggested change
async fn aggregation_job_init_two_step_vdaf_idempotence() {
async fn aggregation_job_init_two_round_vdaf_idempotence() {

Edit: nevermind, I got the conversion from rounds to steps wrong.

@tgeoghegan tgeoghegan merged commit ae56c00 into main Sep 14, 2023
7 checks passed
@tgeoghegan tgeoghegan deleted the timg/round-to-step branch September 14, 2023 20:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
allow-changed-migrations Override the ci-migrations check to allow migrations that have changed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants