Merge pull request #9662 from sake92/add-sharaf-framework

Add sharaf framework

frameworks/Scala/sharaf/.mill-version

@@ -0,0 +1 @@
+0.12.8

frameworks/Scala/sharaf/README.md

@@ -0,0 +1,45 @@
+
+# Sharaf Benchmarking Test
+
+[Sharaf](https://sake92.github.io/sharaf/) is a minimalistic Scala 3 web framework.
+
+### Test Type Implementation Source Code
+
+* [JSON](src/routes.scala)
+* [PLAINTEXT](src/routes.scala)
+* [DB](src/routes.scala)
+* [QUERY](src/routes.scala)
+* [UPDATE](src/routes.scala)
+* [FORTUNES](src/routes.scala)
+
+## Important Libraries
+The tests were run with:
+* [squery](https://sake92.github.io/squery/) for SQL
+* [tupson](https://sake92.github.io/tupson/) for JSON
+* [scalatags](https://com-lihaoyi.github.io/scalatags/) for HTML
+
+## Test URLs
+### JSON
+
+http://localhost:8080/json
+
+### PLAINTEXT
+
+http://localhost:8080/plaintext
+
+### DB
+
+http://localhost:8080/db
+
+### QUERY
+
+http://localhost:8080/query?queries=
+
+
+### UPDATE
+
+http://localhost:8080/update?queries=
+
+### FORTUNES
+
+http://localhost:8080/fortunes

frameworks/Scala/sharaf/benchmark_config.json

@@ -0,0 +1,30 @@
+{
+  "framework": "sharaf",
+  "tests": [
+    {
+      "default": {
+        "plaintext_url": "/plaintext",
+        "json_url": "/json",
+        "db_url": "/db",
+        "query_url": "/queries?queries=",
+        "fortune_url": "/fortunes",
+        "update_url": "/updates?queries=",
+        "port": 8080,
+        "approach": "Realistic",
+        "classification": "Fullstack",
+        "database": "postgres",
+        "framework": "Sharaf",
+        "language": "Scala",
+        "flavor": "None",
+        "orm": "Micro",
+        "platform": "Undertow",
+        "webserver": "None",
+        "os": "Linux",
+        "database_os": "Linux",
+        "display_name": "Sharaf",
+        "notes": "",
+        "versus": "Undertow"
+      }
+    }
+  ]
+}

frameworks/Scala/sharaf/build.mill

@@ -0,0 +1,14 @@
+package build
+
+import mill._
+import mill.scalalib._
+
+object `package` extends RootModule with ScalaModule {
+  def scalaVersion = "3.6.2"
+  def ivyDeps = Agg(
+    ivy"ba.sake::sharaf:0.8.1",
+    ivy"ba.sake::squery:0.6.4",
+    ivy"org.postgresql:postgresql:42.6.0",
+    ivy"com.zaxxer:HikariCP:5.0.1"
+  )
+}

frameworks/Scala/sharaf/mill

@@ -0,0 +1,265 @@
+#!/usr/bin/env sh
+
+# This is a wrapper script, that automatically download mill from GitHub release pages
+# You can give the required mill version with --mill-version parameter
+# If no version is given, it falls back to the value of DEFAULT_MILL_VERSION
+#
+# Original Project page: https://github.com/lefou/millw
+# Script Version: 0.4.12
+#
+# If you want to improve this script, please also contribute your changes back!
+#
+# Licensed under the Apache License, Version 2.0
+
+set -e
+
+if [ -z "${DEFAULT_MILL_VERSION}" ] ; then
+  DEFAULT_MILL_VERSION="0.11.4"
+fi
+
+
+if [ -z "${GITHUB_RELEASE_CDN}" ] ; then
+  GITHUB_RELEASE_CDN=""
+fi
+
+
+MILL_REPO_URL="https://github.com/com-lihaoyi/mill"
+
+if [ -z "${CURL_CMD}" ] ; then
+  CURL_CMD=curl
+fi
+
+# Explicit commandline argument takes precedence over all other methods
+if [ "$1" = "--mill-version" ] ; then
+  shift
+  if [ "x$1" != "x" ] ; then
+    MILL_VERSION="$1"
+    shift
+  else
+    echo "You specified --mill-version without a version." 1>&2
+    echo "Please provide a version that matches one provided on" 1>&2
+    echo "${MILL_REPO_URL}/releases" 1>&2
+    false
+  fi
+fi
+
+# Please note, that if a MILL_VERSION is already set in the environment,
+# We reuse it's value and skip searching for a value.
+
+# If not already set, read .mill-version file
+if [ -z "${MILL_VERSION}" ] ; then
+  if [ -f ".mill-version" ] ; then
+    MILL_VERSION="$(tr '\r' '\n' < .mill-version | head -n 1 2> /dev/null)"
+  elif [ -f ".config/mill-version" ] ; then
+    MILL_VERSION="$(tr '\r' '\n' < .config/mill-version | head -n 1 2> /dev/null)"
+  fi
+fi
+
+MILL_USER_CACHE_DIR="${XDG_CACHE_HOME:-${HOME}/.cache}/mill"
+
+if [ -z "${MILL_DOWNLOAD_PATH}" ] ; then
+  MILL_DOWNLOAD_PATH="${MILL_USER_CACHE_DIR}/download"
+fi
+
+# If not already set, try to fetch newest from Github
+if [ -z "${MILL_VERSION}" ] ; then
+  # TODO: try to load latest version from release page
+  echo "No mill version specified." 1>&2
+  echo "You should provide a version via '.mill-version' file or --mill-version option." 1>&2
+
+  mkdir -p "${MILL_DOWNLOAD_PATH}"
+  LANG=C touch -d '1 hour ago' "${MILL_DOWNLOAD_PATH}/.expire_latest" 2>/dev/null || (
+    # we might be on OSX or BSD which don't have -d option for touch
+    # but probably a -A [-][[hh]mm]SS
+    touch "${MILL_DOWNLOAD_PATH}/.expire_latest"; touch -A -010000 "${MILL_DOWNLOAD_PATH}/.expire_latest"
+  ) || (
+    # in case we still failed, we retry the first touch command with the intention
+    # to show the (previously suppressed) error message
+    LANG=C touch -d '1 hour ago' "${MILL_DOWNLOAD_PATH}/.expire_latest"
+  )
+
+  # POSIX shell variant of bash's -nt operator, see https://unix.stackexchange.com/a/449744/6993
+  # if [ "${MILL_DOWNLOAD_PATH}/.latest" -nt "${MILL_DOWNLOAD_PATH}/.expire_latest" ] ; then
+  if [ -n "$(find -L "${MILL_DOWNLOAD_PATH}/.latest" -prune -newer "${MILL_DOWNLOAD_PATH}/.expire_latest")" ]; then
+    # we know a current latest version
+    MILL_VERSION=$(head -n 1 "${MILL_DOWNLOAD_PATH}"/.latest 2> /dev/null)
+  fi
+
+  if [ -z "${MILL_VERSION}" ] ; then
+    # we don't know a current latest version
+    echo "Retrieving latest mill version ..." 1>&2
+    LANG=C ${CURL_CMD} -s -i -f -I ${MILL_REPO_URL}/releases/latest 2> /dev/null  | grep --ignore-case Location: | sed s'/^.*tag\///' | tr -d '\r\n' > "${MILL_DOWNLOAD_PATH}/.latest"
+    MILL_VERSION=$(head -n 1 "${MILL_DOWNLOAD_PATH}"/.latest 2> /dev/null)
+  fi
+
+  if [ -z "${MILL_VERSION}" ] ; then
+    # Last resort
+    MILL_VERSION="${DEFAULT_MILL_VERSION}"
+    echo "Falling back to hardcoded mill version ${MILL_VERSION}" 1>&2
+  else
+    echo "Using mill version ${MILL_VERSION}" 1>&2
+  fi
+fi
+
+MILL_NATIVE_SUFFIX="-native"
+FULL_MILL_VERSION=$MILL_VERSION
+ARTIFACT_SUFFIX=""
+case "$MILL_VERSION" in
+    *"$MILL_NATIVE_SUFFIX")
+  MILL_VERSION=${MILL_VERSION%"$MILL_NATIVE_SUFFIX"}
+  if [ "$(expr substr $(uname -s) 1 5 2>/dev/null)" = "Linux" ]; then
+    if [ "$(uname -m)" = "aarch64" ]; then
+      ARTIFACT_SUFFIX="-native-linux-aarch64"
+    else
+      ARTIFACT_SUFFIX="-native-linux-amd64"
+    fi
+  elif [ "$(uname)" = "Darwin" ]; then
+    if [ "$(uname -m)" = "arm64" ]; then
+      ARTIFACT_SUFFIX="-native-mac-aarch64"
+    else
+      ARTIFACT_SUFFIX="-native-mac-amd64"
+    fi
+  else
+     echo "This native mill launcher supports only Linux and macOS." 1>&2
+     exit 1
+  fi
+esac
+
+MILL="${MILL_DOWNLOAD_PATH}/${FULL_MILL_VERSION}"
+
+try_to_use_system_mill() {
+  if [ "$(uname)" != "Linux" ]; then
+    return 0
+  fi
+
+  MILL_IN_PATH="$(command -v mill || true)"
+
+  if [ -z "${MILL_IN_PATH}" ]; then
+    return 0
+  fi
+
+  SYSTEM_MILL_FIRST_TWO_BYTES=$(head --bytes=2 "${MILL_IN_PATH}")
+  if [ "${SYSTEM_MILL_FIRST_TWO_BYTES}" = "#!" ]; then
+	  # MILL_IN_PATH is (very likely) a shell script and not the mill
+	  # executable, ignore it.
+	  return 0
+  fi
+
+  SYSTEM_MILL_PATH=$(readlink -e "${MILL_IN_PATH}")
+  SYSTEM_MILL_SIZE=$(stat --format=%s "${SYSTEM_MILL_PATH}")
+  SYSTEM_MILL_MTIME=$(stat --format=%y "${SYSTEM_MILL_PATH}")
+
+  if [ ! -d "${MILL_USER_CACHE_DIR}" ]; then
+    mkdir -p "${MILL_USER_CACHE_DIR}"
+  fi
+
+  SYSTEM_MILL_INFO_FILE="${MILL_USER_CACHE_DIR}/system-mill-info"
+  if [ -f "${SYSTEM_MILL_INFO_FILE}" ]; then
+    parseSystemMillInfo() {
+        LINE_NUMBER="${1}"
+        # Select the line number of the SYSTEM_MILL_INFO_FILE, cut the
+        # variable definition in that line in two halves and return
+        # the value, and finally remove the quotes.
+        sed -n "${LINE_NUMBER}p" "${SYSTEM_MILL_INFO_FILE}" |\
+            cut -d= -f2 |\
+            sed 's/"\(.*\)"/\1/'
+    }
+
+    CACHED_SYSTEM_MILL_PATH=$(parseSystemMillInfo 1)
+    CACHED_SYSTEM_MILL_VERSION=$(parseSystemMillInfo 2)
+    CACHED_SYSTEM_MILL_SIZE=$(parseSystemMillInfo 3)
+    CACHED_SYSTEM_MILL_MTIME=$(parseSystemMillInfo 4)
+
+    if [ "${SYSTEM_MILL_PATH}" = "${CACHED_SYSTEM_MILL_PATH}" ] \
+           && [ "${SYSTEM_MILL_SIZE}" = "${CACHED_SYSTEM_MILL_SIZE}" ] \
+           && [ "${SYSTEM_MILL_MTIME}" = "${CACHED_SYSTEM_MILL_MTIME}" ]; then
+      if [ "${CACHED_SYSTEM_MILL_VERSION}" = "${MILL_VERSION}" ]; then
+          MILL="${SYSTEM_MILL_PATH}"
+          return 0
+      else
+          return 0
+      fi
+    fi
+  fi
+
+  SYSTEM_MILL_VERSION=$(${SYSTEM_MILL_PATH} --version | head -n1 | sed -n 's/^Mill.*version \(.*\)/\1/p')
+
+  cat <<EOF > "${SYSTEM_MILL_INFO_FILE}"
+CACHED_SYSTEM_MILL_PATH="${SYSTEM_MILL_PATH}"
+CACHED_SYSTEM_MILL_VERSION="${SYSTEM_MILL_VERSION}"
+CACHED_SYSTEM_MILL_SIZE="${SYSTEM_MILL_SIZE}"
+CACHED_SYSTEM_MILL_MTIME="${SYSTEM_MILL_MTIME}"
+EOF
+
+  if [ "${SYSTEM_MILL_VERSION}" = "${MILL_VERSION}" ]; then
+    MILL="${SYSTEM_MILL_PATH}"
+  fi
+}
+try_to_use_system_mill
+
+# If not already downloaded, download it
+if [ ! -s "${MILL}" ] ; then
+
+  # support old non-XDG download dir
+  MILL_OLD_DOWNLOAD_PATH="${HOME}/.mill/download"
+  OLD_MILL="${MILL_OLD_DOWNLOAD_PATH}/${MILL_VERSION}"
+  if [ -x "${OLD_MILL}" ] ; then
+    MILL="${OLD_MILL}"
+  else
+    case $MILL_VERSION in
+      0.0.* | 0.1.* | 0.2.* | 0.3.* | 0.4.* )
+        DOWNLOAD_SUFFIX=""
+        DOWNLOAD_FROM_MAVEN=0
+        ;;
+      0.5.* | 0.6.* | 0.7.* | 0.8.* | 0.9.* | 0.10.* | 0.11.0-M* )
+        DOWNLOAD_SUFFIX="-assembly"
+        DOWNLOAD_FROM_MAVEN=0
+        ;;
+      *)
+        DOWNLOAD_SUFFIX="-assembly"
+        DOWNLOAD_FROM_MAVEN=1
+        ;;
+    esac
+
+    DOWNLOAD_FILE=$(mktemp mill.XXXXXX)
+
+    if [ "$DOWNLOAD_FROM_MAVEN" = "1" ] ; then
+      DOWNLOAD_URL="https://repo1.maven.org/maven2/com/lihaoyi/mill-dist${ARTIFACT_SUFFIX}/${MILL_VERSION}/mill-dist${ARTIFACT_SUFFIX}-${MILL_VERSION}.jar"
+    else
+      MILL_VERSION_TAG=$(echo "$MILL_VERSION" | sed -E 's/([^-]+)(-M[0-9]+)?(-.*)?/\1\2/')
+      DOWNLOAD_URL="${GITHUB_RELEASE_CDN}${MILL_REPO_URL}/releases/download/${MILL_VERSION_TAG}/${MILL_VERSION}${DOWNLOAD_SUFFIX}"
+      unset MILL_VERSION_TAG
+    fi
+
+    # TODO: handle command not found
+    echo "Downloading mill ${MILL_VERSION} from ${DOWNLOAD_URL} ..." 1>&2
+    ${CURL_CMD} -f -L -o "${DOWNLOAD_FILE}" "${DOWNLOAD_URL}"
+    chmod +x "${DOWNLOAD_FILE}"
+    mkdir -p "${MILL_DOWNLOAD_PATH}"
+    mv "${DOWNLOAD_FILE}" "${MILL}"
+
+    unset DOWNLOAD_FILE
+    unset DOWNLOAD_SUFFIX
+  fi
+fi
+
+if [ -z "$MILL_MAIN_CLI" ] ; then
+  MILL_MAIN_CLI="${0}"
+fi
+
+MILL_FIRST_ARG=""
+if [ "$1" = "--bsp" ] || [ "$1" = "-i" ] || [ "$1" = "--interactive" ] || [ "$1" = "--no-server" ] || [ "$1" = "--repl" ] || [ "$1" = "--help" ] ; then
+  # Need to preserve the first position of those listed options
+  MILL_FIRST_ARG=$1
+  shift
+fi
+
+unset MILL_DOWNLOAD_PATH
+unset MILL_OLD_DOWNLOAD_PATH
+unset OLD_MILL
+unset MILL_VERSION
+unset MILL_REPO_URL
+
+# We don't quote MILL_FIRST_ARG on purpose, so we can expand the empty value without quotes
+# shellcheck disable=SC2086
+exec "${MILL}" $MILL_FIRST_ARG -D "mill.main.cli=${MILL_MAIN_CLI}" "$@"

