Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@

### Added

- [#6057](https://github.com/ChainSafe/forest/issues/6057) Added `--no-progress-timeout` to `forest-cli f3 ready` subcommand to exit when F3 is stuck for the given timeout.

### Changed

### Removed
Expand Down
2 changes: 1 addition & 1 deletion scripts/tests/calibnet_export_f3_check.sh
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ echo "Cleaning up the initial snapshot"
rm --force --verbose ./*.{car,car.zst,sha256sum}

echo "Wait for F3 to sync"
timeout 10m $FOREST_CLI_PATH f3 ready --wait
timeout 10m $FOREST_CLI_PATH f3 ready --wait --no-progress-timeout 5m

echo "Exporting zstd compressed snapshot in v2 format"
$FOREST_CLI_PATH snapshot export --format v2
Expand Down
35 changes: 29 additions & 6 deletions src/cli/subcommands/f3_cmd.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@
#[cfg(test)]
mod tests;

use std::{borrow::Cow, sync::LazyLock, time::Duration};
use std::{
borrow::Cow,
sync::LazyLock,
time::{Duration, Instant},
};

use crate::{
blocks::{Tipset, TipsetKey},
Expand Down Expand Up @@ -99,6 +103,9 @@ pub enum F3Commands {
/// The threshold of the epoch gap between chain head and F3 head within which F3 is considered in sync.
#[arg(long, default_value_t = 20)]
threshold: usize,
/// Exit after F3 making no progress for this duration. It has no effect when `--wait` is not used.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Not a blocker, but we could ensure that --wait is used without resorting to docs.

https://docs.rs/clap/latest/clap/struct.ArgGroup.html

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Fixed.

     Running `target/debug/forest-cli f3 ready --no-progress-timeout 5m`
error: the following required arguments were not provided:
  --wait

Usage: forest-cli f3 ready --wait --no-progress-timeout <NO_PROGRESS_TIMEOUT>

For more information, try '--help'.

#[arg(long, default_value = "10m")]
no_progress_timeout: humantime::Duration,
},
}

Expand Down Expand Up @@ -128,7 +135,11 @@ impl F3Commands {
}
Self::Certs(cmd) => cmd.run(client).await,
Self::PowerTable(cmd) => cmd.run(client).await,
Self::Ready { wait, threshold } => {
Self::Ready {
wait,
threshold,
no_progress_timeout,
} => {
let is_running = client.call(F3IsRunning::request(())?).await?;
if !is_running {
anyhow::bail!("F3 is not running");
Expand All @@ -148,16 +159,21 @@ impl F3Commands {
);
pb.enable_steady_tick(std::time::Duration::from_millis(100));
let mut num_consecutive_fetch_failtures = 0;
let no_progress_timeout_duration: Duration = no_progress_timeout.into();
let mut interval = tokio::time::interval(Duration::from_secs(1));
let mut last_f3_head_epoch = 0;
let mut last_progress = Instant::now();
loop {
interval.tick().await;
match get_heads(&client).await {
Ok((chain_head, cert_head)) => {
num_consecutive_fetch_failtures = 0;
if cert_head
.chain_head()
.epoch
.saturating_add(threshold.try_into()?)
let f3_head_epoch = cert_head.chain_head().epoch;
if f3_head_epoch != last_f3_head_epoch {
last_f3_head_epoch = f3_head_epoch;
last_progress = Instant::now();
}
if f3_head_epoch.saturating_add(threshold.try_into()?)
>= chain_head.epoch()
{
let text = format!(
Expand Down Expand Up @@ -195,6 +211,13 @@ impl F3Commands {
}
}
}

if last_progress + no_progress_timeout_duration < Instant::now() {
eprintln!(
"Warning: F3 made no progress in the past {no_progress_timeout}. Exiting..."
);
std::process::exit(3);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Why 3?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Exit code 1 and 2 have been used above

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Let's use some constants to easily indicate the exit code cause.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Fixed.

}
}
Ok(())
}
Expand Down
Loading