inline telemetry lifecycle event calls

Author: carole-lavillonniere

internal/container/start.go

@@ -42,34 +42,6 @@ type StartOptions struct {
 	Telemetry        *telemetry.Client
 }
 
-func emitEmulatorStartError(ctx context.Context, tel *telemetry.Client, c runtime.ContainerConfig, errorCode, errorMsg string) {
-	if tel == nil {
-		return
-	}
-	tel.EmitEmulatorLifecycleEvent(ctx, telemetry.LifecycleEvent{
-		EventType: telemetry.LifecycleStartError,
-		Emulator:  c.EmulatorType,
-		Image:     c.Image,
-		ErrorCode: errorCode,
-		ErrorMsg:  errorMsg,
-	})
-}
-
-func emitEmulatorStartSuccess(ctx context.Context, tel *telemetry.Client, c runtime.ContainerConfig, containerID string, durationMS int64, pulled bool, info *telemetry.LocalStackInfo) {
-	if tel == nil {
-		return
-	}
-	tel.EmitEmulatorLifecycleEvent(ctx, telemetry.LifecycleEvent{
-		EventType:      telemetry.LifecycleStartSuccess,
-		Emulator:       c.EmulatorType,
-		Image:          c.Image,
-		ContainerID:    containerID,
-		DurationMS:     durationMS,
-		Pulled:         pulled,
-		LocalStackInfo: info,
-	})
-}
-
 func Start(ctx context.Context, rt runtime.Runtime, sink output.Sink, opts StartOptions, interactive bool) error {
 	if err := rt.IsHealthy(ctx); err != nil {
 		rt.EmitUnhealthyError(sink, err)
@@ -87,9 +59,7 @@ func Start(ctx context.Context, rt runtime.Runtime, sink output.Sink, opts Start
 		return err
 	}
 
-	if opts.Telemetry != nil {
-		opts.Telemetry.SetAuthToken(token)
-	}
+	opts.Telemetry.SetAuthToken(token)
 
 	if hasDuplicateContainerTypes(opts.Containers) {
 		output.EmitWarning(sink, "Multiple emulators of the same type are defined in your config; this setup is not supported yet")
@@ -275,7 +245,13 @@ func pullImages(ctx context.Context, rt runtime.Runtime, sink output.Sink, tel *
 				Title:   fmt.Sprintf("Failed to pull %s", c.Image),
 				Summary: err.Error(),
 			})
-			emitEmulatorStartError(ctx, tel, c, telemetry.ErrCodeImagePullFailed, err.Error())
+			tel.EmitEmulatorLifecycleEvent(ctx, telemetry.LifecycleEvent{
+				EventType: telemetry.LifecycleStartError,
+				Emulator:  c.EmulatorType,
+				Image:     c.Image,
+				ErrorCode: telemetry.ErrCodeImagePullFailed,
+				ErrorMsg:  err.Error(),
+			})
 			return nil, output.NewSilentError(fmt.Errorf("failed to pull image %s: %w", c.Image, err))
 		}
 		output.EmitSpinnerStop(sink)
@@ -337,21 +313,41 @@ func startContainers(ctx context.Context, rt runtime.Runtime, sink output.Sink,
 		output.EmitStatus(sink, "starting", c.Name, "")
 		containerID, err := rt.Start(ctx, c)
 		if err != nil {
-			emitEmulatorStartError(ctx, tel, c, telemetry.ErrCodeStartFailed, err.Error())
+			tel.EmitEmulatorLifecycleEvent(ctx, telemetry.LifecycleEvent{
+				EventType: telemetry.LifecycleStartError,
+				Emulator:  c.EmulatorType,
+				Image:     c.Image,
+				ErrorCode: telemetry.ErrCodeStartFailed,
+				ErrorMsg:  err.Error(),
+			})
 			return fmt.Errorf("failed to start LocalStack: %w", err)
 		}
 
 		output.EmitStatus(sink, "waiting", c.Name, "")
 		healthURL := fmt.Sprintf("http://localhost:%s%s", c.Port, c.HealthPath)
 		if err := awaitStartup(ctx, rt, sink, containerID, "LocalStack", healthURL); err != nil {
-			emitEmulatorStartError(ctx, tel, c, telemetry.ErrCodeStartFailed, err.Error())
+			tel.EmitEmulatorLifecycleEvent(ctx, telemetry.LifecycleEvent{
+				EventType: telemetry.LifecycleStartError,
+				Emulator:  c.EmulatorType,
+				Image:     c.Image,
+				ErrorCode: telemetry.ErrCodeStartFailed,
+				ErrorMsg:  err.Error(),
+			})
 			return err
 		}
 
 		output.EmitStatus(sink, "ready", c.Name, fmt.Sprintf("containerId: %s", containerID[:12]))
 
 		lsInfo, _ := fetchLocalStackInfo(ctx, c.Port)
-		emitEmulatorStartSuccess(ctx, tel, c, containerID[:12], time.Since(startTime).Milliseconds(), pulled[c.Name], lsInfo)
+		tel.EmitEmulatorLifecycleEvent(ctx, telemetry.LifecycleEvent{
+			EventType:      telemetry.LifecycleStartSuccess,
+			Emulator:       c.EmulatorType,
+			Image:          c.Image,
+			ContainerID:    containerID[:12],
+			DurationMS:     time.Since(startTime).Milliseconds(),
+			Pulled:         pulled[c.Name],
+			LocalStackInfo: lsInfo,
+		})
 	}
 	return nil
 }
