feat(user-feedback): capture envelopes

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 */; };
@@ -1777,6 +1778,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>"; };
@@ -3524,6 +3526,7 @@
 			children = (
 				849B8F9E2C70091A00148E1F /* Configuration */,
 				849B8F962C6E906900148E1F /* SentryUserFeedbackIntegrationDriver.swift */,
+				84DBC62B2CE82F0E000C4904 /* SentryFeedback.swift */,
 				84CFA4CB2C9E0CA3008DA5F4 /* SentryUserFeedbackIntegration.h */,
 				84CFA4CC2C9E0CA3008DA5F4 /* SentryUserFeedbackIntegration.m */,
 				84CFA4C92C9DF884008DA5F4 /* SentryUserFeedbackWidget.swift */,
@@ -4566,6 +4569,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,25 +253,28 @@ 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 This method will be deprecated in a future release; use `captureFeedback` instead.
+ */
++ (void)captureUserFeedback:(SentryUserFeedback *)userFeedback
+    NS_SWIFT_NAME(capture(userFeedback:));
+
+/**
+ * Captures user feedback that was manually gathered and sends it to Sentry.
+ * @param feedback The 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.
+ * https://docs.sentry.io/platforms/apple/user-feedback/ for more information.
  */
-+ (void)captureUserFeedback:(SentryUserFeedback *)userFeedback
-    NS_SWIFT_NAME(capture(userFeedback:));
++ (void)captureFeedback:(SentryFeedback *)feedback NS_SWIFT_NAME(capture(feedback:));
 
 /**
  * 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.
+ * @see @c SentryOptions.configureUserFeedback to customize the experience.
  * @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.
+ * https://docs.sentry.io/platforms/apple/user-feedback/ for more information.
  */
 + (void)showUserFeedbackForm;
 

Sources/Sentry/Public/SentryUserFeedback.h

@@ -15,14 +15,24 @@ NS_ASSUME_NONNULL_BEGIN
  */
 NS_SWIFT_NAME(UserFeedback)
 @interface SentryUserFeedback : NSObject <SentrySerializable>
-SENTRY_NO_INIT
 
 /**
  * Initializes SentryUserFeedback and sets the required eventId.
  * @param eventId The eventId of the event to which the user feedback is associated.
+ * @note Uses the old envelope format descried at
+ * https://develop.sentry.dev/sdk/data-model/envelope-items/#user-feedback and will be deprecated in
+ * the future.
  */
 - (instancetype)initWithEventId:(SentryId *)eventId;
 
+/**
+ * Initializes a new `SentryUserFeedback` as its own event, instead of one attached to a transaction
+ * or error event.
+ * @note Uses the new envelope format described at
+ * https://develop.sentry.dev/application/feedback-architecture/#feedback-events.
+ */
+- (instancetype)init;
+
 /**
  * The eventId of the event to which the user feedback is associated.
  */

Sources/Sentry/SentryClient.m

@@ -569,6 +569,16 @@ - (void)captureUserFeedback:(SentryUserFeedback *)userFeedback
     [self.transportAdapter sendUserFeedback:userFeedback];
 }
 
+- (void)captureFeedback:(SentryFeedback *)feedback
+{
+    if ([self isDisabled]) {
+        [self logDisabledMessage];
+        return;
+    }
+
+    [self.transportAdapter sendFeedback:feedback];
+}
+
 - (void)storeEnvelope:(SentryEnvelope *)envelope
 {
     [self.fileManager storeEnvelope:envelope];

Sources/Sentry/SentryEnvelope.m

@@ -129,6 +129,24 @@ - (instancetype)initWithUserFeedback:(SentryUserFeedback *)userFeedback
                            data:json];
 }
 
+- (instancetype)initWithFeedback:(SentryFeedback *)feedback
+{
+    NSError *error = nil;
+    NSData *json = [NSJSONSerialization dataWithJSONObject:[feedback serialize]
+                                                   options:0
+                                                     error:&error];
+
+    if (nil != error) {
+        SENTRY_LOG_ERROR(@"Couldn't serialize feedback.");
+        json = [NSData new];
+    }
+
+    return [self
+        initWithHeader:[[SentryEnvelopeItemHeader alloc] initWithType:SentryEnvelopeItemTypeFeedback
+                                                               length:json.length]
+                  data:json];
+}
+
 - (instancetype)initWithClientReport:(SentryClientReport *)clientReport
 {
     NSError *error = nil;

Sources/Sentry/SentryHub.m

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

Sources/Sentry/SentrySDK.m

@@ -406,6 +406,11 @@ + (void)captureUserFeedback:(SentryUserFeedback *)userFeedback
     [SentrySDK.currentHub captureUserFeedback:userFeedback];
 }
 
++ (void)captureFeedback:(SentryFeedback *)feedback
+{
+    [SentrySDK.currentHub captureFeedback:feedback];
+}
+
 + (void)showUserFeedbackForm
 {
     // TODO: implement

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>
 
@@ -87,6 +88,16 @@ - (void)sendUserFeedback:(SentryUserFeedback *)userFeedback
     [self sendEnvelope:envelope];
 }
 
