Adding upstream version 2.52.6.
Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
parent
a960158181
commit
6d002e9543
GPG key ID:
FBB4F0E80A80222F
441 changed files with 95392 additions and 0 deletions
53
middleware/redirect/config.go
Normal file
53
middleware/redirect/config.go
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
package redirect
|
||||
|
||||
import (
|
||||
"regexp"
|
||||
|
||||
"github.com/gofiber/fiber/v2"
|
||||
)
|
||||
|
||||
// Config defines the config for middleware.
|
||||
type Config struct {
|
||||
// Filter defines a function to skip middleware.
|
||||
// Optional. Default: nil
|
||||
Next func(*fiber.Ctx) bool
|
||||
|
||||
// Rules defines the URL path rewrite rules. The values captured in asterisk can be
|
||||
// retrieved by index e.g. $1, $2 and so on.
|
||||
// Required. Example:
|
||||
// "/old": "/new",
|
||||
// "/api/*": "/$1",
|
||||
// "/js/*": "/public/javascripts/$1",
|
||||
// "/users/*/orders/*": "/user/$1/order/$2",
|
||||
Rules map[string]string
|
||||
|
||||
// The status code when redirecting
|
||||
// This is ignored if Redirect is disabled
|
||||
// Optional. Default: 302 Temporary Redirect
|
||||
StatusCode int
|
||||
|
||||
rulesRegex map[*regexp.Regexp]string
|
||||
}
|
||||
|
||||
// ConfigDefault is the default config
|
||||
var ConfigDefault = Config{
|
||||
StatusCode: fiber.StatusFound,
|
||||
}
|
||||
|
||||
// Helper function to set default values
|
||||
func configDefault(config ...Config) Config {
|
||||
// Return default config if nothing provided
|
||||
if len(config) < 1 {
|
||||
return ConfigDefault
|
||||
}
|
||||
|
||||
// Override default config
|
||||
cfg := config[0]
|
||||
|
||||
// Set default values
|
||||
if cfg.StatusCode == 0 {
|
||||
cfg.StatusCode = ConfigDefault.StatusCode
|
||||
}
|
||||
|
||||
return cfg
|
||||
}
|
||||
61
middleware/redirect/redirect.go
Normal file
61
middleware/redirect/redirect.go
Normal file
|
|
@ -0,0 +1,61 @@
|
|||
package redirect
|
||||
|
||||
import (
|
||||
"regexp"
|
||||
"strconv"
|
||||
"strings"
|
||||
|
||||
"github.com/gofiber/fiber/v2"
|
||||
)
|
||||
|
||||
// New creates a new middleware handler
|
||||
func New(config ...Config) fiber.Handler {
|
||||
cfg := configDefault(config...)
|
||||
|
||||
// Initialize
|
||||
cfg.rulesRegex = map[*regexp.Regexp]string{}
|
||||
for k, v := range cfg.Rules {
|
||||
k = strings.ReplaceAll(k, "*", "(.*)")
|
||||
k += "$"
|
||||
cfg.rulesRegex[regexp.MustCompile(k)] = v
|
||||
}
|
||||
|
||||
// Middleware function
|
||||
return func(c *fiber.Ctx) error {
|
||||
// Next request to skip middleware
|
||||
if cfg.Next != nil && cfg.Next(c) {
|
||||
return c.Next()
|
||||
}
|
||||
// Rewrite
|
||||
for k, v := range cfg.rulesRegex {
|
||||
replacer := captureTokens(k, c.Path())
|
||||
if replacer != nil {
|
||||
queryString := string(c.Context().QueryArgs().QueryString())
|
||||
if queryString != "" {
|
||||
queryString = "?" + queryString
|
||||
}
|
||||
return c.Redirect(replacer.Replace(v)+queryString, cfg.StatusCode)
|
||||
}
|
||||
}
|
||||
return c.Next()
|
||||
}
|
||||
}
|
||||
|
||||
// https://github.com/labstack/echo/blob/master/middleware/rewrite.go
|
||||
func captureTokens(pattern *regexp.Regexp, input string) *strings.Replacer {
|
||||
if len(input) > 1 {
|
||||
input = strings.TrimSuffix(input, "/")
|
||||
}
|
||||
groups := pattern.FindAllStringSubmatch(input, -1)
|
||||
if groups == nil {
|
||||
return nil
|
||||
}
|
||||
values := groups[0][1:]
|
||||
replace := make([]string, 2*len(values))
|
||||
for i, v := range values {
|
||||
j := 2 * i
|
||||
replace[j] = "$" + strconv.Itoa(i+1)
|
||||
replace[j+1] = v
|
||||
}
|
||||
return strings.NewReplacer(replace...)
|
||||
}
|
||||
295
middleware/redirect/redirect_test.go
Normal file
295
middleware/redirect/redirect_test.go
Normal file
|
|
@ -0,0 +1,295 @@
|
|||
//nolint:bodyclose // Much easier to just ignore memory leaks in tests
|
||||
package redirect
|
||||
|
||||
import (
|
||||
"context"
|
||||
"net/http"
|
||||
"testing"
|
||||
|
||||
"github.com/gofiber/fiber/v2"
|
||||
"github.com/gofiber/fiber/v2/utils"
|
||||
)
|
||||
|
||||
func Test_Redirect(t *testing.T) {
|
||||
app := *fiber.New()
|
||||
|
||||
app.Use(New(Config{
|
||||
Rules: map[string]string{
|
||||
"/default": "google.com",
|
||||
},
|
||||
StatusCode: fiber.StatusMovedPermanently,
|
||||
}))
|
||||
app.Use(New(Config{
|
||||
Rules: map[string]string{
|
||||
"/default/*": "fiber.wiki",
|
||||
},
|
||||
StatusCode: fiber.StatusTemporaryRedirect,
|
||||
}))
|
||||
app.Use(New(Config{
|
||||
Rules: map[string]string{
|
||||
"/redirect/*": "$1",
|
||||
},
|
||||
StatusCode: fiber.StatusSeeOther,
|
||||
}))
|
||||
app.Use(New(Config{
|
||||
Rules: map[string]string{
|
||||
"/pattern/*": "golang.org",
|
||||
},
|
||||
StatusCode: fiber.StatusFound,
|
||||
}))
|
||||
|
||||
app.Use(New(Config{
|
||||
Rules: map[string]string{
|
||||
"/": "/swagger",
|
||||
},
|
||||
StatusCode: fiber.StatusMovedPermanently,
|
||||
}))
|
||||
app.Use(New(Config{
|
||||
Rules: map[string]string{
|
||||
"/params": "/with_params",
|
||||
},
|
||||
StatusCode: fiber.StatusMovedPermanently,
|
||||
}))
|
||||
|
||||
app.Get("/api/*", func(c *fiber.Ctx) error {
|
||||
return c.SendString("API")
|
||||
})
|
||||
|
||||
app.Get("/new", func(c *fiber.Ctx) error {
|
||||
return c.SendString("Hello, World!")
|
||||
})
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
url string
|
||||
redirectTo string
|
||||
statusCode int
|
||||
}{
|
||||
{
|
||||
name: "should be returns status StatusFound without a wildcard",
|
||||
url: "/default",
|
||||
redirectTo: "google.com",
|
||||
statusCode: fiber.StatusMovedPermanently,
|
||||
},
|
||||
{
|
||||
name: "should be returns status StatusTemporaryRedirect using wildcard",
|
||||
url: "/default/xyz",
|
||||
redirectTo: "fiber.wiki",
|
||||
statusCode: fiber.StatusTemporaryRedirect,
|
||||
},
|
||||
{
|
||||
name: "should be returns status StatusSeeOther without set redirectTo to use the default",
|
||||
url: "/redirect/github.com/gofiber/redirect",
|
||||
redirectTo: "github.com/gofiber/redirect",
|
||||
statusCode: fiber.StatusSeeOther,
|
||||
},
|
||||
{
|
||||
name: "should return the status code default",
|
||||
url: "/pattern/xyz",
|
||||
redirectTo: "golang.org",
|
||||
statusCode: fiber.StatusFound,
|
||||
},
|
||||
{
|
||||
name: "access URL without rule",
|
||||
url: "/new",
|
||||
statusCode: fiber.StatusOK,
|
||||
},
|
||||
{
|
||||
name: "redirect to swagger route",
|
||||
url: "/",
|
||||
redirectTo: "/swagger",
|
||||
statusCode: fiber.StatusMovedPermanently,
|
||||
},
|
||||
{
|
||||
name: "no redirect to swagger route",
|
||||
url: "/api/",
|
||||
statusCode: fiber.StatusOK,
|
||||
},
|
||||
{
|
||||
name: "no redirect to swagger route #2",
|
||||
url: "/api/test",
|
||||
statusCode: fiber.StatusOK,
|
||||
},
|
||||
{
|
||||
name: "redirect with query params",
|
||||
url: "/params?query=abc",
|
||||
redirectTo: "/with_params?query=abc",
|
||||
statusCode: fiber.StatusMovedPermanently,
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
req, err := http.NewRequestWithContext(context.Background(), fiber.MethodGet, tt.url, nil)
|
||||
utils.AssertEqual(t, err, nil)
|
||||
req.Header.Set("Location", "github.com/gofiber/redirect")
|
||||
resp, err := app.Test(req)
|
||||
|
||||
utils.AssertEqual(t, err, nil)
|
||||
utils.AssertEqual(t, tt.statusCode, resp.StatusCode)
|
||||
utils.AssertEqual(t, tt.redirectTo, resp.Header.Get("Location"))
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func Test_Next(t *testing.T) {
|
||||
// Case 1 : Next function always returns true
|
||||
app := *fiber.New()
|
||||
app.Use(New(Config{
|
||||
Next: func(*fiber.Ctx) bool {
|
||||
return true
|
||||
},
|
||||
Rules: map[string]string{
|
||||
"/default": "google.com",
|
||||
},
|
||||
StatusCode: fiber.StatusMovedPermanently,
|
||||
}))
|
||||
|
||||
app.Use(func(c *fiber.Ctx) error {
|
||||
return c.SendStatus(fiber.StatusOK)
|
||||
})
|
||||
|
||||
req, err := http.NewRequestWithContext(context.Background(), fiber.MethodGet, "/default", nil)
|
||||
utils.AssertEqual(t, err, nil)
|
||||
resp, err := app.Test(req)
|
||||
utils.AssertEqual(t, err, nil)
|
||||
|
||||
utils.AssertEqual(t, fiber.StatusOK, resp.StatusCode)
|
||||
|
||||
// Case 2 : Next function always returns false
|
||||
app = *fiber.New()
|
||||
app.Use(New(Config{
|
||||
Next: func(*fiber.Ctx) bool {
|
||||
return false
|
||||
},
|
||||
Rules: map[string]string{
|
||||
"/default": "google.com",
|
||||
},
|
||||
StatusCode: fiber.StatusMovedPermanently,
|
||||
}))
|
||||
|
||||
req, err = http.NewRequestWithContext(context.Background(), fiber.MethodGet, "/default", nil)
|
||||
utils.AssertEqual(t, err, nil)
|
||||
resp, err = app.Test(req)
|
||||
utils.AssertEqual(t, err, nil)
|
||||
|
||||
utils.AssertEqual(t, fiber.StatusMovedPermanently, resp.StatusCode)
|
||||
utils.AssertEqual(t, "google.com", resp.Header.Get("Location"))
|
||||
}
|
||||
|
||||
func Test_NoRules(t *testing.T) {
|
||||
// Case 1: No rules with default route defined
|
||||
app := *fiber.New()
|
||||
|
||||
app.Use(New(Config{
|
||||
StatusCode: fiber.StatusMovedPermanently,
|
||||
}))
|
||||
|
||||
app.Use(func(c *fiber.Ctx) error {
|
||||
return c.SendStatus(fiber.StatusOK)
|
||||
})
|
||||
|
||||
req, err := http.NewRequestWithContext(context.Background(), fiber.MethodGet, "/default", nil)
|
||||
utils.AssertEqual(t, err, nil)
|
||||
resp, err := app.Test(req)
|
||||
utils.AssertEqual(t, err, nil)
|
||||
utils.AssertEqual(t, fiber.StatusOK, resp.StatusCode)
|
||||
|
||||
// Case 2: No rules and no default route defined
|
||||
app = *fiber.New()
|
||||
|
||||
app.Use(New(Config{
|
||||
StatusCode: fiber.StatusMovedPermanently,
|
||||
}))
|
||||
|
||||
req, err = http.NewRequestWithContext(context.Background(), fiber.MethodGet, "/default", nil)
|
||||
utils.AssertEqual(t, err, nil)
|
||||
resp, err = app.Test(req)
|
||||
utils.AssertEqual(t, err, nil)
|
||||
utils.AssertEqual(t, fiber.StatusNotFound, resp.StatusCode)
|
||||
}
|
||||
|
||||
func Test_DefaultConfig(t *testing.T) {
|
||||
// Case 1: Default config and no default route
|
||||
app := *fiber.New()
|
||||
|
||||
app.Use(New())
|
||||
|
||||
req, err := http.NewRequestWithContext(context.Background(), fiber.MethodGet, "/default", nil)
|
||||
utils.AssertEqual(t, err, nil)
|
||||
resp, err := app.Test(req)
|
||||
|
||||
utils.AssertEqual(t, err, nil)
|
||||
utils.AssertEqual(t, fiber.StatusNotFound, resp.StatusCode)
|
||||
|
||||
// Case 2: Default config and default route
|
||||
app = *fiber.New()
|
||||
|
||||
app.Use(New())
|
||||
app.Use(func(c *fiber.Ctx) error {
|
||||
return c.SendStatus(fiber.StatusOK)
|
||||
})
|
||||
|
||||
req, err = http.NewRequestWithContext(context.Background(), fiber.MethodGet, "/default", nil)
|
||||
utils.AssertEqual(t, err, nil)
|
||||
resp, err = app.Test(req)
|
||||
|
||||
utils.AssertEqual(t, err, nil)
|
||||
utils.AssertEqual(t, fiber.StatusOK, resp.StatusCode)
|
||||
}
|
||||
|
||||
func Test_RegexRules(t *testing.T) {
|
||||
// Case 1: Rules regex is empty
|
||||
app := *fiber.New()
|
||||
app.Use(New(Config{
|
||||
Rules: map[string]string{},
|
||||
StatusCode: fiber.StatusMovedPermanently,
|
||||
}))
|
||||
|
||||
app.Use(func(c *fiber.Ctx) error {
|
||||
return c.SendStatus(fiber.StatusOK)
|
||||
})
|
||||
|
||||
req, err := http.NewRequestWithContext(context.Background(), fiber.MethodGet, "/default", nil)
|
||||
utils.AssertEqual(t, err, nil)
|
||||
resp, err := app.Test(req)
|
||||
|
||||
utils.AssertEqual(t, err, nil)
|
||||
utils.AssertEqual(t, fiber.StatusOK, resp.StatusCode)
|
||||
|
||||
// Case 2: Rules regex map contains valid regex and well-formed replacement URLs
|
||||
app = *fiber.New()
|
||||
app.Use(New(Config{
|
||||
Rules: map[string]string{
|
||||
"/default": "google.com",
|
||||
},
|
||||
StatusCode: fiber.StatusMovedPermanently,
|
||||
}))
|
||||
|
||||
app.Use(func(c *fiber.Ctx) error {
|
||||
return c.SendStatus(fiber.StatusOK)
|
||||
})
|
||||
|
||||
req, err = http.NewRequestWithContext(context.Background(), fiber.MethodGet, "/default", nil)
|
||||
utils.AssertEqual(t, err, nil)
|
||||
resp, err = app.Test(req)
|
||||
|
||||
utils.AssertEqual(t, err, nil)
|
||||
utils.AssertEqual(t, fiber.StatusMovedPermanently, resp.StatusCode)
|
||||
utils.AssertEqual(t, "google.com", resp.Header.Get("Location"))
|
||||
|
||||
// Case 3: Test invalid regex throws panic
|
||||
defer func() {
|
||||
if r := recover(); r != nil {
|
||||
t.Log("Recovered from invalid regex: ", r)
|
||||
}
|
||||
}()
|
||||
|
||||
app = *fiber.New()
|
||||
app.Use(New(Config{
|
||||
Rules: map[string]string{
|
||||
"(": "google.com",
|
||||
},
|
||||
StatusCode: fiber.StatusMovedPermanently,
|
||||
}))
|
||||
t.Error("Expected panic, got nil")
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue