chore(dot): transform telemetry into an injectable interface

.gitignore

@@ -9,6 +9,7 @@
 
 # Output of go coverage tool when used with LiteIDE
 *.out
+*.log
 
 /bin
 

dot/build_spec.go

@@ -4,12 +4,14 @@
 package dot
 
 import (
+	"context"
 	"encoding/json"
 	"fmt"
 	"os"
 	"path/filepath"
 
 	"github.com/ChainSafe/gossamer/dot/state"
+	"github.com/ChainSafe/gossamer/dot/telemetry"
 	"github.com/ChainSafe/gossamer/internal/log"
 	"github.com/ChainSafe/gossamer/lib/common"
 	"github.com/ChainSafe/gossamer/lib/genesis"
@@ -94,33 +96,43 @@ func BuildFromDB(path string) (*BuildSpec, error) {
 	tmpGen.Genesis.Raw = make(map[string]map[string]string)
 	tmpGen.Genesis.Runtime = make(map[string]map[string]interface{})
 
+	// BootstrapMailer should not return an error here since there is no URLs to connect to
+	disabledTelemetry, err := telemetry.BootstrapMailer(context.TODO(), nil, false, nil)
+	if err != nil {
+		panic("telemetry should not fail at BuildFromDB function: " + err.Error())
+	}
+
 	config := state.Config{
-		Path:     path,
-		LogLevel: log.Info,
+		Path:      path,
+		LogLevel:  log.Info,
+		Telemetry: disabledTelemetry,
 	}
+
 	stateSrvc := state.NewService(config)
 
-	// start state service (initialise state database)
-	err := stateSrvc.Start()
+	err = stateSrvc.SetupBase()
 	if err != nil {
-		return nil, err
+		return nil, fmt.Errorf("cannot setup state database: %w", err)
 	}
 
+	// start state service (initialise state database)
+	err = stateSrvc.Start()
+	if err != nil {
+		return nil, fmt.Errorf("cannot start state service: %w", err)
+	}
 	// set genesis fields data
 	ent, err := stateSrvc.Storage.Entries(nil)
 	if err != nil {
-		return nil, err
+		return nil, fmt.Errorf("failed to get storage trie entries: %w", err)
 	}
-
 	err = genesis.BuildFromMap(ent, tmpGen)
 	if err != nil {
-		return nil, err
+		return nil, fmt.Errorf("failed to build from map: %w", err)
 	}
-
 	// set genesisData
 	gd, err := stateSrvc.DB().Get(common.GenesisDataKey)
 	if err != nil {
-		return nil, err
+		return nil, fmt.Errorf("failed to retrieve genesis data: %w", err)
 	}
 	gData := &genesis.Data{}
 	err = json.Unmarshal(gd, gData)

dot/core/test_helpers.go → dot/core/helpers_test.go

@@ -18,6 +18,7 @@ import (
 	rtstorage "github.com/ChainSafe/gossamer/lib/runtime/storage"
 	"github.com/ChainSafe/gossamer/lib/runtime/wasmer"
 	"github.com/ChainSafe/gossamer/lib/utils"
+	"github.com/golang/mock/gomock"
 	"github.com/stretchr/testify/mock"
 	"github.com/stretchr/testify/require"
 )
@@ -51,10 +52,16 @@ func NewTestService(t *testing.T, cfg *Config) *Service {
 	if cfg.BlockState == nil || cfg.StorageState == nil ||
 		cfg.TransactionState == nil || cfg.EpochState == nil ||
 		cfg.CodeSubstitutedState == nil {
+		ctrl := gomock.NewController(t)
+		telemetryMock := NewMockClient(ctrl)
+		telemetryMock.EXPECT().SendMessage(gomock.Any()).AnyTimes()
+
 		config := state.Config{
-			Path:     testDatadirPath,
-			LogLevel: log.Info,
+			Path:      testDatadirPath,
+			LogLevel:  log.Info,
+			Telemetry: telemetryMock,
 		}
+
 		stateSrvc = state.NewService(config)
 		stateSrvc.UseMemDB()
 

dot/core/messages_test.go

@@ -10,6 +10,7 @@ import (
 
 	"github.com/centrifuge/go-substrate-rpc-client/v3/signature"
 	ctypes "github.com/centrifuge/go-substrate-rpc-client/v3/types"
+	"github.com/golang/mock/gomock"
 	"github.com/stretchr/testify/require"
 
 	"github.com/ChainSafe/gossamer/dot/core/mocks"
@@ -124,9 +125,13 @@ func TestService_HandleTransactionMessage(t *testing.T) {
 	ks := keystore.NewGlobalKeystore()
 	ks.Acco.Insert(kp)
 
+	ctrl := gomock.NewController(t)
+	telemetryMock := NewMockClient(ctrl)
+	telemetryMock.EXPECT().SendMessage(gomock.Any()).AnyTimes()
+
 	cfg := &Config{
 		Keystore:         ks,
-		TransactionState: state.NewTransactionState(),
+		TransactionState: state.NewTransactionState(telemetryMock),
 	}
 
 	s := NewTestService(t, cfg)

dot/core/service_test.go

@@ -27,10 +27,13 @@ import (
 	"github.com/ChainSafe/gossamer/lib/transaction"
 	"github.com/ChainSafe/gossamer/lib/trie"
 	"github.com/ChainSafe/gossamer/pkg/scale"
+	"github.com/golang/mock/gomock"
 	"github.com/stretchr/testify/mock"
 	"github.com/stretchr/testify/require"
 )
 
+//go:generate mockgen -destination=mock_telemetry_test.go -package $GOPACKAGE github.com/ChainSafe/gossamer/dot/telemetry Client
+
 func TestMain(m *testing.M) {
 	wasmFilePaths, err := runtime.GenerateRuntimeWasmFile()
 	if err != nil {
@@ -379,7 +382,11 @@ func TestMaintainTransactionPool_EmptyBlock(t *testing.T) {
 		},
 	}
 
-	ts := state.NewTransactionState()
+	ctrl := gomock.NewController(t)
+	telemetryMock := NewMockClient(ctrl)
+	telemetryMock.EXPECT().SendMessage(gomock.Any()).AnyTimes()
+
+	ts := state.NewTransactionState(telemetryMock)
 	hashes := make([]common.Hash, len(txs))
 
 	for i, tx := range txs {
@@ -424,7 +431,11 @@ func TestMaintainTransactionPool_BlockWithExtrinsics(t *testing.T) {
 		},
 	}
 
-	ts := state.NewTransactionState()
+	ctrl := gomock.NewController(t)
+	telemetryMock := NewMockClient(ctrl)
+	telemetryMock.EXPECT().SendMessage(gomock.Any()).AnyTimes()
+
+	ts := state.NewTransactionState(telemetryMock)
 	hashes := make([]common.Hash, len(txs))
 
 	for i, tx := range txs {

dot/digest/digest_test.go

@@ -17,16 +17,24 @@ import (
 	"github.com/ChainSafe/gossamer/lib/genesis"
 	"github.com/ChainSafe/gossamer/lib/keystore"
 	"github.com/ChainSafe/gossamer/pkg/scale"
+	"github.com/golang/mock/gomock"
 
 	"github.com/stretchr/testify/require"
 )
 
+//go:generate mockgen -destination=mock_telemetry_test.go -package $GOPACKAGE github.com/ChainSafe/gossamer/dot/telemetry Client
+
 func newTestHandler(t *testing.T) *Handler {
 	testDatadirPath := t.TempDir()
 
+	ctrl := gomock.NewController(t)
+	telemetryMock := NewMockClient(ctrl)
+	telemetryMock.EXPECT().SendMessage(gomock.Any()).AnyTimes()
+
 	config := state.Config{
-		Path:     testDatadirPath,
-		LogLevel: log.Info,
+		Path:      testDatadirPath,
+		LogLevel:  log.Info,
+		Telemetry: telemetryMock,
 	}
 	stateSrvc := state.NewService(config)
 	stateSrvc.UseMemDB()
@@ -35,6 +43,9 @@ func newTestHandler(t *testing.T) *Handler {
 	err := stateSrvc.Initialise(gen, genHeader, genTrie)
 	require.NoError(t, err)
 
+	err = stateSrvc.SetupBase()
+	require.NoError(t, err)
+
 	err = stateSrvc.Start()
 	require.NoError(t, err)