Prevent excessive api calls

apitest/src/main/java/bisq/apitest/Scaffold.java

@@ -154,7 +154,8 @@ public void tearDown() {
             try {
                 log.info("Shutting down executor service ...");
                 executor.shutdownNow();
-                executor.awaitTermination(config.supportingApps.size() * 2000, MILLISECONDS);
+                //noinspection ResultOfMethodCallIgnored
+                executor.awaitTermination(config.supportingApps.size() * 2000L, MILLISECONDS);
 
                 SetupTask[] orderedTasks = new SetupTask[]{
                         bobNodeTask, aliceNodeTask, arbNodeTask, seedNodeTask, bitcoindTask};
@@ -218,20 +219,25 @@ public void installDaoSetupDirectories() {
             if (copyBitcoinRegtestDir.run().getExitStatus() != 0)
                 throw new IllegalStateException("Could not install bitcoin regtest dir");
 
+            String aliceDataDir = daoSetupDir + "/" + alicedaemon.appName;
             BashCommand copyAliceDataDir = new BashCommand(
-                    "cp -rf " + daoSetupDir + "/" + alicedaemon.appName
-                            + " " + config.rootAppDataDir);
+                    "cp -rf " + aliceDataDir + " " + config.rootAppDataDir);
             if (copyAliceDataDir.run().getExitStatus() != 0)
                 throw new IllegalStateException("Could not install alice data dir");
 
+            String bobDataDir = daoSetupDir + "/" + bobdaemon.appName;
             BashCommand copyBobDataDir = new BashCommand(
-                    "cp -rf " + daoSetupDir + "/" + bobdaemon.appName
-                            + " " + config.rootAppDataDir);
+                    "cp -rf " + bobDataDir + " " + config.rootAppDataDir);
             if (copyBobDataDir.run().getExitStatus() != 0)
                 throw new IllegalStateException("Could not install bob data dir");
 
             log.info("Installed dao-setup files into {}", buildDataDir);
 
+            if (!config.callRateMeteringConfigPath.isEmpty()) {
+                installCallRateMeteringConfiguration(aliceDataDir);
+                installCallRateMeteringConfiguration(bobDataDir);
+            }
+
             // Copy the blocknotify script from the src resources dir to the build
             // resources dir.  Users may want to edit comment out some lines when all
             // of the default block notifcation ports being will not be used (to avoid
@@ -287,6 +293,25 @@ private void installBitcoinBlocknotify() {
         }
     }
 
