HTTP context API improvements

hexagontk · Sep 13, 2023 · b736a0e · b736a0e
1 parent e9c300b
commit b736a0e
Show file tree

Hide file tree

Showing 10 changed files with 45 additions and 92 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -1,6 +1,4 @@
 
-name: Build
-
 on:
   push:
     branches-ignore: [ master ]
@@ -10,7 +8,6 @@ permissions:
 
 jobs:
   build:
-    name: Build
     uses: hexagonkt/.github/.github/workflows/graalvm_gradle.yml@master
     with:
       java: dev

diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml
@@ -1,6 +1,4 @@
 
-name: Nightly
-
 on:
   schedule:
     - cron: "59 23 * * *"
@@ -28,9 +26,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ ubuntu-latest, windows-latest ]
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
 
-    name: Build (${{ matrix.os }})
+    name: build (${{ matrix.os }})
     uses: hexagonkt/.github/.github/workflows/graalvm_gradle.yml@master
     with:
       os: ${{ matrix.os }}
@@ -39,25 +37,13 @@ jobs:
       check_directory: core/build
       ref: develop
 
-  # TODO Delete this special case when Jacoco runs on macOS properly
-  build_macos:
-    name: Build (macos-latest)
-    uses: hexagonkt/.github/.github/workflows/graalvm_gradle.yml@master
-    with:
-      os: macos-latest
-      java: dev
-      distribution: graalvm
-      check_directory: core/build
-      ref: develop
-      tasks: -x jacocoTestReport
-
   sample_keystores:
     strategy:
       fail-fast: false
       matrix:
         os: [ ubuntu-latest, windows-latest, macos-latest ]
 
-    name: Sample Keystores (${{ matrix.os }})
+    name: sample_keystores (${{ matrix.os }})
     uses: hexagonkt/.github/.github/workflows/graalvm_gradle.yml@master
     with:
       os: ${{ matrix.os }}
@@ -72,30 +58,25 @@ jobs:
       matrix:
         os: [ ubuntu-latest, windows-latest, macos-latest ]
 
-    name: Native Test
+    name: native_test (${{ matrix.os }})
     runs-on: ${{ matrix.os }}
     steps:
-      - name: Configure Page File
-        uses: al-cheb/configure-pagefile-action@v1.3
+      - uses: al-cheb/configure-pagefile-action@v1.3
         if: ${{ matrix.os == 'windows-latest' }}
         with:
           minimum-size: 16GB
           disk-root: "C:"
-      - name: Check Out
-        uses: actions/checkout@v3
+      - uses: actions/checkout@v3
         with:
           ref: develop
-      - name: Set Up Java
-        uses: graalvm/setup-graalvm@v1
+      - uses: graalvm/setup-graalvm@v1
         with:
-          java-version: 20
-          distribution: graalvm-community
+          java-version: dev
+          distribution: graalvm
           cache: gradle
-      - name: Build Project
-        run: ./gradlew --stacktrace nativeTest
+      - run: ./gradlew --stacktrace nativeTest
 
   jmh:
-    name: JMH Benchmark
     uses: hexagonkt/.github/.github/workflows/graalvm_gradle.yml@master
     with:
       java: dev
@@ -104,7 +85,6 @@ jobs:
       tasks: jmh
 
   build_site:
-    name: Build Site
     uses: hexagonkt/hexagon/.github/workflows/site.yml@master
     with:
       ref: develop
@@ -115,7 +95,7 @@ jobs:
       matrix:
         os: [ ubuntu-latest, windows-latest, macos-latest ]
 
-    name: Test Publishing (${{ matrix.os }})
+    name: test_publishing (${{ matrix.os }})
     uses: hexagonkt/.github/.github/workflows/graalvm_gradle.yml@master
     with:
       os: ${{ matrix.os }}

diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml
@@ -1,43 +1,35 @@
 
-name: Pull Request
-
-on:
-  - pull_request
+on: pull_request
 
 permissions:
   contents: read
 
 jobs:
   sample_keystores:
-    name: Sample Keystores
     uses: hexagonkt/.github/.github/workflows/graalvm_gradle.yml@master
     with:
       java: dev
       distribution: graalvm
       tasks: createCa createIdentities
 
   native_test:
