implement new test: ktor-pgclient (#7006)

frameworks/Kotlin/ktor/benchmark_config.json

@@ -116,6 +116,29 @@
         "display_name": "Ktor-reactivepg",
         "notes": "",
         "versus": "netty"
+      },
+      "pgclient": {
+        "plaintext_url": "/plaintext",
+        "json_url": "/json",
+        "db_url": "/db",
+        "query_url": "/query?queries=",
+        "update_url": "/updates?queries=",
+        "fortune_url": "/fortunes",
+
+        "port": 8080,
+        "approach": "Realistic",
+        "classification": "Micro",
+        "database": "Postgres",
+        "framework": "ktor",
+        "language": "Kotlin",
+        "orm": "Raw",
+        "platform": "Netty",
+        "webserver": "None",
+        "os": "Linux",
+        "database_os": "Linux",
+        "display_name": "ktor-pgclient",
+        "notes": "http://ktor.io/",
+        "versus": "netty"
       }
     }
   ]

frameworks/Kotlin/ktor/ktor-pgclient.dockerfile

@@ -0,0 +1,15 @@
+FROM openjdk:11.0.3-jdk-stretch as build
+WORKDIR /app
+COPY ktor-pgclient/gradle gradle
+COPY ktor-pgclient/build.gradle.kts build.gradle.kts
+COPY ktor-pgclient/gradlew gradlew
+COPY ktor-pgclient/src src
+RUN /app/gradlew --no-daemon shadowJar
+
+FROM openjdk:11.0.3-jdk-slim
+WORKDIR /app
+COPY --from=build /app/build/libs/ktor-pgclient.jar ktor-pgclient.jar
+
+EXPOSE 8080
+
+CMD ["java", "-server", "-Xms1G", "-Xmx1G", "-XX:-UseBiasedLocking", "-XX:+UseNUMA", "-XX:+UseParallelGC", "-XX:+AlwaysPreTouch", "-jar", "ktor-pgclient.jar"]

frameworks/Kotlin/ktor/ktor-pgclient/README.md

@@ -0,0 +1,38 @@
+# Ktor with Vert.x async pgclient
+
+This sets up testing using [Ktor](https://ktor.io/), with the async PostgreSQL client of the Eclipse Vert.x project.  
+The client features batching, pipelining and supports coroutines.
+
+## Test URLs
+
+### Plain Text Test
+
+    http://localhost:8080/plaintext
+
+### JSON Encoding Test
+
+    http://localhost:8080/json
+
+### Single Query Test
+
+    http://localhost:8080/db
+
+### Multiple Queries Test
+
+    http://localhost:8080/query?queries=
+
+### Database updates Test
+
+    http://localhost:8080/updates?queries=
+
+### Fortunes Test
+
+    http://localhost:8080/fortunes
+
+## build
+
+    ./gradlew build
+
+## run
+
+    java -jar build/libs/bench.jar

frameworks/Kotlin/ktor/ktor-pgclient/build.gradle.kts

@@ -0,0 +1,37 @@
+plugins {
+    application
+    kotlin("jvm") version "1.6.10"
+    id("org.jetbrains.kotlin.plugin.serialization") version "1.6.10"
+    id("com.github.johnrengelman.shadow") version "7.1.2"
+}
+
+group = "org.jetbrains.ktor"
+version = "1.0-SNAPSHOT"
+
+repositories {
+    mavenCentral()
+}
+
+application {
+    mainClass.set("MainKt")
+}
+
+dependencies {
+    implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8")
+    implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.3.2")
+    implementation("io.ktor:ktor-server-netty:1.6.7")
+    implementation("io.ktor:ktor-html-builder:1.6.7")
+    implementation("io.vertx:vertx-pg-client:4.2.3")
+    implementation("io.vertx:vertx-lang-kotlin:4.2.3")
+    implementation("io.vertx:vertx-lang-kotlin-coroutines:4.2.3")
+}
+
+tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile>().configureEach {
+    kotlinOptions.jvmTarget = "11"
+}
+
+tasks.shadowJar {
+    archiveBaseName.set("ktor-pgclient")
+    archiveClassifier.set("")
+    archiveVersion.set("")
+}

frameworks/Kotlin/ktor/ktor-pgclient/gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,5 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.3.3-bin.zip
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists

frameworks/Kotlin/ktor/ktor-pgclient/gradlew

@@ -0,0 +1,234 @@
+#!/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/master/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
+
+APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
+
+APP_NAME="Gradle"
+APP_BASE_NAME=${0##*/}
+
+# 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"'
+
+# 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
+    which java >/dev/null 2>&1 || 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
+
+# Increase the maximum file descriptors if we can.
+if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
+    case $MAX_FD in #(
+      max*)
+        MAX_FD=$( ulimit -H -n ) ||
+            warn "Could not query maximum file descriptor limit"
+    esac
+    case $MAX_FD in  #(
+      '' | soft) :;; #(
+      *)
+        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
+
+# 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 \
+        "$@"
+
+# 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" "$@"

frameworks/Kotlin/ktor/ktor-pgclient/gradlew.bat

@@ -0,0 +1,89 @@
+@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=.
+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%" == "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%"=="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!
+if  not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
+exit /b 1
+
+:mainEnd
+if "%OS%"=="Windows_NT" endlocal
+
+:omega

frameworks/Kotlin/ktor/ktor-pgclient/src/main/kotlin/main.kt

