Merge pull request #12 from adamreese/wildcard-redirects

feat(redirect): add wildcard redirect support; spin sdk bump; CI test additions

Author: vdice

.github/workflows/build.yml

@@ -14,6 +14,11 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
+      - name: Setup Wasmtime
+        uses: bytecodealliance/actions/wasmtime/setup@v1
+        with:
+          version: "31.0.0"
+
       - name: "Install Go"
         uses: actions/setup-go@v3
         with:
@@ -24,7 +29,10 @@ jobs:
           wget https://github.com/tinygo-org/tinygo/releases/download/v0.37.0/tinygo_0.37.0_amd64.deb
           sudo dpkg -i tinygo_0.37.0_amd64.deb
 
-      - name: Make
+      - name: Build
         env:
           ENABLE_WASM_OPT: false
         run: make build
+
+      - name: Test
+        run: make test

.github/workflows/release.yml

@@ -16,6 +16,11 @@ jobs:
       - name: set the release version (tag)
         run: echo "RELEASE_VERSION=${GITHUB_REF/refs\/tags\//}" >> $GITHUB_ENV
 
+      - name: Setup Wasmtime
+        uses: bytecodealliance/actions/wasmtime/setup@v1
+        with:
+          version: "31.0.0"
+
       - name: "Install Go"
         uses: actions/setup-go@v3
         with:
@@ -26,11 +31,14 @@ jobs:
           wget https://github.com/tinygo-org/tinygo/releases/download/v0.37.0/tinygo_0.37.0_amd64.deb
           sudo dpkg -i tinygo_0.37.0_amd64.deb
 
-      - name: Make
+      - name: Build
         env:
           ENABLE_WASM_OPT: false
         run: make build
 
+      - name: Test
+        run: make test
+
       - name: generate checksums
         run: |
           sha256sum redirect.wasm > checksums-${{ env.RELEASE_VERSION }}.txt

Makefile

@@ -6,3 +6,7 @@ build:
 ifeq ($(ENABLE_WASM_OPT),true)
 	wasm-opt -Os -o redirect.wasm redirect.wasm
 endif
+
+.PHONY: test
+test:
+	tinygo test -target=wasip1 -gc=leaking -v ./redirect/...

README.md

@@ -13,10 +13,12 @@ The `spin-redirect` component can be configured to address your needs in differe
 
 The following table outlines available configuration values:
 
