Support captureFeedback

CHANGELOG.md

@@ -10,6 +10,11 @@
 ```dart
 SentryNavigatorObserver(ignoreRoutes: ["/ignoreThisRoute"]),
 ```
+- Support `captureFeedback` ([#2230](https://github.com/getsentry/sentry-dart/pull/2230))
+  - Deprecated `Sentry.captureUserFeedback`, use `captureFeedback` instead.
+  - Deprecated `Hub.captureUserFeedback`, use `captureFeedback` instead.
+  - Deprecated `SentryClient.captureUserFeedback`, use `captureFeedback` instead.
+  - Deprecated `SentryUserFeedback`, use `SentryFeedback` instead.
 
 ### Improvements
 

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

@@ -245,6 +245,8 @@
     return sentryId;
   }
 
+  @Deprecated(
+      'Will be removed in a future version. Use [captureFeedback] instead')
   Future<void> captureUserFeedback(SentryUserFeedback userFeedback) async {
     if (!_isEnabled) {
       _options.logger(
@@ -274,6 +276,47 @@
     }
   }
 
+  /// Captures the feedback.
+  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.",
+      );
+    } else {
+      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 feedback',
+          exception: exception,
+          stackTrace: stacktrace,
+        );
+      }
+    }
+    return sentryId;
+  }
+
   FutureOr<Scope> _cloneAndRunWithScope(
       Scope scope, ScopeCallback? withScope) async {
     if (withScope != null) {

dart/lib/src/hub_adapter.dart

@@ -1,19 +1,20 @@
 import 'dart:async';
 
 import 'package:meta/meta.dart';
-import 'hint.dart';
 
+import 'hint.dart';
 import 'hub.dart';
 import 'metrics/metric.dart';
 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';
-import 'sentry_user_feedback.dart';
 import 'sentry_options.dart';
+import 'sentry_user_feedback.dart';
 import 'tracing.dart';
 
 /// Hub adapter to make Integrations testable
@@ -117,7 +118,9 @@
   ISentrySpan? getSpan() => Sentry.currentHub.getSpan();
 
   @override
+  // ignore: deprecated_member_use_from_same_package
   Future<void> captureUserFeedback(SentryUserFeedback userFeedback) =>
+      // ignore: deprecated_member_use_from_same_package
       Sentry.captureUserFeedback(userFeedback);
 
   @override
@@ -196,4 +199,16 @@
   @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_api.dart';
 import 'profiling.dart';
 import 'protocol.dart';
+import 'protocol/sentry_feedback.dart';
 import 'scope.dart';
 import 'sentry_client.dart';
 import 'sentry_options.dart';
@@ -96,8 +97,17 @@
       SentryId.empty();
 
   @override
+  // ignore: deprecated_member_use_from_same_package
   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/noop_sentry_client.dart

@@ -6,6 +6,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_client.dart';
 import 'sentry_envelope.dart';
@@ -55,6 +56,7 @@ class NoOpSentryClient implements SentryClient {
       SentryId.empty();
 
   @override
+  // ignore: deprecated_member_use_from_same_package
   Future<void> captureUserFeedback(SentryUserFeedback userFeedback) async {}
 
   @override
@@ -77,4 +79,9 @@ class NoOpSentryClient implements SentryClient {
   @override
   @internal
   MetricsAggregator? get metricsAggregator => null;
+
+  @override
+  Future<SentryId> captureFeedback(SentryFeedback feedback,
+          {Scope? scope, Hint? hint}) async =>
+      SentryId.empty();
 }

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 @@
     SentryCulture? culture,
     SentryTraceContext? trace,
     SentryResponse? response,
+    SentryFeedback? feedback,
   }) : super({
           SentryDevice.type: device,
           SentryOperatingSystem.type: operatingSystem,
@@ -29,6 +31,7 @@
           SentryCulture.type: culture,
           SentryTraceContext.type: trace,
           SentryResponse.type: response,
+          SentryFeedback.type: feedback,
         });
 
   /// Deserializes [Contexts] from JSON [Map].
@@ -62,6 +65,9 @@
       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 @@
 
   set response(SentryResponse? value) => this[SentryResponse.type] = value;
 
+  /// Feedback context for a feedback event.
+  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 @@
           }
           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 @@
       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 @@
     SentryGpu? gpu,
     SentryTraceContext? trace,
     SentryResponse? response,
+    SentryFeedback? feedback,
   }) =>
       Contexts(
         device: device ?? this.device,
@@ -277,6 +297,7 @@
         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 @@
     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 [SentryFeedback] 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 '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';
@@ -21,6 +22,7 @@
 import 'sentry_options.dart';
 import 'sentry_user_feedback.dart';
 import 'tracing.dart';
+import 'sentry_attachment/sentry_attachment.dart';
 
 /// Configuration options callback
 typedef OptionsConfiguration = FutureOr<void> Function(SentryOptions);
@@ -216,9 +218,21 @@
   /// Reports a [userFeedback] to Sentry.io.
   ///
   /// First capture an event and use the [SentryId] to create a [SentryUserFeedback]
+  @Deprecated(
+      'Will be removed in a future version. Use [captureFeedback] instead')
   static Future<void> captureUserFeedback(SentryUserFeedback userFeedback) =>
       _hub.captureUserFeedback(userFeedback);
 
+  /// Reports [SentryFeedback] to Sentry.io.
+  ///
+  /// Use [withScope] to add [SentryAttachment] to the feedback.
+  static Future<SentryId> captureFeedback(
+    SentryFeedback feedback, {
+    Hint? hint,
+    ScopeCallback? withScope,
+  }) =>
+      _hub.captureFeedback(feedback, hint: hint, withScope: withScope);
+
   /// Close the client SDK
   static Future<void> close() async {
     final hub = _hub;