fix: replace guava ratelimiter by my own rate limiter

Author: florianepitech

pom.xml

@@ -21,18 +21,23 @@
             <artifactId>httpclient</artifactId>
             <version>4.5.13</version>
         </dependency>
-        <!-- Google Guava -->
-        <dependency>
-            <groupId>com.google.guava</groupId>
-            <artifactId>guava</artifactId>
-            <version>20.0</version>
-        </dependency>
         <!-- Json -->
         <dependency>
             <groupId>org.json</groupId>
             <artifactId>json</artifactId>
             <version>20220320</version>
         </dependency>
+        <dependency>
+            <groupId>org.jetbrains</groupId>
+            <artifactId>annotations</artifactId>
+            <version>23.0.0</version>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <version>RELEASE</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
     <properties>

src/main/java/net/httpclient/wrapper/Test.java

@@ -0,0 +1,42 @@
+package net.httpclient.wrapper;
+
+import net.httpclient.wrapper.events.HttpClientSessionEvent;
+import net.httpclient.wrapper.events.HttpClientSessionListener;
+import net.httpclient.wrapper.exception.HttpClientException;
+import net.httpclient.wrapper.exception.HttpServerException;
+import net.httpclient.wrapper.response.RequestResponse;
+import net.httpclient.wrapper.session.HttpClientSession;
+import net.httpclient.wrapper.utils.BasicCookieStoreSerializerUtils;
+import org.apache.http.impl.client.BasicCookieStore;
+
+import java.io.IOException;
+
+public class Test implements HttpClientSessionListener {
+
+    public static void main(String[] args) throws HttpClientException, IOException, HttpServerException {
+        System.out.println("Hello World!");
+        HttpClientSessionEvent.addHttpClientSessionListener(new Test());
+
+
+        HttpClientSession httpClientSession = new HttpClientSession();
+        RequestResponse requestResponse = httpClientSession.sendGet("https://lincos.tools/content/11-cookie");
+        System.out.println(requestResponse.getStatusCode());
+        System.out.println(BasicCookieStoreSerializerUtils.serializableToBase64(httpClientSession.getHttpCookieStore()));
+        requestResponse = httpClientSession.sendGet("https://www.nautiljon.com/");
+        System.out.println(requestResponse.getStatusCode());
+        System.out.println(BasicCookieStoreSerializerUtils.serializableToBase64(httpClientSession.getHttpCookieStore()));
+        System.out.println("Finished !\n");
+
+        // print all cookies
+        for (org.apache.http.cookie.Cookie cookie : httpClientSession.getHttpCookieStore().getCookies()) {
+            System.out.println(cookie.getDomain() + " : " + cookie.getPath());
+            System.out.println("\t => " + cookie.getName() + " : " + cookie.getValue());
+        }
+
+    }
+
+    @Override
+    public void onHttpClientCookiesUpdated(HttpClientSession httpClientSession) {
+        System.out.println("Cookies updated");
+    }
+}

src/main/java/net/httpclient/wrapper/events/HttpClientSessionEvent.java

@@ -3,6 +3,7 @@
 import net.httpclient.wrapper.session.HttpClientSession;
 
 import java.util.ArrayList;
