Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: ask user for email on first run of Kurtosis (#1001)
- Loading branch information
Showing
7 changed files
with
94 additions
and
81 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
...ory/do_nothing_metrics_client_callback.go → ...ack/do_nothing_metrics_client_callback.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
70 changes: 70 additions & 0 deletions
70
cli/cli/kurtosis_config/email_collector/email_collector.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| package email_collector | ||
|
|
||
| import ( | ||
| "github.com/kurtosis-tech/kurtosis/cli/cli/helpers/do_nothing_metrics_client_callback" | ||
| "github.com/kurtosis-tech/kurtosis/cli/cli/helpers/logrus_logger_converter" | ||
| "github.com/kurtosis-tech/kurtosis/cli/cli/helpers/metrics_user_id_store" | ||
| "github.com/kurtosis-tech/kurtosis/cli/cli/helpers/prompt_displayer" | ||
| "github.com/kurtosis-tech/kurtosis/cli/cli/kurtosis_config/resolved_config" | ||
| "github.com/kurtosis-tech/kurtosis/kurtosis_version" | ||
| metrics_client "github.com/kurtosis-tech/metrics-library/golang/lib/client" | ||
| "github.com/kurtosis-tech/metrics-library/golang/lib/source" | ||
| "github.com/sirupsen/logrus" | ||
| ) | ||
|
|
||
| const ( | ||
| defaultEmailValue = "" | ||
| emailValueInputPrompt = "(Optional) Share your email address for occasional updates & outreach for product feedback from Kurtosis" | ||
| sendUserMetrics = true | ||
| flushQueueOnEachEvent = false | ||
| ) | ||
|
|
||
| func AskUserForEmailAndLogIt() { | ||
| userEmail, err := prompt_displayer.DisplayConfirmationPromptAndGetBooleanResult(emailValueInputPrompt, defaultEmailValue) | ||
| if err != nil { | ||
| logrus.Debugf("The user tried to input his email address but it failed") | ||
| } | ||
|
|
||
| if userEmail != defaultEmailValue { | ||
| logUserEmailAddressAsMetric(userEmail) | ||
| } | ||
|
|
||
| } | ||
|
|
||
| // TODO this recreates a metrics client instead of using the factory as there are circular dependencies - clean this up | ||
| func logUserEmailAddressAsMetric(userEmail string) { | ||
| metricsUserIdStore := metrics_user_id_store.GetMetricsUserIDStore() | ||
| metricsUserId, err := metricsUserIdStore.GetUserID() | ||
| if err != nil { | ||
| logrus.Debugf("an error occurred while getting users metrics id:\n%v", err) | ||
| return | ||
| } | ||
| logger := logrus.StandardLogger() | ||
|
|
||
| metricsClient, metricsClientCloseFunc, err := metrics_client.CreateMetricsClient( | ||
| source.KurtosisCLISource, | ||
| kurtosis_version.KurtosisVersion, | ||
| metricsUserId, | ||
| // TODO this isn't relevant for the metric also this only runs at first install; | ||
| // The user hasn't ever used Kurtosis yet so it has to be the default cluster | ||
| resolved_config.DefaultDockerClusterName, | ||
| sendUserMetrics, | ||
| flushQueueOnEachEvent, | ||
| do_nothing_metrics_client_callback.NewDoNothingMetricsClientCallback(), | ||
| logrus_logger_converter.ConvertLogrusLoggerToAnalyticsLogger(logger), | ||
| ) | ||
| if err != nil { | ||
| logrus.Debugf("tried creating a metrics client but failed with error:\n%v", err) | ||
| return | ||
| } | ||
| defer func() { | ||
| err = metricsClientCloseFunc() | ||
| if err != nil { | ||
| logrus.Debugf("an error occurred while closing the metrics client:\n%v", err) | ||
| } | ||
| }() | ||
| if err = metricsClient.TrackUserSharedEmailAddress(userEmail); err != nil { | ||
| logrus.Debugf("tried sending user email address as metric but failed:\n%v", err) | ||
| return | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters