A means of detecting when server is synced and ready

[catch-21]

Describe your idea, in simple words.

It would be good to have a field on the health endpoint to indicate when the server is ready to be queried.

Why is it a good idea?

Currently, the health endpoint can return {"connection_status":"connected","most_recent_checkpoint":null,"most_recent_node_tip":null} when it has established a connection with the node socket but it's sync status is unknown (reproducible for a short time when restoring from existing db).

The workaround is for client to wait for the absence of null values, and for checkpoint and tip to be equal before querying.

Are you willing to work on it yourself?

No

[KtorZ]

@james-iohk the server can be queries as soon as it is started. The question then becomes when is it relevant for a client to start consuming the data fetched from the server?

I don't think there's one generic answer for this as it very much depends on the use-case set by clients. Hence why the health endpoints gives both the current network tip and the latest checkpoint synced. It's then up to client to decide if they want to wait or not.