fix(api-sync): prevent validator round reset after each batch during restore (#1322)

* make block batch size configurable

* fix validator round resetting after batch commit

* add regression test

Author: oXtxNt9U

packages/api-sync/source/defaults.ts

@@ -3,6 +3,11 @@ import { Environment } from "@mainsail/kernel";
 
 export const defaults = {
 	enabled: Environment.isTrue(EnvironmentVariables.MAINSAIL_API_SYNC_ENABLED),
+	restore: {
+		blocks: {
+			batchSize: Environment.get<number>(EnvironmentVariables.MAINSAIL_API_SYNC_RESTORE_BLOCKS_BATCH_SIZE, 1000),
+		},
+	},
 	syncInterval: Environment.get<number>(EnvironmentVariables.MAINSAIL_API_SYNC_INTERVAL, 8000),
 	tokenCacheSize: Environment.get<number>(EnvironmentVariables.MAINSAIL_API_SYNC_TOKEN_CACHE_SIZE, 256),
 	tokenWhitelistRefreshInterval: Environment.get<number>(

packages/api-sync/source/restore.ts

@@ -159,6 +159,10 @@ export class Restore {
 	@optional()
 	private readonly snapshotImporter?: Contracts.Snapshot.LegacyImporter;
 
+	@inject(Identifiers.ServiceProvider.Configuration)
+	@tagged("plugin", "api-sync")
+	private readonly pluginConfiguration!: Contracts.Kernel.PluginConfiguration;
+
 	public async restore(): Promise<void> {
 		const isEmpty = await this.databaseService.isEmpty();
 		const mostRecentCommit = await (isEmpty
@@ -299,15 +303,16 @@ export class Restore {
 			validatorRounds,
 		} = context;
 
-		const BATCH_SIZE = 1000;
-		const CHUNK_SIZE = 1000;
+		const BATCH_SIZE = this.pluginConfiguration.getRequired<number>("restore.blocks.batchSize");
+		const CHUNK_SIZE = BATCH_SIZE;
 		const t0 = performance.now();
 
 		const genesisBlockNumber = this.configuration.getGenesisHeight();
 		let currentBlockNumber = genesisBlockNumber;
 
 		let ingestedBlocks = 0;
 		let ingestedTransactions = 0;
+		let totalRound = 0;
 
 		const multiPaymentContractAddress = this.app.get<string>(
 			EvmConsensusIdentifiers.Contracts.Addresses.MultiPayment,
@@ -383,7 +388,6 @@ export class Restore {
 				}
 			};
 
-			let totalRound = 0;
 			for await (const { block, proof } of commits) {
 				blocks.push({
 					commitRound: proof.round,

packages/api-sync/source/service-provider.ts

@@ -39,8 +39,14 @@ export class ServiceProvider extends Providers.ServiceProvider {
 
 	public configSchema(): Joi.ObjectSchema {
 		return Joi.object({
+			restore: Joi.object({
+				blocks: Joi.object({
+					batchSize: Joi.number().integer().positive().required(),
+				}),
+			}),
 			syncInterval: Joi.number().integer().positive().required(),
 			tokenCacheSize: Joi.number().integer().positive().required(),
+			tokenWhitelistRefreshInterval: Joi.number().integer().positive().required(),
 		}).unknown(true);
 	}
 

packages/constants/source/environment-variables.ts

@@ -81,6 +81,8 @@ export const EnvironmentVariableNames = [
 	"MAINSAIL_API_SYNC_TOKEN_WHITELIST_REMOTE_URL",
 	"MAINSAIL_API_SYNC_LOG_EXTRA",
 
+	"MAINSAIL_API_SYNC_RESTORE_BLOCKS_BATCH_SIZE",
+
 	// Transaction pool API
 	"MAINSAIL_API_TRANSACTION_POOL_TRUST_PROXY",
 	"MAINSAIL_API_TRANSACTION_POOL_DISABLED",

tests/functional/resync/source/resync.test.ts

@@ -23,7 +23,7 @@ describe<{
 	});
 
 	it("should be ok", async ({ syncNode }) => {
-		await waitBlock(syncNode, 5);
+		await waitBlock(syncNode, 54);
 	});
 
 	it("should be ok with votes", async ({ syncNode }) => {

tests/functional/resync/source/setup.ts

@@ -120,6 +120,11 @@ const setupNode = async (app: Application, dataDirectory: string, configDirector
 		},
 		"@mainsail/api-sync": {
 			maxSyncAttempts: 1,
+			restore: {
+				blocks: {
+					batchSize: 5,
+				},
+			},
 			syncInterval: 250,
 			truncateDatabase: "1",
 		},