Skip to content

fix: Add generic to evaluation event builder #500

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 25, 2025
Merged

fix: Add generic to evaluation event builder #500

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
185f643
refactor: make EvaluationEventBuilder generic and update tests accord…
askpt Jun 25, 2025
91b980e
refactor: make EvaluationEventBuilder generic in tests for type safety
askpt Jun 25, 2025
8d4eb13
refactor: remove unused EvaluationEventBuilder instance in tests
askpt Jun 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/OpenFeature/Telemetry/EvaluationEventBuilder.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,22 @@
/// <summary>
/// Class for creating evaluation events for feature flags.
/// </summary>
public sealed class EvaluationEventBuilder
public sealed class EvaluationEventBuilder<T>
{
private const string EventName = "feature_flag.evaluation";

/// <summary>
/// Gets the default instance of the <see cref="EvaluationEventBuilder"/>.
/// Gets the default instance of the <see cref="EvaluationEventBuilder{T}"/>.
/// </summary>
public static EvaluationEventBuilder Default { get; } = new();
public static EvaluationEventBuilder<T> Default { get; } = new();

Check warning on line 16 in src/OpenFeature/Telemetry/EvaluationEventBuilder.cs

View check run for this annotation

Codecov / codecov/patch

src/OpenFeature/Telemetry/EvaluationEventBuilder.cs#L16 

Added line #L16 was not covered by tests

/// <summary>
/// Creates an evaluation event based on the provided hook context and flag evaluation details.
/// </summary>
/// <param name="hookContext">The context of the hook containing flag key and provider metadata.</param>
/// <param name="details">The details of the flag evaluation including reason, variant, and metadata.</param>
/// <returns>An instance of <see cref="EvaluationEvent"/> containing the event name, attributes, and body.</returns>
public EvaluationEvent Build(HookContext<Value> hookContext, FlagEvaluationDetails<Value> details)
public static EvaluationEvent Build(HookContext<T> hookContext, FlagEvaluationDetails<T> details)
{
var attributes = new Dictionary<string, object?>
{
Expand Down
16 changes: 7 additions & 9 deletions test/OpenFeature.Tests/Telemetry/EvaluationEventBuilderTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ namespace OpenFeature.Tests.Telemetry;

public class EvaluationEventBuilderTests
{
private readonly EvaluationEventBuilder _builder = EvaluationEventBuilder.Default;

[Fact]
public void Build_ShouldReturnEventWithCorrectAttributes()
{
Expand All @@ -25,7 +23,7 @@ public void Build_ShouldReturnEventWithCorrectAttributes()
reason: "reason", variant: "variant", flagMetadata: flagMetadata);

// Act
var evaluationEvent = _builder.Build(hookContext, details);
var evaluationEvent = EvaluationEventBuilder<Value>.Build(hookContext, details);

// Assert
Assert.Equal("feature_flag.evaluation", evaluationEvent.Name);
Expand Down Expand Up @@ -55,7 +53,7 @@ public void Build_ShouldHandleErrorDetails()
errorMessage: "errorMessage", reason: "reason", variant: "variant", flagMetadata: flagMetadata);

// Act
var evaluationEvent = _builder.Build(hookContext, details);
var evaluationEvent = EvaluationEventBuilder<Value>.Build(hookContext, details);

// Assert
Assert.Equal("general", evaluationEvent.Attributes[TelemetryConstants.ErrorCode]);
Expand All @@ -79,7 +77,7 @@ public void Build_ShouldHandleMissingVariant()
reason: "reason", variant: null, flagMetadata: flagMetadata);

// Act
var evaluationEvent = _builder.Build(hookContext, details);
var evaluationEvent = EvaluationEventBuilder<Value>.Build(hookContext, details);

// Assert
Assert.Null(evaluationEvent.Attributes[TelemetryConstants.Variant]);
Expand All @@ -98,7 +96,7 @@ public void Build_ShouldHandleMissingFlagMetadata()
reason: "reason", variant: "", flagMetadata: flagMetadata);

// Act
var evaluationEvent = _builder.Build(hookContext, details);
var evaluationEvent = EvaluationEventBuilder<Value>.Build(hookContext, details);

// Assert
Assert.Null(evaluationEvent.Attributes[TelemetryConstants.ContextId]);
Expand All @@ -122,7 +120,7 @@ public void Build_ShouldHandleMissingReason(string? reason)
reason: reason, variant: "", flagMetadata: flagMetadata);

// Act
var evaluationEvent = _builder.Build(hookContext, details);
var evaluationEvent = EvaluationEventBuilder<Value>.Build(hookContext, details);

// Assert
Assert.Equal(Reason.Unknown.ToLowerInvariant(), evaluationEvent.Attributes[TelemetryConstants.Reason]);
Expand All @@ -144,7 +142,7 @@ public void Build_ShouldHandleErrorWithEmptyErrorMessage(string? errorMessage)
errorMessage: errorMessage, reason: "reason", variant: "", flagMetadata: flagMetadata);

// Act
var evaluationEvent = _builder.Build(hookContext, details);
var evaluationEvent = EvaluationEventBuilder<Value>.Build(hookContext, details);

// Assert
Assert.Equal("general", evaluationEvent.Attributes[TelemetryConstants.ErrorCode]);
Expand All @@ -164,7 +162,7 @@ public void Build_ShouldIncludeValueAttributeInEvent()
reason: "reason", variant: "variant", flagMetadata: new ImmutableMetadata());

// Act
var evaluationEvent = _builder.Build(hookContext, details);
var evaluationEvent = EvaluationEventBuilder<Value>.Build(hookContext, details);

// Assert
Assert.Equal(testValue, evaluationEvent.Attributes[TelemetryConstants.Value]);
Expand Down