diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..7bbbc83a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,63 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: 'bug' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** + +Please fill the following code example: + +Socket.IO server version: `x.y.z` + +*Server* + +```js +import { Server } from "socket.io"; + +const io = new Server(8080); + +io.on("connection", (socket) => { + // ... +}); +``` + +Socket.IO java client version: `x.y.z` + +*Client* + +```java +public class MyApplication { + public static void main(String[] args) throws URISyntaxException { + IO.Options options = IO.Options.builder() + .build(); + + Socket socket = IO.socket("http://localhost:8080", options); + + socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() { + @Override + public void call(Object... args) { + System.out.println("connect"); + } + }); + + socket.open(); + } +} +``` + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Platform:** + - Device: [e.g. Samsung S8] + - OS: [e.g. Android 9.2] + +**Additional context** +Add any other context about the problem here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..36014cde --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: 'enhancement' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 00000000..53c39215 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,9 @@ +--- +name: Ask a Question +about: Ask the community for help +title: '' +labels: 'question' +assignees: '' + +--- + diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 00000000..439755f9 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,34 @@ +name: CI + +on: + push: + pull_request: + schedule: + - cron: '0 0 * * 0' + +jobs: + verify: + runs-on: ubuntu-latest + + strategy: + matrix: + java: [7, 8, 11] + + steps: + - uses: actions/checkout@v2 + - name: Setup java + uses: actions/setup-java@v1 + with: + java-version: ${{ matrix.java }} + - name: Cache Maven packages + uses: actions/cache@v2 + 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 diff --git a/.gitignore b/.gitignore index d26349c8..3ce60d52 100644 --- a/.gitignore +++ b/.gitignore @@ -14,3 +14,6 @@ .DS_Store target/ node_modules/ +build/ +.gradle/ +local.properties diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index b940182f..00000000 --- a/.travis.yml +++ /dev/null @@ -1,7 +0,0 @@ -language: java -dist: trusty -sudo: false -install: mvn install -DskipTests=true -Dgpg.skip=true -jdk: - - openjdk7 - - oraclejdk8 diff --git a/History.md b/History.md index 60f71daf..02f66f43 100644 --- a/History.md +++ b/History.md @@ -1,4 +1,33 @@ +2.0.1 / 2021-04-27 +================== + +### Bug Fixes + +* fix usage with ws:// scheme ([67fd5f3](https://github.com/socketio/socket.io-client-java/commit/67fd5f34a31c63f7884f82ab39386ad343527590)) +* ensure buffered events are sent in order ([4885e7d](https://github.com/socketio/socket.io-client-java/commit/4885e7d59fad78285448694cb5681e8a9ce809ef)) +* ensure the payload format is valid ([e8ffe9d](https://github.com/socketio/socket.io-client-java/commit/e8ffe9d1383736f6a21090ab959a2f4fa5a41284)) +* emit a CONNECT_ERROR event upon connection failure ([d324e7f](https://github.com/socketio/socket.io-client-java/commit/d324e7f396a444ddd556c3d70a85a28eefb1e02b)) + + +2.0.0 / 2020-12-15 +================== + +### Features + +* add options builder ([#304](https://github.com/socketio/socket.io-client-java/issues/304)) ([49068d3](https://github.com/socketio/socket.io-client-java/commit/49068d3cc504c9b83e29a8d5cb4350360c6ef8ea)) +* add support for Socket.IO v3 ([79cb27f](https://github.com/socketio/socket.io-client-java/commit/79cb27fc979ecf1eec9dc2dd4a72c8081149d1e2)) + + +1.0.1 / 2020-12-10 +================== + +### Bug Fixes + +* don't process socket.connect() if we are already re-connecting ([#577](https://github.com/socketio/socket.io-client-java/issues/577)) ([54b7311](https://github.com/socketio/socket.io-client-java/commit/54b73114d19f33a78bec1ce99325893129f8a148)) +* handle case where URI.getHost() returns null ([#484](https://github.com/socketio/socket.io-client-java/issues/484)) ([567372e](https://github.com/socketio/socket.io-client-java/commit/567372ecfa6c86bdc72f8bc64985d6511dc87666)) + + 1.0.0 / 2017-07-14 ================== diff --git a/Makefile b/Makefile new file mode 100644 index 00000000..d0927070 --- /dev/null +++ b/Makefile @@ -0,0 +1,7 @@ +help: ## print this message + @grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}' + +build-site: ## build the site + mvn clean javadoc:javadoc site -DskipTests + +.PHONY: build-site diff --git a/README.md b/README.md index 31368927..28c73c09 100644 --- a/README.md +++ b/README.md @@ -1,190 +1,34 @@ # Socket.IO-client Java -[![Build Status](https://travis-ci.org/socketio/socket.io-client-java.png?branch=master)](https://travis-ci.org/socketio/socket.io-client-java) -This is the Socket.IO v1.x Client Library for Java, which is simply ported from the [JavaScript client](https://github.com/socketio/socket.io-client). +[![Build Status](https://github.com/socketio/socket.io-client-java/workflows/CI/badge.svg)](https://github.com/socketio/socket.io-client-java/actions) + +This is the Socket.IO Client Library for Java, which is simply ported from the [JavaScript client](https://github.com/socketio/socket.io-client). See also: - [Android chat demo](https://github.com/nkzawa/socket.io-android-chat) - [engine.io-client-java](https://github.com/socketio/engine.io-client-java) -## Installation -The latest artifact is available on Maven Central. You'll also need [dependencies](http://socketio.github.io/socket.io-client-java/dependencies.html) to install. - -### Maven -Add the following dependency to your `pom.xml`. - -```xml - - - io.socket - socket.io-client - 1.0.0 - - -``` - -### Gradle -Add it as a gradle dependency for Android Studio, in `build.gradle`: - -```groovy -compile ('io.socket:socket.io-client:1.0.0') { - // excluding org.json which is provided by Android - exclude group: 'org.json', module: 'json' -} -``` - -#### Socket.IO Server 1.x suppport - -The current version of socket.io-client-java doesn't support socket.io server 1.x. -Please use socket.io-client-java 0.9.x for that instead. - -## Usage -Socket.IO-client Java has almost the same api and features with the original JS client. You use `IO#socket` to initialize `Socket`: - -```java -socket = IO.socket("http://localhost"); -socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() { - - @Override - public void call(Object... args) { - socket.emit("foo", "hi"); - socket.disconnect(); - } - -}).on("event", new Emitter.Listener() { - - @Override - public void call(Object... args) {} - -}).on(Socket.EVENT_DISCONNECT, new Emitter.Listener() { - - @Override - public void call(Object... args) {} - -}); -socket.connect(); -``` - -This Library uses [org.json](http://www.json.org/java/) to parse and compose JSON strings: - -```java -// Sending an object -JSONObject obj = new JSONObject(); -obj.put("hello", "server"); -obj.put("binary", new byte[42]); -socket.emit("foo", obj); +## Table of content -// Receiving an object -socket.on("foo", new Emitter.Listener() { - @Override - public void call(Object... args) { - JSONObject obj = (JSONObject)args[0]; - } -}); -``` +- [Compatibility](#compatibility) +- [Documentation](#documentation) +- [License](#license) -Options are supplied as follows: +## Compatibility -```java -IO.Options opts = new IO.Options(); -opts.forceNew = true; -opts.reconnection = false; +| Client version | Socket.IO server | +| -------------- | ---------------- | +| 0.9.x | 1.x | +| 1.x | 2.x | +| 2.x | 3.x / 4.x | -socket = IO.socket("http://localhost", opts); -``` +## Documentation -You can supply query parameters with the `query` option. NB: if you don't want to reuse a cached socket instance when the query parameter changes, you should use the `forceNew` option, the use case might be if your app allows for a user to logout, and a new user to login again: +The documentation can be found [here](https://socketio.github.io/socket.io-client-java/installation.html). -```java -IO.Options opts = new IO.Options(); -opts.forceNew = true; -opts.query = "auth_token=" + authToken; -Socket socket = IO.socket("http://localhost", opts); -``` - -You can get a callback with `Ack` when the server received a message: - -```java -socket.emit("foo", "woot", new Ack() { - @Override - public void call(Object... args) {} -}); -``` - -And vice versa: - -```java -// ack from client to server -socket.on("foo", new Emitter.Listener() { - @Override - public void call(Object... args) { - Ack ack = (Ack) args[args.length - 1]; - ack.call(); - } -}); -``` - -SSL (HTTPS, WSS) settings: - -```java -OkHttpClient okHttpClient = new OkHttpClient.Builder() - .hostnameVerifier(myHostnameVerifier) - .sslSocketFactory(mySSLContext.getSocketFactory(), myX509TrustManager) - .build(); - -// default settings for all sockets -IO.setDefaultOkHttpWebSocketFactory(okHttpClient); -IO.setDefaultOkHttpCallFactory(okHttpClient); - -// set as an option -opts = new IO.Options(); -opts.callFactory = okHttpClient; -opts.webSocketFactory = okHttpClient; -socket = IO.socket("https://localhost", opts); -``` - -See the Javadoc for more details. - -http://socketio.github.io/socket.io-client-java/apidocs/ - -### Transports and HTTP Headers -You can access transports and their HTTP headers as follows. - -```java -// Called upon transport creation. -socket.io().on(Manager.EVENT_TRANSPORT, new Emitter.Listener() { - @Override - public void call(Object... args) { - Transport transport = (Transport)args[0]; - - transport.on(Transport.EVENT_REQUEST_HEADERS, new Emitter.Listener() { - @Override - public void call(Object... args) { - @SuppressWarnings("unchecked") - Map> headers = (Map>)args[0]; - // modify request headers - headers.put("Cookie", Arrays.asList("foo=1;")); - } - }); - - transport.on(Transport.EVENT_RESPONSE_HEADERS, new Emitter.Listener() { - @Override - public void call(Object... args) { - @SuppressWarnings("unchecked") - Map> headers = (Map>)args[0]; - // access response headers - String cookie = headers.get("Set-Cookie").get(0); - } - }); - } -}); -``` - -## Features -This library supports all of the features the JS client does, including events, options and upgrading transport. Android is fully supported. +The source of this documentation is in the `src/site/` directory of the repository. Pull requests are welcome! ## License MIT - diff --git a/build.gradle b/build.gradle new file mode 100644 index 00000000..decb5026 --- /dev/null +++ b/build.gradle @@ -0,0 +1,90 @@ +/* + * This file was generated by the Gradle 'init' task. + */ + +plugins { + id 'java-library' + id 'maven-publish' +} + +repositories { + mavenLocal() + maven { url 'https://maven.bandyer.com/releases' } + + maven { + url = uri('https://oss.sonatype.org/content/groups/public/') + } + maven { + url = uri('https://oss.sonatype.org/content/repositories/snapshots') + } + + maven { + url = uri('https://repo.maven.apache.org/maven2/') + } +} + +dependencies { + api 'com.kaleyra:engine.io-client:2.0.0' + implementation 'org.json:json:20090211' + testImplementation 'junit:junit:4.12' + testImplementation 'org.hamcrest:hamcrest-library:1.3' + testImplementation 'org.skyscreamer:jsonassert:1.5.0' +} + +java.sourceCompatibility = JavaVersion.VERSION_1_7 + +java { + withSourcesJar() + withJavadocJar() +} + + +def projectGroup = "com.kaleyra" +def libVersion = "2.0.1" + +Properties properties = new Properties() +if (project.rootProject.file("local.properties").exists()) { + properties.load(project.rootProject.file('local.properties').newDataInputStream()) +} + +publishing { + repositories { + maven { + url = "s3://maven-bandyer/releases/" + credentials(AwsCredentials) { + accessKey = properties.getProperty("maven.accessKey") + secretKey = properties.getProperty("maven.secretKey") + } + } + } + + publications { + maven(MavenPublication) { + from components.java + groupId = projectGroup + artifactId = project.getName() + version = libVersion + } + } +} + +task invalidateCache(type: Exec) { + workingDir 'scripts' + def publishPath = "releases" + def packageName = projectGroup + "." + project.getName() + commandLine 'python3', './invalidate_s3_cache.py', properties.getProperty("maven.accessKey"), properties.getProperty("maven.secretKey"), properties.getProperty("maven.distributionId"), publishPath, packageName ,libVersion +} + +task publishUpload { + def dryRun = true + def publishTask = 'publishToMavenLocal' + if(!dryRun) publishTask = 'publish' + dependsOn publishTask + dependsOn 'invalidateCache' + tasks.findByName('invalidateCache').mustRunAfter publishTask +} + + +tasks.withType(JavaCompile) { + options.encoding = 'UTF-8' +} diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 00000000..69a97150 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-7.1-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 00000000..744e882e --- /dev/null +++ b/gradlew @@ -0,0 +1,185 @@ +#!/usr/bin/env sh + +# +# Copyright 2015 the original author or authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn () { + echo "$*" +} + +die () { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MSYS* | MINGW* ) + msys=true + ;; + NONSTOP* ) + nonstop=true + ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin or MSYS, switch paths to Windows format before running java +if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=`expr $i + 1` + done + case $i in + 0) set -- ;; + 1) set -- "$args0" ;; + 2) set -- "$args0" "$args1" ;; + 3) set -- "$args0" "$args1" "$args2" ;; + 4) set -- "$args0" "$args1" "$args2" "$args3" ;; + 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save () { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=`save "$@"` + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 00000000..ac1b06f9 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,89 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/pom.xml b/pom.xml index ea79c46b..6bd5b6e2 100644 --- a/pom.xml +++ b/pom.xml @@ -1,8 +1,8 @@ 4.0.0 - io.socket + com.kaleyra.socket_io socket.io-client - 1.0.1-SNAPSHOT + 2.0.1 jar socket.io-client Socket.IO Client Library for Java @@ -42,6 +42,16 @@ + + bandyer-release + https://maven.bandyer.com/releases/ + + true + + + true + + sonatype-oss-public https://oss.sonatype.org/content/groups/public/ @@ -54,15 +64,11 @@ - - 3.0.4 - - - io.socket + com.kaleyra engine.io-client - 1.0.0 + 2.0.0 org.json @@ -219,20 +225,9 @@ 2.3 - com.github.github - site-maven-plugin - 0.12 - - Creating site for ${project.version} - - - - - site - - site - - + org.apache.maven.plugins + maven-site-plugin + 3.9.1 diff --git a/scripts/invalidate_s3_cache.py b/scripts/invalidate_s3_cache.py new file mode 100755 index 00000000..2e331a6c --- /dev/null +++ b/scripts/invalidate_s3_cache.py @@ -0,0 +1,43 @@ +import sys +import boto3 +from time import time + +AWS_ACCESS_KEY = sys.argv[1] +AWS_SECRET_ACCESS_KEY = sys.argv[2] +AWS_CF_DISTRIBUTION_ID = sys.argv[3] +AWS_PATH = sys.argv[4] # such as releases/ +PACKAGE_NAME = sys.argv[5] # such as com.bandyer.library +PACKAGE_VERSION = sys.argv[6] # such as 1.0 + +aws_package_path = PACKAGE_NAME.replace(".", "/") + +if AWS_PATH[0] == '/': + AWS_PATH = AWS_PATH[1:] + +if AWS_PATH.endswith('/'): + AWS_PATH = AWS_PATH[:-1] + +root_path = AWS_PATH + "/" + aws_package_path + "/" + +package_split = PACKAGE_NAME.split('.') + +foldersToInvalidate = [ '/?list-type=2&delimiter=/&prefix='+ AWS_PATH +'/&max-keys=50', + '/?list-type=2&delimiter=/&prefix='+ AWS_PATH + '/' + package_split[0] + '/&max-keys=50', + '/?list-type=2&delimiter=/&prefix='+ AWS_PATH + '/' + package_split[0] + '/' + package_split[1] +'/&max-keys=50', + '/?list-type=2&delimiter=/&prefix='+ root_path +'&max-keys=50', # invalidate necessary for website indexing + '/?list-type=2&delimiter=/&prefix='+ root_path + PACKAGE_VERSION + '/&max-keys=50', # invalidate necessary for website indexing + "/" + root_path + "maven-metadata.*", + "/" + root_path + PACKAGE_VERSION + '/*'] + +client = boto3.client('cloudfront', aws_access_key_id=AWS_ACCESS_KEY, aws_secret_access_key=AWS_SECRET_ACCESS_KEY) + +response = client.create_invalidation( + DistributionId=AWS_CF_DISTRIBUTION_ID, + InvalidationBatch={ + 'Paths': { + 'Quantity': len(foldersToInvalidate), + 'Items': foldersToInvalidate + }, + 'CallerReference': str(time()).replace(".", "") + } +) diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 00000000..58ea34df --- /dev/null +++ b/settings.gradle @@ -0,0 +1,5 @@ +/* + * This file was generated by the Gradle 'init' task. + */ + +rootProject.name = 'socket.io-client' diff --git a/src/main/java/io/socket/backo/Backoff.java b/src/main/java/com/kaleyra/socket_io/backo/Backoff.java similarity index 97% rename from src/main/java/io/socket/backo/Backoff.java rename to src/main/java/com/kaleyra/socket_io/backo/Backoff.java index f5199213..825c1c52 100644 --- a/src/main/java/io/socket/backo/Backoff.java +++ b/src/main/java/com/kaleyra/socket_io/backo/Backoff.java @@ -1,4 +1,4 @@ -package io.socket.backo; +package com.kaleyra.socket_io.backo; import java.math.BigDecimal; import java.math.BigInteger; diff --git a/src/main/java/com/kaleyra/socket_io/client/Ack.java b/src/main/java/com/kaleyra/socket_io/client/Ack.java new file mode 100644 index 00000000..d3f81aef --- /dev/null +++ b/src/main/java/com/kaleyra/socket_io/client/Ack.java @@ -0,0 +1,9 @@ +package com.kaleyra.socket_io.client; + +/** + * Acknowledgement. + */ + +public interface Ack { + void call(Object... args); +} \ No newline at end of file diff --git a/src/main/java/com/kaleyra/socket_io/client/AckWithTimeOut.java b/src/main/java/com/kaleyra/socket_io/client/AckWithTimeOut.java new file mode 100644 index 00000000..83eac753 --- /dev/null +++ b/src/main/java/com/kaleyra/socket_io/client/AckWithTimeOut.java @@ -0,0 +1,50 @@ +package com.kaleyra.socket_io.client; + +import java.util.Timer; +import java.util.TimerTask; + +public abstract class AckWithTimeOut implements Ack { + + private Timer timer; + private long timeOut = 0; + private boolean called = false; + + public AckWithTimeOut() { + } + + public AckWithTimeOut(long timeout_after) { + if (timeout_after <= 0) + return; + this.timeOut = timeout_after; + startTimer(); + } + + private void startTimer() { + timer = new Timer(); + timer.schedule(new TimerTask() { + @Override + public void run() { + callback(new NoAck()); + } + }, timeOut); + } + + void resetTimer() { + if (timer != null) { + timer.cancel(); + startTimer(); + } + } + + void cancelTimer() { + if (timer != null) + timer.cancel(); + } + + void callback(Object... args) { + if (called) return; + called = true; + cancelTimer(); + call(args); + } +} \ No newline at end of file diff --git a/src/main/java/io/socket/client/IO.java b/src/main/java/com/kaleyra/socket_io/client/IO.java similarity index 72% rename from src/main/java/io/socket/client/IO.java rename to src/main/java/com/kaleyra/socket_io/client/IO.java index a5455f48..20c99d4f 100644 --- a/src/main/java/io/socket/client/IO.java +++ b/src/main/java/com/kaleyra/socket_io/client/IO.java @@ -1,13 +1,12 @@ -package io.socket.client; +package com.kaleyra.socket_io.client; -import io.socket.parser.Parser; +import com.kaleyra.socket_io.parser.Parser; import okhttp3.Call; import okhttp3.WebSocket; 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; @@ -17,7 +16,7 @@ public class IO { private static final Logger logger = Logger.getLogger(IO.class.getName()); - private static final ConcurrentHashMap managers = new ConcurrentHashMap(); + private static final ConcurrentHashMap managers = new ConcurrentHashMap<>(); /** * Protocol version. @@ -58,20 +57,20 @@ 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; + String query = source.getQuery(); + if (query != null && (opts.query == null || opts.query.isEmpty())) { + opts.query = query; + } + if (newConnection) { if (logger.isLoggable(Level.FINE)) { logger.fine(String.format("ignoring socket cache for %s", source)); @@ -87,12 +86,7 @@ public static Socket socket(URI uri, Options opts) { io = managers.get(id); } - String query = parsed.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); } @@ -104,5 +98,21 @@ public static class Options extends Manager.Options { * Whether to enable multiplexing. Default is true. */ public boolean multiplex = true; + + /** + *

+ * Retrieve new builder class that helps creating socket option as builder pattern. + * This method returns exactly same result as : + *