-    name: Native Test
     uses: hexagonkt/.github/.github/workflows/graalvm_gradle.yml@master
     with:
       java: dev
       distribution: graalvm
       tasks: nativeTest
 
   jmh:
-    name: JMH Benchmark
     uses: hexagonkt/.github/.github/workflows/graalvm_gradle.yml@master
     with:
       java: dev
       distribution: graalvm
       tasks: jmh
 
   build_site:
-    name: Build Site
     uses: hexagonkt/hexagon/.github/workflows/site.yml@develop
 
   test_publishing:
-    name: Test Publishing
     uses: hexagonkt/.github/.github/workflows/graalvm_gradle.yml@master
     with:
       java: dev

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -1,40 +1,33 @@
 
-name: Release
-
 on:
   push:
     branches: [ master ]
 
 jobs:
   publish:
-    name: Publish
     runs-on: ubuntu-latest
     steps:
 
-      - name: Restore MkDocs Cache
-        uses: actions/cache@v3
+      - uses: actions/cache@v3
         with:
           key: ${{ runner.os }}-mkdocs-${{ hashFiles('**/*.gradle*', '**/gradle*.properties') }}
           restore-keys: ${{ runner.os }}-mkdocs-
           path: |
             ~/.local/bin
             ~/.local/lib/python*/site-packages
 
-      - name: Check Out
-        uses: actions/checkout@v3
+      - uses: actions/checkout@v3
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Set Up Java
-        uses: graalvm/setup-graalvm@v1
+      - uses: graalvm/setup-graalvm@v1
         with:
           java-version: 20
           distribution: graalvm-community
           github-token: ${{ secrets.GITHUB_TOKEN }}
           cache: gradle
 
-      - name: Update Site
-        env:
+      - env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
           export REMOTE="https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$GITHUB_REPOSITORY.git"
@@ -44,16 +37,14 @@ jobs:
           ./gradlew -x build buildSite
           ls -AlF site/build/site
 
-      - name: Publish Packages
-        env:
+      - env:
           OSSRH_PASSWORD: ${{ secrets.OSSRH_PASSWORD }}
           OSSRH_USERNAME: ${{ secrets.OSSRH_USERNAME }}
           SIGNING_KEY: ${{ secrets.SIGNING_KEY }}
           SIGNING_PASSWORD: ${{ secrets.SIGNING_PASSWORD }}
         run: ./gradlew --no-daemon -x test release
 
-      - name: Publish Site
-        run: |
+      - run: |
           cp -rf site/build/site/* build/gh-pages/
           cd build/gh-pages
           git add --all

diff --git a/.github/workflows/release_branch.yml b/.github/workflows/release_branch.yml
@@ -1,31 +1,25 @@
 
-name: Release Branch
-
 on:
   push:
     branches: [ release/** ]
 
 jobs:
   publish:
-    name: Publish
     runs-on: ubuntu-latest
     steps:
 
-      - name: Check Out
-        uses: actions/checkout@v3
+      - uses: actions/checkout@v3
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Set Up Java
-        uses: graalvm/setup-graalvm@v1
+      - uses: graalvm/setup-graalvm@v1
         with:
-          java-version: 20
-          distribution: graalvm-community
+          java-version: dev
+          distribution: graalvm
           github-token: ${{ secrets.GITHUB_TOKEN }}
           cache: gradle
 
-      - name: Publish Packages
-        env:
+      - env:
           OSSRH_PASSWORD: ${{ secrets.OSSRH_PASSWORD }}
           OSSRH_USERNAME: ${{ secrets.OSSRH_USERNAME }}
           SIGNING_KEY: ${{ secrets.SIGNING_KEY }}

diff --git a/.github/workflows/site.yml b/.github/workflows/site.yml
@@ -1,6 +1,4 @@
 
-name: Site
-
 on:
   workflow_call:
     inputs:
@@ -31,41 +29,34 @@ on:
 
 jobs:
   site:
-    name: Build Site
     runs-on: ubuntu-latest
     permissions:
       contents: read
     defaults:
       run: { shell: bash }
     steps:
-      - name: Restore MkDocs Cache
-        uses: actions/cache@v3
+      - uses: actions/cache@v3
         with:
           key: ${{ runner.os }}-mkdocs-${{ hashFiles('**/*.gradle*', '**/gradle*.properties') }}
           restore-keys: ${{ runner.os }}-mkdocs-
           path: |
             ~/.local/bin
             ~/.local/lib/python*/site-packages
 
