diff --git a/.github/workflows/pre-release.yml b/.github/workflows/pre-release.yml index a3d445f9..dc6fdcd7 100644 --- a/.github/workflows/pre-release.yml +++ b/.github/workflows/pre-release.yml @@ -53,7 +53,7 @@ jobs: # When adding a new example make sure it's listed here - name: Find and replace restateVersion in build.gradle.kts for java templates if: github.event.inputs.sdkJavaVersion != '' - run: for jvmDir in hello-world-http hello-world-lambda food-ordering/app; do sed -i 's/val restateVersion = "[0-9A-Z.-]*"/val restateVersion = "${{ inputs.sdkJavaVersion }}"/' java/$jvmDir/build.gradle.kts; done + run: for jvmDir in hello-world-http hello-world-lambda food-ordering/app patterns; do sed -i 's/val restateVersion = "[0-9A-Z.-]*"/val restateVersion = "${{ inputs.sdkJavaVersion }}"/' java/$jvmDir/build.gradle.kts; done - name: Find and replace restateVersion in build.gradle.kts for kotlin templates if: github.event.inputs.sdkJavaVersion != '' run: for jvmDir in hello-world-http hello-world-lambda; do sed -i 's/val restateVersion = "[0-9A-Z.-]*"/val restateVersion = "${{ inputs.sdkJavaVersion }}"/' kotlin/$jvmDir/build.gradle.kts; done @@ -80,6 +80,12 @@ jobs: with: arguments: check build-root-directory: java/food-ordering/app + - name: Test java/patterns + if: github.event.inputs.sdkJavaVersion != '' + uses: gradle/gradle-build-action@v2 + with: + arguments: check + build-root-directory: java/patterns - name: Test kotlin/hello-world-http if: github.event.inputs.sdkJavaVersion != '' uses: gradle/gradle-build-action@v2 diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 7a436b71..95dd61ca 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -40,6 +40,11 @@ jobs: with: arguments: check build-root-directory: java/food-ordering/app + - name: Test java/patterns + uses: gradle/gradle-build-action@v2 + with: + arguments: check + build-root-directory: java/patterns - name: Test kotlin/hello-world-http uses: gradle/gradle-build-action@v2 with: diff --git a/java/README.md b/java/README.md new file mode 100644 index 00000000..e25197be --- /dev/null +++ b/java/README.md @@ -0,0 +1,15 @@ +# Java examples + +This directory contains Restate examples using the Java SDK. + +## Common patterns + +- A collection of [common patterns](patterns) you encounter when developing distributed applications. + +## Starter examples + +- [Hello World](hello-world-http): A simple example of a Restate service. +- [Hello World - AWS Lambda](hello-world-lambda): A simple example of how you can run a Restate service on AWS Lambda. + +## Applications +- [Food ordering](food-ordering): See how to integrate Restate with external services using Awakeables and side effects. diff --git a/java/patterns/.gitignore b/java/patterns/.gitignore new file mode 100644 index 00000000..53ecbad3 --- /dev/null +++ b/java/patterns/.gitignore @@ -0,0 +1,35 @@ +# Compiled class file +*.class + +# Log file +*.log + +# BlueJ files +*.ctxt + +# Mobile Tools for Java (J2ME) +.mtj.tmp/ + +# Package Files # +*.jar +*.war +*.nar +*.ear +*.zip +*.tar.gz +*.rar + +# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml +hs_err_pid* + +# Ignore Gradle project-specific cache directory +.gradle + +# Ignore Gradle build output directory +build + +.idea +*.iml + +# Unignore the gradle wrapper +!gradle/wrapper/gradle-wrapper.jar \ No newline at end of file diff --git a/java/patterns/README.md b/java/patterns/README.md new file mode 100644 index 00000000..12b66e8d --- /dev/null +++ b/java/patterns/README.md @@ -0,0 +1,12 @@ +# Restate Sample Patterns + +A collections of useful patterns in distributed applications, and how to +implement them with [Restate](https://github.com/restatedev/restate). +This is a continuously evolving list. + +All patterns are described in one file and have a comment block at the top +that explains them. + +### List of Patterns + +- [**Compensations**](src/main/java/dev/restate/patterns/Compensations.java) diff --git a/java/patterns/build.gradle.kts b/java/patterns/build.gradle.kts new file mode 100644 index 00000000..34a3a1f5 --- /dev/null +++ b/java/patterns/build.gradle.kts @@ -0,0 +1,71 @@ +import com.google.protobuf.gradle.id + +plugins { + java + application + + id("com.google.protobuf") version "0.9.1" + id("com.diffplug.spotless") version "6.24.0" +} + +repositories { + mavenCentral() +} + +val restateVersion = "0.7.0" + +dependencies { + // Restate SDK + implementation("dev.restate:sdk-api:$restateVersion") + implementation("dev.restate:sdk-http-vertx:$restateVersion") + // To use Jackson to read/write state entries (optional) + implementation("dev.restate:sdk-serde-jackson:$restateVersion") + + // Protobuf and grpc dependencies + implementation("com.google.protobuf:protobuf-java:3.24.3") + implementation("io.grpc:grpc-stub:1.58.0") + implementation("io.grpc:grpc-protobuf:1.58.0") + // This is needed to compile the @Generated annotation forced by the grpc compiler + // See https://github.com/grpc/grpc-java/issues/9153 + compileOnly("org.apache.tomcat:annotations-api:6.0.53") + + // Logging (optional) + implementation("org.apache.logging.log4j:log4j-core:2.20.0") + + // Testing (optional) + testImplementation("org.junit.jupiter:junit-jupiter:5.9.1") + testImplementation("dev.restate:sdk-testing:$restateVersion") +} + +configure { + java { + targetExclude("build/generated/**/*.java") + + googleJavaFormat() + } +} + +// Configure protoc plugin +protobuf { + protoc { artifact = "com.google.protobuf:protoc:3.24.3" } + + // We need both grpc and restate codegen(s) because the restate codegen depends on the grpc one + plugins { + id("grpc") { artifact = "io.grpc:protoc-gen-grpc-java:1.58.0" } + id("restate") { artifact = "dev.restate:protoc-gen-restate:$restateVersion:all@jar" } + } + + generateProtoTasks { + all().forEach { + it.plugins { + id("grpc") + id("restate") + } + } + } +} + +// Configure test platform +tasks.withType { + useJUnitPlatform() +} \ No newline at end of file diff --git a/java/patterns/gradle/wrapper/gradle-wrapper.jar b/java/patterns/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 00000000..033e24c4 Binary files /dev/null and b/java/patterns/gradle/wrapper/gradle-wrapper.jar differ diff --git a/java/patterns/gradle/wrapper/gradle-wrapper.properties b/java/patterns/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 00000000..62f495df --- /dev/null +++ b/java/patterns/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.2-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/java/patterns/gradlew b/java/patterns/gradlew new file mode 100755 index 00000000..fcb6fca1 --- /dev/null +++ b/java/patterns/gradlew @@ -0,0 +1,248 @@ +#!/bin/sh + +# +# 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. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for 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/HEAD/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 +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 + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +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 ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +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" || "$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 + 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 + # 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 +fi + + +# 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"' + +# 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 \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# 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. +# + +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/java/patterns/gradlew.bat b/java/patterns/gradlew.bat new file mode 100644 index 00000000..6689b85b --- /dev/null +++ b/java/patterns/gradlew.bat @@ -0,0 +1,92 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/java/patterns/src/main/java/dev/restate/patterns/Compensations.java b/java/patterns/src/main/java/dev/restate/patterns/Compensations.java new file mode 100644 index 00000000..64abb7be --- /dev/null +++ b/java/patterns/src/main/java/dev/restate/patterns/Compensations.java @@ -0,0 +1,101 @@ +package dev.restate.patterns; + +import static dev.restate.patterns.compensations.generated.Proto.*; + +import dev.restate.patterns.compensations.generated.*; +import dev.restate.patterns.compensations.generated.CarRentalRestate.CarRentalRestateClient; +import dev.restate.patterns.compensations.generated.FlightsRestate.FlightsRestateClient; +import dev.restate.patterns.compensations.generated.PaymentRestate.PaymentRestateClient; +import dev.restate.sdk.Awaitable; +import dev.restate.sdk.RestateContext; +import dev.restate.sdk.common.TerminalException; +import java.util.ArrayDeque; +import java.util.Deque; +import java.util.Iterator; + +/** + * -------------------------------------- Compensations -------------------------------------- + * Restate guarantees that your invocations are run to completion no matter what happens. However, + * in case you want your services to be able to respond with exceptions as part of the normal + * control flow (i.e. denoting a negative outcome) you can let the callee throw a + * `TerminalException`. If the caller has completed previous steps before receiving the + * `TerminalException`, it will have to undo those steps in order to leave the system in a + * consistent state. The way to undo steps is by registering compensations and running them for all + * completed steps. With Restate, this can be naturally expressed as part of the service code. + * Moreover, Restate runs the compensations with the same guarantees as the service code, i.e. it + * executes them durably until they complete, which guarantees that the system will be left in a + * consistent state. + * + *