+ * + * SocketOptionBuilder builder = SocketOptionBuilder.builder(); + * + * + * @return builder class that helps creating socket option as builder pattern. + * @see SocketOptionBuilder#builder() + */ + public static SocketOptionBuilder builder() { + return SocketOptionBuilder.builder(); + } } } diff --git a/src/main/java/io/socket/client/Manager.java b/src/main/java/com/kaleyra/socket_io/client/Manager.java similarity index 73% rename from src/main/java/io/socket/client/Manager.java rename to src/main/java/com/kaleyra/socket_io/client/Manager.java index 6da92ee5..75909801 100644 --- a/src/main/java/io/socket/client/Manager.java +++ b/src/main/java/com/kaleyra/socket_io/client/Manager.java @@ -1,25 +1,17 @@ -package io.socket.client; - -import io.socket.backo.Backoff; -import io.socket.emitter.Emitter; -import io.socket.parser.IOParser; -import io.socket.parser.Packet; -import io.socket.parser.Parser; -import io.socket.thread.EventThread; +package com.kaleyra.socket_io.client; + +import com.kaleyra.socket_io.backo.Backoff; +import com.kaleyra.socket_io.emitter.Emitter; +import com.kaleyra.socket_io.parser.DecodingException; +import com.kaleyra.socket_io.parser.IOParser; +import com.kaleyra.socket_io.parser.Packet; +import com.kaleyra.socket_io.parser.Parser; +import com.kaleyra.socket_io.thread.EventThread; import okhttp3.Call; import okhttp3.WebSocket; import java.net.URI; -import java.util.ArrayList; -import java.util.Date; -import java.util.HashSet; -import java.util.LinkedList; -import java.util.List; -import java.util.Map; -import java.util.Queue; -import java.util.Set; -import java.util.Timer; -import java.util.TimerTask; +import java.util.*; import java.util.concurrent.ConcurrentHashMap; import java.util.logging.Level; import java.util.logging.Logger; @@ -48,16 +40,6 @@ public class Manager extends Emitter { public static final String EVENT_PACKET = "packet"; public static final String EVENT_ERROR = "error"; - /** - * Called on a connection error. - */ - public static final String EVENT_CONNECT_ERROR = "connect_error"; - - /** - * Called on a connection timeout. - */ - public static final String EVENT_CONNECT_TIMEOUT = "connect_timeout"; - /** * Called on a successful reconnection. */ @@ -72,12 +54,6 @@ public class Manager extends Emitter { public static final String EVENT_RECONNECT_ATTEMPT = "reconnect_attempt"; - public static final String EVENT_RECONNECTING = "reconnecting"; - - public static final String EVENT_PING = "ping"; - - public static final String EVENT_PONG = "pong"; - /** * Called when a new transport is created. (experimental) */ @@ -98,13 +74,11 @@ public class Manager extends Emitter { private double _randomizationFactor; private Backoff backoff; private long _timeout; - private Set connecting = new HashSet(); - private Date lastPing; private URI uri; private List packetBuffer; private Queue subs; private Options opts; - /*package*/ io.socket.engineio.client.Socket engine; + /*package*/ com.kaleyra.socket_io.engineio.client.Socket engine; private Parser.Encoder encoder; private Parser.Decoder decoder; @@ -140,8 +114,8 @@ public Manager(URI uri, Options opts) { opts.callFactory = defaultCallFactory; } this.opts = opts; - this.nsps = new ConcurrentHashMap(); - this.subs = new LinkedList(); + this.nsps = new ConcurrentHashMap<>(); + this.subs = new LinkedList<>(); this.reconnection(opts.reconnection); this.reconnectionAttempts(opts.reconnectionAttempts != 0 ? opts.reconnectionAttempts : Integer.MAX_VALUE); this.reconnectionDelay(opts.reconnectionDelay != 0 ? opts.reconnectionDelay : 1000); @@ -155,33 +129,11 @@ public Manager(URI uri, Options opts) { this.readyState = ReadyState.CLOSED; this.uri = uri; this.encoding = false; - this.packetBuffer = new ArrayList(); + this.packetBuffer = new ArrayList<>(); this.encoder = opts.encoder != null ? opts.encoder : new IOParser.Encoder(); this.decoder = opts.decoder != null ? opts.decoder : new IOParser.Decoder(); } - private void emitAll(String event, Object... args) { - this.emit(event, args); - for (Socket socket : this.nsps.values()) { - socket.emit(event, args); - } - } - - /** - * Update `socket.id` of all sockets - */ - private void updateSocketIds() { - for (Map.Entry entry : this.nsps.entrySet()) { - String nsp = entry.getKey(); - Socket socket = entry.getValue(); - socket.id = this.generateId(nsp); - } - } - - private String generateId(String nsp) { - return ("/".equals(nsp) ? "" : (nsp + "#")) + this.engine.id(); - } - public boolean reconnection() { return this._reconnection; } @@ -191,6 +143,10 @@ public Manager reconnection(boolean v) { return this; } + public boolean isReconnecting() { + return reconnecting; + } + public int reconnectionAttempts() { return this._reconnectionAttempts; } @@ -275,7 +231,7 @@ public void run() { logger.fine(String.format("opening %s", Manager.this.uri)); } Manager.this.engine = new Engine(Manager.this.uri, Manager.this.opts); - final io.socket.engineio.client.Socket socket = Manager.this.engine; + final com.kaleyra.socket_io.engineio.client.Socket socket = Manager.this.engine; final Manager self = Manager.this; Manager.this.readyState = ReadyState.OPENING; Manager.this.skipReconnect = false; @@ -303,7 +259,7 @@ public void call(Object... objects) { logger.fine("connect_error"); self.cleanup(); self.readyState = ReadyState.CLOSED; - self.emitAll(EVENT_CONNECT_ERROR, data); + self.emit(EVENT_ERROR, data); if (fn != null) { Exception err = new SocketIOException("Connection error", data instanceof Exception ? (Exception) data : null); @@ -315,24 +271,28 @@ public void call(Object... objects) { } }); - if (Manager.this._timeout >= 0) { - final long timeout = Manager.this._timeout; + final long timeout = Manager.this._timeout; + final Runnable onTimeout = new Runnable() { + @Override + public void run() { + logger.fine(String.format("connect attempt timed out after %d", timeout)); + openSub.destroy(); + socket.close(); + socket.emit(Engine.EVENT_ERROR, new SocketIOException("timeout")); + } + }; + + if (timeout == 0) { + EventThread.exec(onTimeout); + return; + } else if (Manager.this._timeout > 0) { logger.fine(String.format("connection attempt will timeout after %d", timeout)); final Timer timer = new Timer(); timer.schedule(new TimerTask() { @Override public void run() { - EventThread.exec(new Runnable() { - @Override - public void run() { - logger.fine(String.format("connect attempt timed out after %d", timeout)); - openSub.destroy(); - socket.close(); - socket.emit(Engine.EVENT_ERROR, new SocketIOException("timeout")); - self.emitAll(EVENT_CONNECT_TIMEOUT, timeout); - } - }); + EventThread.exec(onTimeout); } }, timeout); @@ -361,30 +321,22 @@ private void onopen() { this.readyState = ReadyState.OPEN; this.emit(EVENT_OPEN); - final io.socket.engineio.client.Socket socket = this.engine; + final com.kaleyra.socket_io.engineio.client.Socket socket = this.engine; this.subs.add(On.on(socket, Engine.EVENT_DATA, new Listener() { @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()); } } })); - this.subs.add(On.on(socket, Engine.EVENT_PING, new Listener() { - @Override - public void call(Object... objects) { - Manager.this.onping(); - } - })); - this.subs.add(On.on(socket, Engine.EVENT_PONG, new Listener() { - @Override - public void call(Object... objects) { - Manager.this.onpong(); - } - })); this.subs.add(On.on(socket, Engine.EVENT_ERROR, new Listener() { @Override public void call(Object... objects) { @@ -405,31 +357,13 @@ public void call (Packet packet) { }); } - private void onping() { - this.lastPing = new Date(); - this.emitAll(EVENT_PING); - } - - private void onpong() { - this.emitAll(EVENT_PONG, - 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); } private void onerror(Exception err) { logger.log(Level.FINE, "error", err); - this.emitAll(EVENT_ERROR, err); + this.emit(EVENT_ERROR, err); } /** @@ -440,41 +374,31 @@ private void onerror(Exception err) { * @return a socket instance for the namespace. */ public Socket socket(final String nsp, Options opts) { - Socket socket = this.nsps.get(nsp); - if (socket == null) { - socket = new Socket(this, nsp, opts); - Socket _socket = this.nsps.putIfAbsent(nsp, socket); - if (_socket != null) { - socket = _socket; - } else { - final Manager self = this; - final Socket s = socket; - socket.on(Socket.EVENT_CONNECTING, new Listener() { - @Override - public void call(Object... args) { - self.connecting.add(s); - } - }); - socket.on(Socket.EVENT_CONNECT, new Listener() { - @Override - public void call(Object... objects) { - s.id = self.generateId(nsp); - } - }); + synchronized (this.nsps) { + Socket socket = this.nsps.get(nsp); + if (socket == null) { + socket = new Socket(this, nsp, opts); + this.nsps.put(nsp, socket); } + return socket; } - return socket; } public Socket socket(String nsp) { return socket(nsp, null); } - /*package*/ void destroy(Socket socket) { - this.connecting.remove(socket); - if (!this.connecting.isEmpty()) return; + /*package*/ void destroy() { + synchronized (this.nsps) { + for (Socket socket : this.nsps.values()) { + if (socket.isActive()) { + logger.fine("socket is still active, skipping close"); + return; + } + } - this.close(); + this.close(); + } } /*package*/ void packet(Packet packet) { @@ -483,10 +407,6 @@ public Socket socket(String nsp) { } final Manager self = this; - if (packet.query != null && !packet.query.isEmpty() && packet.type == Parser.CONNECT) { - packet.nsp += "?" + packet.query; - } - if (!self.encoding) { self.encoding = true; this.encoder.encode(packet, new Parser.Encoder.Callback() { @@ -524,7 +444,6 @@ private void cleanup() { this.packetBuffer.clear(); this.encoding = false; - this.lastPing = null; this.decoder.destroy(); } @@ -565,7 +484,7 @@ private void reconnect() { if (this.backoff.getAttempts() >= this._reconnectionAttempts) { logger.fine("reconnect failed"); this.backoff.reset(); - this.emitAll(EVENT_RECONNECT_FAILED); + this.emit(EVENT_RECONNECT_FAILED); this.reconnecting = false; } else { long delay = this.backoff.duration(); @@ -583,8 +502,7 @@ public void run() { logger.fine("attempting reconnect"); int attempts = self.backoff.getAttempts(); - self.emitAll(EVENT_RECONNECT_ATTEMPT, attempts); - self.emitAll(EVENT_RECONNECTING, attempts); + self.emit(EVENT_RECONNECT_ATTEMPT, attempts); // check again for the case socket closed in above events if (self.skipReconnect) return; @@ -596,7 +514,7 @@ public void call(Exception err) { logger.fine("reconnect attempt error"); self.reconnecting = false; self.reconnect(); - self.emitAll(EVENT_RECONNECT_ERROR, err); + self.emit(EVENT_RECONNECT_ERROR, err); } else { logger.fine("reconnect success"); self.onreconnect(); @@ -621,25 +539,24 @@ private void onreconnect() { int attempts = this.backoff.getAttempts(); this.reconnecting = false; this.backoff.reset(); - this.updateSocketIds(); - this.emitAll(EVENT_RECONNECT, attempts); + this.emit(EVENT_RECONNECT, attempts); } - public static interface OpenCallback { + public interface OpenCallback { - public void call(Exception err); + void call(Exception err); } - private static class Engine extends io.socket.engineio.client.Socket { + private static class Engine extends com.kaleyra.socket_io.engineio.client.Socket { Engine(URI uri, Options opts) { super(uri, opts); } } - public static class Options extends io.socket.engineio.client.Socket.Options { + public static class Options extends com.kaleyra.socket_io.engineio.client.Socket.Options { public boolean reconnection = true; public int reconnectionAttempts; @@ -648,6 +565,7 @@ public static class Options extends io.socket.engineio.client.Socket.Options { public double randomizationFactor; public Parser.Encoder encoder; public Parser.Decoder decoder; + public Map auth; /** * Connection timeout (ms). Set -1 to disable. diff --git a/src/main/java/com/kaleyra/socket_io/client/NoAck.java b/src/main/java/com/kaleyra/socket_io/client/NoAck.java new file mode 100644 index 00000000..663d20ba --- /dev/null +++ b/src/main/java/com/kaleyra/socket_io/client/NoAck.java @@ -0,0 +1,8 @@ +package com.kaleyra.socket_io.client; + +/** + * No Acknowledgement. + */ +public class NoAck { +} + diff --git a/src/main/java/io/socket/client/On.java b/src/main/java/com/kaleyra/socket_io/client/On.java similarity index 69% rename from src/main/java/io/socket/client/On.java rename to src/main/java/com/kaleyra/socket_io/client/On.java index b962f131..1dbe54e2 100644 --- a/src/main/java/io/socket/client/On.java +++ b/src/main/java/com/kaleyra/socket_io/client/On.java @@ -1,6 +1,6 @@ -package io.socket.client; +package com.kaleyra.socket_io.client; -import io.socket.emitter.Emitter; +import com.kaleyra.socket_io.emitter.Emitter; public class On { @@ -16,8 +16,8 @@ public void destroy() { }; } - public static interface Handle { + public interface Handle { - public void destroy(); + void destroy(); } } diff --git a/src/main/java/io/socket/client/Socket.java b/src/main/java/com/kaleyra/socket_io/client/Socket.java similarity index 75% rename from src/main/java/io/socket/client/Socket.java rename to src/main/java/com/kaleyra/socket_io/client/Socket.java index 61baef35..7b18e5d2 100644 --- a/src/main/java/io/socket/client/Socket.java +++ b/src/main/java/com/kaleyra/socket_io/client/Socket.java @@ -1,20 +1,14 @@ -package io.socket.client; +package com.kaleyra.socket_io.client; -import io.socket.emitter.Emitter; -import io.socket.parser.Packet; -import io.socket.parser.Parser; -import io.socket.thread.EventThread; +import com.kaleyra.socket_io.emitter.Emitter; +import com.kaleyra.socket_io.parser.Packet; +import com.kaleyra.socket_io.parser.Parser; +import com.kaleyra.socket_io.thread.EventThread; import org.json.JSONArray; import org.json.JSONException; import org.json.JSONObject; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.HashMap; -import java.util.LinkedList; -import java.util.List; -import java.util.Map; -import java.util.Queue; +import java.util.*; import java.util.logging.Level; import java.util.logging.Logger; @@ -30,8 +24,6 @@ public class Socket extends Emitter { */ public static final String EVENT_CONNECT = "connect"; - public static final String EVENT_CONNECTING = "connecting"; - /** * Called on a disconnection. */ @@ -42,45 +34,21 @@ public class Socket extends Emitter { * *

Parameters:

*
    - *
  • (Exception) error data.
  • + *
  • (Exception) error data.
  • *