+- (void)sendFeedback:(SentryFeedback *)feedback
+{
+    SentryEnvelopeItem *item = [[SentryEnvelopeItem alloc] initWithFeedback:feedback];
+    SentryEnvelopeHeader *envelopeHeader =
+        [[SentryEnvelopeHeader alloc] initWithId:feedback.eventId];
+    SentryEnvelope *envelope = [[SentryEnvelope alloc] initWithHeader:envelopeHeader
+                                                           singleItem:item];
+    [self sendEnvelope:envelope];
+}
+
 - (void)sendEnvelope:(SentryEnvelope *)envelope
 {
     for (id<SentryTransport> transport in self.transports) {

Sources/Sentry/SentryUserFeedback.m

@@ -2,7 +2,26 @@
 #import "SentrySwift.h"
 #import <Foundation/Foundation.h>
 
-@implementation SentryUserFeedback
+typedef enum : NSUInteger {
+    /** A user feedback attached to a transaction or error event. */
+    kSentryUserFeedbackTypeAttached,
+
+    /** A user feedback sent as its own event independent of any other event. */
+    kSentryUserFeedbackTypeStandalone,
+} SentryUserFeedbackType;
+
+@implementation SentryUserFeedback {
+    SentryUserFeedbackType _type;
+}
+
+- (instancetype)init
+{
+    if (self = [super init]) {
+        _type = kSentryUserFeedbackTypeStandalone;
+        _eventId = [[SentryId alloc] init];
+    }
+    return self;
+}
 
 - (instancetype)initWithEventId:(SentryId *)eventId
 {
@@ -11,18 +30,26 @@ - (instancetype)initWithEventId:(SentryId *)eventId
         _email = @"";
         _name = @"";
         _comments = @"";
+        _type = kSentryUserFeedbackTypeAttached;
     }
     return self;
 }
 
 - (NSDictionary<NSString *, id> *)serialize
 {
-    return @{
-        @"event_id" : self.eventId.sentryIdString,
-        @"email" : self.email,
-        @"name" : self.name,
-        @"comments" : self.comments
-    };
+    switch (_type) {
+    case kSentryUserFeedbackTypeAttached:
+        return @{
+            @"event_id" : self.eventId.sentryIdString,
+            @"email" : self.email,
+            @"name" : self.name,
+            @"comments" : self.comments
+        };
+    case kSentryUserFeedbackTypeStandalone:
+        return @{
+
+        };
+    }
 }
 
 @end

Sources/Sentry/include/HybridPublic/SentryEnvelope.h

@@ -7,13 +7,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
 
@@ -82,6 +83,7 @@ SENTRY_NO_INIT
 - (instancetype)initWithEvent:(SentryEvent *)event;
 - (instancetype)initWithSession:(SentrySession *)session;
 - (instancetype)initWithUserFeedback:(SentryUserFeedback *)userFeedback;
+- (instancetype)initWithFeedback:(SentryFeedback *)feedback;
 - (_Nullable instancetype)initWithAttachment:(SentryAttachment *)attachment
                            maxAttachmentSize:(NSUInteger)maxAttachmentSize;
 - (instancetype)initWithHeader:(SentryEnvelopeItemHeader *)header

Sources/Sentry/include/HybridPublic/SentryEnvelopeItemType.h

@@ -3,6 +3,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";

Sources/Sentry/include/SentryClient+Private.h

@@ -2,8 +2,15 @@
 #import "SentryDataCategory.h"
 #import "SentryDiscardReason.h"
 
-@class SentrySession, SentryEnvelopeItem, SentryId, SentryAttachment, SentryThreadInspector,
-    SentryReplayEvent, SentryReplayRecording, SentryEnvelope;
+@class SentryAttachment;
+@class SentryEnvelope;
+@class SentryEnvelopeItem;
+@class SentryFeedback;
+@class SentryId;
+@class SentryReplayEvent;
+@class SentryReplayRecording;
+@class SentrySession;
+@class SentryThreadInspector;
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -63,6 +70,12 @@ NS_ASSUME_NONNULL_BEGIN
 - (void)addAttachmentProcessor:(id<SentryClientAttachmentProcessor>)attachmentProcessor;
 - (void)removeAttachmentProcessor:(id<SentryClientAttachmentProcessor>)attachmentProcessor;
 
+/**
+ * Captures a new-style user feedback and sends it to Sentry.
+ * @param feedback The user feedback to send to Sentry.
+ */
+- (void)captureFeedback:(SentryFeedback *)feedback NS_SWIFT_NAME(capture(feedback:));
+
 @end
 
 NS_ASSUME_NONNULL_END

Sources/Sentry/include/SentryHub+Private.h

@@ -6,6 +6,7 @@
 @class SentryTransaction;
 @class SentryDispatchQueueWrapper;
 @class SentryEnvelope;
+@class SentryFeedback;
 @class SentryNSTimerFactory;
 @class SentrySession;
 @class SentryTracer;
@@ -62,6 +63,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 - (void)storeEnvelope:(SentryEnvelope *)envelope;
 - (void)captureEnvelope:(SentryEnvelope *)envelope;
+- (void)captureFeedback:(SentryFeedback *)feedback;
 
 - (void)registerSessionListener:(id<SentrySessionListener>)listener;
 - (void)unregisterSessionListener:(id<SentrySessionListener>)listener;

Sources/Sentry/include/SentryPrivate.h

@@ -3,6 +3,7 @@
 #import "SentryDispatchQueueWrapper.h"
 #import "SentryNSDataUtils.h"
 #import "SentryRandom.h"
+#import "SentrySDK+Private.h"
 #import "SentryTime.h"
 
 // Headers that also import SentryDefines should be at the end of this list

Sources/Sentry/include/SentrySDK+Private.h

@@ -10,7 +10,11 @@
 #    import "SentrySDK.h"
 #endif
 
-@class SentryHub, SentryId, SentryAppStartMeasurement, SentryEnvelope;
+@class SentryAppStartMeasurement;
+@class SentryEnvelope;
+@class SentryFeedback;
+@class SentryHub;
+@class SentryId;
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -51,6 +55,8 @@ NS_ASSUME_NONNULL_BEGIN
  */
 + (void)captureEnvelope:(SentryEnvelope *)envelope;
 
++ (void)captureFeedback:(SentryFeedback *)feedback;
+
 @end
 
 NS_ASSUME_NONNULL_END