|
| 1 | +package io.sentry.react; |
| 2 | + |
| 3 | +import io.sentry.android.core.internal.util.SentryFrameMetricsCollector; |
| 4 | +import java.util.List; |
| 5 | +import java.util.concurrent.CopyOnWriteArrayList; |
| 6 | +import org.jetbrains.annotations.Nullable; |
| 7 | + |
| 8 | +/** |
| 9 | + * Collects per-frame delay data from {@link SentryFrameMetricsCollector} and provides a method to |
| 10 | + * query the accumulated delay within a given time range. |
| 11 | + * |
| 12 | + * <p>This is a temporary solution until sentry-java exposes a queryable API for frames delay |
| 13 | + * (similar to sentry-cocoa's getFramesDelaySPI). |
| 14 | + */ |
| 15 | +public class RNSentryFrameDelayCollector |
| 16 | + implements SentryFrameMetricsCollector.FrameMetricsCollectorListener { |
| 17 | + |
| 18 | + private static final long MAX_FRAME_AGE_NANOS = 5L * 60 * 1_000_000_000L; // 5 minutes |
| 19 | + |
| 20 | + private final List<FrameRecord> frames = new CopyOnWriteArrayList<>(); |
| 21 | + |
| 22 | + private @Nullable String listenerId; |
| 23 | + private @Nullable SentryFrameMetricsCollector collector; |
| 24 | + |
| 25 | + /** |
| 26 | + * Starts collecting frame delay data from the given collector. |
| 27 | + * |
| 28 | + * @return true if collection was started successfully |
| 29 | + */ |
| 30 | + public boolean start(@Nullable SentryFrameMetricsCollector frameMetricsCollector) { |
| 31 | + if (frameMetricsCollector == null) { |
| 32 | + return false; |
| 33 | + } |
| 34 | + stop(); |
| 35 | + this.collector = frameMetricsCollector; |
| 36 | + this.listenerId = frameMetricsCollector.startCollection(this); |
| 37 | + return this.listenerId != null; |
| 38 | + } |
| 39 | + |
| 40 | + /** Stops collecting frame delay data. */ |
| 41 | + public void stop() { |
| 42 | + if (collector != null && listenerId != null) { |
| 43 | + collector.stopCollection(listenerId); |
| 44 | + listenerId = null; |
| 45 | + collector = null; |
| 46 | + } |
| 47 | + frames.clear(); |
| 48 | + } |
| 49 | + |
| 50 | + @Override |
| 51 | + public void onFrameMetricCollected( |
| 52 | + long frameStartNanos, |
| 53 | + long frameEndNanos, |
| 54 | + long durationNanos, |
| 55 | + long delayNanos, |
| 56 | + boolean isSlow, |
| 57 | + boolean isFrozen, |
| 58 | + float refreshRate) { |
| 59 | + if (delayNanos <= 0) { |
| 60 | + return; |
| 61 | + } |
| 62 | + frames.add(new FrameRecord(frameStartNanos, frameEndNanos, delayNanos)); |
| 63 | + pruneOldFrames(frameEndNanos); |
| 64 | + } |
| 65 | + |
| 66 | + /** |
| 67 | + * Returns the total frames delay in seconds for the given time range. |
| 68 | + * |
| 69 | + * <p>Handles partial overlap: if a frame's delay period partially falls within the query range, |
| 70 | + * only the overlapping portion is counted. |
| 71 | + * |
| 72 | + * @param startNanos start of the query range in system nanos (e.g., System.nanoTime()) |
| 73 | + * @param endNanos end of the query range in system nanos |
| 74 | + * @return delay in seconds, or -1 if no data is available |
| 75 | + */ |
| 76 | + public double getFramesDelay(long startNanos, long endNanos) { |
| 77 | + if (startNanos >= endNanos) { |
| 78 | + return -1; |
| 79 | + } |
| 80 | + |
| 81 | + long totalDelayNanos = 0; |
| 82 | + |
| 83 | + for (FrameRecord frame : frames) { |
| 84 | + if (frame.endNanos <= startNanos) { |
| 85 | + continue; |
| 86 | + } |
| 87 | + if (frame.startNanos >= endNanos) { |
| 88 | + break; |
| 89 | + } |
| 90 | + |
| 91 | + // The delay portion of a frame is at the end of the frame duration. |
| 92 | + // delayStart = frameEnd - delay, delayEnd = frameEnd |
| 93 | + long delayStart = frame.endNanos - frame.delayNanos; |
| 94 | + long delayEnd = frame.endNanos; |
| 95 | + |
| 96 | + // Intersect the delay interval with the query range |
| 97 | + long overlapStart = Math.max(delayStart, startNanos); |
| 98 | + long overlapEnd = Math.min(delayEnd, endNanos); |
| 99 | + |
| 100 | + if (overlapEnd > overlapStart) { |
| 101 | + totalDelayNanos += (overlapEnd - overlapStart); |
| 102 | + } |
| 103 | + } |
| 104 | + |
| 105 | + return totalDelayNanos / 1e9; |
| 106 | + } |
| 107 | + |
| 108 | + private void pruneOldFrames(long currentNanos) { |
| 109 | + long cutoff = currentNanos - MAX_FRAME_AGE_NANOS; |
| 110 | + // Remove from the front one-by-one. CopyOnWriteArrayList.remove(0) is O(n) per call, |
| 111 | + // but old frames are pruned incrementally so typically only 0-1 entries are removed. |
| 112 | + while (!frames.isEmpty() && frames.get(0).endNanos < cutoff) { |
| 113 | + frames.remove(0); |
| 114 | + } |
| 115 | + } |
| 116 | + |
| 117 | + private static class FrameRecord { |
| 118 | + final long startNanos; |
| 119 | + final long endNanos; |
| 120 | + final long delayNanos; |
| 121 | + |
| 122 | + FrameRecord(long startNanos, long endNanos, long delayNanos) { |
| 123 | + this.startNanos = startNanos; |
| 124 | + this.endNanos = endNanos; |
| 125 | + this.delayNanos = delayNanos; |
| 126 | + } |
| 127 | + } |
| 128 | +} |
0 commit comments