Function TestServiceFinish

internal/telemetry/telemetry_test.go:365–430

(t *testing.T)

}

func TestServiceFinish(t *testing.T) {
	t.Run("logs none when no events recorded", func(t *testing.T) {
		// Given an invocation without events and log delivery
		t.Cleanup(stubDeviceID("test-device"))
		var buf bytes.Buffer
		service := NewService(LogFlusher(&buf, false))

		// When the invocation finishes
		service.Finish()

		// Then log mode explains the absence of telemetry
		assert.Equal(t, "Telemetry payload: none\n", buf.String())
	})

	t.Run("delivers events with merged dimensions", func(t *testing.T) {
		// Given an invocation with common dimensions
		t.Cleanup(stubDeviceID("test-device"))
		var captured SendTelemetryPayload
		service := NewService(func(p SendTelemetryPayload) { captured = p },
			WithAdditionalCommonDimensions(ghtelemetry.Dimensions{
				"version": "2.45.0",
				"agent":   "none",
			}),
		)

		// When an event with its own dimensions and measures is completed and delivered
		service.Record(ghtelemetry.Event{
			Type:       "command_invocation",
			Dimensions: map[string]string{"command": "gh pr list"},
			Measures:   map[string]int64{"duration_ms": 150},
		})
		service.Finish()

		// Then the payload includes both common and event-specific facts
		require.Len(t, captured.Events, 1)
		event := captured.Events[0]
		assert.Equal(t, "command_invocation", event.Type)
		assert.Equal(t, "gh pr list", event.Dimensions["command"])
		assert.Equal(t, "2.45.0", event.Dimensions["version"])
		assert.Equal(t, "none", event.Dimensions["agent"])
		assert.Equal(t, "test-device", event.Dimensions["device_id"])
		assert.NotEmpty(t, event.Dimensions["timestamp"])
		assert.NotEmpty(t, event.Dimensions["invocation_id"])
		assert.NotEmpty(t, event.Dimensions["os"])
		assert.NotEmpty(t, event.Dimensions["architecture"])
		assert.Equal(t, int64(150), event.Measures["duration_ms"])
	})

	t.Run("event dimensions override common dimensions", func(t *testing.T) {
		// Given common and event dimensions share a key
		t.Cleanup(stubDeviceID("test-device"))
		var captured SendTelemetryPayload
		service := NewService(func(p SendTelemetryPayload) { captured = p }, WithAdditionalCommonDimensions(ghtelemetry.Dimensions{"shared": "common"}))
		service.Record(ghtelemetry.Event{
			Type:       "test",
			Dimensions: map[string]string{"shared": "event-level"},
		})