diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index c7110d97..6192b2da 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -7,7 +7,44 @@ on: branches: [ main ] jobs: - build: + build-jvm: + # prevent from running on forks + if: github.repository_owner == 'restatedev' + runs-on: ubuntu-latest + strategy: + matrix: + jvm-version: [ 17 ] + + steps: + - uses: actions/checkout@v3 + + - name: Use JVM ${{ matrix.jvm-version }} + uses: actions/setup-java@v3 + with: + distribution: 'temurin' + java-version: ${{ matrix.jvm-version }} + + - name: Test jvm/java-blocking-http + uses: gradle/gradle-build-action@v2 + with: + arguments: check + build-root-directory: jvm/java-blocking-http + - name: Test jvm/java-blocking-lambda + uses: gradle/gradle-build-action@v2 + with: + arguments: check + build-root-directory: jvm/java-blocking-lambda + - name: Test jvm/kotlin-http + uses: gradle/gradle-build-action@v2 + with: + arguments: check + build-root-directory: jvm/kotlin-http + - name: Test jvm/kotlin-lambda + uses: gradle/gradle-build-action@v2 + with: + arguments: check + build-root-directory: jvm/kotlin-lambda + build-ts: # prevent from running on forks if: github.repository_owner == 'restatedev' runs-on: ubuntu-latest @@ -17,11 +54,13 @@ jobs: steps: - uses: actions/checkout@v3 + - uses: bufbuild/buf-setup-action@v1 - name: Use Node.js ${{ matrix.node-version }} uses: actions/setup-node@v3 with: node-version: ${{ matrix.node-version }} registry-url: 'https://registry.npmjs.org' + - run: npm ci --prefix typescript - run: npm run --prefix typescript -ws verify diff --git a/jvm/java-blocking-http/.gitignore b/jvm/java-blocking-http/.gitignore new file mode 100644 index 00000000..5ae75d3d --- /dev/null +++ b/jvm/java-blocking-http/.gitignore @@ -0,0 +1,32 @@ +# 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 diff --git a/jvm/java-blocking-http/README.md b/jvm/java-blocking-http/README.md new file mode 100644 index 00000000..2b1330b7 --- /dev/null +++ b/jvm/java-blocking-http/README.md @@ -0,0 +1,29 @@ +# Blocking HTTP example + +Sample project configuration of a Restate service using the Java blocking interface and HTTP server. It contains: + +* [`build.gradle.kts`](build.gradle.kts) +* [Service interface definition `greeter.proto`](src/main/proto/greeter.proto) +* [Service class implementation `Greeter`](src/main/java/dev/restate/sdk/examples/Greeter.java) +* [Test `GreeterTest`](src/test/java/dev/restate/sdk/examples/GreeterTest.java) +* [Logging configuration](src/main/resources/log4j2.properties) + +## Running the example + +You can run the Java greeter service via: + +```shell +./gradlew run +``` + +Or from the IDE UI. + +## Running the tests + +You can run the tests either via: + +```shell +./gradlew check +``` + +Or from the IDE UI. \ No newline at end of file diff --git a/jvm/java-blocking-http/build.gradle.kts b/jvm/java-blocking-http/build.gradle.kts new file mode 100644 index 00000000..6e1a50a9 --- /dev/null +++ b/jvm/java-blocking-http/build.gradle.kts @@ -0,0 +1,70 @@ +import com.google.protobuf.gradle.id + +plugins { + java + application + + id("com.google.protobuf") version "0.9.1" +} + +repositories { + mavenCentral() + // OSSRH Snapshots repo + // TODO remove it once we have the proper release + maven { url = uri("https://s01.oss.sonatype.org/content/repositories/snapshots/") } +} + +val restateVersion = "0.0.1-SNAPSHOT" + +dependencies { + // Restate SDK + implementation("dev.restate:sdk-java-blocking:$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-test:$restateVersion") +} + +// 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-java-blocking:$restateVersion:all@jar" } + } + + generateProtoTasks { + all().forEach { + it.plugins { + id("grpc") + id("restate") + } + } + } +} + +// Configure test platform +tasks.withType { + useJUnitPlatform() +} + +// Set main class +application { + mainClass.set("dev.restate.sdk.examples.Greeter") +} \ No newline at end of file diff --git a/jvm/java-blocking-http/gradle/wrapper/gradle-wrapper.jar b/jvm/java-blocking-http/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 00000000..033e24c4 Binary files /dev/null and b/jvm/java-blocking-http/gradle/wrapper/gradle-wrapper.jar differ diff --git a/jvm/java-blocking-http/gradle/wrapper/gradle-wrapper.properties b/jvm/java-blocking-http/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 00000000..62f495df --- /dev/null +++ b/jvm/java-blocking-http/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/jvm/java-blocking-http/gradlew b/jvm/java-blocking-http/gradlew new file mode 100755 index 00000000..fcb6fca1 --- /dev/null +++ b/jvm/java-blocking-http/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/jvm/java-blocking-http/gradlew.bat b/jvm/java-blocking-http/gradlew.bat new file mode 100644 index 00000000..6689b85b --- /dev/null +++ b/jvm/java-blocking-http/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/jvm/java-blocking-http/src/main/java/dev/restate/sdk/examples/Greeter.java b/jvm/java-blocking-http/src/main/java/dev/restate/sdk/examples/Greeter.java new file mode 100644 index 00000000..d3473ea5 --- /dev/null +++ b/jvm/java-blocking-http/src/main/java/dev/restate/sdk/examples/Greeter.java @@ -0,0 +1,28 @@ +package dev.restate.sdk.examples; + +import dev.restate.sdk.blocking.RestateContext; +import dev.restate.sdk.core.CoreSerdes; +import dev.restate.sdk.core.StateKey; +import dev.restate.sdk.examples.generated.*; +import dev.restate.sdk.http.vertx.RestateHttpEndpointBuilder; + +import static dev.restate.sdk.examples.generated.GreeterProto.*; + +public class Greeter extends GreeterRestate.GreeterRestateImplBase { + + private static final StateKey COUNT = StateKey.of("count", CoreSerdes.INT); + + @Override + public GreetResponse greet(RestateContext context, GreetRequest request) { + int count = context.get(COUNT).orElse(1); + context.set(COUNT, count + 1); + + return GreetResponse.newBuilder() + .setMessage("Hello " + request.getName() + " for the " + count + " time!") + .build(); + } + + public static void main(String[] args) { + RestateHttpEndpointBuilder.builder().withService(new Greeter()).buildAndListen(); + } +} diff --git a/jvm/java-blocking-http/src/main/proto/greeter.proto b/jvm/java-blocking-http/src/main/proto/greeter.proto new file mode 100644 index 00000000..74139459 --- /dev/null +++ b/jvm/java-blocking-http/src/main/proto/greeter.proto @@ -0,0 +1,22 @@ +syntax = "proto3"; + +package greeter; + +import "dev/restate/ext.proto"; + +option java_package = "dev.restate.sdk.examples.generated"; +option java_outer_classname = "GreeterProto"; + +service Greeter { + option (dev.restate.ext.service_type) = KEYED; + + rpc Greet (GreetRequest) returns (GreetResponse); +} + +message GreetRequest { + string name = 1 [(dev.restate.ext.field) = KEY]; +} + +message GreetResponse { + string message = 1; +} diff --git a/jvm/java-blocking-http/src/main/resources/log4j2.properties b/jvm/java-blocking-http/src/main/resources/log4j2.properties new file mode 100644 index 00000000..130894e5 --- /dev/null +++ b/jvm/java-blocking-http/src/main/resources/log4j2.properties @@ -0,0 +1,18 @@ +# 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 + +# Restate logs to debug level +logger.app.name = dev.restate +logger.app.level = debug +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/jvm/java-blocking-http/src/test/java/dev/restate/sdk/examples/GreeterTest.java b/jvm/java-blocking-http/src/test/java/dev/restate/sdk/examples/GreeterTest.java new file mode 100644 index 00000000..9f6f94c3 --- /dev/null +++ b/jvm/java-blocking-http/src/test/java/dev/restate/sdk/examples/GreeterTest.java @@ -0,0 +1,34 @@ +package dev.restate.sdk.examples; + +import dev.restate.sdk.examples.generated.GreeterGrpc; +import dev.restate.sdk.examples.generated.GreeterGrpc.GreeterBlockingStub; +import dev.restate.sdk.examples.generated.GreeterProto.GreetRequest; +import dev.restate.sdk.examples.generated.GreeterProto.GreetResponse; +import dev.restate.sdk.testing.RestateGrpcChannel; +import dev.restate.sdk.testing.RestateRunner; +import dev.restate.sdk.testing.RestateRunnerBuilder; +import io.grpc.ManagedChannel; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.RegisterExtension; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +class GreeterTest { + + // Runner runs Restate using testcontainers and registers services + @RegisterExtension + private static final RestateRunner restateRunner = RestateRunnerBuilder.create() + // Service to test + .withService(new Greeter()) + .buildRunner(); + + @Test + void testGreet( + // Channel to send requests to Restate services + @RestateGrpcChannel ManagedChannel channel) { + GreeterBlockingStub client = GreeterGrpc.newBlockingStub(channel); + GreetResponse response = client.greet(GreetRequest.newBuilder().setName("Francesco").build()); + + assertEquals("Hello Francesco for the 1 time!", response.getMessage()); + } +} diff --git a/jvm/java-blocking-lambda/.gitignore b/jvm/java-blocking-lambda/.gitignore new file mode 100644 index 00000000..5ae75d3d --- /dev/null +++ b/jvm/java-blocking-lambda/.gitignore @@ -0,0 +1,32 @@ +# 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 diff --git a/jvm/java-blocking-lambda/README.md b/jvm/java-blocking-lambda/README.md new file mode 100644 index 00000000..51a28d33 --- /dev/null +++ b/jvm/java-blocking-lambda/README.md @@ -0,0 +1,32 @@ +# Blocking Lambda example + +Sample project configuration of a Restate service using the Java blocking interface and AWS Lambda. It contains: + +* [`build.gradle.kts`](build.gradle.kts) +* [Service interface definition `greeter.proto`](src/main/proto/greeter.proto) +* [Service class implementation `Greeter`](src/main/java/dev/restate/sdk/examples/Greeter.java) +* [Lambda handler `LambdaHandler`](src/main/java/dev/restate/sdk/examples/LambdaHandler.java) +* [Test `GreeterTest`](src/test/java/dev/restate/sdk/examples/GreeterTest.java) +* [Logging configuration](src/main/resources/log4j2.properties) + +## Package + +Run: + +```shell +./gradlew shadowJar +``` + +You'll find the shadowed jar in the `build` directory. + +The class to configure in Lambda is `dev.restate.sdk.examples.LambdaHandler`. + +## Running the tests + +You can run the tests either via: + +```shell +./gradlew check +``` + +Or from the IDE UI. \ No newline at end of file diff --git a/jvm/java-blocking-lambda/build.gradle.kts b/jvm/java-blocking-lambda/build.gradle.kts new file mode 100644 index 00000000..6235cce1 --- /dev/null +++ b/jvm/java-blocking-lambda/build.gradle.kts @@ -0,0 +1,67 @@ +import com.google.protobuf.gradle.id + +plugins { + java + + id("com.google.protobuf") version "0.9.1" + + // To package the dependency for Lambda + id("com.github.johnrengelman.shadow") version "7.1.2" +} + +repositories { + mavenCentral() + // OSSRH Snapshots repo + // TODO remove it once we have the proper release + maven { url = uri("https://s01.oss.sonatype.org/content/repositories/snapshots/") } +} + +val restateVersion = "0.0.1-SNAPSHOT" + +dependencies { + // Restate SDK + implementation("dev.restate:sdk-java-blocking:$restateVersion") + implementation("dev.restate:sdk-lambda:$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-test:$restateVersion") +} + +// 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-java-blocking:$restateVersion:all@jar" } + } + + generateProtoTasks { + all().forEach { + it.plugins { + id("grpc") + id("restate") + } + } + } +} + +// Configure test platform +tasks.withType { + useJUnitPlatform() +} diff --git a/jvm/java-blocking-lambda/gradle/wrapper/gradle-wrapper.jar b/jvm/java-blocking-lambda/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 00000000..033e24c4 Binary files /dev/null and b/jvm/java-blocking-lambda/gradle/wrapper/gradle-wrapper.jar differ diff --git a/jvm/java-blocking-lambda/gradle/wrapper/gradle-wrapper.properties b/jvm/java-blocking-lambda/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 00000000..62f495df --- /dev/null +++ b/jvm/java-blocking-lambda/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/jvm/java-blocking-lambda/gradlew b/jvm/java-blocking-lambda/gradlew new file mode 100755 index 00000000..fcb6fca1 --- /dev/null +++ b/jvm/java-blocking-lambda/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/jvm/java-blocking-lambda/gradlew.bat b/jvm/java-blocking-lambda/gradlew.bat new file mode 100644 index 00000000..6689b85b --- /dev/null +++ b/jvm/java-blocking-lambda/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/jvm/java-blocking-lambda/src/main/java/dev/restate/sdk/examples/Greeter.java b/jvm/java-blocking-lambda/src/main/java/dev/restate/sdk/examples/Greeter.java new file mode 100644 index 00000000..c8120364 --- /dev/null +++ b/jvm/java-blocking-lambda/src/main/java/dev/restate/sdk/examples/Greeter.java @@ -0,0 +1,23 @@ +package dev.restate.sdk.examples; + +import dev.restate.sdk.blocking.RestateContext; +import dev.restate.sdk.core.CoreSerdes; +import dev.restate.sdk.core.StateKey; +import dev.restate.sdk.examples.generated.*; + +import static dev.restate.sdk.examples.generated.GreeterProto.*; + +public class Greeter extends GreeterRestate.GreeterRestateImplBase { + + private static final StateKey COUNT = StateKey.of("count", CoreSerdes.INT); + + @Override + public GreetResponse greet(RestateContext context, GreetRequest request) { + int count = context.get(COUNT).orElse(1); + context.set(COUNT, count + 1); + + return GreetResponse.newBuilder() + .setMessage("Hello " + request.getName() + " for the " + count + " time!") + .build(); + } +} diff --git a/jvm/java-blocking-lambda/src/main/java/dev/restate/sdk/examples/LambdaHandler.java b/jvm/java-blocking-lambda/src/main/java/dev/restate/sdk/examples/LambdaHandler.java new file mode 100644 index 00000000..417f37d5 --- /dev/null +++ b/jvm/java-blocking-lambda/src/main/java/dev/restate/sdk/examples/LambdaHandler.java @@ -0,0 +1,11 @@ +package dev.restate.sdk.examples; + +import dev.restate.sdk.lambda.BaseRestateLambdaHandler; +import dev.restate.sdk.lambda.RestateLambdaEndpointBuilder; + +public class LambdaHandler extends BaseRestateLambdaHandler { + @Override + public void register(RestateLambdaEndpointBuilder builder) { + builder.withService(new Greeter()); + } +} diff --git a/jvm/java-blocking-lambda/src/main/proto/greeter.proto b/jvm/java-blocking-lambda/src/main/proto/greeter.proto new file mode 100644 index 00000000..74139459 --- /dev/null +++ b/jvm/java-blocking-lambda/src/main/proto/greeter.proto @@ -0,0 +1,22 @@ +syntax = "proto3"; + +package greeter; + +import "dev/restate/ext.proto"; + +option java_package = "dev.restate.sdk.examples.generated"; +option java_outer_classname = "GreeterProto"; + +service Greeter { + option (dev.restate.ext.service_type) = KEYED; + + rpc Greet (GreetRequest) returns (GreetResponse); +} + +message GreetRequest { + string name = 1 [(dev.restate.ext.field) = KEY]; +} + +message GreetResponse { + string message = 1; +} diff --git a/jvm/java-blocking-lambda/src/main/resources/log4j2.properties b/jvm/java-blocking-lambda/src/main/resources/log4j2.properties new file mode 100644 index 00000000..130894e5 --- /dev/null +++ b/jvm/java-blocking-lambda/src/main/resources/log4j2.properties @@ -0,0 +1,18 @@ +# 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 + +# Restate logs to debug level +logger.app.name = dev.restate +logger.app.level = debug +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/jvm/java-blocking-lambda/src/test/java/dev/restate/sdk/examples/GreeterTest.java b/jvm/java-blocking-lambda/src/test/java/dev/restate/sdk/examples/GreeterTest.java new file mode 100644 index 00000000..9f6f94c3 --- /dev/null +++ b/jvm/java-blocking-lambda/src/test/java/dev/restate/sdk/examples/GreeterTest.java @@ -0,0 +1,34 @@ +package dev.restate.sdk.examples; + +import dev.restate.sdk.examples.generated.GreeterGrpc; +import dev.restate.sdk.examples.generated.GreeterGrpc.GreeterBlockingStub; +import dev.restate.sdk.examples.generated.GreeterProto.GreetRequest; +import dev.restate.sdk.examples.generated.GreeterProto.GreetResponse; +import dev.restate.sdk.testing.RestateGrpcChannel; +import dev.restate.sdk.testing.RestateRunner; +import dev.restate.sdk.testing.RestateRunnerBuilder; +import io.grpc.ManagedChannel; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.RegisterExtension; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +class GreeterTest { + + // Runner runs Restate using testcontainers and registers services + @RegisterExtension + private static final RestateRunner restateRunner = RestateRunnerBuilder.create() + // Service to test + .withService(new Greeter()) + .buildRunner(); + + @Test + void testGreet( + // Channel to send requests to Restate services + @RestateGrpcChannel ManagedChannel channel) { + GreeterBlockingStub client = GreeterGrpc.newBlockingStub(channel); + GreetResponse response = client.greet(GreetRequest.newBuilder().setName("Francesco").build()); + + assertEquals("Hello Francesco for the 1 time!", response.getMessage()); + } +} diff --git a/jvm/kotlin-http/.gitignore b/jvm/kotlin-http/.gitignore new file mode 100644 index 00000000..5ae75d3d --- /dev/null +++ b/jvm/kotlin-http/.gitignore @@ -0,0 +1,32 @@ +# 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 diff --git a/jvm/kotlin-http/README.md b/jvm/kotlin-http/README.md new file mode 100644 index 00000000..ca6ea9ae --- /dev/null +++ b/jvm/kotlin-http/README.md @@ -0,0 +1,29 @@ +# Kotlin HTTP example + +Sample project configuration of a Restate service using the Kotlin coroutines interface and HTTP server. It contains: + +* [`build.gradle.kts`](build.gradle.kts) +* [Service interface definition `greeter.proto`](src/main/proto/greeter.proto) +* [Service class implementation `Greeter`](src/main/kotlin/dev/restate/sdk/examples/Greeter.kt) +* [Test `GreeterTest`](src/test/kotlin/dev/restate/sdk/examples/GreeterTest.kt) +* [Logging configuration](src/main/resources/log4j2.properties) + +## Running the example + +You can run the Kotlin greeter service via: + +```shell +./gradlew run +``` + +Or from the IDE UI. + +## Running the tests + +You can run the tests either via: + +```shell +./gradlew check +``` + +Or from the IDE UI. diff --git a/jvm/kotlin-http/build.gradle.kts b/jvm/kotlin-http/build.gradle.kts new file mode 100644 index 00000000..aeb8c5cb --- /dev/null +++ b/jvm/kotlin-http/build.gradle.kts @@ -0,0 +1,88 @@ +import com.google.protobuf.gradle.id +import org.jetbrains.kotlin.gradle.tasks.KotlinCompile + +plugins { + kotlin("jvm") version "1.9.10" + application + + id("com.google.protobuf") version "0.9.1" +} + +repositories { + mavenCentral() + // OSSRH Snapshots repo + // TODO remove it once we have the proper release + maven { url = uri("https://s01.oss.sonatype.org/content/repositories/snapshots/") } +} + +val restateVersion = "0.0.1-SNAPSHOT" + +dependencies { + // Restate SDK + implementation("dev.restate:sdk-kotlin:$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 (we need the Java dependencies as well because the Kotlin dependencies rely on Java) + implementation("com.google.protobuf:protobuf-java:3.24.3") + implementation("com.google.protobuf:protobuf-kotlin:3.24.3") + implementation("io.grpc:grpc-stub:1.58.0") + implementation("io.grpc:grpc-protobuf:1.58.0") + implementation("io.grpc:grpc-kotlin-stub:1.4.0") { exclude("javax.annotation", "javax.annotation-api") } + // 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") + + // To specify the coroutines dispatcher + implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.3") + + // Logging (optional) + implementation("org.apache.logging.log4j:log4j-core:2.20.0") + + // Testing (optional) + testImplementation("org.junit.jupiter:junit-jupiter:5.9.1") + testImplementation("org.jetbrains.kotlinx:kotlinx-coroutines-test:1.7.3") + testImplementation("dev.restate:sdk-test:$restateVersion") +} + +// Setup Java/Kotlin compiler target +java { + toolchain { + languageVersion.set(JavaLanguageVersion.of(17)) + } +} + +// Configure protoc plugin +protobuf { + protoc { artifact = "com.google.protobuf:protoc:3.24.3" } + + plugins { + id("grpc") { artifact = "io.grpc:protoc-gen-grpc-java:1.58.0" } + id("grpckt") { artifact = "io.grpc:protoc-gen-grpc-kotlin:1.4.0:jdk8@jar" } + } + + generateProtoTasks { + all().forEach { + // We need both java and kotlin codegen(s) because the kotlin protobuf/grpc codegen depends on the java ones + it.plugins { + id("grpc") + id("grpckt") + } + it.builtins { + java {} + id("kotlin") + } + } + } +} + +// Configure test platform +tasks.withType { + useJUnitPlatform() +} + +// Configure main class +application { + mainClass.set("dev.restate.sdk.examples.GreeterKt") +} diff --git a/jvm/kotlin-http/gradle/wrapper/gradle-wrapper.jar b/jvm/kotlin-http/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 00000000..033e24c4 Binary files /dev/null and b/jvm/kotlin-http/gradle/wrapper/gradle-wrapper.jar differ diff --git a/jvm/kotlin-http/gradle/wrapper/gradle-wrapper.properties b/jvm/kotlin-http/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 00000000..62f495df --- /dev/null +++ b/jvm/kotlin-http/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/jvm/kotlin-http/gradlew b/jvm/kotlin-http/gradlew new file mode 100755 index 00000000..fcb6fca1 --- /dev/null +++ b/jvm/kotlin-http/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/jvm/kotlin-http/gradlew.bat b/jvm/kotlin-http/gradlew.bat new file mode 100644 index 00000000..6689b85b --- /dev/null +++ b/jvm/kotlin-http/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/jvm/kotlin-http/src/main/kotlin/dev/restate/sdk/examples/Greeter.kt b/jvm/kotlin-http/src/main/kotlin/dev/restate/sdk/examples/Greeter.kt new file mode 100644 index 00000000..6baed897 --- /dev/null +++ b/jvm/kotlin-http/src/main/kotlin/dev/restate/sdk/examples/Greeter.kt @@ -0,0 +1,37 @@ +package dev.restate.sdk.examples + +import dev.restate.sdk.core.CoreSerdes +import dev.restate.sdk.core.StateKey +import dev.restate.sdk.examples.generated.* +import dev.restate.sdk.examples.generated.GreeterProto.GreetRequest +import dev.restate.sdk.examples.generated.GreeterProto.GreetResponse +import dev.restate.sdk.kotlin.RestateCoroutineService +import dev.restate.sdk.http.vertx.RestateHttpEndpointBuilder +import kotlinx.coroutines.Dispatchers + +class Greeter : + // Use Dispatchers.Unconfined as the Executor/thread pool is managed by the SDK itself. + GreeterGrpcKt.GreeterCoroutineImplBase(Dispatchers.Unconfined), + RestateCoroutineService { + + companion object { + private val COUNT = StateKey.of("count", CoreSerdes.INT) + } + + override suspend fun greet(request: GreetRequest): GreetResponse { + val ctx = restateContext() + + val count = ctx.get(COUNT) ?: 1 + ctx.set(COUNT, count + 1) + + return greetResponse { + message = "Hello ${request.name} for the $count time!" + } + } +} + +fun main() { + RestateHttpEndpointBuilder + .builder() + .withService(Greeter()).buildAndListen() +} diff --git a/jvm/kotlin-http/src/main/proto/greeter.proto b/jvm/kotlin-http/src/main/proto/greeter.proto new file mode 100644 index 00000000..74139459 --- /dev/null +++ b/jvm/kotlin-http/src/main/proto/greeter.proto @@ -0,0 +1,22 @@ +syntax = "proto3"; + +package greeter; + +import "dev/restate/ext.proto"; + +option java_package = "dev.restate.sdk.examples.generated"; +option java_outer_classname = "GreeterProto"; + +service Greeter { + option (dev.restate.ext.service_type) = KEYED; + + rpc Greet (GreetRequest) returns (GreetResponse); +} + +message GreetRequest { + string name = 1 [(dev.restate.ext.field) = KEY]; +} + +message GreetResponse { + string message = 1; +} diff --git a/jvm/kotlin-http/src/main/resources/log4j2.properties b/jvm/kotlin-http/src/main/resources/log4j2.properties new file mode 100644 index 00000000..130894e5 --- /dev/null +++ b/jvm/kotlin-http/src/main/resources/log4j2.properties @@ -0,0 +1,18 @@ +# 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 + +# Restate logs to debug level +logger.app.name = dev.restate +logger.app.level = debug +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/jvm/kotlin-http/src/test/kotlin/dev/restate/sdk/examples/GreeterTest.kt b/jvm/kotlin-http/src/test/kotlin/dev/restate/sdk/examples/GreeterTest.kt new file mode 100644 index 00000000..863fc76b --- /dev/null +++ b/jvm/kotlin-http/src/test/kotlin/dev/restate/sdk/examples/GreeterTest.kt @@ -0,0 +1,33 @@ +package dev.restate.sdk.examples + +import dev.restate.sdk.examples.generated.GreeterGrpcKt.GreeterCoroutineStub +import dev.restate.sdk.examples.generated.greetRequest +import dev.restate.sdk.testing.RestateGrpcChannel +import dev.restate.sdk.testing.RestateRunner +import dev.restate.sdk.testing.RestateRunnerBuilder +import io.grpc.ManagedChannel +import kotlinx.coroutines.test.runTest +import org.junit.jupiter.api.Assertions.assertEquals +import org.junit.jupiter.api.Test +import org.junit.jupiter.api.extension.RegisterExtension + +class GreeterTest { + companion object { + // Runner runs Restate using testcontainers and registers services + @RegisterExtension + private val restateRunner: RestateRunner = RestateRunnerBuilder.create() + // Service to test + .withService(Greeter()) + .buildRunner() + } + + @Test + fun testGreet( + // Channel to send requests to Restate services + @RestateGrpcChannel channel: ManagedChannel) = runTest { + val client = GreeterCoroutineStub(channel) + val response = client.greet(greetRequest { name = "Francesco" }) + + assertEquals("Hello Francesco for the 1 time!", response.getMessage()) + } +} diff --git a/jvm/kotlin-lambda/.gitignore b/jvm/kotlin-lambda/.gitignore new file mode 100644 index 00000000..5ae75d3d --- /dev/null +++ b/jvm/kotlin-lambda/.gitignore @@ -0,0 +1,32 @@ +# 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 diff --git a/jvm/kotlin-lambda/README.md b/jvm/kotlin-lambda/README.md new file mode 100644 index 00000000..e815b897 --- /dev/null +++ b/jvm/kotlin-lambda/README.md @@ -0,0 +1,32 @@ +# Kotlin Lambda example + +Sample project configuration of a Restate service using the Kotlin coroutines interface and AWS Lambda. It contains: + +* [`build.gradle.kts`](build.gradle.kts) +* [Service interface definition `greeter.proto`](src/main/proto/greeter.proto) +* [Service class implementation `Greeter`](src/main/kotlin/dev/restate/sdk/examples/Greeter.kt) +* [Lambda handler `LambdaHandler`](src/main/kotlin/dev/restate/sdk/examples/LambdaHandler.kt) +* [Test `GreeterTest`](src/test/kotlin/dev/restate/sdk/examples/GreeterTest.kt) +* [Logging configuration](src/main/resources/log4j2.properties) + +## Package + +Run: + +```shell +./gradlew shadowJar +``` + +You'll find the shadowed jar in the `build` directory. + +The class to configure in Lambda is `dev.restate.sdk.examples.LambdaHandler`. + +## Running the tests + +You can run the tests either via: + +```shell +./gradlew check +``` + +Or from the IDE UI. \ No newline at end of file diff --git a/jvm/kotlin-lambda/build.gradle.kts b/jvm/kotlin-lambda/build.gradle.kts new file mode 100644 index 00000000..2acf1057 --- /dev/null +++ b/jvm/kotlin-lambda/build.gradle.kts @@ -0,0 +1,85 @@ +import com.google.protobuf.gradle.id +import org.jetbrains.kotlin.gradle.tasks.KotlinCompile + +plugins { + kotlin("jvm") version "1.9.10" + + id("com.google.protobuf") version "0.9.1" + + // To package the dependency for Lambda + id("com.github.johnrengelman.shadow") version "7.1.2" +} + +repositories { + mavenCentral() + // OSSRH Snapshots repo + // TODO remove it once we have the proper release + maven { url = uri("https://s01.oss.sonatype.org/content/repositories/snapshots/") } +} + +val restateVersion = "0.0.1-SNAPSHOT" + +dependencies { + // Restate SDK + implementation("dev.restate:sdk-kotlin:$restateVersion") + implementation("dev.restate:sdk-lambda:$restateVersion") + // To use Jackson to read/write state entries (optional) + implementation("dev.restate:sdk-serde-jackson:$restateVersion") + + // Protobuf and grpc dependencies (we need the Java dependencies as well because the Kotlin dependencies rely on Java) + implementation("com.google.protobuf:protobuf-java:3.24.3") + implementation("com.google.protobuf:protobuf-kotlin:3.24.3") + implementation("io.grpc:grpc-stub:1.58.0") + implementation("io.grpc:grpc-protobuf:1.58.0") + implementation("io.grpc:grpc-kotlin-stub:1.4.0") { exclude("javax.annotation", "javax.annotation-api") } + // 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") + + // To specify the coroutines dispatcher + implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.3") + + // Logging (optional) + implementation("org.apache.logging.log4j:log4j-core:2.20.0") + + // Testing (optional) + testImplementation("org.junit.jupiter:junit-jupiter:5.9.1") + testImplementation("org.jetbrains.kotlinx:kotlinx-coroutines-test:1.7.3") + testImplementation("dev.restate:sdk-test:$restateVersion") +} + +// Setup Java/Kotlin compiler target +java { + toolchain { + languageVersion.set(JavaLanguageVersion.of(17)) + } +} + +// Configure protoc plugin +protobuf { + protoc { artifact = "com.google.protobuf:protoc:3.24.3" } + + plugins { + id("grpc") { artifact = "io.grpc:protoc-gen-grpc-java:1.58.0" } + id("grpckt") { artifact = "io.grpc:protoc-gen-grpc-kotlin:1.4.0:jdk8@jar" } + } + + generateProtoTasks { + all().forEach { + // We need both java and kotlin codegen(s) because the kotlin protobuf/grpc codegen depends on the java ones + it.plugins { + id("grpc") + id("grpckt") + } + it.builtins { + java {} + id("kotlin") + } + } + } +} + +// Configure test platform +tasks.withType { + useJUnitPlatform() +} \ No newline at end of file diff --git a/jvm/kotlin-lambda/gradle/wrapper/gradle-wrapper.jar b/jvm/kotlin-lambda/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 00000000..033e24c4 Binary files /dev/null and b/jvm/kotlin-lambda/gradle/wrapper/gradle-wrapper.jar differ diff --git a/jvm/kotlin-lambda/gradle/wrapper/gradle-wrapper.properties b/jvm/kotlin-lambda/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 00000000..62f495df --- /dev/null +++ b/jvm/kotlin-lambda/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/jvm/kotlin-lambda/gradlew b/jvm/kotlin-lambda/gradlew new file mode 100755 index 00000000..fcb6fca1 --- /dev/null +++ b/jvm/kotlin-lambda/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/jvm/kotlin-lambda/gradlew.bat b/jvm/kotlin-lambda/gradlew.bat new file mode 100644 index 00000000..6689b85b --- /dev/null +++ b/jvm/kotlin-lambda/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/jvm/kotlin-lambda/src/main/kotlin/dev/restate/sdk/examples/Greeter.kt b/jvm/kotlin-lambda/src/main/kotlin/dev/restate/sdk/examples/Greeter.kt new file mode 100644 index 00000000..638c6a3b --- /dev/null +++ b/jvm/kotlin-lambda/src/main/kotlin/dev/restate/sdk/examples/Greeter.kt @@ -0,0 +1,30 @@ +package dev.restate.sdk.examples + +import dev.restate.sdk.core.CoreSerdes +import dev.restate.sdk.core.StateKey +import dev.restate.sdk.examples.generated.* +import dev.restate.sdk.examples.generated.GreeterProto.GreetRequest +import dev.restate.sdk.examples.generated.GreeterProto.GreetResponse +import dev.restate.sdk.kotlin.RestateCoroutineService +import kotlinx.coroutines.Dispatchers + +class Greeter : + // Use Dispatchers.Unconfined as the Executor/thread pool is managed by the SDK itself. + GreeterGrpcKt.GreeterCoroutineImplBase(Dispatchers.Unconfined), + RestateCoroutineService { + + companion object { + private val COUNT = StateKey.of("count", CoreSerdes.INT) + } + + override suspend fun greet(request: GreetRequest): GreetResponse { + val ctx = restateContext() + + val count = ctx.get(COUNT) ?: 1 + ctx.set(COUNT, count + 1) + + return greetResponse { + message = "Hello ${request.name} for the $count time!" + } + } +} diff --git a/jvm/kotlin-lambda/src/main/kotlin/dev/restate/sdk/examples/LambdaHandler.kt b/jvm/kotlin-lambda/src/main/kotlin/dev/restate/sdk/examples/LambdaHandler.kt new file mode 100644 index 00000000..b95f2708 --- /dev/null +++ b/jvm/kotlin-lambda/src/main/kotlin/dev/restate/sdk/examples/LambdaHandler.kt @@ -0,0 +1,10 @@ +package dev.restate.sdk.examples + +import dev.restate.sdk.lambda.BaseRestateLambdaHandler +import dev.restate.sdk.lambda.RestateLambdaEndpointBuilder + +class LambdaHandler : BaseRestateLambdaHandler() { + override fun register(builder: RestateLambdaEndpointBuilder) { + builder.withService(Greeter()) + } +} diff --git a/jvm/kotlin-lambda/src/main/proto/greeter.proto b/jvm/kotlin-lambda/src/main/proto/greeter.proto new file mode 100644 index 00000000..74139459 --- /dev/null +++ b/jvm/kotlin-lambda/src/main/proto/greeter.proto @@ -0,0 +1,22 @@ +syntax = "proto3"; + +package greeter; + +import "dev/restate/ext.proto"; + +option java_package = "dev.restate.sdk.examples.generated"; +option java_outer_classname = "GreeterProto"; + +service Greeter { + option (dev.restate.ext.service_type) = KEYED; + + rpc Greet (GreetRequest) returns (GreetResponse); +} + +message GreetRequest { + string name = 1 [(dev.restate.ext.field) = KEY]; +} + +message GreetResponse { + string message = 1; +} diff --git a/jvm/kotlin-lambda/src/main/resources/META-INF/services/dev.restate.sdk.lambda.LambdaRestateServerFactory b/jvm/kotlin-lambda/src/main/resources/META-INF/services/dev.restate.sdk.lambda.LambdaRestateServerFactory new file mode 100644 index 00000000..297dab9e --- /dev/null +++ b/jvm/kotlin-lambda/src/main/resources/META-INF/services/dev.restate.sdk.lambda.LambdaRestateServerFactory @@ -0,0 +1 @@ +dev.restate.sdk.examples.LambdaFactory \ No newline at end of file diff --git a/jvm/kotlin-lambda/src/main/resources/log4j2.properties b/jvm/kotlin-lambda/src/main/resources/log4j2.properties new file mode 100644 index 00000000..130894e5 --- /dev/null +++ b/jvm/kotlin-lambda/src/main/resources/log4j2.properties @@ -0,0 +1,18 @@ +# 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 + +# Restate logs to debug level +logger.app.name = dev.restate +logger.app.level = debug +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/jvm/kotlin-lambda/src/test/kotlin/dev/restate/sdk/examples/GreeterTest.kt b/jvm/kotlin-lambda/src/test/kotlin/dev/restate/sdk/examples/GreeterTest.kt new file mode 100644 index 00000000..863fc76b --- /dev/null +++ b/jvm/kotlin-lambda/src/test/kotlin/dev/restate/sdk/examples/GreeterTest.kt @@ -0,0 +1,33 @@ +package dev.restate.sdk.examples + +import dev.restate.sdk.examples.generated.GreeterGrpcKt.GreeterCoroutineStub +import dev.restate.sdk.examples.generated.greetRequest +import dev.restate.sdk.testing.RestateGrpcChannel +import dev.restate.sdk.testing.RestateRunner +import dev.restate.sdk.testing.RestateRunnerBuilder +import io.grpc.ManagedChannel +import kotlinx.coroutines.test.runTest +import org.junit.jupiter.api.Assertions.assertEquals +import org.junit.jupiter.api.Test +import org.junit.jupiter.api.extension.RegisterExtension + +class GreeterTest { + companion object { + // Runner runs Restate using testcontainers and registers services + @RegisterExtension + private val restateRunner: RestateRunner = RestateRunnerBuilder.create() + // Service to test + .withService(Greeter()) + .buildRunner() + } + + @Test + fun testGreet( + // Channel to send requests to Restate services + @RestateGrpcChannel channel: ManagedChannel) = runTest { + val client = GreeterCoroutineStub(channel) + val response = client.greet(greetRequest { name = "Francesco" }) + + assertEquals("Hello Francesco for the 1 time!", response.getMessage()) + } +}