diff --git a/.ldrelease/config.yml b/.ldrelease/config.yml index ed8d9d2..a8b8ec0 100644 --- a/.ldrelease/config.yml +++ b/.ldrelease/config.yml @@ -6,7 +6,7 @@ repo: jobs: - docker: - image: gradle:6.8.3-jdk11 + image: gradle:7.6-jdk11 template: name: gradle diff --git a/.ldrelease/publish.sh b/.ldrelease/publish.sh index a2e9637..677f638 100755 --- a/.ldrelease/publish.sh +++ b/.ldrelease/publish.sh @@ -4,4 +4,9 @@ set -ue # Publish to Sonatype echo "Publishing to Sonatype" -./gradlew publishToSonatype closeAndReleaseRepository || { echo "Gradle publish/release failed" >&2; exit 1; } +if [[ -n "${LD_RELEASE_IS_PRERELEASE}" ]]; then + ./gradlew publishToSonatype || { echo "Gradle publish/release failed" >&2; exit 1; } +else + ./gradlew publishToSonatype closeAndReleaseRepository || { echo "Gradle publish/release failed" >&2; exit 1; } +fi + diff --git a/build.gradle.kts b/build.gradle.kts index ff93d12..1ef1a9d 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -76,6 +76,7 @@ dependencies { } checkstyle { + toolVersion = "9.3" configFile = file("${project.rootDir}/checkstyle.xml") } diff --git a/checkstyle.xml b/checkstyle.xml index de0742b..0101956 100644 --- a/checkstyle.xml +++ b/checkstyle.xml @@ -5,7 +5,7 @@ - + diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar index e708b1c..7454180 100644 Binary files a/gradle/wrapper/gradle-wrapper.jar and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index 2e6e589..070cb70 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,5 +1,5 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-7.3.3-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-bin.zip zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew index 4f906e0..1b6c787 100755 --- a/gradlew +++ b/gradlew @@ -1,7 +1,7 @@ -#!/usr/bin/env sh +#!/bin/sh # -# Copyright 2015 the original author or authors. +# Copyright © 2015-2021 the original authors. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -17,67 +17,101 @@ # ############################################################################## -## -## Gradle start up script for UN*X -## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# ############################################################################## # 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 +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac done -SAVED="`pwd`" -cd "`dirname \"$PRG\"`/" >/dev/null -APP_HOME="`pwd -P`" -cd "$SAVED" >/dev/null + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit APP_NAME="Gradle" -APP_BASE_NAME=`basename "$0"` +APP_BASE_NAME=${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" +MAX_FD=maximum warn () { echo "$*" -} +} >&2 die () { echo echo "$*" echo exit 1 -} +} >&2 # 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 - ;; - MINGW* ) - msys=true - ;; - NONSTOP* ) - nonstop=true - ;; +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 @@ -87,9 +121,9 @@ CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 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" + JAVACMD=$JAVA_HOME/jre/sh/java else - JAVACMD="$JAVA_HOME/bin/java" + JAVACMD=$JAVA_HOME/bin/java fi if [ ! -x "$JAVACMD" ] ; then die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME @@ -98,7 +132,7 @@ Please set the JAVA_HOME variable in your environment to match the location of your Java installation." fi else - JAVACMD="java" + 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 @@ -106,80 +140,95 @@ 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 +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac 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 +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. # 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 +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + # 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\"" + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) fi - i=`expr $i + 1` + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg 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; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# -# 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" +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' exec "$JAVACMD" "$@" diff --git a/src/main/java/com/launchdarkly/eventsource/EventParser.java b/src/main/java/com/launchdarkly/eventsource/EventParser.java index b60ba60..02bdffe 100644 --- a/src/main/java/com/launchdarkly/eventsource/EventParser.java +++ b/src/main/java/com/launchdarkly/eventsource/EventParser.java @@ -424,7 +424,10 @@ public int read(byte[] b, int off, int len) throws IOException { // (B) We must ask lineParser to give us another chunk of a not-yet-finished line. if (!lineEnded) { if (!canGetNextChunk()) { - return -1; // EOF + // The underlying SSE stream has run out of data while we were still trying to + // read the rest of the message. This is an abnormal condition, so we'll treat + // it as an exception, rather than just returning -1 to indicate EOF. + throw new StreamClosedWithIncompleteMessageException(); } haveChunk = true; continue; // We'll go to (A) in the next loop @@ -433,10 +436,15 @@ public int read(byte[] b, int off, int len) throws IOException { // (C) The previous line was done; ask lineParser to give us the next line (or at // least the first chunk of it). if (!canGetNextChunk()) { - return -1; // EOF + // See comment above about abnormal termination. Even if we just finished + // reading a complete line of data, the message is incomplete because we didn't + // see a blank line. + throw new StreamClosedWithIncompleteMessageException(); } if (lineEnded && chunkSize == 0) { - // Blank line means end of message - close this stream and return EOF. + // Blank line means end of message - close this stream and return EOF. This is a + // normal condition: the stream of data for this message is done because the + // message is finished. closed.set(true); resetState(); return -1; diff --git a/src/main/java/com/launchdarkly/eventsource/EventSource.java b/src/main/java/com/launchdarkly/eventsource/EventSource.java index a02a14f..cf276d9 100644 --- a/src/main/java/com/launchdarkly/eventsource/EventSource.java +++ b/src/main/java/com/launchdarkly/eventsource/EventSource.java @@ -465,6 +465,11 @@ public Iterator iterator() { * will start the stream again. *

