Skip to content

Commit

Permalink
remove old user feedback api
Browse files Browse the repository at this point in the history
  • Loading branch information
buenaflor committed Feb 10, 2025
1 parent b2409ce commit 1e0e8fa
Show file tree
Hide file tree
Showing 24 changed files with 4,035 additions and 5,849 deletions.
69 changes: 34 additions & 35 deletions dart/lib/sentry.dart
Original file line number Diff line number Diff line change
Expand Up @@ -5,60 +5,59 @@
/// A pure Dart client for Sentry.io crash reporting.
library;

export 'src/run_zoned_guarded_integration.dart';
export 'src/event_processor.dart';
export 'src/exception_cause.dart';
// exception extraction
export 'src/exception_cause_extractor.dart';
export 'src/exception_stacktrace_extractor.dart';
export 'src/exception_type_identifier.dart';
export 'src/hint.dart';
export 'src/http_client/sentry_http_client.dart';
export 'src/http_client/sentry_http_client_error.dart';
export 'src/hub.dart';
// useful for tests
export 'src/hub_adapter.dart';
export 'src/platform_checker.dart';
export 'src/integration.dart';
export 'src/noop_isolate_error_integration.dart'
if (dart.library.io) 'src/isolate_error_integration.dart';
export 'src/performance_collector.dart';
export 'src/platform_checker.dart';
export 'src/protocol.dart';
// feedback
export 'src/protocol/sentry_feedback.dart';
// proxy
export 'src/protocol/sentry_proxy.dart';
export 'src/run_zoned_guarded_integration.dart';
export 'src/scope.dart';
export 'src/scope_observer.dart';
export 'src/sentry.dart';
export 'src/sentry_attachment/sentry_attachment.dart';
export 'src/sentry_baggage.dart';
export 'src/sentry_client.dart';
export 'src/sentry_envelope.dart';
export 'src/sentry_envelope_item.dart';
export 'src/sentry_client.dart';
export 'src/sentry_options.dart';
// ignore: invalid_export_of_internal_element
export 'src/sentry_span_operations.dart';
// ignore: invalid_export_of_internal_element
export 'src/sentry_trace_origins.dart';
// constants
export 'src/span_data_convention.dart';
// spotlight debugging
export 'src/spotlight.dart';
// useful for integrations
export 'src/throwable_mechanism.dart';
export 'src/transport/transport.dart';
export 'src/integration.dart';
export 'src/event_processor.dart';
export 'src/http_client/sentry_http_client.dart';
export 'src/http_client/sentry_http_client_error.dart';
export 'src/sentry_attachment/sentry_attachment.dart';
export 'src/sentry_user_feedback.dart';
export 'src/utils/tracing_utils.dart';
export 'src/performance_collector.dart';
// tracing
export 'src/tracing.dart';
export 'src/hint.dart';
export 'src/transport/transport.dart';
export 'src/type_check_hint.dart';
export 'src/sentry_baggage.dart';
// exception extraction
export 'src/exception_cause_extractor.dart';
export 'src/exception_cause.dart';
export 'src/exception_stacktrace_extractor.dart';
export 'src/exception_type_identifier.dart';
// URL
// ignore: invalid_export_of_internal_element
export 'src/utils/http_sanitizer.dart';
// ignore: invalid_export_of_internal_element
export 'src/utils/url_details.dart';
export 'src/utils.dart';
// ignore: invalid_export_of_internal_element
export 'src/utils/http_header_utils.dart';
// URL
// ignore: invalid_export_of_internal_element
export 'src/sentry_trace_origins.dart';
// ignore: invalid_export_of_internal_element
export 'src/sentry_span_operations.dart';
export 'src/utils/http_sanitizer.dart';
export 'src/utils/tracing_utils.dart';
// ignore: invalid_export_of_internal_element
export 'src/utils.dart';
// spotlight debugging
export 'src/spotlight.dart';
// proxy
export 'src/protocol/sentry_proxy.dart';
// feedback
export 'src/protocol/sentry_feedback.dart';
// constants
export 'src/span_data_convention.dart';
export 'src/utils/url_details.dart';
34 changes: 0 additions & 34 deletions dart/lib/src/hub.dart
Original file line number Diff line number Diff line change
Expand Up @@ -242,40 +242,6 @@ class Hub {
return sentryId;
}

