Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Validation for fetchedDisplayRefreshRate #2299

Closed
wants to merge 2 commits into from
Closed

Validation for fetchedDisplayRefreshRate #2299

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c05ea27
validation for fetchedDisplayRefreshRate
Sep 19, 2024
8685826
Update span_frame_metrics_collector_test.dart
Sep 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions flutter/lib/src/span_frame_metrics_collector.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ import 'native/sentry_native_binding.dart';
@internal
class SpanFrameMetricsCollector implements PerformanceContinuousCollector {
static const _frozenFrameThresholdMs = 700;
static const _defaultRefreshRate = 60;

static const totalFramesKey = 'frames.total';
static const framesDelayKey = 'frames.delay';
static const slowFramesKey = 'frames.slow';
Expand Down Expand Up @@ -39,7 +41,7 @@ class SpanFrameMetricsCollector implements PerformanceContinuousCollector {
bool get isTrackingRegistered => _isTrackingRegistered;
bool _isTrackingRegistered = false;

int displayRefreshRate = 60;
int displayRefreshRate = _defaultRefreshRate;

final _stopwatch = Stopwatch();

Expand All @@ -59,7 +61,7 @@ class SpanFrameMetricsCollector implements PerformanceContinuousCollector {
}

final fetchedDisplayRefreshRate = await _native?.displayRefreshRate();
if (fetchedDisplayRefreshRate != null) {
if (fetchedDisplayRefreshRate != null && fetchedDisplayRefreshRate > 0) {
options.logger(SentryLevel.debug,
'Retrieved display refresh rate at $fetchedDisplayRefreshRate');
displayRefreshRate = fetchedDisplayRefreshRate;
Expand Down Expand Up @@ -251,6 +253,6 @@ class SpanFrameMetricsCollector implements PerformanceContinuousCollector {
_isTrackingPaused = true;
frames.clear();
activeSpans.clear();
displayRefreshRate = 60;
displayRefreshRate = _defaultRefreshRate;
}
}
27 changes: 27 additions & 0 deletions flutter/test/span_frame_metrics_collector_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,33 @@ void main() {
expect(tracer.data['frames.total'], expectedTotalFrames);
});

test(
'captures metrics with display refresh rate of 60 if native refresh rate is 0',
() async {
final sut = fixture.sut;
fixture.options.tracesSampleRate = 1.0;
fixture.options.addPerformanceCollector(sut);
final startTimestamp = DateTime.now();
final endTimestamp =
startTimestamp.add(Duration(milliseconds: 1000)).toUtc();

when(fixture.mockSentryNative.displayRefreshRate())
.thenAnswer((_) async => 0);

final tracer = SentryTracer(
SentryTransactionContext('name', 'op', description: 'tracerDesc'),
fixture.hub,
startTimestamp: startTimestamp);

await Future<void>.delayed(Duration(milliseconds: 500));
await tracer.finish(endTimestamp: endTimestamp);

expect(tracer.data['frames.slow'], expectedSlowFrames);
expect(tracer.data['frames.frozen'], expectedFrozenFrames);
expect(tracer.data['frames.delay'], expectedFramesDelay);
expect(tracer.data['frames.total'], expectedTotalFrames);
});

test('onSpanFinished removes frames older than span start timestamp',
() async {
// Using multiple spans to test frame removal. When the last span is finished,
Expand Down