feat(halo): ready command integrated into docker containers

cli/cmd/compose.yml.tpl

@@ -27,6 +27,10 @@ services:
       #- --metrics                    # Enable prometheus metrics
       #- --pprof                      # Enable prometheus metrics
       #- --pprof.addr=0.0.0.0         # Enable prometheus metrics
+    healthcheck:
+      test: "nc -z localhost 8545"
+      interval: 1s
+      retries: 30
 
     ports:
       - 8551             # Auth-RPC (used by halo)

halo/cmd/cmd.go

@@ -28,6 +28,7 @@ func New() *cobra.Command {
 		buildinfo.NewVersionCmd(),
 		newConsKeyCmd(),
 		newStatusCmd(),
+		newReadyCmd(),
 	)
 }
 

halo/cmd/ready.go

@@ -0,0 +1,61 @@
+package cmd
+
+import (
+	"context"
+	"fmt"
+	"net/http"
+	"time"
+
+	"github.com/omni-network/omni/lib/errors"
+	"github.com/omni-network/omni/lib/log"
+
+	cmtcfg "github.com/cometbft/cometbft/config"
+
+	"github.com/spf13/cobra"
+)
+
+func newReadyCmd() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "ready",
+		Short: "Assert the readiness of the halo node",
+		Args:  cobra.NoArgs,
+		RunE: func(cmd *cobra.Command, _ []string) error {
+			err := assertReady(cmd.Context())
+			if err != nil {
+				return errors.Wrap(err, "ready failed")
+			}
+
+			return nil
+		},
+	}
+
+	return cmd
+}
+
+// assertReady calls halo's /ready endpoint and returns nil if the status is ready
+// or an error otherwise.
+func assertReady(ctx context.Context) error {
+	cfg := cmtcfg.DefaultConfig()
+	url := fmt.Sprintf("http://0.0.0.0%v/ready", cfg.Instrumentation.PrometheusListenAddr)
+
+	ctx, cancel := context.WithTimeout(ctx, 5*time.Second)
+	defer cancel()
+
+	req, err := http.NewRequestWithContext(ctx, http.MethodGet, url, nil)
+	if err != nil {
+		return errors.Wrap(err, "http request creation")
+	}
+
+	resp, err := http.DefaultClient.Do(req)
+	if err != nil {
+		return errors.Wrap(err, "http request")
+	}
+	defer resp.Body.Close()
+
+	if resp.StatusCode < 400 {
+		log.Info(ctx, "The node is ready")
+		return nil
+	}
+
+	return errors.New("the node is not ready yet")
+}

halo/cmd/testdata/TestCLIReference_halo.golden

@@ -9,6 +9,7 @@ Available Commands:
   consensus-pubkey Print the consensus public key
   help             Help about any command
   init             Initializes required halo files and directories
+  ready            Assert the readiness of the halo node
   rollback         Rollback Cosmos SDK and CometBFT state by one height
   run              Runs the halo consensus client
   status           Query remote node for status

scripts/halovisor/Dockerfile

@@ -35,6 +35,8 @@ COPY --from=build-cosmovisor /ko-app/cosmovisor /usr/local/bin/cosmovisor
 COPY --from=build-0-genesis /app /halovisor/genesis/bin/halo
 COPY --from=build-1-uluwatu /app /halovisor/upgrades/1_uluwatu/bin/halo
 
+HEALTHCHECK --interval=30s --timeout=5s --start-period=10s CMD ["/halovisor/upgrades/1_uluwatu/bin/halo", "ready"]
+
 # Cosmovisor is the entrypoint
 ENTRYPOINT [ "cosmovisor" ]
 # First 'run' is cosmovisor command, second 'run' is halo command.