Feature/event tracking command count on mixpanel

.github/workflows/cd.yml

@@ -16,6 +16,8 @@ jobs:
           go-version: '1.18'
         env:
           SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
+          MIXPANEL_PROJECT_TOKEN: ${{ secrets.MIXPANEL_PROJECT_TOKEN }}
+          MIXPANEL_SERVICE_ACCOUNT_SECRET: ${{ secrets.MIXPANEL_SERVICE_ACCOUNT_SECRET }}
   build:
     runs-on: ubuntu-latest
     steps:

Makefile

@@ -56,14 +56,14 @@ install:
 	GO111MODULE=on go install \
 		-trimpath \
 		-ldflags \
-		"-X github.com/onflow/flow-cli/build.commit=$(COMMIT) -X github.com/onflow/flow-cli/build.semver=$(VERSION)" \
+		"-X github.com/onflow/flow-cli/build.commit=$(COMMIT) -X github.com/onflow/flow-cli/build.semver=$(VERSION) -X github.com/onflow/flow-cli/pkg/flowkit/util.MIXPANEL_SERVICE_ACCOUNT_SECRET=$(MIXPANEL_SERVICE_ACCOUNT_SECRET) -X github.com/onflow/flow-cli/pkg/flowkit/util.MIXPANEL_PROJECT_TOKEN=$(MIXPANEL_PROJECT_TOKEN)" \
 		./cmd/flow
 
 $(BINARY):
 	GO111MODULE=on go build \
 		-trimpath \
 		-ldflags \
-		"-X github.com/onflow/flow-cli/build.commit=$(COMMIT) -X github.com/onflow/flow-cli/build.semver=$(VERSION)" \
+		"-X github.com/onflow/flow-cli/build.commit=$(COMMIT) -X github.com/onflow/flow-cli/build.semver=$(VERSION) -X github.com/onflow/flow-cli/pkg/flowkit/util.MIXPANEL_SERVICE_ACCOUNT_SECRET=$(MIXPANEL_SERVICE_ACCOUNT_SECRET) -X github.com/onflow/flow-cli/pkg/flowkit/util.MIXPANEL_PROJECT_TOKEN=$(MIXPANEL_PROJECT_TOKEN)"\
 		-o $(BINARY) ./cmd/flow
 
 .PHONY: versioned-binaries

docs/data-collection.md

@@ -0,0 +1,29 @@
+---
+title: Data Collection
+description: Data collected from Flow CLI usage
+---
+
+Flow CLI tracks flow command usage count using Mixpanel.
+
+Data collection is enabled by default. Users can opt out of our data collection through running `flow config tracking disable`. 
+To opt back in, users can run `flow config tracking enable`.
+
+## Why do we collect data about flow cli usage?
+
+Collecting aggregate command count allow us to prioritise features and fixes based on how users use flow cli.
+
+## What data do we collect?
+
+We only collect the number of times a command is executed. 
+
+We don't keep track of the values of arguments, flags used
+and the values of the flags used. We also don't associate any commands to any particular user.
+
+The only property that we collect from our users are their preferences for opting in / out of data collection. 
+The analytics user ID is specific to Mixpanel and does not permit Flow CLI maintainers to e.g. track you across websites you visit.
+
+Further details regarding the data collected can be found under Mixpanel's data collection page in `Ingestion API` 
+section of https://help.mixpanel.com/hc/en-us/articles/115004613766-Default-Properties-Collected-by-Mixpanel.
+
+Please note that although Mixpanel's page above mentions that geolocation properties are recorded by default, 
+we have turned off geolocation data reporting to Mixpanel.

internal/accounts/create.go