+import java.util.List;
 
 /**
  * This static class manage the HttpClientSession events.
@@ -20,15 +21,19 @@ public class HttpClientSessionEvent {
      * @param listener The listener to add.
      */
     public static void addHttpClientSessionListener(HttpClientSessionListener listener) {
-        httpClientSessionBasics.add(listener);
+        synchronized (httpClientSessionBasics) {
+            httpClientSessionBasics.add(listener);
+        }
     }
 
     /**
      * Remove a listener from the list of listeners.
      * @param listener The listener to remove.
      */
     public static void removeHttpClientSessionListener(HttpClientSessionListener listener) {
-        httpClientSessionBasics.remove(listener);
+        synchronized (httpClientSessionBasics) {
+            httpClientSessionBasics.remove(listener);
+        }
     }
 
     /*
@@ -40,8 +45,24 @@ public static void removeHttpClientSessionListener(HttpClientSessionListener lis
      * @param httpClientSession The HttpClientSession who has updated his cookies.
      */
     public static void triggerHttpClientCookiesUpdated(HttpClientSession httpClientSession) {
-        httpClientSessionBasics.forEach(listener -> listener.onHttpClientCookiesUpdated(httpClientSession));
+        synchronized (httpClientSessionBasics) {
+            httpClientSessionBasics.forEach(listener -> listener.onHttpClientCookiesUpdated(httpClientSession));
+        }
     }
 
 
+    /*
+     $      Getters
+     */
+
+    /**
+     * This method return a list copy of the listeners.
+     * @return A list copy of the listeners.
+     */
+    public static List<HttpClientSessionListener> getHttpClientSessionListeners() {
+        synchronized (httpClientSessionBasics) {
+            return new ArrayList<>(httpClientSessionBasics);
+        }
+    }
+
 }

src/main/java/net/httpclient/wrapper/ratelimiter/RateLimiter.java

@@ -0,0 +1,86 @@
+package net.httpclient.wrapper.ratelimiter;
+
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.time.Duration;
+import java.time.Instant;
+
+public class RateLimiter {
+
+    private Duration duration;
+    private Instant lastAcquire;
+
+    /*
+     $      Constructor
+     */
+
+    /**
+     * Create a rate limiter with a duration.
+     * @param duration The duration between each acquire.
+     */
+    public RateLimiter(@NotNull Duration duration) {
+        this.duration = duration;
+    }
+
+    /**
+     * Sleep until the duration is passed.
+     */
+    public void acquire() {
+        synchronized (this) {
+            try {
+                dangerousAcquire();
+            } catch (InterruptedException e) {
+                e.printStackTrace();
+            }
+        }
+    }
+
+    public void dangerousAcquire() throws InterruptedException {
+        synchronized (this) {
+            if (lastAcquire == null) {
+                lastAcquire = Instant.now();
+                return;
+            }
+            Duration durationToSleep = getRemainingTime();
+            if (durationToSleep.isZero()) Thread.sleep(durationToSleep.toMillis());
+            lastAcquire = Instant.now();
+        }
+    }
+
+    /**
+     * Reset the rate limiter.
+     */
+    public void reset() {
+        lastAcquire = null;
+    }
+
+    /**
+     * Get the remaining time before the next acquire.
+     * @return The remaining time in milliseconds.
+     */
+    public @NotNull Duration getRemainingTime() {
+        if (lastAcquire == null) return Duration.ZERO;
+        long lastRequest = lastAcquire.toEpochMilli();
+        long now = Instant.now().toEpochMilli();
+        long result = lastRequest + duration.toMillis() - now;
+        return (result > 0) ? Duration.ofMillis(result) : Duration.ZERO;
+    }
+
+    /*
+     $      Getters
+     */
+
+    public @NotNull Duration getDuration() {
+        return duration;
+    }
+
+    public @Nullable Instant getLastAcquire() {
+        return lastAcquire;
+    }
+
+    public void setDuration(@NotNull Duration duration) {
+        this.duration = duration;
+    }
+
+}

src/main/java/net/httpclient/wrapper/response/RequestResponse.java

