feat(feedback): capture envelopes

Samples/iOS-Swift/iOS-Swift-UITests/UserFeedbackUITests.swift

@@ -134,6 +134,11 @@ class UserFeedbackUITests: BaseUITest {
         XCTAssertEqual(try XCTUnwrap(emailField.value as? String), "[email protected]")
 
         XCTAssertEqual(try XCTUnwrap(messageTextView.value as? String), "", "The UITextView shouldn't have any initial text functioning as a placeholder; as UITextView has no placeholder property, the \"placeholder\" is a label on top of it.")
+
+        // TODO: go to Extras view
+        app.buttons["io.sentry.ui-test.button.get-feedback-envelope"].tap()
+        // TODO: pull contents out of text field
+        // TODO: validate contents
     }
 
     func testSubmitWithOnlyRequiredFieldsFilled() {

Samples/iOS-Swift/iOS-Swift/ExtraViewController.swift

@@ -185,4 +185,31 @@ class ExtraViewController: UIViewController {
 
         return pi
     }
+
+    // copied from ProfilingViewController.withProfile
+    @IBAction func getAllEnvelopes(_ sender: Any) {
+        let cachesDirectory = NSSearchPathForDirectoriesInDomains(.cachesDirectory, .userDomainMask, true).first!
+        let fm = FileManager.default
+        let dir = "\(cachesDirectory)/io.sentry/profiles"
+        let count = try! fm.contentsOfDirectory(atPath: dir).count
+        //swiftlint:disable empty_count
+//        guard first || count > 0 else {
+//            //swiftlint:enable empty_count
+//            profilingUITestDataMarshalingTextField.text = "<missing>"
+//            return
+//        }
+//        let fileName = "profile\(first ? 0 : count - 1)"
+//        let fullPath = "\(dir)/\(fileName)"
+//        
+//        if fm.fileExists(atPath: fullPath) {
+//            let url = NSURL.fileURL(withPath: fullPath)
+//            block(url)
+//            do {
+//                try fm.removeItem(atPath: fullPath)
+//            } catch {
+//                SentrySDK.capture(error: error)
+//            }
+//            return
+//        }
+    }
 }

Sentry.xcodeproj/project.pbxproj

@@ -3,7 +3,7 @@
 	archiveVersion = 1;
 	classes = {
 	};
-	objectVersion = 55;
+	objectVersion = 70;
 	objects = {
 
 /* Begin PBXBuildFile section */
@@ -714,6 +714,7 @@
 		84CFA4CA2C9DF884008DA5F4 /* SentryUserFeedbackWidget.swift in Sources */ = {isa = PBXBuildFile; fileRef = 84CFA4C92C9DF884008DA5F4 /* SentryUserFeedbackWidget.swift */; };
 		84CFA4CD2C9E0CA3008DA5F4 /* SentryUserFeedbackIntegration.m in Sources */ = {isa = PBXBuildFile; fileRef = 84CFA4CC2C9E0CA3008DA5F4 /* SentryUserFeedbackIntegration.m */; };
 		84CFA4CE2C9E0CA3008DA5F4 /* SentryUserFeedbackIntegration.h in Headers */ = {isa = PBXBuildFile; fileRef = 84CFA4CB2C9E0CA3008DA5F4 /* SentryUserFeedbackIntegration.h */; };
+		84DBC62C2CE82F12000C4904 /* SentryFeedback.swift in Sources */ = {isa = PBXBuildFile; fileRef = 84DBC62B2CE82F0E000C4904 /* SentryFeedback.swift */; };
 		84DEE86B2B686BD400A7BC17 /* SentrySamplerDecision.h in Headers */ = {isa = PBXBuildFile; fileRef = 84DEE86A2B686BD400A7BC17 /* SentrySamplerDecision.h */; };
 		84DEE8762B69AD6400A7BC17 /* SentryLaunchProfiling.h in Headers */ = {isa = PBXBuildFile; fileRef = 84DEE8752B69AD6400A7BC17 /* SentryLaunchProfiling.h */; };
 		84E13B842CBF1D91003B52EC /* SentryUserFeedbackWidgetButtonMegaphoneIconView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 84E13B832CBF1D91003B52EC /* SentryUserFeedbackWidgetButtonMegaphoneIconView.swift */; };
