Skip to content

Commit 8c3e861

Browse files
jeremyjiang-devjeremyjiang-dev
committed
Rename FrameMetrics to PerfFrameMetrics
1 parent 6999284 commit 8c3e861

File tree

6 files changed

+44
-38
lines changed

6 files changed

+44
-38
lines changed

‎firebase-perf/src/main/java/com/google/firebase/perf/application/AppStateMonitor.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -354,15 +354,15 @@ private void sendScreenTrace(Activity activity) {
354354
} catch (IllegalArgumentException ignored) {
355355
logger.debug("View not hardware accelerated. Unable to collect screen trace.");
356356
}
357-
FrameMetricsCalculator.FrameMetrics frameMetrics =
357+
FrameMetricsCalculator.PerfFrameMetrics perfFrameMetrics =
358358
FrameMetricsCalculator.calculateFrameMetrics(frameMetricsAggregator.reset());
359-
if (frameMetrics.getTotalFrames() == 0
360-
&& frameMetrics.getSlowFrames() == 0
361-
&& frameMetrics.getFrozenFrames() == 0) {
359+
if (perfFrameMetrics.getTotalFrames() == 0
360+
&& perfFrameMetrics.getSlowFrames() == 0
361+
&& perfFrameMetrics.getFrozenFrames() == 0) {
362362
// All metrics are zero, no need to send screen trace.
363363
return;
364364
}
365-
ScreenTraceUtil.addFrameCounters(screenTrace, frameMetrics);
365+
ScreenTraceUtil.addFrameCounters(screenTrace, perfFrameMetrics);
366366
// Stop and record trace
367367
screenTrace.stop();
368368
}

‎firebase-perf/src/main/java/com/google/firebase/perf/application/FragmentStateMonitor.java

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
import com.google.android.gms.common.util.VisibleForTesting;
2222
import com.google.firebase.perf.logging.AndroidLogger;
2323
import com.google.firebase.perf.metrics.FrameMetricsCalculator;
24-
import com.google.firebase.perf.metrics.FrameMetricsCalculator.FrameMetrics;
24+
import com.google.firebase.perf.metrics.FrameMetricsCalculator.PerfFrameMetrics;
2525
import com.google.firebase.perf.metrics.Trace;
2626
import com.google.firebase.perf.transport.TransportManager;
2727
import com.google.firebase.perf.util.Clock;
@@ -32,7 +32,7 @@
3232
public class FragmentStateMonitor extends FragmentManager.FragmentLifecycleCallbacks {
3333
private static final AndroidLogger logger = AndroidLogger.getInstance();
3434
private final WeakHashMap<Fragment, Trace> fragmentToTraceMap = new WeakHashMap<>();
35-
private final WeakHashMap<Fragment, FrameMetrics> fragmentToMetricsMap = new WeakHashMap<>();
35+
private final WeakHashMap<Fragment, PerfFrameMetrics> fragmentToMetricsMap = new WeakHashMap<>();
3636
private final Clock clock;
3737
private final TransportManager transportManager;
3838
private final AppStateMonitor appStateMonitor;
@@ -79,9 +79,9 @@ public void onFragmentResumed(@NonNull FragmentManager fm, @NonNull Fragment f)
7979
}
8080
fragmentToTraceMap.put(f, fragmentTrace);
8181

82-
FrameMetrics frameMetrics =
82+
PerfFrameMetrics perfFrameMetrics =
8383
FrameMetricsCalculator.calculateFrameMetrics(this.frameMetricsAggregator.getMetrics());
84-
fragmentToMetricsMap.put(f, frameMetrics);
84+
fragmentToMetricsMap.put(f, perfFrameMetrics);
8585
}
8686

