Add repertory to store installation id and secret

Author: Roberto Sora

cli/cli.go

@@ -17,6 +17,7 @@ package cli
 
 import (
 	"fmt"
+	"github.com/arduino/arduino-cli/repertory"
 	"io/ioutil"
 	"os"
 	"path/filepath"
@@ -163,6 +164,9 @@ func preRun(cmd *cobra.Command, args []string) {
 	configuration.Init(configPath)
 	configFile := viper.ConfigFileUsed()
 
+	// initialize repertory
+	repertory.Init()
+
 	//
 	// Prepare logging
 	//

cli/daemon/daemon.go

@@ -17,6 +17,7 @@ package daemon
 
 import (
 	"fmt"
+	"github.com/segmentio/stats/v4"
 	"io"
 	"io/ioutil"
 	"net"
@@ -57,8 +58,8 @@ var daemonize bool
 func runDaemonCommand(cmd *cobra.Command, args []string) {
 
 	if viper.GetBool("telemetry.enabled") {
-		telemetry.Activate("daemon", viper.GetString("installation.id"))
-		defer telemetry.Engine.Flush()
+		telemetry.Activate("daemon")
+		defer stats.Flush()
 	}
 
 	port := viper.GetString("daemon.port")
@@ -94,7 +95,7 @@ func runDaemonCommand(cmd *cobra.Command, args []string) {
 			// stdin is closed when the controlling parent process ends
 			_, _ = io.Copy(ioutil.Discard, os.Stdin)
 			if viper.GetBool("telemetry.enabled") {
-				telemetry.Engine.Flush()
+				stats.Flush()
 			}
 			os.Exit(0)
 		}()

commands/board/list.go

@@ -18,7 +18,6 @@ package board
 import (
 	"encoding/json"
 	"fmt"
-	"github.com/arduino/arduino-cli/telemetry"
 	"github.com/segmentio/stats/v4"
 	"io/ioutil"
 	"net/http"
@@ -108,13 +107,13 @@ func List(instanceID int32) ([]*rpc.DetectedPort, error) {
 
 	pm := commands.GetPackageManager(instanceID)
 	if pm == nil {
-		telemetry.Engine.Incr("board.list", stats.T("success", "false"))
+		stats.Incr("board.list", stats.T("success", "false"))
 		return nil, errors.New("invalid instance")
 	}
 
 	ports, err := commands.ListBoards(pm)
 	if err != nil {
-		telemetry.Engine.Incr("board.list", stats.T("success", "false"))
+		stats.Incr("board.list", stats.T("success", "false"))
 		return nil, errors.Wrap(err, "error getting port list from serial-discovery")
 	}
 
@@ -140,7 +139,7 @@ func List(instanceID int32) ([]*rpc.DetectedPort, error) {
 				logrus.Debug("Board not recognized")
 			} else if err != nil {
 				// this is bad, bail out
-				telemetry.Engine.Incr("board.list", stats.T("success", "false"))
+				stats.Incr("board.list", stats.T("success", "false"))
 				return nil, errors.Wrap(err, "error getting board info from Arduino Cloud")
 			}
 
@@ -161,6 +160,6 @@ func List(instanceID int32) ([]*rpc.DetectedPort, error) {
 		retVal = append(retVal, p)
 	}
 
-	telemetry.Engine.Incr("board.list", stats.T("success", "true"))
+	stats.Incr("board.list", stats.T("success", "true"))
 	return retVal, nil
 }

commands/compile/compile.go

@@ -63,19 +63,19 @@ func Compile(ctx context.Context, req *rpc.CompileReq, outStream, errStream io.W
 
 	pm := commands.GetPackageManager(req.GetInstance().GetId())
 	if pm == nil {
-		telemetry.Engine.Incr("compile", stats.M(tags)...)
+		stats.Incr("compile", stats.M(tags)...)
 		return nil, errors.New("invalid instance")
 	}
 
 	logrus.Tracef("Compile %s for %s started", req.GetSketchPath(), req.GetFqbn())
 	if req.GetSketchPath() == "" {
-		telemetry.Engine.Incr("compile", stats.M(tags)...)
+		stats.Incr("compile", stats.M(tags)...)
 		return nil, fmt.Errorf("missing sketchPath")
 	}
 	sketchPath := paths.New(req.GetSketchPath())
 	sketch, err := sketches.NewSketchFromPath(sketchPath)
 	if err != nil {
-		telemetry.Engine.Incr("compile", stats.M(tags)...)
+		stats.Incr("compile", stats.M(tags)...)
 		return nil, fmt.Errorf("opening sketch: %s", err)
 	}
 
@@ -84,12 +84,12 @@ func Compile(ctx context.Context, req *rpc.CompileReq, outStream, errStream io.W
 		fqbnIn = sketch.Metadata.CPU.Fqbn
 	}
 	if fqbnIn == "" {
-		telemetry.Engine.Incr("compile", stats.M(tags)...)
+		stats.Incr("compile", stats.M(tags)...)
 		return nil, fmt.Errorf("no FQBN provided")
 	}
 	fqbn, err := cores.ParseFQBN(fqbnIn)
 	if err != nil {
-		telemetry.Engine.Incr("compile", stats.M(tags)...)
+		stats.Incr("compile", stats.M(tags)...)
 		return nil, fmt.Errorf("incorrect FQBN: %s", err)
 	}
 
@@ -103,7 +103,7 @@ func Compile(ctx context.Context, req *rpc.CompileReq, outStream, errStream io.W
 		// 	"\"%[1]s:%[2]s\" platform is not installed, please install it by running \""+
 		// 		version.GetAppName()+" core install %[1]s:%[2]s\".", fqbn.Package, fqbn.PlatformArch)
 		// feedback.Error(errorMessage)
-		telemetry.Engine.Incr("compile", stats.M(tags)...)
+		stats.Incr("compile", stats.M(tags)...)
 		return nil, fmt.Errorf("platform not installed")
 	}
 
@@ -123,7 +123,7 @@ func Compile(ctx context.Context, req *rpc.CompileReq, outStream, errStream io.W
 		builderCtx.BuildPath = paths.New(req.GetBuildPath())
 		err = builderCtx.BuildPath.MkdirAll()
 		if err != nil {
-			telemetry.Engine.Incr("compile", stats.M(tags)...)
+			stats.Incr("compile", stats.M(tags)...)
 			return nil, fmt.Errorf("cannot create build directory: %s", err)
 		}
 	}
@@ -149,7 +149,7 @@ func Compile(ctx context.Context, req *rpc.CompileReq, outStream, errStream io.W
 		builderCtx.BuildCachePath = paths.New(req.GetBuildCachePath())
 		err = builderCtx.BuildCachePath.MkdirAll()
 		if err != nil {
-			telemetry.Engine.Incr("compile", stats.M(tags)...)
+			stats.Incr("compile", stats.M(tags)...)
 			return nil, fmt.Errorf("cannot create build cache directory: %s", err)
 		}
 	}
@@ -183,17 +183,17 @@ func Compile(ctx context.Context, req *rpc.CompileReq, outStream, errStream io.W
 	// if --preprocess or --show-properties were passed, we can stop here
 	if req.GetShowProperties() {
 		tags["success"] = "true"
-		telemetry.Engine.Incr("compile", stats.M(tags)...)
+		stats.Incr("compile", stats.M(tags)...)
 		return &rpc.CompileResp{}, builder.RunParseHardwareAndDumpBuildProperties(builderCtx)
 	} else if req.GetPreprocess() {
 		tags["success"] = "true"
-		telemetry.Engine.Incr("compile", stats.M(tags)...)
+		stats.Incr("compile", stats.M(tags)...)
 		return &rpc.CompileResp{}, builder.RunPreprocess(builderCtx)
 	}
 
 	// if it's a regular build, go on...
 	if err := builder.RunBuilder(builderCtx); err != nil {
-		telemetry.Engine.Incr("compile", stats.M(tags)...)
+		stats.Incr("compile", stats.M(tags)...)
 		return nil, err
 	}
 
@@ -229,7 +229,7 @@ func Compile(ctx context.Context, req *rpc.CompileReq, outStream, errStream io.W
 	// Copy "sketch.ino.*.hex" / "sketch.ino.*.bin" artifacts to sketch directory
 	srcDir, err := outputPath.Parent().ReadDir() // read "/build/path/*"
 	if err != nil {
-		telemetry.Engine.Incr("compile", stats.M(tags)...)
+		stats.Incr("compile", stats.M(tags)...)
 		return nil, fmt.Errorf("reading build directory: %s", err)
 	}
 	srcDir.FilterPrefix(base + ".")
@@ -240,7 +240,7 @@ func Compile(ctx context.Context, req *rpc.CompileReq, outStream, errStream io.W
 		dstOutput := exportPath.Join(exportFile + srcFilename)
 		logrus.WithField("from", srcOutput).WithField("to", dstOutput).Debug("copying sketch build output")
 		if err = srcOutput.CopyTo(dstOutput); err != nil {
-			telemetry.Engine.Incr("compile", stats.M(tags)...)
+			stats.Incr("compile", stats.M(tags)...)
 			return nil, fmt.Errorf("copying output file: %s", err)
 		}
 	}
@@ -251,13 +251,13 @@ func Compile(ctx context.Context, req *rpc.CompileReq, outStream, errStream io.W
 		dstElf := exportPath.Join(exportFile + ".elf")
 		logrus.WithField("from", srcElf).WithField("to", dstElf).Debug("copying sketch build output")
 		if err = srcElf.CopyTo(dstElf); err != nil {
-			telemetry.Engine.Incr("compile", stats.M(tags)...)
+			stats.Incr("compile", stats.M(tags)...)
 			return nil, fmt.Errorf("copying elf file: %s", err)
 		}
 	}
 
 	logrus.Tracef("Compile %s for %s successful", sketch.Name, fqbnIn)
 	tags["success"] = "true"
-	telemetry.Engine.Incr("compile", stats.M(tags)...)
+	stats.Incr("compile", stats.M(tags)...)
 	return &rpc.CompileResp{}, nil
 }

configuration/configuration.go

@@ -38,7 +38,7 @@ func Init(configPath string) {
 
 	// Get default data path if none was provided
 	if configPath == "" {
-		configPath = getDefaultArduinoDataDir()
+		configPath = GetDefaultArduinoDataDir()
 	}
 
 	// Add paths where to search for a config file
@@ -58,7 +58,7 @@ func Init(configPath string) {
 	// those were set through env vars or cli flags
 	dataDir := viper.GetString("directories.Data")
 	if dataDir == "" {
-		dataDir = getDefaultArduinoDataDir()
+		dataDir = GetDefaultArduinoDataDir()
 	}
 	userDir := viper.GetString("directories.User")
 	if userDir == "" {
@@ -76,10 +76,11 @@ func Init(configPath string) {
 			feedback.Errorf("Error reading config file: %v", err)
 		}
 	}
+
 }
 
-// getDefaultArduinoDataDir returns the full path to the default arduino folder
-func getDefaultArduinoDataDir() string {
+// GetDefaultArduinoDataDir returns the full path to the default arduino folder
+func GetDefaultArduinoDataDir() string {
 	userHomeDir, err := os.UserHomeDir()
 	if err != nil {
 		feedback.Errorf("Unable to get user home dir: %v", err)

configuration/defaults.go

@@ -18,7 +18,6 @@ package configuration
 import (
 	"path/filepath"
 
-	"github.com/gofrs/uuid"
 	"github.com/spf13/viper"
 )
 
@@ -42,11 +41,4 @@ func setDefaults(dataDir, userDir string) {
 	viper.SetDefault("telemetry.addr", ":2112")
 	viper.SetDefault("telemetry.pattern", "/metrics")
 
-	//Installation ID
-	// FIXME: how should I treat this error?
-	installationID, _ := uuid.NewV4()
-	installationSecret, _ := uuid.NewV4()
-	viper.SetDefault("installation.id", installationID.String())
-	viper.SetDefault("installation.secret", installationSecret.String())
-
 }

repertory/repertory.go

@@ -0,0 +1,40 @@
+package repertory
+
+import (
+	"github.com/arduino/arduino-cli/cli/feedback"
+	"github.com/arduino/arduino-cli/configuration"
+	"github.com/gofrs/uuid"
+	"github.com/spf13/viper"
+	"os"
+)
+
+// Store is the Read Only config storage
+var Store = viper.New()
+
+// Configure configures the Read Only config storage
+func Init() {
+	configPath := configuration.GetDefaultArduinoDataDir()
+	Store.SetConfigType("yaml")
+	Store.SetConfigName("repertory.yaml")
+	Store.AddConfigPath(configPath)
+	// Attempt to read config file
+	if err := Store.ReadInConfig(); err != nil {
+		// ConfigFileNotFoundError is acceptable, anything else
+		// should be reported to the user
+		if _, ok := err.(viper.ConfigFileNotFoundError); ok {
+			// FIXME: how should I treat this error?
+			installationID, _ := uuid.NewV4()
+			Store.SetDefault("installation.id", installationID.String())
+			installationSecret, _ := uuid.NewV4()
+			Store.SetDefault("installation.secret", installationSecret.String())
+			if err = Store.SafeWriteConfigAs(configPath); err != nil {
+				if os.IsNotExist(err) {
+					err = Store.WriteConfigAs(configPath)
+				}
+			}
+		} else {
+			feedback.Errorf("Error reading repertory file: %v", err)
+
+		}
+	}
+}

telemetry/telemetry.go

@@ -4,6 +4,7 @@ import (
 	"crypto/hmac"
 	"crypto/sha256"
 	"encoding/hex"
+	"github.com/arduino/arduino-cli/repertory"
 	"net/http"
 	"path/filepath"
 
@@ -13,19 +14,16 @@ import (
 	"github.com/spf13/viper"
 )
 
-// Engine is the engine used by global helper functions for this module.
-var Engine = stats.DefaultEngine
-
-// Activate configure and starts the telemetry server exposing a Prometheus resource
-func Activate(metricPrefix, installationID string) {
-	// Configure telemetry engine
+// Activate configures and starts the telemetry server exposing a Prometheus resource
+func Activate(metricPrefix string) {
 	// Create a Prometheus default handler
 	ph := prometheus.DefaultHandler
 	// Create a new stats engine with an engine that prepends the "daemon" prefix to all metrics
-	// and includes the installationID as a tag
-	Engine = stats.WithPrefix(metricPrefix, stats.T("installationID", installationID))
+	// and includes the installationID as a tag, then replace the default stats engine
+	stats.DefaultEngine = stats.WithPrefix(metricPrefix, stats.T("installationID",
+		repertory.Store.GetString("installation.id")))
 	// Register the handler so it receives metrics from the default engine.
-	Engine.Register(ph)
+	stats.Register(ph)
 
 	// Configure using viper settings
 	serverAddr := viper.GetString("telemetry.addr")
@@ -41,7 +39,8 @@ func Activate(metricPrefix, installationID string) {
 // SanitizeSketchPath uses config generated UUID (installation.secret) as an HMAC secret to sanitize and anonymize the sketch
 // name maintaining it distinguishable from a different sketch from the same Installation
 func SanitizeSketchPath(sketchPath string) string {
-	installationSecret := viper.GetString("installation.secret")
+	logrus.Infof("repertory.Store.ConfigFileUsed() %s", repertory.Store.ConfigFileUsed())
+	installationSecret := repertory.Store.GetString("installation.secret")
 	sketchName := filepath.Base(sketchPath)
 	// Create a new HMAC by defining the hash type and the key (as byte array)
 	h := hmac.New(sha256.New, []byte(installationSecret))