[2.0.0-SNAPSHOT]

SemaphoreRequestQueueManager improved

Author: GoodforGod

.github/workflows/gradle.yml

@@ -32,9 +32,16 @@ jobs:
         run: ./gradlew spotlessCheck
 
       - name: Test
+        if: matrix.java == '11'
         run: ./gradlew test jacocoTestReport
         env:
-          API_KEY: ${{ secrets.API_KEY }}
+          API_KEY: ${{ secrets.ETHERSCAN_API_KEY_1 }}
+
+      - name: Test
+        if: matrix.java == '17'
+        run: ./gradlew test jacocoTestReport
+        env:
+          API_KEY: ${{ secrets.ETHERSCAN_API_KEY_2 }}
 
       - name: SonarQube
         if: matrix.java == '17'

src/main/java/io/goodforgod/api/etherscan/manager/RequestQueueManager.java

@@ -12,11 +12,8 @@
  */
 public interface RequestQueueManager extends AutoCloseable {
 
-    RequestQueueManager DEFAULT = new SemaphoreRequestQueueManager(1, Duration.ofMillis(5050L),
-            Duration.ofMillis(5050L), 0);
-
-    RequestQueueManager PERSONAL = new SemaphoreRequestQueueManager(5, Duration.ofMillis(1050L),
-            Duration.ofMillis(1050L), 5);
+    RequestQueueManager DEFAULT = new SemaphoreRequestQueueManager(1, Duration.ofMillis(5005L));
+    RequestQueueManager PERSONAL = new SemaphoreRequestQueueManager(5, Duration.ofMillis(1005L));
 
     /**
      * Waits in queue for chance to take turn

src/main/java/io/goodforgod/api/etherscan/manager/impl/SemaphoreRequestQueueManager.java

@@ -21,18 +21,10 @@ public final class SemaphoreRequestQueueManager implements RequestQueueManager,
     private final long queueResetTimeInMillis;
 
     public SemaphoreRequestQueueManager(int size, Duration resetIn) {
-        this(size, resetIn, resetIn);
-    }
-
-    public SemaphoreRequestQueueManager(int size, Duration resetIn, Duration delayIn) {
-        this(size, resetIn, delayIn, size);
-    }
-
-    public SemaphoreRequestQueueManager(int size, Duration queueResetTimeIn, Duration delayIn, int initialSize) {
-        this.semaphore = new Semaphore(initialSize);
-        this.queueResetTimeInMillis = queueResetTimeIn.toMillis();
-        this.executorService.scheduleAtFixedRate(releaseLocks(size + 1),
-                delayIn.toMillis(), queueResetTimeInMillis, TimeUnit.MILLISECONDS);
+        this.semaphore = new Semaphore(0);
+        this.queueResetTimeInMillis = resetIn.toMillis();
+        this.executorService.scheduleAtFixedRate(releaseLocks(size),
+                resetIn.toMillis(), queueResetTimeInMillis, TimeUnit.MILLISECONDS);
     }
 
     @SuppressWarnings("java:S899")
@@ -46,7 +38,13 @@ public void takeTurn() {
     }
 
     private Runnable releaseLocks(int toRelease) {
-        return () -> semaphore.release(toRelease);
+        return () -> {
+            int availablePermits = semaphore.availablePermits();
+            int neededPermits = toRelease - availablePermits;
+            if (neededPermits > 0) {
+                semaphore.release(neededPermits);
+            }
+        };
     }
 
     @Override

src/test/java/io/goodforgod/api/etherscan/ApiRunner.java

@@ -1,37 +1,45 @@
 package io.goodforgod.api.etherscan;
 
 import io.goodforgod.api.etherscan.manager.RequestQueueManager;
+import java.util.Map;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.Assertions;
 
 public class ApiRunner extends Assertions {
 
     private static final String DEFAULT_KEY = "YourApiKeyToken";
 
-    private static final EtherScanAPI api;
-    private static final String apiKey;
+    private static final String API_KEY;
+    private static final EtherScanAPI API;
 
     static {
-        final String key = System.getenv("API_KEY");
-        final RequestQueueManager queueManager = RequestQueueManager.DEFAULT;
-
-        apiKey = (key == null || key.isEmpty())
-                ? DEFAULT_KEY
-                : key;
-        api = EtherScanAPI.builder().withApiKey(ApiRunner.apiKey).withNetwork(EthNetworks.MAINNET).withQueue(queueManager)
+        API_KEY = System.getenv().entrySet().stream()
+                .filter(e -> e.getKey().startsWith("ETHERSCAN_API_KEY"))
+                .map(Map.Entry::getValue)
+                .findFirst()
+                .orElse(DEFAULT_KEY);
+
+        final RequestQueueManager queueManager = (DEFAULT_KEY.equals(API_KEY))
+                ? RequestQueueManager.DEFAULT
+                : RequestQueueManager.PERSONAL;
+
+        API = EtherScanAPI.builder()
+                .withApiKey(ApiRunner.API_KEY)
+                .withNetwork(EthNetworks.MAINNET)
+                .withQueue(queueManager)
                 .build();
     }
 
     public static String getApiKey() {
-        return apiKey;
+        return API_KEY;
     }
 
     public static EtherScanAPI getApi() {
-        return api;
+        return API;
     }
 
     @AfterAll
     public static void cleanup() throws Exception {
-        api.close();
+        API.close();
     }
 }

src/test/java/io/goodforgod/api/etherscan/EtherScanAPITests.java

@@ -5,6 +5,7 @@
 import io.goodforgod.api.etherscan.http.EthHttpClient;
 import io.goodforgod.api.etherscan.http.impl.UrlEthHttpClient;
 import io.goodforgod.api.etherscan.model.Balance;
+import java.net.URI;
 import java.time.Duration;
 import java.util.concurrent.TimeUnit;
 import java.util.function.Supplier;
@@ -16,7 +17,7 @@
  */
 class EtherScanAPITests extends ApiRunner {
 
-    private final EthNetworks network = EthNetworks.KOVAN;
+    private final EthNetworks network = EthNetworks.SEPOLIA;
 
     @Test
     void validKey() {
@@ -46,14 +47,12 @@ void noTimeoutOnRead() {
 
     @Test
     void noTimeoutOnReadGroli() {
-        Supplier<EthHttpClient> supplier = () -> new UrlEthHttpClient(Duration.ofMillis(300));
         Balance balance = getApi().account().balance("0xF318ABc9A5a92357c4Fea8d082dade4D43e780B7");
         assertNotNull(balance);
     }
 
     @Test
     void noTimeoutOnReadTobalala() {
-        Supplier<EthHttpClient> supplier = () -> new UrlEthHttpClient(Duration.ofMillis(30000));
         Balance balance = getApi().account().balance("0xF318ABc9A5a92357c4Fea8d082dade4D43e780B7");
         assertNotNull(balance);
     }
@@ -68,8 +67,12 @@ void noTimeoutUnlimitedAwait() {
     void timeout() throws InterruptedException {
         TimeUnit.SECONDS.sleep(5);
         Supplier<EthHttpClient> supplier = () -> new UrlEthHttpClient(Duration.ofMillis(300), Duration.ofMillis(300));
-        EtherScanAPI api = EtherScanAPI.builder().withApiKey(getApiKey()).withNetwork(EthNetworks.KOVAN).withHttpClient(supplier)
+        EtherScanAPI api = EtherScanAPI.builder()
+                .withApiKey(getApiKey())
+                .withNetwork(() -> URI.create("https://api-unknown.etherscan.io/api"))
+                .withHttpClient(supplier)
                 .build();
+
         assertThrows(EtherScanConnectionException.class,
                 () -> api.account().blocksMined("0x0010f94b296A852aAac52EA6c5Ac72e03afD032D"));
     }

src/test/java/io/goodforgod/api/etherscan/account/AccountBalanceListTest.java renamed to src/test/java/io/goodforgod/api/etherscan/account/AccountBalanceListTests.java

@@ -13,7 +13,7 @@
  * @author GoodforGod
  * @since 03.11.2018
  */
-class AccountBalanceListTest extends ApiRunner {
+class AccountBalanceListTests extends ApiRunner {
 
     @Test
     void correct() {

src/test/java/io/goodforgod/api/etherscan/account/AccountBalanceTest.java renamed to src/test/java/io/goodforgod/api/etherscan/account/AccountBalanceTests.java

@@ -10,7 +10,7 @@
  * @author GoodforGod
  * @since 03.11.2018
  */
-class AccountBalanceTest extends ApiRunner {
+class AccountBalanceTests extends ApiRunner {
 
     private final EtherScanAPI api = getApi();
 

src/test/java/io/goodforgod/api/etherscan/account/AccountMinedBlocksTest.java renamed to src/test/java/io/goodforgod/api/etherscan/account/AccountMinedBlocksTests.java

@@ -11,7 +11,7 @@
  * @author GoodforGod
  * @since 03.11.2018
  */
-class AccountMinedBlocksTest extends ApiRunner {
+class AccountMinedBlocksTests extends ApiRunner {
 
     private final EtherScanAPI api = getApi();
 

src/test/java/io/goodforgod/api/etherscan/account/AccountTokenBalanceTest.java renamed to src/test/java/io/goodforgod/api/etherscan/account/AccountTokenBalanceTests.java

@@ -10,7 +10,7 @@
  * @author GoodforGod
  * @since 03.11.2018
  */
-class AccountTokenBalanceTest extends ApiRunner {
+class AccountTokenBalanceTests extends ApiRunner {
 
     private final EtherScanAPI api = getApi();
 

src/test/java/io/goodforgod/api/etherscan/account/AccountTxErc20Test.java renamed to src/test/java/io/goodforgod/api/etherscan/account/AccountTxErc20Tests.java

@@ -10,7 +10,7 @@
  * @author GoodforGod
  * @since 03.11.2018
  */
-class AccountTxErc20Test extends ApiRunner {
+class AccountTxErc20Tests extends ApiRunner {
 
     @Test
     void correct() {