EnvelopeTests

Author: jamescrosswell

src/Sentry/Protocol/Envelopes/EnvelopeItem.cs

@@ -10,7 +10,7 @@ namespace Sentry.Protocol.Envelopes;
 /// </summary>
 public sealed class EnvelopeItem : ISerializable, IDisposable
 {
-    private const string TypeKey = "type";
+    internal const string TypeKey = "type";
 
     internal const string TypeValueEvent = "event";
     internal const string TypeValueFeedback = "feedback";

test/Sentry.Tests/Protocol/Envelopes/EnvelopeTests.cs

@@ -819,6 +819,90 @@ public async Task Roundtrip_WithUserFeedback_Success()
         envelopeRoundtrip.Should().BeEquivalentTo(envelope);
     }
 
+    [Fact]
+    public async Task Roundtrip_WithFeedback_Success()
+    {
+        // Arrange
+        var feedback = new SentryFeedback(
+            "Everything is great!",
+            "[email protected]",
+            "Someone Nice",
+            "fake-replay-id",
+            "https://www.example.com",
+            SentryId.Create()
+        );
+        var evt = new SentryEvent { Level = SentryLevel.Info,
+            Contexts =
+            {
+                Feedback = feedback
+            }
+        };
+
+        using var envelope = Envelope.FromFeedback(evt);
+
+        using var stream = new MemoryStream();
+
+        // Act
+        await envelope.SerializeAsync(stream, _testOutputLogger);
+        stream.Seek(0, SeekOrigin.Begin);
+
+        using var envelopeRoundtrip = await Envelope.DeserializeAsync(stream);
+
+        // Assert
+        envelopeRoundtrip.Should().BeEquivalentTo(envelope);
+    }
+
+    [Fact]
+    public void FromFeedback_NoFeedbackContext_Throws()
+    {
+        // Arrange
+        var evt = new SentryEvent { Level = SentryLevel.Info };
+
+        // Act
+        Action act = () => Envelope.FromFeedback(evt);
+
+        // Assert
+        act.Should().Throw<ArgumentException>()
+            .WithMessage("Unable to create envelope - the event does not contain any feedback.");
+    }
+
+    [Fact]
+    public void FromFeedback_MultipleAttachments_LogsWarning()
+    {
+        // Arrange
+        var feedback = new SentryFeedback(
+            "Everything is great!",
+            "[email protected]",
+            "Someone Nice",
+            "fake-replay-id",
+            "https://www.example.com",
+            SentryId.Create()
+        );
+        var evt = new SentryEvent { Level = SentryLevel.Info,
+            Contexts =
+            {
+                Feedback = feedback
+            }
+        };
+        var logger = Substitute.For<IDiagnosticLogger>();
+        logger.IsEnabled(Arg.Any<SentryLevel>()).Returns(true);
+
+        List<SentryAttachment> attachments = [
+            AttachmentHelper.FakeAttachment("file1.txt"), AttachmentHelper.FakeAttachment("file2.txt")
+        ];
+
+        // Act
+        using var envelope = Envelope.FromFeedback(evt, logger, attachments);
+
+        // Assert
+        logger.Received(1).Log(
+            SentryLevel.Warning,
+            Arg.Is<string>(m => m.Contains("Feedback can only contain one attachment")),
+            null,
+            Arg.Any<object[]>());
+        envelope.Items.Should().ContainSingle(item => item.Header[EnvelopeItem.TypeKey].ToString() == EnvelopeItem.TypeValueAttachment);
+    }
+
     [Fact]
     public async Task Roundtrip_WithSession_Success()
     {