feat(cmd): add google analytics

changelog.md

@@ -9,6 +9,7 @@
 - [#3561](https://github.com/ignite/cli/pull/3561) Add GetChainInfo method to plugin system API
 - [#3626](https://github.com/ignite/cli/pull/3626) Add logging levels to relayer
 - [#3476](https://github.com/ignite/cli/pull/3476) Use `buf.build` binary to code generate from proto files
+- [#3599](https://github.com/ignite/cli/pull/3599) Add google analytics
 - [#3614](https://github.com/ignite/cli/pull/3614) feat: use DefaultBaseappOptions for app.New method
 - [#3536](https://github.com/ignite/cli/pull/3536) Change app.go to v2 and add AppWiring feature
 - [#3659](https://github.com/ignite/cli/pull/3659) cosmos-sdk `v0.50.x`

go.mod

@@ -22,6 +22,7 @@ require (
 	github.com/99designs/keyring v1.2.2
 	github.com/AlecAivazis/survey/v2 v2.3.7
 	github.com/DATA-DOG/go-sqlmock v1.5.0
+	github.com/Pallinder/go-randomdata v1.2.0
 	github.com/blang/semver/v4 v4.0.0
 	github.com/briandowns/spinner v1.23.0
 	github.com/bufbuild/buf v1.15.1

go.sum

@@ -129,6 +129,8 @@ github.com/OneOfOne/xxhash v1.2.8 h1:31czK/TI9sNkxIKfaUfGlU47BAxQ0ztGgd9vPyqimf8
 github.com/OneOfOne/xxhash v1.2.8/go.mod h1:eZbhyaAYD41SGSSsnmcpxVoRiQ/MPUTjUdIIOT9Um7Q=
 github.com/OpenPeeDeeP/depguard/v2 v2.1.0 h1:aQl70G173h/GZYhWf36aE5H0KaujXfVMnn/f1kSDVYY=
 github.com/OpenPeeDeeP/depguard/v2 v2.1.0/go.mod h1:PUBgk35fX4i7JDmwzlJwJ+GMe6NfO1723wmJMgPThNQ=
+github.com/Pallinder/go-randomdata v1.2.0 h1:DZ41wBchNRb/0GfsePLiSwb0PHZmT67XY00lCDlaYPg=
+github.com/Pallinder/go-randomdata v1.2.0/go.mod h1:yHmJgulpD2Nfrm0cR9tI/+oAgRqCQQixsA8HyRZfV9Y=
 github.com/ProtonMail/go-crypto v0.0.0-20230828082145-3c4c8a2d2371 h1:kkhsdkhsCvIsutKu5zLMgWtgh9YxGCNAw8Ad8hjwfYg=
 github.com/ProtonMail/go-crypto v0.0.0-20230828082145-3c4c8a2d2371/go.mod h1:EjAoLdwvbIOoOQr3ihjnSoLZRtE8azugULFRteWMNc0=
 github.com/Shopify/sarama v1.19.0/go.mod h1:FVkBWblsNy7DGZRfXLU0O9RCGt5g3g3yEuWXgklEdEo=

ignite/cmd/ignite/analytics.go

@@ -0,0 +1,129 @@
+package main
+
+import (
+	"encoding/json"
+	"os"
+	"path/filepath"
+	"runtime"
+	"strings"
+
+	"github.com/Pallinder/go-randomdata"
+	"github.com/manifoldco/promptui"
+
+	"github.com/ignite/cli/ignite/pkg/gacli"
+	"github.com/ignite/cli/ignite/version"
+)
+
+const (
+	gaID           = "G-<ID>"
+	gaSecret       = "<API_SECRET>"
+	envDoNotTrack  = "DO_NOT_TRACK"
+	igniteDir      = ".ignite"
+	igniteIdentity = "identity.json"
+)
+
+var gaclient gacli.Client
+
+type (
+	// metric represents an analytics metric.
+	metric struct {
+		// err sets metrics type as an error metric.
+		err error
+		// command is the command name.
+		command string
+	}
+
+	// identity represents an analytics identity file.
+	identity struct {
+		// name represents the username.
+		Name string `json:"name" yaml:"name"`
+		// doNotTrack represents the user track choice.
+		DoNotTrack bool `json:"doNotTrack" yaml:"doNotTrack"`
+	}
+)
+
+func addCmdMetric(m metric) {
+	envDoNotTrackVar := os.Getenv(envDoNotTrack)
+	if envDoNotTrackVar == "1" || strings.ToLower(envDoNotTrackVar) == "true" {
+		return
+	}
+
+	if m.command == "ignite version" {
+		return
+	}
+
+	dntInfo, err := checkDNT()
+	if err != nil || dntInfo.DoNotTrack {
+		return
+	}
+
+	met := gacli.Metric{
+		OS:        runtime.GOOS,
+		Arch:      runtime.GOARCH,
+		FullCmd:   m.command,
+		SessionId: dntInfo.Name,
+		Version:   version.Version,
+	}
+
+	switch {
+	case m.err == nil:
+		met.Status = "success"
+	case m.err != nil:
+		met.Status = "error"
+		met.Error = m.err.Error()
+	}
+
+	cmds := strings.Split(m.command, " ")
+	met.Cmd = cmds[0]
+	if len(cmds) > 0 {
+		met.Cmd = cmds[1]
+	}
+
+	go gaclient.SendMetric(met)
+}
+
+func checkDNT() (identity, error) {
+	home, err := os.UserHomeDir()
+	if err != nil {
+		return identity{}, err
+	}
+	if err := os.Mkdir(filepath.Join(home, igniteDir), 0o700); err != nil && !os.IsExist(err) {
+		return identity{}, err
+	}
+	identityPath := filepath.Join(home, igniteDir, igniteIdentity)
+	data, err := os.ReadFile(identityPath)
+	if err != nil && !os.IsNotExist(err) {
+		return identity{}, err
+	}
+
+	var i identity
+	if err := json.Unmarshal(data, &i); err == nil {
+		return i, nil
+	}
+
+	i.Name = randomdata.SillyName()
+	i.DoNotTrack = false
+
+	prompt := promptui.Select{
+		Label: "Ignite collects metrics about command usage. " +
+			"All data is anonymous and helps to improve Ignite. " +
+			"Ignite respect the DNT rules (consoledonottrack.com). " +
+			"Would you agree to share these metrics with us?",
+		Items: []string{"Yes", "No"},
+	}
+	resultID, _, err := prompt.Run()
+	if err != nil {
+		return identity{}, err
+	}
+
+	if resultID != 0 {
+		i.DoNotTrack = true
+	}
+
+	data, err = json.Marshal(&i)
+	if err != nil {
+		return i, err
+	}
+
+	return i, os.WriteFile(identityPath, data, 0o700)
+}

ignite/cmd/ignite/main.go

@@ -5,17 +5,20 @@ import (
 	"errors"
 	"fmt"
 	"os"
+	"strings"
 
 	ignitecmd "github.com/ignite/cli/ignite/cmd"
 	chainconfig "github.com/ignite/cli/ignite/config/chain"
 	"github.com/ignite/cli/ignite/pkg/clictx"
 	"github.com/ignite/cli/ignite/pkg/cliui/colors"
 	"github.com/ignite/cli/ignite/pkg/cliui/icons"
+	"github.com/ignite/cli/ignite/pkg/gacli"
 	"github.com/ignite/cli/ignite/pkg/validation"
 	"github.com/ignite/cli/ignite/pkg/xstrings"
 )
 
 func main() {
+	gaclient = gacli.New(gaID, gaSecret)
 	os.Exit(run())
 }
 
@@ -24,6 +27,23 @@ func run() int {
 		exitCodeOK    = 0
 		exitCodeError = 1
 	)
+
+	defer func() {
+		if r := recover(); r != nil {
+			addCmdMetric(metric{
+				err:     fmt.Errorf("%v", r),
+				command: strings.Join(os.Args, " "),
+			})
+			fmt.Println(r)
+			os.Exit(exitCodeError)
+		}
+	}()
+
+	if len(os.Args) > 1 {
+		addCmdMetric(metric{
+			command: strings.Join(os.Args, " "),
+		})
+	}
 	ctx := clictx.From(context.Background())
 
 	cmd, cleanUp, err := ignitecmd.New(ctx)

ignite/pkg/gacli/doc.go

@@ -0,0 +1,2 @@
+// Package gacli is a client for Google Analytics to send data points for hint-type=event.
+package gacli

ignite/pkg/gacli/gacli.go

@@ -1,63 +1,85 @@
-// Package gacli is a client for Google Analytics to send data points for hint-type=event.
 package gacli
 
 import (
+	"bytes"
+	"encoding/json"
+	"fmt"
 	"net/http"
-	"net/url"
 )
 
 const (
-	endpoint = "https://www.google-analytics.com/collect"
+	endpoint = "https://www.google-analytics.com/mp/collect?measurement_id=%s&api_secret=%s"
 )
 
-// Client is an analytics client.
-type Client struct {
-	id string // Google Analytics ID
-}
-
-// New creates a new analytics client for Segment.io with Segment's
-// endpoint and access key.
-func New(id string) *Client {
-	return &Client{
-		id: id,
+type (
+	// Client is an analytics client.
+	Client struct {
+		id     string // Google Analytics measurement ID.
+		secret string // Google Analytics API secret.
 	}
-}
-
-// Metric represents a data point.
-type Metric struct {
-	Category string
-	Action   string
-	Label    string
-	Value    string
-	User     string
-	Version  string
-}
-
-// Send sends metrics to GA.
-func (c *Client) Send(metric Metric) error {
-	v := url.Values{
-		"v":   {"1"},
-		"tid": {c.id},
-		"cid": {metric.User},
-		"t":   {"event"},
-		"ec":  {metric.Category},
-		"ea":  {metric.Action},
-		"ua":  {"Opera/9.80 (Windows NT 6.0) Presto/2.12.388 Version/12.14"},
+	// Body analytics metrics body.
+	Body struct {
+		ClientId string  `json:"client_id"`
+		Events   []Event `json:"events"`
 	}
-	if metric.Label != "" {
-		v.Set("el", metric.Label)
+	// Event analytics event.
+	Event struct {
+		Name   string `json:"name"`
+		Params Metric `json:"params"`
 	}
-	if metric.Value != "" {
-		v.Set("ev", metric.Value)
+	// Metric represents a data point.
+	Metric struct {
+		Status             string `json:"status,omitempty"`
+		OS                 string `json:"os,omitempty"`
+		Arch               string `json:"arch,omitempty"`
+		FullCmd            string `json:"full_command,omitempty"`
+		Cmd                string `json:"command,omitempty"`
+		Error              string `json:"error,omitempty"`
+		Version            string `json:"version,omitempty"`
+		SessionId          string `json:"session_id,omitempty"`
+		EngagementTimeMsec string `json:"engagement_time_msec,omitempty"`
 	}
-	if metric.Version != "" {
-		v.Set("an", metric.Version)
-		v.Set("av", metric.Version)
+)
+
+// New creates a new analytics client with
+// measure id and secret key.
+func New(id, secret string) Client {
+	return Client{
+		secret: secret,
+		id:     id,
 	}
-	resp, err := http.PostForm(endpoint, v)
+}
+
+// Send sends metrics to analytics.
+func (c Client) Send(body Body) error {
+	// encode body
+	encoded, err := json.Marshal(body)
 	if err != nil {
 		return err
 	}
+
+	// Create an HTTP request with the payload
+	url := fmt.Sprintf(endpoint, c.id, c.secret)
+	resp, err := http.Post(url, "application/json", bytes.NewBuffer(encoded))
+	if err != nil {
+		return fmt.Errorf("error creating HTTP request: %w", err)
+	}
 	defer resp.Body.Close()
+
+	if resp.StatusCode != http.StatusOK &&
+		resp.StatusCode != http.StatusNoContent {
+		return fmt.Errorf("Error sending event. Status code: %d\n", resp.StatusCode)
+	}
 	return nil
 }
+
+func (c Client) SendMetric(metric Metric) error {
+	metric.EngagementTimeMsec = "100"
+	return c.Send(Body{
+		ClientId: metric.SessionId,
+		Events: []Event{{
+			Name:   metric.Cmd,
+			Params: metric,
+		}},
+	})
+}