@Deprecated(
'Will be removed in a future version. Use [captureFeedback] instead')
Future<void> captureUserFeedback(SentryUserFeedback userFeedback) async {
if (!_isEnabled) {
_options.logger(
SentryLevel.warning,
"Instance is disabled and this 'captureUserFeedback' call is a no-op.",
);
return;
}
if (userFeedback.eventId == SentryId.empty()) {
_options.logger(
SentryLevel.warning,
'Captured UserFeedback with empty id, dropping the feedback',
);
return;
}
try {
final item = _peek();

await item.client.captureUserFeedback(userFeedback);
} catch (exception, stacktrace) {
_options.logger(
SentryLevel.error,
'Error while capturing user feedback for ${userFeedback.eventId}',
exception: exception,
stackTrace: stacktrace,
);
if (_options.automatedTestMode) {
rethrow;
}
}
}

/// Captures the feedback.
Future<SentryId> captureFeedback(
SentryFeedback feedback, {
Expand Down
7 changes: 0 additions & 7 deletions dart/lib/src/hub_adapter.dart
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ import 'scope.dart';
import 'sentry.dart';
import 'sentry_client.dart';
import 'sentry_options.dart';
import 'sentry_user_feedback.dart';
import 'tracing.dart';

/// Hub adapter to make Integrations testable
Expand Down Expand Up @@ -110,12 +109,6 @@ class HubAdapter implements Hub {
@override
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
ISentrySpan startTransactionWithContext(
SentryTransactionContext transactionContext, {
Expand Down
5 changes: 0 additions & 5 deletions dart/lib/src/noop_hub.dart
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ import 'protocol/sentry_feedback.dart';
import 'scope.dart';
import 'sentry_client.dart';
import 'sentry_options.dart';
import 'sentry_user_feedback.dart';
import 'tracing.dart';

class NoOpHub implements Hub {
Expand Down Expand Up @@ -85,10 +84,6 @@ class NoOpHub implements Hub {
}) async =>
SentryId.empty();

@override
// ignore: deprecated_member_use_from_same_package
Future<void> captureUserFeedback(SentryUserFeedback userFeedback) async {}

@override
Future<SentryId> captureFeedback(
SentryFeedback feedback, {
Expand Down
5 changes: 0 additions & 5 deletions dart/lib/src/noop_sentry_client.dart
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ import 'scope.dart';
import 'sentry_client.dart';
import 'sentry_envelope.dart';
import 'sentry_trace_context_header.dart';
import 'sentry_user_feedback.dart';

class NoOpSentryClient implements SentryClient {
NoOpSentryClient._();
Expand Down Expand Up @@ -51,10 +50,6 @@ class NoOpSentryClient implements SentryClient {
Future<SentryId> captureEnvelope(SentryEnvelope envelope) async =>
SentryId.empty();

@override
// ignore: deprecated_member_use_from_same_package
Future<void> captureUserFeedback(SentryUserFeedback userFeedback) async {}

@override
Future<void> close() async {}

Expand Down
9 changes: 0 additions & 9 deletions dart/lib/src/sentry.dart
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ import 'sentry_attachment/sentry_attachment.dart';
import 'sentry_client.dart';
import 'sentry_options.dart';
import 'sentry_run_zoned_guarded.dart';
import 'sentry_user_feedback.dart';
import 'tracing.dart';
import 'transport/data_category.dart';
import 'transport/task_queue.dart';
Expand Down Expand Up @@ -249,14 +248,6 @@ class Sentry {
DataCategory.unknown,
);

/// 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.
Expand Down
13 changes: 0 additions & 13 deletions dart/lib/src/sentry_client.dart
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ import 'sentry_exception_factory.dart';
import 'sentry_options.dart';
import 'sentry_stack_trace_factory.dart';
import 'sentry_trace_context_header.dart';
import 'sentry_user_feedback.dart';
import 'transport/client_report_transport.dart';
import 'transport/data_category.dart';
import 'transport/http_transport.dart';
Expand Down Expand Up @@ -443,18 +442,6 @@ class SentryClient {
return _options.transport.send(envelope);
}

/// Reports the [userFeedback] to Sentry.io.
@Deprecated(
'Will be removed in a future version. Use [captureFeedback] instead')
Future<void> captureUserFeedback(SentryUserFeedback userFeedback) {
final envelope = SentryEnvelope.fromUserFeedback(
userFeedback,
_options.sdk,
dsn: _options.dsn,
);
return _options.transport.send(envelope);
}

/// Reports the [feedback] to Sentry.io.
Future<SentryId> captureFeedback(
SentryFeedback feedback, {
Expand Down
18 changes: 0 additions & 18 deletions dart/lib/src/sentry_envelope.dart
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ import 'sentry_envelope_item.dart';
import 'sentry_item_type.dart';
import 'sentry_options.dart';
import 'sentry_trace_context_header.dart';
import 'sentry_user_feedback.dart';
import 'utils.dart';

/// Class representation of `Envelope` file.
Expand Down Expand Up @@ -59,23 +58,6 @@ class SentryEnvelope {
);
}

@Deprecated('Will be removed in a future version.')
factory SentryEnvelope.fromUserFeedback(
SentryUserFeedback feedback,
SdkVersion sdkVersion, {
String? dsn,
}) {
return SentryEnvelope(
// no need for [traceContext]
SentryEnvelopeHeader(
feedback.eventId,
sdkVersion,
dsn: dsn,
),
[SentryEnvelopeItem.fromUserFeedback(feedback)],
);
}

/// Create a [SentryEnvelope] containing one [SentryEnvelopeItem] which holds the [SentryTransaction] data.
factory SentryEnvelope.fromTransaction(
SentryTransaction transaction,
Expand Down
17 changes: 0 additions & 17 deletions dart/lib/src/sentry_envelope_item.dart
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ import 'protocol.dart';
import 'sentry_attachment/sentry_attachment.dart';
import 'sentry_envelope_item_header.dart';
import 'sentry_item_type.dart';
import 'sentry_user_feedback.dart';
import 'utils.dart';

/// Item holding header information and JSON encoded data.
Expand Down Expand Up @@ -40,22 +39,6 @@ class SentryEnvelopeItem {
);
}

/// Create a [SentryEnvelopeItem] which sends [SentryUserFeedback].
@Deprecated('Will be removed in a future version.')
factory SentryEnvelopeItem.fromUserFeedback(SentryUserFeedback feedback) {
final dataFactory = () => utf8JsonEncoder.convert(feedback.toJson());

final header = SentryEnvelopeItemHeader(
SentryItemType.userFeedback,
contentType: 'application/json',
);
return SentryEnvelopeItem(
header,
dataFactory,
originalObject: feedback,
);
}

/// Create a [SentryEnvelopeItem] which holds the [SentryEvent] data.
factory SentryEnvelopeItem.fromEvent(SentryEvent event) {
return SentryEnvelopeItem(
Expand Down
69 changes: 0 additions & 69 deletions dart/lib/src/sentry_user_feedback.dart

This file was deleted.

7 changes: 0 additions & 7 deletions dart/test/mocks/mock_hub.dart
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ class MockHub with NoSuchMethodProvider implements Hub {
List<SentryClient?> bindClientCalls = [];

// ignore: deprecated_member_use_from_same_package
List<SentryUserFeedback> userFeedbackCalls = [];
List<CaptureTransactionCall> captureTransactionCalls = [];
int closeCalls = 0;
bool _isEnabled = true;
Expand Down Expand Up @@ -118,12 +117,6 @@ class MockHub with NoSuchMethodProvider implements Hub {
return transaction.eventId;
}

@override
// ignore: deprecated_member_use_from_same_package
Future<void> captureUserFeedback(SentryUserFeedback userFeedback) async {
userFeedbackCalls.add(userFeedback);
}

@override
ISentrySpan? getSpan() {
getSpanCalls++;
Expand Down
Loading

0 comments on commit 1e0e8fa

Please sign in to comment.