Improve docs static methods (#1051)

getsentry · Oct 7, 2022 · b8b9b7b · b8b9b7b
1 parent bc9607c
commit b8b9b7b
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 7 deletions.
diff --git a/dart/lib/src/sentry.dart b/dart/lib/src/sentry.dart
@@ -168,6 +168,7 @@ class Sentry {
         withScope: withScope,
       );
 
+  /// Reports a [message] to Sentry.io.
   static Future<SentryId> captureMessage(
     String? message, {
     SentryLevel? level = SentryLevel.info,
@@ -185,6 +186,9 @@ class Sentry {
         withScope: withScope,
       );
 
+  /// Reports a [userFeedback] to Sentry.io.
+  ///
+  /// First capture an event and use the [SentryId] to create a [SentryUserFeedback]
   static Future<void> captureUserFeedback(SentryUserFeedback userFeedback) =>
       _hub.captureUserFeedback(userFeedback);
 
@@ -276,7 +280,7 @@ class Sentry {
         onFinish: onFinish,
       );
 
-  /// Gets the current active transaction or span.
+  /// Gets the current active transaction or span bound to the scope.
   static ISentrySpan? getSpan() => _hub.getSpan();
 
   @internal

diff --git a/dart/lib/src/sentry_user_feedback.dart b/dart/lib/src/sentry_user_feedback.dart
@@ -6,7 +6,10 @@ class SentryUserFeedback {
     this.name,
     this.email,
     this.comments,
-  }) : assert(eventId != SentryId.empty());
+  }) : assert(eventId != SentryId.empty() &&
+            (name?.isNotEmpty == true ||
+                email?.isNotEmpty == true ||
+                comments?.isNotEmpty == true));
 
   factory SentryUserFeedback.fromJson(Map<String, dynamic> json) {
     return SentryUserFeedback(

diff --git a/dart/test/sentry_user_feedback_test.dart b/dart/test/sentry_user_feedback_test.dart
@@ -70,7 +70,10 @@ void main() {
 
   group('$SentryUserFeedback to envelops', () {
     test('to envelope', () {
-      final feedback = SentryUserFeedback(eventId: SentryId.newId());
+      final feedback = SentryUserFeedback(
+        eventId: SentryId.newId(),
+        name: 'test',
+      );
       final envelope = SentryEnvelope.fromUserFeedback(
         feedback,
         SdkVersion(name: 'a', version: 'b'),
@@ -88,8 +91,10 @@ void main() {
   test('sending $SentryUserFeedback', () async {
     final fixture = Fixture();
     final sut = fixture.getSut();
-    await sut
-        .captureUserFeedback(SentryUserFeedback(eventId: SentryId.newId()));
+    await sut.captureUserFeedback(SentryUserFeedback(
+      eventId: SentryId.newId(),
+      name: 'test',
+    ));
 
     expect(fixture.transport.envelopes.length, 1);
   });
@@ -106,7 +111,10 @@ void main() {
     final sut = fixture.getSut();
     await sut.close();
     await sut.captureUserFeedback(
-      SentryUserFeedback(eventId: SentryId.newId()),
+      SentryUserFeedback(
+        eventId: SentryId.newId(),
+        name: 'test',
+      ),
     );
 
     expect(fixture.transport.envelopes.length, 0);
@@ -133,7 +141,7 @@ void main() {
 
     await expectLater(() async {
       await sut.captureUserFeedback(
-        SentryUserFeedback(eventId: SentryId.newId()),
+        SentryUserFeedback(eventId: SentryId.newId(), name: 'name'),
       );
     }, returnsNormally);
   });