From afeef5fedf21f3d0e899d8213fcc6507c8a49476 Mon Sep 17 00:00:00 2001 From: David Cook Date: Thu, 14 Sep 2023 16:29:42 -0500 Subject: [PATCH] Update comments about aggregation job steps --- aggregator/src/aggregator/aggregation_job_continue.rs | 5 ++--- aggregator_core/src/datastore/models.rs | 4 ++-- db/00000000000001_initial_schema.up.sql | 2 +- messages/src/lib.rs | 2 +- 4 files changed, 6 insertions(+), 7 deletions(-) diff --git a/aggregator/src/aggregator/aggregation_job_continue.rs b/aggregator/src/aggregator/aggregation_job_continue.rs index 3fb8b53ac..284b776cc 100644 --- a/aggregator/src/aggregator/aggregation_job_continue.rs +++ b/aggregator/src/aggregator/aggregation_job_continue.rs @@ -28,9 +28,8 @@ use tokio::try_join; use tracing::trace_span; impl VdafOps { - /// Step the helper's aggregation job to the next step of VDAF preparation using the step `n` - /// prepare state in `report_aggregations` with the step `n+1` broadcast prepare messages in - /// `leader_aggregation_job`. + /// Step the helper's aggregation job to the next step using the step `n` ping pong state in + /// `report_aggregations` with the step `n+1` ping pong messages in `leader_aggregation_job`. pub(super) async fn step_aggregation_job( tx: &Transaction<'_, C>, task: Arc, diff --git a/aggregator_core/src/datastore/models.rs b/aggregator_core/src/datastore/models.rs index a1bb8267d..21994c369 100644 --- a/aggregator_core/src/datastore/models.rs +++ b/aggregator_core/src/datastore/models.rs @@ -306,13 +306,13 @@ impl> AggregationJob { state, ..self } } - /// Returns the step of the VDAF preparation protocol the aggregation job is on. + /// Returns the step the aggregation job is on. pub fn step(&self) -> AggregationJobStep { self.step } /// Returns a new [`AggregationJob`] corresponding to this aggregation job updated to be on - /// the given VDAF preparation step. + /// the given step. pub fn with_step(self, step: AggregationJobStep) -> Self { Self { step, ..self } } diff --git a/db/00000000000001_initial_schema.up.sql b/db/00000000000001_initial_schema.up.sql index f744ed8a1..86b1eca07 100644 --- a/db/00000000000001_initial_schema.up.sql +++ b/db/00000000000001_initial_schema.up.sql @@ -173,7 +173,7 @@ CREATE TABLE aggregation_jobs( batch_id BYTEA NOT NULL, -- batch ID (fixed-size only; corresponds to identifier in BatchSelector) client_timestamp_interval TSRANGE NOT NULL, -- the minimal interval containing all of client timestamps included in this aggregation job state AGGREGATION_JOB_STATE NOT NULL, -- current state of the aggregation job - step INTEGER NOT NULL, -- current step of the VDAF preparation protocol + step INTEGER NOT NULL, -- current step of the aggregation job last_request_hash BYTEA, -- SHA-256 hash of the most recently received AggregationJobContinueReq (helper only) trace_context JSONB, -- distributed tracing metadata diff --git a/messages/src/lib.rs b/messages/src/lib.rs index 4500d44f5..e1db09239 100644 --- a/messages/src/lib.rs +++ b/messages/src/lib.rs @@ -2559,7 +2559,7 @@ impl AggregationJobContinueReq { } } - /// Gets the step of VDAF preparation this aggregation job is on. + /// Gets the step this aggregation job is on. pub fn step(&self) -> AggregationJobStep { self.step }