frameworks/Scala/sharaf/sharaf.dockerfile

@@ -0,0 +1,14 @@
+FROM eclipse-temurin:21-jdk-ubi9-minimal
+WORKDIR /sharaf
+
+COPY src src
+COPY build.mill build.mill
+COPY mill mill
+RUN chmod 777 mill
+COPY .mill-version .mill-version
+
+RUN ./mill assembly
+
+EXPOSE 8080
+
+CMD ["java", "-server", "-Xms1g", "-Xmx1g", "-jar", "out/assembly.dest/out.jar"]

frameworks/Scala/sharaf/src/db.scala

@@ -0,0 +1,52 @@
+package ba.sake.sharaf.benchmark
+
+import java.util.concurrent.ThreadLocalRandom
+import scala.collection.mutable
+import ba.sake.squery.{*, given}
+import scala.collection.decorators.*
+
+class DAO {
+  private val ds = com.zaxxer.hikari.HikariDataSource()
+  ds.setJdbcUrl("jdbc:postgresql://tfb-database:5432/hello_world")
+  ds.setUsername("benchmarkdbuser")
+  ds.setPassword("benchmarkdbpass")
+  ds.setMaximumPoolSize(48)
+  private val squeryContext = SqueryContext(ds)
+
+  def getRandomWorld(): WorldRow = squeryContext.run {
+    sql"SELECT id, randomnumber FROM world WHERE id = ${getRandomRowId()}"
+      .readRow()
+  }
+
+  def getRandomWorlds(queriesCount: Int): Seq[WorldRow] = squeryContext.run {
+    val buffer = new mutable.ArrayBuffer[WorldRow](queriesCount)
+    for i <- 0 until queriesCount do
+      buffer += sql"SELECT id, randomnumber FROM world WHERE id = ${getRandomRowId()}"
+        .readRow()
+    buffer.toSeq
+  }
+
+  def updateWorlds(rows: Seq[WorldRow]): Unit = squeryContext.run {
+    val values = rows
+      .map(row => sql"(${row.id}, ${row.randomnumber})")
+      .intersperse(sql",")
+      .reduce(_ ++ _)
+    sql"""
+    UPDATE world as w
+    SET randomnumber = c.randomnumber
+    FROM (VALUES ${values}) AS c(id, randomnumber)
+    WHERE w.id = c.id
+    """.update()
+  }
+
+  def getFortunes(): Seq[FortuneRow] = squeryContext.run {
+    sql"SELECT id, message FROM fortune".readRows()
+  }
+
+  def getRandomRowId(): Int =
+    return 1 + ThreadLocalRandom.current().nextInt(10000)
+
+}
+
+case class WorldRow(id: Int, randomnumber: Int) derives SqlReadRow
+case class FortuneRow(id: Int, message: String) derives SqlReadRow

