TelemetryTests.cs

/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *--------------------------------------------------------------------------------------------*/

using System.Diagnostics;
using System.Reflection;
using Xunit;

namespace GitHub.Copilot.Test.Unit;

public class TelemetryTests
{
    [Fact]
    public void TelemetryConfig_DefaultValues_AreNull()
    {
        var config = new TelemetryConfig();

        Assert.Null(config.OtlpEndpoint);
        Assert.Null(config.FilePath);
        Assert.Null(config.ExporterType);
        Assert.Null(config.SourceName);
        Assert.Null(config.CaptureContent);
    }

    [Fact]
    public void TelemetryConfig_CanSetAllProperties()
    {
        var config = new TelemetryConfig
        {
            OtlpEndpoint = "http://localhost:4318",
            FilePath = "/tmp/traces.json",
            ExporterType = "otlp-http",
            SourceName = "my-app",
            CaptureContent = true
        };

        Assert.Equal("http://localhost:4318", config.OtlpEndpoint);
        Assert.Equal("/tmp/traces.json", config.FilePath);
        Assert.Equal("otlp-http", config.ExporterType);
        Assert.Equal("my-app", config.SourceName);
        Assert.True(config.CaptureContent);
    }

    [Fact]
    public void CopilotClientOptions_Telemetry_DefaultsToNull()
    {
        var options = new CopilotClientOptions();

        Assert.Null(options.Telemetry);
    }

    [Fact]
    public void CopilotClientOptions_Clone_CopiesTelemetry()
    {
        var telemetry = new TelemetryConfig
        {
            OtlpEndpoint = "http://localhost:4318",
            ExporterType = "otlp-http"
        };

        var options = new CopilotClientOptions { Telemetry = telemetry };
        var clone = options.Clone();

        Assert.Same(telemetry, clone.Telemetry);
    }

    [Fact]
    public void TelemetryHelpers_Restores_W3C_Trace_Context()
    {
        using var parent = new Activity("parent");
        parent.SetIdFormat(ActivityIdFormat.W3C);
        parent.TraceStateString = "state=value";
        parent.Start();

        var traceContext = InvokeTelemetryHelper<(string? Traceparent, string? Tracestate)>("GetTraceContext");
        Assert.Equal(parent.Id, traceContext.Traceparent);
        Assert.Equal("state=value", traceContext.Tracestate);

        parent.Stop();
        using var restored = InvokeTelemetryHelper<Activity?>(
            "RestoreTraceContext",
            traceContext.Traceparent,
            traceContext.Tracestate);

        Assert.NotNull(restored);
        Assert.Equal(parent.Id, restored.ParentId);
        Assert.Equal("state=value", restored.TraceStateString);

        Assert.Null(InvokeTelemetryHelper<Activity?>("RestoreTraceContext", "not-a-traceparent", null));
    }

    private static T InvokeTelemetryHelper<T>(string name, params object?[] args)
    {
        var helperType = typeof(CopilotClient).Assembly.GetType("GitHub.Copilot.TelemetryHelpers", throwOnError: true)!;
        var method = helperType.GetMethod(name, BindingFlags.Static | BindingFlags.NonPublic)!;
        return (T)method.Invoke(null, args)!;
    }
}