fix: Cache sync event details to track Cmd+C. (#18409)

marianogappa · web-flow · commit a4e1a0335bbd · 2024-06-26T15:30:21.000Z
In order to fix the issue described here: cloudquery/cloudquery-issues#1911 (comment) I'm caching the event details in a global variable except on `LoginSuccess` as suggested by @erezrokah. Testing: Successful sync ![Screenshot 2024-06-26 at 16 08 18](https://github.com/cloudquery/cloudquery/assets/1078546/e7c76d7a-38ea-4fc9-8e62-ce91edebbbc8) Cmd+C during sync ![Screenshot 2024-06-26 at 16 08 55](https://github.com/cloudquery/cloudquery/assets/1078546/1cc57dbc-071d-4cbc-ad93-99989c5fdb75)
diff --git a/cli/internal/analytics/client.go b/cli/internal/analytics/client.go
@@ -15,7 +15,8 @@ import (
 )
 
 var (
-	client rudderstack.Client
+	client                 rudderstack.Client
+	cachedSyncEventDetails *eventDetails
 )
 
 type eventDetails struct {
@@ -51,7 +52,15 @@ func getEnvironment() string {
 	return "cli"
 }
 
-func getEventDetails(ctx context.Context) *eventDetails {
+// getSyncEventDetails returns the cached event details if available, otherwise it fetches the details from the API
+func getSyncEventDetails(ctx context.Context) *eventDetails {
+	if cachedSyncEventDetails == nil {
+		refreshSyncEventDetails(ctx)
+	}
+	return cachedSyncEventDetails
+}
+
+func refreshSyncEventDetails(ctx context.Context) *eventDetails {
 	tc := cqauth.NewTokenClient()
 	token, err := tc.GetToken()
 	if err != nil {
@@ -63,19 +72,24 @@ func getEventDetails(ctx context.Context) *eventDetails {
 	}
 	currentTeam, _ := internalAuth.GetTeamForToken(ctx, token)
 
-	return &eventDetails{
+	eventDetails := &eventDetails{
 		user:        *user,
 		currentTeam: currentTeam,
 		environment: getEnvironment(),
 	}
+
+	// Cache event details for future use
+	cachedSyncEventDetails = eventDetails
+
+	return eventDetails
 }
 
 func TrackLoginSuccess(ctx context.Context, invocationUUID uuid.UUID) {
 	if client == nil {
 		return
 	}
 
-	details := getEventDetails(ctx)
+	details := refreshSyncEventDetails(ctx)
 	if details == nil {
 		return
 	}
@@ -124,7 +138,7 @@ func TrackSyncStarted(ctx context.Context, invocationUUID uuid.UUID, event SyncS
 		return
 	}
 
-	details := getEventDetails(ctx)
+	details := getSyncEventDetails(ctx)
 	if details == nil {
 		return
 	}
@@ -150,7 +164,7 @@ func TrackSyncCompleted(ctx context.Context, invocationUUID uuid.UUID, event Syn
 		return
 	}
 
-	details := getEventDetails(ctx)
+	details := getSyncEventDetails(ctx)
 	if details == nil {
 		return
 	}

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,8 @@ import (`
`15`	`15`	`)`
`16`	`16`
`17`	`17`	`var (`
`18`		`- client rudderstack.Client`
	`18`	`+ client rudderstack.Client`
	`19`	`+ cachedSyncEventDetails *eventDetails`
`19`	`20`	`)`
`20`	`21`
`21`	`22`	`type eventDetails struct {`
`@@ -51,7 +52,15 @@ func getEnvironment() string {`
`51`	`52`	`return "cli"`
`52`	`53`	`}`
`53`	`54`
`54`		`-func getEventDetails(ctx context.Context) *eventDetails {`
	`55`	`+// getSyncEventDetails returns the cached event details if available, otherwise it fetches the details from the API`
	`56`	`+func getSyncEventDetails(ctx context.Context) *eventDetails {`
	`57`	`+ if cachedSyncEventDetails == nil {`
	`58`	`+ refreshSyncEventDetails(ctx)`
	`59`	`+ }`
	`60`	`+ return cachedSyncEventDetails`
	`61`	`+}`
	`62`	`+`
	`63`	`+func refreshSyncEventDetails(ctx context.Context) *eventDetails {`
`55`	`64`	`tc := cqauth.NewTokenClient()`
`56`	`65`	`token, err := tc.GetToken()`
`57`	`66`	`if err != nil {`
`@@ -63,19 +72,24 @@ func getEventDetails(ctx context.Context) *eventDetails {`
`63`	`72`	`}`
`64`	`73`	`currentTeam, _ := internalAuth.GetTeamForToken(ctx, token)`
`65`	`74`
`66`		`- return &eventDetails{`
	`75`	`+ eventDetails := &eventDetails{`
`67`	`76`	`user: *user,`
`68`	`77`	`currentTeam: currentTeam,`
`69`	`78`	`environment: getEnvironment(),`
`70`	`79`	`}`
	`80`	`+`
	`81`	`+ // Cache event details for future use`
	`82`	`+ cachedSyncEventDetails = eventDetails`
	`83`	`+`
	`84`	`+ return eventDetails`
`71`	`85`	`}`
`72`	`86`
`73`	`87`	`func TrackLoginSuccess(ctx context.Context, invocationUUID uuid.UUID) {`
`74`	`88`	`if client == nil {`
`75`	`89`	`return`
`76`	`90`	`}`
`77`	`91`
`78`		`- details := getEventDetails(ctx)`
	`92`	`+ details := refreshSyncEventDetails(ctx)`
`79`	`93`	`if details == nil {`
`80`	`94`	`return`
`81`	`95`	`}`
`@@ -124,7 +138,7 @@ func TrackSyncStarted(ctx context.Context, invocationUUID uuid.UUID, event SyncS`
`124`	`138`	`return`
`125`	`139`	`}`
`126`	`140`
`127`		`- details := getEventDetails(ctx)`
	`141`	`+ details := getSyncEventDetails(ctx)`
`128`	`142`	`if details == nil {`
`129`	`143`	`return`
`130`	`144`	`}`
`@@ -150,7 +164,7 @@ func TrackSyncCompleted(ctx context.Context, invocationUUID uuid.UUID, event Syn`
`150`	`164`	`return`
`151`	`165`	`}`
`152`	`166`
`153`		`- details := getEventDetails(ctx)`
	`167`	`+ details := getSyncEventDetails(ctx)`
`154`	`168`	`if details == nil {`
`155`	`169`	`return`
`156`	`170`	`}`