diff --git a/examples/README.md b/examples/README.md index 30be401..1ef12f5 100644 --- a/examples/README.md +++ b/examples/README.md @@ -6,6 +6,7 @@ * [Spring](#spring) * [Quarkus](#quarkus) * [Ktor](#ktor) + * [Micronaut](#micronaut) * [Java HTTP Server](#java-http-server) [//]: # (@formatter:on) @@ -30,6 +31,12 @@ This example uses `Ktor` to serve the front end. - [Ktor Routing](ktor/ktor-example/src/main/kotlin/Application.kt): Demonstrates integration with Ktor Routing. +## Micronaut + +This example uses `Micronaut` to serve the front end. + +- [Micronaut Reactor](micronaut/micronaut-reactor-example/src/main/kotlin/dev/datastar/kotlin/examples/micronaut/MicronautReactorApplication.kt) + ## Java HTTP Server This example uses the plain Java `HttpServer` to serve the front end. diff --git a/examples/micronaut/micronaut-reactor-example/build.gradle.kts b/examples/micronaut/micronaut-reactor-example/build.gradle.kts new file mode 100644 index 0000000..84c9133 --- /dev/null +++ b/examples/micronaut/micronaut-reactor-example/build.gradle.kts @@ -0,0 +1,73 @@ +plugins { + id("org.jetbrains.kotlin.jvm") version "2.2.0" + id("org.jetbrains.kotlin.plugin.allopen") version "2.2.0" + id("com.google.devtools.ksp") version "2.2.10-2.0.2" + id("io.micronaut.application") version "4.5.4" + id("com.gradleup.shadow") version "8.3.7" + id("io.micronaut.aot") version "4.5.4" +} + +version = "0.1" +group = "dev.datastar.kotlin.examples.micronaut" + +val kotlinVersion = project.properties.get("kotlinVersion") +repositories { + mavenCentral() +} + +dependencies { + implementation("dev.data-star.kotlin:kotlin-sdk:1.0.0-RC2") + implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.10.2") + implementation("org.jetbrains.kotlinx:kotlinx-coroutines-reactor:1.10.2") + implementation("io.micronaut.reactor:micronaut-reactor") + ksp("io.micronaut:micronaut-http-validation") + ksp("io.micronaut.serde:micronaut-serde-processor") + implementation("io.micronaut.kotlin:micronaut-kotlin-runtime") + implementation("io.micronaut.serde:micronaut-serde-jackson") + implementation("org.jetbrains.kotlin:kotlin-reflect:${kotlinVersion}") + implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8:${kotlinVersion}") + compileOnly("io.micronaut:micronaut-http-client") + runtimeOnly("ch.qos.logback:logback-classic") + runtimeOnly("com.fasterxml.jackson.module:jackson-module-kotlin") + testImplementation("io.micronaut:micronaut-http-client") +} + + +application { + mainClass = "dev.datastar.kotlin.examples.micronaut.ApplicationKt" +} +java { + toolchain { + languageVersion = JavaLanguageVersion.of(21) + } +} + + +graalvmNative.toolchainDetection = false + +micronaut { + runtime("netty") + testRuntime("junit5") + processing { + incremental(true) + annotations("dev.datastar.kotlin.examples.micronaut.*") + } + aot { + // Please review carefully the optimizations enabled below + // Check https://micronaut-projects.github.io/micronaut-aot/latest/guide/ for more details + optimizeServiceLoading = false + convertYamlToJava = false + precomputeOperations = true + cacheEnvironment = true + optimizeClassLoading = true + deduceEnvironment = true + optimizeNetty = true + replaceLogbackXml = true + } +} + +tasks.named("dockerfileNative") { + jdkVersion = "21" +} + + diff --git a/examples/micronaut/micronaut-reactor-example/gradle.properties b/examples/micronaut/micronaut-reactor-example/gradle.properties new file mode 100644 index 0000000..14fceb0 --- /dev/null +++ b/examples/micronaut/micronaut-reactor-example/gradle.properties @@ -0,0 +1,3 @@ +micronautVersion=4.9.3 +kotlinVersion=2.2.0 +org.gradle.jvmargs=-Xmx4096M diff --git a/examples/micronaut/micronaut-reactor-example/gradle/wrapper/gradle-wrapper.jar b/examples/micronaut/micronaut-reactor-example/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..1b33c55 Binary files /dev/null and b/examples/micronaut/micronaut-reactor-example/gradle/wrapper/gradle-wrapper.jar differ diff --git a/examples/micronaut/micronaut-reactor-example/gradle/wrapper/gradle-wrapper.properties b/examples/micronaut/micronaut-reactor-example/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..ff23a68 --- /dev/null +++ b/examples/micronaut/micronaut-reactor-example/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.2-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/examples/micronaut/micronaut-reactor-example/gradlew b/examples/micronaut/micronaut-reactor-example/gradlew new file mode 100755 index 0000000..23d15a9 --- /dev/null +++ b/examples/micronaut/micronaut-reactor-example/gradlew @@ -0,0 +1,251 @@ +#!/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. +# +# SPDX-License-Identifier: Apache-2.0 +# + +############################################################################## +# +# 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/platforms/jvm/plugins-application/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##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || 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="\\\"\\\"" + + +# 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=SC2039,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=SC2039,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 optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \ + "$@" + +# 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/examples/micronaut/micronaut-reactor-example/gradlew.bat b/examples/micronaut/micronaut-reactor-example/gradlew.bat new file mode 100644 index 0000000..db3a6ac --- /dev/null +++ b/examples/micronaut/micronaut-reactor-example/gradlew.bat @@ -0,0 +1,94 @@ +@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 +@rem SPDX-License-Identifier: Apache-2.0 +@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. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH= + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %* + +: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/examples/micronaut/micronaut-reactor-example/micronaut-cli.yml b/examples/micronaut/micronaut-reactor-example/micronaut-cli.yml new file mode 100644 index 0000000..893adea --- /dev/null +++ b/examples/micronaut/micronaut-reactor-example/micronaut-cli.yml @@ -0,0 +1,6 @@ +applicationType: default +defaultPackage: dev.datastar.kotlin.examples.micronaut +testFramework: junit +sourceLanguage: kotlin +buildTool: gradle_kotlin +features: [app-name, gradle, http-client-test, junit, kotlin, kotlin-application, ksp, logback, micronaut-aot, micronaut-build, micronaut-http-validation, netty-server, properties, readme, serialization-jackson, shade, static-resources] diff --git a/examples/micronaut/micronaut-reactor-example/settings.gradle.kts b/examples/micronaut/micronaut-reactor-example/settings.gradle.kts new file mode 100644 index 0000000..a5ea6af --- /dev/null +++ b/examples/micronaut/micronaut-reactor-example/settings.gradle.kts @@ -0,0 +1,2 @@ +rootProject.name = "micronaut-reactor-example" + diff --git a/examples/micronaut/micronaut-reactor-example/src/main/kotlin/dev/datastar/kotlin/examples/micronaut/MicronautReactorApplication.kt b/examples/micronaut/micronaut-reactor-example/src/main/kotlin/dev/datastar/kotlin/examples/micronaut/MicronautReactorApplication.kt new file mode 100644 index 0000000..a96232e --- /dev/null +++ b/examples/micronaut/micronaut-reactor-example/src/main/kotlin/dev/datastar/kotlin/examples/micronaut/MicronautReactorApplication.kt @@ -0,0 +1,88 @@ +package dev.datastar.kotlin.examples.micronaut + +import dev.datastar.kotlin.sdk.Response +import dev.datastar.kotlin.sdk.ServerSentEventGenerator +import io.micronaut.http.HttpStatus +import io.micronaut.http.MediaType +import io.micronaut.http.annotation.Controller +import io.micronaut.http.annotation.Get +import io.micronaut.http.annotation.Post +import io.micronaut.http.annotation.Produces +import io.micronaut.http.annotation.Status +import io.micronaut.runtime.Micronaut.run +import kotlinx.coroutines.flow.MutableStateFlow +import kotlinx.coroutines.reactor.flux +import kotlinx.coroutines.runBlocking +import reactor.core.publisher.Flux + +fun main(args: Array) { + run(*args) +} + +@Controller +class CounterController { + + private val counter = MutableStateFlow(0) + + @Get + @Produces(MediaType.TEXT_HTML) + fun index(): Flux = flux { + this.javaClass.classLoader + .getResource("counter.html") + ?.openStream() + ?.reader() + ?.useLines { lines -> + for (line in lines) { + send(line) + } + } + } + + + @Get("/counter") + @Produces(MediaType.TEXT_EVENT_STREAM) + @Status(HttpStatus.OK) + fun counter(): Flux = flux { + val response = MicronautResponse { s: String -> + runBlocking { + send(s) + } + } + + val generator = ServerSentEventGenerator(response) + + counter.collect { event -> + generator.patchElements("""${event}""") + + if (event == 3) { + generator.executeScript("""alert('Thanks for trying Datastar!')""") + } + } + } + + @Post("/increment") + @Status(HttpStatus.NO_CONTENT) + fun increment() { + counter.value++ + } + + @Post("/decrement") + @Status(HttpStatus.NO_CONTENT) + fun decrement() { + counter.value-- + } + +} + +class MicronautResponse( + private val sender: (String) -> Unit, +) : Response { + override fun flush() = Unit + + override fun sendConnectionHeaders( + status: Int, + headers: Map> + ) = Unit + + override fun write(text: String) = sender(text) +} \ No newline at end of file diff --git a/examples/micronaut/micronaut-reactor-example/src/main/resources/application.properties b/examples/micronaut/micronaut-reactor-example/src/main/resources/application.properties new file mode 100644 index 0000000..4cd26db --- /dev/null +++ b/examples/micronaut/micronaut-reactor-example/src/main/resources/application.properties @@ -0,0 +1,2 @@ +#Sat Sep 06 11:42:02 UTC 2025 +micronaut.application.name=micronaut-web-example diff --git a/examples/micronaut/micronaut-reactor-example/src/main/resources/counter.html b/examples/micronaut/micronaut-reactor-example/src/main/resources/counter.html new file mode 100644 index 0000000..b8a6a79 --- /dev/null +++ b/examples/micronaut/micronaut-reactor-example/src/main/resources/counter.html @@ -0,0 +1,185 @@ + + + + + + Counting Stars + + + + + +
+

Counting Stars

+
+ Loading... +
+
+ + +
+
+ + + \ No newline at end of file diff --git a/examples/micronaut/micronaut-reactor-example/src/main/resources/logback.xml b/examples/micronaut/micronaut-reactor-example/src/main/resources/logback.xml new file mode 100644 index 0000000..2d77bda --- /dev/null +++ b/examples/micronaut/micronaut-reactor-example/src/main/resources/logback.xml @@ -0,0 +1,14 @@ + + + + + + %cyan(%d{HH:mm:ss.SSS}) %gray([%thread]) %highlight(%-5level) %magenta(%logger{36}) - %msg%n + + + + + + + diff --git a/settings.gradle.kts b/settings.gradle.kts index 49a7865..175943a 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -12,3 +12,4 @@ includeBuild("examples/quarkus/quarkus-rest-example") includeBuild("examples/quarkus/quarkus-qute-example") includeBuild("examples/ktor/ktor-example") includeBuild("examples/java-httpserver") +includeBuild("examples/micronaut/micronaut-reactor-example")