frameworks/Scala/sharaf/src/main.scala

@@ -0,0 +1,22 @@
+package ba.sake.sharaf.benchmark
+
+import io.undertow.Undertow
+import io.undertow.UndertowOptions
+import ba.sake.sharaf.*
+
+@main def run(): Unit = {
+  val dao = DAO()
+  val benchmarkRoutes = BenchmarkRoutes(dao)
+  val server = Undertow
+    .builder()
+    .addHttpListener(8080, "0.0.0.0")
+    .setHandler(SharafHandler(benchmarkRoutes.routes))
+    .setIoThreads(Runtime.getRuntime().availableProcessors() * 2)
+    // In HTTP/1.1, connections are persistent unless declared otherwise.
+    // Adding a "Connection: keep-alive" header to every response would only
+    // add useless bytes.
+    .setServerOption(UndertowOptions.ALWAYS_SET_KEEP_ALIVE, false)
+    .build()
+  server.start()
+  println(s"Started HTTP server at localhost:8080")
+}

frameworks/Scala/sharaf/src/pages.scala

@@ -0,0 +1,21 @@
+package ba.sake.sharaf.benchmark
+
+import scalatags.Text.all.*
+import ba.sake.hepek.html.HtmlPage
+
+class FortunesPage(rows: Seq[FortuneRow]) extends HtmlPage {
+  override def pageSettings = super.pageSettings.withTitle("Fortunes")
+
+  override def bodyContent = table(
+    tr(
+      th("id"),
+      th("message")
+    ),
+    rows.map { row =>
+      tr(
+        td(row.id),
+        td(row.message)
+      )
+    }
+  )
+}

