feat: user feedback support (#34)

* feat: user feedback support

* fix windows-pwsh tests

Author: vaind

modules/Sentry/public/Out-Sentry.ps1

@@ -3,6 +3,7 @@
 
 function Out-Sentry
 {
+    [OutputType([Sentry.SentryId])]
     [CmdletBinding(DefaultParameterSetName = 'ErrorRecord')]
     param(
         [Parameter(ValueFromPipeline = $true, ParameterSetName = 'ErrorRecord')]
@@ -32,7 +33,7 @@ function Out-Sentry
         }
 
         $options = Get-CurrentOptions
-        [Sentry.SentryEvent]$event_
+        [Sentry.SentryEvent]$event_ = $null
         $processor = [StackTraceProcessor]::new()
 
         if ($ErrorRecord -ne $null)
@@ -106,5 +107,4 @@ function Out-Sentry
                 $scope | ForEach-Object $EditScope
             })
     }
-    end {}
 }

tests/init.tests.ps1

@@ -91,15 +91,17 @@ Describe 'SentrySdk' {
     }
 
     It 'Out-Sentry does not crash when Sentry is not enabled' {
-        'message' | Out-Sentry -Debug
+        $eventId = 'message' | Out-Sentry -Debug
+        $eventId | Should -Be $null
     }
 
     It 'Out-Sentry does not capture when Sentry is not enabled' {
         $events = [System.Collections.Generic.List[Sentry.SentryEvent]]::new();
         $transport = [RecordingTransport]::new()
         StartSentryForEventTests ([ref] $events) ([ref] $transport)
         Stop-Sentry
-        'message' | Out-Sentry -Debug
+        $eventId = 'message' | Out-Sentry -Debug
+        $eventId | Should -Be $null
         $events.Count | Should -Be 0
     }
 }

tests/userfeedback.tests.ps1

@@ -0,0 +1,55 @@
+BeforeAll {
+    . "$PSScriptRoot/utils.ps1"
+}
+
+Describe 'UserFeedback' {
+    BeforeEach {
+        $events = [System.Collections.Generic.List[Sentry.SentryEvent]]::new();
+        $transport = [RecordingTransport]::new()
+        StartSentryForEventTests ([ref] $events) ([ref] $transport)
+    }
+
+    AfterEach {
+        $events.Clear()
+        $transport.Clear()
+        Stop-Sentry
+    }
+
+    It 'Out-Sentry returns an event ID for messages' {
+        $eventId = 'msg' | Out-Sentry
+        $eventId | Should -BeOfType [Sentry.SentryId]
+        $eventId.ToString().Length | Should -Be 32
+    }
+
+    It 'Out-Sentry returns an event ID for an error record' {
+        try
+        {
+            throw 'error'
+        }
+        catch
+        {
+            $eventId = $_ | Out-Sentry
+        }
+        $eventId | Should -BeOfType [Sentry.SentryId]
+        $eventId.ToString().Length | Should -Be 32
+    }
+
+    It 'Feedback gets captured' {
+        $eventId = 'msg' | Out-Sentry
+
+        $eventId | Should -BeOfType [Sentry.SentryId]
+        [Sentry.SentrySdk]::Flush()
+        $transport.Envelopes.Count | Should -Be 1
+
+        [Sentry.SentrySdk]::CaptureUserFeedback($eventId, 'email@example.com', 'comments', 'name')
+        [Sentry.SentrySdk]::Flush()
+        $transport.Envelopes.Count | Should -Be 2
+        $envelopeItem = $transport.Envelopes.ToArray()[1].Items[0]
+        $envelopeItem.Header['type'] | Should -Be 'user_report'
+        $envelopeItem.Payload.Source.EventId | Should -Be $eventId
+        $envelopeItem.Payload.Source.Name | Should -Be 'name'
+        $envelopeItem.Payload.Source.Email | Should -Be 'email@example.com'
+        $envelopeItem.Payload.Source.Comments | Should -Be 'comments'
+    }
+
+}

tests/utils.ps1

@@ -7,6 +7,11 @@ class RecordingTransport:Sentry.Extensibility.ITransport
         $this.envelopes.Enqueue($envelope);
         return [System.Threading.Tasks.Task]::CompletedTask;
     }
+
+    [void] Clear()
+    {
+        $this.envelopes = [System.Collections.Concurrent.ConcurrentQueue[Sentry.Protocol.Envelopes.Envelope]]::new()
+    }
 }
 
 class TestLogger:Sentry.Infrastructure.DiagnosticLogger