-| Key           | Description                                           | Default Value    |
-|---------------|-------------------------------------------------------|------------------|
-| `destination` | Where should the component redirect to                | `/`              |
-| `statuscode`  | What HTTP status code should be used when redirecting | `302`            |
+| Key            | Description                                                                                                             | Default Value |
+|----------------|-------------------------------------------------------------------------------------------------------------------------|---------------|
+| `destination`  | Where should the component redirect to                                                                                  | `/`           |
+| `statuscode`   | What HTTP status code should be used when redirecting                                                                   | `302`         |
+| `include_path` | Whether to include the original request path on the destination redirect; see [wildcard redirects](#wildcard-redirects) | `false`       |
+| `trim_prefix`  | A specific prefix portion of the original request path to trim (when `include_path` is `true`)                          |               |
 
 The `spin-redirect` component tries to look up the config value in the Spin component configuration using the keys shown in the table above (lower case). If desired key is not present, it transforms the key to upper case (e.g., `DESTINATION`) and checks environment variables.
 
@@ -73,3 +75,47 @@ statuscode="301"
 route = "/"
 
 ```
+
+### Wildcard redirects
+
+Wildcard redirects can be enabled by setting `include_path` to `true`.  In the example below,
+all requests to the application will be redirected to `/foo`, with the original request path included,
+e.g. `/bar` will redirect to `/foo/bar`, `/baz` will redirect to `/foo/baz` and so on.
+
+```toml
+spin_manifest_version = 2
+
+[application]
+name = "wildcard-redirect"
+version = "0.1.0"
+
+[[trigger.http]]
+id = "trigger-redirect-to-foo"
+component = "redirect-to-foo"
+route = "/..."
+
+[component.redirect-to-foo]
+source = "modules/redirect.wasm"
+environment = { DESTINATION = "/foo", INCLUDE_PATH = "true" }
+```
+
+A prefix portion of the original request path can be trimmed via the `trim_prefix` configuration.
+
+In this example, the `/v1/` prefix is trimmed, such that requests to `/v1/bar` will redirect to `/v2/bar` and so on.
+
+```toml
+spin_manifest_version = 2
+
+[application]
+name = "wildcard-redirect"
+version = "0.1.0"
+
+[[trigger.http]]
+id = "trigger-redirect-v1-to-v2"
+component = "redirect-v1-to-v2"
+route = "/v1/..."
+
+[component.redirect-v1-to-v2]
+source = "modules/redirect.wasm"
+environment = { DESTINATION = "/v2", INCLUDE_PATH = "true", TRIM_PREFIX = "/v1/" }
+```

go.mod

@@ -2,6 +2,8 @@ module github.com/fermyon/spin-redirect
 
 go 1.24
 
-require github.com/fermyon/spin/sdk/go v1.4.2
+require github.com/spinframework/spin-go-sdk v0.0.0-20250310233821-2665ad7e30a4
 
 require github.com/julienschmidt/httprouter v1.3.0 // indirect
+
+replace github.com/spinframework/spin-go-sdk => github.com/fermyon/spin-go-sdk v0.0.0-20250310233821-2665ad7e30a4

go.sum

@@ -1,4 +1,4 @@
-github.com/fermyon/spin/sdk/go v1.4.2 h1:4U2J2WooKptCa4zeBetKctz/DEJxv3RvGauW0bZ+e6U=
-github.com/fermyon/spin/sdk/go v1.4.2/go.mod h1:yb8lGesopgj/GwPzLPATxcOeqWZT/HjrzEFfwbztAXE=
+github.com/fermyon/spin-go-sdk v0.0.0-20250310233821-2665ad7e30a4 h1:er/5jOnjXEjx95+7iiioj5l/CwT5AQgM7Udr8xM/mDI=
+github.com/fermyon/spin-go-sdk v0.0.0-20250310233821-2665ad7e30a4/go.mod h1:9GoW1+MR0gN1OEinITtjPOzmu0dur3U6ty3pIH/gN24=
 github.com/julienschmidt/httprouter v1.3.0 h1:U0609e9tgbseu3rBINet9P48AI/D3oJs4dN7jwJOQ1U=
 github.com/julienschmidt/httprouter v1.3.0/go.mod h1:JR6WtHb+2LUe8TCKY3cZOxFyyO8IZAc4RVcycCCAKdM=

main.go

@@ -0,0 +1,12 @@
+package main
+
+import (
+	spinhttp "github.com/spinframework/spin-go-sdk/http"
+
+	"github.com/fermyon/spin-redirect/redirect"
+)
+
+func init() {
+	r := redirect.NewSpinRedirect()
+	spinhttp.Handle(r.HandleFunc)
+}

config.go renamed to redirect/config.go

@@ -1,10 +1,10 @@
-package main
+package redirect
 
 import (
 	"os"
 	"strings"
 
-	config "github.com/fermyon/spin/sdk/go/config"
+	config "github.com/spinframework/spin-go-sdk/variables"
 )
 
 type ConfigReader interface {

redirect.go renamed to redirect/redirect.go

@@ -1,10 +1,11 @@
-package main
+package redirect
 
 import (
 	"net/http"
+	"net/url"
+	"path"
 	"strconv"
-
-	spinhttp "github.com/fermyon/spin/sdk/go/http"
+	"strings"
 )
 
 const (
@@ -16,16 +17,12 @@ const (
 	destinationKey string = "destination"
 	// Key for loading desired HTTP status code
 	statusCodeKey string = "statuscode"
+	// Key to enable adding original path in redirect
+	includePathKey string = "include_path"
+	// Key for trimming a preceding portion of the included path
+	trimPrefixKey string = "trim_prefix"
 )
 
-func init() {
-	r := NewSpinRedirect()
-	spinhttp.Handle(r.handleFunc)
-}
-
-func main() {
-}
-
 // SpinRedirect is a struct that provides a handleFunc
 // for redirecting to a destination URL using configurable HTTP status code.
 type SpinRedirect struct {
@@ -39,11 +36,11 @@ func NewSpinRedirect() SpinRedirect {
 	}
 }
 
-func (s SpinRedirect) handleFunc(w http.ResponseWriter, r *http.Request) {
+func (s SpinRedirect) HandleFunc(w http.ResponseWriter, r *http.Request) {
 	dest, _ := s.getDestination()
 	code, _ := s.getStatusCode(r.Method)
 
-	w.Header().Set("Location", dest)
+	w.Header().Set("Location", s.WithPath(dest, r))
 	w.WriteHeader(code)
 }
 
@@ -92,3 +89,21 @@ func isValidRedirectStatusCode(code int, method string) bool {
 	}
 	return false
 }
+
+// WithPath returns the provided dest with the path portion of the request,
+// assuming the includePathKey has a value of true
+func (s SpinRedirect) WithPath(dest string, r *http.Request) string {
+	includePath := s.cfg.Get(includePathKey)
+	if includePath != "true" {
+		return dest
+	}
+
+	u, err := url.Parse(dest)
+	if err != nil {
+		return dest
+	}
+
+	u.Path = path.Join(u.Path, strings.TrimPrefix(r.URL.Path, s.cfg.Get(trimPrefixKey)))
+
+	return u.String()
+}

redirect/redirect_test.go

@@ -0,0 +1,72 @@
+package redirect
+
+import (
+	"fmt"
+	"net/http"
+	"testing"
+)
+
+type testConfigReader struct {
+	includePath string
+	trimPrefix  string
+}
+
+func (c *testConfigReader) Get(key string) string {
+	switch key {
+	case includePathKey:
+		return c.includePath
+	case trimPrefixKey:
+		return c.trimPrefix
+	default:
+		return ""
+	}
+}
+
+func TestWithPath(t *testing.T) {
+	type test struct {
+		name    string
+		cfg     testConfigReader
+		reqPath string
+		wantURL string
+	}
+
+	tests := []test{
+		{
+			"include_path false",
+			testConfigReader{},
+			"/foo/bar",
+			"http://localhost",
+		},
+		{
+			"include_path true, trim_prefix empty",
+			testConfigReader{includePath: "true"},
+			"/foo/bar",
+			"http://localhost/foo/bar",
+		},
+		{
+			"include_path true, trim_prefix is foo",
+			testConfigReader{includePath: "true", trimPrefix: "/foo"},
+			"/foo/bar",
+			"http://localhost/bar",
+		},
+	}
+
+	for _, tc := range tests {
+		t.Run(tc.name, func(t *testing.T) {
+			r := &SpinRedirect{
+				cfg: &tc.cfg,
+			}
+
+			dest := "http://localhost"
+			req, err := http.NewRequest("GET", fmt.Sprintf("http://localhost%s", tc.reqPath), nil)
+			if err != nil {
+				t.Fatalf("failed to create new http request: %s", err)
+			}
+
+			gotURL := r.WithPath(dest, req)
+			if gotURL != tc.wantURL {
+				t.Fatalf("failed: got '%s', want '%s'", gotURL, tc.wantURL)
+			}
+		})
+	}
+}