* If the stream is not currently active, calling this method has no effect. + *

+ * Note for Android developers: since it is generally undesirable to perform + * any network activity from the main thread, be aware that {@link #interrupt()}, + * {@link #stop()}, and {@link #close()} all cause an immediate close of the + * connection (if any), which happens on the same thread that called the method. * * @since 4.0.0 * @see #stop() @@ -491,6 +496,11 @@ public void interrupt() { * will start the stream again. *

* If the stream is not currently active, calling this method has no effect. + *

+ * Note for Android developers: since it is generally undesirable to perform + * any network activity from the main thread, be aware that {@link #interrupt()}, + * {@link #stop()}, and {@link #close()} all cause an immediate close of the + * connection (if any), which happens on the same thread that called the method. * * @since 4.0.0 * @see #interrupt() @@ -506,6 +516,11 @@ public void stop() { * This is similar to {@link #stop()} except that it also releases any resources that * the EventSource was maintaining in general, such as an HTTP connection pool. Do * not try to use the EventSource after closing it. + *

+ * Note for Android developers: since it is generally undesirable to perform + * any network activity from the main thread, be aware that {@link #interrupt()}, + * {@link #stop()}, and {@link #close()} all cause an immediate close of the + * connection (if any), which happens on the same thread that called the method. */ @Override public void close() { @@ -947,9 +962,10 @@ public Builder logger(LDLogger logger) { * If you set it to {@code true}, it will instead call the handler as soon as it sees a {@code data} field-- * setting {@link MessageEvent#getDataReader()} to a {@link java.io.Reader} that reads directly from the data as * it arrives. The EventSource will perform any necessary parsing under the covers, so that for instance if there - * are multiple {@code data:} lines in the event, the {@link java.io.Reader} will emit a newline character between - * each and will not see the "data:" field names. The {@link java.io.Reader} will report "end of stream" as soon - * as the event is terminated normally by a blank line. + * are multiple {@code data:} lines in the event, the Reader will emit a newline character between + * each and will not see the "data:" field names. The Reader will report "end of stream" as soon + * as the event is terminated normally by a blank line. If the stream is closed before normal termination of + * the event, the Reader will throw a {@link StreamClosedWithIncompleteMessageException}. *

* This mode is designed for applications that expect very large data items to be delivered over SSE. Use it * with caution, since there are several limitations: @@ -963,7 +979,8 @@ public Builder logger(LDLogger logger) { *

  • The SSE protocol specifies that an event should be processed only if it is terminated by a blank line, but * in this mode the handler will receive the event as soon as a {@code data:} field appears-- so, if the stream * happens to cut off abnormally without a trailing blank line, technically you will be receiving an incomplete - * event that should have been ignored.
    • + * event that should have been ignored. You will know this has happened ifbecause reading from the Reader throws + * a {@link StreamClosedWithIncompleteMessageException}. * * * @param streamEventData true if events should be dispatched immediately with asynchronous data rather than diff --git a/src/main/java/com/launchdarkly/eventsource/MessageEvent.java b/src/main/java/com/launchdarkly/eventsource/MessageEvent.java index c00191f..819aed0 100644 --- a/src/main/java/com/launchdarkly/eventsource/MessageEvent.java +++ b/src/main/java/com/launchdarkly/eventsource/MessageEvent.java @@ -195,7 +195,13 @@ public String getData() { *

    * The method will never return {@code null}; every event has data, even if the data is empty * (zero length). - * + *

    + * If the stream connection is closed before a complete SSE message has been received (that is, + * before the usual blank line that would terminate a message), then instead of a normal EOF, + * the Reader will throw a {@link StreamClosedWithIncompleteMessageException}. If this happens, + * the application should generally discard the entire {@link MessageEvent} and not try to + * process it further. + * * @return a reader for the event data * @since 2.6.0 */ diff --git a/src/main/java/com/launchdarkly/eventsource/StreamClosedWithIncompleteMessageException.java b/src/main/java/com/launchdarkly/eventsource/StreamClosedWithIncompleteMessageException.java new file mode 100644 index 0000000..06e380f --- /dev/null +++ b/src/main/java/com/launchdarkly/eventsource/StreamClosedWithIncompleteMessageException.java @@ -0,0 +1,12 @@ +package com.launchdarkly.eventsource; + +import java.io.IOException; + +/** + * @author elibishop + * + */ +@SuppressWarnings("serial") +public class StreamClosedWithIncompleteMessageException extends IOException { + +} diff --git a/src/test/java/com/launchdarkly/eventsource/EventParserStreamingDataTest.java b/src/test/java/com/launchdarkly/eventsource/EventParserStreamingDataTest.java index 3e7147b..17838ec 100644 --- a/src/test/java/com/launchdarkly/eventsource/EventParserStreamingDataTest.java +++ b/src/test/java/com/launchdarkly/eventsource/EventParserStreamingDataTest.java @@ -1,5 +1,6 @@ package com.launchdarkly.eventsource; +import org.junit.Assert; import org.junit.Test; import java.io.IOException; @@ -10,6 +11,7 @@ import static org.hamcrest.Matchers.equalTo; import static org.hamcrest.Matchers.is; import static org.hamcrest.Matchers.nullValue; +import static org.junit.Assert.fail; @SuppressWarnings("javadoc") public class EventParserStreamingDataTest extends EventParserBaseTest { @@ -179,7 +181,22 @@ public void incompletelyReadEventIsSkippedIfAnotherMessageIsRead() throws Except } @Test - public void streamIsClosedBeforeEndOfEvent() throws Exception { + public void streamIsClosedImmediatelyAfterEndOfEvent() throws Exception { + String streamData = "data: hello\n\n"; + initParser(100, true); + processData(streamData); + + MessageEvent e1 = awaitMessageEvent(); + assertThat(e1.isStreamingData(), is(true)); + assertThat(readUpToLimit(e1.getDataReader(), 5), equalTo("hello")); + + closeStream(); + + assertThat(e1.getDataReader().read(), equalTo(-1)); // normal EOF, not an error + } + + @Test + public void streamIsClosedBeforeEndOfEventAtEndOfLine() throws Exception { String streamData = "data: hello\n"; initParser(100, true); processData(streamData); @@ -190,7 +207,28 @@ public void streamIsClosedBeforeEndOfEvent() throws Exception { closeStream(); - assertThat(e1.getDataReader().read(), equalTo(-1)); + try { + e1.getDataReader().read(); + fail("expected exception"); + } catch (StreamClosedWithIncompleteMessageException e) {} + } + + @Test + public void streamIsClosedBeforeEndOfEventWithinLine() throws Exception { + String streamData = "data: hello"; + initParser(100, true); + processData(streamData); + + MessageEvent e1 = awaitMessageEvent(); + assertThat(e1.isStreamingData(), is(true)); + assertThat(readUpToLimit(e1.getDataReader(), 5), equalTo("hello")); + + closeStream(); + + try { + e1.getDataReader().read(); + fail("expected exception"); + } catch (StreamClosedWithIncompleteMessageException e) {} } @Test