diff --git a/README.md b/README.md index f7b6146..a7e65ef 100644 --- a/README.md +++ b/README.md @@ -7,4 +7,5 @@ - 🛠️ [Kotlin Multiplatform](kmp/README.md) - 🌐 [Kotlin-Js Interop](kotlin-js-interop/README.md) - ⚙️ [Ktor Framework](ktor/README.md) +- 🔄 [Ktor Retry Plugin](ktor-retry-plugin/README.md) - 🛡️ [Resilience4j](resilience4j/README.md) diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index 5f1fbae..5742b1b 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -12,8 +12,11 @@ compose-compiler = "1.5.4" compose-material3 = "1.2.1" androidx-activityCompose = "1.8.2" kotlinx-serialization = "1.6.3" -junit = "5.9.3" +junit = "4.13.2" +junit-jupiter = "5.9.3" resilience4j = "2.2.0" +logback = "1.5.3" +hamcrest = "2.2" [libraries] # kotlin @@ -45,23 +48,33 @@ ktor-client-core = { module = "io.ktor:ktor-client-core", version.ref = "ktor" } ktor-client-js = { module = "io.ktor:ktor-client-js", version.ref = "ktor" } ktor-client-android = { module = "io.ktor:ktor-client-android", version.ref = "ktor" } ktor-client-websockets = { module = "io.ktor:ktor-client-websockets", version.ref = "ktor" } +ktor-client-cio = { module = "io.ktor:ktor-client-cio", version.ref = "ktor" } +ktor-client-logging = { module = "io.ktor:ktor-client-logging", version.ref = "ktor" } ktor-bom = { module = "io.ktor:ktor-bom", version.ref = "ktor" } +ktor-server-core = { module = "io.ktor:ktor-server-core", version.ref = "ktor" } ktor-server-netty = { module = "io.ktor:ktor-server-netty", version.ref = "ktor" } ktor-server-websockets = { module = "io.ktor:ktor-server-websockets", version.ref = "ktor" } +ktor-server-cio = { module = "io.ktor:ktor-server-cio", version.ref = "ktor" } ktor-server-calllogging = { module = "io.ktor:ktor-server-call-logging", version.ref = "ktor" } ktor-server-defaultheaders = { module = "io.ktor:ktor-server-default-headers", version.ref = "ktor" } ktor-server-sessions = { module = "io.ktor:ktor-server-sessions", version.ref = "ktor" } ktor-server-statuspages = { module = "io.ktor:ktor-server-status-pages", version.ref = "ktor" } -ktor-server-test-host = { module = "io.ktor:ktor-server-test-host", version.ref = "ktor" } +ktor-server-testhost = { module = "io.ktor:ktor-server-test-host", version.ref = "ktor" } +ktor-server-hostcommon = { module = "io.ktor:ktor-server-host-common", version.ref = "ktor" } # Resilience4j resilience4j-retry = { module = "io.github.resilience4j:resilience4j-retry", version.ref = "resilience4j" } resilience4j-kotlin = { module = "io.github.resilience4j:resilience4j-kotlin", version.ref = "resilience4j" } +# junit +junit = { module = "junit:junit", version.ref = "junit" } +junit-jupiter-engine = { module = "org.junit.jupiter:junit-jupiter-engine", version.ref = "junit-jupiter" } + # others +logback-classic = { module = "ch.qos.logback:logback-classic", version.ref = "logback" } nexus-publish = { module = "io.github.gradle-nexus.publish-plugin:io.github.gradle-nexus.publish-plugin.gradle.plugin", version.ref = "nexus-publish" } mockito-core = { module = "org.mockito:mockito-core", version.ref = "mockito" } -junit-jupiter-engine = { module = "org.junit.jupiter:junit-jupiter-engine", version.ref = "junit" } +hamcrest = { module = "org.hamcrest:hamcrest", version.ref = "hamcrest" } [plugins] androidLibrary = { id = "com.android.library", version.ref = "agp" } @@ -71,4 +84,4 @@ kotlinMultiplatform = { id = "org.jetbrains.kotlin.multiplatform", version.ref = kotlinAndroid = { id = "org.jetbrains.kotlin.android", version.ref = "kotlin" } kotlinxSerialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlin" } -# original toml taken from: https://github.com/ktorio/ktor-documentation/blob/2.3.9/codeSnippets/snippets/tutorial-client-kmm/gradle/libs.versions.toml \ No newline at end of file +# original toml taken from: https://github.com/ktorio/ktor-documentation/blob/2.3.9/codeSnippets/snippets/tutorial-client-kmm/gradle/libs.versions.toml diff --git a/ktor-retry-plugin/README.md b/ktor-retry-plugin/README.md new file mode 100644 index 0000000..ffcb228 --- /dev/null +++ b/ktor-retry-plugin/README.md @@ -0,0 +1,78 @@ +# Ktor Retry Plugin + +### Install + +The `HttpRequestRetry` plugin can be installed using the `install` function +and configured using its **last parameter function** +(_trailing lambda_), as with other Ktor plugins. + +The plugin is part of the `ktor-client-core` module. + +### Configuration + +| Property | Description | +|----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `maxRetries` | The maximum number of retries | | +| `retryIf` | A lambda that returns `true` if the request should be retried on specific request details and or responses. | +| `retryOnExceptionIf` | A lambda that returns `true` if the request should be retried on specific request details and or exceptions that occurred. | +| `delayMillis` | A lambda that returns the delay in milliseconds before the next retry. Some methods are provided to create more complex delays, such as `exponentialDelay()` or `constantDelay()`. | + +> [!NOTE] +> The plugin also provides more specific methods to retry for +> (e.g., on server errors, for example, `retryOnServerErrors()` retries on server 5xx errors). + +Example: + +```kotlin +val client = HttpClient(CIO) { + install(HttpRequestRetry) { + maxRetries = 5 + retryIf { request, response -> + !response.status.isSuccess() + } + retryOnExceptionIf { request, cause -> + cause is NetworkError + } + delayMillis { retry -> + retry * 3000L + } // retries in 3, 6, 9, etc. seconds + } + // other configurations +} +``` + +Default configuration: + +```kotlin +install(HttpRequestRetry) { + retryOnExceptionOrServerErrors(3) + exponentialDelay() +} +``` + +### Changing a Request Before Retry + +It is possible to modify the request +before retrying it by using the `modifyRequest` method inside the configuration block of the plugin. +This method receives a lambda that takes the request and returns the modified request. +One usage example is to add a header with the current retry count: + +```kotlin +val client = HttpClient(CIO) { + install(HttpRequestRetry) { + modifyRequest { request -> + request.headers.append("x-retry-count", retryCount.toString()) + } + } + // other configurations +} +``` + +> [!IMPORTANT] +> To preserve configuration context between retry attempts, the plugin uses request attibutes to store data. +> If those are altered, the plugin may not work as expected. +> +> If an attribute is not present in the request, the plugin will use the default configuration associated with that attribute. +> Such behaviour can be seen in the source code: +> - [after applying configuration](https://github.com/ktorio/ktor/blob/7c76fa7c0f2b7dcc6e0445da8612d75bb5d11609/ktor-client/ktor-client-core/common/src/io/ktor/client/plugins/HttpRequestRetry.kt#L366-L373) +> - [before each retry attempt](https://github.com/ktorio/ktor/blob/7c76fa7c0f2b7dcc6e0445da8612d75bb5d11609/ktor-client/ktor-client-core/common/src/io/ktor/client/plugins/HttpRequestRetry.kt#L267-L274) diff --git a/ktor-retry-plugin/client-retry/README.md b/ktor-retry-plugin/client-retry/README.md new file mode 100644 index 0000000..f267abc --- /dev/null +++ b/ktor-retry-plugin/client-retry/README.md @@ -0,0 +1,18 @@ +# Client Retry + +A sample Ktor project showing how to use the [HttpRequestRetry](https://ktor.io/docs/client-retry.html) plugin. + +## Running + +This client sample uses the server from the [simulate-slow-server](../simulate-slow-server) example. +The server sample has the `/error` route that returns the `200 OK` response from the third attempt only. + +To see `HttpRequestRetry` in action, run this example by executing the following command: + +```bash +./gradlew :client-retry:run +``` + +The client will send three consequent requests automatically to get a success response from the server. + +> Note that this example uses the [Logging](https://ktor.io/docs/client-logging.html) plugin to show all requests in a console. diff --git a/ktor-retry-plugin/client-retry/build.gradle.kts b/ktor-retry-plugin/client-retry/build.gradle.kts new file mode 100644 index 0000000..31a1756 --- /dev/null +++ b/ktor-retry-plugin/client-retry/build.gradle.kts @@ -0,0 +1,27 @@ +plugins { + application + alias(libs.plugins.kotlinJvm) +} + +application { + mainClass.set("application.ApplicationKt") +} + +repositories { + mavenCentral() + maven { url = uri("https://maven.pkg.jetbrains.space/public/p/ktor/eap") } +} + +dependencies { + implementation(libs.ktor.client.core) + implementation(libs.ktor.client.cio) + implementation(libs.ktor.client.logging) + implementation(libs.ktor.server.core) + implementation(libs.ktor.server.cio) + implementation(libs.ktor.server.hostcommon) + implementation(libs.logback.classic) + implementation(project(":simulate-slow-server")) + implementation(project(":end-to-end-utilities")) + testImplementation(libs.junit) + testImplementation(libs.hamcrest) +} diff --git a/ktor-retry-plugin/client-retry/src/main/kotlin/application/Application.kt b/ktor-retry-plugin/client-retry/src/main/kotlin/application/Application.kt new file mode 100644 index 0000000..035a08c --- /dev/null +++ b/ktor-retry-plugin/client-retry/src/main/kotlin/application/Application.kt @@ -0,0 +1,28 @@ +package application + +import e2e.* +import io.ktor.client.* +import io.ktor.client.engine.cio.* +import io.ktor.client.plugins.* +import io.ktor.client.plugins.logging.* +import io.ktor.client.request.* +import io.ktor.client.statement.* +import io.ktor.server.application.* +import kotlinx.coroutines.* +import slowserver.main + +fun main() { + defaultServer(Application::main).start() + runBlocking { + val client = HttpClient(CIO) { + install(HttpRequestRetry) { + retryOnServerErrors(maxRetries = 5) + exponentialDelay() + } + install(Logging) { level = LogLevel.INFO } + } + + val response: HttpResponse = client.get("http://0.0.0.0:8080/error") + println(response.bodyAsText()) + } +} diff --git a/ktor-retry-plugin/client-retry/src/test/kotlin/application/ApplicationTest.kt b/ktor-retry-plugin/client-retry/src/test/kotlin/application/ApplicationTest.kt new file mode 100644 index 0000000..ef2dd76 --- /dev/null +++ b/ktor-retry-plugin/client-retry/src/test/kotlin/application/ApplicationTest.kt @@ -0,0 +1,44 @@ +package application + +import e2e.readString +import e2e.runGradleAppWaiting +import kotlinx.coroutines.runBlocking +import org.junit.* +import org.junit.Assert.* +import java.io.File + +class ApplicationTest { + + companion object { + private const val GRADLEW_WINDOWS = "gradlew.bat" + private const val GRADLEW_UNIX = "gradlew" + + @JvmStatic + fun findGradleWrapper(): String { + val currentDir = File(System.getProperty("user.dir")) + val parentDir = currentDir.parent ?: error("Cannot find parent directory of $currentDir") + val gradlewName = if (System.getProperty("os.name").startsWith("Windows")) { + GRADLEW_WINDOWS + } else { + GRADLEW_UNIX + } + val gradlewFile = File(parentDir, gradlewName) + check(gradlewFile.exists()) { "Gradle Wrapper not found at ${gradlewFile.absolutePath}" } + return gradlewFile.absolutePath + } + } + + @Before + fun setup() { + System.setProperty("gradlew", findGradleWrapper()) + } + + @Test + fun outputContainsAllResponses() = runBlocking { + runGradleAppWaiting().inputStream.readString().let { outputString -> + assertTrue(outputString.contains("RESPONSE: 500 Internal Server Error")) + assertTrue(outputString.contains("RESPONSE: 200 OK")) + assertTrue(outputString.contains("Server is back online!")) + } + } +} diff --git a/ktor-retry-plugin/end-to-end-utilities/README.md b/ktor-retry-plugin/end-to-end-utilities/README.md new file mode 100644 index 0000000..f902153 --- /dev/null +++ b/ktor-retry-plugin/end-to-end-utilities/README.md @@ -0,0 +1,3 @@ +# End-to-end utilities + +This project isn't runnable and contains helper classes and functions for testing samples from this repository. diff --git a/ktor-retry-plugin/end-to-end-utilities/build.gradle.kts b/ktor-retry-plugin/end-to-end-utilities/build.gradle.kts new file mode 100644 index 0000000..fd875eb --- /dev/null +++ b/ktor-retry-plugin/end-to-end-utilities/build.gradle.kts @@ -0,0 +1,13 @@ +plugins { + alias(libs.plugins.kotlinJvm) +} + +repositories { + mavenCentral() + maven { url = uri("https://maven.pkg.jetbrains.space/public/p/ktor/eap") } +} + +dependencies { + implementation(libs.ktor.server.core) + implementation(libs.ktor.server.cio) +} diff --git a/ktor-retry-plugin/end-to-end-utilities/src/main/kotlin/e2e/defaultServer.kt b/ktor-retry-plugin/end-to-end-utilities/src/main/kotlin/e2e/defaultServer.kt new file mode 100644 index 0000000..013f5e4 --- /dev/null +++ b/ktor-retry-plugin/end-to-end-utilities/src/main/kotlin/e2e/defaultServer.kt @@ -0,0 +1,16 @@ +package e2e + +import io.ktor.server.application.* +import io.ktor.server.cio.* +import io.ktor.server.engine.* +import org.slf4j.helpers.NOPLogger + +fun defaultServer(module: Application.() -> Unit) = embeddedServer(CIO, environment = applicationEngineEnvironment { + log = NOPLogger.NOP_LOGGER + + connector { + port = 8080 + } + + module(module) +}) diff --git a/ktor-retry-plugin/end-to-end-utilities/src/main/kotlin/e2e/gradleProcess.kt b/ktor-retry-plugin/end-to-end-utilities/src/main/kotlin/e2e/gradleProcess.kt new file mode 100644 index 0000000..804c069 --- /dev/null +++ b/ktor-retry-plugin/end-to-end-utilities/src/main/kotlin/e2e/gradleProcess.kt @@ -0,0 +1,21 @@ +package e2e + +import java.io.InputStream + +fun runGradleAppWaiting(): Process = runGradleWaiting("run") +fun runGradleApp(): Process = runGradle("run") + +fun runGradleWaiting(vararg args: String): Process { + val process = runGradle(*args) + process.waitFor() + return process +} + +fun runGradle(vararg args: String): Process { + val gradlewPath = + System.getProperty("gradlew") ?: error("System property 'gradlew' should point to Gradle Wrapper file") + val processArgs = listOf(gradlewPath, "-Dorg.gradle.logging.level=quiet", "--quiet") + args + return ProcessBuilder(processArgs).start() +} + +fun InputStream.readString(): String = readAllBytes().toString(Charsets.UTF_8) diff --git a/ktor-retry-plugin/gradle/wrapper/gradle-wrapper.jar b/ktor-retry-plugin/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..7f93135 Binary files /dev/null and b/ktor-retry-plugin/gradle/wrapper/gradle-wrapper.jar differ diff --git a/ktor-retry-plugin/gradle/wrapper/gradle-wrapper.properties b/ktor-retry-plugin/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..3fa8f86 --- /dev/null +++ b/ktor-retry-plugin/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.4-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/ktor-retry-plugin/gradlew b/ktor-retry-plugin/gradlew new file mode 100644 index 0000000..1aa94a4 --- /dev/null +++ b/ktor-retry-plugin/gradlew @@ -0,0 +1,249 @@ +#!/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##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && 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=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, 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" \ + 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/ktor-retry-plugin/gradlew.bat b/ktor-retry-plugin/gradlew.bat new file mode 100644 index 0000000..93e3f59 --- /dev/null +++ b/ktor-retry-plugin/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/ktor-retry-plugin/settings.gradle.kts b/ktor-retry-plugin/settings.gradle.kts new file mode 100644 index 0000000..45e616b --- /dev/null +++ b/ktor-retry-plugin/settings.gradle.kts @@ -0,0 +1,28 @@ +pluginManagement { + repositories { + google() + mavenCentral() + gradlePluginPortal() + } +} + +dependencyResolutionManagement { + dependencyResolutionManagement { + versionCatalogs { + create("libs") { + from(files("../gradle/libs.versions.toml")) + } + } + } + @Suppress("UnstableApiUsage") + repositories { + google() + mavenCentral() + } +} + +rootProject.name = "ktor-retry-plugin" + +include(":client-retry") +include(":simulate-slow-server") +include(":end-to-end-utilities") diff --git a/ktor-retry-plugin/simulate-slow-server/README.md b/ktor-retry-plugin/simulate-slow-server/README.md new file mode 100644 index 0000000..11795da --- /dev/null +++ b/ktor-retry-plugin/simulate-slow-server/README.md @@ -0,0 +1,11 @@ +# Slow Server + +An application simulating a slow server by creating a custom interceptor for Ktor. + +## Running + +Execute this command in the repository's root directory to run this sample: + +```bash +./gradlew :simulate-slow-server:run +``` diff --git a/ktor-retry-plugin/simulate-slow-server/build.gradle.kts b/ktor-retry-plugin/simulate-slow-server/build.gradle.kts new file mode 100644 index 0000000..56a819d --- /dev/null +++ b/ktor-retry-plugin/simulate-slow-server/build.gradle.kts @@ -0,0 +1,22 @@ +plugins { + application + alias(libs.plugins.kotlinJvm) +} + +application { + mainClass.set("io.ktor.server.netty.EngineMain") +} + +repositories { + mavenCentral() + maven { url = uri("https://maven.pkg.jetbrains.space/public/p/ktor/eap") } +} + +dependencies { + implementation(libs.kotlin.stdlib.jdk8) + implementation(libs.ktor.server.netty) + implementation(libs.ktor.server.core) + implementation(libs.logback.classic) + testImplementation(libs.ktor.server.testhost) + testImplementation(libs.kotlin.test) +} diff --git a/ktor-retry-plugin/simulate-slow-server/src/main/kotlin/slowserver/Application.kt b/ktor-retry-plugin/simulate-slow-server/src/main/kotlin/slowserver/Application.kt new file mode 100644 index 0000000..2acabc6 --- /dev/null +++ b/ktor-retry-plugin/simulate-slow-server/src/main/kotlin/slowserver/Application.kt @@ -0,0 +1,30 @@ +package slowserver + +import io.ktor.http.* +import io.ktor.server.application.* +import io.ktor.server.response.* +import io.ktor.server.routing.* +import kotlinx.coroutines.* +import java.time.* + +fun Application.main() { + intercept(ApplicationCallPipeline.Plugins) { + delay(2000L) + } + routing { + get("/path1") { + call.respondText("Response time: ${LocalTime.now()}") + } + get("/path2") { + call.respondText("Response time: ${LocalTime.now()}") + } + var requestCount = 0 + get("/error") { + requestCount += 1 + when (requestCount) { + in 1..2 -> call.respondText("Server is down", status = HttpStatusCode.InternalServerError) + in 3..10 -> call.respondText("Server is back online!", status = HttpStatusCode.OK) + } + } + } +} diff --git a/ktor-retry-plugin/simulate-slow-server/src/main/resources/application.conf b/ktor-retry-plugin/simulate-slow-server/src/main/resources/application.conf new file mode 100644 index 0000000..7cd7988 --- /dev/null +++ b/ktor-retry-plugin/simulate-slow-server/src/main/resources/application.conf @@ -0,0 +1,9 @@ +ktor { + deployment { + port = 8080 + } + + application { + modules = [ slowserver.ApplicationKt.main ] + } +} diff --git a/ktor-retry-plugin/simulate-slow-server/src/main/resources/logback.xml b/ktor-retry-plugin/simulate-slow-server/src/main/resources/logback.xml new file mode 100644 index 0000000..bdbb64e --- /dev/null +++ b/ktor-retry-plugin/simulate-slow-server/src/main/resources/logback.xml @@ -0,0 +1,12 @@ + + + + %d{YYYY-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n + + + + + + + + diff --git a/ktor-retry-plugin/simulate-slow-server/src/test/kotlin/slowserver/ApplicationTest.kt b/ktor-retry-plugin/simulate-slow-server/src/test/kotlin/slowserver/ApplicationTest.kt new file mode 100644 index 0000000..8552d77 --- /dev/null +++ b/ktor-retry-plugin/simulate-slow-server/src/test/kotlin/slowserver/ApplicationTest.kt @@ -0,0 +1,19 @@ +package slowserver + +import io.ktor.client.request.* +import io.ktor.server.testing.* +import java.time.Duration +import java.time.LocalTime +import kotlin.test.* + +class ApplicationTest { + @Test + fun testPath1() = testApplication { + val requestTime = LocalTime.now() + client.get("/path1") + val responseTime = LocalTime.now() + assertTrue { + Duration.between(requestTime, responseTime).toSeconds() >= 2 + } + } +} diff --git a/ktor/gradle/wrapper/gradle-wrapper.jar b/ktor/gradle/wrapper/gradle-wrapper.jar index 7f93135..e69de29 100644 Binary files a/ktor/gradle/wrapper/gradle-wrapper.jar and b/ktor/gradle/wrapper/gradle-wrapper.jar differ diff --git a/ktor/lib/build.gradle.kts b/ktor/lib/build.gradle.kts index c0bb4d1..7279aac 100644 --- a/ktor/lib/build.gradle.kts +++ b/ktor/lib/build.gradle.kts @@ -63,7 +63,7 @@ kotlin { val backendJvmTest by getting { dependsOn(commonTest) dependencies { - implementation(libs.ktor.server.test.host) + implementation(libs.ktor.server.testhost) implementation(libs.ktor.client.websockets) } } diff --git a/resilience4j/build.gradle.kts b/resilience4j/build.gradle.kts index d5fce72..e13b30e 100644 --- a/resilience4j/build.gradle.kts +++ b/resilience4j/build.gradle.kts @@ -5,7 +5,6 @@ plugins { repositories { // Use Maven Central for resolving dependencies. mavenCentral() - } dependencies { @@ -19,4 +18,4 @@ dependencies { tasks.named("test") { useJUnitPlatform() -} \ No newline at end of file +}