The very same mechanism of undoing completed steps via compensations is also needed if you + * want to gracefully cancel an invocation, i.e. because it is no longer needed or stuck, and leave + * the system in a consistent state. The way a graceful cancellation manifests is by throwing a + * `TerminalError` at the next Restate API call. In fact, Restate starts cancelling your invocation + * call tree starting with the leaf invocations first and then propagating the cancellation error + * up. Given that your service code is properly instrumented with compensations, you know that an + * invocation which completed with a `TerminalError` has not made any changes to the system and the + * caller only needs to undo the steps that have been completed successfully before. + */ +public class Compensations { + + /** + * Trip reservation workflow which has been instrumented with compensations. The workflow tries to + * reserve the flight and the car rental before it processes the payment. If at any point one of + * the calls fails or gets cancelled, then the trip reservation workflow will undo all + * successfully completed steps by running the compensations. + * + *

Note: that the compensation logic is purely implemented in the user code and runs durably + * until it completes. Moreover, an invocation failure and an invocation cancellation are handled + * in the exact same way by the caller. + */ + public static class TravelService extends TravelRestate.TravelRestateImplBase { + @Override + public void reserve(RestateContext ctx, TravelBookingRequest request) throws TerminalException { + final FlightsRestateClient flightsService = FlightsRestate.newClient(ctx); + final CarRentalRestateClient carRentalService = CarRentalRestate.newClient(ctx); + final PaymentRestateClient paymentService = PaymentRestate.newClient(ctx); + + // Create a list of compensations to run in case of a failure or cancellation. + final Deque compensations = new ArrayDeque<>(); + + try { + final FlightBookingId flightBookingId = + flightsService + .reserve(FlightBookingRequest.newBuilder().setTripId(request.getTripID()).build()) + .await(); + // Register the compensation to undo the flight reservation. + compensations.add(() -> flightsService.cancel(flightBookingId).await()); + + final CarRentalId carRentalId = + carRentalService + .reserve(CarRentalRequest.newBuilder().setTripId(request.getTripID()).build()) + .await(); + // Register the compensation to undo the car rental reservation. + compensations.add(() -> carRentalService.cancel(carRentalId).await()); + + final PaymentId paymentId = + paymentService + .process(PaymentRequest.newBuilder().setTripId(request.getTripID()).build()) + .await(); + // Register the compensation to undo the payment. + compensations.add(() -> paymentService.refund(paymentId).await()); + + Awaitable.all( + flightsService.confirm(flightBookingId), carRentalService.confirm(carRentalId)) + .await(); + } catch (TerminalException e) { + // Run the compensations in reverse order + final Iterator compensationsIterator = compensations.descendingIterator(); + + while (compensationsIterator.hasNext()) { + compensationsIterator.next().run(); + } + + throw new TerminalException( + e.getCode(), + String.format( + "Failed to reserve the trip: %s. Ran %d compensations.", + e.getMessage(), compensations.size())); + } + } + } +} diff --git a/java/patterns/src/main/proto/compensations.proto b/java/patterns/src/main/proto/compensations.proto new file mode 100644 index 00000000..15f40369 --- /dev/null +++ b/java/patterns/src/main/proto/compensations.proto @@ -0,0 +1,77 @@ +syntax = "proto3"; + +package compensations; + +import "google/protobuf/empty.proto"; + +import "dev/restate/ext.proto"; + +option java_package = "dev.restate.patterns.compensations.generated"; +option java_outer_classname = "Proto"; + +/** + * Travel service. + */ +service Travel { + // See https://docs.restate.dev/services/service_type for more details. + option (dev.restate.ext.service_type) = UNKEYED; + + rpc Reserve (TravelBookingRequest) returns (google.protobuf.Empty); +} + +message TravelBookingRequest { + string tripID = 1; +} + +service Flights { + // See https://docs.restate.dev/services/service_type for more details. + option (dev.restate.ext.service_type) = KEYED; + + rpc Reserve(FlightBookingRequest) returns (FlightBookingId); + rpc Confirm(FlightBookingId) returns (google.protobuf.Empty); + rpc Cancel(FlightBookingId) returns (google.protobuf.Empty); +} + +message FlightBookingRequest { + string tripId = 1 [(dev.restate.ext.field) = KEY]; +} + +message FlightBookingId { + string tripId = 1 [(dev.restate.ext.field) = KEY]; + string bookingId = 2; +} + +service CarRental { + // See https://docs.restate.dev/services/service_type for more details. + option (dev.restate.ext.service_type) = KEYED; + + rpc Reserve(CarRentalRequest) returns (CarRentalId); + rpc Confirm(CarRentalId) returns (google.protobuf.Empty); + rpc Cancel(CarRentalId) returns (google.protobuf.Empty); +} + +message CarRentalRequest { + string tripId = 1 [(dev.restate.ext.field) = KEY]; +} + +message CarRentalId { + string tripId = 1 [(dev.restate.ext.field) = KEY]; + string bookingId = 2; +} + +service Payment { + // See https://docs.restate.dev/services/service_type for more details. + option (dev.restate.ext.service_type) = KEYED; + + rpc Process(PaymentRequest) returns (PaymentId); + rpc Refund(PaymentId) returns (google.protobuf.Empty); +} + +message PaymentRequest { + string tripId = 1 [(dev.restate.ext.field) = KEY]; +} + +message PaymentId { + string tripId = 1 [(dev.restate.ext.field) = KEY]; + string paymentId = 2; +} diff --git a/java/patterns/src/main/resources/log4j2.properties b/java/patterns/src/main/resources/log4j2.properties new file mode 100644 index 00000000..81a0455a --- /dev/null +++ b/java/patterns/src/main/resources/log4j2.properties @@ -0,0 +1,26 @@ +# Set to debug or trace if log4j initialization is failing +status = warn + +# Console appender configuration +appender.console.type = Console +appender.console.name = consoleLogger +appender.console.layout.type = PatternLayout +appender.console.layout.pattern = %d{yyyy-MM-dd HH:mm:ss} %-5p %notEmpty{[%X{restateServiceMethod}]}%notEmpty{[%X{restateInvocationId}]} %c - %m%n + +# Filter out logging during replay +appender.console.filter.replay.type = ContextMapFilter +appender.console.filter.replay.onMatch = DENY +appender.console.filter.replay.onMismatch = NEUTRAL +appender.console.filter.replay.0.type = KeyValuePair +appender.console.filter.replay.0.key = restateInvocationStatus +appender.console.filter.replay.0.value = REPLAYING + +# Restate logs to debug level +logger.app.name = dev.restate +logger.app.level = info +logger.app.additivity = false +logger.app.appenderRef.console.ref = consoleLogger + +# Root logger +rootLogger.level = info +rootLogger.appenderRef.stdout.ref = consoleLogger \ No newline at end of file diff --git a/java/patterns/src/test/java/dev/restate/patterns/CompensationsTest.java b/java/patterns/src/test/java/dev/restate/patterns/CompensationsTest.java new file mode 100644 index 00000000..b07f482b --- /dev/null +++ b/java/patterns/src/test/java/dev/restate/patterns/CompensationsTest.java @@ -0,0 +1,94 @@ +package dev.restate.patterns; + +import static org.junit.jupiter.api.Assertions.assertThrows; + +import dev.restate.patterns.compensations.generated.CarRentalRestate; +import dev.restate.patterns.compensations.generated.FlightsRestate; +import dev.restate.patterns.compensations.generated.PaymentRestate; +import dev.restate.patterns.compensations.generated.Proto; +import dev.restate.patterns.compensations.generated.Proto.FlightBookingId; +import dev.restate.patterns.compensations.generated.Proto.FlightBookingRequest; +import dev.restate.patterns.compensations.generated.Proto.PaymentId; +import dev.restate.patterns.compensations.generated.Proto.PaymentRequest; +import dev.restate.patterns.compensations.generated.TravelGrpc; +import dev.restate.sdk.RestateContext; +import dev.restate.sdk.common.TerminalException; +import dev.restate.sdk.testing.RestateGrpcChannel; +import dev.restate.sdk.testing.RestateRunner; +import dev.restate.sdk.testing.RestateRunnerBuilder; +import io.grpc.ManagedChannel; +import io.grpc.StatusRuntimeException; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.RegisterExtension; + +public class CompensationsTest { + // Runner runs Restate using testcontainers and registers services + @RegisterExtension + private static final RestateRunner restateRunner = + RestateRunnerBuilder.create() + // Service to test + .withService(new Compensations.TravelService()) + // Helper services + .withService(new FlightsService()) + .withService(new CarRentalService()) + .withService(new PaymentService()) + .buildRunner(); + + @Test + void testGreet( + // Channel to send requests to Restate services + @RestateGrpcChannel ManagedChannel channel) { + TravelGrpc.TravelBlockingStub client = TravelGrpc.newBlockingStub(channel); + + assertThrows( + StatusRuntimeException.class, + () -> client.reserve(Proto.TravelBookingRequest.newBuilder().setTripID("myTrip").build()), + "INTERNAL: Failed to reserve the trip: Failed to reserve car rental. Ran 1 compensations."); + } + + // -------------------------------------------------------------------------------------- + // Helper services for the test + // -------------------------------------------------------------------------------------- + + private static final class FlightsService extends FlightsRestate.FlightsRestateImplBase { + @Override + public FlightBookingId reserve(RestateContext context, FlightBookingRequest request) + throws TerminalException { + return FlightBookingId.newBuilder().setBookingId(request.getTripId()).build(); + } + + @Override + public void confirm(RestateContext context, FlightBookingId request) throws TerminalException {} + + @Override + public void cancel(RestateContext context, FlightBookingId request) throws TerminalException {} + } + + private static final class CarRentalService extends CarRentalRestate.CarRentalRestateImplBase { + @Override + public Proto.CarRentalId reserve(RestateContext context, Proto.CarRentalRequest request) + throws TerminalException { + // let's simulate that the car rental service failed to reserve the car + throw new TerminalException(TerminalException.Code.INTERNAL, "Failed to reserve car rental"); + } + + @Override + public void confirm(RestateContext context, Proto.CarRentalId request) + throws TerminalException {} + + @Override + public void cancel(RestateContext context, Proto.CarRentalId request) + throws TerminalException {} + } + + private static final class PaymentService extends PaymentRestate.PaymentRestateImplBase { + @Override + public PaymentId process(RestateContext context, PaymentRequest request) + throws TerminalException { + return PaymentId.newBuilder().setPaymentId(request.getTripId()).build(); + } + + @Override + public void refund(RestateContext context, PaymentId request) throws TerminalException {} + } +}