@@ -57,11 +57,19 @@ public String getRawResponse() {
     }
 
     public JSONObject toJSONObject() {
-        return (new JSONObject(rawResponse));
+        try {
+            return (new JSONObject(rawResponse));
+        } catch (Exception e) {
+            return (null);
+        }
     }
 
     public JSONArray toJSONArray() {
-        return (new JSONArray(rawResponse));
+        try {
+            return (new JSONArray(rawResponse));
+        } catch (Exception e) {
+            return (null);
+        }
     }
 
     public long getTime() {

src/main/java/net/httpclient/wrapper/session/HttpClientSession.java

@@ -54,6 +54,7 @@ public class HttpClientSession {
     protected final BasicCookieStore httpCookieStore = new BasicCookieStore();
     protected RequestConfig.Builder requestConfig;
     protected String userAgent = RandomUserAgent.getRandomUserAgent();
+    protected Object metadata = null;
 
     private final long TIMEOUT = TimeUnit.MILLISECONDS.convert(10, TimeUnit.SECONDS);
 
@@ -227,6 +228,8 @@ else if (statusCode >= 400 && statusCode <= 499)
      * @param serializedOldCookieStore The old cookie store before the request serialized as string.
      */
     private void verifyCookiesEvents(String serializedOldCookieStore) {
+        if (HttpClientSessionEvent.getHttpClientSessionListeners().size() == 0)
+            return;
         try {
             String serializedNewCookieStore = BasicCookieStoreSerializerUtils.serializableToBase64(httpCookieStore);
             if (!serializedOldCookieStore.equals(serializedNewCookieStore))
@@ -289,4 +292,11 @@ public void setUserAgent(String userAgent) {
         this.userAgent = userAgent;
     }
 
+    public Object getMetadata() {
+        return metadata;
+    }
+
+    public void setMetadata(Object metadata) {
+        this.metadata = metadata;
+    }
 }

src/main/java/net/httpclient/wrapper/session/HttpClientSessionRateLimited.java

@@ -1,13 +1,14 @@
 package net.httpclient.wrapper.session;
 
-import com.google.common.util.concurrent.RateLimiter;
 import net.httpclient.wrapper.exception.HttpClientException;
 import net.httpclient.wrapper.exception.HttpServerException;
+import net.httpclient.wrapper.ratelimiter.RateLimiter;
 import net.httpclient.wrapper.response.RequestResponse;
 import org.apache.http.NameValuePair;
 import org.apache.http.entity.ContentType;
 
 import java.io.IOException;
+import java.time.Duration;
 import java.util.List;
 
 public class HttpClientSessionRateLimited extends HttpClientSession {
@@ -20,7 +21,7 @@ public HttpClientSessionRateLimited() {
 
     public HttpClientSessionRateLimited(double permitsPerSecond) {
         super();
-        rateLimiter = RateLimiter.create(permitsPerSecond);
+        rateLimiter = new RateLimiter(Duration.ofSeconds((int)permitsPerSecond));
     }
 
     @Override

src/test/java/net/httpclient/wrapper/ratelimiter/RateLimiterTest.java

@@ -0,0 +1,35 @@
+package net.httpclient.wrapper.ratelimiter;
+
+import org.junit.jupiter.api.Test;
+
+import java.time.Duration;
+import java.time.Instant;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+class RateLimiterTest {
+
+    @Test
+    public void constructTest() {
+        assertThrows(IllegalArgumentException.class, () -> new RateLimiter(null));
+        assertDoesNotThrow(() -> new RateLimiter(Duration.ofSeconds(1)));
+    }
+
+    @Test
+    public void acquireTest() {
+        RateLimiter rateLimiter = new RateLimiter(Duration.ofSeconds(1));
+        assertDoesNotThrow(() -> rateLimiter.acquire());
+        assertDoesNotThrow(() -> rateLimiter.acquire());
+    }
+
+    @Test
+    public void getRemainingTimeTest() throws InterruptedException {
+        int durationInSeconds = 3;
+        RateLimiter rateLimiter = new RateLimiter(Duration.ofSeconds(durationInSeconds));
+        rateLimiter.acquire();
+        assertEquals(durationInSeconds, rateLimiter.getRemainingTime().toSeconds());
+        rateLimiter.reset();
+        assertEquals(Duration.ZERO, rateLimiter.getRemainingTime());
+    }
+
+}