8787
@Override
@@ -96,22 +96,23 @@ public void onFragmentPaused(@NonNull FragmentManager fm, @NonNull Fragment f) {
9696

9797
Trace fragmentTrace = fragmentToTraceMap.get(f);
9898
fragmentToTraceMap.remove(f);
99-
FrameMetrics preFrameMetrics = fragmentToMetricsMap.get(f);
99+
PerfFrameMetrics prePerfFrameMetrics = fragmentToMetricsMap.get(f);
100100
fragmentToMetricsMap.remove(f);
101101

102-
FrameMetrics curFrameMetrics =
102+
PerfFrameMetrics curPerfFrameMetrics =
103103
FrameMetricsCalculator.calculateFrameMetrics(this.frameMetricsAggregator.getMetrics());
104104

105-
int totalFrames = curFrameMetrics.getTotalFrames() - preFrameMetrics.getTotalFrames();
106-
int slowFrames = curFrameMetrics.getSlowFrames() - preFrameMetrics.getSlowFrames();
107-
int frozenFrames = curFrameMetrics.getFrozenFrames() - preFrameMetrics.getFrozenFrames();
105+
int totalFrames = curPerfFrameMetrics.getTotalFrames() - prePerfFrameMetrics.getTotalFrames();
106+
int slowFrames = curPerfFrameMetrics.getSlowFrames() - prePerfFrameMetrics.getSlowFrames();
107+
int frozenFrames =
108+
curPerfFrameMetrics.getFrozenFrames() - prePerfFrameMetrics.getFrozenFrames();
108109

109110
if (totalFrames == 0 && slowFrames == 0 && frozenFrames == 0) {
110111
// All metrics are zero, no need to send screen trace.
111112
return;
112113
}
113114
ScreenTraceUtil.addFrameCounters(
114-
fragmentTrace, new FrameMetrics(totalFrames, slowFrames, frozenFrames));
115+
fragmentTrace, new PerfFrameMetrics(totalFrames, slowFrames, frozenFrames));
115116
fragmentTrace.stop();
116117
}
117118

@@ -121,7 +122,7 @@ WeakHashMap<Fragment, Trace> getFragmentToTraceMap() {
121122
}
122123

123124
@VisibleForTesting
124-
WeakHashMap<Fragment, FrameMetrics> getFragmentToMetricsMap() {
125+
WeakHashMap<Fragment, PerfFrameMetrics> getFragmentToMetricsMap() {
125126
return fragmentToMetricsMap;
126127
}
127128
}