*/ - public static final String EVENT_ERROR = "error"; - - public static final String EVENT_MESSAGE = "message"; - - public static final String EVENT_CONNECT_ERROR = Manager.EVENT_CONNECT_ERROR; - - public static final String EVENT_CONNECT_TIMEOUT = Manager.EVENT_CONNECT_TIMEOUT; - - public static final String EVENT_RECONNECT = Manager.EVENT_RECONNECT; - - public static final String EVENT_RECONNECT_ERROR = Manager.EVENT_RECONNECT_ERROR; + public static final String EVENT_CONNECT_ERROR = "connect_error"; - public static final String EVENT_RECONNECT_FAILED = Manager.EVENT_RECONNECT_FAILED; + static final String EVENT_MESSAGE = "message"; - public static final String EVENT_RECONNECT_ATTEMPT = Manager.EVENT_RECONNECT_ATTEMPT; - - public static final String EVENT_RECONNECTING = Manager.EVENT_RECONNECTING; - - public static final String EVENT_PING = Manager.EVENT_PING; - - public static final String EVENT_PONG = Manager.EVENT_PONG; - - protected static Map events = new HashMap() {{ + protected static Map RESERVED_EVENTS = new HashMap() {{ put(EVENT_CONNECT, 1); put(EVENT_CONNECT_ERROR, 1); - put(EVENT_CONNECT_TIMEOUT, 1); - put(EVENT_CONNECTING, 1); put(EVENT_DISCONNECT, 1); - put(EVENT_ERROR, 1); - put(EVENT_RECONNECT, 1); - put(EVENT_RECONNECT_ATTEMPT, 1); - put(EVENT_RECONNECT_FAILED, 1); - put(EVENT_RECONNECT_ERROR, 1); - put(EVENT_RECONNECTING, 1); - put(EVENT_PING, 1); - put(EVENT_PONG, 1); + // used on the server-side + put("disconnecting", 1); + put("newListener", 1); + put("removeListener", 1); }}; /*package*/ String id; @@ -89,17 +57,17 @@ public class Socket extends Emitter { private int ids; private String nsp; private Manager io; - private String query; - private Map acks = new HashMap(); + private Map auth; + private Map acks = new HashMap<>(); private Queue subs; - private final Queue> receiveBuffer = new LinkedList>(); - private final Queue> sendBuffer = new LinkedList>(); + private final Queue> receiveBuffer = new LinkedList<>(); + private final Queue> sendBuffer = new LinkedList<>(); public Socket(Manager io, String nsp, Manager.Options opts) { this.io = io; this.nsp = nsp; if (opts != null) { - this.query = opts.query; + this.auth = opts.auth; } } @@ -120,6 +88,14 @@ public void call(Object... args) { Socket.this.onpacket((Packet) args[0]); } })); + add(On.on(io, Manager.EVENT_ERROR, new Listener() { + @Override + public void call(Object... args) { + if (!Socket.this.connected) { + Socket.super.emit(EVENT_CONNECT_ERROR, args[0]); + } + } + })); add(On.on(io, Manager.EVENT_CLOSE, new Listener() { @Override public void call(Object... args) { @@ -129,6 +105,10 @@ public void call(Object... args) { }}; } + public boolean isActive() { + return this.subs != null; + } + /** * Connects the socket. */ @@ -136,12 +116,11 @@ public Socket open() { EventThread.exec(new Runnable() { @Override public void run() { - if (Socket.this.connected) return; + if (Socket.this.connected || Socket.this.io.isReconnecting()) return; Socket.this.subEvents(); Socket.this.io.open(); // ensure open if (Manager.ReadyState.OPEN == Socket.this.io.readyState) Socket.this.onopen(); - Socket.this.emit(EVENT_CONNECTING); } }); return this; @@ -174,19 +153,18 @@ public void run() { * Emits an event. When you pass {@link Ack} at the last argument, then the acknowledge is done. * * @param event an event name. - * @param args data to send. + * @param args data to send. * @return a reference to this object. */ @Override public Emitter emit(final String event, final Object... args) { + if (RESERVED_EVENTS.containsKey(event)) { + throw new RuntimeException("'" + event + "' is a reserved event name"); + } + EventThread.exec(new Runnable() { @Override public void run() { - if (events.containsKey(event)) { - Socket.super.emit(event, args); - return; - } - Ack ack; Object[] _args; int lastIndex = args.length - 1; @@ -212,8 +190,8 @@ public void run() { * Emits an event with an acknowledge. * * @param event an event name - * @param args data to send. - * @param ack the acknowledgement to be called + * @param args data to send. + * @param ack the acknowledgement to be called * @return a reference to this object. */ public Emitter emit(final String event, final Object[] args, final Ack ack) { @@ -229,7 +207,7 @@ public void run() { } } - Packet packet = new Packet(Parser.EVENT, jsonArgs); + Packet packet = new Packet<>(Parser.EVENT, jsonArgs); if (ack != null) { logger.fine(String.format("emitting packet with ack id %d", ids)); @@ -240,6 +218,8 @@ public void run() { if (Socket.this.connected) { Socket.this.packet(packet); } else { + if (ack instanceof AckWithTimeOut) + ((AckWithTimeOut) ack).cancelTimer(); Socket.this.sendBuffer.add(packet); } } @@ -255,14 +235,10 @@ private void packet(Packet packet) { private void onopen() { logger.fine("transport is open - connecting"); - if (!"/".equals(this.nsp)) { - if (this.query != null && !this.query.isEmpty()) { - Packet packet = new Packet(Parser.CONNECT); - packet.query = this.query; - this.packet(packet); - } else { - this.packet(new Packet(Parser.CONNECT)); - } + if (this.auth != null) { + this.packet(new Packet<>(Parser.CONNECT, new JSONObject(this.auth))); + } else { + this.packet(new Packet<>(Parser.CONNECT)); } } @@ -272,24 +248,26 @@ private void onclose(String reason) { } this.connected = false; this.id = null; - this.emit(EVENT_DISCONNECT, reason); + super.emit(EVENT_DISCONNECT, reason); } private void onpacket(Packet packet) { if (!this.nsp.equals(packet.nsp)) return; switch (packet.type) { - case Parser.CONNECT: - this.onconnect(); - break; - - case Parser.EVENT: { - @SuppressWarnings("unchecked") - Packet p = (Packet) packet; - this.onevent(p); + case Parser.CONNECT: { + if (packet.data instanceof JSONObject && ((JSONObject) packet.data).has("sid")) { + try { + this.onconnect(((JSONObject) packet.data).getString("sid")); + return; + } catch (JSONException e) {} + } else { + super.emit(EVENT_CONNECT_ERROR, new SocketIOException("It seems you are trying to reach a Socket.IO server in v2.x with a v3.x client, which is not possible")); + } break; } + case Parser.EVENT: case Parser.BINARY_EVENT: { @SuppressWarnings("unchecked") Packet p = (Packet) packet; @@ -297,13 +275,7 @@ private void onpacket(Packet packet) { break; } - case Parser.ACK: { - @SuppressWarnings("unchecked") - Packet p = (Packet) packet; - this.onack(p); - break; - } - + case Parser.ACK: case Parser.BINARY_ACK: { @SuppressWarnings("unchecked") Packet p = (Packet) packet; @@ -315,14 +287,14 @@ private void onpacket(Packet packet) { this.ondisconnect(); break; - case Parser.ERROR: - this.emit(EVENT_ERROR, packet.data); + case Parser.CONNECT_ERROR: + super.emit(EVENT_CONNECT_ERROR, packet.data); break; } } private void onevent(Packet packet) { - List args = new ArrayList(Arrays.asList(toArray(packet.data))); + List args = new ArrayList<>(Arrays.asList(toArray(packet.data))); if (logger.isLoggable(Level.FINE)) { logger.fine(String.format("emitting event %s", args)); } @@ -343,7 +315,7 @@ private void onevent(Packet packet) { private Ack ack(final int id) { final Socket self = this; - final boolean[] sent = new boolean[] {false}; + final boolean[] sent = new boolean[]{false}; return new Ack() { @Override public void call(final Object... args) { @@ -361,7 +333,7 @@ public void run() { jsonArgs.put(arg); } - Packet packet = new Packet(Parser.ACK, jsonArgs); + Packet packet = new Packet<>(Parser.ACK, jsonArgs); packet.id = id; self.packet(packet); } @@ -376,7 +348,10 @@ private void onack(Packet packet) { if (logger.isLoggable(Level.FINE)) { logger.fine(String.format("calling ack %s with %s", packet.id, packet.data)); } - fn.call(toArray(packet.data)); + if (fn instanceof AckWithTimeOut) + ((AckWithTimeOut) fn).callback(toArray(packet.data)); + else + fn.call(toArray(packet.data)); } else { if (logger.isLoggable(Level.FINE)) { logger.fine(String.format("bad ack %s", packet.id)); @@ -384,22 +359,29 @@ private void onack(Packet packet) { } } - private void onconnect() { + private void onconnect(String id) { this.connected = true; - this.emit(EVENT_CONNECT); + this.id = id; this.emitBuffered(); + super.emit(EVENT_CONNECT); } private void emitBuffered() { List data; while ((data = this.receiveBuffer.poll()) != null) { - String event = (String)data.get(0); + if (data.isEmpty()) { + continue; + } + String event = data.remove(0).toString(); super.emit(event, data.toArray()); } this.receiveBuffer.clear(); Packet packet; while ((packet = this.sendBuffer.poll()) != null) { + Ack ack = acks.get(packet.id); + if (ack instanceof AckWithTimeOut) + ((AckWithTimeOut) ack).resetTimer(); this.packet(packet); } this.sendBuffer.clear(); @@ -422,7 +404,12 @@ private void destroy() { this.subs = null; } - this.io.destroy(this); + for (Ack ack : acks.values()) { + if (ack instanceof AckWithTimeOut) + ((AckWithTimeOut) ack).cancelTimer(); + } + + this.io.destroy(); } /** @@ -470,7 +457,7 @@ public boolean connected() { /** * A property on the socket instance that is equal to the underlying engine.io socket id. - * + *

* The value is present once the socket has connected, is removed when the socket disconnects and is updated if the socket reconnects. * * @return a socket id diff --git a/src/main/java/io/socket/client/SocketIOException.java b/src/main/java/com/kaleyra/socket_io/client/SocketIOException.java similarity index 90% rename from src/main/java/io/socket/client/SocketIOException.java rename to src/main/java/com/kaleyra/socket_io/client/SocketIOException.java index 5ad67dca..87065f39 100644 --- a/src/main/java/io/socket/client/SocketIOException.java +++ b/src/main/java/com/kaleyra/socket_io/client/SocketIOException.java @@ -1,4 +1,4 @@ -package io.socket.client; +package com.kaleyra.socket_io.client; public class SocketIOException extends Exception { diff --git a/src/main/java/com/kaleyra/socket_io/client/SocketOptionBuilder.java b/src/main/java/com/kaleyra/socket_io/client/SocketOptionBuilder.java new file mode 100644 index 00000000..f7872557 --- /dev/null +++ b/src/main/java/com/kaleyra/socket_io/client/SocketOptionBuilder.java @@ -0,0 +1,202 @@ +package com.kaleyra.socket_io.client; + +import java.util.List; +import java.util.Map; + + +/** + * Convenient builder class that helps creating + * {@link IO.Options Client Option} object as builder pattern. + * Finally, you can get option object with call {@link #build()} method. + * + * @author junbong + */ +public class SocketOptionBuilder { + /** + * Construct new builder with default preferences. + * + * @return new builder object + * @see SocketOptionBuilder#builder(IO.Options) + */ + public static SocketOptionBuilder builder() { + return new SocketOptionBuilder(); + } + + + /** + * Construct this builder from specified option object. + * The option that returned from {@link #build()} method + * is not equals with given option. + * In other words, builder creates new option object + * and copy all preferences from given option. + * + * @param options option object which to copy preferences + * @return new builder object + */ + public static SocketOptionBuilder builder(IO.Options options) { + return new SocketOptionBuilder(options); + } + + + private final IO.Options options = new IO.Options(); + + + /** + * Construct new builder with default preferences. + */ + protected SocketOptionBuilder() { + this(null); + } + + + /** + * Construct this builder from specified option object. + * The option that returned from {@link #build()} method + * is not equals with given option. + * In other words, builder creates new option object + * and copy all preferences from given option. + * + * @param options option object which to copy preferences. Null-ok. + */ + protected SocketOptionBuilder(IO.Options options) { + if (options != null) { + this.setForceNew(options.forceNew) + .setMultiplex(options.multiplex) + .setReconnection(options.reconnection) + .setReconnectionAttempts(options.reconnectionAttempts) + .setReconnectionDelay(options.reconnectionDelay) + .setReconnectionDelayMax(options.reconnectionDelayMax) + .setRandomizationFactor(options.randomizationFactor) + .setTimeout(options.timeout) + .setTransports(options.transports) + .setUpgrade(options.upgrade) + .setRememberUpgrade(options.rememberUpgrade) + .setHost(options.host) + .setHostname(options.hostname) + .setPort(options.port) + .setPolicyPort(options.policyPort) + .setSecure(options.secure) + .setPath(options.path) + .setQuery(options.query) + .setAuth(options.auth) + .setExtraHeaders(options.extraHeaders) + .setEnablePollingCookies(options.enablePollingCookies); + } + } + + public SocketOptionBuilder setForceNew(boolean forceNew) { + this.options.forceNew = forceNew; + return this; + } + + public SocketOptionBuilder setMultiplex(boolean multiplex) { + this.options.multiplex = multiplex; + return this; + } + + public SocketOptionBuilder setReconnection(boolean reconnection) { + this.options.reconnection = reconnection; + return this; + } + + public SocketOptionBuilder setReconnectionAttempts(int reconnectionAttempts) { + this.options.reconnectionAttempts = reconnectionAttempts; + return this; + } + + public SocketOptionBuilder setReconnectionDelay(long reconnectionDelay) { + this.options.reconnectionDelay = reconnectionDelay; + return this; + } + + public SocketOptionBuilder setReconnectionDelayMax(long reconnectionDelayMax) { + this.options.reconnectionDelayMax = reconnectionDelayMax; + return this; + } + + + public SocketOptionBuilder setRandomizationFactor(double randomizationFactor) { + this.options.randomizationFactor = randomizationFactor; + return this; + } + + public SocketOptionBuilder setTimeout(long timeout) { + this.options.timeout = timeout; + return this; + } + + public SocketOptionBuilder setTransports(String[] transports) { + this.options.transports = transports; + return this; + } + + public SocketOptionBuilder setUpgrade(boolean upgrade) { + this.options.upgrade = upgrade; + return this; + } + + public SocketOptionBuilder setRememberUpgrade(boolean rememberUpgrade) { + this.options.rememberUpgrade = rememberUpgrade; + return this; + } + + public SocketOptionBuilder setHost(String host) { + this.options.host = host; + return this; + } + + public SocketOptionBuilder setHostname(String hostname) { + this.options.hostname = hostname; + return this; + } + + public SocketOptionBuilder setPort(int port) { + this.options.port = port; + return this; + } + + public SocketOptionBuilder setPolicyPort(int policyPort) { + this.options.policyPort = policyPort; + return this; + } + + public SocketOptionBuilder setQuery(String query) { + this.options.query = query; + return this; + } + + public SocketOptionBuilder setSecure(boolean secure) { + this.options.secure = secure; + return this; + } + + public SocketOptionBuilder setPath(String path) { + this.options.path = path; + return this; + } + + public SocketOptionBuilder setAuth(Map auth) { + this.options.auth = auth; + return this; + } + + public SocketOptionBuilder setExtraHeaders(Map> extraHeaders) { + this.options.extraHeaders = extraHeaders; + return this; + } + + public SocketOptionBuilder setEnablePollingCookies(boolean enablePollingCookies) { + this.options.enablePollingCookies = enablePollingCookies; + return this; + } + + /** + * Finally retrieve {@link IO.Options} object + * from this builder. + * + * @return option that built from this builder + */ + public IO.Options build() { + return this.options; + } +} diff --git a/src/main/java/com/kaleyra/socket_io/client/Url.java b/src/main/java/com/kaleyra/socket_io/client/Url.java new file mode 100644 index 00000000..c75c40bb --- /dev/null +++ b/src/main/java/com/kaleyra/socket_io/client/Url.java @@ -0,0 +1,84 @@ +package com.kaleyra.socket_io.client; + +import java.net.URI; +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +public class Url { + + /** + * Expected format: "[id:password@]host[:port]" + */ + private static Pattern PATTERN_AUTHORITY = Pattern.compile("^(.*@)?([^:]+)(:\\d+)?$"); + + private Url() {} + + 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 ParsedURI parse(URI uri) { + String protocol = uri.getScheme(); + if (protocol == null || !protocol.matches("^https?|wss?$")) { + protocol = "https"; + } + + int port = uri.getPort(); + if (port == -1) { + if ("http".equals(protocol) || "ws".equals(protocol)) { + port = 80; + } else if ("https".equals(protocol) || "wss".equals(protocol)) { + port = 443; + } + } + + String path = uri.getRawPath(); + if (path == null || path.length() == 0) { + path = "/"; + } + + String userInfo = uri.getRawUserInfo(); + String query = uri.getRawQuery(); + String fragment = uri.getRawFragment(); + String _host = uri.getHost(); + if (_host == null) { + // might happen on some of Samsung Devices such as S4. + _host = extractHostFromAuthorityPart(uri.getRawAuthority()); + } + 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); + } + + + private static String extractHostFromAuthorityPart(String authority) + { + if (authority == null) { + throw new RuntimeException("unable to parse the host from the authority"); + } + + Matcher matcher = PATTERN_AUTHORITY.matcher(authority); + + // If the authority part does not match the expected format. + if (!matcher.matches()) { + throw new RuntimeException("unable to parse the host from the authority"); + } + + // Return the host part. + return matcher.group(2); + } + +} diff --git a/src/main/java/io/socket/hasbinary/HasBinary.java b/src/main/java/com/kaleyra/socket_io/hasbinary/HasBinary.java similarity index 97% rename from src/main/java/io/socket/hasbinary/HasBinary.java rename to src/main/java/com/kaleyra/socket_io/hasbinary/HasBinary.java index 630be88a..7b9a2cbd 100644 --- a/src/main/java/io/socket/hasbinary/HasBinary.java +++ b/src/main/java/com/kaleyra/socket_io/hasbinary/HasBinary.java @@ -1,4 +1,4 @@ -package io.socket.hasbinary; +package com.kaleyra.socket_io.hasbinary; import org.json.JSONArray; import org.json.JSONException; diff --git a/src/main/java/io/socket/parser/Binary.java b/src/main/java/com/kaleyra/socket_io/parser/Binary.java similarity index 98% rename from src/main/java/io/socket/parser/Binary.java rename to src/main/java/com/kaleyra/socket_io/parser/Binary.java index b390da62..7c0d244f 100644 --- a/src/main/java/io/socket/parser/Binary.java +++ b/src/main/java/com/kaleyra/socket_io/parser/Binary.java @@ -1,4 +1,4 @@ -package io.socket.parser; +package com.kaleyra.socket_io.parser; import org.json.JSONArray; import org.json.JSONException; @@ -20,7 +20,7 @@ public class Binary { @SuppressWarnings("unchecked") public static DeconstructedPacket deconstructPacket(Packet packet) { - List buffers = new ArrayList(); + List buffers = new ArrayList<>(); packet.data = _deconstructPacket(packet.data, buffers); packet.attachments = buffers.size(); diff --git a/src/main/java/com/kaleyra/socket_io/parser/DecodingException.java b/src/main/java/com/kaleyra/socket_io/parser/DecodingException.java new file mode 100644 index 00000000..10985da3 --- /dev/null +++ b/src/main/java/com/kaleyra/socket_io/parser/DecodingException.java @@ -0,0 +1,7 @@ +package com.kaleyra.socket_io.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/com/kaleyra/socket_io/parser/IOParser.java similarity index 81% rename from src/main/java/io/socket/parser/IOParser.java rename to src/main/java/com/kaleyra/socket_io/parser/IOParser.java index 813c16ca..659d48e0 100644 --- a/src/main/java/io/socket/parser/IOParser.java +++ b/src/main/java/com/kaleyra/socket_io/parser/IOParser.java @@ -1,7 +1,9 @@ -package io.socket.parser; +package com.kaleyra.socket_io.parser; -import io.socket.hasbinary.HasBinary; +import com.kaleyra.socket_io.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,26 @@ private static Packet decodeString(String str) { return p; } + private static boolean isPayloadValid(int type, Object payload) { + switch (type) { + case CONNECT: + case CONNECT_ERROR: + return payload instanceof JSONObject; + case DISCONNECT: + return payload == null; + case EVENT: + case BINARY_EVENT: + return payload instanceof JSONArray + && ((JSONArray) payload).length() > 0 + && !((JSONArray) payload).isNull(0); + case ACK: + case BINARY_ACK: + return payload instanceof JSONArray; + default: + return false; + } + } + @Override public void destroy() { if (this.reconstructor != null) { @@ -214,7 +239,7 @@ public void onDecoded (Callback callback) { BinaryReconstructor(Packet packet) { this.reconPack = packet; - this.buffers = new ArrayList(); + this.buffers = new ArrayList<>(); } public Packet takeBinaryData(byte[] binData) { @@ -230,7 +255,7 @@ public Packet takeBinaryData(byte[] binData) { public void finishReconstruction () { this.reconPack = null; - this.buffers = new ArrayList(); + this.buffers = new ArrayList<>(); } } } diff --git a/src/main/java/io/socket/parser/Packet.java b/src/main/java/com/kaleyra/socket_io/parser/Packet.java similarity index 86% rename from src/main/java/io/socket/parser/Packet.java rename to src/main/java/com/kaleyra/socket_io/parser/Packet.java index da65f68f..2c6ae0a7 100644 --- a/src/main/java/io/socket/parser/Packet.java +++ b/src/main/java/com/kaleyra/socket_io/parser/Packet.java @@ -1,4 +1,4 @@ -package io.socket.parser; +package com.kaleyra.socket_io.parser; public class Packet { @@ -8,7 +8,6 @@ public class Packet { public String nsp; public T data; public int attachments; - public String query; public Packet() {} diff --git a/src/main/java/com/kaleyra/socket_io/parser/Parser.java b/src/main/java/com/kaleyra/socket_io/parser/Parser.java new file mode 100644 index 00000000..a73fbc1a --- /dev/null +++ b/src/main/java/com/kaleyra/socket_io/parser/Parser.java @@ -0,0 +1,82 @@ +package com.kaleyra.socket_io.parser; + +public interface Parser { + + /** + * Packet type `connect`. + */ + int CONNECT = 0; + + /** + * Packet type `disconnect`. + */ + int DISCONNECT = 1; + + /** + * Packet type `event`. + */ + int EVENT = 2; + + /** + * Packet type `ack`. + */ + int ACK = 3; + + /** + * Packet type `error`. + */ + int CONNECT_ERROR = 4; + + /** + * Packet type `binary event`. + */ + int BINARY_EVENT = 5; + + /** + * Packet type `binary ack`. + */ + int BINARY_ACK = 6; + + int protocol = 5; + + /** + * Packet types. + */ + String[] types = new String[] { + "CONNECT", + "DISCONNECT", + "EVENT", + "ACK", + "ERROR", + "BINARY_EVENT", + "BINARY_ACK" + }; + + interface Encoder { + + void encode(Packet obj, Callback callback); + + interface Callback { + + void call(Object[] data); + } + } + + interface Decoder { + + void add(String obj); + + void add(byte[] obj); + + void destroy(); + + void onDecoded(Callback callback); + + interface Callback { + + void call(Packet packet); + } + } +} + + diff --git a/src/main/java/io/socket/client/Ack.java b/src/main/java/io/socket/client/Ack.java deleted file mode 100644 index 8bd6a1e8..00000000 --- a/src/main/java/io/socket/client/Ack.java +++ /dev/null @@ -1,11 +0,0 @@ -package io.socket.client; - -/** - * Acknowledgement. - */ -public interface Ack { - - public void call(Object... args); - -} - diff --git a/src/main/java/io/socket/client/Url.java b/src/main/java/io/socket/client/Url.java deleted file mode 100644 index b9830180..00000000 --- a/src/main/java/io/socket/client/Url.java +++ /dev/null @@ -1,73 +0,0 @@ -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; - -public class Url { - - private static Pattern PATTERN_HTTP = Pattern.compile("^http|ws$"); - private static Pattern PATTERN_HTTPS = Pattern.compile("^(http|ws)s$"); - - private Url() {} - - public static URL parse(String uri) throws URISyntaxException { - return parse(new URI(uri)); - } - - public static URL parse(URI uri) { - String protocol = uri.getScheme(); - if (protocol == null || !protocol.matches("^https?|wss?$")) { - protocol = "https"; - } - - int port = uri.getPort(); - if (port == -1) { - if (PATTERN_HTTP.matcher(protocol).matches()) { - port = 80; - } else if (PATTERN_HTTPS.matcher(protocol).matches()) { - port = 443; - } - } - - String path = uri.getRawPath(); - if (path == null || path.length() == 0) { - path = "/"; - } - - String userInfo = uri.getRawUserInfo(); - String query = uri.getRawQuery(); - String fragment = uri.getRawFragment(); - try { - return new URL(protocol + "://" - + (userInfo != null ? userInfo + "@" : "") - + uri.getHost() - + (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)); - } - - 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; - } - -} diff --git a/src/main/java/io/socket/parser/Parser.java b/src/main/java/io/socket/parser/Parser.java deleted file mode 100644 index 66367d50..00000000 --- a/src/main/java/io/socket/parser/Parser.java +++ /dev/null @@ -1,82 +0,0 @@ -package io.socket.parser; - -public interface Parser { - - /** - * Packet type `connect`. - */ - public static final int CONNECT = 0; - - /** - * Packet type `disconnect`. - */ - public static final int DISCONNECT = 1; - - /** - * Packet type `event`. - */ - public static final int EVENT = 2; - - /** - * Packet type `ack`. - */ - public static final int ACK = 3; - - /** - * Packet type `error`. - */ - public static final int ERROR = 4; - - /** - * Packet type `binary event`. - */ - public static final int BINARY_EVENT = 5; - - /** - * Packet type `binary ack`. - */ - public static final int BINARY_ACK = 6; - - public static int protocol = 4; - - /** - * Packet types. - */ - public static String[] types = new String[] { - "CONNECT", - "DISCONNECT", - "EVENT", - "ACK", - "ERROR", - "BINARY_EVENT", - "BINARY_ACK" - }; - - public static interface Encoder { - - public void encode(Packet obj, Callback callback); - - public interface Callback { - - public void call(Object[] data); - } - } - - public static interface Decoder { - - public void add(String obj); - - public void add(byte[] obj); - - public void destroy(); - - public void onDecoded(Callback callback); - - public interface Callback { - - public void call(Packet packet); - } - } -} - - diff --git a/src/site/markdown/changelog.md b/src/site/markdown/changelog.md new file mode 100644 index 00000000..98ea025b --- /dev/null +++ b/src/site/markdown/changelog.md @@ -0,0 +1,18 @@ + +## [2.0.0](https://github.com/socketio/socket.io-client-java/compare/socket.io-client-1.0.1...socket.io-client-2.0.0) (2020-12-14) + + +### Features + +* add options builder ([#304](https://github.com/socketio/socket.io-client-java/issues/304)) ([49068d3](https://github.com/socketio/socket.io-client-java/commit/49068d3cc504c9b83e29a8d5cb4350360c6ef8ea)) +* add support for Socket.IO v3 ([79cb27f](https://github.com/socketio/socket.io-client-java/commit/79cb27fc979ecf1eec9dc2dd4a72c8081149d1e2)), closes [/github.com/socketio/socket.io-protocol#difference-between-v5-and-v4](https://github.com//github.com/socketio/socket.io-protocol/issues/difference-between-v5-and-v4) + + + +## [1.0.1](https://github.com/socketio/socket.io-client-java/compare/socket.io-client-1.0.0...socket.io-client-1.0.1) (2020-12-10) + + +### Bug Fixes + +* don't process socket.connect() if we are already re-connecting ([#577](https://github.com/socketio/socket.io-client-java/issues/577)) ([54b7311](https://github.com/socketio/socket.io-client-java/commit/54b73114d19f33a78bec1ce99325893129f8a148)) +* handle case where URI.getHost() returns null ([#484](https://github.com/socketio/socket.io-client-java/issues/484)) ([567372e](https://github.com/socketio/socket.io-client-java/commit/567372ecfa6c86bdc72f8bc64985d6511dc87666)) diff --git a/src/site/markdown/emitting_events.md b/src/site/markdown/emitting_events.md new file mode 100644 index 00000000..5f298ffb --- /dev/null +++ b/src/site/markdown/emitting_events.md @@ -0,0 +1,148 @@ +# Emitting events + +See also: https://socket.io/docs/v4/emitting-events/ + +**Table of content** + + + +There are several ways to send events between the server and the client. + +## Basic emit + +The Socket.IO API is inspired from the Node.js [EventEmitter](https://nodejs.org/docs/latest/api/events.html#events_events): + +*Server* + +```js +io.on("connection", (socket) => { + socket.emit("hello", "world"); +}); +``` + +*Client* + +```java +socket.on("hello", new Emitter.Listener() { + @Override + public void call(Object... args) { + System.out.println(args[0]); // world + } +}); +``` + +This also works in the other direction: + +*Server* + +```js +io.on("connection", (socket) => { + socket.on("hello", (arg) => { + console.log(arg); // world + }); +}); +``` + +*Client* + +```java +socket.emit("hello", "world"); +``` + +You can send any number of arguments, and all serializable datastructures are supported, including binary objects like [Buffer](https://nodejs.org/docs/latest/api/buffer.html#buffer_buffer) or [TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray). + +*Server* + +```js +io.on("connection", (socket) => { + socket.on("hello", (...args) => { + console.log(args); // [ 1, '2', , { test: '42' } ] + }); +}); +``` + +*Client* + +```java +byte[] buffer = "abc".getBytes(StandardCharsets.UTF_8); +JSONObject object = new JSONObject(); +object.put("test", "42"); + +socket.emit("hello", 1, "2", bytes, object); +``` + +## Acknowledgements + +Events are great, but in some cases you may want a more classic request-response API. In Socket.IO, this feature is named acknowledgements. + +You can add a callback as the last argument of the `emit()`, and this callback will be called once the other side acknowledges the event: + +### From client to server + +*Client* + +```java +// Java 7 +socket.emit("update item", 1, new JSONObject(singletonMap("name", "updated")), new Ack() { + @Override + public void call(Object... args) { + JSONObject response = (JSONObject) args[0]; + System.out.println(response.getString("status")); // "ok" + } +}); + +// Java 8 and above +socket.emit("update item", 1, new JSONObject(singletonMap("name", "updated")), (Ack) args -> { + JSONObject response = (JSONObject) args[0]; + System.out.println(response.getString("status")); // "ok" +}); +``` + +*Server* + +```js +io.on("connection", (socket) => { + socket.on("update item", (arg1, arg2, callback) => { + console.log(arg1); // 1 + console.log(arg2); // { name: "updated" } + callback({ + status: "ok" + }); + }); +}); +``` + +### From server to client + +*Server* + +```js +io.on("connection", (socket) => { + socket.emit("hello", "please acknowledge", (response) => { + console.log(response); // prints "hi!" + }); +}); +``` + +*Client* + +```java +// Java 7 +socket.on("hello", new Emitter.Listener() { + @Override + public void call(Object... args) { + System.out.println(args[0]); // "please acknowledge" + if (args.length > 1 && args[1] instanceof Ack) { + ((Ack) args[1]).call("hi!"); + } + } +}); + +// Java 8 and above +socket.on("hello", args -> { + System.out.println(args[0]); // "please acknowledge" + if (args.length > 1 && args[1] instanceof Ack) { + ((Ack) args[1]).call("hi!"); + } +}); +``` diff --git a/src/site/markdown/initialization.md b/src/site/markdown/initialization.md new file mode 100644 index 00000000..72cca0d0 --- /dev/null +++ b/src/site/markdown/initialization.md @@ -0,0 +1,316 @@ +# Initialization + +**Table of content** + + + +## Creation of a Socket instance + +```java +URI uri = URI.create("https://example.com"); +IO.Options options = IO.Options.builder() + // ... + .build(); + +Socket socket = IO.socket(uri, options); +``` + +Unlike the JS client (which can infer it from the `window.location` object), the URI is mandatory here. + +The [scheme](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#Syntax) part of the URI is also mandatory. Both `ws://` and `http://` can be used interchangeably. + +```java +Socket socket = IO.socket("https://example.com"); // OK +Socket socket = IO.socket("wss://example.com"); // OK, similar to the example above +Socket socket = IO.socket("192.168.0.1:1234"); // NOT OK, missing the scheme part +``` + +The path represents the [Namespace](https://socket.io/docs/v4/namespaces/), and not the actual path (see [below](#path)) of the HTTP requests: + +```java +Socket socket = IO.socket(URI.create("https://example.com")); // the main namespace +Socket productSocket = IO.socket(URI.create("https://example.com/product")); // the "product" namespace +Socket orderSocket = IO.socket(URI.create("https://example.com/order")); // the "order" namespace +``` + +## Default values + +```java +IO.Options options = IO.Options.builder() + // IO factory options + .setForceNew(false) + .setMultiplex(true) + + // low-level engine options + .setTransports(new String[] { Polling.NAME, WebSocket.NAME }) + .setUpgrade(true) + .setRememberUpgrade(false) + .setPath("/socket.io/") + .setQuery(null) + .setExtraHeaders(null) + + // Manager options + .setReconnection(true) + .setReconnectionAttempts(Integer.MAX_VALUE) + .setReconnectionDelay(1_000) + .setReconnectionDelayMax(5_000) + .setRandomizationFactor(0.5) + .setTimeout(20_000) + + // Socket options + .setAuth(null) + .build(); +``` + +## Description + +### IO factory options + +These settings will be shared by all Socket instances attached to the same Manager. + +#### `forceNew` + +Default value: `false` + +Whether to create a new Manager instance. + +A Manager instance is in charge of the low-level connection to the server (established with HTTP long-polling or WebSocket). It handles the reconnection logic. + +A Socket instance is the interface which is used to sends events to — and receive events from — the server. It belongs to a given [namespace](https://socket.io/docs/v4/namespaces). + +A single Manager can be attached to several Socket instances. + +The following example will reuse the same Manager instance for the 3 Socket instances (one single WebSocket connection): + +```java +IO.Options options = IO.Options.builder() + .setForceNew(false) + .build(); + +Socket socket = IO.socket(URI.create("https://example.com"), options); // the main namespace +Socket productSocket = IO.socket(URI.create("https://example.com/product"), options); // the "product" namespace +Socket orderSocket = IO.socket(URI.create("https://example.com/order"), options); // the "order" namespace +``` + +The following example will create 3 different Manager instances (and thus 3 distinct WebSocket connections): + +```java +IO.Options options = IO.Options.builder() + .setForceNew(true) + .build(); + +Socket socket = IO.socket(URI.create("https://example.com"), options); // the main namespace +Socket productSocket = IO.socket(URI.create("https://example.com/product"), options); // the "product" namespace +Socket orderSocket = IO.socket(URI.create("https://example.com/order"), options); // the "order" namespace +``` + +#### `multiplex` + +Default value: `true` + +The opposite of `forceNew`: whether to reuse an existing Manager instance. + +### Low-level engine options + +#### `transports` + +Default value: `new String[] { Polling.NAME, WebSocket.NAME }` + +The low-level connection to the Socket.IO server can either be established with: + +- HTTP long-polling: successive HTTP requests (`POST` for writing, `GET` for reading) +- [WebSocket](https://en.wikipedia.org/wiki/WebSocket) + +The following example disables the HTTP long-polling transport: + +```java +IO.Options options = IO.Options.builder() + .setTransports(new String[] { WebSocket.NAME }) + .build(); + +Socket socket = IO.socket(URI.create("https://example.com"), options); +``` + +Note: in that case, sticky sessions are not required on the server side (more information [here](https://socket.io/docs/v4/using-multiple-nodes/)). + +#### `upgrade` + +Default value: `true` + +Whether the client should try to upgrade the transport from HTTP long-polling to something better. + +#### `rememberUpgrade` + +Default value: `false` + +If true and if the previous WebSocket connection to the server succeeded, the connection attempt will bypass the normal upgrade process and will initially try WebSocket. A connection attempt following a transport error will use the normal upgrade process. It is recommended you turn this on only when using SSL/TLS connections, or if you know that your network does not block websockets. + +#### `path` + +Default value: `/socket.io/` + +It is the name of the path that is captured on the server side. + +The server and the client values must match: + +*Server* + +```js +import { Server } from "socket.io"; + +const io = new Server(8080, { + path: "/my-custom-path/" +}); + +io.on("connection", (socket) => { + // ... +}); +``` + +*Client* + +```java +IO.Options options = IO.Options.builder() + .setPath("/my-custom-path/") + .build(); + +Socket socket = IO.socket(URI.create("https://example.com"), options); +``` + +Please note that this is different from the path in the URI, which represents the [Namespace](https://socket.io/docs/v4/namespaces/). + +Example: + +```java +IO.Options options = IO.Options.builder() + .setPath("/my-custom-path/") + .build(); + +Socket socket = IO.socket(URI.create("https://example.com/order"), options); +``` + +- the Socket instance is attached to the "order" Namespace +- the HTTP requests will look like: `GET https://example.com/my-custom-path/?EIO=4&transport=polling&t=ML4jUwU` + +#### `query` + +Default value: - + +Additional query parameters (then found in `socket.handshake.query` object on the server-side). + +Example: + +*Server* + +```js +io.on("connection", (socket) => { + console.log(socket.handshake.query); // prints { x: '42', EIO: '4', transport: 'polling' } +}); +``` + +*Client* + +```java +IO.Options options = IO.Options.builder() + .setQuery("x=42") + .build(); + +Socket socket = IO.socket(URI.create("https://example.com"), options); +``` + +Note: The `socket.handshake.query` object contains the query parameters that were sent during the Socket.IO handshake, it won't be updated for the duration of the current session, which means changing the `query` on the client-side will only be effective when the current session is closed and a new one is created: + +```java +socket.io().on(Manager.EVENT_RECONNECT_ATTEMPT, new Emitter.Listener() { + @Override + public void call(Object... args) { + options.query = "y=43"; + } +}); +``` + +#### `extraHeaders` + +Default value: - + +Additional headers (then found in `socket.handshake.headers` object on the server-side). + +Example: + +*Server* + +```js +io.on("connection", (socket) => { + console.log(socket.handshake.headers); // prints { accept: '*/*', authorization: 'bearer 1234', connection: 'Keep-Alive', 'accept-encoding': 'gzip', 'user-agent': 'okhttp/3.12.12' } +}); +``` + +*Client* + +```java +IO.Options options = IO.Options.builder() + .setExtraHeaders(singletonMap("authorization", singletonList("bearer 1234"))) + .build(); + +Socket socket = IO.socket(URI.create("https://example.com"), options); +``` + +Note: Similar to the `query` option above, the `socket.handshake.headers` object contains the headers that were sent during the Socket.IO handshake, it won't be updated for the duration of the current session, which means changing the `extraHeaders` on the client-side will only be effective when the current session is closed and a new one is created: + +```java +socket.io().on(Manager.EVENT_RECONNECT_ATTEMPT, new Emitter.Listener() { + @Override + public void call(Object... args) { + options.extraHeaders.put("authorization", singletonList("bearer 5678")); + } +}); +``` + +### Socket options + +These settings are specific to the given Socket instance. + +#### `auth` + +Default value: - + +Credentials that are sent when accessing a namespace (see also [here](https://socket.io/docs/v4/middlewares/#sending-credentials)). + +Example: + +*Server* + +```js +io.on("connection", (socket) => { + console.log(socket.handshake.auth); // prints { token: 'abcd' } +}); +``` + +*Client* + +```java +IO.Options options = IO.Options.builder() + .setAuth(singletonMap("token", "abcd")) + .build(); + +Socket socket = IO.socket(URI.create("https://example.com"), options); +``` + +You can update the `auth` map when the access to the Namespace is denied: + +```java +socket.on(Socket.EVENT_CONNECT_ERROR, new Emitter.Listener() { + @Override + public void call(Object... args) { + options.auth.put("token", "efgh"); + socket.connect(); + } +}); +``` + +Or manually force the Socket instance to reconnect: + +```java +options.auth.put("token", "efgh"); +socket.disconnect().connect(); +``` diff --git a/src/site/markdown/installation.md b/src/site/markdown/installation.md new file mode 100644 index 00000000..532dc4d3 --- /dev/null +++ b/src/site/markdown/installation.md @@ -0,0 +1,33 @@ +## Compatibility + +| Client version | Socket.IO server | +| -------------- | ---------------- | +| 0.9.x | 1.x | +| 1.x | 2.x (or 3.1.x / 4.x with [`allowEIO3: true`](https://socket.io/docs/v4/server-options/#alloweio3)) | +| 2.x | 3.x / 4.x | + +## Installation +The latest artifact is available on Maven Central. + +### Maven +Add the following dependency to your `pom.xml`. + +```xml + + + io.socket + socket.io-client + 2.0.1 + + +``` + +### Gradle +Add it as a gradle dependency for Android Studio, in `build.gradle`: + +```groovy +implementation ('io.socket:socket.io-client:2.0.1') { + // excluding org.json which is provided by Android + exclude group: 'org.json', module: 'json' +} +``` diff --git a/src/site/markdown/listening_to_events.md b/src/site/markdown/listening_to_events.md new file mode 100644 index 00000000..6a740658 --- /dev/null +++ b/src/site/markdown/listening_to_events.md @@ -0,0 +1,71 @@ +# Listening to events + +See also: https://socket.io/docs/v4/listening-to-events/ + +**Table of content** + + + +There are several ways to handle events that are transmitted between the server and the client. + +## EventEmitter methods + +### socket.on(eventName, listener) + +Adds the *listener* function to the end of the listeners array for the event named *eventName*. + +```java +socket.on("details", new Emitter.Listener() { + @Override + public void call(Object... args) { + // ... + } +}); +``` + +### socket.once(eventName, listener) + +Adds a **one-time** *listener* function for the event named *eventName*. + +```java +socket.once("details", new Emitter.Listener() { + @Override + public void call(Object... args) { + // ... + } +}); +``` + +### socket.off(eventName, listener) + +Removes the specified *listener* from the listener array for the event named *eventName*. + +```java +Emitter.Listener listener = new Emitter.Listener() { + @Override + public void call(Object... args) { + calls.add("two"); + } +}; + +socket.on("details", listener); + +// and then later... +socket.off("details", listener); +``` + +### socket.off(eventName) + +Removes all listeners for the specific *eventName*. + +```java +socket.off("details"); +``` + +### socket.off() + +Removes all listeners (for any event). + +```java +socket.off(); +``` diff --git a/src/site/markdown/migrating_from_1_x.md b/src/site/markdown/migrating_from_1_x.md new file mode 100644 index 00000000..37c56550 --- /dev/null +++ b/src/site/markdown/migrating_from_1_x.md @@ -0,0 +1,177 @@ +# Migrating from 1.x + +The `2.0.0` release is the first release which is compatible with the Socket.IO v3 server. You can find more information about the v3 release here: https://socket.io/blog/socket-io-3-release/ + +Here is the compatibility table: + +| Java client version | Socket.IO server | +| -------------- | ---------------- | +| 0.9.x | 1.x | +| 1.x | 2.x (or 3.1.x / 4.x with [`allowEIO3: true`](https://socket.io/docs/v4/server-options/#alloweio3)) | +| 2.x | 3.x / 4.x | + +**Important note:** due to the backward incompatible changes to the Socket.IO protocol, a 2.x Java client will not be able to reach a 2.x server, and vice-versa + +Since the Java client matches the Javascript client quite closely, most of the changes listed in the migration guide [here](https://socket.io/docs/v4/migrating-from-2-x-to-3-0) also apply to the Java client: + +- [A middleware error will now emit an Error object](#A_middleware_error_will_now_emit_an_Error_object) +- [The Socket `query` option is renamed to `auth`](#The_Socket_query_option_is_renamed_to_auth) +- [The Socket instance will no longer forward the events emitted by its Manager](#The_Socket_instance_will_no_longer_forward_the_events_emitted_by_its_Manager) +- [No more "pong" event](#No_more_.E2.80.9Cpong.E2.80.9D_event) + +Additional changes which are specific to the Java client: + +- [An `extraHeaders` option is now available](#An_extraHeaders_option_is_now_available) + +### A middleware error will now emit an Error object + +The `ERROR` event is renamed to `CONNECT_ERROR` and the object emitted is now a `JSONObject`: + +Before: + +```java +socket.on(Socket.EVENT_ERROR, new Emitter.Listener() { + @Override + public void call(Object... args) { + String error = (String) args[0]; + System.out.println(error); // not authorized + } +}); +``` + +After: + +```java +socket.on(Socket.EVENT_CONNECT_ERROR, new Emitter.Listener() { + @Override + public void call(Object... args) { + JSONObject error = (JSONObject) args[0]; + String message = error.getString("message"); + System.out.println(error); // not authorized + + JSONObject data = error.getJSONObject("data"); // additional details (optional) + } +}); +``` + + +### The Socket `query` option is renamed to `auth` + +In previous versions, the `query` option was used in two distinct places: + +- in the query parameters of the HTTP requests (`GET /socket.io/?EIO=3&abc=def`) +- in the Socket.IO handshake + +Which could lead to unexpected behaviors. + +New syntax: + +```java +IO.Options options = new IO.Options(); +options.query = singletonMap("abc", singletonList("def")); // included in the query parameters +options.auth = singletonMap("token", singletonList("1234")); // included in the Socket.IO handshake + +Socket socket = IO.socket("https://example.com", options); +``` + +### The Socket instance will no longer forward the events emitted by its Manager + +In previous versions, the Socket instance emitted the events related to the state of the underlying connection. This will not be the case anymore. + +You still have access to those events on the Manager instance (the `io()` method of the socket) : + +Before: + +```java +socket.on(Socket.EVENT_RECONNECT_ATTEMPT, new Emitter.Listener() { + @Override + public void call(Object... objects) { + // ... + } +}); +``` + +After: + +```java +socket.io().on(Manager.EVENT_RECONNECT_ATTEMPT, new Emitter.Listener() { + @Override + public void call(Object... objects) { + // ... + } +}); +``` + +Here is the updated list of events emitted by the Manager: + +| Name | Description | Previously (if different) | +| ---- | ----------- | ------------------------- | +| `Manager.EVENT_OPEN` | successful (re)connection | - | +| `Manager.EVENT_ERROR` | (re)connection failure or error after a successful connection | `Manager.EVENT_CONNECT_ERROR` & `Manager.EVENT_CONNECT_TIMEOUT` | +| `Manager.EVENT_CLOSE` | disconnection | - | +| `Manager.EVENT_RECONNECT_ATTEMPT` | reconnection attempt | `Manager.EVENT_RECONNECT_ATTEMPT` & `Manager.EVENT_RECONNECTING` (duplicate) | +| `Manager.EVENT_RECONNECT` | successful reconnection | - | +| `Manager.EVENT_RECONNECT_ERROR` | reconnection failure | - | +| `Manager.EVENT_RECONNECT_FAILED` | reconnection failure after all attempts | - | + +Here is the updated list of events emitted by the Socket: + +| Name | Description | Previously (if different) | +| ---- | ----------- | ------------------------- | +| `Socket.EVENT_CONNECT` | successful connection to a Namespace | - | +| `Socket.EVENT_CONNECT_ERROR` | connection failure | `Socket.EVENT_ERROR` | +| `Socket.EVENT_DISCONNECT` | disconnection | - | + + +And finally, here's the updated list of reserved events that you cannot use in your application: + +- `connect` (used on the client-side) +- `connect_error` (used on the client-side) +- `disconnect` (used on both sides) +- `disconnecting` (used on the server-side) +- `newListener` and `removeListener` (EventEmitter [reserved events](https://nodejs.org/api/events.html#events_event_newlistener)) + +```java +socket.emit("connect_error"); // will now throw an exception +``` + +### No more "pong" event + +In Socket.IO v2, you could listen to the `pong` event on the client-side, which included the duration of the last health check round-trip. + +Due to the reversal of the heartbeat mechanism (more information [here](https://socket.io/blog/engine-io-4-release/#Heartbeat-mechanism-reversal)), this event has been removed. + +Before: + +```java +socket.once(Socket.EVENT_PONG, new Emitter.Listener() { + @Override + public void call(Object... args) { + long latency = (long) args[0]; + // ... + } +}); +``` + +There is no similar API in the new release. + +### An `extraHeaders` option is now available + +This is a more straightforward way to provide headers that will be included in all HTTP requests. + +```java +IO.Options options = new IO.Options(); +options.extraHeaders = singletonMap("Authorization", singletonList("Bearer abcd")); + +Socket socket = IO.socket("https://example.com", options); +``` + +Or with the new builder syntax: + +```java +IO.Options options = IO.Options.builder() + .setExtraHeaders(singletonMap("Authorization", singletonList("Bearer abcd"))) + .build(); + +Socket socket = IO.socket("https://example.com", options); +``` diff --git a/src/site/markdown/socket_instance.md b/src/site/markdown/socket_instance.md new file mode 100644 index 00000000..5a40be45 --- /dev/null +++ b/src/site/markdown/socket_instance.md @@ -0,0 +1,158 @@ +# The Socket instance + +**Table of content** + + + +- [Javadoc](apidocs/index.html?io/socket/client/Socket.html) + +Besides [emitting](emitting_events.html) and [listening to](listening_to_events.html) events, the Socket instance has a few attributes that may be of use in your application: + +## Socket#id + +Each new connection is assigned a random 20-characters identifier. + +This identifier is synced with the value on the server-side. + +*Server* + +```js +io.on("connection", (socket) => { + console.log(socket.id); // x8WIv7-mJelg7on_ALbx +}); +``` + +*Client* + +```java +socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() { + @Override + public void call(Object... args) { + System.out.println(socket.id()); // x8WIv7-mJelg7on_ALbx + } +}); + +socket.on(Socket.EVENT_DISCONNECT, new Emitter.Listener() { + @Override + public void call(Object... args) { + System.out.println(socket.id()); // null + } +}); +``` + +## Socket#connected + +This attribute describes whether the socket is currently connected to the server. + +```java +socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() { + @Override + public void call(Object... args) { + System.out.println(socket.connected()); // true + } +}); + +socket.on(Socket.EVENT_DISCONNECT, new Emitter.Listener() { + @Override + public void call(Object... args) { + System.out.println(socket.connected()); // false + } +}); +``` + +## Lifecycle + +Lifecycle diagram + +## Events + +### `Socket.EVENT_CONNECT` + +This event is fired by the Socket instance upon connection / reconnection. + +```java +socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() { + @Override + public void call(Object... args) { + // ... + } +}); +``` + +Please note that you shouldn't register event handlers in the `connect` handler itself, as a new handler will be registered every time the Socket reconnects: + +```java +// BAD +socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() { + @Override + public void call(Object... args) { + socket.on("data", new Emitter.Listener() { + @Override + public void call(Object... args) { + // ... + } + }); + } +}); + +// GOOD +socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() { + @Override + public void call(Object... args) { + // ... + } +}); + +socket.on("data", new Emitter.Listener() { + @Override + public void call(Object... args) { + // ... + } +}); +``` + +### `Socket.EVENT_CONNECT_ERROR` + +This event is fired when the server does not accept the connection (in a [middleware function](https://socket.io/docs/v4/middlewares/#sending-credentials)). + +You need to manually reconnect. You might need to update the credentials: + +```java +socket.on(Socket.EVENT_CONNECT_ERROR, new Emitter.Listener() { + @Override + public void call(Object... args) { + options.auth.put("authorization", "bearer 1234"); + socket.connect(); + } +}); +``` + +### `Socket.EVENT_DISCONNECT` + +This event is fired upon disconnection. + +```java +socket.on(Socket.EVENT_DISCONNECT, new Emitter.Listener() { + @Override + public void call(Object... args) { + System.out.println(socket.id()); // null + } +}); +``` + +Here is the list of possible reasons: + +Reason | Description +------ | ----------- +`io server disconnect` | The server has forcefully disconnected the socket with [socket.disconnect()](https://socket.io/docs/v4/server-api/#socketdisconnectclose) +`io client disconnect` | The socket was manually disconnected using `socket.disconnect()` +`ping timeout` | The server did not respond in the `pingTimeout` range +`transport close` | The connection was closed (example: the user has lost connection, or the network was changed from WiFi to 4G) +`transport error` | The connection has encountered an error (example: the server was killed during a HTTP long-polling cycle) + +Note: those events, along with `disconnecting`, `newListener` and `removeListener`, are special events that shouldn't be used in your application: + +```js +// BAD, will throw an error +socket.emit("disconnect"); +``` diff --git a/src/site/markdown/usage.md b/src/site/markdown/usage.md new file mode 100644 index 00000000..977358bf --- /dev/null +++ b/src/site/markdown/usage.md @@ -0,0 +1,148 @@ +## Usage +Socket.IO-client Java has almost the same api and features with the original JS client. You use `IO#socket` to initialize `Socket`: + +```java +import client.com.kaleyra.socket_io.IO; +import client.com.kaleyra.socket_io.Socket; +... + +Socket socket = IO.socket("http://localhost"); +socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() { + + @Override + public void call(Object... args) { + socket.emit("foo", "hi"); + socket.disconnect(); + } + +}).on("event", new Emitter.Listener() { + + @Override + public void call(Object... args) {} + +}).on(Socket.EVENT_DISCONNECT, new Emitter.Listener() { + + @Override + public void call(Object... args) {} + +}); +socket.connect(); +``` + +This Library uses [org.json](https://github.com/stleary/JSON-java) to parse and compose JSON strings: + +```java +// Sending an object +JSONObject obj = new JSONObject(); +obj.put("hello", "server"); +obj.put("binary", new byte[42]); +socket.emit("foo", obj); + +// Receiving an object +socket.on("foo", new Emitter.Listener() { + @Override + public void call(Object... args) { + JSONObject obj = (JSONObject)args[0]; + } +}); +``` + +Options are supplied as follows: + +```java +IO.Options opts = new IO.Options(); +opts.forceNew = true; +opts.reconnection = false; + +socket = IO.socket("http://localhost", opts); +``` + +You can supply query parameters with the `query` option. NB: if you don't want to reuse a cached socket instance when the query parameter changes, you should use the `forceNew` option, the use case might be if your app allows for a user to logout, and a new user to login again: + +```java +IO.Options opts = new IO.Options(); +opts.forceNew = true; +opts.query = "auth_token=" + authToken; +Socket socket = IO.socket("http://localhost", opts); +``` + +You can get a callback with `Ack` when the server received a message: + +```java +socket.emit("foo", "woot", new Ack() { + @Override + public void call(Object... args) {} +}); +``` + +And vice versa: + +```java +// ack from client to server +socket.on("foo", new Emitter.Listener() { + @Override + public void call(Object... args) { + Ack ack = (Ack) args[args.length - 1]; + ack.call(); + } +}); +``` + +SSL (HTTPS, WSS) settings: + +```java +OkHttpClient okHttpClient = new OkHttpClient.Builder() + .hostnameVerifier(myHostnameVerifier) + .sslSocketFactory(mySSLContext.getSocketFactory(), myX509TrustManager) + .build(); + +// default settings for all sockets +IO.setDefaultOkHttpWebSocketFactory(okHttpClient); +IO.setDefaultOkHttpCallFactory(okHttpClient); + +// set as an option +opts = new IO.Options(); +opts.callFactory = okHttpClient; +opts.webSocketFactory = okHttpClient; +socket = IO.socket("https://localhost", opts); +``` + +See the Javadoc for more details. + +http://socketio.github.io/socket.io-client-java/apidocs/ + +### Transports and HTTP Headers +You can access transports and their HTTP headers as follows. + +```java +// Called upon transport creation. +socket.io().on(Manager.EVENT_TRANSPORT, new Emitter.Listener() { + @Override + public void call(Object... args) { + Transport transport = (Transport)args[0]; + + transport.on(Transport.EVENT_REQUEST_HEADERS, new Emitter.Listener() { + @Override + public void call(Object... args) { + @SuppressWarnings("unchecked") + Map> headers = (Map>)args[0]; + // modify request headers + headers.put("Cookie", Arrays.asList("foo=1;")); + } + }); + + transport.on(Transport.EVENT_RESPONSE_HEADERS, new Emitter.Listener() { + @Override + public void call(Object... args) { + @SuppressWarnings("unchecked") + Map> headers = (Map>)args[0]; + // access response headers + String cookie = headers.get("Set-Cookie").get(0); + } + }); + } +}); +``` + +## Features +This library supports all of the features the JS client does, including events, options and upgrading transport. Android is fully supported. diff --git a/src/site/resources/images/client_socket_events.png b/src/site/resources/images/client_socket_events.png new file mode 100644 index 00000000..c2ea34cc Binary files /dev/null and b/src/site/resources/images/client_socket_events.png differ diff --git a/src/site/site.xml b/src/site/site.xml new file mode 100644 index 00000000..3f81c927 --- /dev/null +++ b/src/site/site.xml @@ -0,0 +1,42 @@ + + + + + org.apache.maven.skins + maven-fluido-skin + 1.9 + + + + Socket.IO Java client + + + + + + socketio/socket.io-client-java + right + gray + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/src/test/java/io/socket/backo/BackoffTest.java b/src/test/java/com/kaleyra/socket_io/backo/BackoffTest.java similarity index 97% rename from src/test/java/io/socket/backo/BackoffTest.java rename to src/test/java/com/kaleyra/socket_io/backo/BackoffTest.java index a268829f..4c545ff5 100644 --- a/src/test/java/io/socket/backo/BackoffTest.java +++ b/src/test/java/com/kaleyra/socket_io/backo/BackoffTest.java @@ -1,4 +1,4 @@ -package io.socket.backo; +package com.kaleyra.socket_io.backo; import org.junit.Test; diff --git a/src/test/java/io/socket/client/Connection.java b/src/test/java/com/kaleyra/socket_io/client/Connection.java similarity index 86% rename from src/test/java/io/socket/client/Connection.java rename to src/test/java/com/kaleyra/socket_io/client/Connection.java index 9e7bf8c6..7dd63bc1 100644 --- a/src/test/java/io/socket/client/Connection.java +++ b/src/test/java/com/kaleyra/socket_io/client/Connection.java @@ -1,4 +1,4 @@ -package io.socket.client; +package com.kaleyra.socket_io.client; import org.junit.After; import org.junit.Before; @@ -6,7 +6,7 @@ import java.io.BufferedReader; import java.io.IOException; import java.io.InputStreamReader; -import java.net.URISyntaxException; +import java.net.URI; import java.util.HashMap; import java.util.Map; import java.util.concurrent.*; @@ -77,24 +77,24 @@ public void stopServer() throws InterruptedException { serverService.awaitTermination(3000, TimeUnit.MILLISECONDS); } - Socket client() throws URISyntaxException { + Socket client() { return client(createOptions()); } - Socket client(String path) throws URISyntaxException { + Socket client(String path) { return client(path, createOptions()); } - Socket client(IO.Options opts) throws URISyntaxException { + Socket client(IO.Options opts) { return client(nsp(), opts); } - Socket client(String path, IO.Options opts) throws URISyntaxException { - return IO.socket(uri() + path, opts); + Socket client(String path, IO.Options opts) { + return IO.socket(URI.create(uri() + path), opts); } - String uri() { - return "http://localhost:" + PORT; + URI uri() { + return URI.create("http://localhost:" + PORT); } String nsp() { @@ -104,11 +104,12 @@ String nsp() { IO.Options createOptions() { IO.Options opts = new IO.Options(); opts.forceNew = true; + opts.reconnection = true; return opts; } String[] createEnv() { - Map env = new HashMap(System.getenv()); + Map env = new HashMap<>(System.getenv()); env.put("DEBUG", "socket.io:*"); env.put("PORT", String.valueOf(PORT)); String[] _env = new String[env.size()]; diff --git a/src/test/java/io/socket/client/ConnectionTest.java b/src/test/java/com/kaleyra/socket_io/client/ConnectionTest.java similarity index 85% rename from src/test/java/io/socket/client/ConnectionTest.java rename to src/test/java/com/kaleyra/socket_io/client/ConnectionTest.java index 728d48fc..12b7cb7a 100644 --- a/src/test/java/io/socket/client/ConnectionTest.java +++ b/src/test/java/com/kaleyra/socket_io/client/ConnectionTest.java @@ -1,6 +1,6 @@ -package io.socket.client; +package com.kaleyra.socket_io.client; -import io.socket.emitter.Emitter; +import com.kaleyra.socket_io.emitter.Emitter; import org.json.JSONException; import org.json.JSONObject; import org.junit.Assert; @@ -29,8 +29,8 @@ public class ConnectionTest extends Connection { private Socket socket; @Test(timeout = TIMEOUT) - public void connectToLocalhost() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void connectToLocalhost() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); socket = client(); socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() { @Override @@ -50,7 +50,7 @@ public void call(Object... args) { } @Test(timeout = TIMEOUT) - public void startTwoConnectionsWithSamePath() throws URISyntaxException, InterruptedException { + public void startTwoConnectionsWithSamePath() throws InterruptedException { Socket s1 = client("/"); Socket s2 = client("/"); @@ -60,7 +60,7 @@ public void startTwoConnectionsWithSamePath() throws URISyntaxException, Interru } @Test(timeout = TIMEOUT) - public void startTwoConnectionsWithSamePathAndDifferentQuerystrings() throws URISyntaxException, InterruptedException { + public void startTwoConnectionsWithSamePathAndDifferentQuerystrings() throws InterruptedException { Socket s1 = client("/?woot"); Socket s2 = client("/"); @@ -70,8 +70,8 @@ public void startTwoConnectionsWithSamePathAndDifferentQuerystrings() throws URI } @Test(timeout = TIMEOUT) - public void workWithAcks() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void workWithAcks() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); socket = client(); socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() { @Override @@ -111,8 +111,8 @@ public void call(Object... args) { } @Test(timeout = TIMEOUT) - public void receiveDateWithAck() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void receiveDateWithAck() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); socket = client(); socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() { @@ -136,8 +136,8 @@ public void call(Object... args) { } @Test(timeout = TIMEOUT) - public void sendBinaryAck() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void sendBinaryAck() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); final byte[] buf = "huehue".getBytes(Charset.forName("UTF-8")); socket = client(); @@ -168,8 +168,8 @@ public void call(Object... args) { } @Test(timeout = TIMEOUT) - public void receiveBinaryDataWithAck() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void receiveBinaryDataWithAck() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); final byte[] buf = "huehue".getBytes(Charset.forName("UTF-8")); socket = client(); @@ -191,8 +191,8 @@ public void call(Object... args) { } @Test(timeout = TIMEOUT) - public void workWithFalse() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void workWithFalse() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); socket = client(); socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() { @Override @@ -212,8 +212,8 @@ public void call(Object... args) { } @Test(timeout = TIMEOUT) - public void receiveUTF8MultibyteCharacters() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void receiveUTF8MultibyteCharacters() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); final String[] correct = new String[] { "てすと", "Я Б Г Д Ж Й", @@ -245,9 +245,9 @@ public void call(Object... args) { } @Test(timeout = TIMEOUT) - public void connectToNamespaceAfterConnectionEstablished() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); - final Manager manager = new Manager(new URI(uri())); + public void connectToNamespaceAfterConnectionEstablished() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); + final Manager manager = new Manager(uri()); socket = manager.socket("/"); socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() { @Override @@ -270,9 +270,9 @@ public void call(Object... args) { } @Test(timeout = TIMEOUT) - public void connectToNamespaceAfterConnectionGetsClosed() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); - final Manager manager = new Manager(new URI(uri())); + public void connectToNamespaceAfterConnectionGetsClosed() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); + final Manager manager = new Manager(uri()); socket = manager.socket("/"); socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() { @Override @@ -299,8 +299,8 @@ public void call(Object... args) { } @Test(timeout = TIMEOUT) - public void reconnectByDefault() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void reconnectByDefault() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); socket = client(); socket.io().on(Manager.EVENT_RECONNECT, new Emitter.Listener() { @Override @@ -320,8 +320,8 @@ public void run() { } @Test(timeout = TIMEOUT) - public void reconnectManually() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void reconnectManually() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); socket = client(); socket.once(Socket.EVENT_CONNECT, new Emitter.Listener() { @Override @@ -346,8 +346,8 @@ public void call(Object... args) { } @Test(timeout = TIMEOUT) - public void reconnectAutomaticallyAfterReconnectingManually() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void reconnectAutomaticallyAfterReconnectingManually() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); socket = client(); socket.once(Socket.EVENT_CONNECT, new Emitter.Listener() { @Override @@ -357,7 +357,7 @@ public void call(Object... args) { }).once(Socket.EVENT_DISCONNECT, new Emitter.Listener() { @Override public void call(Object... args) { - socket.on(Socket.EVENT_RECONNECT, new Emitter.Listener() { + socket.io().on(Manager.EVENT_RECONNECT, new Emitter.Listener() { @Override public void call(Object... args) { socket.disconnect(); @@ -378,16 +378,16 @@ public void run() { } @Test(timeout = 14000) - public void attemptReconnectsAfterAFailedReconnect() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void attemptReconnectsAfterAFailedReconnect() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); IO.Options opts = createOptions(); opts.reconnection = true; opts.timeout = 0; opts.reconnectionAttempts = 2; opts.reconnectionDelay = 10; - final Manager manager = new Manager(new URI(uri()), opts); + final Manager manager = new Manager(uri(), opts); socket = manager.socket("/timeout"); - socket.once(Socket.EVENT_RECONNECT_FAILED, new Emitter.Listener() { + manager.once(Manager.EVENT_RECONNECT_FAILED, new Emitter.Listener() { @Override public void call(Object... args) { final int[] reconnects = new int[] {0}; @@ -415,15 +415,15 @@ public void call(Object... args) { } @Test(timeout = TIMEOUT) - public void reconnectDelayShouldIncreaseEveryTime() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void reconnectDelayShouldIncreaseEveryTime() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); IO.Options opts = createOptions(); opts.reconnection = true; opts.timeout = 0; opts.reconnectionAttempts = 3; opts.reconnectionDelay = 100; opts.randomizationFactor = 0.2; - final Manager manager = new Manager(new URI(uri()), opts); + final Manager manager = new Manager(uri(), opts); socket = manager.socket("/timeout"); final int[] reconnects = new int[] {0}; @@ -431,13 +431,13 @@ public void reconnectDelayShouldIncreaseEveryTime() throws URISyntaxException, I final long[] startTime = new long[] {0}; final long[] prevDelay = new long[] {0}; - socket.on(Socket.EVENT_CONNECT_ERROR, new Emitter.Listener() { + manager.on(Manager.EVENT_ERROR, new Emitter.Listener() { @Override public void call(Object... args) { startTime[0] = new Date().getTime(); } }); - socket.on(Socket.EVENT_RECONNECT_ATTEMPT, new Emitter.Listener() { + manager.on(Manager.EVENT_RECONNECT_ATTEMPT, new Emitter.Listener() { @Override public void call(Object... args) { reconnects[0]++; @@ -449,7 +449,7 @@ public void call(Object... args) { prevDelay[0] = delay; } }); - socket.on(Socket.EVENT_RECONNECT_FAILED, new Emitter.Listener() { + manager.on(Manager.EVENT_RECONNECT_FAILED, new Emitter.Listener() { @Override public void call(Object... args) { values.offer(true); @@ -464,38 +464,17 @@ public void call(Object... args) { manager.close(); } - @Test(timeout = TIMEOUT) - public void reconnectEventFireInSocket() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); - socket = client(); - socket.on(Socket.EVENT_RECONNECT, new Emitter.Listener() { - @Override - public void call(Object... objects) { - values.offer("done"); - } - }); - socket.open(); - new Timer().schedule(new TimerTask() { - @Override - public void run() { - socket.io().engine.close(); - } - }, 500); - values.take(); - socket.close(); - } - @Test(timeout = TIMEOUT) public void notReconnectWhenForceClosed() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + final BlockingQueue values = new LinkedBlockingQueue<>(); IO.Options opts = createOptions(); opts.timeout = 0; opts.reconnectionDelay = 10; socket = IO.socket(uri() + "/invalid", opts); - socket.on(Socket.EVENT_CONNECT_ERROR, new Emitter.Listener() { + socket.io().on(Manager.EVENT_ERROR, new Emitter.Listener() { @Override public void call(Object... args) { - socket.on(Socket.EVENT_RECONNECT_ATTEMPT, new Emitter.Listener() { + socket.io().on(Manager.EVENT_RECONNECT_ATTEMPT, new Emitter.Listener() { @Override public void call(Object... args) { values.offer(false); @@ -516,15 +495,15 @@ public void run() { @Test(timeout = TIMEOUT) public void stopReconnectingWhenForceClosed() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + final BlockingQueue values = new LinkedBlockingQueue<>(); IO.Options opts = createOptions(); opts.timeout = 0; opts.reconnectionDelay = 10; socket = IO.socket(uri() + "/invalid", opts); - socket.once(Socket.EVENT_RECONNECT_ATTEMPT, new Emitter.Listener() { + socket.io().once(Manager.EVENT_RECONNECT_ATTEMPT, new Emitter.Listener() { @Override public void call(Object... args) { - socket.on(Socket.EVENT_RECONNECT_ATTEMPT, new Emitter.Listener() { + socket.io().on(Manager.EVENT_RECONNECT_ATTEMPT, new Emitter.Listener() { @Override public void call(Object... args) { values.offer(false); @@ -545,17 +524,17 @@ public void run() { } @Test(timeout = TIMEOUT) - public void reconnectAfterStoppingReconnection() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void reconnectAfterStoppingReconnection() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); IO.Options opts = createOptions(); opts.forceNew = true; opts.timeout = 0; opts.reconnectionDelay = 10; socket = client("/invalid", opts); - socket.once(Socket.EVENT_RECONNECT_ATTEMPT, new Emitter.Listener() { + socket.io().once(Manager.EVENT_RECONNECT_ATTEMPT, new Emitter.Listener() { @Override public void call(Object... args) { - socket.once(Socket.EVENT_RECONNECT_ATTEMPT, new Emitter.Listener() { + socket.io().once(Manager.EVENT_RECONNECT_ATTEMPT, new Emitter.Listener() { @Override public void call(Object... args) { values.offer("done"); @@ -571,9 +550,9 @@ public void call(Object... args) { } @Test(timeout = TIMEOUT) - public void stopReconnectingOnASocketAndKeepToReconnectOnAnother() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); - final Manager manager = new Manager(new URI(uri())); + public void stopReconnectingOnASocketAndKeepToReconnectOnAnother() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); + final Manager manager = new Manager(uri()); final Socket socket1 = manager.socket("/"); final Socket socket2 = manager.socket("/asd"); @@ -617,10 +596,10 @@ public void run() { } @Test(timeout = TIMEOUT) - public void connectWhileDisconnectingAnotherSocket() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void connectWhileDisconnectingAnotherSocket() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); - final Manager manager = new Manager(new URI(uri())); + final Manager manager = new Manager(uri()); final Socket socket1 = manager.socket("/foo"); socket1.on(Socket.EVENT_CONNECT, new Emitter.Listener() { @Override @@ -644,13 +623,13 @@ public void call(Object... args) { } @Test(timeout = TIMEOUT) - public void tryToReconnectTwiceAndFailWithIncorrectAddress() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void tryToReconnectTwiceAndFailWithIncorrectAddress() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); IO.Options opts = new IO.Options(); opts.reconnection = true; opts.reconnectionAttempts = 2; opts.reconnectionDelay = 10; - final Manager manager = new Manager(new URI("http://localhost:3940"), opts); + final Manager manager = new Manager(URI.create("http://localhost:3940"), opts); socket = manager.socket("/asd"); final int[] reconnects = new int[] {0}; Emitter.Listener cb = new Emitter.Listener() { @@ -676,14 +655,14 @@ public void call(Object... objects) { } @Test(timeout = TIMEOUT) - public void tryToReconnectTwiceAndFailWithImmediateTimeout() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void tryToReconnectTwiceAndFailWithImmediateTimeout() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); IO.Options opts = new IO.Options(); opts.reconnection = true; opts.timeout = 0; opts.reconnectionAttempts = 2; opts.reconnectionDelay = 10; - final Manager manager = new Manager(new URI(uri()), opts); + final Manager manager = new Manager(uri(), opts); final int[] reconnects = new int[] {0}; Emitter.Listener reconnectCb = new Emitter.Listener() { @@ -709,11 +688,11 @@ public void call(Object... objects) { } @Test(timeout = TIMEOUT) - public void notTryToReconnectWithIncorrectPortWhenReconnectionDisabled() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void notTryToReconnectWithIncorrectPortWhenReconnectionDisabled() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); IO.Options opts = new IO.Options(); opts.reconnection = false; - final Manager manager = new Manager(new URI("http://localhost:9823"), opts); + final Manager manager = new Manager(URI.create("http://localhost:9823"), opts); Emitter.Listener cb = new Emitter.Listener() { @Override public void call(Object... objects) { @@ -722,7 +701,7 @@ public void call(Object... objects) { } }; manager.on(Manager.EVENT_RECONNECT_ATTEMPT, cb); - manager.on(Manager.EVENT_CONNECT_ERROR, new Emitter.Listener() { + manager.on(Manager.EVENT_ERROR, new Emitter.Listener() { @Override public void call(Object... objects) { Timer timer = new Timer(); @@ -743,15 +722,15 @@ public void run() { } @Test(timeout = TIMEOUT) - public void fireReconnectEventsOnSocket() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void fireReconnectEventsOnSocket() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); Manager.Options opts = new Manager.Options(); opts.reconnection = true; opts.timeout = 0; opts.reconnectionAttempts = 2; opts.reconnectionDelay = 10; - final Manager manager = new Manager(new URI(uri()), opts); + final Manager manager = new Manager(uri(), opts); socket = manager.socket("/timeout_socket"); final int[] reconnects = new int[] {0}; @@ -763,8 +742,8 @@ public void call(Object... args) { } }; - socket.on(Socket.EVENT_RECONNECT_ATTEMPT, reconnectCb); - socket.on(Socket.EVENT_RECONNECT_FAILED, new Emitter.Listener() { + manager.on(Manager.EVENT_RECONNECT_ATTEMPT, reconnectCb); + manager.on(Manager.EVENT_RECONNECT_FAILED, new Emitter.Listener() { @Override public void call(Object... objects) { socket.close(); @@ -778,15 +757,15 @@ public void call(Object... objects) { } @Test(timeout = TIMEOUT) - public void fireReconnectingWithAttemptsNumberWhenReconnectingTwice() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void fireReconnectingWithAttemptsNumberWhenReconnectingTwice() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); Manager.Options opts = new Manager.Options(); opts.reconnection = true; opts.timeout = 0; opts.reconnectionAttempts = 2; opts.reconnectionDelay = 10; - final Manager manager = new Manager(new URI(uri()), opts); + final Manager manager = new Manager(uri(), opts); socket = manager.socket("/timeout_socket"); final int[] reconnects = new int[] {0}; @@ -798,8 +777,8 @@ public void call(Object... args) { } }; - socket.on(Socket.EVENT_RECONNECTING, reconnectCb); - socket.on(Socket.EVENT_RECONNECT_FAILED, new Emitter.Listener() { + manager.on(Manager.EVENT_RECONNECT_ATTEMPT, reconnectCb); + manager.on(Manager.EVENT_RECONNECT_FAILED, new Emitter.Listener() { @Override public void call(Object... objects) { socket.close(); @@ -813,8 +792,8 @@ public void call(Object... objects) { } @Test(timeout = TIMEOUT) - public void emitDateAsString() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void emitDateAsString() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); socket = client(); socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() { @Override @@ -834,8 +813,8 @@ public void call(Object... args) { } @Test(timeout = TIMEOUT) - public void emitDateInObject() throws URISyntaxException, InterruptedException, JSONException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void emitDateInObject() throws InterruptedException, JSONException { + final BlockingQueue values = new LinkedBlockingQueue<>(); socket = client(); socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() { @Override @@ -864,8 +843,8 @@ public void call(Object... args) { @Test(timeout = TIMEOUT) - public void sendAndGetBinaryData() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void sendAndGetBinaryData() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); final byte[] buf = "asdfasdf".getBytes(Charset.forName("UTF-8")); socket = client(); socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() { @@ -886,8 +865,8 @@ public void call(Object... args) { } @Test(timeout = TIMEOUT) - public void sendBinaryDataMixedWithJson() throws URISyntaxException, InterruptedException, JSONException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void sendBinaryDataMixedWithJson() throws InterruptedException, JSONException { + final BlockingQueue values = new LinkedBlockingQueue<>(); final byte[] buf = "howdy".getBytes(Charset.forName("UTF-8")); socket = client(); socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() { @@ -920,7 +899,7 @@ public void call(Object... args) { @Test(timeout = TIMEOUT) public void sendEventsWithByteArraysInTheCorrectOrder() throws Exception { - final BlockingQueue values = new LinkedBlockingQueue(); + final BlockingQueue values = new LinkedBlockingQueue<>(); final byte[] buf = "abuff1".getBytes(Charset.forName("UTF-8")); socket = client(); socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() { diff --git a/src/test/java/io/socket/client/ExecutionTest.java b/src/test/java/com/kaleyra/socket_io/client/ExecutionTest.java similarity index 85% rename from src/test/java/io/socket/client/ExecutionTest.java rename to src/test/java/com/kaleyra/socket_io/client/ExecutionTest.java index b4bf6a7e..81fc63d7 100644 --- a/src/test/java/io/socket/client/ExecutionTest.java +++ b/src/test/java/com/kaleyra/socket_io/client/ExecutionTest.java @@ -1,4 +1,4 @@ -package io.socket.client; +package com.kaleyra.socket_io.client; import org.junit.Test; import org.junit.runner.RunWith; @@ -21,17 +21,17 @@ public class ExecutionTest extends Connection { @Test(timeout = TIMEOUT) public void execConnection() throws InterruptedException, IOException { - exec("io.socket.client.executions.Connection"); + exec("com.kaleyra.socket_io.client.executions.Connection"); } @Test(timeout = TIMEOUT) public void execConnectionFailure() throws InterruptedException, IOException { - exec("io.socket.client.executions.ConnectionFailure"); + exec("com.kaleyra.socket_io.client.executions.ConnectionFailure"); } @Test(timeout = TIMEOUT) public void execImmediateClose() throws InterruptedException, IOException { - exec("io.socket.client.executions.ImmediateClose"); + exec("com.kaleyra.socket_io.client.executions.ImmediateClose"); } private void exec(String mainClass) throws InterruptedException, IOException { diff --git a/src/test/java/io/socket/client/SSLConnectionTest.java b/src/test/java/com/kaleyra/socket_io/client/SSLConnectionTest.java similarity index 94% rename from src/test/java/io/socket/client/SSLConnectionTest.java rename to src/test/java/com/kaleyra/socket_io/client/SSLConnectionTest.java index f0decc89..0ff8e8a4 100644 --- a/src/test/java/io/socket/client/SSLConnectionTest.java +++ b/src/test/java/com/kaleyra/socket_io/client/SSLConnectionTest.java @@ -1,6 +1,6 @@ -package io.socket.client; +package com.kaleyra.socket_io.client; -import io.socket.emitter.Emitter; +import com.kaleyra.socket_io.emitter.Emitter; import okhttp3.OkHttpClient; import org.junit.After; import org.junit.Test; @@ -16,6 +16,7 @@ import java.io.File; import java.io.FileInputStream; import java.io.IOException; +import java.net.URI; import java.security.GeneralSecurityException; import java.security.KeyStore; import java.util.concurrent.BlockingQueue; @@ -39,8 +40,8 @@ public class SSLConnectionTest extends Connection { } @Override - String uri() { - return "https://localhost:" + PORT; + URI uri() { + return URI.create("https://localhost:" + PORT); } @Override @@ -66,7 +67,7 @@ private static void prepareOkHttpClient() throws GeneralSecurityException, IOExc TrustManagerFactory tmf = TrustManagerFactory.getInstance("SunX509"); tmf.init(ks); - SSLContext sslContext = SSLContext.getInstance("TLSv1"); + SSLContext sslContext = SSLContext.getInstance("TLS"); sslContext.init(kmf.getKeyManagers(), tmf.getTrustManagers(), null); sOkHttpClient = new OkHttpClient.Builder() @@ -88,7 +89,7 @@ public void tearDown() { @Test(timeout = TIMEOUT) public void connect() throws Exception { - final BlockingQueue values = new LinkedBlockingQueue(); + final BlockingQueue values = new LinkedBlockingQueue<>(); IO.Options opts = createOptions(); opts.callFactory = sOkHttpClient; opts.webSocketFactory = sOkHttpClient; @@ -112,7 +113,7 @@ public void call(Object... args) { @Test(timeout = TIMEOUT) public void defaultSSLContext() throws Exception { - final BlockingQueue values = new LinkedBlockingQueue(); + final BlockingQueue values = new LinkedBlockingQueue<>(); IO.setDefaultOkHttpWebSocketFactory(sOkHttpClient); IO.setDefaultOkHttpCallFactory(sOkHttpClient); socket = client(); diff --git a/src/test/java/io/socket/client/ServerConnectionNamespaceTest.java b/src/test/java/com/kaleyra/socket_io/client/ServerConnectionNamespaceTest.java similarity index 85% rename from src/test/java/io/socket/client/ServerConnectionNamespaceTest.java rename to src/test/java/com/kaleyra/socket_io/client/ServerConnectionNamespaceTest.java index 46974b02..26b80b38 100644 --- a/src/test/java/io/socket/client/ServerConnectionNamespaceTest.java +++ b/src/test/java/com/kaleyra/socket_io/client/ServerConnectionNamespaceTest.java @@ -1,4 +1,4 @@ -package io.socket.client; +package com.kaleyra.socket_io.client; import org.junit.runner.RunWith; import org.junit.runners.JUnit4; diff --git a/src/test/java/io/socket/client/ServerConnectionTest.java b/src/test/java/com/kaleyra/socket_io/client/ServerConnectionTest.java similarity index 69% rename from src/test/java/io/socket/client/ServerConnectionTest.java rename to src/test/java/com/kaleyra/socket_io/client/ServerConnectionTest.java index 6c421a1b..b69e4d92 100644 --- a/src/test/java/io/socket/client/ServerConnectionTest.java +++ b/src/test/java/com/kaleyra/socket_io/client/ServerConnectionTest.java @@ -1,15 +1,15 @@ -package io.socket.client; +package com.kaleyra.socket_io.client; -import io.socket.emitter.Emitter; -import io.socket.engineio.client.Transport; -import io.socket.engineio.client.transports.Polling; -import io.socket.engineio.client.transports.WebSocket; +import com.kaleyra.socket_io.emitter.Emitter; +import com.kaleyra.socket_io.engineio.client.Transport; +import com.kaleyra.socket_io.engineio.client.transports.Polling; +import com.kaleyra.socket_io.engineio.client.transports.WebSocket; import org.json.JSONObject; import org.junit.Test; import org.junit.runner.RunWith; import org.junit.runners.JUnit4; -import java.net.URISyntaxException; +import java.util.*; import java.util.Arrays; import java.util.List; import java.util.Map; @@ -18,6 +18,7 @@ import static org.hamcrest.CoreMatchers.*; import static org.junit.Assert.assertThat; +import static org.junit.Assert.assertTrue; @RunWith(JUnit4.class) public class ServerConnectionTest extends Connection { @@ -26,8 +27,8 @@ public class ServerConnectionTest extends Connection { private Socket socket2; @Test(timeout = TIMEOUT) - public void openAndClose() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void openAndClose() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); socket = client(); socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() { @@ -51,8 +52,8 @@ public void call(Object... args) { } @Test(timeout = TIMEOUT) - public void message() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void message() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); socket = client(); socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() { @@ -75,7 +76,7 @@ public void call(Object... args) { @Test(timeout = TIMEOUT) public void event() throws Exception { - final BlockingQueue values = new LinkedBlockingQueue(); + final BlockingQueue values = new LinkedBlockingQueue<>(); final JSONObject obj = new JSONObject(); obj.put("foo", 1); @@ -104,7 +105,7 @@ public void call(Object... args) { @Test(timeout = TIMEOUT) public void ack() throws Exception { - final BlockingQueue values = new LinkedBlockingQueue(); + final BlockingQueue values = new LinkedBlockingQueue<>(); final JSONObject obj = new JSONObject(); obj.put("foo", 1); @@ -130,10 +131,118 @@ public void call(Object... args) { socket.disconnect(); } + /** + * TestCase: + * -> Server has not implemented the `ackNotImplemented` + * -> server will never answer to client + * -> client decides that the callback for him is useful if received in 2 seconds + * -> client will receive NoAck as response after 2 seconds, because server did not respond + */ + @Test(timeout = TIMEOUT) + public void noack() throws Exception { + final BlockingQueue values = new LinkedBlockingQueue(); + + final JSONObject obj = new JSONObject(); + obj.put("foo", 1); + + socket = client(); + socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() { + @Override + public void call(Object... objects) { + + socket.emit("ackNotImplemented", new Object[]{obj, "bar"}, new AckWithTimeOut(2000) { + @Override + public void call(Object... args) { + values.offer(args); + } + }); + + } + }); + + socket.connect(); + + Object[] args = (Object[]) values.take(); + assertTrue(args[0] instanceof NoAck); + socket.disconnect(); + } + + /** + * TestCase: + * -> Server has not implemented the `ackNotImplemented` + * -> server will never answer to client + * -> client decides that the callback for him is useful if received in 1 second + * -> Client got disconnected, because of a network issue + * -> keeps sending emits, which will be put in the buffer to be sent after the reconnection + * -> onReconnection he expects the results of all his emits otherwise a NoAck after 1 second + *

+ * NOTE: + * If we don't have the ack timeout, this test and all other emit-tests which expect a callback will fail for TIMEOUT + */ @Test(timeout = TIMEOUT) - public void ackWithoutArgs() throws URISyntaxException, InterruptedException { + public void noackWithReconnect() throws Exception { final BlockingQueue values = new LinkedBlockingQueue(); + // disconnect after 2 seconds + simulateReconnection(2000); + + socket = client(); + socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() { + @Override + public void call(Object... objects) { + + // make 4 emits delayed one from the other, and each will have a timeout of 1 second + for (int i = 0; i < 4; i++) { + + final Timer emitTimer = new Timer(); + final int pos = i; + emitTimer.schedule(new TimerTask() { + @Override + public void run() { + socket.emit("ackNotImplemented", "emit number " + pos, new AckWithTimeOut(1000) { + @Override + public void call(Object... args) { + values.offer(args); + } + }); + } + }, i * 1000); + + } + } + + }); + + socket.connect(); + // make sure we have received 4 NoAcks + assertTrue(((Object[]) values.take())[0] instanceof NoAck); + assertTrue(((Object[]) values.take())[0] instanceof NoAck); + assertTrue(((Object[]) values.take())[0] instanceof NoAck); + assertTrue(((Object[]) values.take())[0] instanceof NoAck); + + socket.disconnect(); + } + + /** + * Simulate the socket reconnection + * + * @param after milliseconds, when to start the reconnection + */ + private void simulateReconnection(long after) { + final Timer timer = new Timer(); + timer.schedule(new TimerTask() { + @Override + public void run() { + // simulate reconnect... + socket.io().engine.close(); + } + }, after); + } + + @Test(timeout = TIMEOUT) + public void ackWithoutArgs() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); + socket = client(); socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() { @Override @@ -153,8 +262,8 @@ public void call(Object... args) { } @Test(timeout = TIMEOUT) - public void ackWithoutArgsFromClient() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void ackWithoutArgsFromClient() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); socket = client(); socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() { @@ -188,14 +297,14 @@ public void call(Object... args) { } @Test(timeout = TIMEOUT) - public void closeEngineConnection() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void closeEngineConnection() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); socket = client(); socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() { @Override public void call(Object... args) { - socket.io().engine.on(io.socket.engineio.client.Socket.EVENT_CLOSE, new Emitter.Listener() { + socket.io().engine.on(com.kaleyra.socket_io.engineio.client.Socket.EVENT_CLOSE, new Emitter.Listener() { @Override public void call(Object... objects) { values.offer("done"); @@ -209,18 +318,14 @@ public void call(Object... objects) { } @Test(timeout = TIMEOUT) - public void broadcast() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void broadcast() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); socket = client(); socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() { @Override public void call(Object... objects) { - try { - socket2 = client(); - } catch (URISyntaxException e) { - throw new RuntimeException(e); - } + socket2 = client(); socket2.on(Socket.EVENT_CONNECT, new Emitter.Listener() { @Override @@ -246,8 +351,8 @@ public void call(Object... args) { } @Test(timeout = TIMEOUT) - public void room() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void room() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); socket = client(); socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() { @@ -270,8 +375,8 @@ public void call(Object... args) { } @Test(timeout = TIMEOUT) - public void pollingHeaders() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void pollingHeaders() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); IO.Options opts = createOptions(); opts.transports = new String[] {Polling.NAME}; @@ -305,8 +410,8 @@ public void call(Object... args) { } @Test(timeout = TIMEOUT) - public void websocketHandshakeHeaders() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void websocketHandshakeHeaders() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); IO.Options opts = createOptions(); opts.transports = new String[] {WebSocket.NAME}; @@ -340,8 +445,8 @@ public void call(Object... args) { } @Test(timeout = TIMEOUT) - public void disconnectFromServer() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void disconnectFromServer() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); socket = client(); socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() { diff --git a/src/test/java/io/socket/client/SocketTest.java b/src/test/java/com/kaleyra/socket_io/client/SocketTest.java similarity index 63% rename from src/test/java/io/socket/client/SocketTest.java rename to src/test/java/com/kaleyra/socket_io/client/SocketTest.java index aa94e700..0e3ae95c 100644 --- a/src/test/java/io/socket/client/SocketTest.java +++ b/src/test/java/com/kaleyra/socket_io/client/SocketTest.java @@ -1,23 +1,23 @@ -package io.socket.client; +package com.kaleyra.socket_io.client; -import io.socket.emitter.Emitter; -import io.socket.util.Optional; +import com.kaleyra.socket_io.emitter.Emitter; +import com.kaleyra.socket_io.util.Optional; import org.json.JSONException; import org.json.JSONObject; import org.junit.Test; import org.junit.runner.RunWith; import org.junit.runners.JUnit4; -import java.net.URISyntaxException; import java.util.Timer; import java.util.TimerTask; import java.util.concurrent.BlockingQueue; import java.util.concurrent.LinkedBlockingQueue; +import static java.util.Collections.singletonMap; import static org.hamcrest.CoreMatchers.is; import static org.hamcrest.CoreMatchers.not; -import static org.hamcrest.Matchers.greaterThan; import static org.junit.Assert.assertThat; +import static org.junit.Assert.fail; @RunWith(JUnit4.class) public class SocketTest extends Connection { @@ -25,8 +25,8 @@ public class SocketTest extends Connection { private Socket socket; @Test(timeout = TIMEOUT) - public void shouldHaveAnAccessibleSocketIdEqualToServerSideSocketId() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void shouldHaveAnAccessibleSocketIdEqualToServerSideSocketId() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); socket = client(); socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() { @Override @@ -39,13 +39,13 @@ public void call(Object... objects) { @SuppressWarnings("unchecked") Optional id = values.take(); assertThat(id.isPresent(), is(true)); - assertThat(id.get(), is(socket.io().engine.id())); + assertThat(id.get(), not(socket.io().engine.id())); // distinct ID since Socket.IO v3 socket.disconnect(); } @Test(timeout = TIMEOUT) - public void shouldHaveAnAccessibleSocketIdEqualToServerSideSocketIdOnCustomNamespace() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void shouldHaveAnAccessibleSocketIdEqualToServerSideSocketIdOnCustomNamespace() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); socket = client("/foo"); socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() { @Override @@ -58,13 +58,13 @@ public void call(Object... objects) { @SuppressWarnings("unchecked") Optional id = values.take(); assertThat(id.isPresent(), is(true)); - assertThat(id.get(), is("/foo#" + socket.io().engine.id())); + assertThat(id.get(), is(not(socket.io().engine.id()))); // distinct ID since Socket.IO v3 socket.disconnect(); } @Test(timeout = TIMEOUT) - public void clearsSocketIdUponDisconnection() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void clearsSocketIdUponDisconnection() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); socket = client(); socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() { @Override @@ -86,8 +86,8 @@ public void call(Object... args) { } @Test(timeout = TIMEOUT) - public void doesNotFireConnectErrorIfWeForceDisconnectInOpeningState() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void doesNotFireConnectErrorIfWeForceDisconnectInOpeningState() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); IO.Options opts = new IO.Options(); opts.timeout = 100; socket = client(opts); @@ -113,59 +113,22 @@ public void run() { } @Test(timeout = TIMEOUT) - public void pingAndPongWithLatency() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void shouldChangeSocketIdUponReconnection() throws InterruptedException { + final BlockingQueue values = new LinkedBlockingQueue<>(); socket = client(); - socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() { - @Override - public void call(Object... objects) { - final boolean[] pinged = new boolean[] { false }; - socket.once(Socket.EVENT_PING, new Emitter.Listener() { - @Override - public void call(Object... args) { - pinged[0] = true; - } - }); - socket.once(Socket.EVENT_PONG, new Emitter.Listener() { - @Override - public void call(Object... args) { - long ms = (long)args[0]; - values.offer(pinged[0]); - values.offer(ms); - } - }); - } - }); - socket.connect(); - - @SuppressWarnings("unchecked") - boolean pinged = (boolean)values.take(); - assertThat(pinged, is(true)); - - @SuppressWarnings("unchecked") - long ms = (long)values.take(); - assertThat(ms, greaterThan((long)0)); - - socket.disconnect(); - } - - @Test(timeout = TIMEOUT) - public void shouldChangeSocketIdUponReconnection() throws URISyntaxException, InterruptedException { - final BlockingQueue values = new LinkedBlockingQueue(); - socket = client(); - socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() { + socket.once(Socket.EVENT_CONNECT, new Emitter.Listener() { @Override public void call(Object... objects) { values.offer(Optional.ofNullable(socket.id())); - socket.on(Socket.EVENT_RECONNECT_ATTEMPT, new Emitter.Listener() { + socket.io().on(Manager.EVENT_RECONNECT_ATTEMPT, new Emitter.Listener() { @Override public void call(Object... objects) { values.offer(Optional.ofNullable(socket.id())); } }); - socket.on(Socket.EVENT_RECONNECT, new Emitter.Listener() { + socket.once(Socket.EVENT_CONNECT, new Emitter.Listener() { @Override public void call(Object... objects) { values.offer(Optional.ofNullable(socket.id())); @@ -191,8 +154,8 @@ public void call(Object... objects) { } @Test(timeout = TIMEOUT) - public void shouldAcceptAQueryStringOnDefaultNamespace() throws URISyntaxException, InterruptedException, JSONException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void shouldAcceptAQueryStringOnDefaultNamespace() throws InterruptedException, JSONException { + final BlockingQueue values = new LinkedBlockingQueue<>(); socket = client("/?c=d"); socket.emit("getHandshake", new Ack() { @@ -212,8 +175,8 @@ public void call(Object... args) { } @Test(timeout = TIMEOUT) - public void shouldAcceptAQueryString() throws URISyntaxException, InterruptedException, JSONException { - final BlockingQueue values = new LinkedBlockingQueue(); + public void shouldAcceptAQueryString() throws InterruptedException, JSONException { + final BlockingQueue values = new LinkedBlockingQueue<>(); socket = client("/abc?b=c&d=e"); socket.on("handshake", new Emitter.Listener() { @@ -233,4 +196,95 @@ public void call(Object... args) { socket.disconnect(); } + + @Test(timeout = TIMEOUT) + public void shouldAcceptAnAuthOption() throws InterruptedException, JSONException { + final BlockingQueue values = new LinkedBlockingQueue<>(); + + IO.Options opts = new IO.Options(); + opts.auth = singletonMap("token", "abcd"); + socket = client("/abc", opts); + socket.on("handshake", new Emitter.Listener() { + @Override + public void call(Object... args) { + JSONObject handshake = (JSONObject)args[0]; + values.offer(Optional.ofNullable(handshake)); + } + }); + socket.connect(); + + @SuppressWarnings("unchecked") + Optional handshake = values.take(); + JSONObject query = handshake.get().getJSONObject("auth"); + assertThat(query.getString("token"), is("abcd")); + + socket.disconnect(); + } + + @Test(timeout = TIMEOUT) + public void shouldFireAnErrorEventOnMiddlewareFailure() throws InterruptedException, JSONException { + final BlockingQueue values = new LinkedBlockingQueue<>(); + + socket = client("/no"); + socket.on(Socket.EVENT_CONNECT_ERROR, new Emitter.Listener() { + @Override + public void call(Object... args) { + values.offer(Optional.ofNullable(args[0])); + } + }); + socket.connect(); + + @SuppressWarnings("unchecked") + JSONObject error = ((Optional) values.take()).get(); + assertThat(error.getString("message"), is("auth failed")); + assertThat(error.getJSONObject("data").getString("a"), is("b")); + assertThat(error.getJSONObject("data").getInt("c"), is(3)); + + socket.disconnect(); + } + + @Test(timeout = TIMEOUT) + public void shouldThrowOnReservedEvent() { + final BlockingQueue values = new LinkedBlockingQueue<>(); + + socket = client("/no"); + try { + socket.emit("disconnecting", "goodbye"); + fail(); + } catch (RuntimeException e) { + assertThat(e.getMessage(), is("'disconnecting' is a reserved event name")); + } + + socket.disconnect(); + } + + @Test(timeout = TIMEOUT) + public void shouldEmitEventsInOrder() throws InterruptedException { + 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/com/kaleyra/socket_io/client/UrlTest.java b/src/test/java/com/kaleyra/socket_io/client/UrlTest.java new file mode 100644 index 00000000..0fc79fd5 --- /dev/null +++ b/src/test/java/com/kaleyra/socket_io/client/UrlTest.java @@ -0,0 +1,97 @@ +package com.kaleyra.socket_io.client; + +import org.junit.Test; +import org.junit.runner.RunWith; +import org.junit.runners.JUnit4; + +import java.net.URI; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.CoreMatchers.not; +import static org.junit.Assert.assertThat; + +@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() { + 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() { + 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() { + URI uri = parse("//localhost:3000"); + assertThat(uri.getScheme(), is("https")); + assertThat(uri.getHost(), is("localhost")); + assertThat(uri.getPort(), is(3000)); + } + + @Test + 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() { + 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 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() { + String url = "http://[::1]"; + URI parsed = parse(url); + assertThat(parsed.getScheme(), is("http")); + assertThat(parsed.getHost(), is("[::1]")); + assertThat(parsed.getPort(), is(80)); + assertThat(extractId(url), is("http://[::1]:80")); + } + +} diff --git a/src/test/java/io/socket/client/executions/Connection.java b/src/test/java/com/kaleyra/socket_io/client/executions/Connection.java similarity index 77% rename from src/test/java/io/socket/client/executions/Connection.java rename to src/test/java/com/kaleyra/socket_io/client/executions/Connection.java index 432be173..b7034edb 100644 --- a/src/test/java/io/socket/client/executions/Connection.java +++ b/src/test/java/com/kaleyra/socket_io/client/executions/Connection.java @@ -1,8 +1,8 @@ -package io.socket.client.executions; +package com.kaleyra.socket_io.client.executions; -import io.socket.emitter.Emitter; -import io.socket.client.IO; -import io.socket.client.Socket; +import com.kaleyra.socket_io.client.IO; +import com.kaleyra.socket_io.client.Socket; +import com.kaleyra.socket_io.emitter.Emitter; import okhttp3.OkHttpClient; import java.net.URISyntaxException; @@ -25,7 +25,7 @@ public void call(Object... args) { socket.close(); } }); - socket.io().on(io.socket.engineio.client.Socket.EVENT_CLOSE, new Emitter.Listener() { + socket.io().on(com.kaleyra.socket_io.engineio.client.Socket.EVENT_CLOSE, new Emitter.Listener() { @Override public void call(Object... args) { System.out.println("engine close"); diff --git a/src/test/java/io/socket/client/executions/ConnectionFailure.java b/src/test/java/com/kaleyra/socket_io/client/executions/ConnectionFailure.java similarity index 71% rename from src/test/java/io/socket/client/executions/ConnectionFailure.java rename to src/test/java/com/kaleyra/socket_io/client/executions/ConnectionFailure.java index d87f0336..fda9836a 100644 --- a/src/test/java/io/socket/client/executions/ConnectionFailure.java +++ b/src/test/java/com/kaleyra/socket_io/client/executions/ConnectionFailure.java @@ -1,8 +1,8 @@ -package io.socket.client.executions; +package com.kaleyra.socket_io.client.executions; -import io.socket.emitter.Emitter; -import io.socket.client.IO; -import io.socket.client.Socket; +import com.kaleyra.socket_io.client.IO; +import com.kaleyra.socket_io.client.Socket; +import com.kaleyra.socket_io.emitter.Emitter; import okhttp3.OkHttpClient; import java.net.URISyntaxException; @@ -21,12 +21,7 @@ public static void main(String[] args) throws URISyntaxException { options.callFactory = client; final Socket socket = IO.socket("http://localhost:" + port, options); - socket.on(Socket.EVENT_CONNECT_TIMEOUT, new Emitter.Listener() { - @Override - public void call(Object... args) { - System.out.println("connect timeout"); - } - }).on(Socket.EVENT_CONNECT_ERROR, new Emitter.Listener() { + socket.on(Socket.EVENT_CONNECT_ERROR, new Emitter.Listener() { @Override public void call(Object... args) { System.out.println("connect error"); diff --git a/src/test/java/io/socket/client/executions/ImmediateClose.java b/src/test/java/com/kaleyra/socket_io/client/executions/ImmediateClose.java similarity index 80% rename from src/test/java/io/socket/client/executions/ImmediateClose.java rename to src/test/java/com/kaleyra/socket_io/client/executions/ImmediateClose.java index fa23d169..9874bccd 100644 --- a/src/test/java/io/socket/client/executions/ImmediateClose.java +++ b/src/test/java/com/kaleyra/socket_io/client/executions/ImmediateClose.java @@ -1,8 +1,8 @@ -package io.socket.client.executions; +package com.kaleyra.socket_io.client.executions; -import io.socket.emitter.Emitter; -import io.socket.client.IO; -import io.socket.client.Socket; +import com.kaleyra.socket_io.client.IO; +import com.kaleyra.socket_io.client.Socket; +import com.kaleyra.socket_io.emitter.Emitter; import okhttp3.OkHttpClient; import java.net.URISyntaxException; @@ -29,7 +29,7 @@ public void call(Object... args) { System.out.println("disconnect"); } }); - socket.io().on(io.socket.engineio.client.Socket.EVENT_CLOSE, new Emitter.Listener() { + socket.io().on(com.kaleyra.socket_io.engineio.client.Socket.EVENT_CLOSE, new Emitter.Listener() { @Override public void call(Object... args) { System.out.println("engine close"); diff --git a/src/test/java/io/socket/hasbinary/HasBinaryTest.java b/src/test/java/com/kaleyra/socket_io/hasbinary/HasBinaryTest.java similarity index 98% rename from src/test/java/io/socket/hasbinary/HasBinaryTest.java rename to src/test/java/com/kaleyra/socket_io/hasbinary/HasBinaryTest.java index c83fca60..516a6a2d 100644 --- a/src/test/java/io/socket/hasbinary/HasBinaryTest.java +++ b/src/test/java/com/kaleyra/socket_io/hasbinary/HasBinaryTest.java @@ -1,4 +1,4 @@ -package io.socket.hasbinary; +package com.kaleyra.socket_io.hasbinary; import org.json.JSONArray; import org.json.JSONException; diff --git a/src/test/java/io/socket/parser/ByteArrayTest.java b/src/test/java/com/kaleyra/socket_io/parser/ByteArrayTest.java similarity index 67% rename from src/test/java/io/socket/parser/ByteArrayTest.java rename to src/test/java/com/kaleyra/socket_io/parser/ByteArrayTest.java index a358c15c..f465ede5 100644 --- a/src/test/java/io/socket/parser/ByteArrayTest.java +++ b/src/test/java/com/kaleyra/socket_io/parser/ByteArrayTest.java @@ -1,15 +1,15 @@ -package io.socket.parser; +package com.kaleyra.socket_io.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; @@ -19,9 +19,9 @@ public class ByteArrayTest { private static Parser.Encoder encoder = new IOParser.Encoder(); @Test - public void encodeByteArray() { - Packet packet = new Packet(Parser.BINARY_EVENT); - packet.data = "abc".getBytes(Charset.forName("UTF-8")); + public void encodeByteArray() throws JSONException { + 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; @@ -66,7 +66,7 @@ public void encodeBinaryAckWithByteArray() throws JSONException { JSONArray data = new JSONArray("[a, null, {}]"); data.put(1, "xxx".getBytes(Charset.forName("UTF-8"))); - Packet packet = new Packet(Parser.BINARY_ACK); + Packet packet = new Packet<>(Parser.BINARY_ACK); packet.data = data; packet.id = 127; packet.nsp = "/back"; @@ -79,7 +79,7 @@ public void cleanItselfUpOnClose() { data.put(new byte[2]); data.put(new byte[3]); - Packet packet = new Packet(Parser.BINARY_EVENT); + Packet packet = new Packet<>(Parser.BINARY_EVENT); packet.data = data; packet.id = 0; packet.nsp = "/"; diff --git a/src/test/java/io/socket/parser/Helpers.java b/src/test/java/com/kaleyra/socket_io/parser/Helpers.java similarity index 85% rename from src/test/java/io/socket/parser/Helpers.java rename to src/test/java/com/kaleyra/socket_io/parser/Helpers.java index 0a3d4612..90222380 100644 --- a/src/test/java/io/socket/parser/Helpers.java +++ b/src/test/java/com/kaleyra/socket_io/parser/Helpers.java @@ -1,21 +1,17 @@ -package io.socket.parser; +package com.kaleyra.socket_io.parser; -import io.socket.emitter.Emitter; import org.json.JSONArray; import org.json.JSONException; import org.json.JSONObject; -import org.junit.runner.RunWith; -import org.junit.runners.JUnit4; import org.skyscreamer.jsonassert.JSONAssert; import static org.hamcrest.CoreMatchers.is; import static org.junit.Assert.assertThat; +import static org.junit.Assert.fail; -@RunWith(JUnit4.class) public class Helpers { private static Parser.Encoder encoder = new IOParser.Encoder(); - private static Packet errorPacket = new Packet(Parser.ERROR, "parser error"); public static void test(final Packet obj) { encoder.encode(obj, new Parser.Encoder.Callback() { @@ -35,13 +31,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/com/kaleyra/socket_io/parser/ParserTest.java similarity index 82% rename from src/test/java/io/socket/parser/ParserTest.java rename to src/test/java/com/kaleyra/socket_io/parser/ParserTest.java index c13005c4..01c5c254 100644 --- a/src/test/java/io/socket/parser/ParserTest.java +++ b/src/test/java/com/kaleyra/socket_io/parser/ParserTest.java @@ -1,4 +1,4 @@ -package io.socket.parser; +package com.kaleyra.socket_io.parser; import org.json.JSONArray; import org.json.JSONException; @@ -27,12 +27,12 @@ public void encodeDisconnection() { @Test public void encodeEvent() throws JSONException { - Packet packet1 = new Packet(Parser.EVENT); + Packet packet1 = new Packet<>(Parser.EVENT); packet1.data = new JSONArray("[\"a\", 1, {}]"); packet1.nsp = "/"; Helpers.test(packet1); - Packet packet2 = new Packet(Parser.EVENT); + Packet packet2 = new Packet<>(Parser.EVENT); packet2.data = new JSONArray("[\"a\", 1, {}]"); packet2.nsp = "/test"; Helpers.test(packet2); @@ -40,7 +40,7 @@ public void encodeEvent() throws JSONException { @Test public void encodeAck() throws JSONException { - Packet packet = new Packet(Parser.ACK); + Packet packet = new Packet<>(Parser.ACK); packet.data = new JSONArray("[\"a\", 1, {}]"); packet.id = 123; packet.nsp = "/"; @@ -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]"); } } diff --git a/src/test/java/io/socket/util/Optional.java b/src/test/java/com/kaleyra/socket_io/util/Optional.java similarity index 87% rename from src/test/java/io/socket/util/Optional.java rename to src/test/java/com/kaleyra/socket_io/util/Optional.java index aadc6036..2d3bc440 100644 --- a/src/test/java/io/socket/util/Optional.java +++ b/src/test/java/com/kaleyra/socket_io/util/Optional.java @@ -1,4 +1,4 @@ -package io.socket.util; +package com.kaleyra.socket_io.util; import java.util.NoSuchElementException; @@ -12,11 +12,11 @@ public static Optional of(T value) { if (value == null) { throw new NullPointerException(); } - return new Optional(value); + return new Optional<>(value); } public static Optional ofNullable(T value) { - return new Optional(value); + return new Optional<>(value); } public static Optional empty() { diff --git a/src/test/java/io/socket/client/UrlTest.java b/src/test/java/io/socket/client/UrlTest.java deleted file mode 100644 index fbcf42de..00000000 --- a/src/test/java/io/socket/client/UrlTest.java +++ /dev/null @@ -1,72 +0,0 @@ -package io.socket.client; - -import org.junit.Test; -import org.junit.runner.RunWith; -import org.junit.runners.JUnit4; - -import java.net.MalformedURLException; -import java.net.URISyntaxException; -import java.net.URL; - -import static org.hamcrest.CoreMatchers.is; -import static org.hamcrest.CoreMatchers.not; -import static org.junit.Assert.assertThat; - -@RunWith(JUnit4.class) -public class UrlTest { - - @Test - public void parse() throws URISyntaxException { - assertThat(Url.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")); - } - - @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)); - } - - @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("/")); - } - - @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/")); - } - - @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/"); - assertThat(id1, is(id2)); - assertThat(id1, is(not(id3))); - assertThat(id2, is(not(id3))); - } - - @Test - public void ipv6() throws URISyntaxException, MalformedURLException { - String url = "http://[::1]"; - URL parsed = Url.parse(url); - assertThat(parsed.getProtocol(), is("http")); - assertThat(parsed.getHost(), is("[::1]")); - assertThat(parsed.getPort(), is(80)); - assertThat(Url.extractId(url), is("http://[::1]:80")); - } -} diff --git a/src/test/resources/cert.pem b/src/test/resources/cert.pem index bea755ce..cf3be045 100644 --- a/src/test/resources/cert.pem +++ b/src/test/resources/cert.pem @@ -1,10 +1,21 @@ -----BEGIN CERTIFICATE----- -MIIBfDCCASYCCQDTnGd/oOyF1DANBgkqhkiG9w0BAQUFADBFMQswCQYDVQQGEwJB -VTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50ZXJuZXQgV2lkZ2l0 -cyBQdHkgTHRkMB4XDTE0MDcwNzEzMTUzN1oXDTQxMTEyMTEzMTUzN1owRTELMAkG -A1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNVBAoTGEludGVybmV0 -IFdpZGdpdHMgUHR5IEx0ZDBcMA0GCSqGSIb3DQEBAQUAA0sAMEgCQQC6sdeFPlqk -5Pap9woFx1RO05gLidw4MNcL+ZRSxy/sNeE4PhT/RLFcEvnXiHc92wT8YB5Z+WCM -k/jRQ0q19PNPAgMBAAEwDQYJKoZIhvcNAQEFBQADQQCnmm1N/yZiMBZw2JDfbsx3 -ecc0BGQ2BwWQuGHzP07TMi1AuOyNZSczl907OphYb9iRC8shZ4O+oXjQAuGTQ1Hp +MIIDazCCAlOgAwIBAgIUPRxvTroGehqqXb8XOvqliIcKyagwDQYJKoZIhvcNAQEL +BQAwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgMClNvbWUtU3RhdGUxITAfBgNVBAoM +GEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZDAeFw0yMDEyMTAxMDE0MDFaFw0zMDEy +MDgxMDE0MDFaMEUxCzAJBgNVBAYTAkFVMRMwEQYDVQQIDApTb21lLVN0YXRlMSEw +HwYDVQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQwggEiMA0GCSqGSIb3DQEB +AQUAA4IBDwAwggEKAoIBAQCxJ8fUV6sRiNub3Af6jGpGTsWpCqtxBkRSADENMzdT +Twz4wUXXbgv/Tbt3XJovR1RtE9nx+WyA4XqBdfr8s/qDLiVWiyszU9E6jBjQva9B +aGJDZU0BEXjGDTFaE4tL3E/YWZvXVKmrEiq0aZa6anbjOefjG46CnXgfir/TZlx+ +8I5s/UmKY5PZ525zLHx/hGbCNCOfdH196CUsV5NNME5OIYIs0+9jLXkn8KS9uEKa +ifhf4rv4G2wo82KkIR1JIkKalH0xb0Z/R6+J2I2ADvxCIVxcGu78Nj0Ms5jpQKM6 +GTogpC3hN4fSAVdOLTHmQU1UrOg9btZtB79fYWn1KmMlAgMBAAGjUzBRMB0GA1Ud +DgQWBBSVf9NTqVxHgXqkdleQ4HGxxA8FTTAfBgNVHSMEGDAWgBSVf9NTqVxHgXqk +dleQ4HGxxA8FTTAPBgNVHRMBAf8EBTADAQH/MA0GCSqGSIb3DQEBCwUAA4IBAQB8 +8Jjqcipf2jHdiRx+4ltJ5y4hitgPsPRsR74L22hHAvICFC+2b2Iu3R1vSBJj5140 +HwwH7LUPyt3IKzQP8EOB2MbZsfH10Z3/ChnH1MHmOCDO+Wusi0C0HaOfWp/rAsgY +q+wLMGd3G72/Ba1YdaGHm9SjrziyAEnF5Uz8sUkQrDbZTiWp35PagJTDhdQ6pnUh +JROaoYgNYhGjQ89V1geIpIVTVqoGvLyvAi4k58KQyMUtxi7IEG/IdgopZAL9IL75 +D7fMXi21mrb1ohJpk3JlS1Z1XtoynIs4uzlv9wg6yKU5ExZ0QsUwuBekopUuSAvg +XeFIZbJz/WoAo0ZJ6o8Y -----END CERTIFICATE----- diff --git a/src/test/resources/key.pem b/src/test/resources/key.pem index 4a78a226..b80afb93 100644 --- a/src/test/resources/key.pem +++ b/src/test/resources/key.pem @@ -1,9 +1,28 @@ ------BEGIN RSA PRIVATE KEY----- -MIIBOwIBAAJBALqx14U+WqTk9qn3CgXHVE7TmAuJ3Dgw1wv5lFLHL+w14Tg+FP9E -sVwS+deIdz3bBPxgHln5YIyT+NFDSrX0808CAwEAAQJAIdwLSIEsk2drTRwe1zl1 -ku5RTxZruE0zU1qqifDSQjab1StAK1tapxBVRlRlyLCfD704UClsU8sjGtq0Nh6n -kQIhAO2YJM1g0w9bWYet3zC2UdEASPzaQ7llpZmc51NRBx2NAiEAyShICAaclEuy -wwuD4hibV+b6I8CLYoyPBo32EaceN0sCIQCUed6NxfM/houlgV+Xtmfcnzv9X3yx -EDdzjpz08Q7sRQIgZFv1fBOYYSBXQppnJRFzx2pUmCvDHtrTrMh84RfIqnsCIQCf -JjNXXxOaHn1PNZpi6EHReiFQmy1Swt+AxpTsKixsfA== ------END RSA PRIVATE KEY----- +-----BEGIN PRIVATE KEY----- +MIIEvAIBADANBgkqhkiG9w0BAQEFAASCBKYwggSiAgEAAoIBAQCxJ8fUV6sRiNub +3Af6jGpGTsWpCqtxBkRSADENMzdTTwz4wUXXbgv/Tbt3XJovR1RtE9nx+WyA4XqB +dfr8s/qDLiVWiyszU9E6jBjQva9BaGJDZU0BEXjGDTFaE4tL3E/YWZvXVKmrEiq0 +aZa6anbjOefjG46CnXgfir/TZlx+8I5s/UmKY5PZ525zLHx/hGbCNCOfdH196CUs +V5NNME5OIYIs0+9jLXkn8KS9uEKaifhf4rv4G2wo82KkIR1JIkKalH0xb0Z/R6+J +2I2ADvxCIVxcGu78Nj0Ms5jpQKM6GTogpC3hN4fSAVdOLTHmQU1UrOg9btZtB79f +YWn1KmMlAgMBAAECggEAZCjGnTJ3wLEs4KD1Td2nlFqi/GDQ71UIuYfsM7daN1rB +Tb8QOq24UL7lF6Yeck6U2BraJSnNA8z3k0xd/BPRtesYJycF5L4l1EEzIomsFYHr +1IjokYsMSoVY+sGEBv7nkb2QE52FU/gwdtIf6wOYdf3eMhP5bbWUHdk3fVEpSIbN +q9Le23U4Rf+24TUFYQfSmxIADVXnleEBaIBvIj9+uqrQWkY7aTdvdZshuL08irrU +/UekrqsP6uruKPEL2n7xUYjM1MvkAuPmyHjikwevNpPAMuAlFty/ZCNd1fARDfKS +WToRnpgm5u8D414gDCesoyYuy3IbhQ4t95gru2T+3QKBgQDl6sW0+0RlTMA2QOv5 +IID9UfO01OhDZZTjy83tse+hqWNN93DengBaK4LLhPxUp0Ff62nICzoeCieXgrUF +rYkF9F1fIa1lOgTemmNoKYm3OzlBfWbZ2zlVPzxg6QlLaYBLc2ZNpAAuuGJjh115 +JjDwVh+TN/8MkPDG+dnKb52VLwKBgQDFQLV8UehHFzkirNw1+dYSCkNv9qJwoub9 +MD6lI4rl7pi//4i1QdKvJkCSSZ664s9UjyogyI+meRdUS9ea3JYUrWLUCoPr0nfb +5b0ohEb56QhEnCO5xVO49dDpb64b8rPxztLV5Ejr0cnS73UEZSu16ihrWMtxn5w3 +sRQ4L7pf6wKBgGDKk2z7kvGqfAjbD/yTSHpcs+Je92DYNPQpaoo0rJM8QkgicWvm +zHMpeii/1ZK1zvnYm3HR+CeJUt2f8yFuyw6sr1pLTToeUMp96HeDdSykTBhb+J6i +geJ3eq25rWYIBjC9ZkYtUr5YdWM9K4bDIzsqpqRNoJvjsNmzeZKVppuVAoGAOwsI +iAL4dTclWhTGAb4b7uB1mTEJJJAOdmEXj1TZQcQuouH5aNAgIV9g2qkAw04a42PL +J28BWMJMUmY1TlyS6/OObowLOu6QBBl7ioI1wJ6ZY/gc1YGUcvvZodZVFnaKmGnh +QDcKANSWBfa5XyxtbhF+McutcgBlwWHW/I6EyisCgYAnJ35YgVEx4hakXQNSwlPR +Y6ArQSHTlsBdpxbE2ekDrqTDfx6r2RVdiq3arZepk4UG9UDVBzCuZfQO8mRRV0lF +9tqssEl8uqJasxrLbY1LAg75btV+8o4UJhutstzzXG2oEY3YlZRbjl8a146jVd09 +2oxN1xfkQYQ9cLYTAOfrDw== +-----END PRIVATE KEY----- diff --git a/src/test/resources/keystore.jks b/src/test/resources/keystore.jks index 24c507ba..fa70caba 100644 Binary files a/src/test/resources/keystore.jks and b/src/test/resources/keystore.jks differ diff --git a/src/test/resources/package-lock.json b/src/test/resources/package-lock.json index 491c6bc4..be30fb65 100644 --- a/src/test/resources/package-lock.json +++ b/src/test/resources/package-lock.json @@ -1,389 +1,387 @@ { + "name": "resources", + "lockfileVersion": 2, "requires": true, - "lockfileVersion": 1, - "dependencies": { - "accepts": { - "version": "1.3.3", - "resolved": "https://registry.npmjs.org/accepts/-/accepts-1.3.3.tgz", - "integrity": "sha1-w8p0NJOGSMPg2cHjKN1otiLChMo=", - "requires": { - "mime-types": "2.1.15", - "negotiator": "0.6.1" + "packages": { + "": { + "dependencies": { + "socket.io": "^3.0.4" } }, - "after": { - "version": "0.8.2", - "resolved": "https://registry.npmjs.org/after/-/after-0.8.2.tgz", - "integrity": "sha1-/ts5T58OAqqXaOcCvaI7UF+ufh8=" + "node_modules/@types/component-emitter": { + "version": "1.2.10", + "resolved": "https://registry.npmjs.org/@types/component-emitter/-/component-emitter-1.2.10.tgz", + "integrity": "sha512-bsjleuRKWmGqajMerkzox19aGbscQX5rmmvvXl3wlIp5gMG1HgkiwPxsN5p070fBDKTNSPgojVbuY1+HWMbFhg==" }, - "base64-arraybuffer": { - "version": "0.1.5", - "resolved": "https://registry.npmjs.org/base64-arraybuffer/-/base64-arraybuffer-0.1.5.tgz", - "integrity": "sha1-c5JncZI7Whl0etZmqlzUv5xunOg=" + "node_modules/@types/cookie": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/@types/cookie/-/cookie-0.4.0.tgz", + "integrity": "sha512-y7mImlc/rNkvCRmg8gC3/lj87S7pTUIJ6QGjwHR9WQJcFs+ZMTOaoPrkdFA/YdbuqVEmEbb5RdhVxMkAcgOnpg==" }, - "base64id": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/base64id/-/base64id-1.0.0.tgz", - "integrity": "sha1-R2iMuZu2gE8OBtPnY7HDLlfY5rY=" + "node_modules/@types/cors": { + "version": "2.8.9", + "resolved": "https://registry.npmjs.org/@types/cors/-/cors-2.8.9.tgz", + "integrity": "sha512-zurD1ibz21BRlAOIKP8yhrxlqKx6L9VCwkB5kMiP6nZAhoF5MvC7qS1qPA7nRcr1GJolfkQC7/EAL4hdYejLtg==" }, - "cookie": { - "version": "0.3.1", - "resolved": "https://registry.npmjs.org/cookie/-/cookie-0.3.1.tgz", - "integrity": "sha1-5+Ch+e9DtMi6klxcWpboBtFoc7s=" + "node_modules/@types/node": { + "version": "14.14.12", + "resolved": "https://registry.npmjs.org/@types/node/-/node-14.14.12.tgz", + "integrity": "sha512-ASH8OPHMNlkdjrEdmoILmzFfsJICvhBsFfAum4aKZ/9U4B6M6tTmTPh+f3ttWdD74CEGV5XvXWkbyfSdXaTd7g==" }, - "debug": { - "version": "2.6.8", - "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.8.tgz", - "integrity": "sha1-5zFTHKLt4n0YgiJCfaF4IdaP9Pw=", - "requires": { - "ms": "2.0.0" + "node_modules/accepts": { + "version": "1.3.7", + "resolved": "https://registry.npmjs.org/accepts/-/accepts-1.3.7.tgz", + "integrity": "sha512-Il80Qs2WjYlJIBNzNkK6KYqlVMTbZLXgHx2oT0pU/fjRHyEp+PEfEPY0R3WCwAGVOtauxh1hOxNgIf5bv7dQpA==", + "dependencies": { + "mime-types": "~2.1.24", + "negotiator": "0.6.2" + }, + "engines": { + "node": ">= 0.6" } }, - "engine.io": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/engine.io/-/engine.io-3.1.0.tgz", - "integrity": "sha1-XKQ4486f28kVxKIcjdnhJmcG5X4=", - "requires": { - "accepts": "1.3.3", - "base64id": "1.0.0", - "cookie": "0.3.1", - "debug": "2.6.8", - "engine.io-parser": "2.1.1", - "uws": "0.14.5", - "ws": "2.3.1" + "node_modules/base64-arraybuffer": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/base64-arraybuffer/-/base64-arraybuffer-0.1.4.tgz", + "integrity": "sha1-mBjHngWbE1X5fgQooBfIOOkLqBI=", + "engines": { + "node": ">= 0.6.0" } }, - "engine.io-client": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/engine.io-client/-/engine.io-client-3.1.1.tgz", - "integrity": "sha1-QVqYUrrbFPoAj6PvHjFgjbZ2EyU=", - "requires": { - "component-emitter": "1.2.1", - "component-inherit": "0.0.3", - "debug": "2.6.8", - "engine.io-parser": "2.1.1", - "has-cors": "1.1.0", - "indexof": "0.0.1", - "parsejson": "0.0.3", - "parseqs": "0.0.5", - "parseuri": "0.0.5", - "ws": "2.3.1", - "xmlhttprequest-ssl": "1.5.3", - "yeast": "0.1.2" + "node_modules/base64id": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/base64id/-/base64id-2.0.0.tgz", + "integrity": "sha512-lGe34o6EHj9y3Kts9R4ZYs/Gr+6N7MCaMlIFA3F1R2O5/m7K06AxfSeO5530PEERE6/WyEg3lsuyw4GHlPZHog==", + "engines": { + "node": "^4.5.0 || >= 5.9" + } + }, + "node_modules/component-emitter": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/component-emitter/-/component-emitter-1.3.0.tgz", + "integrity": "sha512-Rd3se6QB+sO1TwqZjscQrurpEPIfO0/yYnSin6Q/rD3mOutHvUrCAhJub3r90uNb+SESBuE0QYoB90YdfatsRg==" + }, + "node_modules/cookie": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/cookie/-/cookie-0.4.1.tgz", + "integrity": "sha512-ZwrFkGJxUR3EIoXtO+yVE69Eb7KlixbaeAWfBQB9vVsNn/o+Yw69gBWSSDK825hQNdN+wF8zELf3dFNl/kxkUA==", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/cors": { + "version": "2.8.5", + "resolved": "https://registry.npmjs.org/cors/-/cors-2.8.5.tgz", + "integrity": "sha512-KIHbLJqu73RGr/hnbrO9uBeixNGuvSQjul/jdFvS/KFSIH1hWVd1ng7zOHx+YrEfInLG7q4n6GHQ9cDtxv/P6g==", + "dependencies": { + "object-assign": "^4", + "vary": "^1" }, + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/debug": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.1.1.tgz", + "integrity": "sha512-pYAIzeRo8J6KPEaJ0VWOh5Pzkbw/RetuzehGM7QRRX5he4fPHx2rdKMB256ehJCkX+XRQm16eZLqLNS8RSZXZw==", + "deprecated": "Debug versions >=3.2.0 <3.2.7 || >=4 <4.3.1 have a low-severity ReDos regression when used in a Node.js environment. It is recommended you upgrade to 3.2.7 or 4.3.1. (https://github.com/visionmedia/debug/issues/797)", "dependencies": { - "component-emitter": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/component-emitter/-/component-emitter-1.2.1.tgz", - "integrity": "sha1-E3kY1teCg/ffemt8WmPhQOaUJeY=" - }, - "component-inherit": { - "version": "0.0.3", - "resolved": "https://registry.npmjs.org/component-inherit/-/component-inherit-0.0.3.tgz", - "integrity": "sha1-ZF/ErfWLcrZJ1crmUTVhnbJv8UM=" - }, - "has-cors": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/has-cors/-/has-cors-1.1.0.tgz", - "integrity": "sha1-XkdHk/fqmEPRu5nCPu9J/xJv/zk=" - }, - "indexof": { - "version": "0.0.1", - "resolved": "https://registry.npmjs.org/indexof/-/indexof-0.0.1.tgz", - "integrity": "sha1-gtwzbSMrkGIXnQWrMpOmYFn9Q10=" - }, - "yeast": { - "version": "0.1.2", - "resolved": "https://registry.npmjs.org/yeast/-/yeast-0.1.2.tgz", - "integrity": "sha1-AI4G2AlDIMNy28L47XagymyKxBk=" - } + "ms": "^2.1.1" } }, - "engine.io-parser": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/engine.io-parser/-/engine.io-parser-2.1.1.tgz", - "integrity": "sha1-4Ps/DgRi9/WLt3waUun1p+JuRmg=", - "requires": { - "after": "0.8.2", - "arraybuffer.slice": "0.0.6", - "base64-arraybuffer": "0.1.5", - "blob": "0.0.4", - "has-binary2": "1.0.2" - }, + "node_modules/engine.io": { + "version": "4.0.5", + "resolved": "https://registry.npmjs.org/engine.io/-/engine.io-4.0.5.tgz", + "integrity": "sha512-Ri+whTNr2PKklxQkfbGjwEo+kCBUM4Qxk4wtLqLrhH+b1up2NFL9g9pjYWiCV/oazwB0rArnvF/ZmZN2ab5Hpg==", "dependencies": { - "arraybuffer.slice": { - "version": "0.0.6", - "resolved": "https://registry.npmjs.org/arraybuffer.slice/-/arraybuffer.slice-0.0.6.tgz", - "integrity": "sha1-8zshWfBTKj8xB6JywMz70a0peco=" - }, - "blob": { - "version": "0.0.4", - "resolved": "https://registry.npmjs.org/blob/-/blob-0.0.4.tgz", - "integrity": "sha1-vPEwUspURj8w+fx+lbmkdjCpSSE=" - } + "accepts": "~1.3.4", + "base64id": "2.0.0", + "cookie": "~0.4.1", + "cors": "~2.8.5", + "debug": "~4.1.0", + "engine.io-parser": "~4.0.0", + "ws": "^7.1.2" + }, + "engines": { + "node": ">=10.0.0" } }, - "has-binary2": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/has-binary2/-/has-binary2-1.0.2.tgz", - "integrity": "sha1-6D26SfC5vk0CbSc2U1DZ8D9Uvpg=", - "requires": { - "isarray": "2.0.1" + "node_modules/engine.io-parser": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/engine.io-parser/-/engine.io-parser-4.0.2.tgz", + "integrity": "sha512-sHfEQv6nmtJrq6TKuIz5kyEKH/qSdK56H/A+7DnAuUPWosnIZAS2NHNcPLmyjtY3cGS/MqJdZbUjW97JU72iYg==", + "dependencies": { + "base64-arraybuffer": "0.1.4" }, + "engines": { + "node": ">=8.0.0" + } + }, + "node_modules/mime-db": { + "version": "1.44.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.44.0.tgz", + "integrity": "sha512-/NOTfLrsPBVeH7YtFPgsVWveuL+4SjjYxaQ1xtM1KMFj7HdxlBlxeyNLzhyJVx7r4rZGJAZ/6lkKCitSc/Nmpg==", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/mime-types": { + "version": "2.1.27", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.27.tgz", + "integrity": "sha512-JIhqnCasI9yD+SsmkquHBxTSEuZdQX5BuQnS2Vc7puQQQ+8yiP5AY5uWhpdv4YL4VM5c6iliiYWPgJ/nJQLp7w==", "dependencies": { - "isarray": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.1.tgz", - "integrity": "sha1-o32U7ZzaLVmGXJ92/llu4fM4dB4=" - } + "mime-db": "1.44.0" + }, + "engines": { + "node": ">= 0.6" } }, - "mime-db": { - "version": "1.27.0", - "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.27.0.tgz", - "integrity": "sha1-gg9XIpa70g7CXtVeW13oaeVDbrE=" + "node_modules/ms": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==" }, - "mime-types": { - "version": "2.1.15", - "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.15.tgz", - "integrity": "sha1-pOv1BkCUVpI3uM9wBGd20J/JKu0=", - "requires": { - "mime-db": "1.27.0" + "node_modules/negotiator": { + "version": "0.6.2", + "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-0.6.2.tgz", + "integrity": "sha512-hZXc7K2e+PgeI1eDBe/10Ard4ekbfrrqG8Ep+8Jmf4JID2bNg7NvCPOZN+kfF574pFQI7mum2AUqDidoKqcTOw==", + "engines": { + "node": ">= 0.6" } }, - "ms": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", - "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=" + "node_modules/object-assign": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", + "integrity": "sha1-IQmtx5ZYh8/AXLvUQsrIv7s2CGM=", + "engines": { + "node": ">=0.10.0" + } }, - "negotiator": { - "version": "0.6.1", - "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-0.6.1.tgz", - "integrity": "sha1-KzJxhOiZIQEXeyhWP7XnECrNDKk=" - }, - "parsejson": { - "version": "0.0.3", - "resolved": "https://registry.npmjs.org/parsejson/-/parsejson-0.0.3.tgz", - "integrity": "sha1-q343WfIJ7OmUN5c/fQ8fZK4OZKs=", - "requires": { - "better-assert": "1.0.2" + "node_modules/socket.io": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/socket.io/-/socket.io-3.0.4.tgz", + "integrity": "sha512-Vj1jUoO75WGc9txWd311ZJJqS9Dr8QtNJJ7gk2r7dcM/yGe9sit7qOijQl3GAwhpBOz/W8CwkD7R6yob07nLbA==", + "dependencies": { + "@types/cookie": "^0.4.0", + "@types/cors": "^2.8.8", + "@types/node": "^14.14.7", + "accepts": "~1.3.4", + "base64id": "~2.0.0", + "debug": "~4.1.0", + "engine.io": "~4.0.0", + "socket.io-adapter": "~2.0.3", + "socket.io-parser": "~4.0.1" }, + "engines": { + "node": ">=10.0.0" + } + }, + "node_modules/socket.io-adapter": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/socket.io-adapter/-/socket.io-adapter-2.0.3.tgz", + "integrity": "sha512-2wo4EXgxOGSFueqvHAdnmi5JLZzWqMArjuP4nqC26AtLh5PoCPsaRbRdah2xhcwTAMooZfjYiNVNkkmmSMaxOQ==" + }, + "node_modules/socket.io-parser": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/socket.io-parser/-/socket.io-parser-4.0.2.tgz", + "integrity": "sha512-Bs3IYHDivwf+bAAuW/8xwJgIiBNtlvnjYRc4PbXgniLmcP1BrakBoq/QhO24rgtgW7VZ7uAaswRGxutUnlAK7g==", "dependencies": { - "better-assert": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/better-assert/-/better-assert-1.0.2.tgz", - "integrity": "sha1-QIZrnhueC1W0gYlDEeaPr/rrxSI=", - "requires": { - "callsite": "1.0.0" - } - }, - "callsite": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/callsite/-/callsite-1.0.0.tgz", - "integrity": "sha1-KAOY5dZkvXQDi28JBRU+borxvCA=" - } + "@types/component-emitter": "^1.2.10", + "component-emitter": "~1.3.0", + "debug": "~4.1.0" + }, + "engines": { + "node": ">=10.0.0" } }, - "parseqs": { - "version": "0.0.5", - "resolved": "https://registry.npmjs.org/parseqs/-/parseqs-0.0.5.tgz", - "integrity": "sha1-1SCKNzjkZ2bikbouoXNoSSGouJ0=", - "requires": { - "better-assert": "1.0.2" + "node_modules/vary": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/vary/-/vary-1.1.2.tgz", + "integrity": "sha1-IpnwLG3tMNSllhsLn3RSShj2NPw=", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/ws": { + "version": "7.4.1", + "resolved": "https://registry.npmjs.org/ws/-/ws-7.4.1.tgz", + "integrity": "sha512-pTsP8UAfhy3sk1lSk/O/s4tjD0CRwvMnzvwr4OKGX7ZvqZtUyx4KIJB5JWbkykPoc55tixMGgTNoh3k4FkNGFQ==", + "engines": { + "node": ">=8.3.0" }, - "dependencies": { - "better-assert": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/better-assert/-/better-assert-1.0.2.tgz", - "integrity": "sha1-QIZrnhueC1W0gYlDEeaPr/rrxSI=", - "requires": { - "callsite": "1.0.0" - } + "peerDependencies": { + "bufferutil": "^4.0.1", + "utf-8-validate": "^5.0.2" + }, + "peerDependenciesMeta": { + "bufferutil": { + "optional": true }, - "callsite": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/callsite/-/callsite-1.0.0.tgz", - "integrity": "sha1-KAOY5dZkvXQDi28JBRU+borxvCA=" + "utf-8-validate": { + "optional": true } } + } + }, + "dependencies": { + "@types/component-emitter": { + "version": "1.2.10", + "resolved": "https://registry.npmjs.org/@types/component-emitter/-/component-emitter-1.2.10.tgz", + "integrity": "sha512-bsjleuRKWmGqajMerkzox19aGbscQX5rmmvvXl3wlIp5gMG1HgkiwPxsN5p070fBDKTNSPgojVbuY1+HWMbFhg==" + }, + "@types/cookie": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/@types/cookie/-/cookie-0.4.0.tgz", + "integrity": "sha512-y7mImlc/rNkvCRmg8gC3/lj87S7pTUIJ6QGjwHR9WQJcFs+ZMTOaoPrkdFA/YdbuqVEmEbb5RdhVxMkAcgOnpg==" + }, + "@types/cors": { + "version": "2.8.9", + "resolved": "https://registry.npmjs.org/@types/cors/-/cors-2.8.9.tgz", + "integrity": "sha512-zurD1ibz21BRlAOIKP8yhrxlqKx6L9VCwkB5kMiP6nZAhoF5MvC7qS1qPA7nRcr1GJolfkQC7/EAL4hdYejLtg==" + }, + "@types/node": { + "version": "14.14.12", + "resolved": "https://registry.npmjs.org/@types/node/-/node-14.14.12.tgz", + "integrity": "sha512-ASH8OPHMNlkdjrEdmoILmzFfsJICvhBsFfAum4aKZ/9U4B6M6tTmTPh+f3ttWdD74CEGV5XvXWkbyfSdXaTd7g==" + }, + "accepts": { + "version": "1.3.7", + "resolved": "https://registry.npmjs.org/accepts/-/accepts-1.3.7.tgz", + "integrity": "sha512-Il80Qs2WjYlJIBNzNkK6KYqlVMTbZLXgHx2oT0pU/fjRHyEp+PEfEPY0R3WCwAGVOtauxh1hOxNgIf5bv7dQpA==", + "requires": { + "mime-types": "~2.1.24", + "negotiator": "0.6.2" + } + }, + "base64-arraybuffer": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/base64-arraybuffer/-/base64-arraybuffer-0.1.4.tgz", + "integrity": "sha1-mBjHngWbE1X5fgQooBfIOOkLqBI=" }, - "parseuri": { - "version": "0.0.5", - "resolved": "https://registry.npmjs.org/parseuri/-/parseuri-0.0.5.tgz", - "integrity": "sha1-gCBKUNTbt3m/3G6+J3jZDkvOMgo=", + "base64id": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/base64id/-/base64id-2.0.0.tgz", + "integrity": "sha512-lGe34o6EHj9y3Kts9R4ZYs/Gr+6N7MCaMlIFA3F1R2O5/m7K06AxfSeO5530PEERE6/WyEg3lsuyw4GHlPZHog==" + }, + "component-emitter": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/component-emitter/-/component-emitter-1.3.0.tgz", + "integrity": "sha512-Rd3se6QB+sO1TwqZjscQrurpEPIfO0/yYnSin6Q/rD3mOutHvUrCAhJub3r90uNb+SESBuE0QYoB90YdfatsRg==" + }, + "cookie": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/cookie/-/cookie-0.4.1.tgz", + "integrity": "sha512-ZwrFkGJxUR3EIoXtO+yVE69Eb7KlixbaeAWfBQB9vVsNn/o+Yw69gBWSSDK825hQNdN+wF8zELf3dFNl/kxkUA==" + }, + "cors": { + "version": "2.8.5", + "resolved": "https://registry.npmjs.org/cors/-/cors-2.8.5.tgz", + "integrity": "sha512-KIHbLJqu73RGr/hnbrO9uBeixNGuvSQjul/jdFvS/KFSIH1hWVd1ng7zOHx+YrEfInLG7q4n6GHQ9cDtxv/P6g==", "requires": { - "better-assert": "1.0.2" - }, - "dependencies": { - "better-assert": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/better-assert/-/better-assert-1.0.2.tgz", - "integrity": "sha1-QIZrnhueC1W0gYlDEeaPr/rrxSI=", - "requires": { - "callsite": "1.0.0" - } - }, - "callsite": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/callsite/-/callsite-1.0.0.tgz", - "integrity": "sha1-KAOY5dZkvXQDi28JBRU+borxvCA=" - } + "object-assign": "^4", + "vary": "^1" } }, - "safe-buffer": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.0.1.tgz", - "integrity": "sha1-0mPKVGls2KMGtcplUekt5XkY++c=" + "debug": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.1.1.tgz", + "integrity": "sha512-pYAIzeRo8J6KPEaJ0VWOh5Pzkbw/RetuzehGM7QRRX5he4fPHx2rdKMB256ehJCkX+XRQm16eZLqLNS8RSZXZw==", + "requires": { + "ms": "^2.1.1" + } }, - "socket.io": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/socket.io/-/socket.io-2.0.3.tgz", - "integrity": "sha1-Q1nwaiSTOua9CHeYr3jGgOrjReM=", + "engine.io": { + "version": "4.0.5", + "resolved": "https://registry.npmjs.org/engine.io/-/engine.io-4.0.5.tgz", + "integrity": "sha512-Ri+whTNr2PKklxQkfbGjwEo+kCBUM4Qxk4wtLqLrhH+b1up2NFL9g9pjYWiCV/oazwB0rArnvF/ZmZN2ab5Hpg==", "requires": { - "debug": "2.6.8", - "engine.io": "3.1.0", - "object-assign": "4.1.1", - "socket.io-adapter": "1.1.0", - "socket.io-client": "2.0.3", - "socket.io-parser": "3.1.2" - }, - "dependencies": { - "object-assign": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", - "integrity": "sha1-IQmtx5ZYh8/AXLvUQsrIv7s2CGM=" - } + "accepts": "~1.3.4", + "base64id": "2.0.0", + "cookie": "~0.4.1", + "cors": "~2.8.5", + "debug": "~4.1.0", + "engine.io-parser": "~4.0.0", + "ws": "^7.1.2" } }, - "socket.io-adapter": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/socket.io-adapter/-/socket.io-adapter-1.1.0.tgz", - "integrity": "sha1-x6pGUB3VVsLLiiivj/lcC14dqkw=", + "engine.io-parser": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/engine.io-parser/-/engine.io-parser-4.0.2.tgz", + "integrity": "sha512-sHfEQv6nmtJrq6TKuIz5kyEKH/qSdK56H/A+7DnAuUPWosnIZAS2NHNcPLmyjtY3cGS/MqJdZbUjW97JU72iYg==", "requires": { - "debug": "2.3.3" - }, - "dependencies": { - "debug": { - "version": "2.3.3", - "resolved": "https://registry.npmjs.org/debug/-/debug-2.3.3.tgz", - "integrity": "sha1-QMRT5n5uE8kB3ewxeviYbNqe/4w=", - "requires": { - "ms": "0.7.2" - } - }, - "ms": { - "version": "0.7.2", - "resolved": "https://registry.npmjs.org/ms/-/ms-0.7.2.tgz", - "integrity": "sha1-riXPJRKziFodldfwN4aNhDESR2U=" - } + "base64-arraybuffer": "0.1.4" } }, - "socket.io-client": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/socket.io-client/-/socket.io-client-2.0.3.tgz", - "integrity": "sha1-bK9K/5+FsZ/ZG2zhPWmttWT4hzs=", + "mime-db": { + "version": "1.44.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.44.0.tgz", + "integrity": "sha512-/NOTfLrsPBVeH7YtFPgsVWveuL+4SjjYxaQ1xtM1KMFj7HdxlBlxeyNLzhyJVx7r4rZGJAZ/6lkKCitSc/Nmpg==" + }, + "mime-types": { + "version": "2.1.27", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.27.tgz", + "integrity": "sha512-JIhqnCasI9yD+SsmkquHBxTSEuZdQX5BuQnS2Vc7puQQQ+8yiP5AY5uWhpdv4YL4VM5c6iliiYWPgJ/nJQLp7w==", "requires": { - "backo2": "1.0.2", - "base64-arraybuffer": "0.1.5", - "component-bind": "1.0.0", - "component-emitter": "1.2.1", - "debug": "2.6.8", - "engine.io-client": "3.1.1", - "has-cors": "1.1.0", - "indexof": "0.0.1", - "object-component": "0.0.3", - "parseqs": "0.0.5", - "parseuri": "0.0.5", - "socket.io-parser": "3.1.2", - "to-array": "0.1.4" - }, - "dependencies": { - "backo2": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/backo2/-/backo2-1.0.2.tgz", - "integrity": "sha1-MasayLEpNjRj41s+u2n038+6eUc=" - }, - "component-bind": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/component-bind/-/component-bind-1.0.0.tgz", - "integrity": "sha1-AMYIq33Nk4l8AAllGx06jh5zu9E=" - }, - "component-emitter": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/component-emitter/-/component-emitter-1.2.1.tgz", - "integrity": "sha1-E3kY1teCg/ffemt8WmPhQOaUJeY=" - }, - "has-cors": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/has-cors/-/has-cors-1.1.0.tgz", - "integrity": "sha1-XkdHk/fqmEPRu5nCPu9J/xJv/zk=" - }, - "indexof": { - "version": "0.0.1", - "resolved": "https://registry.npmjs.org/indexof/-/indexof-0.0.1.tgz", - "integrity": "sha1-gtwzbSMrkGIXnQWrMpOmYFn9Q10=" - }, - "object-component": { - "version": "0.0.3", - "resolved": "https://registry.npmjs.org/object-component/-/object-component-0.0.3.tgz", - "integrity": "sha1-8MaapQ78lbhmwYb0AKM3acsvEpE=" - }, - "to-array": { - "version": "0.1.4", - "resolved": "https://registry.npmjs.org/to-array/-/to-array-0.1.4.tgz", - "integrity": "sha1-F+bBH3PdTz10zaek/zI46a2b+JA=" - } + "mime-db": "1.44.0" } }, - "socket.io-parser": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/socket.io-parser/-/socket.io-parser-3.1.2.tgz", - "integrity": "sha1-28IoIVH8T6675Aru3Ady66YZ9/I=", + "ms": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==" + }, + "negotiator": { + "version": "0.6.2", + "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-0.6.2.tgz", + "integrity": "sha512-hZXc7K2e+PgeI1eDBe/10Ard4ekbfrrqG8Ep+8Jmf4JID2bNg7NvCPOZN+kfF574pFQI7mum2AUqDidoKqcTOw==" + }, + "object-assign": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", + "integrity": "sha1-IQmtx5ZYh8/AXLvUQsrIv7s2CGM=" + }, + "socket.io": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/socket.io/-/socket.io-3.0.4.tgz", + "integrity": "sha512-Vj1jUoO75WGc9txWd311ZJJqS9Dr8QtNJJ7gk2r7dcM/yGe9sit7qOijQl3GAwhpBOz/W8CwkD7R6yob07nLbA==", "requires": { - "component-emitter": "1.2.1", - "debug": "2.6.8", - "has-binary2": "1.0.2", - "isarray": "2.0.1" - }, - "dependencies": { - "component-emitter": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/component-emitter/-/component-emitter-1.2.1.tgz", - "integrity": "sha1-E3kY1teCg/ffemt8WmPhQOaUJeY=" - }, - "isarray": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.1.tgz", - "integrity": "sha1-o32U7ZzaLVmGXJ92/llu4fM4dB4=" - } + "@types/cookie": "^0.4.0", + "@types/cors": "^2.8.8", + "@types/node": "^14.14.7", + "accepts": "~1.3.4", + "base64id": "~2.0.0", + "debug": "~4.1.0", + "engine.io": "~4.0.0", + "socket.io-adapter": "~2.0.3", + "socket.io-parser": "~4.0.1" } }, - "uws": { - "version": "0.14.5", - "resolved": "https://registry.npmjs.org/uws/-/uws-0.14.5.tgz", - "integrity": "sha1-Z6rzPEaypYel9mZtAPdpEyjxSdw=", - "optional": true + "socket.io-adapter": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/socket.io-adapter/-/socket.io-adapter-2.0.3.tgz", + "integrity": "sha512-2wo4EXgxOGSFueqvHAdnmi5JLZzWqMArjuP4nqC26AtLh5PoCPsaRbRdah2xhcwTAMooZfjYiNVNkkmmSMaxOQ==" }, - "ws": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/ws/-/ws-2.3.1.tgz", - "integrity": "sha1-a5Sz5EfLajY/eF6vlK9jWejoHIA=", + "socket.io-parser": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/socket.io-parser/-/socket.io-parser-4.0.2.tgz", + "integrity": "sha512-Bs3IYHDivwf+bAAuW/8xwJgIiBNtlvnjYRc4PbXgniLmcP1BrakBoq/QhO24rgtgW7VZ7uAaswRGxutUnlAK7g==", "requires": { - "safe-buffer": "5.0.1", - "ultron": "1.1.0" - }, - "dependencies": { - "ultron": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/ultron/-/ultron-1.1.0.tgz", - "integrity": "sha1-sHoualQagV/Go0zNRTO67DB8qGQ=" - } + "@types/component-emitter": "^1.2.10", + "component-emitter": "~1.3.0", + "debug": "~4.1.0" } }, - "xmlhttprequest-ssl": { - "version": "1.5.3", - "resolved": "https://registry.npmjs.org/xmlhttprequest-ssl/-/xmlhttprequest-ssl-1.5.3.tgz", - "integrity": "sha1-GFqIjATspGw+QHDZn3tJ3jUomS0=" + "vary": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/vary/-/vary-1.1.2.tgz", + "integrity": "sha1-IpnwLG3tMNSllhsLn3RSShj2NPw=" + }, + "ws": { + "version": "7.4.1", + "resolved": "https://registry.npmjs.org/ws/-/ws-7.4.1.tgz", + "integrity": "sha512-pTsP8UAfhy3sk1lSk/O/s4tjD0CRwvMnzvwr4OKGX7ZvqZtUyx4KIJB5JWbkykPoc55tixMGgTNoh3k4FkNGFQ==", + "requires": {} } } } diff --git a/src/test/resources/package.json b/src/test/resources/package.json index 495be8d5..7685423e 100644 --- a/src/test/resources/package.json +++ b/src/test/resources/package.json @@ -1,6 +1,6 @@ { "private": true, "dependencies": { - "socket.io": "2.0.3" + "socket.io": "^3.0.4" } } diff --git a/src/test/resources/server.js b/src/test/resources/server.js index 08ff53c4..72b02504 100644 --- a/src/test/resources/server.js +++ b/src/test/resources/server.js @@ -18,8 +18,12 @@ var port = process.env.PORT || 3000; var nsp = process.argv[2] || '/'; var slice = Array.prototype.slice; -io.of('/foo').on('connection', function() { - // register namespace +const fooNsp = io.of('/foo'); + +fooNsp.on('connection', (socket) => { + socket.on('room', (...args) => { + fooNsp.to(socket.id).emit.apply(fooNsp, ['roomBack'].concat(args)); + }); }); io.of('/timeout_socket').on('connection', function() { @@ -38,6 +42,12 @@ io.of('/abc').on('connection', function(socket) { socket.emit('handshake', socket.handshake); }); +io.of("/no").use((socket, next) => { + const err = new Error("auth failed"); + err.data = { a: "b", c: 3 }; + next(err); +}); + io.of(nsp).on('connection', function(socket) { socket.send('hello client'); @@ -84,9 +94,8 @@ io.of(nsp).on('connection', function(socket) { socket.broadcast.emit.apply(socket, ['broadcastBack'].concat(args)); }); - socket.on('room', function() { - var args = slice.call(arguments); - io.to(socket.id).emit.apply(socket, ['roomBack'].concat(args)); + socket.on('room', (arg) => { + io.to(socket.id).emit("roomBack", arg); }); socket.on('requestDisconnect', function() {