├── .gitignore
├── .mvn
└── wrapper
│ ├── MavenWrapperDownloader.java
│ ├── maven-wrapper.jar
│ └── maven-wrapper.properties
├── Readme.md
├── mvnw
├── mvnw.cmd
├── pom.xml
├── postman
└── Server Sent Events.postman_collection.json
└── src
├── main
├── java
│ └── pl
│ │ └── mkapiczy
│ │ └── serversentevents
│ │ ├── ServerSentEventsApplication.java
│ │ ├── controller
│ │ └── EventController.java
│ │ ├── mapper
│ │ └── EventMapper.java
│ │ ├── model
│ │ └── EventDto.java
│ │ ├── repository
│ │ ├── EmitterRepository.java
│ │ └── InMemoryEmitterRepository.java
│ │ └── service
│ │ ├── EmitterService.java
│ │ ├── NotificationService.java
│ │ └── SseNotificationService.java
└── resources
│ └── application.properties
└── test
└── java
└── pl
└── mkapiczy
└── serversentevents
├── ServerSentEventsApplicationTests.java
├── controller
└── EventControllerITest.java
├── mapper
└── EventMapperTest.java
├── repository
└── InMemoryEmitterRepositoryTest.java
├── service
├── EmitterServiceTest.java
└── SseNotificationServiceTest.java
└── utils
├── AsyncEventClient.java
└── TestConstants.java
/.gitignore:
--------------------------------------------------------------------------------
1 | HELP.md
2 | target/
3 | !.mvn/wrapper/maven-wrapper.jar
4 | !**/src/main/**
5 | !**/src/test/**
6 |
7 | ### STS ###
8 | .apt_generated
9 | .classpath
10 | .factorypath
11 | .project
12 | .settings
13 | .springBeans
14 | .sts4-cache
15 |
16 | ### IntelliJ IDEA ###
17 | .idea
18 | *.iws
19 | *.iml
20 | *.ipr
21 |
22 | ### NetBeans ###
23 | /nbproject/private/
24 | /nbbuild/
25 | /dist/
26 | /nbdist/
27 | /.nb-gradle/
28 | build/
29 |
30 | ### VS Code ###
31 | .vscode/
32 |
33 |
34 | tmp/
--------------------------------------------------------------------------------
/.mvn/wrapper/MavenWrapperDownloader.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2007-present the original author or authors.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 | import java.net.*;
17 | import java.io.*;
18 | import java.nio.channels.*;
19 | import java.util.Properties;
20 |
21 | public class MavenWrapperDownloader {
22 |
23 | private static final String WRAPPER_VERSION = "0.5.6";
24 | /**
25 | * Default URL to download the maven-wrapper.jar from, if no 'downloadUrl' is provided.
26 | */
27 | private static final String DEFAULT_DOWNLOAD_URL = "https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/"
28 | + WRAPPER_VERSION + "/maven-wrapper-" + WRAPPER_VERSION + ".jar";
29 |
30 | /**
31 | * Path to the maven-wrapper.properties file, which might contain a downloadUrl property to
32 | * use instead of the default one.
33 | */
34 | private static final String MAVEN_WRAPPER_PROPERTIES_PATH =
35 | ".mvn/wrapper/maven-wrapper.properties";
36 |
37 | /**
38 | * Path where the maven-wrapper.jar will be saved to.
39 | */
40 | private static final String MAVEN_WRAPPER_JAR_PATH =
41 | ".mvn/wrapper/maven-wrapper.jar";
42 |
43 | /**
44 | * Name of the property which should be used to override the default download url for the wrapper.
45 | */
46 | private static final String PROPERTY_NAME_WRAPPER_URL = "wrapperUrl";
47 |
48 | public static void main(String args[]) {
49 | System.out.println("- Downloader started");
50 | File baseDirectory = new File(args[0]);
51 | System.out.println("- Using base directory: " + baseDirectory.getAbsolutePath());
52 |
53 | // If the maven-wrapper.properties exists, read it and check if it contains a custom
54 | // wrapperUrl parameter.
55 | File mavenWrapperPropertyFile = new File(baseDirectory, MAVEN_WRAPPER_PROPERTIES_PATH);
56 | String url = DEFAULT_DOWNLOAD_URL;
57 | if(mavenWrapperPropertyFile.exists()) {
58 | FileInputStream mavenWrapperPropertyFileInputStream = null;
59 | try {
60 | mavenWrapperPropertyFileInputStream = new FileInputStream(mavenWrapperPropertyFile);
61 | Properties mavenWrapperProperties = new Properties();
62 | mavenWrapperProperties.load(mavenWrapperPropertyFileInputStream);
63 | url = mavenWrapperProperties.getProperty(PROPERTY_NAME_WRAPPER_URL, url);
64 | } catch (IOException e) {
65 | System.out.println("- ERROR loading '" + MAVEN_WRAPPER_PROPERTIES_PATH + "'");
66 | } finally {
67 | try {
68 | if(mavenWrapperPropertyFileInputStream != null) {
69 | mavenWrapperPropertyFileInputStream.close();
70 | }
71 | } catch (IOException e) {
72 | // Ignore ...
73 | }
74 | }
75 | }
76 | System.out.println("- Downloading from: " + url);
77 |
78 | File outputFile = new File(baseDirectory.getAbsolutePath(), MAVEN_WRAPPER_JAR_PATH);
79 | if(!outputFile.getParentFile().exists()) {
80 | if(!outputFile.getParentFile().mkdirs()) {
81 | System.out.println(
82 | "- ERROR creating output directory '" + outputFile.getParentFile().getAbsolutePath() + "'");
83 | }
84 | }
85 | System.out.println("- Downloading to: " + outputFile.getAbsolutePath());
86 | try {
87 | downloadFileFromURL(url, outputFile);
88 | System.out.println("Done");
89 | System.exit(0);
90 | } catch (Throwable e) {
91 | System.out.println("- Error downloading");
92 | e.printStackTrace();
93 | System.exit(1);
94 | }
95 | }
96 |
97 | private static void downloadFileFromURL(String urlString, File destination) throws Exception {
98 | if (System.getenv("MVNW_USERNAME") != null && System.getenv("MVNW_PASSWORD") != null) {
99 | String username = System.getenv("MVNW_USERNAME");
100 | char[] password = System.getenv("MVNW_PASSWORD").toCharArray();
101 | Authenticator.setDefault(new Authenticator() {
102 | @Override
103 | protected PasswordAuthentication getPasswordAuthentication() {
104 | return new PasswordAuthentication(username, password);
105 | }
106 | });
107 | }
108 | URL website = new URL(urlString);
109 | ReadableByteChannel rbc;
110 | rbc = Channels.newChannel(website.openStream());
111 | FileOutputStream fos = new FileOutputStream(destination);
112 | fos.getChannel().transferFrom(rbc, 0, Long.MAX_VALUE);
113 | fos.close();
114 | rbc.close();
115 | }
116 |
117 | }
118 |
--------------------------------------------------------------------------------
/.mvn/wrapper/maven-wrapper.jar:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mkapiczy/server-sent-events/0cbc141c1a4c07f6314304ca6dc5306ab521f11b/.mvn/wrapper/maven-wrapper.jar
--------------------------------------------------------------------------------
/.mvn/wrapper/maven-wrapper.properties:
--------------------------------------------------------------------------------
1 | distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.6.3/apache-maven-3.6.3-bin.zip
2 | wrapperUrl=https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar
3 |
--------------------------------------------------------------------------------
/Readme.md:
--------------------------------------------------------------------------------
1 | # Server Sent Events
2 | Service for sending real time events to the client
3 |
4 | ### Server sent event
5 | Service is using Server Sent Event for one-way communication with client.
6 | [SSE mozilla web doc refrence]('https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events)
7 |
8 | Events are returned as `text/event-stream` divided into
9 | * `data:` returns json string with body object, includes ISO-8601 timestamp
10 | * `event:` returns type of event
11 | * `id:` id of event used to keep track of which event was received by client
12 |
13 |
14 | ## API
15 |
16 | ### Endpoints
17 |
18 | | Path | Method | Description | Headers | Body |
19 | | :-------: |:----------:| :------------------------------------------------:| :----------:| :-----:|
20 | | `/events` | `GET` | Subscribe for events for given member | `Member-ID`, `Device-Id`, `Last-Event-ID` ||
21 | | `/events` | `POST` | Publish `Event` to given member | `Member-ID` | `Event`|
22 |
23 | ### Event object
24 | Structure:
25 | ```json
26 | {
27 | "event": {
28 | "type": "EVENT_TYPE_WITH_UPPER_CASE",
29 | "body": {
30 | "examplePropertyOfEvent": "exampleValueOfProperty"
31 | }
32 | }
33 | }
34 | ```
35 |
36 | ### Testing
37 | You can use included postman collection for publishing the events. However, postman does not support event-stream content type, so for receiving the events you need to use another client, for instace:
38 | ```
39 | curl -i -H "MemberId: 123" http://localhost:8080/notification/events
40 | ```
--------------------------------------------------------------------------------
/mvnw:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | # ----------------------------------------------------------------------------
3 | # Licensed to the Apache Software Foundation (ASF) under one
4 | # or more contributor license agreements. See the NOTICE file
5 | # distributed with this work for additional information
6 | # regarding copyright ownership. The ASF licenses this file
7 | # to you under the Apache License, Version 2.0 (the
8 | # "License"); you may not use this file except in compliance
9 | # with the License. You may obtain a copy of the License at
10 | #
11 | # https://www.apache.org/licenses/LICENSE-2.0
12 | #
13 | # Unless required by applicable law or agreed to in writing,
14 | # software distributed under the License is distributed on an
15 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 | # KIND, either express or implied. See the License for the
17 | # specific language governing permissions and limitations
18 | # under the License.
19 | # ----------------------------------------------------------------------------
20 |
21 | # ----------------------------------------------------------------------------
22 | # Maven Start Up Batch script
23 | #
24 | # Required ENV vars:
25 | # ------------------
26 | # JAVA_HOME - location of a JDK home dir
27 | #
28 | # Optional ENV vars
29 | # -----------------
30 | # M2_HOME - location of maven2's installed home dir
31 | # MAVEN_OPTS - parameters passed to the Java VM when running Maven
32 | # e.g. to debug Maven itself, use
33 | # set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000
34 | # MAVEN_SKIP_RC - flag to disable loading of mavenrc files
35 | # ----------------------------------------------------------------------------
36 |
37 | if [ -z "$MAVEN_SKIP_RC" ] ; then
38 |
39 | if [ -f /etc/mavenrc ] ; then
40 | . /etc/mavenrc
41 | fi
42 |
43 | if [ -f "$HOME/.mavenrc" ] ; then
44 | . "$HOME/.mavenrc"
45 | fi
46 |
47 | fi
48 |
49 | # OS specific support. $var _must_ be set to either true or false.
50 | cygwin=false;
51 | darwin=false;
52 | mingw=false
53 | case "`uname`" in
54 | CYGWIN*) cygwin=true ;;
55 | MINGW*) mingw=true;;
56 | Darwin*) darwin=true
57 | # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home
58 | # See https://developer.apple.com/library/mac/qa/qa1170/_index.html
59 | if [ -z "$JAVA_HOME" ]; then
60 | if [ -x "/usr/libexec/java_home" ]; then
61 | export JAVA_HOME="`/usr/libexec/java_home`"
62 | else
63 | export JAVA_HOME="/Library/Java/Home"
64 | fi
65 | fi
66 | ;;
67 | esac
68 |
69 | if [ -z "$JAVA_HOME" ] ; then
70 | if [ -r /etc/gentoo-release ] ; then
71 | JAVA_HOME=`java-config --jre-home`
72 | fi
73 | fi
74 |
75 | if [ -z "$M2_HOME" ] ; then
76 | ## resolve links - $0 may be a link to maven's home
77 | PRG="$0"
78 |
79 | # need this for relative symlinks
80 | while [ -h "$PRG" ] ; do
81 | ls=`ls -ld "$PRG"`
82 | link=`expr "$ls" : '.*-> \(.*\)$'`
83 | if expr "$link" : '/.*' > /dev/null; then
84 | PRG="$link"
85 | else
86 | PRG="`dirname "$PRG"`/$link"
87 | fi
88 | done
89 |
90 | saveddir=`pwd`
91 |
92 | M2_HOME=`dirname "$PRG"`/..
93 |
94 | # make it fully qualified
95 | M2_HOME=`cd "$M2_HOME" && pwd`
96 |
97 | cd "$saveddir"
98 | # echo Using m2 at $M2_HOME
99 | fi
100 |
101 | # For Cygwin, ensure paths are in UNIX format before anything is touched
102 | if $cygwin ; then
103 | [ -n "$M2_HOME" ] &&
104 | M2_HOME=`cygpath --unix "$M2_HOME"`
105 | [ -n "$JAVA_HOME" ] &&
106 | JAVA_HOME=`cygpath --unix "$JAVA_HOME"`
107 | [ -n "$CLASSPATH" ] &&
108 | CLASSPATH=`cygpath --path --unix "$CLASSPATH"`
109 | fi
110 |
111 | # For Mingw, ensure paths are in UNIX format before anything is touched
112 | if $mingw ; then
113 | [ -n "$M2_HOME" ] &&
114 | M2_HOME="`(cd "$M2_HOME"; pwd)`"
115 | [ -n "$JAVA_HOME" ] &&
116 | JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`"
117 | fi
118 |
119 | if [ -z "$JAVA_HOME" ]; then
120 | javaExecutable="`which javac`"
121 | if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then
122 | # readlink(1) is not available as standard on Solaris 10.
123 | readLink=`which readlink`
124 | if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then
125 | if $darwin ; then
126 | javaHome="`dirname \"$javaExecutable\"`"
127 | javaExecutable="`cd \"$javaHome\" && pwd -P`/javac"
128 | else
129 | javaExecutable="`readlink -f \"$javaExecutable\"`"
130 | fi
131 | javaHome="`dirname \"$javaExecutable\"`"
132 | javaHome=`expr "$javaHome" : '\(.*\)/bin'`
133 | JAVA_HOME="$javaHome"
134 | export JAVA_HOME
135 | fi
136 | fi
137 | fi
138 |
139 | if [ -z "$JAVACMD" ] ; then
140 | if [ -n "$JAVA_HOME" ] ; then
141 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
142 | # IBM's JDK on AIX uses strange locations for the executables
143 | JAVACMD="$JAVA_HOME/jre/sh/java"
144 | else
145 | JAVACMD="$JAVA_HOME/bin/java"
146 | fi
147 | else
148 | JAVACMD="`which java`"
149 | fi
150 | fi
151 |
152 | if [ ! -x "$JAVACMD" ] ; then
153 | echo "Error: JAVA_HOME is not defined correctly." >&2
154 | echo " We cannot execute $JAVACMD" >&2
155 | exit 1
156 | fi
157 |
158 | if [ -z "$JAVA_HOME" ] ; then
159 | echo "Warning: JAVA_HOME environment variable is not set."
160 | fi
161 |
162 | CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher
163 |
164 | # traverses directory structure from process work directory to filesystem root
165 | # first directory with .mvn subdirectory is considered project base directory
166 | find_maven_basedir() {
167 |
168 | if [ -z "$1" ]
169 | then
170 | echo "Path not specified to find_maven_basedir"
171 | return 1
172 | fi
173 |
174 | basedir="$1"
175 | wdir="$1"
176 | while [ "$wdir" != '/' ] ; do
177 | if [ -d "$wdir"/.mvn ] ; then
178 | basedir=$wdir
179 | break
180 | fi
181 | # workaround for JBEAP-8937 (on Solaris 10/Sparc)
182 | if [ -d "${wdir}" ]; then
183 | wdir=`cd "$wdir/.."; pwd`
184 | fi
185 | # end of workaround
186 | done
187 | echo "${basedir}"
188 | }
189 |
190 | # concatenates all lines of a file
191 | concat_lines() {
192 | if [ -f "$1" ]; then
193 | echo "$(tr -s '\n' ' ' < "$1")"
194 | fi
195 | }
196 |
197 | BASE_DIR=`find_maven_basedir "$(pwd)"`
198 | if [ -z "$BASE_DIR" ]; then
199 | exit 1;
200 | fi
201 |
202 | ##########################################################################################
203 | # Extension to allow automatically downloading the maven-wrapper.jar from Maven-central
204 | # This allows using the maven wrapper in projects that prohibit checking in binary data.
205 | ##########################################################################################
206 | if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then
207 | if [ "$MVNW_VERBOSE" = true ]; then
208 | echo "Found .mvn/wrapper/maven-wrapper.jar"
209 | fi
210 | else
211 | if [ "$MVNW_VERBOSE" = true ]; then
212 | echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..."
213 | fi
214 | if [ -n "$MVNW_REPOURL" ]; then
215 | jarUrl="$MVNW_REPOURL/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar"
216 | else
217 | jarUrl="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar"
218 | fi
219 | while IFS="=" read key value; do
220 | case "$key" in (wrapperUrl) jarUrl="$value"; break ;;
221 | esac
222 | done < "$BASE_DIR/.mvn/wrapper/maven-wrapper.properties"
223 | if [ "$MVNW_VERBOSE" = true ]; then
224 | echo "Downloading from: $jarUrl"
225 | fi
226 | wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar"
227 | if $cygwin; then
228 | wrapperJarPath=`cygpath --path --windows "$wrapperJarPath"`
229 | fi
230 |
231 | if command -v wget > /dev/null; then
232 | if [ "$MVNW_VERBOSE" = true ]; then
233 | echo "Found wget ... using wget"
234 | fi
235 | if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then
236 | wget "$jarUrl" -O "$wrapperJarPath"
237 | else
238 | wget --http-user=$MVNW_USERNAME --http-password=$MVNW_PASSWORD "$jarUrl" -O "$wrapperJarPath"
239 | fi
240 | elif command -v curl > /dev/null; then
241 | if [ "$MVNW_VERBOSE" = true ]; then
242 | echo "Found curl ... using curl"
243 | fi
244 | if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then
245 | curl -o "$wrapperJarPath" "$jarUrl" -f
246 | else
247 | curl --user $MVNW_USERNAME:$MVNW_PASSWORD -o "$wrapperJarPath" "$jarUrl" -f
248 | fi
249 |
250 | else
251 | if [ "$MVNW_VERBOSE" = true ]; then
252 | echo "Falling back to using Java to download"
253 | fi
254 | javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java"
255 | # For Cygwin, switch paths to Windows format before running javac
256 | if $cygwin; then
257 | javaClass=`cygpath --path --windows "$javaClass"`
258 | fi
259 | if [ -e "$javaClass" ]; then
260 | if [ ! -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then
261 | if [ "$MVNW_VERBOSE" = true ]; then
262 | echo " - Compiling MavenWrapperDownloader.java ..."
263 | fi
264 | # Compiling the Java class
265 | ("$JAVA_HOME/bin/javac" "$javaClass")
266 | fi
267 | if [ -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then
268 | # Running the downloader
269 | if [ "$MVNW_VERBOSE" = true ]; then
270 | echo " - Running MavenWrapperDownloader.java ..."
271 | fi
272 | ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR")
273 | fi
274 | fi
275 | fi
276 | fi
277 | ##########################################################################################
278 | # End of extension
279 | ##########################################################################################
280 |
281 | export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"}
282 | if [ "$MVNW_VERBOSE" = true ]; then
283 | echo $MAVEN_PROJECTBASEDIR
284 | fi
285 | MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS"
286 |
287 | # For Cygwin, switch paths to Windows format before running java
288 | if $cygwin; then
289 | [ -n "$M2_HOME" ] &&
290 | M2_HOME=`cygpath --path --windows "$M2_HOME"`
291 | [ -n "$JAVA_HOME" ] &&
292 | JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"`
293 | [ -n "$CLASSPATH" ] &&
294 | CLASSPATH=`cygpath --path --windows "$CLASSPATH"`
295 | [ -n "$MAVEN_PROJECTBASEDIR" ] &&
296 | MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"`
297 | fi
298 |
299 | # Provide a "standardized" way to retrieve the CLI args that will
300 | # work with both Windows and non-Windows executions.
301 | MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $@"
302 | export MAVEN_CMD_LINE_ARGS
303 |
304 | WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain
305 |
306 | exec "$JAVACMD" \
307 | $MAVEN_OPTS \
308 | -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \
309 | "-Dmaven.home=${M2_HOME}" "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \
310 | ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@"
311 |
--------------------------------------------------------------------------------
/mvnw.cmd:
--------------------------------------------------------------------------------
1 | @REM ----------------------------------------------------------------------------
2 | @REM Licensed to the Apache Software Foundation (ASF) under one
3 | @REM or more contributor license agreements. See the NOTICE file
4 | @REM distributed with this work for additional information
5 | @REM regarding copyright ownership. The ASF licenses this file
6 | @REM to you under the Apache License, Version 2.0 (the
7 | @REM "License"); you may not use this file except in compliance
8 | @REM with the License. You may obtain a copy of the License at
9 | @REM
10 | @REM https://www.apache.org/licenses/LICENSE-2.0
11 | @REM
12 | @REM Unless required by applicable law or agreed to in writing,
13 | @REM software distributed under the License is distributed on an
14 | @REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 | @REM KIND, either express or implied. See the License for the
16 | @REM specific language governing permissions and limitations
17 | @REM under the License.
18 | @REM ----------------------------------------------------------------------------
19 |
20 | @REM ----------------------------------------------------------------------------
21 | @REM Maven Start Up Batch script
22 | @REM
23 | @REM Required ENV vars:
24 | @REM JAVA_HOME - location of a JDK home dir
25 | @REM
26 | @REM Optional ENV vars
27 | @REM M2_HOME - location of maven2's installed home dir
28 | @REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands
29 | @REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending
30 | @REM MAVEN_OPTS - parameters passed to the Java VM when running Maven
31 | @REM e.g. to debug Maven itself, use
32 | @REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000
33 | @REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files
34 | @REM ----------------------------------------------------------------------------
35 |
36 | @REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on'
37 | @echo off
38 | @REM set title of command window
39 | title %0
40 | @REM enable echoing by setting MAVEN_BATCH_ECHO to 'on'
41 | @if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO%
42 |
43 | @REM set %HOME% to equivalent of $HOME
44 | if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%")
45 |
46 | @REM Execute a user defined script before this one
47 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre
48 | @REM check for pre script, once with legacy .bat ending and once with .cmd ending
49 | if exist "%HOME%\mavenrc_pre.bat" call "%HOME%\mavenrc_pre.bat"
50 | if exist "%HOME%\mavenrc_pre.cmd" call "%HOME%\mavenrc_pre.cmd"
51 | :skipRcPre
52 |
53 | @setlocal
54 |
55 | set ERROR_CODE=0
56 |
57 | @REM To isolate internal variables from possible post scripts, we use another setlocal
58 | @setlocal
59 |
60 | @REM ==== START VALIDATION ====
61 | if not "%JAVA_HOME%" == "" goto OkJHome
62 |
63 | echo.
64 | echo Error: JAVA_HOME not found in your environment. >&2
65 | echo Please set the JAVA_HOME variable in your environment to match the >&2
66 | echo location of your Java installation. >&2
67 | echo.
68 | goto error
69 |
70 | :OkJHome
71 | if exist "%JAVA_HOME%\bin\java.exe" goto init
72 |
73 | echo.
74 | echo Error: JAVA_HOME is set to an invalid directory. >&2
75 | echo JAVA_HOME = "%JAVA_HOME%" >&2
76 | echo Please set the JAVA_HOME variable in your environment to match the >&2
77 | echo location of your Java installation. >&2
78 | echo.
79 | goto error
80 |
81 | @REM ==== END VALIDATION ====
82 |
83 | :init
84 |
85 | @REM Find the project base dir, i.e. the directory that contains the folder ".mvn".
86 | @REM Fallback to current working directory if not found.
87 |
88 | set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR%
89 | IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir
90 |
91 | set EXEC_DIR=%CD%
92 | set WDIR=%EXEC_DIR%
93 | :findBaseDir
94 | IF EXIST "%WDIR%"\.mvn goto baseDirFound
95 | cd ..
96 | IF "%WDIR%"=="%CD%" goto baseDirNotFound
97 | set WDIR=%CD%
98 | goto findBaseDir
99 |
100 | :baseDirFound
101 | set MAVEN_PROJECTBASEDIR=%WDIR%
102 | cd "%EXEC_DIR%"
103 | goto endDetectBaseDir
104 |
105 | :baseDirNotFound
106 | set MAVEN_PROJECTBASEDIR=%EXEC_DIR%
107 | cd "%EXEC_DIR%"
108 |
109 | :endDetectBaseDir
110 |
111 | IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig
112 |
113 | @setlocal EnableExtensions EnableDelayedExpansion
114 | for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a
115 | @endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS%
116 |
117 | :endReadAdditionalConfig
118 |
119 | SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe"
120 | set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar"
121 | set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain
122 |
123 | set DOWNLOAD_URL="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar"
124 |
125 | FOR /F "tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO (
126 | IF "%%A"=="wrapperUrl" SET DOWNLOAD_URL=%%B
127 | )
128 |
129 | @REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central
130 | @REM This allows using the maven wrapper in projects that prohibit checking in binary data.
131 | if exist %WRAPPER_JAR% (
132 | if "%MVNW_VERBOSE%" == "true" (
133 | echo Found %WRAPPER_JAR%
134 | )
135 | ) else (
136 | if not "%MVNW_REPOURL%" == "" (
137 | SET DOWNLOAD_URL="%MVNW_REPOURL%/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar"
138 | )
139 | if "%MVNW_VERBOSE%" == "true" (
140 | echo Couldn't find %WRAPPER_JAR%, downloading it ...
141 | echo Downloading from: %DOWNLOAD_URL%
142 | )
143 |
144 | powershell -Command "&{"^
145 | "$webclient = new-object System.Net.WebClient;"^
146 | "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^
147 | "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^
148 | "}"^
149 | "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%DOWNLOAD_URL%', '%WRAPPER_JAR%')"^
150 | "}"
151 | if "%MVNW_VERBOSE%" == "true" (
152 | echo Finished downloading %WRAPPER_JAR%
153 | )
154 | )
155 | @REM End of extension
156 |
157 | @REM Provide a "standardized" way to retrieve the CLI args that will
158 | @REM work with both Windows and non-Windows executions.
159 | set MAVEN_CMD_LINE_ARGS=%*
160 |
161 | %MAVEN_JAVA_EXE% %JVM_CONFIG_MAVEN_PROPS% %MAVEN_OPTS% %MAVEN_DEBUG_OPTS% -classpath %WRAPPER_JAR% "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %*
162 | if ERRORLEVEL 1 goto error
163 | goto end
164 |
165 | :error
166 | set ERROR_CODE=1
167 |
168 | :end
169 | @endlocal & set ERROR_CODE=%ERROR_CODE%
170 |
171 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPost
172 | @REM check for post script, once with legacy .bat ending and once with .cmd ending
173 | if exist "%HOME%\mavenrc_post.bat" call "%HOME%\mavenrc_post.bat"
174 | if exist "%HOME%\mavenrc_post.cmd" call "%HOME%\mavenrc_post.cmd"
175 | :skipRcPost
176 |
177 | @REM pause the script if MAVEN_BATCH_PAUSE is set to 'on'
178 | if "%MAVEN_BATCH_PAUSE%" == "on" pause
179 |
180 | if "%MAVEN_TERMINATE_CMD%" == "on" exit %ERROR_CODE%
181 |
182 | exit /B %ERROR_CODE%
183 |
--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
1 |
2 |
4 | 4.0.0
5 |
6 | org.springframework.boot
7 | spring-boot-starter-parent
8 | 2.3.3.RELEASE
9 |
10 |
11 | pl.mkapiczy
12 | server-sent-events
13 | 0.0.1-SNAPSHOT
14 | server-sent-events
15 | Project demonstrating Server Sent Event technology
16 |
17 |
18 | 13
19 | Hoxton.SR4
20 | Lovelace-SR1
21 |
22 |
23 |
24 |
25 |
26 | org.springframework.data
27 | spring-data-releasetrain
28 | ${spring-data.version}
29 | pom
30 | import
31 |
32 |
33 | org.springframework.cloud
34 | spring-cloud-dependencies
35 | ${spring-cloud.version}
36 | pom
37 | import
38 |
39 |
40 |
41 |
42 |
43 |
44 | org.springframework.boot
45 | spring-boot-starter-web
46 |
47 |
48 | org.projectlombok
49 | lombok
50 | true
51 |
52 |
53 | org.apache.commons
54 | commons-lang3
55 | 3.11
56 |
57 |
58 | org.springframework.boot
59 | spring-boot-starter-webflux
60 | test
61 |
62 |
63 | org.awaitility
64 | awaitility
65 | 3.0.0
66 | test
67 |
68 |
69 | org.springframework.boot
70 | spring-boot-starter-test
71 | test
72 |
73 |
74 | org.junit.vintage
75 | junit-vintage-engine
76 |
77 |
78 |
79 |
80 |
81 |
82 |
83 |
84 | org.springframework.boot
85 | spring-boot-maven-plugin
86 |
87 |
88 |
89 |
90 |
91 |
--------------------------------------------------------------------------------
/postman/Server Sent Events.postman_collection.json:
--------------------------------------------------------------------------------
1 | {
2 | "info": {
3 | "_postman_id": "93e0c426-ba81-48f4-ac66-48213f67ecce",
4 | "name": "Server Sent Events",
5 | "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
6 | },
7 | "item": [
8 | {
9 | "name": "Publish Event",
10 | "request": {
11 | "method": "POST",
12 | "header": [
13 | {
14 | "key": "MemberId",
15 | "value": "123",
16 | "type": "text"
17 | }
18 | ],
19 | "body": {
20 | "mode": "raw",
21 | "raw": "{\n \"type\": \"EVENT_TYPE\",\n \"body\": {\n \"result\": \"SUCCESS\"\n }\n}",
22 | "options": {
23 | "raw": {
24 | "language": "json"
25 | }
26 | }
27 | },
28 | "url": {
29 | "raw": "http://localhost:8080/notification/events",
30 | "protocol": "http",
31 | "host": [
32 | "localhost"
33 | ],
34 | "port": "8080",
35 | "path": [
36 | "notification",
37 | "events"
38 | ]
39 | }
40 | },
41 | "response": []
42 | }
43 | ],
44 | "protocolProfileBehavior": {}
45 | }
--------------------------------------------------------------------------------
/src/main/java/pl/mkapiczy/serversentevents/ServerSentEventsApplication.java:
--------------------------------------------------------------------------------
1 | package pl.mkapiczy.serversentevents;
2 |
3 | import org.springframework.boot.SpringApplication;
4 | import org.springframework.boot.autoconfigure.SpringBootApplication;
5 |
6 | @SpringBootApplication
7 | public class ServerSentEventsApplication {
8 |
9 | public static void main(String[] args) {
10 | SpringApplication.run(ServerSentEventsApplication.class, args);
11 | }
12 |
13 | }
14 |
--------------------------------------------------------------------------------
/src/main/java/pl/mkapiczy/serversentevents/controller/EventController.java:
--------------------------------------------------------------------------------
1 | package pl.mkapiczy.serversentevents.controller;
2 |
3 | import lombok.RequiredArgsConstructor;
4 | import lombok.extern.slf4j.Slf4j;
5 | import org.springframework.http.HttpStatus;
6 | import org.springframework.web.bind.annotation.*;
7 | import org.springframework.web.servlet.mvc.method.annotation.SseEmitter;
8 | import pl.mkapiczy.serversentevents.model.EventDto;
9 | import pl.mkapiczy.serversentevents.service.EmitterService;
10 | import pl.mkapiczy.serversentevents.service.NotificationService;
11 |
12 | @Slf4j
13 | @RestController
14 | @RequestMapping("/events")
15 | @RequiredArgsConstructor
16 | public class EventController {
17 | public static final String MEMBER_ID_HEADER = "MemberId";
18 |
19 | private final EmitterService emitterService;
20 | private final NotificationService notificationService;
21 |
22 | @GetMapping
23 | public SseEmitter subscribeToEvents(@RequestHeader(name = MEMBER_ID_HEADER) String memberId) {
24 | log.debug("Subscribing member with id {}", memberId);
25 | return emitterService.createEmitter(memberId);
26 | }
27 |
28 | @PostMapping
29 | @ResponseStatus(HttpStatus.ACCEPTED)
30 | public void publishEvent(@RequestHeader(name = MEMBER_ID_HEADER) String memberId, @RequestBody EventDto event) {
31 | log.debug("Publishing event {} for member with id {}", event, memberId);
32 | notificationService.sendNotification(memberId, event);
33 | }
34 | }
35 |
--------------------------------------------------------------------------------
/src/main/java/pl/mkapiczy/serversentevents/mapper/EventMapper.java:
--------------------------------------------------------------------------------
1 | package pl.mkapiczy.serversentevents.mapper;
2 |
3 | import lombok.AllArgsConstructor;
4 | import lombok.extern.slf4j.Slf4j;
5 | import org.apache.commons.lang3.RandomStringUtils;
6 | import org.springframework.stereotype.Component;
7 | import org.springframework.web.servlet.mvc.method.annotation.SseEmitter;
8 | import pl.mkapiczy.serversentevents.model.EventDto;
9 |
10 | @Component
11 | @Slf4j
12 | @AllArgsConstructor
13 | public class EventMapper {
14 |
15 | public SseEmitter.SseEventBuilder toSseEventBuilder(EventDto event) {
16 | return SseEmitter.event()
17 | .id(RandomStringUtils.randomAlphanumeric(12))
18 | .name(event.getType())
19 | .data(event.getBody());
20 | }
21 | }
22 |
--------------------------------------------------------------------------------
/src/main/java/pl/mkapiczy/serversentevents/model/EventDto.java:
--------------------------------------------------------------------------------
1 | package pl.mkapiczy.serversentevents.model;
2 |
3 | import lombok.AllArgsConstructor;
4 | import lombok.Builder;
5 | import lombok.Data;
6 | import lombok.NoArgsConstructor;
7 |
8 | import java.io.Serializable;
9 | import java.util.Map;
10 |
11 | @Data
12 | @AllArgsConstructor
13 | @NoArgsConstructor
14 | public class EventDto implements Serializable {
15 | private String type;
16 | private Map body;
17 | }
18 |
--------------------------------------------------------------------------------
/src/main/java/pl/mkapiczy/serversentevents/repository/EmitterRepository.java:
--------------------------------------------------------------------------------
1 | package pl.mkapiczy.serversentevents.repository;
2 |
3 | import org.springframework.web.servlet.mvc.method.annotation.SseEmitter;
4 |
5 | import java.util.Map;
6 | import java.util.Optional;
7 |
8 | public interface EmitterRepository {
9 |
10 | void addOrReplaceEmitter(String memberId, SseEmitter emitter);
11 |
12 | void remove(String memberId);
13 |
14 | Optional get(String memberId);
15 | }
16 |
--------------------------------------------------------------------------------
/src/main/java/pl/mkapiczy/serversentevents/repository/InMemoryEmitterRepository.java:
--------------------------------------------------------------------------------
1 | package pl.mkapiczy.serversentevents.repository;
2 |
3 | import lombok.RequiredArgsConstructor;
4 | import lombok.extern.slf4j.Slf4j;
5 | import org.springframework.stereotype.Repository;
6 | import org.springframework.web.servlet.mvc.method.annotation.SseEmitter;
7 |
8 | import java.util.Map;
9 | import java.util.Optional;
10 | import java.util.concurrent.ConcurrentHashMap;
11 |
12 | @Repository
13 | @RequiredArgsConstructor
14 | @Slf4j
15 | public class InMemoryEmitterRepository implements EmitterRepository {
16 |
17 | private Map userEmitterMap = new ConcurrentHashMap<>();
18 |
19 | @Override
20 | public void addOrReplaceEmitter(String memberId, SseEmitter emitter) {
21 | userEmitterMap.put(memberId, emitter);
22 | }
23 |
24 | @Override
25 | public void remove(String memberId) {
26 | if (userEmitterMap != null && userEmitterMap.containsKey(memberId)) {
27 | log.debug("Removing emitter for member: {}", memberId);
28 | userEmitterMap.remove(memberId);
29 | } else {
30 | log.debug("No emitter to remove for member: {}", memberId);
31 | }
32 | }
33 |
34 | @Override
35 | public Optional get(String memberId) {
36 | return Optional.ofNullable(userEmitterMap.get(memberId));
37 | }
38 | }
39 |
--------------------------------------------------------------------------------
/src/main/java/pl/mkapiczy/serversentevents/service/EmitterService.java:
--------------------------------------------------------------------------------
1 | package pl.mkapiczy.serversentevents.service;
2 |
3 | import lombok.extern.slf4j.Slf4j;
4 | import org.springframework.beans.factory.annotation.Value;
5 | import org.springframework.stereotype.Service;
6 | import org.springframework.web.servlet.mvc.method.annotation.SseEmitter;
7 | import pl.mkapiczy.serversentevents.repository.EmitterRepository;
8 |
9 | @Service
10 | @Slf4j
11 | public class EmitterService {
12 |
13 | private final long eventsTimeout;
14 | private final EmitterRepository repository;
15 |
16 | public EmitterService(@Value("${events.connection.timeout}") long eventsTimeout,
17 | EmitterRepository repository) {
18 | this.eventsTimeout = eventsTimeout;
19 | this.repository = repository;
20 | }
21 |
22 | public SseEmitter createEmitter(String memberId) {
23 | SseEmitter emitter = new SseEmitter(eventsTimeout);
24 | emitter.onCompletion(() -> repository.remove(memberId));
25 | emitter.onTimeout(() -> repository.remove(memberId));
26 | emitter.onError(e -> {
27 | log.error("Create SseEmitter exception", e);
28 | repository.remove(memberId);
29 | });
30 | repository.addOrReplaceEmitter(memberId, emitter);
31 | return emitter;
32 | }
33 |
34 | }
35 |
--------------------------------------------------------------------------------
/src/main/java/pl/mkapiczy/serversentevents/service/NotificationService.java:
--------------------------------------------------------------------------------
1 | package pl.mkapiczy.serversentevents.service;
2 |
3 | import pl.mkapiczy.serversentevents.model.EventDto;
4 |
5 | public interface NotificationService {
6 |
7 | void sendNotification(String memberId, EventDto event);
8 | }
9 |
--------------------------------------------------------------------------------
/src/main/java/pl/mkapiczy/serversentevents/service/SseNotificationService.java:
--------------------------------------------------------------------------------
1 | package pl.mkapiczy.serversentevents.service;
2 |
3 | import lombok.AllArgsConstructor;
4 | import lombok.extern.slf4j.Slf4j;
5 | import org.springframework.context.annotation.Primary;
6 | import org.springframework.stereotype.Service;
7 | import pl.mkapiczy.serversentevents.mapper.EventMapper;
8 | import pl.mkapiczy.serversentevents.model.EventDto;
9 | import pl.mkapiczy.serversentevents.repository.EmitterRepository;
10 |
11 | import java.io.IOException;
12 |
13 | @Service
14 | @Primary
15 | @AllArgsConstructor
16 | @Slf4j
17 | public class SseNotificationService implements NotificationService {
18 |
19 | private final EmitterRepository emitterRepository;
20 | private final EventMapper eventMapper;
21 |
22 | @Override
23 | public void sendNotification(String memberId, EventDto event) {
24 | if (event == null) {
25 | log.debug("No server event to send to device.");
26 | return;
27 | }
28 | doSendNotification(memberId, event);
29 | }
30 |
31 | private void doSendNotification(String memberId, EventDto event) {
32 | emitterRepository.get(memberId).ifPresentOrElse(sseEmitter -> {
33 | try {
34 | log.debug("Sending event: {} for member: {}", event, memberId);
35 | sseEmitter.send(eventMapper.toSseEventBuilder(event));
36 | } catch (IOException | IllegalStateException e) {
37 | log.debug("Error while sending event: {} for member: {} - exception: {}", event, memberId, e);
38 | emitterRepository.remove(memberId);
39 | }
40 | }, () -> log.debug("No emitter for member {}", memberId));
41 | }
42 |
43 | }
44 |
--------------------------------------------------------------------------------
/src/main/resources/application.properties:
--------------------------------------------------------------------------------
1 | spring.application.name=server-sent-events
2 | spring.profiles.active=local
3 | events.connection.timeout=180000
4 | server.servlet.context-path=/notification
5 |
--------------------------------------------------------------------------------
/src/test/java/pl/mkapiczy/serversentevents/ServerSentEventsApplicationTests.java:
--------------------------------------------------------------------------------
1 | package pl.mkapiczy.serversentevents;
2 |
3 | import org.junit.jupiter.api.Test;
4 | import org.springframework.boot.test.context.SpringBootTest;
5 |
6 | @SpringBootTest
7 | class ServerSentEventsApplicationTests {
8 |
9 | @Test
10 | void contextLoads() {
11 | }
12 |
13 | }
14 |
--------------------------------------------------------------------------------
/src/test/java/pl/mkapiczy/serversentevents/controller/EventControllerITest.java:
--------------------------------------------------------------------------------
1 | package pl.mkapiczy.serversentevents.controller;
2 |
3 | import org.awaitility.Awaitility;
4 | import org.junit.jupiter.api.BeforeEach;
5 | import org.junit.jupiter.api.Test;
6 | import org.springframework.beans.factory.annotation.Autowired;
7 | import org.springframework.boot.test.context.SpringBootTest;
8 | import org.springframework.boot.test.web.client.TestRestTemplate;
9 | import org.springframework.boot.web.server.LocalServerPort;
10 | import org.springframework.http.HttpEntity;
11 | import org.springframework.http.HttpHeaders;
12 | import org.springframework.http.HttpMethod;
13 | import org.springframework.http.HttpStatus;
14 | import pl.mkapiczy.serversentevents.model.EventDto;
15 | import pl.mkapiczy.serversentevents.utils.AsyncEventClient;
16 |
17 | import java.util.ArrayList;
18 | import java.util.List;
19 | import java.util.UUID;
20 | import java.util.concurrent.TimeUnit;
21 |
22 | import static org.assertj.core.api.Assertions.assertThat;
23 | import static pl.mkapiczy.serversentevents.controller.EventController.MEMBER_ID_HEADER;
24 | import static pl.mkapiczy.serversentevents.utils.TestConstants.EVENT_DTO;
25 |
26 | @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
27 | public class EventControllerITest {
28 |
29 | private AsyncEventClient asyncEventClient;
30 |
31 | @Autowired
32 | private TestRestTemplate testRestTemplate;
33 |
34 | @LocalServerPort
35 | int serverPort;
36 |
37 | private String memberId;
38 |
39 | @BeforeEach
40 | void setup() {
41 | memberId = UUID.randomUUID().toString();
42 | this.asyncEventClient = new AsyncEventClient(serverPort);
43 | }
44 |
45 | @Test
46 | void shouldReceiveEvent() throws InterruptedException {
47 | var eventStream = asyncEventClient.getEvents(memberId);
48 |
49 | List receivedEvents = new ArrayList<>();
50 | var disposable = eventStream.subscribe(
51 | event -> {
52 | receivedEvents.add(new EventDto(event.event(), event.data()));
53 | },
54 | error -> {throw new AssertionError("Event stream error");});
55 |
56 | waitForSubscription();
57 | publishEvent(memberId);
58 |
59 | Awaitility.await()
60 | .pollDelay(3, TimeUnit.SECONDS)
61 | .until(() -> receivedEvents.size() == 1);
62 | EventDto receivedEvent = receivedEvents.get(0);
63 | assertThat(receivedEvent).isEqualToComparingFieldByField(EVENT_DTO);
64 | disposable.dispose();
65 |
66 | }
67 |
68 | @Test
69 | void shouldNotReceiveEventForWrongMemberId() throws InterruptedException {
70 | var eventStream = asyncEventClient.getEvents(memberId);
71 |
72 | List receivedEvents = new ArrayList<>();
73 | var disposable = eventStream.subscribe(
74 | event -> receivedEvents.add(new EventDto(event.event(), event.data())),
75 | error -> {throw new AssertionError("Event stream error");});
76 |
77 | waitForSubscription();
78 | publishEvent("WRONG_MEMBER_ID");
79 |
80 | Awaitility.await()
81 | .pollDelay(3, TimeUnit.SECONDS)
82 | .until(receivedEvents::isEmpty);
83 | disposable.dispose();
84 | }
85 |
86 | @Test
87 | void shouldGetBadRequestOnSubscriptionWithoutMemberId() {
88 | var statusCode = asyncEventClient.getEventsWithoutHeader();
89 | assertThat(statusCode).isEqualTo(HttpStatus.BAD_REQUEST);
90 | }
91 |
92 | private void publishEvent(String memberId) {
93 | HttpHeaders headers = new HttpHeaders();
94 | headers.add(MEMBER_ID_HEADER, memberId);
95 | headers.add("Content-Type", "application/json");
96 | testRestTemplate.exchange("/events", HttpMethod.POST, new HttpEntity<>(EVENT_DTO, headers), Void.class);
97 | }
98 |
99 | private void waitForSubscription() throws InterruptedException {
100 | Thread.sleep(200);
101 | }
102 | }
--------------------------------------------------------------------------------
/src/test/java/pl/mkapiczy/serversentevents/mapper/EventMapperTest.java:
--------------------------------------------------------------------------------
1 | package pl.mkapiczy.serversentevents.mapper;
2 |
3 | import org.junit.jupiter.api.Test;
4 | import org.springframework.web.servlet.mvc.method.annotation.SseEmitter;
5 |
6 | import static org.assertj.core.api.Assertions.assertThat;
7 | import static pl.mkapiczy.serversentevents.utils.TestConstants.EVENT_DTO;
8 |
9 | class EventMapperTest {
10 |
11 | private EventMapper eventMapper = new EventMapper();
12 |
13 | @Test
14 | void shouldMapToSseEventBuilder() {
15 | SseEmitter.SseEventBuilder sseEventBuilder = eventMapper.toSseEventBuilder(EVENT_DTO);
16 |
17 | assertThat(sseEventBuilder).isNotNull();
18 | }
19 |
20 | }
--------------------------------------------------------------------------------
/src/test/java/pl/mkapiczy/serversentevents/repository/InMemoryEmitterRepositoryTest.java:
--------------------------------------------------------------------------------
1 | package pl.mkapiczy.serversentevents.repository;
2 |
3 | import org.junit.jupiter.api.Test;
4 | import org.springframework.web.servlet.mvc.method.annotation.SseEmitter;
5 |
6 | import java.util.Optional;
7 |
8 | import static org.assertj.core.api.Assertions.assertThat;
9 | import static pl.mkapiczy.serversentevents.utils.TestConstants.MEMBER_ID;
10 |
11 | class InMemoryEmitterRepositoryTest {
12 |
13 | private InMemoryEmitterRepository inMemoryEmitterRepository = new InMemoryEmitterRepository();
14 |
15 | @Test
16 | void shouldAddNewEmitter() {
17 | assertThat(inMemoryEmitterRepository.get(MEMBER_ID)).isEmpty();
18 |
19 | SseEmitter emitter = new SseEmitter();
20 | inMemoryEmitterRepository.addOrReplaceEmitter(MEMBER_ID, emitter);
21 |
22 | Optional emitterAfterAddOptional = inMemoryEmitterRepository.get(MEMBER_ID);
23 | assertThat(emitterAfterAddOptional).isNotEmpty();
24 | assertThat(emitterAfterAddOptional.get()).isEqualTo(emitter);
25 | }
26 |
27 | @Test
28 | void shouldReplaceExistingEmitter() {
29 | SseEmitter firstEmitter = new SseEmitter();
30 | inMemoryEmitterRepository.addOrReplaceEmitter(MEMBER_ID, firstEmitter);
31 |
32 | SseEmitter secondEmitter = new SseEmitter();
33 | inMemoryEmitterRepository.addOrReplaceEmitter(MEMBER_ID, secondEmitter);
34 |
35 | Optional emitterAfterReplaceOptional = inMemoryEmitterRepository.get(MEMBER_ID);
36 | assertThat(emitterAfterReplaceOptional).isNotEmpty();
37 | assertThat(emitterAfterReplaceOptional.get()).isEqualTo(secondEmitter);
38 | }
39 |
40 | @Test
41 | void shouldRemoveExistingEmitter() {
42 | inMemoryEmitterRepository.addOrReplaceEmitter(MEMBER_ID, new SseEmitter());
43 | assertThat(inMemoryEmitterRepository.get(MEMBER_ID)).isNotEmpty();
44 |
45 | inMemoryEmitterRepository.remove(MEMBER_ID);
46 | assertThat(inMemoryEmitterRepository.get(MEMBER_ID)).isEmpty();
47 | }
48 |
49 | @Test
50 | void shouldDoNothingOnRemoveNonExistingEmitter() {
51 | assertThat(inMemoryEmitterRepository.get(MEMBER_ID)).isEmpty();
52 | inMemoryEmitterRepository.remove(MEMBER_ID);
53 | assertThat(inMemoryEmitterRepository.get(MEMBER_ID)).isEmpty();
54 | }
55 |
56 | }
--------------------------------------------------------------------------------
/src/test/java/pl/mkapiczy/serversentevents/service/EmitterServiceTest.java:
--------------------------------------------------------------------------------
1 | package pl.mkapiczy.serversentevents.service;
2 |
3 | import org.junit.jupiter.api.BeforeEach;
4 | import org.junit.jupiter.api.Test;
5 | import org.junit.jupiter.api.extension.ExtendWith;
6 | import org.mockito.Mock;
7 | import org.mockito.junit.jupiter.MockitoExtension;
8 | import pl.mkapiczy.serversentevents.repository.EmitterRepository;
9 |
10 | import java.util.UUID;
11 |
12 | import static org.assertj.core.api.Assertions.assertThat;
13 | import static org.mockito.ArgumentMatchers.eq;
14 | import static org.mockito.Mockito.verify;
15 |
16 | @ExtendWith(MockitoExtension.class)
17 | class EmitterServiceTest {
18 |
19 | @Mock
20 | private EmitterRepository emitterRepository;
21 |
22 | private EmitterService emitterService;
23 |
24 | @BeforeEach
25 | void setUp() {
26 | emitterService = new EmitterService(10, emitterRepository);
27 | }
28 |
29 | @Test
30 | void shouldReturnNewEmitter() {
31 | var memberId = UUID.randomUUID().toString();
32 |
33 | var emitter = emitterService.createEmitter(memberId);
34 |
35 | assertThat(emitter).isNotNull();
36 | verify(emitterRepository).addOrReplaceEmitter(eq(memberId), eq(emitter));
37 | }
38 |
39 | }
--------------------------------------------------------------------------------
/src/test/java/pl/mkapiczy/serversentevents/service/SseNotificationServiceTest.java:
--------------------------------------------------------------------------------
1 | package pl.mkapiczy.serversentevents.service;
2 |
3 | import org.junit.jupiter.api.Test;
4 | import org.junit.jupiter.api.extension.ExtendWith;
5 | import org.mockito.InjectMocks;
6 | import org.mockito.Mock;
7 | import org.mockito.junit.jupiter.MockitoExtension;
8 | import org.springframework.web.servlet.mvc.method.annotation.SseEmitter;
9 | import pl.mkapiczy.serversentevents.mapper.EventMapper;
10 | import pl.mkapiczy.serversentevents.repository.EmitterRepository;
11 |
12 | import java.io.IOException;
13 | import java.util.Optional;
14 |
15 | import static org.mockito.Mockito.*;
16 | import static pl.mkapiczy.serversentevents.utils.TestConstants.*;
17 |
18 | @ExtendWith(MockitoExtension.class)
19 | class SseNotificationServiceTest {
20 | @Mock
21 | private EmitterRepository emitterRepository;
22 | @Mock
23 | private EventMapper eventMapper;
24 | @InjectMocks
25 | private SseNotificationService sseNotificationService;
26 |
27 | @Test
28 | void shouldSendEvent() throws IOException {
29 | SseEmitter emitterSpy = spy(new SseEmitter());
30 | when(emitterRepository.get(MEMBER_ID)).thenReturn(Optional.of(emitterSpy));
31 | when(eventMapper.toSseEventBuilder(EVENT_DTO)).thenReturn(SSE_EVENT_BUILDER);
32 |
33 | sseNotificationService.sendNotification(MEMBER_ID, EVENT_DTO);
34 |
35 | verify(emitterSpy).send(eq(SSE_EVENT_BUILDER));
36 | }
37 |
38 | @Test
39 | void shouldDoNothingOnPassedNullEvent() {
40 | sseNotificationService.sendNotification(MEMBER_ID, null);
41 |
42 | verifyNoInteractions(emitterRepository);
43 | verifyNoInteractions(eventMapper);
44 | }
45 |
46 | @Test
47 | void shouldDoNothingOnMissingEmitter() {
48 | when(emitterRepository.get(MEMBER_ID)).thenReturn(Optional.empty());
49 |
50 | sseNotificationService.sendNotification(MEMBER_ID, EVENT_DTO);
51 |
52 | verifyNoInteractions(eventMapper);
53 | }
54 |
55 | }
--------------------------------------------------------------------------------
/src/test/java/pl/mkapiczy/serversentevents/utils/AsyncEventClient.java:
--------------------------------------------------------------------------------
1 | package pl.mkapiczy.serversentevents.utils;
2 |
3 | import lombok.extern.slf4j.Slf4j;
4 | import org.springframework.core.ParameterizedTypeReference;
5 | import org.springframework.http.HttpStatus;
6 | import org.springframework.http.codec.ServerSentEvent;
7 | import org.springframework.web.reactive.function.client.ClientResponse;
8 | import org.springframework.web.reactive.function.client.WebClient;
9 | import reactor.core.publisher.Flux;
10 | import reactor.core.publisher.Mono;
11 |
12 | import java.time.Duration;
13 | import java.util.Map;
14 |
15 | import static pl.mkapiczy.serversentevents.controller.EventController.MEMBER_ID_HEADER;
16 |
17 | @Slf4j
18 | public class AsyncEventClient {
19 |
20 | private WebClient webClient;
21 |
22 | private final ParameterizedTypeReference>> type =
23 | new ParameterizedTypeReference<>() {
24 | };
25 |
26 | public AsyncEventClient(int serverPort) {
27 | this.webClient = WebClient.builder()
28 | .baseUrl("http://localhost:" + serverPort)
29 | .build();
30 | }
31 |
32 | public Flux>> getEvents(String memberId) {
33 | var requestSpec = webClient.get()
34 | .uri("/events")
35 | .header(MEMBER_ID_HEADER, memberId);
36 |
37 | return requestSpec.retrieve().bodyToFlux(type);
38 | }
39 |
40 | public HttpStatus getEventsWithoutHeader() {
41 | Mono response = webClient.get()
42 | .uri("/events")
43 | .exchange();
44 |
45 | return response.block(Duration.ofMillis(500)).statusCode();
46 | }
47 |
48 | }
49 |
--------------------------------------------------------------------------------
/src/test/java/pl/mkapiczy/serversentevents/utils/TestConstants.java:
--------------------------------------------------------------------------------
1 | package pl.mkapiczy.serversentevents.utils;
2 |
3 | import org.apache.commons.lang3.RandomStringUtils;
4 | import org.springframework.web.servlet.mvc.method.annotation.SseEmitter;
5 | import pl.mkapiczy.serversentevents.model.EventDto;
6 |
7 | import java.util.Map;
8 |
9 | public class TestConstants {
10 | public static final String MEMBER_ID = "MEMBER_ID";
11 | public static final String TYPE = "type";
12 | public static final Map BODY = Map.of("Result", "SUCCESS");
13 | public static final EventDto EVENT_DTO = new EventDto(TYPE, BODY);
14 |
15 | public static final SseEmitter.SseEventBuilder SSE_EVENT_BUILDER = SseEmitter.event()
16 | .id(RandomStringUtils.randomAlphanumeric(12))
17 | .name(TYPE)
18 | .data(BODY);
19 | }
20 |
--------------------------------------------------------------------------------