Add a flag to start processing statediff if we are caught up to the head of the chain #205

2022-03-10T18:14:22Z

abdulrabbani00 commented

2022-03-10 18:14:22 +00:00

(Migrated from github.com)

Overview

This PR will allow users to add a flag when starting geth, indicating if we should wait for the statediff service to catch up to the head of the chain.

The feature has been tested using dapptools.
The feature includes unit tests.
The feature has not been tested with mainnet data.
The feature has not been tested for performance.

Data Structure Changes

This feature changes two major data structures used in the statediffing service.

statediff/config.go - Config
a. WaitforSync - This change allows us to indicate if the statediff service should wait for us to catch up to head.
statediff/service.go - Service
a. WaitforSync - This change allows us to indicate if the statediff service should wait for us to catch up to head.
b. Backend - This backend object is necessary to query the internal API, which indicates if we have caught up to the head of the chain.

These changes have not failed any of the current unit tests under /statediff.

Testing

This PR includes two unit tests. These unit tests have a new mock called Backend. The tests make sure that we catch up to head properly before indicating that we are all caught up.

We should test this with production data to ensure the feature is working correctly and does not incur any performance issues.

# Overview This PR will allow users to add a flag when starting geth, indicating if we should wait for the statediff service to catch up to the head of the chain. * The feature has been tested using dapptools. * The feature includes unit tests. * The feature has __not__ been tested with mainnet data. * The feature has __not__ been tested for performance. # Data Structure Changes This feature changes two major data structures used in the statediffing service. 1. `statediff/config.go` - `Config` a. `WaitforSync` - This change allows us to indicate if the statediff service should wait for us to catch up to head. 2. `statediff/service.go` - `Service` a. `WaitforSync` - This change allows us to indicate if the statediff service should wait for us to catch up to head. b. `Backend` - This backend object is necessary to query the internal API, which indicates if we have caught up to the head of the chain. These changes have not failed any of the current unit tests under `/statediff.` # Testing This PR includes two unit tests. These unit tests have a new mock called `Backend.` The tests make sure that we catch up to head properly before indicating that we are all caught up. We should test this with production data to ensure the feature is working correctly and does not incur any performance issues.

i-norden requested changes

2022-03-16 20:23:32 +00:00

i-norden left a comment

Looks great! Just a few comments for some very minor non-functional changes.