Use SentryId for ISession.Id

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Unreleased
+
+### Changes
+
+- Use SentryId for ISession.Id ([#1052](https://github.com/getsentry/sentry-dotnet/pull/1052))
+
 ## 3.6.0-alpha.1
 
 ### Features

src/Sentry/ISession.cs

@@ -10,7 +10,7 @@ public interface ISession
         /// <summary>
         /// Session auto-generated ID.
         /// </summary>
-        string Id { get; }
+        SentryId Id { get; }
 
         /// <summary>
         /// Session distinct ID.

src/Sentry/Internal/Http/HttpTransport.cs

@@ -28,6 +28,7 @@ internal class HttpTransport : ITransport
 
         // Keep track of last discarded session init so that we can promote the next update.
         // We only track one because session updates are ordered.
+        // Using string instead of SentryId here so that we can use Interlocked.Exchange(...).
         private string? _lastDiscardedSessionInitId;
 
         internal const string DefaultErrorMessage = "No message";
@@ -65,7 +66,7 @@ private Envelope ProcessEnvelope(Envelope envelope, DateTimeOffset instant)
                     // Check if session update with init=true
                     if (envelopeItem.Payload is JsonSerializable {Source: SessionUpdate {IsInitial: true} discardedSessionUpdate})
                     {
-                        _lastDiscardedSessionInitId = discardedSessionUpdate.Id;
+                        _lastDiscardedSessionInitId = discardedSessionUpdate.Id.ToString();
 
                         _options.DiagnosticLogger?.LogDebug(
                             "Discarded envelope item containing initial session update (SID: {0}).",
@@ -92,7 +93,7 @@ private Envelope ProcessEnvelope(Envelope envelope, DateTimeOffset instant)
                 // If it's a session update (not discarded) with init=false, check if it continues
                 // a session with previously dropped init and, if so, promote this update to init=true.
                 if (envelopeItem.Payload is JsonSerializable {Source: SessionUpdate {IsInitial: false} sessionUpdate} &&
-                    string.Equals(sessionUpdate.Id, Interlocked.Exchange(ref _lastDiscardedSessionInitId, null),
+                    string.Equals(sessionUpdate.Id.ToString(), Interlocked.Exchange(ref _lastDiscardedSessionInitId, null),
                         StringComparison.Ordinal))
                 {
                     var modifiedEnvelopeItem = new EnvelopeItem(

src/Sentry/Session.cs

@@ -10,7 +10,7 @@ namespace Sentry
     public class Session : ISession
     {
         /// <inheritdoc />
-        public string Id { get; }
+        public SentryId Id { get; }
 
         /// <inheritdoc />
         public string? DistinctId { get; }
@@ -43,7 +43,7 @@ public class Session : ISession
         private int _sequenceNumber = -1;
 
         internal Session(
-            string id,
+            SentryId id,
             string? distinctId,
             DateTimeOffset startTimestamp,
             string release,
@@ -65,7 +65,7 @@ internal Session(
         /// </summary>
         public Session(string? distinctId, string release, string? environment)
             : this(
-                Guid.NewGuid().ToString(),
+                SentryId.Create(),
                 distinctId,
                 DateTimeOffset.Now,
                 release,

src/Sentry/SessionUpdate.cs

@@ -11,7 +11,7 @@ namespace Sentry
     public class SessionUpdate : ISession, IJsonSerializable
     {
         /// <inheritdoc />
-        public string Id { get; }
+        public SentryId Id { get; }
 
         /// <inheritdoc />
         public string? DistinctId { get; }
@@ -61,7 +61,7 @@ public class SessionUpdate : ISession, IJsonSerializable
         /// Initializes a new instance of <see cref="SessionUpdate"/>.
         /// </summary>
         public SessionUpdate(
-            string id,
+            SentryId id,
             string? distinctId,
             DateTimeOffset startTimestamp,
             string release,
@@ -121,7 +121,7 @@ public void WriteTo(Utf8JsonWriter writer)
         {
             writer.WriteStartObject();
 
-            writer.WriteString("sid", Id);
+            writer.WriteSerializable("sid", Id);
 
             if (!string.IsNullOrWhiteSpace(DistinctId))
             {
@@ -176,7 +176,7 @@ public void WriteTo(Utf8JsonWriter writer)
         /// </summary>
         public static SessionUpdate FromJson(JsonElement json)
         {
-            var id = json.GetProperty("sid").GetStringOrThrow();
+            var id = json.GetProperty("sid").GetStringOrThrow().Pipe(SentryId.Parse);
             var distinctId = json.GetPropertyOrNull("did")?.GetString();
             var startTimestamp = json.GetProperty("started").GetDateTimeOffset();
             var release = json.GetProperty("attrs").GetProperty("release").GetStringOrThrow();

test/Sentry.Tests/GlobalSessionManagerTests.cs

@@ -48,7 +48,7 @@ public void StartSession_ReleaseSet_CreatesNewSession()
 
             // Assert
             sessionUpdate.Should().NotBeNull();
-            sessionUpdate?.Id.Should().NotBeNullOrWhiteSpace();
+            sessionUpdate?.Id.Should().NotBe(SentryId.Empty);
             sessionUpdate?.Release.Should().NotBeNullOrWhiteSpace();
         }
 

test/Sentry.Tests/SessionTests.cs

@@ -13,7 +13,7 @@ public void Serialization_Session_Success()
         {
             // Arrange
             var session = new Session(
-                "foo",
+                SentryId.Parse("75302ac48a024bde9a3b3734a82e36c8"),
                 "bar",
                 DateTimeOffset.Parse("2020-01-01T00:00:00+00:00", CultureInfo.InvariantCulture),
                 "release123",
@@ -41,7 +41,7 @@ public void Serialization_Session_Success()
             // Assert
             json.Should().Be(
                 "{" +
-                "\"sid\":\"foo\"," +
+                "\"sid\":\"75302ac48a024bde9a3b3734a82e36c8\"," +
                 "\"did\":\"bar\"," +
                 "\"init\":true," +
                 "\"started\":\"2020-01-01T00:00:00+00:00\"," +
@@ -65,7 +65,7 @@ public void CreateUpdate_IncrementsSequenceNumber()
         {
             // Arrange
             var session = new Session(
-                "foo",
+                SentryId.Parse("75302ac48a024bde9a3b3734a82e36c8"),
                 "bar",
                 DateTimeOffset.Parse("2020-01-01T00:00:00+00:00", CultureInfo.InvariantCulture),
                 "release123",