From e5ccc008c71e2208191559e9e8a3a8f4a85485f3 Mon Sep 17 00:00:00 2001
From: Andrei Eres <eresav@me.com>
Date: Fri, 11 Oct 2024 13:51:35 +0200
Subject: [PATCH] Rename QueueEvent::StartWork (#6015)
# Description
When we send `QueueEvent::StartWork`, we have already completed the
execution. This may be a leftover of a previous logic change. Currently,
the name is misleading, so it would be better to rename it to
`FinishWork`.
https://github.com/paritytech/polkadot-sdk/blob/c52675efdc05e181ddcec72d3bd425dc0a89d622/polkadot/node/core/pvf/src/execute/queue.rs#L632-L646
https://github.com/paritytech/polkadot-sdk/blob/c52675efdc05e181ddcec72d3bd425dc0a89d622/polkadot/node/core/pvf/src/execute/queue.rs#L361-L363
Fixes https://github.com/paritytech/polkadot-sdk/issues/5910
## Integration
Shouldn't affect downstream projects.
---------
Co-authored-by: GitHub Action <action@github.com>
---
polkadot/node/core/pvf/src/execute/queue.rs | 6 +++---
prdoc/pr_6015.prdoc | 9 +++++++++
2 files changed, 12 insertions(+), 3 deletions(-)
create mode 100644 prdoc/pr_6015.prdoc
diff --git a/polkadot/node/core/pvf/src/execute/queue.rs b/polkadot/node/core/pvf/src/execute/queue.rs
index 096cec3501b..2ac5116912e 100644
--- a/polkadot/node/core/pvf/src/execute/queue.rs
+++ b/polkadot/node/core/pvf/src/execute/queue.rs
@@ -143,7 +143,7 @@ impl Workers {
enum QueueEvent {
Spawn(IdleWorker, WorkerHandle, ExecuteJob),
- StartWork(
+ FinishWork(
Worker,
Result<WorkerInterfaceResponse, WorkerInterfaceError>,
ArtifactId,
@@ -333,7 +333,7 @@ async fn handle_mux(queue: &mut Queue, event: QueueEvent) {
QueueEvent::Spawn(idle, handle, job) => {
handle_worker_spawned(queue, idle, handle, job);
},
- QueueEvent::StartWork(worker, outcome, artifact_id, result_tx) => {
+ QueueEvent::FinishWork(worker, outcome, artifact_id, result_tx) => {
handle_job_finish(queue, worker, outcome, artifact_id, result_tx).await;
},
}
@@ -615,7 +615,7 @@ fn assign(queue: &mut Queue, worker: Worker, job: ExecuteJob) {
job.pov,
)
.await;
- QueueEvent::StartWork(worker, result, job.artifact.id, job.result_tx)
+ QueueEvent::FinishWork(worker, result, job.artifact.id, job.result_tx)
}
.boxed(),
);
diff --git a/prdoc/pr_6015.prdoc b/prdoc/pr_6015.prdoc
new file mode 100644
index 00000000000..d5a7d1e18d5
--- /dev/null
+++ b/prdoc/pr_6015.prdoc
@@ -0,0 +1,9 @@
+title: Rename QueueEvent::StartWork
+doc:
+- audience: Node Dev
+ description: |-
+ When we send `QueueEvent::StartWork`, we have already completed the execution. Therefore, `QueueEvent::FinishWork` is a better match.
+
+crates:
+- name: polkadot-node-core-pvf
+ bump: patch
--
GitLab