Add sync oracle to overseer

node/overseer/Cargo.toml

@@ -19,6 +19,7 @@ orchestra = "0.0.4"
 gum = { package = "tracing-gum", path = "../gum" }
 lru = "0.9"
 sp-core = { git = "https://github.com/paritytech/substrate", branch = "master" }
+sp-consensus = { git = "https://github.com/paritytech/substrate", branch = "master" }
 async-trait = "0.1.57"
 tikv-jemalloc-ctl = "0.5.0"
 

node/overseer/src/dummy.rs

@@ -15,8 +15,8 @@
 // along with Polkadot.  If not, see <http://www.gnu.org/licenses/>.
 
 use crate::{
-	prometheus::Registry, HeadSupportsParachains, InitializedOverseerBuilder, MetricsTrait,
-	Overseer, OverseerMetrics, OverseerSignal, OverseerSubsystemContext, SpawnGlue,
+	prometheus::Registry, HeadSupportsParachains, InitializedOverseerBuilder, MajorSyncOracle,
+	MetricsTrait, Overseer, OverseerMetrics, OverseerSignal, OverseerSubsystemContext, SpawnGlue,
 	KNOWN_LEAVES_CACHE_SIZE,
 };
 use lru::LruCache;
@@ -193,6 +193,7 @@ where
 		.leaves(Default::default())
 		.spawner(SpawnGlue(spawner))
 		.metrics(metrics)
+		.sync_oracle(MajorSyncOracle::new_dummy())
 		.supports_parachains(supports_parachains);
 	Ok(builder)
 }

node/overseer/src/lib.rs

@@ -83,6 +83,7 @@ use polkadot_node_subsystem_types::messages::{
 	DisputeDistributionMessage, GossipSupportMessage, NetworkBridgeRxMessage,
 	NetworkBridgeTxMessage, ProvisionerMessage, RuntimeApiMessage, StatementDistributionMessage,
 };
+use sp_consensus::SyncOracle;
 
 pub use polkadot_node_subsystem_types::{
 	errors::{SubsystemError, SubsystemResult},
@@ -330,6 +331,38 @@ pub async fn forward_events<P: BlockchainEvents<Block>>(client: Arc<P>, mut hand
 	}
 }
 
+/// Used to detect if the node is in major sync. This can happen only on startup so once syncing is
+/// done the node is considered up to date and `finished_syncing` will always return `true`.
+pub struct MajorSyncOracle {
+	sync_oracle: Option<Box<dyn SyncOracle + Send>>,
+}
+
+impl MajorSyncOracle {
+	/// Create `MajorSyncOracle` from `SyncOracle`
+	pub fn new(sync_oracle: Box<dyn SyncOracle + Send>) -> Self {
+		Self { sync_oracle: Some(sync_oracle) }
+	}
+
+	/// Create dummy `MajorSyncOracle` which always returns true for `finished_syncing`
+	pub fn new_dummy() -> Self {
+		Self { sync_oracle: None }
+	}
+
+	/// Check if node is in major sync
+	pub fn finished_syncing(&mut self) -> bool {
+		match &mut self.sync_oracle {
+			Some(sync_oracle) =>
+				if !sync_oracle.is_major_syncing() {
+					self.sync_oracle = None;
+					true
+				} else {
+					false
+				},
+			None => true,
+		}
+	}
+}
+
 /// Create a new instance of the [`Overseer`] with a fixed set of [`Subsystem`]s.
 ///
 /// This returns the overseer along with an [`OverseerHandle`] which can
@@ -629,6 +662,9 @@ pub struct Overseer<SupportsParachains> {
 
 	/// Various Prometheus metrics.
 	pub metrics: OverseerMetrics,
+
+	/// SyncOracle is used to detect when initial full node sync is complete
+	pub sync_oracle: MajorSyncOracle,
 }
 
 /// Spawn the metrics metronome task.

node/service/src/lib.rs

@@ -49,7 +49,7 @@ use {
 	polkadot_node_network_protocol::{
 		peer_set::PeerSetProtocolNames, request_response::ReqProtocolNames,
 	},
-	polkadot_overseer::BlockInfo,
+	polkadot_overseer::{BlockInfo, MajorSyncOracle},
 	sc_client_api::BlockBackend,
 	sp_core::traits::SpawnNamed,
 	sp_trie::PrefixedMemoryDB,
@@ -1091,6 +1091,7 @@ where
 					overseer_message_channel_capacity_override,
 					req_protocol_names,
 					peerset_protocol_names,
+					sync_oracle: MajorSyncOracle::new(Box::new(network.clone())),
 				},
 			)
 			.map_err(|e| {

node/service/src/overseer.rs

@@ -34,8 +34,8 @@ pub use polkadot_overseer::{
 	HeadSupportsParachains,
 };
 use polkadot_overseer::{
-	metrics::Metrics as OverseerMetrics, BlockInfo, InitializedOverseerBuilder, MetricsTrait,
-	Overseer, OverseerConnector, OverseerHandle, SpawnGlue,
+	metrics::Metrics as OverseerMetrics, BlockInfo, InitializedOverseerBuilder, MajorSyncOracle,
+	MetricsTrait, Overseer, OverseerConnector, OverseerHandle, SpawnGlue,
 };
 
 use polkadot_primitives::runtime_api::ParachainHost;
@@ -125,6 +125,8 @@ where
 	pub req_protocol_names: ReqProtocolNames,
 	/// [`PeerSet`] protocol names to protocols mapping.
 	pub peerset_protocol_names: PeerSetProtocolNames,
+	/// SyncOracle is used to detect when initial full node sync is complete
+	pub sync_oracle: MajorSyncOracle,
 }
 
 /// Obtain a prepared `OverseerBuilder`, that is initialized
@@ -155,6 +157,7 @@ pub fn prepared_overseer_builder<Spawner, RuntimeClient>(
 		overseer_message_channel_capacity_override,
 		req_protocol_names,
 		peerset_protocol_names,
+		sync_oracle,
 	}: OverseerGenArgs<Spawner, RuntimeClient>,
 ) -> Result<
 	InitializedOverseerBuilder<
@@ -319,6 +322,7 @@ where
 		.supports_parachains(runtime_client)
 		.known_leaves(LruCache::new(KNOWN_LEAVES_CACHE_SIZE))
 		.metrics(metrics)
+		.sync_oracle(sync_oracle)
 		.spawner(spawner);
 
 	if let Some(capacity) = overseer_message_channel_capacity_override {