refactor(node-framework): use owned type to identify Tasks (matter-…

…labs#2124)

## What ❔

This PR refactors `Task`-related traits to use an owned type `TaskId`
instead of `&'static str`.

## Why ❔

There are use cases where a task's id needs to be generated dynamically
(e.g. broad trait implementations) which this PR accommodates for.

## Checklist

<!-- Check your PR fulfills the following items. -->
<!-- For draft PRs check the boxes as you complete them. -->

- [x] PR title corresponds to the body of PR (we generate changelog
entries from PRs).
- [ ] Tests for the changes have been added / updated.
- [x] Documentation comments have been added / updated.
- [x] Code has been formatted via `zk fmt` and `zk lint`.
- [x] Spellcheck has been run via `zk spellcheck`.

core/node/node_framework/examples/showcase.rs

@@ -10,7 +10,7 @@ use std::{
 use zksync_node_framework::{
     resource::Resource,
     service::{ServiceContext, StopReceiver, ZkStackServiceBuilder},
-    task::Task,
+    task::{Task, TaskId},
     wiring_layer::{WiringError, WiringLayer},
 };
 
@@ -96,14 +96,14 @@ impl PutTask {
 
 #[async_trait::async_trait]
 impl Task for PutTask {
-    fn name(&self) -> &'static str {
+    fn id(&self) -> TaskId {
         // Task names simply have to be unique. They are used for logging and debugging.
-        "put_task"
+        "put_task".into()
     }
 
     /// This method will be invoked by the framework when the task is started.
     async fn run(self: Box<Self>, mut stop_receiver: StopReceiver) -> anyhow::Result<()> {
-        tracing::info!("Starting the task {}", self.name());
+        tracing::info!("Starting the task {}", self.id());
 
         // We have to respect the stop receiver and should exit as soon as we receive
         // a stop signal.
@@ -138,12 +138,12 @@ impl CheckTask {
 
 #[async_trait::async_trait]
 impl Task for CheckTask {
-    fn name(&self) -> &'static str {
-        "check_task"
+    fn id(&self) -> TaskId {
+        "check_task".into()
     }
 
     async fn run(self: Box<Self>, mut stop_receiver: StopReceiver) -> anyhow::Result<()> {
-        tracing::info!("Starting the task {}", self.name());
+        tracing::info!("Starting the task {}", self.id());
 
         tokio::select! {
             _ = self.run_inner() => {},

core/node/node_framework/src/implementations/layers/circuit_breaker_checker.rs

@@ -4,7 +4,7 @@ use zksync_config::configs::chain::CircuitBreakerConfig;
 use crate::{
     implementations::resources::circuit_breakers::CircuitBreakersResource,
     service::{ServiceContext, StopReceiver},
-    task::UnconstrainedTask,
+    task::{TaskId, UnconstrainedTask},
     wiring_layer::{WiringError, WiringLayer},
 };
 
@@ -43,8 +43,8 @@ struct CircuitBreakerCheckerTask {
 
 #[async_trait::async_trait]
 impl UnconstrainedTask for CircuitBreakerCheckerTask {
-    fn name(&self) -> &'static str {
-        "circuit_breaker_checker"
+    fn id(&self) -> TaskId {
+        "circuit_breaker_checker".into()
     }
 
     async fn run_unconstrained(

core/node/node_framework/src/implementations/layers/commitment_generator.rs

@@ -7,7 +7,7 @@ use crate::{
         pools::{MasterPool, PoolResource},
     },
     service::{ServiceContext, StopReceiver},
-    task::Task,
+    task::{Task, TaskId},
     wiring_layer::{WiringError, WiringLayer},
 };
 
@@ -55,8 +55,8 @@ struct CommitmentGeneratorTask {
 
 #[async_trait::async_trait]
 impl Task for CommitmentGeneratorTask {
-    fn name(&self) -> &'static str {
-        "commitment_generator"
+    fn id(&self) -> TaskId {
+        "commitment_generator".into()
     }
 
     async fn run(self: Box<Self>, stop_receiver: StopReceiver) -> anyhow::Result<()> {

core/node/node_framework/src/implementations/layers/consensus.rs

@@ -14,7 +14,7 @@ use crate::{
         sync_state::SyncStateResource,
     },
     service::{ServiceContext, StopReceiver},
-    task::Task,
+    task::{Task, TaskId},
     wiring_layer::{WiringError, WiringLayer},
 };
 
@@ -110,8 +110,8 @@ pub struct MainNodeConsensusTask {
 
 #[async_trait::async_trait]
 impl Task for MainNodeConsensusTask {
-    fn name(&self) -> &'static str {
-        "consensus"
+    fn id(&self) -> TaskId {
+        "consensus".into()
     }
 
     async fn run(self: Box<Self>, mut stop_receiver: StopReceiver) -> anyhow::Result<()> {
@@ -147,8 +147,8 @@ pub struct FetcherTask {
 
 #[async_trait::async_trait]
 impl Task for FetcherTask {
-    fn name(&self) -> &'static str {
-        "consensus_fetcher"
+    fn id(&self) -> TaskId {
+        "consensus_fetcher".into()
     }
 
     async fn run(self: Box<Self>, mut stop_receiver: StopReceiver) -> anyhow::Result<()> {

core/node/node_framework/src/implementations/layers/consistency_checker.rs

@@ -8,7 +8,7 @@ use crate::{
         pools::{MasterPool, PoolResource},
     },
     service::{ServiceContext, StopReceiver},
-    task::Task,
+    task::{Task, TaskId},
     wiring_layer::{WiringError, WiringLayer},
 };
 
@@ -75,8 +75,8 @@ pub struct ConsistencyCheckerTask {
 
 #[async_trait::async_trait]
 impl Task for ConsistencyCheckerTask {
-    fn name(&self) -> &'static str {
-        "consistency_checker"
+    fn id(&self) -> TaskId {
+        "consistency_checker".into()
     }
 
     async fn run(self: Box<Self>, stop_receiver: StopReceiver) -> anyhow::Result<()> {

core/node/node_framework/src/implementations/layers/contract_verification_api.rs

@@ -4,7 +4,7 @@ use zksync_dal::{ConnectionPool, Core};
 use crate::{
     implementations::resources::pools::{MasterPool, PoolResource, ReplicaPool},
     service::{ServiceContext, StopReceiver},
-    task::Task,
+    task::{Task, TaskId},
     wiring_layer::{WiringError, WiringLayer},
 };
 
@@ -46,8 +46,8 @@ pub struct ContractVerificationApiTask {
 
 #[async_trait::async_trait]
 impl Task for ContractVerificationApiTask {
-    fn name(&self) -> &'static str {
-        "contract_verification_api"
+    fn id(&self) -> TaskId {
+        "contract_verification_api".into()
     }
 
     async fn run(self: Box<Self>, stop_receiver: StopReceiver) -> anyhow::Result<()> {

core/node/node_framework/src/implementations/layers/eth_sender.rs

@@ -14,7 +14,7 @@ use crate::{
         pools::{MasterPool, PoolResource, ReplicaPool},
     },
     service::{ServiceContext, StopReceiver},
-    task::Task,
+    task::{Task, TaskId},
     wiring_layer::{WiringError, WiringLayer},
 };
 
@@ -173,8 +173,8 @@ struct EthTxAggregatorTask {
 
 #[async_trait::async_trait]
 impl Task for EthTxAggregatorTask {
-    fn name(&self) -> &'static str {
-        "eth_tx_aggregator"
+    fn id(&self) -> TaskId {
+        "eth_tx_aggregator".into()
     }
 
     async fn run(self: Box<Self>, stop_receiver: StopReceiver) -> anyhow::Result<()> {
@@ -189,8 +189,8 @@ struct EthTxManagerTask {
 
 #[async_trait::async_trait]
 impl Task for EthTxManagerTask {
-    fn name(&self) -> &'static str {
-        "eth_tx_manager"
+    fn id(&self) -> TaskId {
+        "eth_tx_manager".into()
     }
 
     async fn run(self: Box<Self>, stop_receiver: StopReceiver) -> anyhow::Result<()> {

core/node/node_framework/src/implementations/layers/eth_watch.rs

@@ -12,7 +12,7 @@ use crate::{
         pools::{MasterPool, PoolResource},
     },
     service::{ServiceContext, StopReceiver},
-    task::Task,
+    task::{Task, TaskId},
     wiring_layer::{WiringError, WiringLayer},
 };
 
@@ -75,8 +75,8 @@ struct EthWatchTask {
 
 #[async_trait::async_trait]
 impl Task for EthWatchTask {
-    fn name(&self) -> &'static str {
-        "eth_watch"
+    fn id(&self) -> TaskId {
+        "eth_watch".into()
     }
 
     async fn run(self: Box<Self>, stop_receiver: StopReceiver) -> anyhow::Result<()> {

core/node/node_framework/src/implementations/layers/healtcheck_server.rs

@@ -7,7 +7,7 @@ use zksync_node_api_server::healthcheck::HealthCheckHandle;
 use crate::{
     implementations::resources::healthcheck::AppHealthCheckResource,
     service::{ServiceContext, StopReceiver},
-    task::UnconstrainedTask,
+    task::{TaskId, UnconstrainedTask},
     wiring_layer::{WiringError, WiringLayer},
 };
 
@@ -53,8 +53,8 @@ struct HealthCheckTask {
 
 #[async_trait::async_trait]
 impl UnconstrainedTask for HealthCheckTask {
-    fn name(&self) -> &'static str {
-        "healthcheck_server"
+    fn id(&self) -> TaskId {
+        "healthcheck_server".into()
     }
 
     async fn run_unconstrained(

core/node/node_framework/src/implementations/layers/house_keeper.rs

@@ -19,7 +19,7 @@ use zksync_house_keeper::{
 use crate::{
     implementations::resources::pools::{PoolResource, ProverPool, ReplicaPool},
     service::{ServiceContext, StopReceiver},
-    task::Task,
+    task::{Task, TaskId},
     wiring_layer::{WiringError, WiringLayer},
 };
 
@@ -179,8 +179,8 @@ struct PostgresMetricsScrapingTask {
 
 #[async_trait::async_trait]
 impl Task for PostgresMetricsScrapingTask {
-    fn name(&self) -> &'static str {
-        "postgres_metrics_scraping"
+    fn id(&self) -> TaskId {
+        "postgres_metrics_scraping".into()
     }
 
     async fn run(self: Box<Self>, mut stop_receiver: StopReceiver) -> anyhow::Result<()> {
@@ -203,8 +203,8 @@ struct L1BatchMetricsReporterTask {
 
 #[async_trait::async_trait]
 impl Task for L1BatchMetricsReporterTask {
-    fn name(&self) -> &'static str {
-        "l1_batch_metrics_reporter"
+    fn id(&self) -> TaskId {
+        "l1_batch_metrics_reporter".into()
     }
 
     async fn run(self: Box<Self>, stop_receiver: StopReceiver) -> anyhow::Result<()> {
@@ -219,8 +219,8 @@ struct FriProverJobRetryManagerTask {
 
 #[async_trait::async_trait]
 impl Task for FriProverJobRetryManagerTask {
-    fn name(&self) -> &'static str {
-        "fri_prover_job_retry_manager"
+    fn id(&self) -> TaskId {
+        "fri_prover_job_retry_manager".into()
     }
 
     async fn run(self: Box<Self>, stop_receiver: StopReceiver) -> anyhow::Result<()> {
@@ -235,8 +235,8 @@ struct FriWitnessGeneratorJobRetryManagerTask {
 
 #[async_trait::async_trait]
 impl Task for FriWitnessGeneratorJobRetryManagerTask {
-    fn name(&self) -> &'static str {
-        "fri_witness_generator_job_retry_manager"
+    fn id(&self) -> TaskId {
+        "fri_witness_generator_job_retry_manager".into()
     }
 
     async fn run(self: Box<Self>, stop_receiver: StopReceiver) -> anyhow::Result<()> {
@@ -253,8 +253,8 @@ struct WaitingToQueuedFriWitnessJobMoverTask {
 
 #[async_trait::async_trait]
 impl Task for WaitingToQueuedFriWitnessJobMoverTask {
-    fn name(&self) -> &'static str {
-        "waiting_to_queued_fri_witness_job_mover"
+    fn id(&self) -> TaskId {
+        "waiting_to_queued_fri_witness_job_mover".into()
     }
 
     async fn run(self: Box<Self>, stop_receiver: StopReceiver) -> anyhow::Result<()> {
@@ -271,8 +271,8 @@ struct FriWitnessGeneratorStatsReporterTask {
 
 #[async_trait::async_trait]
 impl Task for FriWitnessGeneratorStatsReporterTask {
-    fn name(&self) -> &'static str {
-        "fri_witness_generator_stats_reporter"
+    fn id(&self) -> TaskId {
+        "fri_witness_generator_stats_reporter".into()
     }
 
     async fn run(self: Box<Self>, stop_receiver: StopReceiver) -> anyhow::Result<()> {
@@ -289,8 +289,8 @@ struct FriProverStatsReporterTask {
 
 #[async_trait::async_trait]
 impl Task for FriProverStatsReporterTask {
-    fn name(&self) -> &'static str {
-        "fri_prover_stats_reporter"
+    fn id(&self) -> TaskId {
+        "fri_prover_stats_reporter".into()
     }
 
     async fn run(self: Box<Self>, stop_receiver: StopReceiver) -> anyhow::Result<()> {
@@ -305,8 +305,8 @@ struct FriProofCompressorStatsReporterTask {
 
 #[async_trait::async_trait]
 impl Task for FriProofCompressorStatsReporterTask {
-    fn name(&self) -> &'static str {
-        "fri_proof_compressor_stats_reporter"
+    fn id(&self) -> TaskId {
+        "fri_proof_compressor_stats_reporter".into()
     }
 
     async fn run(self: Box<Self>, stop_receiver: StopReceiver) -> anyhow::Result<()> {
@@ -323,8 +323,8 @@ struct FriProofCompressorJobRetryManagerTask {
 
 #[async_trait::async_trait]
 impl Task for FriProofCompressorJobRetryManagerTask {
-    fn name(&self) -> &'static str {
-        "fri_proof_compressor_job_retry_manager"
+    fn id(&self) -> TaskId {
+        "fri_proof_compressor_job_retry_manager".into()
     }
 
     async fn run(self: Box<Self>, stop_receiver: StopReceiver) -> anyhow::Result<()> {
@@ -341,8 +341,8 @@ struct FriProverJobArchiverTask {
 
 #[async_trait::async_trait]
 impl Task for FriProverJobArchiverTask {
-    fn name(&self) -> &'static str {
-        "fri_prover_job_archiver"
+    fn id(&self) -> TaskId {
+        "fri_prover_job_archiver".into()
     }
 
     async fn run(self: Box<Self>, stop_receiver: StopReceiver) -> anyhow::Result<()> {
@@ -356,8 +356,8 @@ struct FriProverGpuArchiverTask {
 
 #[async_trait::async_trait]
 impl Task for FriProverGpuArchiverTask {
-    fn name(&self) -> &'static str {
-        "fri_prover_gpu_archiver"
+    fn id(&self) -> TaskId {
+        "fri_prover_gpu_archiver".into()
     }
 
     async fn run(self: Box<Self>, stop_receiver: StopReceiver) -> anyhow::Result<()> {

core/node/node_framework/src/implementations/layers/l1_gas.rs

@@ -14,7 +14,7 @@ use crate::{
         l1_tx_params::L1TxParamsResource,
     },
     service::{ServiceContext, StopReceiver},
-    task::Task,
+    task::{Task, TaskId},
     wiring_layer::{WiringError, WiringLayer},
 };
 
@@ -80,8 +80,8 @@ struct GasAdjusterTask {
 
 #[async_trait::async_trait]
 impl Task for GasAdjusterTask {
-    fn name(&self) -> &'static str {
-        "gas_adjuster"
+    fn id(&self) -> TaskId {
+        "gas_adjuster".into()
     }
 
     async fn run(self: Box<Self>, stop_receiver: StopReceiver) -> anyhow::Result<()> {