feat: add router (#42)

* feat: add router

* lint: ignore server.zig

* add router to readme

* fix

Author: hendriknielaender

.github/workflows/ci.yml

@@ -16,70 +16,23 @@ concurrency:
 
 env:
   ZIG_VERSION: 0.16.0-dev.2905+5d71e3051
-  ZLINT_VERSION: v0.7.9
   BORINGSSL_CACHE_VERSION: v1
 
 defaults:
   run:
     shell: bash
 
 jobs:
-  fmt:
-    name: Format
+  lint:
     runs-on: ubuntu-latest
-    timeout-minutes: 10
-
-    steps:
-      - name: Checkout source
-        uses: actions/checkout@v6
-        with:
-          persist-credentials: false
-
-      - name: Setup Zig
-        uses: mlugg/setup-zig@v2
-        with:
-          version: ${{ env.ZIG_VERSION }}
-
-      - name: Check formatting
-        run: zig build fmt-check
-
-  zlint:
-    name: ZLint
-    runs-on: ubuntu-latest
-    timeout-minutes: 10
-
     steps:
-      - name: Checkout source
-        uses: actions/checkout@v6
-        with:
-          persist-credentials: false
-
+      - uses: actions/checkout@v6
       - name: Setup Zig
         uses: mlugg/setup-zig@v2
         with:
           version: ${{ env.ZIG_VERSION }}
-
-      - name: Install zlint
-        run: |
-          case "$(uname -m)" in
-            x86_64) target="linux-x86_64" ;;
-            aarch64 | arm64) target="linux-aarch64" ;;
-            *)
-              echo "Unsupported zlint architecture: $(uname -m)" >&2
-              exit 1
-              ;;
-          esac
-
-          install_dir="${RUNNER_TEMP}/zlint-bin"
-          mkdir -p "${install_dir}"
-          curl --fail --location --silent --show-error --retry 3 --retry-delay 2 \
-            --output "${install_dir}/zlint" \
-            "https://github.com/DonIsaac/zlint/releases/download/${ZLINT_VERSION}/zlint-${target}"
-          chmod +x "${install_dir}/zlint"
-          echo "${install_dir}" >> "${GITHUB_PATH}"
-
-      - name: Run zlint
-        run: zlint . --deny-warnings --format github
+      - run: zig fmt --check src/*.zig
+      - uses: DonIsaac/zlint-action@v0
 
   boringssl_linux:
     name: Prepare BoringSSL (Linux)

README.md

@@ -63,19 +63,34 @@ exe.root_module.addImport("http2", http2_dep.module("http2"));
 const std = @import("std");
 const http2 = @import("http2");
 
+fn indexHandler(ctx: *const http2.Context) !http2.Response {
+    return ctx.response.text(.ok, "hello from http2.zig\n");
+}
+
+fn notFoundHandler(ctx: *const http2.Context) !http2.Response {
+    return ctx.response.text(.not_found, "not found\n");
+}
+
 pub fn main() !void {
-    var gpa = std.heap.GeneralPurposeAllocator(.{}){};
+    var gpa: std.heap.DebugAllocator(.{}) = .init;
     defer _ = gpa.deinit();
     const allocator = gpa.allocator();
 
     // Initialize the HTTP/2 system
     try http2.init(allocator);
     defer http2.deinit();
 
+    // Configure the request router
+    var router = http2.Router.init(allocator);
+    defer router.deinit();
+
+    try router.get("/", indexHandler);
+    router.setFallback(notFoundHandler);
+
     // Configure and create server
     const config = http2.Server.Config{
-        .address = try std.net.Address.resolveIp("127.0.0.1", 3000),
-        .max_connections = 1000,
+        .address = try std.Io.net.IpAddress.parse("127.0.0.1", 3000),
+        .router = &router,
     };
 
     var server = try http2.Server.init(allocator, config);
@@ -99,7 +114,10 @@ TBD
 ```zig
 pub const Server.Config = struct {
     /// Address to bind to
-    address: std.net.Address,
+    address: std.Io.net.IpAddress,
+
+    /// Request router for handling HTTP requests
+    router: *Router,
     
     /// Maximum concurrent connections (default: 1000)
     max_connections: u32 = 1000,
@@ -109,6 +127,35 @@ pub const Server.Config = struct {
 };
 ```
 
+### Router
+
+The server expects a router in `Server.Config`, and requests are dispatched through it.
+
+```zig
+try router.get("/", indexHandler);
+try router.post("/api/messages", createMessageHandler);
+try router.getPrefix("/assets", staticAssetsHandler);
+router.setFallback(notFoundHandler);
+```
+
+Current routing behavior:
+
+- `get`, `post`, `put`, `delete`, `head`, `options`, and `patch` register exact routes.
+- `getPrefix` and `postPrefix` register prefix routes.
+- Prefix routes are ordered by longest path first.
+- Prefix matching is segment-aware: `/api` matches `/api` and `/api/users`, but not `/apix`.
+- A matching path with the wrong method returns `405 Method Not Allowed`.
+- A missing path falls through to the fallback handler when configured; otherwise it returns `404 Not Found`.
+
+The request context passed to handlers exposes:
+
+- `ctx.method`
+- `ctx.path`
+- `ctx.query`
+- `ctx.headers`
+- `ctx.body`
+- `ctx.response`
+
 ### Server Methods
 
 ```zig