Skip to content

Fix fireperf RateLimiter replenishment behavior and unit alignment. #2662

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

Merged
merged 5 commits into from
May 20, 2021
Merged

Fix fireperf RateLimiter replenishment behavior and unit alignment. #2662

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a70ec5e
Fix fireperf RateLimiter
jfcong May 13, 2021
749faf7
Added burst tests to the RateLimiter
jfcong May 13, 2021
b70478e
fix naming and use standard Timeunit library
jfcong May 14, 2021
cea38e5
Fix formatting for RateTest
jfcong May 14, 2021
a2525a1
Make conversion variables inline in the Rate class
jfcong May 17, 2021
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
4 changes: 2 additions & 2 deletions firebase-perf/src/main/java/com/google/firebase/perf/transport/RateLimiter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,14 +264,14 @@ synchronized boolean check(@NonNull PerfMetric metric) {
0,
(long)
(lastTimeTokenReplenished.getDurationMicros(now)
* rate.getTokenPerSeconds()
* rate.getTokensPerSeconds()
/ MICROS_IN_A_SECOND));
tokenCount = Math.min(tokenCount + newTokens, capacity);
if (newTokens > 0) {
lastTimeTokenReplenished =
new Timer(
lastTimeTokenReplenished.getMicros()
+ (long) (newTokens * MICROS_IN_A_SECOND / rate.getTokenPerSeconds()));
+ (long) (newTokens * MICROS_IN_A_SECOND / rate.getTokensPerSeconds()));
}
if (tokenCount > 0) {
tokenCount--;
Expand Down
10 changes: 6 additions & 4 deletions firebase-perf/src/main/java/com/google/firebase/perf/util/Rate.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,16 @@

package com.google.firebase.perf.util;

import static java.util.concurrent.TimeUnit.SECONDS;

import java.util.concurrent.TimeUnit;

/** A Rate object representing the number of tokens per total specified time unit. */
public class Rate {

private static final long NANO_IN_SECOND = 1000 * 1000 * 1000;
private static final long MICRO_IN_SECOND = 1000 * 1000;
private static final long MILLI_IN_SECOND = 1000;
private static final long NANO_IN_SECOND = SECONDS.toNanos(1);
private static final long MICRO_IN_SECOND = SECONDS.toMicros(1);
private static final long MILLI_IN_SECOND = SECONDS.toMillis(1);

private long numTokensPerTotalTimeUnit;
private long numTimeUnits;
Expand Down Expand Up @@ -49,7 +51,7 @@ public Rate(long numTokensPerTotalTimeUnit, long numTimeUnits, TimeUnit timeUnit
*
* @return rate in tokens per second
*/
public double getTokenPerSeconds() {
public double getTokensPerSeconds() {
switch (timeUnit) {
case NANOSECONDS:
return ((double) numTokensPerTotalTimeUnit / numTimeUnits) * NANO_IN_SECOND;
Expand Down
24 changes: 12 additions & 12 deletions firebase-perf/src/test/java/com/google/firebase/perf/transport/RateLimiterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -515,10 +515,10 @@ public void getRateFromNetworkParams_nonDefaultValues_worksCorrectly() {
NETWORK,
/* isLogcatEnabled= */ false);

assertThat(limiter.getRate().getTokenPerSeconds()).isEqualTo(2.0);
assertThat(limiter.getForegroundRate().getTokenPerSeconds()).isEqualTo(700.0d / 60L);
assertThat(limiter.getRate().getTokensPerSeconds()).isEqualTo(2.0);
assertThat(limiter.getForegroundRate().getTokensPerSeconds()).isEqualTo(700.0d / 60L);
assertThat(limiter.getForegroundCapacity()).isEqualTo(700L);
assertThat(limiter.getBackgroundRate().getTokenPerSeconds()).isEqualTo(60.0d / 60L);
assertThat(limiter.getBackgroundRate().getTokensPerSeconds()).isEqualTo(60.0d / 60L);
assertThat(limiter.getBackgroundCapacity()).isEqualTo(60L);
}

Expand All @@ -535,11 +535,11 @@ public void getRateFromNetworkParams_defaultValues_worksCorrectly() {
NETWORK,
/* isLogcatEnabled= */ false);

assertThat(limiter.getRate().getTokenPerSeconds()).isEqualTo(2.0);
assertThat(limiter.getRate().getTokensPerSeconds()).isEqualTo(2.0);

assertThat(limiter.getForegroundRate().getTokenPerSeconds()).isEqualTo(700.0d / 600);
assertThat(limiter.getForegroundRate().getTokensPerSeconds()).isEqualTo(700.0d / 600);
assertThat(limiter.getForegroundCapacity()).isEqualTo(700L);
assertThat(limiter.getBackgroundRate().getTokenPerSeconds()).isEqualTo(70.0d / 600);
assertThat(limiter.getBackgroundRate().getTokensPerSeconds()).isEqualTo(70.0d / 600);
assertThat(limiter.getBackgroundCapacity()).isEqualTo(70L);
}

Expand All @@ -560,10 +560,10 @@ public void getRateFromTraceParams_nonDefaultValues_worksCorrectly() {
TRACE,
/* isLogcatEnabled= */ false);

assertThat(limiter.getRate().getTokenPerSeconds()).isEqualTo(2.0);
assertThat(limiter.getForegroundRate().getTokenPerSeconds()).isEqualTo(600.0d / 60L);
assertThat(limiter.getRate().getTokensPerSeconds()).isEqualTo(2.0);
assertThat(limiter.getForegroundRate().getTokensPerSeconds()).isEqualTo(600.0d / 60L);
assertThat(limiter.getForegroundCapacity()).isEqualTo(600L);
assertThat(limiter.getBackgroundRate().getTokenPerSeconds()).isEqualTo(60.0d / 60L);
assertThat(limiter.getBackgroundRate().getTokensPerSeconds()).isEqualTo(60.0d / 60L);
assertThat(limiter.getBackgroundCapacity()).isEqualTo(60L);
}

Expand All @@ -580,11 +580,11 @@ public void getRateFromTraceParams_defaultValues_worksCorrectly() {
TRACE,
/* isLogcatEnabled= */ false);

assertThat(limiter.getRate().getTokenPerSeconds()).isEqualTo(2.0);
assertThat(limiter.getRate().getTokensPerSeconds()).isEqualTo(2.0);

assertThat(limiter.getForegroundRate().getTokenPerSeconds()).isEqualTo(300.0d / 600);
assertThat(limiter.getForegroundRate().getTokensPerSeconds()).isEqualTo(300.0d / 600);
assertThat(limiter.getForegroundCapacity()).isEqualTo(300L);
assertThat(limiter.getBackgroundRate().getTokenPerSeconds()).isEqualTo(30.0d / 600);
assertThat(limiter.getBackgroundRate().getTokensPerSeconds()).isEqualTo(30.0d / 600);
assertThat(limiter.getBackgroundCapacity()).isEqualTo(30L);
}

Expand Down
41 changes: 21 additions & 20 deletions firebase-perf/src/test/java/com/google/firebase/perf/util/RateTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,61 +26,62 @@
public class RateTest {

@Test
public void ratePerMinute() throws InterruptedException {
public void ratePerMinute() throws Exception {
Rate twoTokensPerMinute = new Rate(2, 1, TimeUnit.MINUTES);
Rate twentyTokensPerTenMinutes = new Rate(5, 10, TimeUnit.MINUTES);
Rate twoTokensPerTenMinutes = new Rate(2, 10, TimeUnit.MINUTES);

assertThat(twoTokensPerMinute.getTokenPerSeconds()).isEqualTo(2.0 / 60);
assertThat(twentyTokensPerTenMinutes.getTokenPerSeconds()).isEqualTo((5.0 / 10) / 60);
assertThat(twoTokensPerTenMinutes.getTokenPerSeconds()).isEqualTo((2.0 / 10) / 60);
assertThat(twoTokensPerMinute.getTokensPerSeconds()).isEqualTo(2.0 / 60);
assertThat(twentyTokensPerTenMinutes.getTokensPerSeconds()).isEqualTo((5.0 / 10) / 60);
assertThat(twoTokensPerTenMinutes.getTokensPerSeconds()).isEqualTo((2.0 / 10) / 60);
}

@Test
public void ratePerSecond() throws InterruptedException {
public void ratePerSecond() throws Exception {
Rate twoTokensPerSecond = new Rate(2, 1, TimeUnit.SECONDS);
Rate twoTokensPerThirtySeconds = new Rate(2, 30, TimeUnit.SECONDS);
Rate seventyTokensPerThirtySeconds = new Rate(70, 30, TimeUnit.SECONDS);

assertThat(twoTokensPerSecond.getTokenPerSeconds()).isEqualTo(2.0);
assertThat(twoTokensPerThirtySeconds.getTokenPerSeconds()).isEqualTo(2.0 / 30);
assertThat(seventyTokensPerThirtySeconds.getTokenPerSeconds()).isEqualTo(70.0 / 30);
assertThat(twoTokensPerSecond.getTokensPerSeconds()).isEqualTo(2.0);
assertThat(twoTokensPerThirtySeconds.getTokensPerSeconds()).isEqualTo(2.0 / 30);
assertThat(seventyTokensPerThirtySeconds.getTokensPerSeconds()).isEqualTo(70.0 / 30);
}

@Test
public void ratePerMillisecond() throws InterruptedException {
public void ratePerMillisecond() throws Exception {
Rate twoTokensPerMillisecond = new Rate(2, 1, TimeUnit.MILLISECONDS);
Rate sevenTokensPerTenMillisecond = new Rate(7, 10, TimeUnit.MILLISECONDS);
Rate thirtyOneTokensPerTenMillisecond = new Rate(31, 10, TimeUnit.MILLISECONDS);

assertThat(twoTokensPerMillisecond.getTokenPerSeconds()).isEqualTo(2.0 * 1000);
assertThat(sevenTokensPerTenMillisecond.getTokenPerSeconds()).isEqualTo((7.0 / 10) * 1000);
assertThat(thirtyOneTokensPerTenMillisecond.getTokenPerSeconds()).isEqualTo((31.0 / 10) * 1000);
assertThat(twoTokensPerMillisecond.getTokensPerSeconds()).isEqualTo(2.0 * 1000);
assertThat(sevenTokensPerTenMillisecond.getTokensPerSeconds()).isEqualTo((7.0 / 10) * 1000);
assertThat(thirtyOneTokensPerTenMillisecond.getTokensPerSeconds())
.isEqualTo((31.0 / 10) * 1000);
}

@Test
public void ratePerMicrosecond() throws InterruptedException {
public void ratePerMicrosecond() throws Exception {
Rate twoTokensPerMicrosecond = new Rate(2, 1, TimeUnit.MICROSECONDS);
Rate sevenTokensPerTenMicroseconds = new Rate(7, 10, TimeUnit.MICROSECONDS);
Rate thirtyOneTokensPerTenMicroseconds = new Rate(31, 10, TimeUnit.MICROSECONDS);

assertThat(twoTokensPerMicrosecond.getTokenPerSeconds()).isEqualTo(2.0 * 1000 * 1000);
assertThat(sevenTokensPerTenMicroseconds.getTokenPerSeconds())
assertThat(twoTokensPerMicrosecond.getTokensPerSeconds()).isEqualTo(2.0 * 1000 * 1000);
assertThat(sevenTokensPerTenMicroseconds.getTokensPerSeconds())
.isEqualTo((7.0 / 10) * 1000 * 1000);
assertThat(thirtyOneTokensPerTenMicroseconds.getTokenPerSeconds())
assertThat(thirtyOneTokensPerTenMicroseconds.getTokensPerSeconds())
.isEqualTo((31.0 / 10) * 1000 * 1000);
}

@Test
public void ratePerNanosecond() throws InterruptedException {
public void ratePerNanosecond() throws Exception {
Rate twoTokensPerNanosecond = new Rate(2, 1, TimeUnit.NANOSECONDS);
Rate sevenTokensPerTenNanoseconds = new Rate(7, 10, TimeUnit.NANOSECONDS);
Rate thirtyOneTokensPerTenNanoseconds = new Rate(31, 10, TimeUnit.NANOSECONDS);

assertThat(twoTokensPerNanosecond.getTokenPerSeconds()).isEqualTo(2.0 * 1000 * 1000 * 1000);
assertThat(sevenTokensPerTenNanoseconds.getTokenPerSeconds())
assertThat(twoTokensPerNanosecond.getTokensPerSeconds()).isEqualTo(2.0 * 1000 * 1000 * 1000);
assertThat(sevenTokensPerTenNanoseconds.getTokensPerSeconds())
.isEqualTo((7.0 / 10) * 1000 * 1000 * 1000);
assertThat(thirtyOneTokensPerTenNanoseconds.getTokenPerSeconds())
assertThat(thirtyOneTokensPerTenNanoseconds.getTokensPerSeconds())
.isEqualTo((31.0 / 10) * 1000 * 1000 * 1000);
}
}