-      - name: Check Out
-        uses: actions/checkout@v3
+      - uses: actions/checkout@v3
         with:
           ref: ${{ inputs.ref }}
 
-      - name: Set Up Java
-        uses: graalvm/setup-graalvm@v1
+      - uses: graalvm/setup-graalvm@v1
         with:
           version: ${{ inputs.version }}
           distribution: ${{ inputs.distribution }}
           java-version: ${{ inputs.java }}
           cache: gradle
 
-      - name: Build Project
-        run: ./gradlew --stacktrace build
+      - run: ./gradlew --stacktrace build
 
-      - name: Build Site
-        run: ./gradlew --stacktrace -x build buildSite
+      - run: ./gradlew --stacktrace -x build buildSite
 
-      - name: Check Build
-        if: ${{ inputs.check_directory != '' }}
+      - if: ${{ inputs.check_directory != '' }}
         run: ls -AlF "${{ inputs.check_directory }}"
diff --git a/http/http_handlers/api/http_handlers.api b/http/http_handlers/api/http_handlers.api
@@ -194,6 +194,8 @@ public final class com/hexagonkt/http/handlers/HttpContext : com/hexagonkt/handl
 	public fun equals (Ljava/lang/Object;)Z
 	public final fun forbidden (Ljava/lang/Object;Lcom/hexagonkt/http/model/Headers;Lcom/hexagonkt/http/model/ContentType;Ljava/util/List;Ljava/util/Map;)Lcom/hexagonkt/http/handlers/HttpContext;
 	public static synthetic fun forbidden$default (Lcom/hexagonkt/http/handlers/HttpContext;Ljava/lang/Object;Lcom/hexagonkt/http/model/Headers;Lcom/hexagonkt/http/model/ContentType;Ljava/util/List;Ljava/util/Map;ILjava/lang/Object;)Lcom/hexagonkt/http/handlers/HttpContext;
+	public final fun found (Ljava/lang/String;Lcom/hexagonkt/http/model/Headers;Ljava/util/List;Ljava/util/Map;)Lcom/hexagonkt/http/handlers/HttpContext;
+	public static synthetic fun found$default (Lcom/hexagonkt/http/handlers/HttpContext;Ljava/lang/String;Lcom/hexagonkt/http/model/Headers;Ljava/util/List;Ljava/util/Map;ILjava/lang/Object;)Lcom/hexagonkt/http/handlers/HttpContext;
 	public final fun getAccept ()Ljava/util/List;
 	public fun getAttributes ()Ljava/util/Map;
 	public final fun getAuthorization ()Lcom/hexagonkt/http/model/Authorization;
@@ -234,8 +236,8 @@ public final class com/hexagonkt/http/handlers/HttpContext : com/hexagonkt/handl
 	public static synthetic fun notFound$default (Lcom/hexagonkt/http/handlers/HttpContext;Ljava/lang/Object;Lcom/hexagonkt/http/model/Headers;Lcom/hexagonkt/http/model/ContentType;Ljava/util/List;Ljava/util/Map;ILjava/lang/Object;)Lcom/hexagonkt/http/handlers/HttpContext;
 	public final fun ok (Ljava/lang/Object;Lcom/hexagonkt/http/model/Headers;Lcom/hexagonkt/http/model/ContentType;Ljava/util/List;Ljava/util/Map;)Lcom/hexagonkt/http/handlers/HttpContext;
 	public static synthetic fun ok$default (Lcom/hexagonkt/http/handlers/HttpContext;Ljava/lang/Object;Lcom/hexagonkt/http/model/Headers;Lcom/hexagonkt/http/model/ContentType;Ljava/util/List;Ljava/util/Map;ILjava/lang/Object;)Lcom/hexagonkt/http/handlers/HttpContext;