@@ -374,7 +370,13 @@ func selectContainersToStart(ctx context.Context, rt runtime.Runtime, sink outpu
 		}
 		if err := ports.CheckAvailable(c.Port); err != nil {
 			emitPortInUseError(sink, c.Port)
-			emitEmulatorStartError(ctx, tel, c, telemetry.ErrCodePortConflict, err.Error())
+			tel.EmitEmulatorLifecycleEvent(ctx, telemetry.LifecycleEvent{
+				EventType: telemetry.LifecycleStartError,
+				Emulator:  c.EmulatorType,
+				Image:     c.Image,
+				ErrorCode: telemetry.ErrCodePortConflict,
+				ErrorMsg:  err.Error(),
+			})
 			return nil, output.NewSilentError(err)
 		}
 		filtered = append(filtered, c)
@@ -423,7 +425,13 @@ func validateLicense(ctx context.Context, sink output.Sink, opts StartOptions, t
 		if errors.As(err, &licErr) && licErr.Detail != "" {
 			opts.Logger.Error("license server response (HTTP %d): %s", licErr.Status, licErr.Detail)
 		}
-		emitEmulatorStartError(ctx, tel, containerConfig, telemetry.ErrCodeLicenseInvalid, err.Error())
+		tel.EmitEmulatorLifecycleEvent(ctx, telemetry.LifecycleEvent{
+			EventType: telemetry.LifecycleStartError,
+			Emulator:  containerConfig.EmulatorType,
+			Image:     containerConfig.Image,
+			ErrorCode: telemetry.ErrCodeLicenseInvalid,
+			ErrorMsg:  err.Error(),
+		})
 		return fmt.Errorf("license validation failed for %s:%s: %w", containerConfig.ProductName, version, err)
 	}
 

internal/container/stop.go

@@ -52,14 +52,12 @@ func Stop(ctx context.Context, rt runtime.Runtime, sink output.Sink, containers
 		output.EmitSpinnerStop(sink)
 		output.EmitSuccess(sink, "LocalStack stopped")
 
-		if opts.Telemetry != nil {
-			opts.Telemetry.EmitEmulatorLifecycleEvent(ctx, telemetry.LifecycleEvent{
-				EventType:      telemetry.LifecycleStop,
-				Emulator:       string(c.Type),
-				DurationMS:     time.Since(stopStart).Milliseconds(),
-				LocalStackInfo: lsInfo,
-			})
-		}
+		opts.Telemetry.EmitEmulatorLifecycleEvent(ctx, telemetry.LifecycleEvent{
+			EventType:      telemetry.LifecycleStop,
+			Emulator:       string(c.Type),
+			DurationMS:     time.Since(stopStart).Milliseconds(),
+			LocalStackInfo: lsInfo,
+		})
 	}
 
 	return nil

internal/container/telemetry_test.go

@@ -85,21 +85,29 @@ func TestStop_SkipsTelemetryWhenNil(t *testing.T) {
 	require.NoError(t, err)
 }
 
-func TestEmitEmulatorStartError_IsNoOpWhenTelNil(t *testing.T) {
-	c := runtime.ContainerConfig{EmulatorType: "aws", Image: "localstack/localstack-pro:latest"}
+func TestEmitEmulatorLifecycleEvent_IsNoOpWhenNil(t *testing.T) {
+	var tel *telemetry.Client
 	// Must not panic.
-	emitEmulatorStartError(context.Background(), nil, c, telemetry.ErrCodePortConflict, "port 4566 in use")
+	tel.EmitEmulatorLifecycleEvent(context.Background(), telemetry.LifecycleEvent{
+		EventType: telemetry.LifecycleStartError,
+		Emulator:  "aws",
+		Image:     "localstack/localstack-pro:latest",
+		ErrorCode: telemetry.ErrCodePortConflict,
+		ErrorMsg:  "port 4566 in use",
+	})
 }
 
-func TestEmitEmulatorStartError_SendsLifecycleEvent(t *testing.T) {
+func TestEmitEmulatorLifecycleEvent_SendsStartErrorEvent(t *testing.T) {
 	tel, ch := newCapturingTelClient(t)
 	tel.SetAuthToken("ls-xyz")
 
-	c := runtime.ContainerConfig{
-		EmulatorType: "aws",
-		Image:        "localstack/localstack-pro:latest",
-	}
-	emitEmulatorStartError(context.Background(), tel, c, telemetry.ErrCodePortConflict, "port 4566 already in use")
+	tel.EmitEmulatorLifecycleEvent(context.Background(), telemetry.LifecycleEvent{
+		EventType: telemetry.LifecycleStartError,
+		Emulator:  "aws",
+		Image:     "localstack/localstack-pro:latest",
+		ErrorCode: telemetry.ErrCodePortConflict,
+		ErrorMsg:  "port 4566 already in use",
+	})
 	tel.Close()
 
 	var got map[string]any

internal/telemetry/client.go

@@ -36,6 +36,9 @@ type Client struct {
 // SetAuthToken stores the resolved auth token for inclusion in telemetry events.
 // Call this once the token is known (e.g. after keyring resolution or interactive login).
 func (c *Client) SetAuthToken(token string) {
+	if c == nil {
+		return
+	}
 	c.authToken = token
 }
 

internal/telemetry/events.go

@@ -120,6 +120,9 @@ func (c *Client) EmitCommand(ctx context.Context, command string, flags []string
 // Environment field is populated automatically from the client state; any
 // value set by the caller is overwritten.
 func (c *Client) EmitEmulatorLifecycleEvent(ctx context.Context, event LifecycleEvent) {
+	if c == nil {
+		return
+	}
 	event.Environment = c.GetEnvironment()
 	c.Emit(ctx, "lstk_lifecycle", ToMap(event))
 }