@@ -0,0 +1,184 @@
+import io.ktor.application.*
+import io.ktor.features.*
+import io.ktor.html.*
+import io.ktor.http.*
+import io.ktor.response.*
+import io.ktor.routing.*
+import io.ktor.server.engine.*
+import io.ktor.server.netty.*
+import io.vertx.kotlin.coroutines.await
+import io.vertx.pgclient.PgConnectOptions
+import io.vertx.pgclient.PgPool
+import io.vertx.sqlclient.PoolOptions
+import io.vertx.sqlclient.Tuple
+import kotlinx.html.HTML
+import kotlinx.html.HtmlBlockTag
+import kotlinx.html.body
+import kotlinx.html.head
+import kotlinx.html.table
+import kotlinx.html.td
+import kotlinx.html.th
+import kotlinx.html.title
+import kotlinx.html.tr
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.builtins.ListSerializer
+import kotlinx.serialization.json.Json
+import java.util.concurrent.ThreadLocalRandom
+
+@Serializable
+data class Message(val message: String)
+
+@Serializable
+data class World(val id: Int, val randomNumber: Int)
+
+data class Fortune(val id: Int, val message: String)
+
+val rand: ThreadLocalRandom
+    get() = ThreadLocalRandom.current()
+
+interface Repository {
+    suspend fun getWorld(): World
+    suspend fun getFortunes(): List<Fortune>
+    suspend fun updateWorlds(worlds: List<World>)
+}
+
+class PgclientRepository : Repository {
+    private val connectOptions =
+        PgConnectOptions()
+            .setPort(5432)
+            .setHost("tfb-database")
+            .setDatabase("hello_world")
+            .setUser("benchmarkdbuser")
+            .setPassword("benchmarkdbpass")
+            .apply {
+                cachePreparedStatements = true
+            }
+
+    private val poolOptions = PoolOptions()
+    private val client = ThreadLocal.withInitial { PgPool.client(connectOptions, poolOptions) }
+    private fun client() = client.get()
+
+
+    override suspend fun getFortunes(): List<Fortune> {
+        val results = client().preparedQuery("select id, message from fortune").execute().await()
+        return results.map { Fortune(it.getInteger(0), it.getString(1)) }
+    }
+
+    override suspend fun getWorld(): World {
+        val worldId = rand.nextInt(1, 10001)
+        val result =
+            client()
+                .preparedQuery("select id, randomNumber from world where id = $1")
+                .execute(Tuple.of(worldId))
+                .await()
+        val row = result.first()
+        return World(row.getInteger(0), row.getInteger(1)!!)
+    }
+
+    override suspend fun updateWorlds(worlds: List<World>) {
+        val batch = worlds.map { Tuple.of(it.id, it.randomNumber) }
+        client()
+            .preparedQuery("update world set randomNumber = $1 where id = $2")
+            .executeBatch(batch)
+            .await()
+    }
+}
+
+fun String.toBoxedInt(range: IntRange): Int =
+    try {
+        this.toInt().coerceIn(range)
+    } catch (e: NumberFormatException) {
+        1
+    }
+
+class MainTemplate : Template<HTML> {
+    val content = Placeholder<HtmlBlockTag>()
+    override fun HTML.apply() {
+        head {
+            title { +"Fortunes" }
+        }
+        body {
+            insert(content)
+        }
+    }
+}
+
+class FortuneTemplate(
+    private val fortunes: List<Fortune>,
+    private val main: MainTemplate = MainTemplate()
+): Template<HTML> {
+    override fun HTML.apply() {
+        insert(main) {
+            content {
+                table {
+                    tr {
+                        th { +"id" }
+                        th { +"message" }
+                    }
+                    fortunes.forEach { fortune ->
+                        tr {
+                            td { +fortune.id.toString() }
+                            td { +fortune.message }
+                        }
+                    }
+                }
+            }
+        }
+    }
+}
+
+fun main() {
+    val db = PgclientRepository()
+
+    val messageSerializer = Message.serializer()
+    val worldSerializer = World.serializer()
+    val worldListSerializer = ListSerializer(World.serializer())
+
+    val server = embeddedServer(Netty, 8080, configure = {
+        shareWorkGroup = true
+    }) {
+        install(DefaultHeaders)
+        routing {
+            get("/plaintext") {
+                call.respondText("Hello, World!")
+            }
+
+            get("/json") {
+                call.respondText(
+                    Json.encodeToString(messageSerializer, Message("Hello, World!")),
+                    ContentType.Application.Json
+                )
+            }
+
+            get("/db") {
+                call.respondText(Json.encodeToString(worldSerializer, db.getWorld()), ContentType.Application.Json)
+            }
+
+            get("/query") {
+                val queries = call.parameters["queries"]?.toBoxedInt(1..500) ?: 1
+                val worlds = (1..queries).map { db.getWorld() }
+                call.respondText(Json.encodeToString(worldListSerializer, worlds), ContentType.Application.Json)
+            }
+
+            get("/fortunes") {
+                val newFortune = Fortune(0, "Additional fortune added at request time.")
+                val fortunes = db.getFortunes().toMutableList()
+                fortunes.add(newFortune)
+                fortunes.sortBy { it.message }
+                call.respondHtmlTemplate(FortuneTemplate(fortunes)) { }
+            }
+
+            get("/updates") {
+                val queries = call.parameters["queries"]?.toBoxedInt(1..500) ?: 1
+                val worlds = (1..queries).map { db.getWorld() }
+                val newWorlds = worlds.map { it.copy(randomNumber = rand.nextInt(1, 10001)) }
+
+                db.updateWorlds(newWorlds)
+
+                call.respondText(Json.encodeToString(worldListSerializer, newWorlds), ContentType.Application.Json)
+            }
+        }
+    }
+
+    server.start(wait = true)
+}