Merge pull request #143 from coinbase/patrick/progress-endpoint

Expose a Status Endpoint for check:*

cmd/check_construction.go

@@ -20,6 +20,7 @@ import (
 	"log"
 	"time"
 
+	"github.com/coinbase/rosetta-cli/pkg/results"
 	"github.com/coinbase/rosetta-cli/pkg/tester"
 
 	"github.com/coinbase/rosetta-sdk-go/fetcher"
@@ -70,7 +71,7 @@ func runCheckConstructionCmd(cmd *cobra.Command, args []string) {
 
 	_, _, fetchErr := fetcher.InitializeAsserter(ctx, Config.Network)
 	if fetchErr != nil {
-		tester.ExitConstruction(
+		results.ExitConstruction(
 			Config,
 			nil,
 			nil,
@@ -81,7 +82,7 @@ func runCheckConstructionCmd(cmd *cobra.Command, args []string) {
 
 	_, err := utils.CheckNetworkSupported(ctx, Config.Network, fetcher)
 	if err != nil {
-		tester.ExitConstruction(
+		results.ExitConstruction(
 			Config,
 			nil,
 			nil,
@@ -99,7 +100,7 @@ func runCheckConstructionCmd(cmd *cobra.Command, args []string) {
 		&SignalReceived,
 	)
 	if err != nil {
-		tester.ExitConstruction(
+		results.ExitConstruction(
 			Config,
 			nil,
 			nil,
@@ -135,6 +136,15 @@ func runCheckConstructionCmd(cmd *cobra.Command, args []string) {
 		return tester.LogMemoryLoop(ctx)
 	})
 
+	g.Go(func() error {
+		return tester.StartServer(
+			ctx,
+			"check:construction status",
+			constructionTester,
+			Config.Construction.StatusPort,
+		)
+	})
+
 	sigListeners := []context.CancelFunc{cancel}
 	go handleSignals(&sigListeners)
 

cmd/check_data.go

@@ -19,6 +19,7 @@ import (
 	"fmt"
 	"time"
 
+	"github.com/coinbase/rosetta-cli/pkg/results"
 	"github.com/coinbase/rosetta-cli/pkg/tester"
 
 	"github.com/coinbase/rosetta-sdk-go/fetcher"
@@ -83,7 +84,7 @@ func runCheckDataCmd(cmd *cobra.Command, args []string) {
 
 	_, _, fetchErr := fetcher.InitializeAsserter(ctx, Config.Network)
 	if fetchErr != nil {
-		tester.ExitData(
+		results.ExitData(
 			Config,
 			nil,
 			nil,
@@ -96,7 +97,7 @@ func runCheckDataCmd(cmd *cobra.Command, args []string) {
 
 	networkStatus, err := utils.CheckNetworkSupported(ctx, Config.Network, fetcher)
 	if err != nil {
-		tester.ExitData(
+		results.ExitData(
 			Config,
 			nil,
 			nil,
@@ -146,7 +147,12 @@ func runCheckDataCmd(cmd *cobra.Command, args []string) {
 	})
 
 	g.Go(func() error {
-		return dataTester.StartProgressLogger(ctx)
+		return tester.StartServer(
+			ctx,
+			"check:data status",
+			dataTester,
+			Config.Data.StatusPort,
+		)
 	})
 
 	sigListeners := []context.CancelFunc{cancel}

cmd/root.go

@@ -132,6 +132,6 @@ var versionCmd = &cobra.Command{
 	Use:   "version",
 	Short: "Print rosetta-cli version",
 	Run: func(cmd *cobra.Command, args []string) {
-		fmt.Println("v0.5.5")
+		fmt.Println("v0.5.6")
 	},
 }

configuration/configuration.go

@@ -66,6 +66,7 @@ const (
 	DefaultBroadcastLimit                    = 3
 	DefaultTipDelay                          = 300
 	DefaultBlockBroadcastLimit               = 5
+	DefaultStatusPort                        = 9090
 
 	// ETH Defaults
 	EthereumIDBlockchain = "Ethereum"
@@ -135,6 +136,11 @@ type ConstructionConfiguration struct {
 	// workflows should be performed before stopping.
 	EndConditions map[string]int `json:"end_conditions,omitempty"`
 
+	// StatusPort allows the caller to query a running check:construction
+	// test to get stats about progress. This can be used instead
+	// of parsing logs to populate some sort of status dashboard.
+	StatusPort uint `json:"status_port,omitempty"`
+
 	// ResultsOutputFile is the absolute filepath of where to save
 	// the results of a check:construction run.
 	ResultsOutputFile string `json:"results_output_file,omitempty"`
@@ -147,6 +153,7 @@ func DefaultDataConfiguration() *DataConfiguration {
 		ActiveReconciliationConcurrency:   DefaultActiveReconciliationConcurrency,
 		InactiveReconciliationConcurrency: DefaultInactiveReconciliationConcurrency,
 		InactiveReconciliationFrequency:   DefaultInactiveReconciliationFrequency,
+		StatusPort:                        DefaultStatusPort,
 	}
 }
 
@@ -271,6 +278,11 @@ type DataConfiguration struct {
 	// EndCondition contains the conditions for the syncer to stop
 	EndConditions *DataEndConditions `json:"end_conditions,omitempty"`
 
+	// StatusPort allows the caller to query a running check:data
+	// test to get stats about progress. This can be used instead
+	// of parsing logs to populate some sort of status dashboard.
+	StatusPort uint `json:"status_port,omitempty"`
+
 	// ResultsOutputFile is the absolute filepath of where to save
 	// the results of a check:data run.
 	ResultsOutputFile string `json:"results_output_file"`
@@ -354,6 +366,10 @@ func populateConstructionMissingFields(
 		constructionConfig.BlockBroadcastLimit = DefaultBlockBroadcastLimit
 	}
 
+	if constructionConfig.StatusPort == 0 {
+		constructionConfig.StatusPort = DefaultStatusPort
+	}
+
 	return constructionConfig
 }
 
@@ -374,6 +390,10 @@ func populateDataMissingFields(dataConfig *DataConfiguration) *DataConfiguration
 		dataConfig.InactiveReconciliationFrequency = DefaultInactiveReconciliationFrequency
 	}
 
+	if dataConfig.StatusPort == 0 {
+		dataConfig.StatusPort = DefaultStatusPort
+	}
+
 	return dataConfig
 }
 

configuration/configuration_test.go

@@ -60,6 +60,7 @@ var (
 			StaleDepth:            12,
 			BroadcastLimit:        200,
 			BlockBroadcastLimit:   992,
+			StatusPort:            21,
 			Workflows: append(
 				fakeWorkflows,
 				&job.Workflow{
@@ -75,6 +76,7 @@ var (
 			ReconciliationDisabled:            false,
 			HistoricalBalanceEnabled:          &historicalEnabled,
 			StartIndex:                        &startIndex,
+			StatusPort:                        123,
 			EndConditions: &DataEndConditions{
 				ReconciliationCoverage: &goodCoverage,
 			},
@@ -153,6 +155,7 @@ func TestLoadConfiguration(t *testing.T) {
 					StaleDepth:            DefaultStaleDepth,
 					BroadcastLimit:        DefaultBroadcastLimit,
 					BlockBroadcastLimit:   DefaultBlockBroadcastLimit,
+					StatusPort:            DefaultStatusPort,
 					Workflows:             fakeWorkflows,
 				}
 

examples/configuration/default.json

@@ -29,6 +29,7 @@
   "inactive_discrepency_search_disabled": false,
   "balance_tracking_disabled": false,
   "coin_tracking_disabled": false,
+  "status_port": 9090,
   "results_output_file": "",
   "pruning_disabled": false
  }