Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
89 changes: 81 additions & 8 deletions src/Sentry/MeasurementUnit.cs
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thought:

This is a similar implementation a coding agent on my end suggested when I gave it a try when looking at it with a friend of mine just last weekend 😉.

I'm not too certain if I'm happy with this approach, though:

  • the size of the struct is increasing
  • we embed more data into the assembly (via the string-arrays)

On the other hand, this (or a similar) implementation is necessary, in order to not change the IEquatable-semantics.

We were then experimenting with the struct only having a string field,
but that would change the Equality-semantics, where

  • MeasurementUnit.Duration.Millisecond == MeasurementUnit.Custom("millisecond")
    • old/this: would not be equal, because constructed differently
    • only with string field: would now become equal, being a behavioral change

Copy link
Copy Markdown
Member

@Flash0ver Flash0ver May 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wait ... actually ... I believe I am wrong concerning the size ... at least partially wrong

  • previous
    • System.Enum + System.String
    • on 64-bit: 8-byte-reference + 8-byte reference = 16B
    • on 32-bit: 4-byte-reference + 4-byte reference = 8B
  • this change
    • UnitKind enum (byte) + System.Int32 + System.String
    • on 64-bit: 1-byte enum + 4-byte int + 3-byte padding, 8-byte reference = 16B
    • on 32-bit: 1-byte enum + 3-byte padding + 4-byte int + 4-byte reference + padding = 12B

So we are only increasing the size of the struct by 4B on 32-bit systems/processes.

Yeah ... that's neglectable considering we no longer box to System.Enum.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

about the Equals-Semantics

If we would only keep a string field, assigning the string via a switch on constructions, we would simplify the code, reduce the struct size to 4B/8B (32-/64-bit systems); but we would change the Equals, as it would no longer matter whether the MeasurementUnit was constructed via MeasurementUnit.Custom or the respective implicit-ennum-conversion.

This being a behavioral change, we could simplify MeasurementUnit in the next Major ... or should we keep the Equals-Behavior as is, where there is a difference how the MeasurementUnit was constructed.

What do you think?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To err on the side of caution (since this API is probably quite widely used already), maybe we delay the behavioural change (and saving the extra 4B) until the next major release.

Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,80 @@ namespace Sentry;
/// <seealso href="https://getsentry.github.io/relay/relay_metrics/enum.MetricUnit.html"/>
public readonly partial struct MeasurementUnit : IEquatable<MeasurementUnit>
{
private readonly Enum? _unit;
private readonly UnitKind _kind;
private readonly int _value;
private readonly string? _name;

private MeasurementUnit(Enum unit)
private enum UnitKind : byte
{
_unit = unit;
None = 0,
Duration = 1,
Information = 2,
Fraction = 3,
Custom = 4
}

private static readonly string[] DurationNames =
[
"nanosecond",
"microsecond",
"millisecond",
"second",
"minute",
"hour",
"day",
"week"
];

private static readonly string[] InformationNames =
[
"bit",
"byte",
"kilobyte",
"kibibyte",
"megabyte",
"mebibyte",
"gigabyte",
"gibibyte",
"terabyte",
"tebibyte",
"petabyte",
"pebibyte",
"exabyte",
"exbibyte"
];

private static readonly string[] FractionNames =
[
"ratio",
"percent"
];

private MeasurementUnit(Duration unit)
{
_kind = UnitKind.Duration;
_value = (int)unit;
_name = null;
}

private MeasurementUnit(Information unit)
{
_kind = UnitKind.Information;
_value = (int)unit;
_name = null;
}

private MeasurementUnit(Fraction unit)
{
_kind = UnitKind.Fraction;
_value = (int)unit;
_name = null;
}

private MeasurementUnit(string name)
{
_unit = null;
_kind = UnitKind.Custom;
_value = default;
_name = name;
}

Expand Down Expand Up @@ -70,21 +132,32 @@ internal static MeasurementUnit Parse(string? name)
return Custom(name);
}

private string? GetPredefinedName()
{
return _kind switch
{
UnitKind.Duration when (uint)_value < (uint)DurationNames.Length => DurationNames[_value],
UnitKind.Information when (uint)_value < (uint)InformationNames.Length => InformationNames[_value],
UnitKind.Fraction when (uint)_value < (uint)FractionNames.Length => FractionNames[_value],
_ => null
};
}

/// <summary>
/// Returns the string representation of the measurement unit, as it will be sent to Sentry.
/// </summary>
public override string ToString() => _unit?.ToString().ToLowerInvariant() ?? _name ?? "";
public override string ToString() => ToNullableString() ?? "";

internal string? ToNullableString() => _unit?.ToString().ToLowerInvariant() ?? _name;
internal string? ToNullableString() => _name ?? GetPredefinedName();

/// <inheritdoc />
public bool Equals(MeasurementUnit other) => Equals(_unit, other._unit) && _name == other._name;
public bool Equals(MeasurementUnit other) => _kind == other._kind && _value == other._value && _name == other._name;

/// <inheritdoc />
public override bool Equals(object? obj) => obj is MeasurementUnit other && Equals(other);

/// <inheritdoc />
public override int GetHashCode() => HashCode.Combine(_unit, _name, _unit?.GetType());
public override int GetHashCode() => HashCode.Combine(_kind, _value, _name);

/// <summary>
/// Returns true if the operands are equal.
Expand Down
38 changes: 38 additions & 0 deletions test/Sentry.Tests/MeasurementUnitTests.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
namespace Sentry.Tests;

using System.Globalization;

public class MeasurementUnitTests
{
[Fact]
Expand Down Expand Up @@ -126,4 +128,40 @@ public void MixedInequalityWithCustom()
var m2 = MeasurementUnit.Duration.Second;
Assert.NotEqual(m1, m2);
}

[Fact]
public void DurationUnits_ToNullableString_MatchesLowercaseEnumNames()
{
foreach (var raw in Enum.GetValues(typeof(MeasurementUnit.Duration)))
{
var value = (MeasurementUnit.Duration)raw;
MeasurementUnit unit = (MeasurementUnit.Duration)raw;
var expected = value.ToString().ToLower(CultureInfo.InvariantCulture);
Assert.Equal(expected, unit.ToNullableString());
}
}

[Fact]
public void InformationUnits_ToNullableString_MatchesLowercaseEnumNames()
{
foreach (var raw in Enum.GetValues(typeof(MeasurementUnit.Information)))
{
var value = (MeasurementUnit.Information)raw;
MeasurementUnit unit = (MeasurementUnit.Information)raw;
var expected = value.ToString().ToLower(CultureInfo.InvariantCulture);
Assert.Equal(expected, unit.ToNullableString());
}
}

[Fact]
public void FractionUnits_ToNullableString_MatchesLowercaseEnumNames()
{
foreach (var raw in Enum.GetValues(typeof(MeasurementUnit.Fraction)))
{
var value = (MeasurementUnit.Fraction)raw;
MeasurementUnit unit = (MeasurementUnit.Fraction)raw;
var expected = value.ToString().ToLower(CultureInfo.InvariantCulture);
Assert.Equal(expected, unit.ToNullableString());
}
}
}
Loading