From fb531fab30968a4b65a402c81f37e92dd5671f33 Mon Sep 17 00:00:00 2001 From: Damien Arrachequesne Date: Sun, 3 Jul 2022 22:35:00 +0200 Subject: [PATCH 1/6] fix: increase the readTimeout value of the default OkHttpClient With the previous value (10 seconds by default), a connection established with HTTP long-polling was closed if the server did not send any packet for 10 seconds (the HTTP request would timeout from the client side). It will now default to 1 minute, which is above the `pingInterval + pingTimeout` value from the server. Note: the connectTimeout and writeTimeout options are left as is (10 seconds), but you may need to increase them depending on your use case: ``` OkHttpClient client = new OkHttpClient.Builder() .connectTimeout(20, TimeUnit.SECONDS) .readTimeout(1, TimeUnit.MINUTES) .writeTimeout(1, TimeUnit.MINUTES) .build(); ``` Related: - https://github.com/socketio/socket.io-client-java/issues/491 - https://github.com/socketio/socket.io-client-java/issues/660 --- .../io/socket/engineio/client/Socket.java | 19 +++++++++++-------- .../client/transports/PollingXHR.java | 4 +--- .../engineio/client/transports/WebSocket.java | 4 +--- 3 files changed, 13 insertions(+), 14 deletions(-) diff --git a/src/main/java/io/socket/engineio/client/Socket.java b/src/main/java/io/socket/engineio/client/Socket.java index 02de6bd5..e49e1420 100644 --- a/src/main/java/io/socket/engineio/client/Socket.java +++ b/src/main/java/io/socket/engineio/client/Socket.java @@ -206,16 +206,10 @@ public Socket(Options opts) { this.callFactory = opts.callFactory != null ? opts.callFactory : defaultCallFactory; this.webSocketFactory = opts.webSocketFactory != null ? opts.webSocketFactory : defaultWebSocketFactory; if (callFactory == null) { - if (defaultOkHttpClient == null) { - defaultOkHttpClient = new OkHttpClient(); - } - callFactory = defaultOkHttpClient; + callFactory = getDefaultOkHttpClient(); } if (webSocketFactory == null) { - if (defaultOkHttpClient == null) { - defaultOkHttpClient = new OkHttpClient(); - } - webSocketFactory = defaultOkHttpClient; + webSocketFactory = getDefaultOkHttpClient(); } this.extraHeaders = opts.extraHeaders; } @@ -228,6 +222,15 @@ public static void setDefaultOkHttpCallFactory(okhttp3.Call.Factory factory) { defaultCallFactory = factory; } + private static OkHttpClient getDefaultOkHttpClient() { + if (defaultOkHttpClient == null) { + defaultOkHttpClient = new OkHttpClient.Builder() + .readTimeout(1, TimeUnit.MINUTES) // defaults to 10 seconds + .build(); + } + return defaultOkHttpClient; + } + /** * Connects the client. * diff --git a/src/main/java/io/socket/engineio/client/transports/PollingXHR.java b/src/main/java/io/socket/engineio/client/transports/PollingXHR.java index 11ec6b38..34a65eb3 100644 --- a/src/main/java/io/socket/engineio/client/transports/PollingXHR.java +++ b/src/main/java/io/socket/engineio/client/transports/PollingXHR.java @@ -2,7 +2,6 @@ import java.io.IOException; -import java.util.Arrays; import java.util.Collections; import java.util.LinkedList; import java.util.List; @@ -18,7 +17,6 @@ import okhttp3.Callback; import okhttp3.HttpUrl; import okhttp3.MediaType; -import okhttp3.OkHttpClient; import okhttp3.RequestBody; import okhttp3.Response; import okhttp3.ResponseBody; @@ -160,7 +158,7 @@ public Request(Options opts) { this.method = opts.method != null ? opts.method : "GET"; this.uri = opts.uri; this.data = opts.data; - this.callFactory = opts.callFactory != null ? opts.callFactory : new OkHttpClient(); + this.callFactory = opts.callFactory; this.extraHeaders = opts.extraHeaders; } diff --git a/src/main/java/io/socket/engineio/client/transports/WebSocket.java b/src/main/java/io/socket/engineio/client/transports/WebSocket.java index c2153c35..0c4c223b 100644 --- a/src/main/java/io/socket/engineio/client/transports/WebSocket.java +++ b/src/main/java/io/socket/engineio/client/transports/WebSocket.java @@ -7,7 +7,6 @@ import io.socket.parseqs.ParseQS; import io.socket.thread.EventThread; import io.socket.yeast.Yeast; -import okhttp3.OkHttpClient; import okhttp3.Request; import okhttp3.Response; import okhttp3.WebSocketListener; @@ -41,7 +40,6 @@ protected void doOpen() { this.emit(EVENT_REQUEST_HEADERS, headers); final WebSocket self = this; - okhttp3.WebSocket.Factory factory = webSocketFactory != null ? webSocketFactory : new OkHttpClient(); Request.Builder builder = new Request.Builder().url(uri()); for (Map.Entry> entry : headers.entrySet()) { for (String v : entry.getValue()) { @@ -49,7 +47,7 @@ protected void doOpen() { } } final Request request = builder.build(); - ws = factory.newWebSocket(request, new WebSocketListener() { + ws = webSocketFactory.newWebSocket(request, new WebSocketListener() { @Override public void onOpen(okhttp3.WebSocket webSocket, Response response) { final Map> headers = response.headers().toMultimap(); From 246993387dfefd22e7945c29a9b60c4a08c337c7 Mon Sep 17 00:00:00 2001 From: Damien Arrachequesne Date: Sun, 10 Jul 2022 08:55:50 +0200 Subject: [PATCH 2/6] chore(release): prepare release engine.io-client-2.1.0 --- History.md | 13 +++++++++++++ README.md | 4 ++-- pom.xml | 4 ++-- src/site/markdown/installation.md | 4 ++-- 4 files changed, 19 insertions(+), 6 deletions(-) diff --git a/History.md b/History.md index 6adbf3cf..2336a66c 100644 --- a/History.md +++ b/History.md @@ -1,4 +1,17 @@ +2.1.0 / 2022-07-10 +================== + +### Features + +* create heartbeat scheduler with named threads and as daemon ([#106](https://github.com/socketio/engine.io-client-java/issues/106)) ([7c9c382](https://github.com/socketio/engine.io-client-java/commit/7c9c382505f7411544add5a68fa326df3b82d2c1)) + +### Bug Fixes + +* increase the readTimeout value of the default OkHttpClient ([fb531fa](https://github.com/socketio/engine.io-client-java/commit/fb531fab30968a4b65a402c81f37e92dd5671f33)) + + + 2.0.0 / 2020-12-11 ================== diff --git a/README.md b/README.md index 643fbdc4..9875d3ab 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ Add the following dependency to your `pom.xml`. io.socket engine.io-client - 2.0.0 + 2.1.0 ``` @@ -44,7 +44,7 @@ Add the following dependency to your `pom.xml`. Add it as a gradle dependency for Android Studio, in `build.gradle`: ```groovy -compile ('io.socket:engine.io-client:2.0.0') { +compile ('io.socket:engine.io-client:2.1.0') { // excluding org.json which is provided by Android exclude group: 'org.json', module: 'json' } diff --git a/pom.xml b/pom.xml index 3e9e3c97..d0fffef6 100644 --- a/pom.xml +++ b/pom.xml @@ -2,7 +2,7 @@ 4.0.0 io.socket engine.io-client - 2.0.1-SNAPSHOT + 2.1.0 jar engine.io-client Engine.IO Client Library for Java @@ -30,7 +30,7 @@ https://github.com/socketio/engine.io-client-java scm:git:https://github.com/socketio/engine.io-client-java.git scm:git:https://github.com/socketio/engine.io-client-java.git - HEAD + engine.io-client-2.1.0 diff --git a/src/site/markdown/installation.md b/src/site/markdown/installation.md index 8b6f845a..3513b78e 100644 --- a/src/site/markdown/installation.md +++ b/src/site/markdown/installation.md @@ -17,7 +17,7 @@ Add the following dependency to your `pom.xml`. io.socket engine.io-client - 2.0.0 + 2.1.0 ``` @@ -26,7 +26,7 @@ Add the following dependency to your `pom.xml`. Add it as a gradle dependency for Android Studio, in `build.gradle`: ```groovy -compile ('io.socket:engine.io-client:2.0.0') { +compile ('io.socket:engine.io-client:2.1.0') { // excluding org.json which is provided by Android exclude group: 'org.json', module: 'json' } From 592859d6b129ad41b74d202cc079b8ce6f890c02 Mon Sep 17 00:00:00 2001 From: Damien Arrachequesne Date: Sun, 10 Jul 2022 09:05:36 +0200 Subject: [PATCH 3/6] chore(release): prepare for next development iteration --- pom.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pom.xml b/pom.xml index d0fffef6..46fff7a0 100644 --- a/pom.xml +++ b/pom.xml @@ -2,7 +2,7 @@ 4.0.0 io.socket engine.io-client - 2.1.0 + 2.1.1-SNAPSHOT jar engine.io-client Engine.IO Client Library for Java @@ -30,7 +30,7 @@ https://github.com/socketio/engine.io-client-java scm:git:https://github.com/socketio/engine.io-client-java.git scm:git:https://github.com/socketio/engine.io-client-java.git - engine.io-client-2.1.0 + HEAD From 8519952a51baff36a2844d726876266b37ad6ffe Mon Sep 17 00:00:00 2001 From: Damien Arrachequesne Date: Sun, 10 Jul 2022 09:50:07 +0200 Subject: [PATCH 4/6] docs: add changelog for version 1.0.2 --- History.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/History.md b/History.md index 2336a66c..fefc5946 100644 --- a/History.md +++ b/History.md @@ -1,4 +1,16 @@ +1.0.2 / 2022-07-10 +================== + +From the "1.x" branch. + +### Bug Fixes + +* check the type of the initial packet ([319f2e2](https://github.com/socketio/engine.io-client-java/commit/319f2e21bedced2866790671b3ae9ae7b0fabb82)) +* increase the readTimeout value of the default OkHttpClient ([2d87497](https://github.com/socketio/engine.io-client-java/commit/2d874971c2428a7a444b3a33afe66aedcdce3a96)) + + + 2.1.0 / 2022-07-10 ================== From 050dd2653a6c510e91679897c39ad849ee5f0132 Mon Sep 17 00:00:00 2001 From: Damien Arrachequesne Date: Tue, 18 Feb 2025 22:30:05 +0100 Subject: [PATCH 5/6] ci: fix java 7 build Maven has been upgraded from 3.8 to 3.9, which is not compatible with JDK 7. See also: https://github.com/actions/runner-images/issues/11093 --- .github/workflows/ci.yml | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 439755f9..415e673b 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -11,24 +11,38 @@ jobs: runs-on: ubuntu-latest strategy: + fail-fast: false matrix: java: [7, 8, 11] steps: - uses: actions/checkout@v2 + + - name: Install Maven 3.8.x (instead of 3.9.x) + run: | + MAVEN_VERSION=3.8.8 + wget https://downloads.apache.org/maven/maven-3/$MAVEN_VERSION/binaries/apache-maven-$MAVEN_VERSION-bin.tar.gz + tar xzvf apache-maven-$MAVEN_VERSION-bin.tar.gz + sudo mv apache-maven-$MAVEN_VERSION /opt/maven + sudo rm -f /usr/bin/mvn # Remove existing symbolic link if it exists + sudo ln -s /opt/maven/bin/mvn /usr/bin/mvn # Create new symbolic link + - name: Setup java uses: actions/setup-java@v1 with: java-version: ${{ matrix.java }} + - name: Cache Maven packages - uses: actions/cache@v2 + uses: actions/cache@v4 with: path: ~/.m2 key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }} restore-keys: ${{ runner.os }}-m2 + - name: Setup Node.js uses: actions/setup-node@v1 with: node-version: 14.x + - name: Run the Maven verify phase run: mvn verify -Dgpg.skip=true From 5d02ea0cedb8ed8e959fa839b5609e5bb0c809e2 Mon Sep 17 00:00:00 2001 From: Damien Arrachequesne Date: Mon, 11 Aug 2025 09:20:10 +0200 Subject: [PATCH 6/6] ci: upgrade maven to version 3.8.9 Previous version is no longer available at [1]. [1]: https://dlcdn.apache.org/maven/maven-3/ --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 415e673b..1c4a623f 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -20,7 +20,7 @@ jobs: - name: Install Maven 3.8.x (instead of 3.9.x) run: | - MAVEN_VERSION=3.8.8 + MAVEN_VERSION=3.8.9 wget https://downloads.apache.org/maven/maven-3/$MAVEN_VERSION/binaries/apache-maven-$MAVEN_VERSION-bin.tar.gz tar xzvf apache-maven-$MAVEN_VERSION-bin.tar.gz sudo mv apache-maven-$MAVEN_VERSION /opt/maven