-	public final fun redirect (Lcom/hexagonkt/http/model/HttpStatus;Ljava/net/URI;Lcom/hexagonkt/http/model/Headers;Ljava/util/List;Ljava/util/Map;)Lcom/hexagonkt/http/handlers/HttpContext;
-	public static synthetic fun redirect$default (Lcom/hexagonkt/http/handlers/HttpContext;Lcom/hexagonkt/http/model/HttpStatus;Ljava/net/URI;Lcom/hexagonkt/http/model/Headers;Ljava/util/List;Ljava/util/Map;ILjava/lang/Object;)Lcom/hexagonkt/http/handlers/HttpContext;
+	public final fun redirect (Lcom/hexagonkt/http/model/HttpStatus;Ljava/lang/String;Lcom/hexagonkt/http/model/Headers;Ljava/util/List;Ljava/util/Map;)Lcom/hexagonkt/http/handlers/HttpContext;
+	public static synthetic fun redirect$default (Lcom/hexagonkt/http/handlers/HttpContext;Lcom/hexagonkt/http/model/HttpStatus;Ljava/lang/String;Lcom/hexagonkt/http/model/Headers;Ljava/util/List;Ljava/util/Map;ILjava/lang/Object;)Lcom/hexagonkt/http/handlers/HttpContext;
 	public final fun request (Ljava/lang/Object;Lcom/hexagonkt/http/model/Headers;Lcom/hexagonkt/http/model/ContentType;Ljava/util/List;Ljava/util/Map;)Lcom/hexagonkt/http/handlers/HttpContext;
 	public static synthetic fun request$default (Lcom/hexagonkt/http/handlers/HttpContext;Ljava/lang/Object;Lcom/hexagonkt/http/model/Headers;Lcom/hexagonkt/http/model/ContentType;Ljava/util/List;Ljava/util/Map;ILjava/lang/Object;)Lcom/hexagonkt/http/handlers/HttpContext;
 	public final fun send (Lcom/hexagonkt/http/model/HttpRequestPort;Ljava/util/Map;)Lcom/hexagonkt/http/handlers/HttpContext;

diff --git a/http/http_handlers/src/main/kotlin/com/hexagonkt/http/handlers/HttpContext.kt b/http/http_handlers/src/main/kotlin/com/hexagonkt/http/handlers/HttpContext.kt
@@ -10,7 +10,6 @@ import com.hexagonkt.http.model.*
 import com.hexagonkt.http.model.INTERNAL_SERVER_ERROR_500
 import com.hexagonkt.http.model.ServerEvent
 import com.hexagonkt.http.model.ws.WsSession
-import java.net.URI
 import java.net.URL
 import java.security.cert.X509Certificate
 import java.util.concurrent.Flow.Publisher
@@ -204,7 +203,7 @@ data class HttpContext(
 
     fun redirect(
         status: HttpStatus,
-        location: URI,
+        location: String,
         headers: Headers = response.headers,
         cookies: List<Cookie> = response.cookies,
         attributes: Map<*, *> = this.attributes,
@@ -216,6 +215,14 @@ data class HttpContext(
             attributes = attributes
         )
 
+    fun found(
+        location: String,
+        headers: Headers = response.headers,
+        cookies: List<Cookie> = response.cookies,
+        attributes: Map<*, *> = this.attributes,
+    ): HttpContext =
+        redirect(FOUND_302, location, headers, cookies, attributes)
+
     fun accepted(
         onConnect: WsSession.() -> Unit = {},
         onBinary: WsSession.(data: ByteArray) -> Unit = {},

diff --git a/http/http_test/src/main/kotlin/com/hexagonkt/http/test/examples/ClientTest.kt b/http/http_test/src/main/kotlin/com/hexagonkt/http/test/examples/ClientTest.kt
@@ -27,7 +27,6 @@ import com.hexagonkt.serialization.serialize
 import org.junit.jupiter.api.*
 
 import java.math.BigInteger
-import java.net.URI
 import kotlin.test.assertEquals
 import kotlin.test.assertFalse
 import kotlin.test.assertNull
@@ -90,7 +89,7 @@ abstract class ClientTest(
     @Test open fun `Redirects are handled correctly correctly`() {
         callback = {
             if (queryParameters["ok"] != null) ok("redirected")
-            else redirect(FOUND_302, URI("/foo?ok"))
+            else found("/foo?ok")
         }
 
         val response = client.get()