feat(feedback): capture envelopes

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

@@ -97,6 +97,17 @@ class UserFeedbackUITests: BaseUITest {
         XCTAssertFalse(app.staticTexts["Thy name (Required)"].exists)
     }
 
+    func testPrefilledUserInformation() throws {
+        launchApp(args: ["--io.sentry.feedback.use-sentry-user"], env: [
+            "--io.sentry.user.name": "ui test user",
+            "--io.sentry.user.email": "[email protected]"
+        ])
+
+        widgetButton.tap()
+        XCTAssertEqual(try XCTUnwrap(nameField.value as? String), "ui test user")
+        XCTAssertEqual(try XCTUnwrap(emailField.value as? String), "[email protected]")
+    }
+
     // MARK: Tests validating happy path / successful submission
 
     func testSubmitFullyFilledForm() throws {

Samples/iOS-Swift/iOS-Swift.xcodeproj/xcshareddata/xcschemes/iOS-Swift.xcscheme

@@ -69,10 +69,18 @@
          </BuildableReference>
       </BuildableProductRunnable>
       <CommandLineArguments>
+         <CommandLineArgument
+            argument = "--io.sentry.disable-everything"
+            isEnabled = "NO">
+         </CommandLineArgument>
          <CommandLineArgument
             argument = "--disable-file-io-tracing"
             isEnabled = "NO">
          </CommandLineArgument>
+         <CommandLineArgument
+            argument = "--io.sentry.feedback.use-sentry-user"
+            isEnabled = "YES">
+         </CommandLineArgument>
          <CommandLineArgument
             argument = "--io.sentry.feedback.require-name"
             isEnabled = "NO">
@@ -236,6 +244,11 @@
             value = ""
             isEnabled = "NO">
          </EnvironmentVariable>
+         <EnvironmentVariable
+            key = "--io.sentry.user.name"
+            value = ""
+            isEnabled = "NO">
+         </EnvironmentVariable>
       </EnvironmentVariables>
    </LaunchAction>
    <ProfileAction

Samples/iOS-Swift/iOS-Swift/AppDelegate.swift

@@ -152,8 +152,9 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
                 user.email = env["--io.sentry.user.email"] ?? "[email protected]"
                 // first check if the username has been overridden in the scheme for testing purposes; then try to use the system username so each person gets an automatic way to easily filter things on the dashboard; then fall back on a hardcoded value if none of these are present
                 let username = env["--io.sentry.user.username"] ?? (env["SIMULATOR_HOST_HOME"] as? NSString)?
-                    .lastPathComponent ?? "cocoa developer"
+                    .lastPathComponent ?? "cocoadev"
                 user.username = username
+                user.name = env["--io.sentry.user.name"] ?? "cocoa developer"
                 scope.setUser(user)
 
                 if let path = Bundle.main.path(forResource: "Tongariro", ofType: "jpg") {
@@ -174,6 +175,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
                     return
                 }
                 config.animations = !args.contains("--io.sentry.feedback.no-animations")
+                config.useSentryUser = args.contains("--io.sentry.feedback.use-sentry-user")
                 config.useShakeGesture = true
                 config.showFormForScreenshots = true
                 config.configureWidget = { widget in

Sentry.xcodeproj/project.pbxproj

@@ -708,6 +708,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 */; };
@@ -1776,6 +1777,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>"; };
@@ -2032,6 +2034,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;
@@ -2957,6 +2963,7 @@
 		7B944FA924697E9700A10721 /* Integrations */ = {
 			isa = PBXGroup;
 			children = (
+				843FB3142D0BDA3900558F18 /* Feedback */,
 				7BF6505D292B77D100BBA5A8 /* MetricKit */,
 				D808FB85281AB2EF009A2A33 /* UIEvents */,
 				D8AB40D92806EBDC00E5E9F7 /* Screenshot */,
@@ -3522,6 +3529,7 @@
 			children = (
 				849B8F9E2C70091A00148E1F /* Configuration */,
 				849B8F962C6E906900148E1F /* SentryUserFeedbackIntegrationDriver.swift */,
+				84DBC62B2CE82F0E000C4904 /* SentryFeedback.swift */,
 				84CFA4CB2C9E0CA3008DA5F4 /* SentryUserFeedbackIntegration.h */,
 				84CFA4CC2C9E0CA3008DA5F4 /* SentryUserFeedbackIntegration.m */,
 				84CFA4C92C9DF884008DA5F4 /* SentryUserFeedbackWidget.swift */,
@@ -4348,6 +4356,9 @@
 				D84DAD5C2B1742C1003CF120 /* PBXTargetDependency */,
 				D85153032CA2B5F60070F669 /* PBXTargetDependency */,
 			);
+			fileSystemSynchronizedGroups = (
+				843FB3142D0BDA3900558F18 /* Feedback */,
+			);
 			name = SentryTests;
 			packageProductDependencies = (
 			);
@@ -4564,6 +4575,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 */,

Sources/Sentry/Public/SentrySDK.h

@@ -6,11 +6,18 @@
 
 @protocol SentrySpan;
 
-@class SentryOptions, SentryEvent, SentryBreadcrumb, SentryScope, SentryUser, SentryId,
-    SentryUserFeedback, SentryTransactionContext;
+@class SentryBreadcrumb;
+@class SentryEvent;
+@class SentryFeedback;
+@class SentryId;
 @class SentryMetricsAPI;
-@class UIView;
+@class SentryOptions;
 @class SentryReplayApi;
+@class SentryScope;
+@class SentryTransactionContext;
+@class SentryUser;
+@class SentryUserFeedback;
+@class UIView;
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -246,28 +253,10 @@ SENTRY_NO_INIT
 /**
  * Captures user feedback that was manually gathered and sends it to Sentry.
  * @param userFeedback The user feedback to send to Sentry.
- * @note If you'd prefer not to have to build the UI required to gather the feedback from the user,
- * consider using `showUserFeedbackForm`, which delivers a prepackaged user feedback experience. See
- * @c SentryOptions.configureUserFeedback to customize a fully managed integration. See
- * https://docs.sentry.io/platforms/apple/user-feedback/#user-feedback-api and (TODO: add link to
- * new docs) for more information on each approach.
  */
 + (void)captureUserFeedback:(SentryUserFeedback *)userFeedback
     NS_SWIFT_NAME(capture(userFeedback:));
 
-/**
- * Display a form to gather information from an end user in the app to send to Sentry as a user
- * feedback event.
- * @see @c SentryOptions.enableUserFeedbackIntegration and @c SentryOptions.configureUserFeedback to
- * enable the functionality and customize the experience.
- * @note If @c SentryOptions.enableUserFeedbackIntegration is @c NO, this method is a no-op.
- * @note This is a fully managed user feedback flow; there will be no need to call
- * @c SentrySDK.captureUserFeedback . See
- * https://docs.sentry.io/platforms/apple/user-feedback/#user-feedback-api and (TODO: add link to
- * new docs) for more information on each approach.
- */
-+ (void)showUserFeedbackForm;
-
 /**
  * Adds a Breadcrumb to the current Scope of the current Hub. If the total number of breadcrumbs
  * exceeds the @c SentryOptions.maxBreadcrumbs  the SDK removes the oldest breadcrumb.

Sources/Sentry/SentryClient.m

@@ -457,13 +457,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
@@ -473,18 +467,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]) {
@@ -585,6 +584,30 @@ - (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];
+
+    NSMutableDictionary *context = [NSMutableDictionary dictionary];
+    context[@"feedback"] = serializedFeedback;
+    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];
@@ -643,6 +666,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]) {
@@ -672,8 +697,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

@@ -95,6 +95,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/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/SentryTransportAdapter.m

@@ -2,6 +2,7 @@
 #import "SentryEnvelope.h"
 #import "SentryEvent.h"
 #import "SentryOptions.h"
+#import "SentrySwift.h"
 #import "SentryUserFeedback.h"
 #import <Foundation/Foundation.h>