refactor(dsp-api): Replace Pekko HTTP server with zio-http (DEV-4870)

.github/workflows/build-and-test.yml

@@ -2,7 +2,7 @@ name: CI-build-and-test
 
 on:
   pull_request:
-    types: [ opened, reopened, synchronize ]
+    types: [opened, reopened, synchronize]
     branches-ignore:
       - "**/graphite-base/**"
 
@@ -73,7 +73,7 @@ jobs:
 
   test-e2e:
     name: Build and E2E test
-    runs-on: buildjet-4vcpu-ubuntu-2204
+    runs-on: buildjet-32vcpu-ubuntu-2204
     concurrency:
       group: ${{ github.ref }}-e2e
       cancel-in-progress: true
@@ -83,23 +83,14 @@ jobs:
         with:
           java-version: ${{ env.JAVA_VERSION }}
       - name: Run end-to-end tests
-        run: make test-e2e
+        run: ./sbtx "test-e2e/test"
       - name: WebApi E2E Test Report
         uses: dorny/test-reporter@v1
         if: success() || failure()
         with:
           name: WebApi E2E Test Results
           path: ./modules/test-e2e/target/test-reports/TEST-*.xml
           reporter: java-junit
-      - name: Upload coverage data to codacy
-        uses: codacy/codacy-coverage-reporter-action@v1
-        with:
-          project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
-          coverage-reports: ./target/scala-3.3.6/coverage-report/cobertura.xml
-      - name: Upload coverage data to codecov
-        uses: codecov/codecov-action@v3
-        with:
-          files: ./target/scala-3.3.6/coverage-report/cobertura.xml
 
   test-ingest-integration:
     runs-on: ubuntu-latest

.gitignore

