Feat: Client Report Recorder #809

denrase · 2022-03-28T13:17:02Z

#skip-changelog

📜 Description

Introduce model files for client reports.
Introduce class for "recording" lost events.

💡 Motivation and Context

This is the first PR for implementing client reports. It's based on the work done in the JS SDK, except that some of the business logic from transport is encapsulated in a separate class.

💚 How did you test it?

Unit tests.

📝 Checklist

🔮 Next steps

This PR will be merged on a separate branch, so we can split up development for the whole feature.
Integrate the recorder into transport, create envelopes, send reports, record events in SDK.

codecov-commenter · 2022-03-28T13:18:34Z

Codecov Report

Merging #809 (93c8cea) into feat/client-reports (636d851) will decrease coverage by 0.66%.
The diff coverage is 77.77%.

@@                   Coverage Diff                   @@
##           feat/client-reports     #809      +/-   ##
=======================================================
- Coverage                89.83%   89.17%   -0.67%     
=======================================================
  Files                      114       92      -22     
  Lines                     3670     2918     -752     
=======================================================
- Hits                      3297     2602     -695     
+ Misses                     373      316      -57

Impacted Files	Coverage Δ
dart/lib/src/transport/rate_limit.dart	`100.00% <ø> (ø)`
dart/lib/src/client_reports/outcome.dart	`25.00% <25.00%> (ø)`
dart/lib/src/transport/data_category.dart	`50.00% <50.00%> (ø)`
dart/lib/src/client_reports/client_report.dart	`100.00% <100.00%> (ø)`
...lib/src/client_reports/client_report_recorder.dart	`100.00% <100.00%> (ø)`
dart/lib/src/client_reports/discarded_event.dart	`100.00% <100.00%> (ø)`
dart/lib/src/transport/rate_limit_parser.dart	`95.83% <100.00%> (-0.17%)`	⬇️
dart/lib/src/transport/rate_limiter.dart	`87.80% <100.00%> (ø)`
flutter/lib/src/flutter_sentry_attachment.dart
.../lib/src/navigation/sentry_navigator_observer.dart
... and 24 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 636d851...93c8cea. Read the comment docs.

dart/lib/src/client_reports/client_report_recorder.dart

marandaneto · 2022-03-29T12:14:07Z

dart/lib/src/client_reports/client_report_recorder.dart