@@ -179,7 +179,7 @@ func createInteractive(state *flowkit.State, loader flowkit.ReaderWriter) (*flow
 
 	service := services.NewServices(gw, state, output.NewStdoutLogger(output.NoneLog))
 
-	key, err := service.Keys.Generate("", crypto.ECDSA_P256)
+	key, err := service.Keys.Generate("", "", crypto.ECDSA_P256)
 	if err != nil {
 		return nil, err
 	}

internal/command/command.go

@@ -78,6 +78,22 @@ const (
 	logLevelNone  = "none"
 )
 
+func (c Command) handleUserTracking() {
+	if util.MIXPANEL_SERVICE_ACCOUNT_SECRET == "" || util.MIXPANEL_PROJECT_TOKEN == "" {
+		return
+	}
+	optedIn, err := util.IsUserOptedIn()
+	if err != nil {
+		sentry.CaptureException(err)
+	}
+	if optedIn {
+		err = util.TrackCommandUsage(c.Cmd)
+		if err != nil {
+			sentry.CaptureException(err)
+		}
+	}
+}
+
 // AddToParent add new command to main parent cmd
 // and initializes all necessary things as well as take care of errors and output
 // here we can do all boilerplate code that is else copied in each command and make sure
@@ -91,6 +107,7 @@ func (c Command) AddToParent(parent *cobra.Command) {
 			defer sentry.Flush(2 * time.Second)
 			defer sentry.Recover()
 		}
+		c.handleUserTracking()
 
 		// initialize file loader used in commands
 		loader := &afero.Afero{Fs: afero.NewOsFs()}

internal/config/config.go

@@ -32,6 +32,7 @@ func init() {
 	InitCommand.AddToParent(Cmd)
 	Cmd.AddCommand(AddCmd)
 	Cmd.AddCommand(RemoveCmd)
+	MetricsSettings.AddToParent(Cmd)
 }
 
 type Result struct {

internal/config/metrics-settings.go

@@ -0,0 +1,63 @@
+/*
+ * Flow CLI
+ *
+ * Copyright 2019 Dapper Labs, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package config
+
+import (
+	"fmt"
+
+	"github.com/onflow/flow-cli/pkg/flowkit"
+	"github.com/onflow/flow-cli/pkg/flowkit/services"
+	"github.com/onflow/flow-cli/pkg/flowkit/util"
+
+	"github.com/onflow/flow-cli/internal/command"
+
+	"github.com/spf13/cobra"
+)
+
+type flagsCommandMetrics struct{}
+
+var commandMetricsFlags = flagsCommandMetrics{}
+
+var MetricsSettings = &command.Command{
+	Cmd: &cobra.Command{
+		Use:     "metrics",
+		Short:   "Configure command usage metrics settings",
+		Example: "flow config metrics disable",
+		Args:    cobra.ExactArgs(1),
+	},
+	Flags: &commandMetricsFlags,
+	Run:   handleMetricsSettings,
+}
+
+func handleMetricsSettings(
+	args []string,
+	_ flowkit.ReaderWriter,
+	_ command.GlobalFlags,
+	_ *services.Services,
+) (command.Result, error) {
+	disabled := args[0] == "disable"
+	err := util.SetUserMetricsSettings(disabled)
+	if err != nil {
+		return nil, err
+	}
+
+	return &Result{
+		fmt.Sprintf("Metrics have been %sd", args[0]),
+	}, nil
+}

pkg/flowkit/util/mixpanel.go

@@ -0,0 +1,169 @@
+/*
+ * Flow CLI
+ *
+ * Copyright 2019 Dapper Labs, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package util
+
+import (
+	"bytes"
+	"encoding/json"
+	"fmt"
+	"github.com/spf13/cobra"
+	"io/ioutil"
+	"net/http"
+	"net/url"
+	"strings"
+)
+
+const (
+	MIXPANEL_TRACK_URL   = "https://api.mixpanel.com/track"
+	MIXPANEL_QUERY_URL   = "https://mixpanel.com/api/2.0/engage?project_id=2154593"
+	MIXPANEL_PROFILE_URL = "https://api.mixpanel.com/engage#profile-set"
+)
+
+var MIXPANEL_PROJECT_TOKEN = ""
+var MIXPANEL_SERVICE_ACCOUNT_SECRET = ""
+
+type MixpanelClient struct {
+	token   string
+	baseUrl string
+}
+
+func TrackCommandUsage(command *cobra.Command) error {
+	mixpanelEvent := newEvent(command)
+	mixpanelEvent.setUpEvent(MIXPANEL_PROJECT_TOKEN, FLOW_CLI)
+	eventPayload, err := encodePayload(mixpanelEvent)
+	if err != nil {
+		return err
+	}
+	payload := bytes.NewReader(eventPayload)
+	req, err := http.NewRequest("POST", MIXPANEL_TRACK_URL, payload)
+	if err != nil {
+		return err
+	}
+	req.Header.Add("Accept", "text/plain")
+	req.Header.Add("Content-Type", "application/json")
+	res, err := http.DefaultClient.Do(req)
+	if err != nil {
+		return err
+	}
+	defer res.Body.Close()
+	_, err = ioutil.ReadAll(res.Body)
+
+	if err != nil {
+		return err
+	}
+	if res.StatusCode >= 400 {
+		return fmt.Errorf("invalid response status code %d for tracking command usage", res.StatusCode)
+	}
+
+	return nil
+}
+
+func encodePayload(obj any) ([]byte, error) {
+	b, err := json.Marshal([]any{obj})
+	if err != nil {
+		return nil, err
+	}
+	return b, nil
+}
+func SetUserMetricsSettings(enable bool) error {
+	mixpanelUser, err := getMixPanelUser()
+	if err != nil {
+		return err
+	}
+	mixpanelUser.configureUserTracking(enable)
+
+	userPayload, err := encodePayload(mixpanelUser)
+	if err != nil {
+		return err
+	}
+
+	payload := bytes.NewReader(userPayload)
+	req, err := http.NewRequest("POST", MIXPANEL_PROFILE_URL, payload)
+	if err != nil {
+		return err
+	}
+	req.Header.Add("Accept", "text/plain")
+	req.Header.Add("Content-Type", "application/json")
+	res, err := http.DefaultClient.Do(req)
+	if err != nil {
+		return err
+	}
+	defer res.Body.Close()
+	_, err = ioutil.ReadAll(res.Body)
+
+	if err != nil {
+		return err
+	}
+	if res.StatusCode >= 400 {
+		return fmt.Errorf("invalid response status code %d for tracking command usage", res.StatusCode)
+	}
+
+	return nil
+}
+
+type MixPanelResponse struct {
+	Results []struct {
+		Properties struct {
+			OptIn bool `json:"opt_in"`
+		} `json:"$properties"`
+	} `json:"results"`
+}
+
+//User is opted in by default
+//If distinct id can't be found through query api, return true to reflect that user is opted in
+func IsUserOptedIn() (bool, error) {
+	distinctId, err := generateNewDistinctId()
+	if err != nil {
+		return false, err
+	}
+
+	queryPayload := "distinct_id=" + url.QueryEscape(distinctId)
+	payload := strings.NewReader(queryPayload)
+	req, err := http.NewRequest("POST", MIXPANEL_QUERY_URL, payload)
+	if err != nil {
+		return false, err
+	}
+
+	mixpanelAuth := "Basic " + MIXPANEL_SERVICE_ACCOUNT_SECRET
+	req.Header.Add("Accept", "application/json")
+	req.Header.Add("Content-Type", "application/x-www-form-urlencoded")
+	req.Header.Add("Authorization", mixpanelAuth)
+
+	res, err := http.DefaultClient.Do(req)
+	if err != nil {
+		return false, err
+	}
+
+	defer res.Body.Close()
+	body, err := ioutil.ReadAll(res.Body)
+
+	var queryResponse MixPanelResponse
+	err = json.Unmarshal(body, &queryResponse)
+
+	if err != nil {
+		return false, err
+	}
+	if res.StatusCode >= 400 {
+		return false, fmt.Errorf("invalid response status code %d for tracking command usage", res.StatusCode)
+	}
+	if len(queryResponse.Results) == 0 {
+		return true, nil
+	}
+	return queryResponse.Results[0].Properties.OptIn, nil
+}

pkg/flowkit/util/mixpanelEvent.go

@@ -0,0 +1,46 @@
+/*
+ * Flow CLI
+ *
+ * Copyright 2019 Dapper Labs, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package util
+
+import (
+	"github.com/spf13/cobra"
+)
+
+const (
+	MIXPANEL_EVENT_PROJECT_TOKEN = "token"
+	MIXPANEL_EVENT_CALLER        = "caller"
+	FLOW_CLI                     = "flow-cli"
+)
+
+type event struct {
+	Name       string                 `json:"event"`
+	Properties map[string]interface{} `json:"properties"`
+}
+
+func newEvent(command *cobra.Command) *event {
+	return &event{
+		command.CommandPath(),
+		make(map[string]interface{}),
+	}
+}
+
+func (e *event) setUpEvent(token string, caller string) {
+	e.Properties[MIXPANEL_EVENT_PROJECT_TOKEN] = token
+	e.Properties[MIXPANEL_EVENT_CALLER] = caller
+}