frameworks/Scala/sharaf/src/routes.scala

@@ -0,0 +1,59 @@
+package ba.sake.sharaf.benchmark
+
+import ba.sake.sharaf.*, routing.*
+import ba.sake.querson.*
+import ba.sake.tupson.*
+
+class BenchmarkRoutes(dao: DAO) {
+
+  def routes: Routes = Routes {
+    case GET() -> Path("plaintext") =>
+      Response.withBody("Hello, World!").settingHeader("Server", "sharaf")
+
+    case GET() -> Path("json") =>
+      Response
+        .withBody(MessageResponse("Hello, World!"))
+        .settingHeader("Server", "sharaf")
+
+    case GET() -> Path("db") =>
+      val row = dao.getRandomWorld()
+      val body = WorldResponse(row.id, row.randomnumber)
+      Response.withBody(body).settingHeader("Server", "sharaf")
+
+    case GET() -> Path("queries") =>
+      val queriesCountStr = Request.current.queryParams[QueriesQP].queries
+      var queriesCount = queriesCountStr.toIntOption.getOrElse(1)
+      if queriesCount < 1 then queriesCount = 1
+      if queriesCount > 500 then queriesCount = 500
+      val rows = dao.getRandomWorlds(queriesCount)
+      val body = rows.map(row => WorldResponse(row.id, row.randomnumber))
+      Response.withBody(body).settingHeader("Server", "sharaf")
+
+    case GET() -> Path("fortunes") =>
+      val rows = dao
+        .getFortunes()
+        .appended(FortuneRow(0, "Additional fortune added at request time."))
+      val rowsSorted = rows.sortBy(_.message)
+      val body = FortunesPage(rowsSorted)
+      Response.withBody(body).settingHeader("Server", "sharaf")
+
+    case GET() -> Path("updates") =>
+      val queriesCountStr = Request.current.queryParams[QueriesQP].queries
+      var queriesCount = queriesCountStr.toIntOption.getOrElse(1)
+      if queriesCount < 1 then queriesCount = 1
+      if queriesCount > 500 then queriesCount = 500
+      val rows = dao.getRandomWorlds(queriesCount)
+      val updatedRows = rows.map(_.copy(randomnumber = dao.getRandomRowId()))
+      dao.updateWorlds(updatedRows)
+      val body = updatedRows.map(row => WorldResponse(row.id, row.randomnumber))
+      Response.withBody(body).settingHeader("Server", "sharaf")
+
+  }
+}
+
+// query params
+case class QueriesQP(queries: String = "1") derives QueryStringRW
+
+// json responses
+case class MessageResponse(message: String) derives JsonRW
+case class WorldResponse(id: Int, randomNumber: Int) derives JsonRW