‎firebase-perf/src/main/java/com/google/firebase/perf/metrics/FrameMetricsCalculator.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,12 @@
2727
* @hide
2828
*/
2929
public class FrameMetricsCalculator {
30-
public static class FrameMetrics {
30+
public static class PerfFrameMetrics {
3131
int totalFrames = 0;
3232
int slowFrames = 0;
3333
int frozenFrames = 0;
3434

35-
public FrameMetrics(int totalFrames, int slowFrames, int frozenFrames) {
35+
public PerfFrameMetrics(int totalFrames, int slowFrames, int frozenFrames) {
3636
this.totalFrames = totalFrames;
3737
this.slowFrames = slowFrames;
3838
this.frozenFrames = frozenFrames;
@@ -58,7 +58,7 @@ public int getTotalFrames() {
5858
* @param arr the metrics data collected by {@link FrameMetricsAggregator#getMetrics()}
5959
* @return the frame metrics
6060
*/
61-
public static @NonNull FrameMetrics calculateFrameMetrics(@Nullable SparseIntArray[] arr) {
61+
public static @NonNull PerfFrameMetrics calculateFrameMetrics(@Nullable SparseIntArray[] arr) {
6262
int totalFrames = 0;
6363
int slowFrames = 0;
6464
int frozenFrames = 0;
@@ -82,6 +82,6 @@ public int getTotalFrames() {
8282
}
8383
}
8484
// Only incrementMetric if corresponding metric is non-zero.
85-
return new FrameMetrics(totalFrames, slowFrames, frozenFrames);
85+
return new PerfFrameMetrics(totalFrames, slowFrames, frozenFrames);
8686
}
8787
}

‎firebase-perf/src/main/java/com/google/firebase/perf/util/ScreenTraceUtil.java

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
package com.google.firebase.perf.util;
1616

1717
import com.google.firebase.perf.logging.AndroidLogger;
18-
import com.google.firebase.perf.metrics.FrameMetricsCalculator.FrameMetrics;
18+
import com.google.firebase.perf.metrics.FrameMetricsCalculator.PerfFrameMetrics;
1919
import com.google.firebase.perf.metrics.Trace;
2020

2121
/** Utility class for screen traces. */
@@ -26,33 +26,33 @@ public class ScreenTraceUtil {
2626
* Set the metrics of total frames, slow frames, and frozen frames for the given screen trace.
2727
*
2828
* @param screenTrace a screen trace
29-
* @param frameMetrics frame metrics calculated by {@link
29+
* @param perfFrameMetrics frame metrics calculated by {@link
3030
* com.google.firebase.perf.metrics.FrameMetricsCalculator#calculateFrameMetrics}
3131
* @return the screen trace with frame metrics added.
3232
*/
33-
public static Trace addFrameCounters(Trace screenTrace, FrameMetrics frameMetrics) {
33+
public static Trace addFrameCounters(Trace screenTrace, PerfFrameMetrics perfFrameMetrics) {
3434
// Only putMetric if corresponding metric is greater than zero.
35-
if (frameMetrics.getTotalFrames() > 0) {
35+
if (perfFrameMetrics.getTotalFrames() > 0) {
3636
screenTrace.putMetric(
37-
Constants.CounterNames.FRAMES_TOTAL.toString(), frameMetrics.getTotalFrames());
37+
Constants.CounterNames.FRAMES_TOTAL.toString(), perfFrameMetrics.getTotalFrames());
3838
}
39-
if (frameMetrics.getSlowFrames() > 0) {
39+
if (perfFrameMetrics.getSlowFrames() > 0) {
4040
screenTrace.putMetric(
41-
Constants.CounterNames.FRAMES_SLOW.toString(), frameMetrics.getSlowFrames());
41+
Constants.CounterNames.FRAMES_SLOW.toString(), perfFrameMetrics.getSlowFrames());
4242
}
43-
if (frameMetrics.getFrozenFrames() > 0) {
43+
if (perfFrameMetrics.getFrozenFrames() > 0) {
4444
screenTrace.putMetric(
45-
Constants.CounterNames.FRAMES_FROZEN.toString(), frameMetrics.getFrozenFrames());
45+
Constants.CounterNames.FRAMES_FROZEN.toString(), perfFrameMetrics.getFrozenFrames());
4646
}
4747
logger.debug(
4848
"Screen trace: "
4949
+ screenTrace.getClass().getSimpleName()
5050
+ " _fr_tot:"
51-
+ frameMetrics.getTotalFrames()
51+
+ perfFrameMetrics.getTotalFrames()
5252
+ " _fr_slo:"
53-
+ frameMetrics.getSlowFrames()
53+
+ perfFrameMetrics.getSlowFrames()
5454
+ " _fr_fzn:"
55-
+ frameMetrics.getFrozenFrames());
55+
+ perfFrameMetrics.getFrozenFrames());
5656
return screenTrace;
5757
}
5858
}

‎firebase-perf/src/test/java/com/google/firebase/perf/application/FragmentStateMonitorTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ public void lifecycleCallbacks_cleansUpMap_duringActivityTransitions() {
201201
new FragmentStateMonitor(clock, mockTransportManager, appStateMonitor, fma);
202202
doReturn(true).when(appStateMonitor).isScreenTraceSupported();
203203
WeakHashMap<Fragment, Trace> fragmentToTraceMap = fragmentMonitor.getFragmentToTraceMap();
204-
WeakHashMap<Fragment, FrameMetricsCalculator.FrameMetrics> fragmentToMetricsMap =
204+
WeakHashMap<Fragment, FrameMetricsCalculator.PerfFrameMetrics> fragmentToMetricsMap =
205205
fragmentMonitor.getFragmentToMetricsMap();
206206
// Activity_A onCreate registers FragmentStateMonitor, then:
207207
appStateMonitor.onActivityStarted(mockActivity);

‎firebase-perf/src/test/java/com/google/firebase/perf/metrics/FrameMetricsCalculatorTest.java

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ public class FrameMetricsCalculatorTest {
2929
public void calculateFrameMetrics_sparseIntArrayIsNull_returnsFrameMetricsWithAllZeros() {
3030
SparseIntArray[] arr = new SparseIntArray[1];
3131
arr[FrameMetricsAggregator.TOTAL_INDEX] = null;
32-
FrameMetricsCalculator.FrameMetrics metrics = FrameMetricsCalculator.calculateFrameMetrics(arr);
32+
FrameMetricsCalculator.PerfFrameMetrics metrics =
33+
FrameMetricsCalculator.calculateFrameMetrics(arr);
3334
assertThat(metrics.getTotalFrames()).isEqualTo(0);
3435
assertThat(metrics.getSlowFrames()).isEqualTo(0);
3536
assertThat(metrics.getFrozenFrames()).isEqualTo(0);
@@ -46,7 +47,8 @@ public void calculateFrameMetrics_validSparseIntArray_returnsCorrectFrameMetrics
4647
SparseIntArray[] arr = new SparseIntArray[1];
4748
arr[FrameMetricsAggregator.TOTAL_INDEX] = sparseIntArray;
4849

49-
FrameMetricsCalculator.FrameMetrics metrics = FrameMetricsCalculator.calculateFrameMetrics(arr);
50+
FrameMetricsCalculator.PerfFrameMetrics metrics =
51+
FrameMetricsCalculator.calculateFrameMetrics(arr);
5052

5153
// we should expect 3+2+5=10 total frames, 2+5=7 slow frames, and 5 frozen frames.
5254
assertThat(metrics.getTotalFrames()).isEqualTo(10);
@@ -65,7 +67,8 @@ public void calculateFrameMetrics_validSparseIntArray_returnsCorrectFrameMetrics
6567
SparseIntArray[] arr = new SparseIntArray[1];
6668
arr[FrameMetricsAggregator.TOTAL_INDEX] = sparseIntArray;
6769

68-
FrameMetricsCalculator.FrameMetrics metrics = FrameMetricsCalculator.calculateFrameMetrics(arr);
70+
FrameMetricsCalculator.PerfFrameMetrics metrics =
71+
FrameMetricsCalculator.calculateFrameMetrics(arr);
6972

7073
// we should expect 3+2=5 total frames, 2 slow frames, and 0 frozen frames.
7174
assertThat(metrics.getTotalFrames()).isEqualTo(5);
@@ -84,7 +87,8 @@ public void calculateFrameMetrics_validSparseIntArray_returnsCorrectFrameMetrics
8487
SparseIntArray[] arr = new SparseIntArray[1];
8588
arr[FrameMetricsAggregator.TOTAL_INDEX] = sparseIntArray;
8689

87-
FrameMetricsCalculator.FrameMetrics metrics = FrameMetricsCalculator.calculateFrameMetrics(arr);
90+
FrameMetricsCalculator.PerfFrameMetrics metrics =
91+
FrameMetricsCalculator.calculateFrameMetrics(arr);
8892

8993
// we should expect 3+2=5 total frames, 0+2=2 slow frames, and 2 frozen frames.
9094
assertThat(metrics.getTotalFrames()).isEqualTo(5);
@@ -102,7 +106,8 @@ public void calculateFrameMetrics_validSparseIntArray_returnsCorrectFrameMetrics
102106
SparseIntArray[] arr = new SparseIntArray[1];
103107
arr[FrameMetricsAggregator.TOTAL_INDEX] = sparseIntArray;
104108

105-
FrameMetricsCalculator.FrameMetrics metrics = FrameMetricsCalculator.calculateFrameMetrics(arr);
109+
FrameMetricsCalculator.PerfFrameMetrics metrics =
110+
FrameMetricsCalculator.calculateFrameMetrics(arr);
106111

107112
// we should expect 3 total frames, 0 slow frames, and 0 frozen frames.
108113
assertThat(metrics.getTotalFrames()).isEqualTo(3);

0 commit comments

Comments
 (0)