+    private void installCallRateMeteringConfiguration(String dataDir) throws IOException, InterruptedException {
+        File testRateMeteringFile = new File(config.callRateMeteringConfigPath);
+        if (!testRateMeteringFile.exists())
+            throw new FileNotFoundException(
+                    format("Call rate metering config file '%s' not found", config.callRateMeteringConfigPath));
+
+        BashCommand copyRateMeteringConfigFile = new BashCommand(
+                "cp -rf " + config.callRateMeteringConfigPath + " " + dataDir);
+        if (copyRateMeteringConfigFile.run().getExitStatus() != 0)
+            throw new IllegalStateException(
+                    format("Could not install %s file in %s",
+                            testRateMeteringFile.getAbsolutePath(), dataDir));
+
+        Path destPath = Paths.get(dataDir, testRateMeteringFile.getName());
+        String chmod700Perms = "rwx------";
+        Files.setPosixFilePermissions(destPath, PosixFilePermissions.fromString(chmod700Perms));
+        log.info("Installed {} with perms {}.", destPath.toString(), chmod700Perms);
+    }
+
     private void installShutdownHook() {
         // Background apps can be left running until the jvm is manually shutdown,
         // so we add a shutdown hook for that use case.

apitest/src/main/java/bisq/apitest/config/ApiTestConfig.java

@@ -71,6 +71,7 @@ public class ApiTestConfig {
     static final String SKIP_TESTS = "skipTests";
     static final String SHUTDOWN_AFTER_TESTS = "shutdownAfterTests";
     static final String SUPPORTING_APPS = "supportingApps";
+    static final String CALL_RATE_METERING_CONFIG_PATH = "callRateMeteringConfigPath";
     static final String ENABLE_BISQ_DEBUGGING = "enableBisqDebugging";
 
     // Default values for certain options
@@ -102,6 +103,7 @@ public class ApiTestConfig {
     public final boolean skipTests;
     public final boolean shutdownAfterTests;
     public final List<String> supportingApps;
+    public final String callRateMeteringConfigPath;
     public final boolean enableBisqDebugging;
 
     // Immutable system configurations set in the constructor.
@@ -228,6 +230,12 @@ public ApiTestConfig(String... args) {
                         .ofType(String.class)
                         .defaultsTo("bitcoind,seednode,arbdaemon,alicedaemon,bobdaemon");
 
+        ArgumentAcceptingOptionSpec<String> callRateMeteringConfigPathOpt =
+                parser.accepts(CALL_RATE_METERING_CONFIG_PATH,
+                        "Install a ratemeters.json file to configure call rate metering interceptors")
+                        .withRequiredArg()
+                        .defaultsTo(EMPTY);
+
         ArgumentAcceptingOptionSpec<Boolean> enableBisqDebuggingOpt =
                 parser.accepts(ENABLE_BISQ_DEBUGGING,
                         "Start Bisq apps with remote debug options")
@@ -289,6 +297,7 @@ public ApiTestConfig(String... args) {
             this.skipTests = options.valueOf(skipTestsOpt);
             this.shutdownAfterTests = options.valueOf(shutdownAfterTestsOpt);
             this.supportingApps = asList(options.valueOf(supportingAppsOpt).split(","));
+            this.callRateMeteringConfigPath = options.valueOf(callRateMeteringConfigPathOpt);
             this.enableBisqDebugging = options.valueOf(enableBisqDebuggingOpt);
 
             // Assign values to special-case static fields.

apitest/src/test/java/bisq/apitest/ApiTestCase.java

@@ -19,6 +19,7 @@
 
 import java.net.InetAddress;
 
+import java.io.File;
 import java.io.IOException;
 
 import java.util.HashMap;
@@ -72,6 +73,16 @@ public class ApiTestCase {
     // gRPC service stubs are used by method & scenario tests, but not e2e tests.
     private static final Map<BisqAppConfig, GrpcStubs> grpcStubsCache = new HashMap<>();
 
+    public static void setUpScaffold(File callRateMeteringConfigFile,
+                                     Enum<?>... supportingApps)
+            throws InterruptedException, ExecutionException, IOException {
+        scaffold = new Scaffold(stream(supportingApps).map(Enum::name)
+                .collect(Collectors.joining(",")))
+                .setUp();
+        config = scaffold.config;
+        bitcoinCli = new BitcoinCliHelper((config));
+    }
+
     public static void setUpScaffold(Enum<?>... supportingApps)
             throws InterruptedException, ExecutionException, IOException {
         scaffold = new Scaffold(stream(supportingApps).map(Enum::name)

apitest/src/test/java/bisq/apitest/method/CallRateMeteringInterceptorTest.java

@@ -0,0 +1,129 @@
+/*
+ * This file is part of Bisq.
+ *
+ * Bisq is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at
+ * your option) any later version.
+ *
+ * Bisq is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public
+ * License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with Bisq. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package bisq.apitest.method;
+
+import io.grpc.StatusRuntimeException;
+
+import java.io.File;
+
+import lombok.extern.slf4j.Slf4j;
+
+import org.junit.jupiter.api.AfterAll;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Disabled;
+import org.junit.jupiter.api.MethodOrderer;
+import org.junit.jupiter.api.Order;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.TestMethodOrder;
+
+import static bisq.apitest.Scaffold.BitcoinCoreApp.bitcoind;
+import static bisq.apitest.config.BisqAppConfig.alicedaemon;
+import static java.util.concurrent.TimeUnit.DAYS;
+import static java.util.concurrent.TimeUnit.HOURS;
+import static java.util.concurrent.TimeUnit.MINUTES;
+import static java.util.concurrent.TimeUnit.SECONDS;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+
+
+
+import bisq.daemon.grpc.GrpcVersionService;
+import bisq.daemon.grpc.interceptor.GrpcServiceRateMeteringConfig;
+
+@Disabled
+@Slf4j
+@TestMethodOrder(MethodOrderer.OrderAnnotation.class)
+public class CallRateMeteringInterceptorTest extends MethodTest {
+
+    private static final GetVersionTest getVersionTest = new GetVersionTest();
+
+    @BeforeAll
+    public static void setUp() {
+        File callRateMeteringConfigFile = buildInterceptorConfigFile();
+        startSupportingApps(callRateMeteringConfigFile,
+                false,
+                false,
+                bitcoind, alicedaemon);
+    }
+
+    @BeforeEach
+    public void sleep200Milliseconds() {
+        sleep(200);
+    }
+
+    @Test
+    @Order(1)
+    public void testGetVersionCall1IsAllowed() {
+        getVersionTest.testGetVersion();
+    }
+
+    @Test
+    @Order(2)
+    public void testGetVersionCall2ShouldThrowException() {
+        Throwable exception = assertThrows(StatusRuntimeException.class, getVersionTest::testGetVersion);
+        assertEquals("PERMISSION_DENIED: the maximum allowed number of getversion calls (1/second) has been exceeded",
+                exception.getMessage());
+    }
+
+    @Test
+    @Order(3)
+    public void testGetVersionCall3ShouldThrowException() {
+        Throwable exception = assertThrows(StatusRuntimeException.class, getVersionTest::testGetVersion);
+        assertEquals("PERMISSION_DENIED: the maximum allowed number of getversion calls (1/second) has been exceeded",
+                exception.getMessage());
+    }
+
+    @Test
+    @Order(4)
+    public void testGetVersionCall4IsAllowed() {
+        sleep(1100); // Let the server's rate meter reset the call count.
+        getVersionTest.testGetVersion();
+    }
+
+    @AfterAll
+    public static void tearDown() {
+        tearDownScaffold();
+    }
+
+    public static File buildInterceptorConfigFile() {
+        GrpcServiceRateMeteringConfig.Builder builder = new GrpcServiceRateMeteringConfig.Builder();
+        builder.addCallRateMeter(GrpcVersionService.class.getSimpleName(),
+                "getVersion",
+                1,
+                SECONDS);
+        builder.addCallRateMeter(GrpcVersionService.class.getSimpleName(),
+                "shouldNotBreakAnything",
+                1000,
+                DAYS);
+        // Only GrpcVersionService is @VisibleForTesting, so we hardcode the class names.
+        builder.addCallRateMeter("GrpcOffersService",
+                "createOffer",
+                5,
+                MINUTES);
+        builder.addCallRateMeter("GrpcOffersService",
+                "takeOffer",
+                10,
+                DAYS);
+        builder.addCallRateMeter("GrpcTradesService",
+                "withdrawFunds",
+                3,
+                HOURS);
+        return builder.build();
+    }
+}