@@ -1789,6 +1790,7 @@
 		84CFA4C92C9DF884008DA5F4 /* SentryUserFeedbackWidget.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryUserFeedbackWidget.swift; sourceTree = "<group>"; };
 		84CFA4CB2C9E0CA3008DA5F4 /* SentryUserFeedbackIntegration.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = SentryUserFeedbackIntegration.h; path = ../../../Sentry/include/SentryUserFeedbackIntegration.h; sourceTree = "<group>"; };
 		84CFA4CC2C9E0CA3008DA5F4 /* SentryUserFeedbackIntegration.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; name = SentryUserFeedbackIntegration.m; path = ../../../Sentry/SentryUserFeedbackIntegration.m; sourceTree = "<group>"; };
+		84DBC62B2CE82F0E000C4904 /* SentryFeedback.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryFeedback.swift; sourceTree = "<group>"; };
 		84DEE86A2B686BD400A7BC17 /* SentrySamplerDecision.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = SentrySamplerDecision.h; path = include/SentrySamplerDecision.h; sourceTree = "<group>"; };
 		84DEE8752B69AD6400A7BC17 /* SentryLaunchProfiling.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = SentryLaunchProfiling.h; path = Sources/Sentry/include/SentryLaunchProfiling.h; sourceTree = SOURCE_ROOT; };
 		84E13B832CBF1D91003B52EC /* SentryUserFeedbackWidgetButtonMegaphoneIconView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryUserFeedbackWidgetButtonMegaphoneIconView.swift; sourceTree = "<group>"; };
@@ -2046,6 +2048,10 @@
 		D8FFE50B2703DAAE00607131 /* SwizzlingCallTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SwizzlingCallTests.swift; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
+/* Begin PBXFileSystemSynchronizedRootGroup section */
+		843FB3142D0BDA3900558F18 /* Feedback */ = {isa = PBXFileSystemSynchronizedRootGroup; explicitFileTypes = {}; explicitFolders = (); path = Feedback; sourceTree = "<group>"; };
+/* End PBXFileSystemSynchronizedRootGroup section */
+
 /* Begin PBXFrameworksBuildPhase section */
 		63AA75971EB8AEF500D153DE /* Frameworks */ = {
 			isa = PBXFrameworksBuildPhase;
@@ -2977,6 +2983,7 @@
 		7B944FA924697E9700A10721 /* Integrations */ = {
 			isa = PBXGroup;
 			children = (
+				843FB3142D0BDA3900558F18 /* Feedback */,
 				7BF6505D292B77D100BBA5A8 /* MetricKit */,
 				D808FB85281AB2EF009A2A33 /* UIEvents */,
 				D8AB40D92806EBDC00E5E9F7 /* Screenshot */,
@@ -3542,6 +3549,7 @@
 			children = (
 				849B8F9E2C70091A00148E1F /* Configuration */,
 				849B8F962C6E906900148E1F /* SentryUserFeedbackIntegrationDriver.swift */,
+				84DBC62B2CE82F0E000C4904 /* SentryFeedback.swift */,
 				84CFA4CB2C9E0CA3008DA5F4 /* SentryUserFeedbackIntegration.h */,
 				84CFA4CC2C9E0CA3008DA5F4 /* SentryUserFeedbackIntegration.m */,
 				84CFA4C92C9DF884008DA5F4 /* SentryUserFeedbackWidget.swift */,
@@ -4373,6 +4381,9 @@
 				D84DAD5C2B1742C1003CF120 /* PBXTargetDependency */,
 				D85153032CA2B5F60070F669 /* PBXTargetDependency */,
 			);
+			fileSystemSynchronizedGroups = (
+				843FB3142D0BDA3900558F18 /* Feedback */,
+			);
 			name = SentryTests;
 			packageProductDependencies = (
 			);
@@ -4589,6 +4600,7 @@
 				7B6438AB26A70F24000D0F65 /* UIViewController+Sentry.m in Sources */,
 				84302A812B5767A50027A629 /* SentryLaunchProfiling.m in Sources */,
 				63AA76A31EB9CBAA00D153DE /* SentryDsn.m in Sources */,
+				84DBC62C2CE82F12000C4904 /* SentryFeedback.swift in Sources */,
 				63B818FA1EC34639002FDF4C /* SentryDebugMeta.m in Sources */,
 				7B98D7D325FB65AE00C5A389 /* SentryWatchdogTerminationTracker.m in Sources */,
 				8E564AE8267AF22600FE117D /* SentryNetworkTrackingIntegration.m in Sources */,

SentryTestUtils/TestTransportAdapter.swift

@@ -2,10 +2,6 @@ import _SentryPrivate
 import Foundation
 
 public class TestTransportAdapter: SentryTransportAdapter {
-    public override func send(_ event: Event, session: SentrySession, attachments: [Attachment]) {
-        self.send(event, with: session, traceContext: nil, attachments: attachments)
-    }
-
     public var sentEventsWithSessionTraceState = Invocations<(event: Event, session: SentrySession, traceContext: TraceContext?, attachments: [Attachment])>()
     public override func send(_ event: Event, with session: SentrySession, traceContext: TraceContext?, attachments: [Attachment]) {
         sentEventsWithSessionTraceState.record((event, session, traceContext, attachments))

Sources/Sentry/Public/SentrySDK.h

@@ -8,6 +8,7 @@
 
 @class SentryBreadcrumb;
 @class SentryEvent;
+@class SentryFeedback;
 @class SentryId;
 @class SentryMetricsAPI;
 @class SentryOptions;

Sources/Sentry/SentryClient.m

@@ -458,13 +458,7 @@ - (SentryId *)sendEvent:(SentryEvent *)event
 
     SentryTraceContext *traceContext = [self getTraceStateWithEvent:event withScope:scope];
 
-    NSArray *attachments = scope.attachments;
-    if (self.attachmentProcessors.count) {
-        for (id<SentryClientAttachmentProcessor> attachmentProcessor in self.attachmentProcessors) {
-            attachments = [attachmentProcessor processAttachments:attachments
-                                                         forEvent:preparedEvent];
-        }
-    }
+    NSArray *attachments = [self attachmentsForEvent:preparedEvent scope:scope];
 
     [self.transportAdapter sendEvent:preparedEvent
                         traceContext:traceContext
@@ -474,18 +468,23 @@ - (SentryId *)sendEvent:(SentryEvent *)event
     return preparedEvent.eventId;
 }
 
+- (NSArray *)attachmentsForEvent:(SentryEvent *)event scope:(SentryScope *)scope
+{
+    NSArray *attachments = scope.attachments;
+    if (self.attachmentProcessors.count) {
+        for (id<SentryClientAttachmentProcessor> attachmentProcessor in self.attachmentProcessors) {
+            attachments = [attachmentProcessor processAttachments:attachments forEvent:event];
+        }
+    }
+    return attachments;
+}
+
 - (SentryId *)sendEvent:(SentryEvent *)event
             withSession:(SentrySession *)session
               withScope:(SentryScope *)scope
 {
     if (nil != event) {
-        NSArray *attachments = scope.attachments;
-        if (self.attachmentProcessors.count) {
-            for (id<SentryClientAttachmentProcessor> attachmentProcessor in self
-                     .attachmentProcessors) {
-                attachments = [attachmentProcessor processAttachments:attachments forEvent:event];
-            }
-        }
+        NSArray *attachments = [self attachmentsForEvent:event scope:scope];
 
         if (event.isCrashEvent && event.context[@"replay"] &&
             [event.context[@"replay"] isKindOfClass:NSDictionary.class]) {
@@ -586,6 +585,39 @@ - (void)captureUserFeedback:(SentryUserFeedback *)userFeedback
     [self.transportAdapter sendUserFeedback:userFeedback];
 }
 
+- (void)captureFeedback:(SentryFeedback *)feedback withScope:(SentryScope *)scope
+{
+    SentryEvent *feedbackEvent = [[SentryEvent alloc] init];
+    feedbackEvent.eventId = feedback.eventId;
+    feedbackEvent.type = SentryEnvelopeItemTypeFeedback;
+
+    NSDictionary *serializedFeedback = [feedback serialize];
+
+    NSUInteger optionalItems = (scope.span == nil ? 0 : 1) + (scope.replayId == nil ? 0 : 1);
+    NSMutableDictionary *context = [NSMutableDictionary dictionaryWithCapacity:1 + optionalItems];
+    context[@"feedback"] = serializedFeedback;
+
+    if (scope.replayId != nil) {
+        NSMutableDictionary *replayContext = [NSMutableDictionary dictionaryWithCapacity:1];
+        replayContext[@"replay_id"] = scope.replayId;
+        context[@"replay"] = replayContext;
+    }
+
+    feedbackEvent.context = context;
+
+    SentryEvent *preparedEvent = [self prepareEvent:feedbackEvent
+                                          withScope:scope
+                             alwaysAttachStacktrace:NO];
+    SentryTraceContext *traceContext = [self getTraceStateWithEvent:preparedEvent withScope:scope];
+    NSArray *attachments = [[self attachmentsForEvent:preparedEvent scope:scope]
+        arrayByAddingObjectsFromArray:[feedback attachments]];
+
+    [self.transportAdapter sendEvent:preparedEvent
+                        traceContext:traceContext
+                         attachments:attachments
+             additionalEnvelopeItems:@[]];
+}
+
 - (void)storeEnvelope:(SentryEnvelope *)envelope
 {
     [self.fileManager storeEnvelope:envelope];
@@ -644,6 +676,8 @@ - (SentryEvent *_Nullable)prepareEvent:(SentryEvent *)event
         = event.type == nil || ![event.type isEqualToString:SentryEnvelopeItemTypeTransaction];
     BOOL eventIsNotReplay
         = event.type == nil || ![event.type isEqualToString:SentryEnvelopeItemTypeReplayVideo];
+    BOOL eventIsNotUserFeedback
+        = event.type == nil || ![event.type isEqualToString:SentryEnvelopeItemTypeFeedback];
 
     // Transactions and replays have their own sampleRate
     if (eventIsNotATransaction && eventIsNotReplay && [self isSampled:self.options.sampleRate]) {
@@ -673,8 +707,9 @@ - (SentryEvent *_Nullable)prepareEvent:(SentryEvent *)event
 
     [self setSdk:event];
 
-    // We don't want to attach debug meta and stacktraces for transactions and replays.
-    if (eventIsNotATransaction && eventIsNotReplay) {
+    // We don't want to attach debug meta and stacktraces for transactions, replays or user
+    // feedback.
+    if (eventIsNotATransaction && eventIsNotReplay && eventIsNotUserFeedback) {
         BOOL shouldAttachStacktrace = alwaysAttachStacktrace || self.options.attachStacktrace
             || (nil != event.exceptions && [event.exceptions count] > 0);
 

Sources/Sentry/SentryDataCategoryMapper.m

@@ -18,6 +18,7 @@
 NSString *const kSentryDataCategoryNameReplay = @"replay";
 NSString *const kSentryDataCategoryNameMetricBucket = @"metric_bucket";
 NSString *const kSentryDataCategoryNameSpan = @"span";
+NSString *const kSentryDataCategoryNameFeedback = @"feedback";
 NSString *const kSentryDataCategoryNameUnknown = @"unknown";
 
 NS_ASSUME_NONNULL_BEGIN
@@ -46,6 +47,9 @@
     if ([itemType isEqualToString:SentryEnvelopeItemTypeReplayVideo]) {
         return kSentryDataCategoryReplay;
     }
+    if ([itemType isEqualToString:SentryEnvelopeItemTypeFeedback]) {
+        return kSentryDataCategoryFeedback;
+    }
     // The envelope item type used for metrics is statsd whereas the client report category for
     // discarded events is metric_bucket.
     if ([itemType isEqualToString:SentryEnvelopeItemTypeStatsd]) {
@@ -104,20 +108,20 @@
     if ([value isEqualToString:kSentryDataCategoryNameSpan]) {
         return kSentryDataCategorySpan;
     }
+    if ([value isEqualToString:kSentryDataCategoryNameFeedback]) {
+        return kSentryDataCategoryFeedback;
+    }
 
     return kSentryDataCategoryUnknown;
 }
 
 NSString *
 nameForSentryDataCategory(SentryDataCategory category)
 {
-    if (category < kSentryDataCategoryAll && category > kSentryDataCategoryUnknown) {
-        return kSentryDataCategoryNameUnknown;
-    }
-
     switch (category) {
     case kSentryDataCategoryAll:
         return kSentryDataCategoryNameAll;
+
     case kSentryDataCategoryDefault:
         return kSentryDataCategoryNameDefault;
     case kSentryDataCategoryError:
@@ -136,12 +140,16 @@
         return kSentryDataCategoryNameProfileChunk;
     case kSentryDataCategoryMetricBucket:
         return kSentryDataCategoryNameMetricBucket;
-    case kSentryDataCategoryUnknown:
-        return kSentryDataCategoryNameUnknown;
     case kSentryDataCategoryReplay:
         return kSentryDataCategoryNameReplay;
     case kSentryDataCategorySpan:
         return kSentryDataCategoryNameSpan;
+    case kSentryDataCategoryFeedback:
+        return kSentryDataCategoryNameFeedback;
+
+    default: // !!!: fall-through!
+    case kSentryDataCategoryUnknown:
+        return kSentryDataCategoryNameUnknown;
     }
 }
 

Sources/Sentry/SentryEnvelope.m

@@ -93,6 +93,8 @@ - (instancetype)initWithEvent:(SentryEvent *)event
     // default. In any case in the envelope type it should be event. Except for transactions
     NSString *envelopeType = [event.type isEqualToString:SentryEnvelopeItemTypeTransaction]
         ? SentryEnvelopeItemTypeTransaction
+        : [event.type isEqualToString:SentryEnvelopeItemTypeFeedback]
+        ? SentryEnvelopeItemTypeFeedback
         : SentryEnvelopeItemTypeEvent;
 
     return [self initWithHeader:[[SentryEnvelopeItemHeader alloc] initWithType:envelopeType

Sources/Sentry/SentryHub.m

@@ -504,6 +504,14 @@ - (void)captureUserFeedback:(SentryUserFeedback *)userFeedback
     }
 }
 
+- (void)captureFeedback:(SentryFeedback *)feedback
+{
+    SentryClient *client = _client;
+    if (client != nil) {
+        [client captureFeedback:feedback withScope:self.scope];
+    }
+}
+
 - (void)addBreadcrumb:(SentryBreadcrumb *)crumb
 {
     SentryOptions *options = [[self client] options];

Sources/Sentry/SentryQueueableRequestManager.m

@@ -27,6 +27,15 @@ - (instancetype)initWithSession:(NSURLSession *)session
 
 - (BOOL)isReady
 {
+#if TEST || TESTCI
+    // force every envelope to be cached in UI tests so we can inspect what the SDK would've sent
+    // for a given operation
+    if ([NSProcessInfo.processInfo.environment[@"--io.sentry.sdk-environment"]
+            isEqualToString:@"ui-tests"]) {
+        return NO;
+    }
+#endif // TEST || TESTCI
+
     // We always have at least one operation in the queue when calling this
     return self.queue.operationCount <= 1;
 }

Sources/Sentry/SentrySDK.m

@@ -405,10 +405,17 @@ + (void)captureUserFeedback:(SentryUserFeedback *)userFeedback
     [SentrySDK.currentHub captureUserFeedback:userFeedback];
 }
 
++ (void)captureFeedback:(SentryFeedback *)feedback
+{
+    [SentrySDK.currentHub captureFeedback:feedback];
+}
+
+#if TARGET_OS_IOS && SENTRY_HAS_UIKIT
 + (void)showUserFeedbackForm
 {
     // TODO: implement
 }
+#endif // TARGET_OS_IOS && SENTRY_HAS_UIKIT
 
 + (void)addBreadcrumb:(SentryBreadcrumb *)crumb
 {

Sources/Sentry/include/HybridPublic/SentryEnvelope.h

@@ -16,13 +16,14 @@
 
 #endif
 
-@class SentryEvent;
-@class SentrySession;
-@class SentryId;
-@class SentryUserFeedback;
 @class SentryAttachment;
 @class SentryEnvelopeItemHeader;
+@class SentryEvent;
+@class SentryFeedback;
+@class SentryId;
+@class SentrySession;
 @class SentryTraceContext;
+@class SentryUserFeedback;
 
 NS_ASSUME_NONNULL_BEGIN
 

Sources/Sentry/include/HybridPublic/SentryEnvelopeItemType.h

@@ -6,6 +6,7 @@
 static NSString *const SentryEnvelopeItemTypeEvent = @"event";
 static NSString *const SentryEnvelopeItemTypeSession = @"session";
 static NSString *const SentryEnvelopeItemTypeUserFeedback = @"user_report";
+static NSString *const SentryEnvelopeItemTypeFeedback = @"feedback";
 static NSString *const SentryEnvelopeItemTypeTransaction = @"transaction";
 static NSString *const SentryEnvelopeItemTypeAttachment = @"attachment";
 static NSString *const SentryEnvelopeItemTypeClientReport = @"client_report";