Support captureFeedback

dart/lib/sentry.dart

@@ -58,3 +58,5 @@ export 'src/utils.dart';
 export 'src/spotlight.dart';
 // proxy
 export 'src/protocol/sentry_proxy.dart';
+// feedback
+export 'src/protocol/sentry_feedback.dart';

dart/lib/src/hub.dart

@@ -274,6 +274,48 @@ class Hub {
     }
   }
 
+  Future<SentryId> captureFeedback(
+    SentryFeedback feedback, {
+    Hint? hint,
+    ScopeCallback? withScope,
+  }) async {
+    var sentryId = SentryId.empty();
+
+    if (!_isEnabled) {
+      _options.logger(
+        SentryLevel.warning,
+        "Instance is disabled and this 'captureFeedback' call is a no-op.",
+      );
+      return sentryId;
+    }
+
+    final item = _peek();
+    late Scope scope;
+    final s = _cloneAndRunWithScope(item.scope, withScope);
+    if (s is Future<Scope>) {
+      scope = await s;
+    } else {
+      scope = s;
+    }
+
+    try {
+      sentryId = await item.client.captureFeedback(
+        feedback,
+        hint: hint,
+        scope: scope,
+      );
+    } catch (exception, stacktrace) {
+      _options.logger(
+        SentryLevel.error,
+        'Error while capturing user feedback',
+        exception: exception,
+        stackTrace: stacktrace,
+      );
+    }
+
+    return sentryId;
+  }
+
   FutureOr<Scope> _cloneAndRunWithScope(
       Scope scope, ScopeCallback? withScope) async {
     if (withScope != null) {

dart/lib/src/hub_adapter.dart

@@ -9,6 +9,7 @@ import 'metrics/metrics_aggregator.dart';
 import 'metrics/metrics_api.dart';
 import 'profiling.dart';
 import 'protocol.dart';
+import 'protocol/sentry_feedback.dart';
 import 'scope.dart';
 import 'sentry.dart';
 import 'sentry_client.dart';
@@ -196,4 +197,16 @@ class HubAdapter implements Hub {
   @override
   MetricsAggregator? get metricsAggregator =>
       Sentry.currentHub.metricsAggregator;
+
+  @override
+  Future<SentryId> captureFeedback(
+    SentryFeedback feedback, {
+    Hint? hint,
+    ScopeCallback? withScope,
+  }) =>
+      Sentry.currentHub.captureFeedback(
+        feedback,
+        hint: hint,
+        withScope: withScope,
+      );
 }

dart/lib/src/noop_hub.dart

@@ -9,6 +9,7 @@ import 'metrics/metrics_aggregator.dart';
 import 'metrics/metrics_api.dart';
 import 'profiling.dart';
 import 'protocol.dart';
+import 'protocol/sentry_feedback.dart';
 import 'scope.dart';
 import 'sentry_client.dart';
 import 'sentry_options.dart';
@@ -98,6 +99,14 @@ class NoOpHub implements Hub {
   @override
   Future<void> captureUserFeedback(SentryUserFeedback userFeedback) async {}
 
+  @override
+  Future<SentryId> captureFeedback(
+    SentryFeedback feedback, {
+    Hint? hint,
+    ScopeCallback? withScope,
+  }) async =>
+      SentryId.empty();
+
   @override
   ISentrySpan startTransaction(
     String name,

dart/lib/src/protocol/contexts.dart

@@ -1,6 +1,7 @@
 import 'dart:collection';
 
 import '../protocol.dart';
+import 'sentry_feedback.dart';
 
 /// The context interfaces provide additional context data.
 ///
@@ -19,6 +20,7 @@ class Contexts extends MapView<String, dynamic> {
     SentryCulture? culture,
     SentryTraceContext? trace,
     SentryResponse? response,
+    SentryFeedback? feedback,
   }) : super({
           SentryDevice.type: device,
           SentryOperatingSystem.type: operatingSystem,
@@ -29,6 +31,7 @@ class Contexts extends MapView<String, dynamic> {
           SentryCulture.type: culture,
           SentryTraceContext.type: trace,
           SentryResponse.type: response,
+          SentryFeedback.type: feedback,
         });
 
   /// Deserializes [Contexts] from JSON [Map].
@@ -62,6 +65,9 @@ class Contexts extends MapView<String, dynamic> {
       response: data[SentryResponse.type] != null
           ? SentryResponse.fromJson(Map.from(data[SentryResponse.type]))
           : null,
+      feedback: data[SentryFeedback.type] != null
+          ? SentryFeedback.fromJson(Map.from(data[SentryFeedback.type]))
+          : null,
     );
 
     data.keys
@@ -136,6 +142,11 @@ class Contexts extends MapView<String, dynamic> {
 
   set response(SentryResponse? value) => this[SentryResponse.type] = value;
 
+  /// Feedback context for a FeedbackEvent.
+  SentryFeedback? get feedback => this[SentryFeedback.type];
+
+  set feedback(SentryFeedback? value) => this[SentryFeedback.type] = value;
+
   /// Produces a [Map] that can be serialized to JSON.
   Map<String, dynamic> toJson() {
     final json = <String, dynamic>{};
@@ -198,6 +209,13 @@ class Contexts extends MapView<String, dynamic> {
           }
           break;
 
+        case SentryFeedback.type:
+          final feedbackMap = feedback?.toJson();
+          if (feedbackMap?.isNotEmpty ?? false) {
+            json[SentryFeedback.type] = feedbackMap;
+          }
+          break;
+
         case SentryRuntime.listType:
           if (runtimes.length == 1) {
             final runtime = runtimes[0];
@@ -249,6 +267,7 @@ class Contexts extends MapView<String, dynamic> {
       trace: trace?.clone(),
       response: response?.clone(),
       runtimes: runtimes.map((runtime) => runtime.clone()).toList(),
+      feedback: feedback?.clone(),
     )..addEntries(
         entries.where((element) => !_defaultFields.contains(element.key)),
       );
@@ -266,6 +285,7 @@ class Contexts extends MapView<String, dynamic> {
     SentryGpu? gpu,
     SentryTraceContext? trace,
     SentryResponse? response,
+    SentryFeedback? feedback,
   }) =>
       Contexts(
         device: device ?? this.device,
@@ -277,6 +297,7 @@ class Contexts extends MapView<String, dynamic> {
         culture: culture ?? this.culture,
         trace: trace ?? this.trace,
         response: response ?? this.response,
+        feedback: feedback ?? this.feedback,
       )..addEntries(
           entries.where((element) => !_defaultFields.contains(element.key)),
         );
@@ -292,5 +313,6 @@ class Contexts extends MapView<String, dynamic> {
     SentryCulture.type,
     SentryTraceContext.type,
     SentryResponse.type,
+    SentryFeedback.type,
   ];
 }

dart/lib/src/protocol/sentry_feedback.dart

@@ -0,0 +1,81 @@
+import 'package:meta/meta.dart';
+
+import 'access_aware_map.dart';
+import 'sentry_id.dart';
+
+@immutable
+class SentryFeedback {
+  static const type = 'feedback';
+
+  SentryFeedback({
+    required this.message,
+    this.contactEmail,
+    this.name,
+    this.replayId,
+    this.url,
+    this.associatedEventId,
+    this.unknown,
+  });
+
+  final String message;
+  final String? contactEmail;
+  final String? name;
+  final String? replayId;
+  final String? url;
+  final SentryId? associatedEventId;
+
+  @internal
+  final Map<String, dynamic>? unknown;
+
+  /// Deserializes a [SentryOperatingSystem] from JSON [Map].
+  factory SentryFeedback.fromJson(Map<String, dynamic> data) {
+    final json = AccessAwareMap(data);
+
+    String? associatedEventId = json['associated_event_id'];
+
+    return SentryFeedback(
+      message: json['message'],
+      contactEmail: json['contact_email'],
+      name: json['name'],
+      replayId: json['replay_id'],
+      url: json['url'],
+      associatedEventId:
+          associatedEventId != null ? SentryId.fromId(associatedEventId) : null,
+      unknown: json.notAccessed(),
+    );
+  }
+
+  Map<String, dynamic> toJson() {
+    return {
+      ...?unknown,
+      'message': message,
+      if (contactEmail != null) 'contact_email': contactEmail,
+      if (name != null) 'name': name,
+      if (replayId != null) 'replay_id': replayId,
+      if (url != null) 'url': url,
+      if (associatedEventId != null)
+        'associated_event_id': associatedEventId.toString(),
+    };
+  }
+
+  SentryFeedback copyWith({
+    String? message,
+    String? contactEmail,
+    String? name,
+    String? replayId,
+    String? url,
+    SentryId? associatedEventId,
+    Map<String, dynamic>? unknown,
+  }) =>
+      SentryFeedback(
+        message: message ?? this.message,
+        contactEmail: contactEmail ?? this.contactEmail,
+        name: name ?? this.name,
+        replayId: replayId ?? this.replayId,
+        url: url ?? this.url,
+        associatedEventId: associatedEventId ?? this.associatedEventId,
+        unknown: unknown ?? this.unknown,
+      );
+
+  SentryFeedback clone() => copyWith();
+}

dart/lib/src/sentry.dart

@@ -4,6 +4,7 @@ import 'package:meta/meta.dart';
 
 import 'dart_exception_type_identifier.dart';
 import 'metrics/metrics_api.dart';
+import 'protocol/sentry_feedback.dart';
 import 'run_zoned_guarded_integration.dart';
 import 'event_processor/enricher/enricher_event_processor.dart';
 import 'environment/environment_variables.dart';
@@ -219,6 +220,9 @@ class Sentry {
   static Future<void> captureUserFeedback(SentryUserFeedback userFeedback) =>
       _hub.captureUserFeedback(userFeedback);
 
+  static Future<void> captureFeedback(SentryFeedback feedback) =>
+      _hub.captureFeedback(feedback);
+
   /// Close the client SDK
   static Future<void> close() async {
     final hub = _hub;

dart/lib/src/sentry_client.dart

@@ -10,6 +10,7 @@ import 'hint.dart';
 import 'metrics/metric.dart';
 import 'metrics/metrics_aggregator.dart';
 import 'protocol.dart';
+import 'protocol/sentry_feedback.dart';
 import 'scope.dart';
 import 'sentry_attachment/sentry_attachment.dart';
 import 'sentry_baggage.dart';
@@ -104,7 +105,7 @@ class SentryClient {
       return _emptySentryId;
     }
 
-    if (_sampleRate()) {
+    if (_sampleRate() && event.type != 'feedback') {
       _options.recorder
           .recordLostEvent(DiscardReason.sampleRate, _getCategory(event));
       _options.logger(
@@ -161,7 +162,7 @@ class SentryClient {
     }
 
     var viewHierarchy = hint.viewHierarchy;
-    if (viewHierarchy != null) {
+    if (viewHierarchy != null && event.type != 'feedback') {
       attachments.add(viewHierarchy);
     }
 
@@ -213,6 +214,10 @@ class SentryClient {
       return event;
     }
 
+    if (event.type == 'feedback') {
+      return event;
+    }
+
     if (event.exceptions?.isNotEmpty ?? false) {
       return event;
     }
@@ -433,6 +438,25 @@ class SentryClient {
     return _attachClientReportsAndSend(envelope);
   }
 
+  /// Reports the [SentryFeedback] and to Sentry.io.
+  Future<SentryId> captureFeedback(
+    SentryFeedback feedback, {
+    Scope? scope,
+    Hint? hint,
+  }) {
+    final feedbackEvent = SentryEvent(
+      type: 'feedback',
+      contexts: Contexts(feedback: feedback),
+      level: SentryLevel.info,
+    );
+
+    return captureEvent(
+      feedbackEvent,
+      scope: scope,
+      hint: hint,
+    );
+  }
+
   /// Reports the [metricsBuckets] to Sentry.io.
   Future<SentryId> captureMetrics(
       Map<int, Iterable<Metric>> metricsBuckets) async {
@@ -460,6 +484,7 @@ class SentryClient {
 
     final beforeSend = _options.beforeSend;
     final beforeSendTransaction = _options.beforeSendTransaction;
+    final beforeSendFeedback = _options.beforeSendFeedback;
     String beforeSendName = 'beforeSend';
 
     try {
@@ -471,6 +496,13 @@ class SentryClient {
         } else {
           processedEvent = callbackResult;
         }
+      } else if (event.type == 'feedback' && beforeSendFeedback != null) {
+        final callbackResult = beforeSendFeedback(event, hint);
+        if (callbackResult is Future<SentryEvent?>) {
+          processedEvent = await callbackResult;
+        } else {
+          processedEvent = callbackResult;
+        }
       } else if (beforeSend != null) {
         final callbackResult = beforeSend(event, hint);
         if (callbackResult is Future<SentryEvent?>) {