@@ -63,6 +63,8 @@ ingest/docs/openapi/*.yml
 # Claude Code
 .claude/settings.local.json
 /.claude/tmp
+.claude-flow/*
+.swarm/*
 
 # ingest
 localdev/storage/

AGENTS.md

@@ -29,7 +29,7 @@ When context is insufficient, prefer asking 1–3 focused questions rather than
 ## Project Overview
 
 DSP-API is the Digital Humanities Service Platform API — a Scala-based REST API for managing semantic data and digital
-assets in the humanities. The project uses ZIO for functional programming, Pekko HTTP (Apache Pekko) for the API, and
+assets in the humanities. The project uses ZIO for functional programming, zio-http and tapir for the API, and
 integrates with Apache Jena Fuseki triplestore and the Sipi media server.
 
 ## Build System & Commands
@@ -74,7 +74,7 @@ Essential commands:
 - Technology
   - Language: Scala 3.3.x
   - FP: ZIO 2.x
-  - HTTP: Pekko HTTP + Tapir
+  - HTTP: ZIO HTTP + Tapir
   - Store: Apache Jena Fuseki (RDF)
   - Media: Sipi
   - JSON: ZIO JSON
@@ -98,17 +98,16 @@ Essential commands:
 ## API Structure
 
 - Endpoints: defined via Tapir in `*Endpoints.scala`
-- Handlers: in `*EndpointsHandler.scala`
-- Routes: in `*Routes.scala` and wired through `ApiRoutes.scala`
+- ServerEndpoints: in `*ServerEndpoints.scala`
 - API areas: Admin API, API v2 (main), Management (health/metrics)
 - Auth: JWT; scoped authorization; session management
 
 ## Common Agent Tasks
 
 - Add a new endpoint
   1. Define endpoint in the appropriate `*Endpoints.scala`
-  2. Implement handler in `*EndpointsHandler.scala`
-  3. Add route in `*Routes.scala` and register in `ApiRoutes.scala`
+  2. Connect endpoint definition with server logic in `*ServerEndpoints.scala`
+  3. Register in `CompleteApiServerEndpoints.scala`
   4. Add unit/integration tests mirroring the main structure
 - Code style and patterns
   - Use Scalafmt; prefer ZIO effects over side effects

CLAUDE.md

@@ -5,7 +5,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
 ## Project Overview
 
 DSP-API is the Digital Humanities Service Platform API - a Scala-based REST API for managing semantic data and digital assets in the humanities. 
-The project uses ZIO for functional programming, Pekko HTTP (Apache Pekko) for the API, and integrates with Apache Jena Fuseki triplestore and Sipi media server.
+The project uses ZIO for functional programming, zio-http as HTTP server and tapir for defining endpoints of the API, and integrates with Apache Jena Fuseki triplestore and Sipi media server.
 
 ## Build System & Commands
 
@@ -143,10 +143,10 @@ Each slice typically contains:
 ## Common Development Tasks
 
 ### Adding New Endpoints
-1. Define endpoint in appropriate `*Endpoints.scala`
-2. Implement handler in `*EndpointsHandler.scala`
-3. Add route in `*Routes.scala`
-4. Add to main router in `ApiRoutes.scala`
+1. Define endpoint in the appropriate `*Endpoints.scala`
+2. Connect endpoint definition with server logic in `*ServerEndpoints.scala`
+3. Register in `CompleteApiServerEndpoints.scala`
+4. Add unit/integration tests mirroring the main structure
 
 ### Code Style
 - Use Scalafmt for formatting
@@ -164,4 +164,4 @@ Each slice typically contains:
 ### Debugging
 - Use `make stack-logs` to view all service logs
 - Check `make stack-health` for API health status
-- Use `make stack-status` to see container status
+- Use `make stack-status` to see container status

build.sbt

@@ -285,6 +285,7 @@ lazy val testkit: Project = Project(id = "testkit", base = file("modules/testkit
       Dependencies.zioTest,
       Dependencies.testcontainers,
       Dependencies.wiremock,
+      Dependencies.dataFaker,
     ),
     publish / skip := true,
     name           := "testkit",
@@ -310,7 +311,6 @@ lazy val it: Project = Project(id = "test-it", base = file("modules/test-it"))
     Test / fork               := true,
     Test / testForkedParallel := false,
     Test / parallelExecution  := false,
-    Test / javaOptions += "-Dkey=" + sys.props.getOrElse("key", "pekko"),
     Test / testOptions += Tests.Argument("-oDF"), // full stack traces and durations
     Test / baseDirectory := (ThisBuild / baseDirectory).value,
     libraryDependencies ++= Dependencies.webapiDependencies ++ Dependencies.webapiTestDependencies ++ Dependencies.integrationTestDependencies,
@@ -342,7 +342,6 @@ lazy val e2e: Project = Project(id = "test-e2e", base = file("modules/test-e2e")
     Test / fork               := true,
     Test / testForkedParallel := false,
     Test / parallelExecution  := false,
-    Test / javaOptions += "-Dkey=" + sys.props.getOrElse("key", "pekko"),
     Test / testOptions += Tests.Argument("-oDF"),
     Test / baseDirectory := (ThisBuild / baseDirectory).value,
     libraryDependencies ++= Dependencies.webapiDependencies ++ Dependencies.webapiTestDependencies ++ Dependencies.integrationTestDependencies,

docs/03-endpoints/api-util/version.md

@@ -19,7 +19,6 @@ Server: webapi/v30.9.0
     "buildCommit": "bbb0e65c7",
     "buildTime": "2024-03-11T17:40:17.322491Z",
     "fuseki": "2.1.5",
-    "pekkoHttp": "1.0.1",
     "scala": "2.13.13",
     "sipi": "3.9.0",
     "webapi": "v30.9.0"

docs/04-publishing-deployment/configuration.md

@@ -1,14 +1,12 @@
 # Configuration
 
-All configuration for Knora is done in `application.conf`. Besides the Knora application
-specific configuration, there we can also find configuration for the underlying Pekko library.
+All configuration for Knora is done in `application.conf`. 
 
 For optimal performance it is important to tune the configuration to the hardware used, mainly
 to the number of CPUs and cores per CPU.
 
 The relevant sections for tuning are:
 
-- `pekko.actor.deployment`
 - `knora-actor-dispatcher`
 - `knora-blocking-dispatcher`
 
@@ -18,9 +16,6 @@ A number of core settings is additionally configurable through system environmen
 
 | key in application.conf                | environment variable                            | default value           |
 |----------------------------------------|-------------------------------------------------|-------------------------|
-| pekko.log-config-on-start              | KNORA_AKKA_LOG_CONFIG_ON_START                  | off                     |
-| pekko.loglevel                         | KNORA_AKKA_LOGLEVEL                             | INFO                    |
-| pekko.stdout-loglevel                  | KNORA_AKKA_STDOUT_LOGLEVEL                      | INFO                    |
 | app.print-extended-config              | KNORA_WEBAPI_PRINT_EXTENDED_CONFIG              | false                   |
 | app.bcrypt-password-strength           | KNORA_WEBAPI_BCRYPT_PASSWORD_STRENGTH           | 12                      |
 | app.jwt.secret                         | KNORA_WEBAPI_JWT_SECRET_KEY                     | super-secret-key        |

ingest/src/main/scala/swiss/dasch/api/MaintenanceEndpointsHandler.scala

@@ -68,12 +68,11 @@ final case class MaintenanceEndpointsHandler(
               .as("work in progress"),
       )
 
-  val endpoints: List[ZServerEndpoint[Any, Any]] =
-    List(
-      postMaintenanceEndpoint,
-      needsTopLeftCorrectionEndpoint,
-      wasTopLeftCorrectionAppliedEndpoint,
-    )
+  val endpoints: List[ZServerEndpoint[Any, Any]] = List(
+    postMaintenanceEndpoint,
+    needsTopLeftCorrectionEndpoint,
+    wasTopLeftCorrectionAppliedEndpoint,
+  )
 }
 
 object MaintenanceEndpointsHandler {

mkdocs.yml

@@ -74,7 +74,6 @@ nav:
               - Ontology Schemas: 05-internals/design/api-v2/ontology-schemas.md
               - Smart IRIs: 05-internals/design/api-v2/smart-iris.md
               - Content Wrappers: 05-internals/design/api-v2/content-wrappers.md
-              - How to Add an API v2 Route: 05-internals/design/api-v2/how-to-add-a-route.md
               - JSON-LD Parsing and Formatting: 05-internals/design/api-v2/json-ld.md
               - Ontology Management: 05-internals/design/api-v2/ontology-management.md
               - DSP-API and Sipi: 05-internals/design/api-v2/sipi.md

modules/test-e2e/src/test/resources/application.conf

@@ -1,5 +1,3 @@
-include "test"
-
 app {
   triplestore {
     dbtype = "fuseki"

modules/test-e2e/src/test/scala/org/knora/webapi/e2e/CORSSupportE2ESpec.scala

@@ -49,7 +49,7 @@ object CORSSupportE2ESpec extends E2EZSpec {
       corsClient(_.options(uri"/admin/projects", Header(AccessControlRequestMethod, "GET")))
         .map(response =>
           assertTrue(
-            response.code == StatusCode.Ok,
+            response.code.isSuccess,
             response.header(AccessControlAllowOrigin).contains("http://example.com"),
             response.header(AccessControlAllowMethods).exists(_.contains("GET")),
             response.header(AccessControlAllowMethods).exists(_.contains("PUT")),
@@ -62,14 +62,13 @@ object CORSSupportE2ESpec extends E2EZSpec {
             response.header(AccessControlAllowCredentials).contains("true"),
           ),
         )
-
     },
     test("send `Access-Control-Allow-Origin` header when the Knora resource is found ") {
       val resourceIri = "http://rdfh.ch/0001/55UrkgTKR2SEQgnsLWI9mg"
       corsClient(_.get(uri"/v2/resources/$resourceIri"))
         .map(response =>
           assertTrue(
-            response.code == StatusCode.Ok,
+            response.code.isSuccess,
             response.header(AccessControlAllowOrigin).contains("http://example.com"),
           ),
         )