From 7db4075d6d8a63393f66ba8b78d6880ec384f5bc Mon Sep 17 00:00:00 2001 From: Tihomir Surdilovic Date: Sat, 28 Jan 2023 12:18:55 -0500 Subject: [PATCH] updates to diagram-rest module Signed-off-by: Tihomir Surdilovic --- README.md | 24 ++ .../api/workflow/DataInputSchema.java | 3 +- api_rest/mvnw | 316 ------------------ api_rest/mvnw.cmd | 188 ----------- api_rest/pom.xml | 111 ------ .../ControllerErrorException.java | 22 -- .../reactive_api_rest/RouterPaths.java | 22 -- diagram-rest/pom.xml | 58 ++++ .../reactive_api_rest/Application.java | 5 +- .../reactive_api_rest/RouterRest.java | 11 +- .../RouterRestInterface.java | 9 +- .../ServerlesRequestHelper.java | 6 +- .../reactive_api_rest/ServerlessRequest.java | 8 +- .../ServerlessWorkFlowResponse.java | 8 +- .../src/main/resources/application.yml | 2 +- .../templates/plantuml/custom-template.txt | 0 .../ServerlesRequestHelperTest.java | 1 + diagram/pom.xml | 2 +- pom.xml | 1 - 19 files changed, 100 insertions(+), 697 deletions(-) delete mode 100644 api_rest/mvnw delete mode 100644 api_rest/mvnw.cmd delete mode 100644 api_rest/pom.xml delete mode 100644 api_rest/src/main/java/io/serverlessworkflow/reactive_api_rest/ControllerErrorException.java delete mode 100644 api_rest/src/main/java/io/serverlessworkflow/reactive_api_rest/RouterPaths.java create mode 100644 diagram-rest/pom.xml rename {api_rest => diagram-rest}/src/main/java/io/serverlessworkflow/reactive_api_rest/Application.java (99%) rename {api_rest => diagram-rest}/src/main/java/io/serverlessworkflow/reactive_api_rest/RouterRest.java (83%) rename api_rest/src/main/java/io/serverlessworkflow/reactive_api_rest/IRouterRest.java => diagram-rest/src/main/java/io/serverlessworkflow/reactive_api_rest/RouterRestInterface.java (88%) rename {api_rest => diagram-rest}/src/main/java/io/serverlessworkflow/reactive_api_rest/ServerlesRequestHelper.java (90%) rename {api_rest => diagram-rest}/src/main/java/io/serverlessworkflow/reactive_api_rest/ServerlessRequest.java (86%) rename {api_rest => diagram-rest}/src/main/java/io/serverlessworkflow/reactive_api_rest/ServerlessWorkFlowResponse.java (89%) rename {api_rest => diagram-rest}/src/main/resources/application.yml (80%) rename {api_rest => diagram-rest}/src/main/resources/templates/plantuml/custom-template.txt (100%) rename {api_rest => diagram-rest}/src/test/java/io/serverlessworkflow/reactive_api_rest/ServerlesRequestHelperTest.java (96%) diff --git a/README.md b/README.md index 5694f7ed..aa0a5ad9 100644 --- a/README.md +++ b/README.md @@ -355,3 +355,27 @@ FunctionDefinition finalizeApplicationFunctionDefinition = List actionsForFunctionDefinition = WorkflowUtils.getActionsForFunctionDefinition(workflow, functionRefName); ``` + +#### Extra + +SDK includes extra functionalities which are not part of core modules but +are very useful and can be used as addons to the core: + +##### Diagram REST +This is a Spring Boot app which builds a rest api for diagram generation. +It was contributed by our community member David Marques. + +To start using it: + +``` +cd diagram-rest +mvn clean install spring-boot:run +``` + +Then you can get the diagram SVG for a workflow definition for example: + +``` +curl -X POST localhost:8090/diagram -d '{"id":"booklending","name":"Book Lending Workflow","version":"1.0","specVersion":"0.8","start":"Book Lending Request","states":[{"name":"Book Lending Request","type":"event","onEvents":[{"eventRefs":["Book Lending Request Event"]}],"transition":"Get Book Status"},{"name":"Get Book Status","type":"operation","actions":[{"functionRef":{"refName":"Get status for book","arguments":{"bookid":"${ .book.id }"}}}],"transition":"Book Status Decision"},{"name":"Book Status Decision","type":"switch","dataConditions":[{"name":"Book is on loan","condition":"${ .book.status == \"onloan\" }","transition":"Report Status To Lender"},{"name":"Check is available","condition":"${ .book.status == \"available\" }","transition":"Check Out Book"}]},{"name":"Report Status To Lender","type":"operation","actions":[{"functionRef":{"refName":"Send status to lender","arguments":{"bookid":"${ .book.id }","message":"Book ${ .book.title } is already on loan"}}}],"transition":"Wait for Lender response"},{"name":"Wait for Lender response","type":"switch","eventConditions":[{"name":"Hold Book","eventRef":"Hold Book Event","transition":"Request Hold"},{"name":"Decline Book Hold","eventRef":"Decline Hold Event","transition":"Cancel Request"}]},{"name":"Request Hold","type":"operation","actions":[{"functionRef":{"refName":"Request hold for lender","arguments":{"bookid":"${ .book.id }","lender":"${ .lender }"}}}],"transition":"Wait two weeks"},{"name":"Wait two weeks","type":"sleep","duration":"P2W","transition":"Get Book Status"},{"name":"Check Out Book","type":"operation","actions":[{"functionRef":{"refName":"Check out book with id","arguments":{"bookid":"${ .book.id }"}}},{"functionRef":{"refName":"Notify Lender for checkout","arguments":{"bookid":"${ .book.id }","lender":"${ .lender }"}}}],"end":true}],"functions":[],"events":[]}' +``` + + diff --git a/api/src/main/java/io/serverlessworkflow/api/workflow/DataInputSchema.java b/api/src/main/java/io/serverlessworkflow/api/workflow/DataInputSchema.java index 422edf48..efadb036 100644 --- a/api/src/main/java/io/serverlessworkflow/api/workflow/DataInputSchema.java +++ b/api/src/main/java/io/serverlessworkflow/api/workflow/DataInputSchema.java @@ -24,9 +24,10 @@ public class DataInputSchema { public DataInputSchema() {} - public DataInputSchema(String refValue){ + public DataInputSchema(String refValue) { this.refValue = refValue; } + public String getRefValue() { return refValue; } diff --git a/api_rest/mvnw b/api_rest/mvnw deleted file mode 100644 index 8a8fb228..00000000 --- a/api_rest/mvnw +++ /dev/null @@ -1,316 +0,0 @@ -#!/bin/sh -# ---------------------------------------------------------------------------- -# Licensed to the Apache Software Foundation (ASF) under one -# or more contributor license agreements. See the NOTICE file -# distributed with this work for additional information -# regarding copyright ownership. The ASF licenses this file -# to you 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. -# ---------------------------------------------------------------------------- - -# ---------------------------------------------------------------------------- -# Maven Start Up Batch script -# -# Required ENV vars: -# ------------------ -# JAVA_HOME - location of a JDK home dir -# -# Optional ENV vars -# ----------------- -# M2_HOME - location of maven2's installed home dir -# MAVEN_OPTS - parameters passed to the Java VM when running Maven -# e.g. to debug Maven itself, use -# set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 -# MAVEN_SKIP_RC - flag to disable loading of mavenrc files -# ---------------------------------------------------------------------------- - -if [ -z "$MAVEN_SKIP_RC" ] ; then - - if [ -f /usr/local/etc/mavenrc ] ; then - . /usr/local/etc/mavenrc - fi - - if [ -f /etc/mavenrc ] ; then - . /etc/mavenrc - fi - - if [ -f "$HOME/.mavenrc" ] ; then - . "$HOME/.mavenrc" - fi - -fi - -# OS specific support. $var _must_ be set to either true or false. -cygwin=false; -darwin=false; -mingw=false -case "`uname`" in - CYGWIN*) cygwin=true ;; - MINGW*) mingw=true;; - Darwin*) darwin=true - # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home - # See https://developer.apple.com/library/mac/qa/qa1170/_index.html - if [ -z "$JAVA_HOME" ]; then - if [ -x "/usr/libexec/java_home" ]; then - export JAVA_HOME="`/usr/libexec/java_home`" - else - export JAVA_HOME="/Library/Java/Home" - fi - fi - ;; -esac - -if [ -z "$JAVA_HOME" ] ; then - if [ -r /etc/gentoo-release ] ; then - JAVA_HOME=`java-config --jre-home` - fi -fi - -if [ -z "$M2_HOME" ] ; then - ## resolve links - $0 may be a link to maven's home - 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 - - saveddir=`pwd` - - M2_HOME=`dirname "$PRG"`/.. - - # make it fully qualified - M2_HOME=`cd "$M2_HOME" && pwd` - - cd "$saveddir" - # echo Using m2 at $M2_HOME -fi - -# For Cygwin, ensure paths are in UNIX format before anything is touched -if $cygwin ; then - [ -n "$M2_HOME" ] && - M2_HOME=`cygpath --unix "$M2_HOME"` - [ -n "$JAVA_HOME" ] && - JAVA_HOME=`cygpath --unix "$JAVA_HOME"` - [ -n "$CLASSPATH" ] && - CLASSPATH=`cygpath --path --unix "$CLASSPATH"` -fi - -# For Mingw, ensure paths are in UNIX format before anything is touched -if $mingw ; then - [ -n "$M2_HOME" ] && - M2_HOME="`(cd "$M2_HOME"; pwd)`" - [ -n "$JAVA_HOME" ] && - JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`" -fi - -if [ -z "$JAVA_HOME" ]; then - javaExecutable="`which javac`" - if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then - # readlink(1) is not available as standard on Solaris 10. - readLink=`which readlink` - if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then - if $darwin ; then - javaHome="`dirname \"$javaExecutable\"`" - javaExecutable="`cd \"$javaHome\" && pwd -P`/javac" - else - javaExecutable="`readlink -f \"$javaExecutable\"`" - fi - javaHome="`dirname \"$javaExecutable\"`" - javaHome=`expr "$javaHome" : '\(.*\)/bin'` - JAVA_HOME="$javaHome" - export JAVA_HOME - fi - fi -fi - -if [ -z "$JAVACMD" ] ; then - 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 - else - JAVACMD="`\\unset -f command; \\command -v java`" - fi -fi - -if [ ! -x "$JAVACMD" ] ; then - echo "Error: JAVA_HOME is not defined correctly." >&2 - echo " We cannot execute $JAVACMD" >&2 - exit 1 -fi - -if [ -z "$JAVA_HOME" ] ; then - echo "Warning: JAVA_HOME environment variable is not set." -fi - -CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher - -# traverses directory structure from process work directory to filesystem root -# first directory with .mvn subdirectory is considered project base directory -find_maven_basedir() { - - if [ -z "$1" ] - then - echo "Path not specified to find_maven_basedir" - return 1 - fi - - basedir="$1" - wdir="$1" - while [ "$wdir" != '/' ] ; do - if [ -d "$wdir"/.mvn ] ; then - basedir=$wdir - break - fi - # workaround for JBEAP-8937 (on Solaris 10/Sparc) - if [ -d "${wdir}" ]; then - wdir=`cd "$wdir/.."; pwd` - fi - # end of workaround - done - echo "${basedir}" -} - -# concatenates all lines of a file -concat_lines() { - if [ -f "$1" ]; then - echo "$(tr -s '\n' ' ' < "$1")" - fi -} - -BASE_DIR=`find_maven_basedir "$(pwd)"` -if [ -z "$BASE_DIR" ]; then - exit 1; -fi - -########################################################################################## -# Extension to allow automatically downloading the maven-wrapper.jar from Maven-central -# This allows using the maven wrapper in projects that prohibit checking in binary data. -########################################################################################## -if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then - if [ "$MVNW_VERBOSE" = true ]; then - echo "Found .mvn/wrapper/maven-wrapper.jar" - fi -else - if [ "$MVNW_VERBOSE" = true ]; then - echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..." - fi - if [ -n "$MVNW_REPOURL" ]; then - jarUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" - else - jarUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" - fi - while IFS="=" read key value; do - case "$key" in (wrapperUrl) jarUrl="$value"; break ;; - esac - done < "$BASE_DIR/.mvn/wrapper/maven-wrapper.properties" - if [ "$MVNW_VERBOSE" = true ]; then - echo "Downloading from: $jarUrl" - fi - wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" - if $cygwin; then - wrapperJarPath=`cygpath --path --windows "$wrapperJarPath"` - fi - - if command -v wget > /dev/null; then - if [ "$MVNW_VERBOSE" = true ]; then - echo "Found wget ... using wget" - fi - if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then - wget "$jarUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" - else - wget --http-user=$MVNW_USERNAME --http-password=$MVNW_PASSWORD "$jarUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" - fi - elif command -v curl > /dev/null; then - if [ "$MVNW_VERBOSE" = true ]; then - echo "Found curl ... using curl" - fi - if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then - curl -o "$wrapperJarPath" "$jarUrl" -f - else - curl --user $MVNW_USERNAME:$MVNW_PASSWORD -o "$wrapperJarPath" "$jarUrl" -f - fi - - else - if [ "$MVNW_VERBOSE" = true ]; then - echo "Falling back to using Java to download" - fi - javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java" - # For Cygwin, switch paths to Windows format before running javac - if $cygwin; then - javaClass=`cygpath --path --windows "$javaClass"` - fi - if [ -e "$javaClass" ]; then - if [ ! -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then - if [ "$MVNW_VERBOSE" = true ]; then - echo " - Compiling MavenWrapperDownloader.java ..." - fi - # Compiling the Java class - ("$JAVA_HOME/bin/javac" "$javaClass") - fi - if [ -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then - # Running the downloader - if [ "$MVNW_VERBOSE" = true ]; then - echo " - Running MavenWrapperDownloader.java ..." - fi - ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR") - fi - fi - fi -fi -########################################################################################## -# End of extension -########################################################################################## - -export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"} -if [ "$MVNW_VERBOSE" = true ]; then - echo $MAVEN_PROJECTBASEDIR -fi -MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" - -# For Cygwin, switch paths to Windows format before running java -if $cygwin; then - [ -n "$M2_HOME" ] && - M2_HOME=`cygpath --path --windows "$M2_HOME"` - [ -n "$JAVA_HOME" ] && - JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"` - [ -n "$CLASSPATH" ] && - CLASSPATH=`cygpath --path --windows "$CLASSPATH"` - [ -n "$MAVEN_PROJECTBASEDIR" ] && - MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"` -fi - -# Provide a "standardized" way to retrieve the CLI args that will -# work with both Windows and non-Windows executions. -MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $@" -export MAVEN_CMD_LINE_ARGS - -WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain - -exec "$JAVACMD" \ - $MAVEN_OPTS \ - $MAVEN_DEBUG_OPTS \ - -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ - "-Dmaven.home=${M2_HOME}" \ - "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ - ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" diff --git a/api_rest/mvnw.cmd b/api_rest/mvnw.cmd deleted file mode 100644 index 1d8ab018..00000000 --- a/api_rest/mvnw.cmd +++ /dev/null @@ -1,188 +0,0 @@ -@REM ---------------------------------------------------------------------------- -@REM Licensed to the Apache Software Foundation (ASF) under one -@REM or more contributor license agreements. See the NOTICE file -@REM distributed with this work for additional information -@REM regarding copyright ownership. The ASF licenses this file -@REM to you under the Apache License, Version 2.0 (the -@REM "License"); you may not use this file except in compliance -@REM with the License. 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, -@REM software distributed under the License is distributed on an -@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -@REM KIND, either express or implied. See the License for the -@REM specific language governing permissions and limitations -@REM under the License. -@REM ---------------------------------------------------------------------------- - -@REM ---------------------------------------------------------------------------- -@REM Maven Start Up Batch script -@REM -@REM Required ENV vars: -@REM JAVA_HOME - location of a JDK home dir -@REM -@REM Optional ENV vars -@REM M2_HOME - location of maven2's installed home dir -@REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands -@REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending -@REM MAVEN_OPTS - parameters passed to the Java VM when running Maven -@REM e.g. to debug Maven itself, use -@REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 -@REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files -@REM ---------------------------------------------------------------------------- - -@REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' -@echo off -@REM set title of command window -title %0 -@REM enable echoing by setting MAVEN_BATCH_ECHO to 'on' -@if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% - -@REM set %HOME% to equivalent of $HOME -if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") - -@REM Execute a user defined script before this one -if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre -@REM check for pre script, once with legacy .bat ending and once with .cmd ending -if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %* -if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %* -:skipRcPre - -@setlocal - -set ERROR_CODE=0 - -@REM To isolate internal variables from possible post scripts, we use another setlocal -@setlocal - -@REM ==== START VALIDATION ==== -if not "%JAVA_HOME%" == "" goto OkJHome - -echo. -echo Error: JAVA_HOME not found in your environment. >&2 -echo Please set the JAVA_HOME variable in your environment to match the >&2 -echo location of your Java installation. >&2 -echo. -goto error - -:OkJHome -if exist "%JAVA_HOME%\bin\java.exe" goto init - -echo. -echo Error: JAVA_HOME is set to an invalid directory. >&2 -echo JAVA_HOME = "%JAVA_HOME%" >&2 -echo Please set the JAVA_HOME variable in your environment to match the >&2 -echo location of your Java installation. >&2 -echo. -goto error - -@REM ==== END VALIDATION ==== - -:init - -@REM Find the project base dir, i.e. the directory that contains the folder ".mvn". -@REM Fallback to current working directory if not found. - -set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% -IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir - -set EXEC_DIR=%CD% -set WDIR=%EXEC_DIR% -:findBaseDir -IF EXIST "%WDIR%"\.mvn goto baseDirFound -cd .. -IF "%WDIR%"=="%CD%" goto baseDirNotFound -set WDIR=%CD% -goto findBaseDir - -:baseDirFound -set MAVEN_PROJECTBASEDIR=%WDIR% -cd "%EXEC_DIR%" -goto endDetectBaseDir - -:baseDirNotFound -set MAVEN_PROJECTBASEDIR=%EXEC_DIR% -cd "%EXEC_DIR%" - -:endDetectBaseDir - -IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig - -@setlocal EnableExtensions EnableDelayedExpansion -for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a -@endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% - -:endReadAdditionalConfig - -SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" -set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" -set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain - -set DOWNLOAD_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" - -FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( - IF "%%A"=="wrapperUrl" SET DOWNLOAD_URL=%%B -) - -@REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central -@REM This allows using the maven wrapper in projects that prohibit checking in binary data. -if exist %WRAPPER_JAR% ( - if "%MVNW_VERBOSE%" == "true" ( - echo Found %WRAPPER_JAR% - ) -) else ( - if not "%MVNW_REPOURL%" == "" ( - SET DOWNLOAD_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" - ) - if "%MVNW_VERBOSE%" == "true" ( - echo Couldn't find %WRAPPER_JAR%, downloading it ... - echo Downloading from: %DOWNLOAD_URL% - ) - - powershell -Command "&{"^ - "$webclient = new-object System.Net.WebClient;"^ - "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^ - "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^ - "}"^ - "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%DOWNLOAD_URL%', '%WRAPPER_JAR%')"^ - "}" - if "%MVNW_VERBOSE%" == "true" ( - echo Finished downloading %WRAPPER_JAR% - ) -) -@REM End of extension - -@REM Provide a "standardized" way to retrieve the CLI args that will -@REM work with both Windows and non-Windows executions. -set MAVEN_CMD_LINE_ARGS=%* - -%MAVEN_JAVA_EXE% ^ - %JVM_CONFIG_MAVEN_PROPS% ^ - %MAVEN_OPTS% ^ - %MAVEN_DEBUG_OPTS% ^ - -classpath %WRAPPER_JAR% ^ - "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^ - %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* -if ERRORLEVEL 1 goto error -goto end - -:error -set ERROR_CODE=1 - -:end -@endlocal & set ERROR_CODE=%ERROR_CODE% - -if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost -@REM check for post script, once with legacy .bat ending and once with .cmd ending -if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat" -if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd" -:skipRcPost - -@REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' -if "%MAVEN_BATCH_PAUSE%"=="on" pause - -if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE% - -cmd /C exit /B %ERROR_CODE% diff --git a/api_rest/pom.xml b/api_rest/pom.xml deleted file mode 100644 index 041c3ed6..00000000 --- a/api_rest/pom.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - 4.0.0 - - org.springframework.boot - spring-boot-starter-parent - 2.7.6 - - - io.serverless - serverlessworkflow-apirest - 0.0.1-SNAPSHOT - Serverless Workflow :: APIREST - APIREST project for Spring Boot - - 11 - - - - org.springframework.boot - spring-boot-starter-webflux - - - - org.springframework.boot - spring-boot-devtools - runtime - true - - - org.projectlombok - lombok - true - - - org.springframework.boot - spring-boot-starter-test - test - - - io.projectreactor - reactor-test - test - - - io.swagger.core.v3 - swagger-annotations - 2.2.7 - - - org.springdoc - springdoc-openapi-webflux-core - 1.6.13 - - - org.springdoc - springdoc-openapi-webflux-ui - 1.6.13 - - - - org.springframework.security - spring-security-test - 5.3.13.RELEASE - test - - - - - - io.serverlessworkflow - serverlessworkflow-api - 5.0.0-SNAPSHOT - - - io.serverlessworkflow - serverlessworkflow-diagram - 5.0.0-SNAPSHOT - - - - - - ossrh - https://oss.sonatype.org/content/repositories/snapshots - - - ossrh - https://oss.sonatype.org/service/local/staging/deploy/maven2/ - - - - - - - org.springframework.boot - spring-boot-maven-plugin - - - - org.projectlombok - lombok - - - - - - - - diff --git a/api_rest/src/main/java/io/serverlessworkflow/reactive_api_rest/ControllerErrorException.java b/api_rest/src/main/java/io/serverlessworkflow/reactive_api_rest/ControllerErrorException.java deleted file mode 100644 index 3e7f6ffd..00000000 --- a/api_rest/src/main/java/io/serverlessworkflow/reactive_api_rest/ControllerErrorException.java +++ /dev/null @@ -1,22 +0,0 @@ -/* - * Copyright 2020-Present The Serverless Workflow Specification 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 - * - * http://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. - */ -package io.serverlessworkflow.reactive_api_rest; - -public class ControllerErrorException extends Exception { - public ControllerErrorException(String errorMessage) { - super(errorMessage); - } -} diff --git a/api_rest/src/main/java/io/serverlessworkflow/reactive_api_rest/RouterPaths.java b/api_rest/src/main/java/io/serverlessworkflow/reactive_api_rest/RouterPaths.java deleted file mode 100644 index 77b8b7a2..00000000 --- a/api_rest/src/main/java/io/serverlessworkflow/reactive_api_rest/RouterPaths.java +++ /dev/null @@ -1,22 +0,0 @@ -/* - * Copyright 2020-Present The Serverless Workflow Specification 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 - * - * http://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. - */ -package io.serverlessworkflow.reactive_api_rest; - -public class RouterPaths { - - // get string of SVG from YAML or JSON file - public static final String GETTING_SVG_FROM_WORKFLOW = "/api/get_svg_from_workflow"; -} diff --git a/diagram-rest/pom.xml b/diagram-rest/pom.xml new file mode 100644 index 00000000..cbaafe2b --- /dev/null +++ b/diagram-rest/pom.xml @@ -0,0 +1,58 @@ + + + 4.0.0 + + org.springframework.boot + spring-boot-starter-parent + 2.7.6 + + + io.serverless + serverlessworkflow-diagram-rest + 5.0.0-SNAPSHOT + Serverless Workflow :: Diagram :: Rest API + Rest Api Module for Diagram Generation + + 1.6.13 + 5.0.0-SNAPSHOT + + + + org.springframework.boot + spring-boot-starter-webflux + + + io.serverlessworkflow + serverlessworkflow-diagram + ${version.sw} + + + org.springdoc + springdoc-openapi-webflux-core + ${version.webflux.core} + + + + + org.springframework.boot + spring-boot-starter-test + test + + + io.projectreactor + reactor-test + test + + + + + + + org.springframework.boot + spring-boot-maven-plugin + + + + + diff --git a/api_rest/src/main/java/io/serverlessworkflow/reactive_api_rest/Application.java b/diagram-rest/src/main/java/io/serverlessworkflow/reactive_api_rest/Application.java similarity index 99% rename from api_rest/src/main/java/io/serverlessworkflow/reactive_api_rest/Application.java rename to diagram-rest/src/main/java/io/serverlessworkflow/reactive_api_rest/Application.java index aa2569f7..1ebe11c6 100644 --- a/api_rest/src/main/java/io/serverlessworkflow/reactive_api_rest/Application.java +++ b/diagram-rest/src/main/java/io/serverlessworkflow/reactive_api_rest/Application.java @@ -1,4 +1,3 @@ -package io.serverlessworkflow.reactive_api_rest; /* * Copyright 2020-Present The Serverless Workflow Specification Authors * @@ -14,14 +13,14 @@ * See the License for the specific language governing permissions and * limitations under the License. */ +package io.serverlessworkflow.reactive_api_rest; + import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication public class Application { - public static void main(String[] args) { SpringApplication.run(Application.class, args); } - } diff --git a/api_rest/src/main/java/io/serverlessworkflow/reactive_api_rest/RouterRest.java b/diagram-rest/src/main/java/io/serverlessworkflow/reactive_api_rest/RouterRest.java similarity index 83% rename from api_rest/src/main/java/io/serverlessworkflow/reactive_api_rest/RouterRest.java rename to diagram-rest/src/main/java/io/serverlessworkflow/reactive_api_rest/RouterRest.java index dcc61b53..2575ca09 100644 --- a/api_rest/src/main/java/io/serverlessworkflow/reactive_api_rest/RouterRest.java +++ b/diagram-rest/src/main/java/io/serverlessworkflow/reactive_api_rest/RouterRest.java @@ -24,17 +24,10 @@ import org.springframework.web.reactive.function.server.ServerResponse; @Configuration -public class RouterRest implements IRouterRest { - - /*** - * Get image SVG from string. - * @param serverlessRequest The serverless request. - * @return String from SVG image - */ +public class RouterRest implements RouterRestInterface { @Bean - @Override public RouterFunction servelessRouterFunction(ServerlessRequest serverlessRequest) { - return route(POST(RouterPaths.GETTING_SVG_FROM_WORKFLOW), + return route(POST("/diagram"), serverlessRequest::getDiagramSVGFromWorkFlow); } diff --git a/api_rest/src/main/java/io/serverlessworkflow/reactive_api_rest/IRouterRest.java b/diagram-rest/src/main/java/io/serverlessworkflow/reactive_api_rest/RouterRestInterface.java similarity index 88% rename from api_rest/src/main/java/io/serverlessworkflow/reactive_api_rest/IRouterRest.java rename to diagram-rest/src/main/java/io/serverlessworkflow/reactive_api_rest/RouterRestInterface.java index 0c09c34f..bc5038e0 100644 --- a/api_rest/src/main/java/io/serverlessworkflow/reactive_api_rest/IRouterRest.java +++ b/diagram-rest/src/main/java/io/serverlessworkflow/reactive_api_rest/RouterRestInterface.java @@ -26,12 +26,12 @@ import org.springframework.web.reactive.function.server.RouterFunction; import org.springframework.web.reactive.function.server.ServerResponse; -public interface IRouterRest { +public interface RouterRestInterface { @RouterOperations( value = { @RouterOperation( - path = RouterPaths.GETTING_SVG_FROM_WORKFLOW, + path = "/diagram", produces = {MediaType.APPLICATION_JSON_VALUE}, method = RequestMethod.POST, beanClass = ServerlessRequest.class, @@ -48,11 +48,6 @@ public interface IRouterRest { schema = @Schema(implementation = ServerlessWorkFlowResponse.class))) } - /*, - security = @SecurityRequirement( - name = "bearer-key", - scopes = {} - )*/ )) }) RouterFunction servelessRouterFunction(ServerlessRequest serverlessRequest); diff --git a/api_rest/src/main/java/io/serverlessworkflow/reactive_api_rest/ServerlesRequestHelper.java b/diagram-rest/src/main/java/io/serverlessworkflow/reactive_api_rest/ServerlesRequestHelper.java similarity index 90% rename from api_rest/src/main/java/io/serverlessworkflow/reactive_api_rest/ServerlesRequestHelper.java rename to diagram-rest/src/main/java/io/serverlessworkflow/reactive_api_rest/ServerlesRequestHelper.java index 75e2f5f5..b277ab19 100644 --- a/api_rest/src/main/java/io/serverlessworkflow/reactive_api_rest/ServerlesRequestHelper.java +++ b/diagram-rest/src/main/java/io/serverlessworkflow/reactive_api_rest/ServerlesRequestHelper.java @@ -18,16 +18,14 @@ import io.serverlessworkflow.api.Workflow; import io.serverlessworkflow.api.interfaces.WorkflowDiagram; import io.serverlessworkflow.diagram.WorkflowDiagramImpl; -import lombok.RequiredArgsConstructor; import org.springframework.stereotype.Component; import reactor.core.publisher.Mono; @Component -@RequiredArgsConstructor public class ServerlesRequestHelper { - public Mono getSvg(String workFlow) { - String diagramSVG = ""; + public static Mono getSvg(String workFlow) { + String diagramSVG; Workflow workflow = Workflow.fromSource(workFlow); ServerlessWorkFlowResponse response = new ServerlessWorkFlowResponse(); diff --git a/api_rest/src/main/java/io/serverlessworkflow/reactive_api_rest/ServerlessRequest.java b/diagram-rest/src/main/java/io/serverlessworkflow/reactive_api_rest/ServerlessRequest.java similarity index 86% rename from api_rest/src/main/java/io/serverlessworkflow/reactive_api_rest/ServerlessRequest.java rename to diagram-rest/src/main/java/io/serverlessworkflow/reactive_api_rest/ServerlessRequest.java index f77350fd..2c92ef52 100644 --- a/api_rest/src/main/java/io/serverlessworkflow/reactive_api_rest/ServerlessRequest.java +++ b/diagram-rest/src/main/java/io/serverlessworkflow/reactive_api_rest/ServerlessRequest.java @@ -15,7 +15,6 @@ */ package io.serverlessworkflow.reactive_api_rest; -import lombok.RequiredArgsConstructor; import org.springframework.http.MediaType; import org.springframework.stereotype.Component; import org.springframework.web.reactive.function.server.ServerRequest; @@ -23,11 +22,8 @@ import reactor.core.publisher.Mono; @Component -@RequiredArgsConstructor public class ServerlessRequest { - private final ServerlesRequestHelper helper; - /** * Get the SVG diagram of a workflow from API Request * @@ -40,8 +36,8 @@ public Mono getDiagramSVGFromWorkFlow(ServerRequest sRequest) { .body( sRequest .bodyToMono(String.class) - .flatMap(helper::getSvg) - .onErrorMap(e -> new ControllerErrorException(e.getMessage())), + .flatMap(ServerlesRequestHelper::getSvg) + .onErrorMap(e -> new IllegalArgumentException(e.getMessage())), ServerlessWorkFlowResponse.class); } } diff --git a/api_rest/src/main/java/io/serverlessworkflow/reactive_api_rest/ServerlessWorkFlowResponse.java b/diagram-rest/src/main/java/io/serverlessworkflow/reactive_api_rest/ServerlessWorkFlowResponse.java similarity index 89% rename from api_rest/src/main/java/io/serverlessworkflow/reactive_api_rest/ServerlessWorkFlowResponse.java rename to diagram-rest/src/main/java/io/serverlessworkflow/reactive_api_rest/ServerlessWorkFlowResponse.java index f36e24d0..c02547dc 100644 --- a/api_rest/src/main/java/io/serverlessworkflow/reactive_api_rest/ServerlessWorkFlowResponse.java +++ b/diagram-rest/src/main/java/io/serverlessworkflow/reactive_api_rest/ServerlessWorkFlowResponse.java @@ -15,14 +15,12 @@ */ package io.serverlessworkflow.reactive_api_rest; -import lombok.AllArgsConstructor; -import lombok.Builder; -import lombok.Data; -import lombok.NoArgsConstructor; - public class ServerlessWorkFlowResponse { private String response; + public ServerlessWorkFlowResponse() { + } + public String getResponse() { return response; } diff --git a/api_rest/src/main/resources/application.yml b/diagram-rest/src/main/resources/application.yml similarity index 80% rename from api_rest/src/main/resources/application.yml rename to diagram-rest/src/main/resources/application.yml index b6080e2c..8f13a949 100644 --- a/api_rest/src/main/resources/application.yml +++ b/diagram-rest/src/main/resources/application.yml @@ -9,4 +9,4 @@ server: port: 8090 spring: application: - name: "Serverless-workflow" \ No newline at end of file + name: "Serverless Workflow Diagram Rest API" \ No newline at end of file diff --git a/api_rest/src/main/resources/templates/plantuml/custom-template.txt b/diagram-rest/src/main/resources/templates/plantuml/custom-template.txt similarity index 100% rename from api_rest/src/main/resources/templates/plantuml/custom-template.txt rename to diagram-rest/src/main/resources/templates/plantuml/custom-template.txt diff --git a/api_rest/src/test/java/io/serverlessworkflow/reactive_api_rest/ServerlesRequestHelperTest.java b/diagram-rest/src/test/java/io/serverlessworkflow/reactive_api_rest/ServerlesRequestHelperTest.java similarity index 96% rename from api_rest/src/test/java/io/serverlessworkflow/reactive_api_rest/ServerlesRequestHelperTest.java rename to diagram-rest/src/test/java/io/serverlessworkflow/reactive_api_rest/ServerlesRequestHelperTest.java index 6290e19e..ef6cbfbf 100644 --- a/api_rest/src/test/java/io/serverlessworkflow/reactive_api_rest/ServerlesRequestHelperTest.java +++ b/diagram-rest/src/test/java/io/serverlessworkflow/reactive_api_rest/ServerlesRequestHelperTest.java @@ -66,6 +66,7 @@ void setUp() { @Test void getSvg() { Mono monoSvg = serverlesRequestHelper.getSvg(input); + monoSvg.subscribe(result -> { assertNotNull(result); assertNotNull(result.getResponse());}); StepVerifier.create(monoSvg) .expectNextMatches(serverlessWorkFlowResponse -> serverlessWorkFlowResponse. getResponse() diff --git a/diagram/pom.xml b/diagram/pom.xml index de12b2ad..30ceb330 100644 --- a/diagram/pom.xml +++ b/diagram/pom.xml @@ -13,7 +13,7 @@ Serverless Workflow :: Diagram ${project.parent.version} jar - Java SDK for Serverless Workflow Specification + Diagram Generation diff --git a/pom.xml b/pom.xml index 505a4248..be3b0767 100644 --- a/pom.xml +++ b/pom.xml @@ -26,7 +26,6 @@ api - api_rest spi validation diagram