From 7d7b32eb1927b7e262fcf535603ab0f96c8490e6 Mon Sep 17 00:00:00 2001
From: Cyril David <cyx@users.noreply.github.com>
Date: Fri, 14 May 2021 16:26:03 -0700
Subject: [PATCH] fix: better development ergonomics (#294)

When we're developing, we woudn't want to swallow panics since that can
cause a lot of surprises.

For non-development cases, since we're reporting this, then swallowing
the panic and displaying a basic error message would be enough for the
user to know that something went wrong happened.
---
 internal/cli/root.go                        | 19 +++++++++++++++++--
 internal/instrumentation/instrumentation.go |  7 ++++---
 2 files changed, 21 insertions(+), 5 deletions(-)

diff --git a/internal/cli/root.go b/internal/cli/root.go
index c70045fe1..d7217ec3e 100644
--- a/internal/cli/root.go
+++ b/internal/cli/root.go
@@ -86,7 +86,7 @@ func Execute() {
 		"no-input", false, "Disable interactivity.")
 
 	rootCmd.PersistentFlags().BoolVar(&cli.noColor,
-		"no-color", false, "Disable colors.")	
+		"no-color", false, "Disable colors.")
 	// order of the comamnds here matters
 	// so add new commands in a place that reflect its relevance or relation with other commands:
 	rootCmd.AddCommand(loginCmd(cli))
@@ -111,7 +111,15 @@ func Execute() {
 	defer func() {
 		if v := recover(); v != nil {
 			err := fmt.Errorf("panic: %v", v)
-			instrumentation.ReportException(err)
+
+			// If we're in development mode, we should throw the
+			// panic for so we have less surprises. For
+			// non-developers, we'll swallow the panics.
+			if instrumentation.ReportException(err) {
+				fmt.Println(panicMessage)
+			} else {
+				panic(v)
+			}
 		}
 	}()
 
@@ -143,3 +151,10 @@ func contextWithSignal(sigs ...os.Signal) context.Context {
 
 	return ctx
 }
+
+const panicMessage = `
+!!     Uh oh. Something went wrong.
+!!     If this problem keeps happening feel free to report an issue at
+!!
+!!     https://github.com/auth0/auth0-cli/issues/new/choose
+`
diff --git a/internal/instrumentation/instrumentation.go b/internal/instrumentation/instrumentation.go
index 313c30095..385ff91a4 100644
--- a/internal/instrumentation/instrumentation.go
+++ b/internal/instrumentation/instrumentation.go
@@ -11,13 +11,13 @@ var SentryDSN string
 
 // ReportException is designed to be called once as the CLI exits. We're
 // purposefully initializing a client all the time given this context.
-func ReportException(err error) {
+func ReportException(err error) bool {
 	if SentryDSN == "" {
-		return
+		return false
 	}
 
 	if err := sentry.Init(sentry.ClientOptions{Dsn: SentryDSN}); err != nil {
-		return
+		return false
 	}
 
 	// Flush buffered events before the program terminates.
@@ -25,4 +25,5 @@ func ReportException(err error) {
 
 	// Allow up to 2s to flush, otherwise quit.
 	sentry.Flush(2 * time.Second)
+	return true
 }