+  final DateTime Function() _dateTimeProvider;
+  final Map<_QuantityKey, int> _quantities = {};
+
+  void recordLostEvent(final Outcome reason, final RateLimitCategory category) {


We need to double check if RateLimitCategory is accurate and if it's missing new entries.
See https://github.com/getsentry/develop/pull/535/files and https://github.com/getsentry/develop/pull/536/files

Hmm, hard to say. We are missing the internal type in RateLimitCategory, but have the __all__ type, which i think is specific to the rate limiting implementation and should probably never be used here. Should we create a separate enum type to be on the safe side?

Let's wait those 2 PRs get reviewed/merged, we can rename to DataCategory at least in case this is not a breaking change to public APIs

Yes, I also renamed RateLimitCategory to DataCategory on Cocoa as relay uses DataCategory for both rate limits and client reports.

Can you point me to the appropriate PR/commit? Intrested in how you are handling the "all" case, assuming that it should not be valid in the client report context and is specific to rate limiting.

Just wondering, as the Dart implementation was ported from sentry-java and we have an all category there: https://github.com/getsentry/sentry-java/blob/b45944c93d53f68bc1e64f5ac4c9a5400b252d44/sentry/src/main/java/io/sentry/transport/RateLimiter.java#L25

I haven't added any special validation code to prevent usage of DataCategory enum values not meant for client reports as we don't need to take care of this (just asked).

dart/lib/src/client_reports/client_report_recorder.dart

philipphofmann

A few minor conceptual comments. Thanks, @denrase for taking care of client reports 🚀

philipphofmann · 2022-03-30T14:22:28Z

dart/lib/src/client_reports/client_report_recorder.dart

+  final DateTime Function() _dateTimeProvider;
+  final Map<_QuantityKey, int> _quantities = {};
+
+  void recordLostEvent(final Outcome reason, final RateLimitCategory category) {


Yes, I also renamed RateLimitCategory to DataCategory on Cocoa as relay uses DataCategory for both rate limits and client reports.

dart/lib/src/client_reports/outcome.dart

brustolin

LGTM

Introduce client report recorder

54048ea

Rename class

cd0dadf

denrase marked this pull request as ready for review March 28, 2022 13:26

denrase requested review from marandaneto and brustolin as code owners March 28, 2022 13:26

marandaneto reviewed Mar 29, 2022

View reviewed changes

dart/lib/src/client_reports/client_report_recorder.dart Outdated Show resolved Hide resolved

marandaneto reviewed Mar 29, 2022

View reviewed changes

dart/lib/src/client_reports/client_report_recorder.dart Outdated Show resolved Hide resolved

marandaneto reviewed Mar 29, 2022

View reviewed changes

dart/lib/src/client_reports/client_report_recorder.dart Show resolved Hide resolved

marandaneto reviewed Mar 29, 2022

View reviewed changes

dart/lib/src/client_reports/client_report_recorder.dart Show resolved Hide resolved

Denis Andrašec added 2 commits March 29, 2022 14:54

use ClockProvider typedef

10c8bb5

use non-growable list

75ab5bb

marandaneto requested review from mattjohnsonpint, philipphofmann and adinauer March 29, 2022 14:18

philipphofmann reviewed Mar 30, 2022

View reviewed changes

Denis Andrašec and others added 3 commits April 4, 2022 14:04

rename classes

659f5b2

Replace rate limit naming from default case prefix

93c8cea

rename file, introduce remaining enum cases

4576880

denrase requested a review from marandaneto April 5, 2022 08:13

marandaneto approved these changes Apr 6, 2022

View reviewed changes

brustolin approved these changes Apr 7, 2022

View reviewed changes

Feat: Client Report Envelope Item (#810)

9c40c3b

denrase merged commit 893a689 into feat/client-reports Apr 13, 2022

denrase deleted the feat/client-report-recorder branch April 13, 2022 07:28

denrase mentioned this pull request Apr 13, 2022

Feat: Client Reports #829

Merged

13 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat: Client Report Recorder #809

Feat: Client Report Recorder #809

denrase commented Mar 28, 2022 •

edited

codecov-commenter commented Mar 28, 2022 •

edited

marandaneto Mar 29, 2022

denrase Mar 29, 2022

marandaneto Mar 29, 2022

philipphofmann Mar 30, 2022

denrase Apr 4, 2022 •

edited

denrase Apr 4, 2022

adinauer Apr 4, 2022

philipphofmann left a comment

philipphofmann Mar 30, 2022

brustolin left a comment

Feat: Client Report Recorder #809

Feat: Client Report Recorder #809

Conversation

denrase commented Mar 28, 2022 • edited

📜 Description

💡 Motivation and Context

💚 How did you test it?

📝 Checklist

🔮 Next steps

codecov-commenter commented Mar 28, 2022 • edited

Codecov Report

marandaneto Mar 29, 2022

Choose a reason for hiding this comment

denrase Mar 29, 2022

Choose a reason for hiding this comment

marandaneto Mar 29, 2022

Choose a reason for hiding this comment

philipphofmann Mar 30, 2022

Choose a reason for hiding this comment

denrase Apr 4, 2022 • edited

Choose a reason for hiding this comment

denrase Apr 4, 2022

Choose a reason for hiding this comment

adinauer Apr 4, 2022

Choose a reason for hiding this comment

philipphofmann left a comment

Choose a reason for hiding this comment

philipphofmann Mar 30, 2022

Choose a reason for hiding this comment

brustolin left a comment

Choose a reason for hiding this comment

denrase commented Mar 28, 2022 •

edited

codecov-commenter commented Mar 28, 2022 •

edited

denrase Apr 4, 2022 •

edited