diff --git a/History.md b/History.md index f11dc8f8..be07a7ca 100644 --- a/History.md +++ b/History.md @@ -1,4 +1,19 @@ +1.0.2 / 2022-07-11 +================== + +From the "1.x" branch. + +### Bug Fixes + +* ensure buffered events are sent in order ([8bd35da](https://github.com/socketio/socket.io-client-java/commit/8bd35da19c1314318fe122876d22e30ae3673ff9)) +* ensure randomizationFactor is always between 0 and 1 ([cb966d5](https://github.com/socketio/socket.io-client-java/commit/cb966d5a64790c0584ad97cf55c205cae8bd1287)) +* ensure the payload format is valid ([8664499](https://github.com/socketio/socket.io-client-java/commit/8664499b6f31154f49783531f778dac5387b766b)) +* fix usage with ws:// scheme ([e57160a](https://github.com/socketio/socket.io-client-java/commit/e57160a00ca1fbb38396effdbc87eb10d6759a51)) +* increase the readTimeout value of the default OkHttpClient ([2d87497](https://github.com/socketio/engine.io-client-java/commit/2d874971c2428a7a444b3a33afe66aedcdce3a96)) (from `engine.io-client`) + + + 1.0.1 / 2020-12-10 ================== diff --git a/README.md b/README.md index 5b7af7d6..50efc96a 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,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:socket.io-client:1.0.1') { +compile ('io.socket:socket.io-client:1.0.2') { // excluding org.json which is provided by Android exclude group: 'org.json', module: 'json' } diff --git a/pom.xml b/pom.xml index 4a3d2e3e..ace14ef2 100644 --- a/pom.xml +++ b/pom.xml @@ -2,7 +2,7 @@ 4.0.0 io.socket socket.io-client - 1.0.2-SNAPSHOT + 1.0.3-SNAPSHOT jar socket.io-client Socket.IO Client Library for Java @@ -62,7 +62,7 @@ io.socket engine.io-client - 1.0.1 + 1.0.2 org.json diff --git a/src/main/java/io/socket/backo/Backoff.java b/src/main/java/io/socket/backo/Backoff.java index f5199213..81e1dddd 100644 --- a/src/main/java/io/socket/backo/Backoff.java +++ b/src/main/java/io/socket/backo/Backoff.java @@ -3,6 +3,9 @@ import java.math.BigDecimal; import java.math.BigInteger; +/** + * Imported from https://github.com/mokesmokes/backo + */ public class Backoff { private long ms = 100; @@ -23,7 +26,10 @@ public long duration() { .multiply(new BigDecimal(ms)).toBigInteger(); ms = (((int) Math.floor(rand * 10)) & 1) == 0 ? ms.subtract(deviation) : ms.add(deviation); } - return ms.min(BigInteger.valueOf(this.max)).longValue(); + return ms + .min(BigInteger.valueOf(this.max)) + .max(BigInteger.valueOf(this.ms)) + .longValue(); } public void reset() { @@ -46,6 +52,10 @@ public Backoff setFactor(int factor) { } public Backoff setJitter(double jitter) { + boolean isValid = jitter >= 0 && jitter < 1; + if (!isValid) { + throw new IllegalArgumentException("jitter must be between 0 and 1"); + } this.jitter = jitter; return this; } diff --git a/src/main/java/io/socket/client/IO.java b/src/main/java/io/socket/client/IO.java index a5455f48..69637ec5 100644 --- a/src/main/java/io/socket/client/IO.java +++ b/src/main/java/io/socket/client/IO.java @@ -7,7 +7,6 @@ import java.net.URI; import java.net.URISyntaxException; -import java.net.URL; import java.util.concurrent.ConcurrentHashMap; import java.util.logging.Level; import java.util.logging.Logger; @@ -58,17 +57,12 @@ public static Socket socket(URI uri, Options opts) { opts = new Options(); } - URL parsed = Url.parse(uri); - URI source; - try { - source = parsed.toURI(); - } catch (URISyntaxException e) { - throw new RuntimeException(e); - } - String id = Url.extractId(parsed); - String path = parsed.getPath(); + Url.ParsedURI parsed = Url.parse(uri); + URI source = parsed.uri; + String id = parsed.id; + boolean sameNamespace = managers.containsKey(id) - && managers.get(id).nsps.containsKey(path); + && managers.get(id).nsps.containsKey(source.getPath()); boolean newConnection = opts.forceNew || !opts.multiplex || sameNamespace; Manager io; @@ -87,12 +81,12 @@ public static Socket socket(URI uri, Options opts) { io = managers.get(id); } - String query = parsed.getQuery(); + String query = source.getQuery(); if (query != null && (opts.query == null || opts.query.isEmpty())) { opts.query = query; } - return io.socket(parsed.getPath(), opts); + return io.socket(source.getPath(), opts); } diff --git a/src/main/java/io/socket/client/Manager.java b/src/main/java/io/socket/client/Manager.java index 1058b067..cac32bf7 100644 --- a/src/main/java/io/socket/client/Manager.java +++ b/src/main/java/io/socket/client/Manager.java @@ -2,6 +2,7 @@ import io.socket.backo.Backoff; import io.socket.emitter.Emitter; +import io.socket.parser.DecodingException; import io.socket.parser.IOParser; import io.socket.parser.Packet; import io.socket.parser.Parser; @@ -370,10 +371,14 @@ private void onopen() { @Override public void call(Object... objects) { Object data = objects[0]; - if (data instanceof String) { - Manager.this.ondata((String)data); - } else if (data instanceof byte[]) { - Manager.this.ondata((byte[])data); + try { + if (data instanceof String) { + Manager.this.decoder.add((String) data); + } else if (data instanceof byte[]) { + Manager.this.decoder.add((byte[]) data); + } + } catch (DecodingException e) { + logger.fine("error while decoding the packet: " + e.getMessage()); } } })); @@ -419,14 +424,6 @@ private void onpong() { null != this.lastPing ? new Date().getTime() - this.lastPing.getTime() : 0); } - private void ondata(String data) { - this.decoder.add(data); - } - - private void ondata(byte[] data) { - this.decoder.add(data); - } - private void ondecoded(Packet packet) { this.emit(EVENT_PACKET, packet); } diff --git a/src/main/java/io/socket/client/Socket.java b/src/main/java/io/socket/client/Socket.java index 369d6244..71ad6f01 100644 --- a/src/main/java/io/socket/client/Socket.java +++ b/src/main/java/io/socket/client/Socket.java @@ -386,8 +386,8 @@ private void onack(Packet packet) { private void onconnect() { this.connected = true; - this.emit(EVENT_CONNECT); this.emitBuffered(); + super.emit(EVENT_CONNECT); } private void emitBuffered() { diff --git a/src/main/java/io/socket/client/Url.java b/src/main/java/io/socket/client/Url.java index c9185d29..451eee8b 100644 --- a/src/main/java/io/socket/client/Url.java +++ b/src/main/java/io/socket/client/Url.java @@ -1,16 +1,11 @@ package io.socket.client; -import java.net.MalformedURLException; import java.net.URI; -import java.net.URISyntaxException; -import java.net.URL; -import java.util.regex.Pattern; import java.util.regex.Matcher; +import java.util.regex.Pattern; public class Url { - private static Pattern PATTERN_HTTP = Pattern.compile("^http|ws$"); - private static Pattern PATTERN_HTTPS = Pattern.compile("^(http|ws)s$"); /** * Expected format: "[id:password@]host[:port]" */ @@ -18,11 +13,17 @@ public class Url { private Url() {} - public static URL parse(String uri) throws URISyntaxException { - return parse(new URI(uri)); + static class ParsedURI { + public final URI uri; + public final String id; + + public ParsedURI(URI uri, String id) { + this.uri = uri; + this.id = id; + } } - public static URL parse(URI uri) { + public static ParsedURI parse(URI uri) { String protocol = uri.getScheme(); if (protocol == null || !protocol.matches("^https?|wss?$")) { protocol = "https"; @@ -30,9 +31,9 @@ public static URL parse(URI uri) { int port = uri.getPort(); if (port == -1) { - if (PATTERN_HTTP.matcher(protocol).matches()) { + if ("http".equals(protocol) || "ws".equals(protocol)) { port = 80; - } else if (PATTERN_HTTPS.matcher(protocol).matches()) { + } else if ("https".equals(protocol) || "wss".equals(protocol)) { port = 443; } } @@ -50,35 +51,18 @@ public static URL parse(URI uri) { // might happen on some of Samsung Devices such as S4. _host = extractHostFromAuthorityPart(uri.getRawAuthority()); } - try { - return new URL(protocol + "://" - + (userInfo != null ? userInfo + "@" : "") - + _host - + (port != -1 ? ":" + port : "") - + path - + (query != null ? "?" + query : "") - + (fragment != null ? "#" + fragment : "")); - } catch (MalformedURLException e) { - throw new RuntimeException(e); - } - } - - public static String extractId(String url) throws MalformedURLException { - return extractId(new URL(url)); + URI completeUri = URI.create(protocol + "://" + + (userInfo != null ? userInfo + "@" : "") + + _host + + (port != -1 ? ":" + port : "") + + path + + (query != null ? "?" + query : "") + + (fragment != null ? "#" + fragment : "")); + String id = protocol + "://" + _host + ":" + port; + + return new ParsedURI(completeUri, id); } - public static String extractId(URL url) { - String protocol = url.getProtocol(); - int port = url.getPort(); - if (port == -1) { - if (PATTERN_HTTP.matcher(protocol).matches()) { - port = 80; - } else if (PATTERN_HTTPS.matcher(protocol).matches()) { - port = 443; - } - } - return protocol + "://" + url.getHost() + ":" + port; - } private static String extractHostFromAuthorityPart(String authority) { diff --git a/src/main/java/io/socket/parser/DecodingException.java b/src/main/java/io/socket/parser/DecodingException.java new file mode 100644 index 00000000..04dc0448 --- /dev/null +++ b/src/main/java/io/socket/parser/DecodingException.java @@ -0,0 +1,7 @@ +package io.socket.parser; + +public class DecodingException extends RuntimeException { + public DecodingException(String message) { + super(message); + } +} diff --git a/src/main/java/io/socket/parser/IOParser.java b/src/main/java/io/socket/parser/IOParser.java index 813c16ca..32c6b49d 100644 --- a/src/main/java/io/socket/parser/IOParser.java +++ b/src/main/java/io/socket/parser/IOParser.java @@ -1,7 +1,9 @@ package io.socket.parser; import io.socket.hasbinary.HasBinary; +import org.json.JSONArray; import org.json.JSONException; +import org.json.JSONObject; import org.json.JSONTokener; import java.util.ArrayList; @@ -14,10 +16,6 @@ final public class IOParser implements Parser { private static final Logger logger = Logger.getLogger(IOParser.class.getName()); - private static Packet error() { - return new Packet(ERROR, "parser error"); - } - private IOParser() {} final public static class Encoder implements Parser.Encoder { @@ -126,12 +124,16 @@ private static Packet decodeString(String str) { int i = 0; int length = str.length(); - Packet p = new Packet(Character.getNumericValue(str.charAt(0))); + Packet p = new Packet<>(Character.getNumericValue(str.charAt(0))); - if (p.type < 0 || p.type > types.length - 1) return error(); + if (p.type < 0 || p.type > types.length - 1) { + throw new DecodingException("unknown packet type " + p.type); + } if (BINARY_EVENT == p.type || BINARY_ACK == p.type) { - if (!str.contains("-") || length <= i + 1) return error(); + if (!str.contains("-") || length <= i + 1) { + throw new DecodingException("illegal attachments"); + } StringBuilder attachments = new StringBuilder(); while (str.charAt(++i) != '-') { attachments.append(str.charAt(i)); @@ -170,7 +172,7 @@ private static Packet decodeString(String str) { try { p.id = Integer.parseInt(id.toString()); } catch (NumberFormatException e){ - return error(); + throw new DecodingException("invalid payload"); } } } @@ -181,7 +183,10 @@ private static Packet decodeString(String str) { p.data = new JSONTokener(str.substring(i)).nextValue(); } catch (JSONException e) { logger.log(Level.WARNING, "An error occured while retrieving data from JSONTokener", e); - return error(); + throw new DecodingException("invalid payload"); + } + if (!isPayloadValid(p.type, p.data)) { + throw new DecodingException("invalid payload"); } } @@ -191,6 +196,27 @@ private static Packet decodeString(String str) { return p; } + private static boolean isPayloadValid(int type, Object payload) { + switch (type) { + case Parser.CONNECT: + return payload instanceof JSONObject; + case Parser.ERROR: + return payload instanceof String; + case Parser.DISCONNECT: + return payload == null; + case Parser.EVENT: + case Parser.BINARY_EVENT: + return payload instanceof JSONArray + && ((JSONArray) payload).length() > 0 + && !((JSONArray) payload).isNull(0); + case Parser.ACK: + case Parser.BINARY_ACK: + return payload instanceof JSONArray; + default: + return false; + } + } + @Override public void destroy() { if (this.reconstructor != null) { diff --git a/src/test/java/io/socket/backo/BackoffTest.java b/src/test/java/io/socket/backo/BackoffTest.java index a268829f..8ae61de4 100644 --- a/src/test/java/io/socket/backo/BackoffTest.java +++ b/src/test/java/io/socket/backo/BackoffTest.java @@ -44,4 +44,10 @@ public void durationOverflow() { } } } + + @Test(expected = IllegalArgumentException.class) + public void ensureJitterIsValid() { + Backoff b = new Backoff(); + b.setJitter(2); + } } diff --git a/src/test/java/io/socket/client/SocketTest.java b/src/test/java/io/socket/client/SocketTest.java index a50c338b..19b9ffc6 100644 --- a/src/test/java/io/socket/client/SocketTest.java +++ b/src/test/java/io/socket/client/SocketTest.java @@ -233,4 +233,34 @@ public void call(Object... args) { socket.disconnect(); } + + @Test(timeout = TIMEOUT) + public void shouldEmitEventsInOrder() throws InterruptedException, URISyntaxException { + final BlockingQueue values = new LinkedBlockingQueue<>(); + + socket = client(); + + socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() { + @Override + public void call(Object... objects) { + socket.emit("ack", "second", new Ack() { + @Override + public void call(Object... args) { + values.offer((String) args[0]); + } + }); + } + }); + + socket.emit("ack", "first", new Ack() { + @Override + public void call(Object... args) { + values.offer((String) args[0]); + } + }); + + socket.connect(); + assertThat(values.take(), is("first")); + assertThat(values.take(), is("second")); + } } diff --git a/src/test/java/io/socket/client/UrlTest.java b/src/test/java/io/socket/client/UrlTest.java index fbcf42de..47a1a0c1 100644 --- a/src/test/java/io/socket/client/UrlTest.java +++ b/src/test/java/io/socket/client/UrlTest.java @@ -4,9 +4,7 @@ import org.junit.runner.RunWith; import org.junit.runners.JUnit4; -import java.net.MalformedURLException; -import java.net.URISyntaxException; -import java.net.URL; +import java.net.URI; import static org.hamcrest.CoreMatchers.is; import static org.hamcrest.CoreMatchers.not; @@ -15,58 +13,85 @@ @RunWith(JUnit4.class) public class UrlTest { + private URI parse(String uri) { + return Url.parse(URI.create(uri)).uri; + } + + private String extractId(String uri) { + return Url.parse(URI.create(uri)).id; + } + @Test - public void parse() throws URISyntaxException { - assertThat(Url.parse("http://username:password@host:8080/directory/file?query#ref").toString(), + public void parse() { + assertThat(parse("http://username:password@host:8080/directory/file?query#ref").toString(), is("http://username:password@host:8080/directory/file?query#ref")); } @Test - public void parseRelativePath() throws URISyntaxException { - URL url = Url.parse("https://woot.com/test"); - assertThat(url.getProtocol(), is("https")); - assertThat(url.getHost(), is("woot.com")); - assertThat(url.getPath(), is("/test")); + public void parseRelativePath() { + URI uri = parse("https://woot.com/test"); + assertThat(uri.getScheme(), is("https")); + assertThat(uri.getHost(), is("woot.com")); + assertThat(uri.getPath(), is("/test")); } @Test - public void parseNoProtocol() throws URISyntaxException { - URL url = Url.parse("//localhost:3000"); - assertThat(url.getProtocol(), is("https")); - assertThat(url.getHost(), is("localhost")); - assertThat(url.getPort(), is(3000)); + public void parseNoProtocol() { + URI uri = parse("//localhost:3000"); + assertThat(uri.getScheme(), is("https")); + assertThat(uri.getHost(), is("localhost")); + assertThat(uri.getPort(), is(3000)); } @Test - public void parseNamespace() throws URISyntaxException { - assertThat(Url.parse("http://woot.com/woot").getPath(), is("/woot")); - assertThat(Url.parse("http://google.com").getPath(), is("/")); - assertThat(Url.parse("http://google.com/").getPath(), is("/")); + public void parseNamespace() { + assertThat(parse("http://woot.com/woot").getPath(), is("/woot")); + assertThat(parse("http://google.com").getPath(), is("/")); + assertThat(parse("http://google.com/").getPath(), is("/")); } @Test - public void parseDefaultPort() throws URISyntaxException { - assertThat(Url.parse("http://google.com/").toString(), is("http://google.com:80/")); - assertThat(Url.parse("https://google.com/").toString(), is("https://google.com:443/")); + public void parseDefaultPort() { + assertThat(parse("http://google.com/").toString(), is("http://google.com:80/")); + assertThat(parse("https://google.com/").toString(), is("https://google.com:443/")); } @Test - public void extractId() throws MalformedURLException { - String id1 = Url.extractId("http://google.com:80/"); - String id2 = Url.extractId("http://google.com/"); - String id3 = Url.extractId("https://google.com/"); + public void testWsProtocol() { + URI uri = parse("ws://woot.com/test"); + assertThat(uri.getScheme(), is("ws")); + assertThat(uri.getHost(), is("woot.com")); + assertThat(uri.getPort(), is(80)); + assertThat(uri.getPath(), is("/test")); + } + + @Test + public void testWssProtocol() { + URI uri = parse("wss://woot.com/test"); + assertThat(uri.getScheme(), is("wss")); + assertThat(uri.getHost(), is("woot.com")); + assertThat(uri.getPort(), is(443)); + assertThat(uri.getPath(), is("/test")); + } + + @Test + public void extractId() { + String id1 = extractId("http://google.com:80/"); + String id2 = extractId("http://google.com/"); + String id3 = extractId("https://google.com/"); assertThat(id1, is(id2)); assertThat(id1, is(not(id3))); assertThat(id2, is(not(id3))); } @Test - public void ipv6() throws URISyntaxException, MalformedURLException { + public void ipv6() { String url = "http://[::1]"; - URL parsed = Url.parse(url); - assertThat(parsed.getProtocol(), is("http")); + URI parsed = parse(url); + assertThat(parsed.getScheme(), is("http")); assertThat(parsed.getHost(), is("[::1]")); assertThat(parsed.getPort(), is(80)); - assertThat(Url.extractId(url), is("http://[::1]:80")); + assertThat(extractId(url), is("http://[::1]:80")); } + } diff --git a/src/test/java/io/socket/parser/ByteArrayTest.java b/src/test/java/io/socket/parser/ByteArrayTest.java index a358c15c..f3ef8a75 100644 --- a/src/test/java/io/socket/parser/ByteArrayTest.java +++ b/src/test/java/io/socket/parser/ByteArrayTest.java @@ -1,15 +1,15 @@ package io.socket.parser; -import io.socket.emitter.Emitter; import org.json.JSONArray; import org.json.JSONException; -import org.json.JSONObject; import org.junit.Test; import org.junit.runner.RunWith; import org.junit.runners.JUnit4; import java.nio.charset.Charset; +import java.nio.charset.StandardCharsets; +import static java.util.Arrays.asList; import static org.hamcrest.CoreMatchers.is; import static org.junit.Assert.assertThat; @@ -20,8 +20,8 @@ public class ByteArrayTest { @Test public void encodeByteArray() { - Packet packet = new Packet(Parser.BINARY_EVENT); - packet.data = "abc".getBytes(Charset.forName("UTF-8")); + Packet packet = new Packet<>(Parser.BINARY_EVENT); + packet.data = new JSONArray(asList("abc", "abc".getBytes(StandardCharsets.UTF_8))); packet.id = 23; packet.nsp = "/cool"; Helpers.testBin(packet); @@ -29,8 +29,8 @@ public void encodeByteArray() { @Test public void encodeByteArray2() { - Packet packet = new Packet(Parser.BINARY_EVENT); - packet.data = new byte[2]; + Packet packet = new Packet<>(Parser.BINARY_EVENT); + packet.data = new JSONArray(asList("2", new byte[] { 0, 1 })); packet.id = 0; packet.nsp = "/"; Helpers.testBin(packet); @@ -38,11 +38,11 @@ public void encodeByteArray2() { @Test public void encodeByteArrayDeepInJson() throws JSONException { - JSONObject data = new JSONObject("{a: \"hi\", b: {}, c: {a: \"bye\", b: {}}}"); - data.getJSONObject("b").put("why", new byte[3]); - data.getJSONObject("c").getJSONObject("b").put("a", new byte[6]); + JSONArray data = new JSONArray("[{a: \"hi\", b: {}, c: {a: \"bye\", b: {}}}]"); + data.getJSONObject(0).getJSONObject("b").put("why", new byte[3]); + data.getJSONObject(0).getJSONObject("c").getJSONObject("b").put("a", new byte[6]); - Packet packet = new Packet(Parser.BINARY_EVENT); + Packet packet = new Packet<>(Parser.BINARY_EVENT); packet.data = data; packet.id = 999; packet.nsp = "/deep"; @@ -51,10 +51,10 @@ public void encodeByteArrayDeepInJson() throws JSONException { @Test public void encodeDeepBinaryJSONWithNullValue() throws JSONException { - JSONObject data = new JSONObject("{a: \"b\", c: 4, e: {g: null}, h: null}"); - data.put("h", new byte[9]); + JSONArray data = new JSONArray("[{a: \"b\", c: 4, e: {g: null}, h: null}]"); + data.getJSONObject(0).put("h", new byte[9]); - Packet packet = new Packet(Parser.BINARY_EVENT); + Packet packet = new Packet<>(Parser.BINARY_EVENT); packet.data = data; packet.nsp = "/"; packet.id = 600; diff --git a/src/test/java/io/socket/parser/Helpers.java b/src/test/java/io/socket/parser/Helpers.java index 0a3d4612..a3b84367 100644 --- a/src/test/java/io/socket/parser/Helpers.java +++ b/src/test/java/io/socket/parser/Helpers.java @@ -1,6 +1,5 @@ package io.socket.parser; -import io.socket.emitter.Emitter; import org.json.JSONArray; import org.json.JSONException; import org.json.JSONObject; @@ -10,6 +9,7 @@ import static org.hamcrest.CoreMatchers.is; import static org.junit.Assert.assertThat; +import static org.junit.Assert.fail; @RunWith(JUnit4.class) public class Helpers { @@ -35,13 +35,10 @@ public void call(Packet packet) { public static void testDecodeError(final String errorMessage) { Parser.Decoder decoder = new IOParser.Decoder(); - decoder.onDecoded(new IOParser.Decoder.Callback() { - @Override - public void call(Packet packet) { - assertPacket(errorPacket, packet); - } - }); - decoder.add(errorMessage); + try { + decoder.add(errorMessage); + fail(); + } catch (DecodingException e) {} } @SuppressWarnings("unchecked") diff --git a/src/test/java/io/socket/parser/ParserTest.java b/src/test/java/io/socket/parser/ParserTest.java index c13005c4..ac154fd6 100644 --- a/src/test/java/io/socket/parser/ParserTest.java +++ b/src/test/java/io/socket/parser/ParserTest.java @@ -63,5 +63,8 @@ public void decodeInError() throws JSONException { Helpers.testDecodeError(Parser.EVENT + "2sd"); // event with invalid json data Helpers.testDecodeError(Parser.EVENT + "2[\"a\",1,{asdf}]"); + Helpers.testDecodeError(Parser.EVENT + "2{}"); + Helpers.testDecodeError(Parser.EVENT + "2[]"); + Helpers.testDecodeError(Parser.EVENT + "2[null]"); } }