mirror of
https://github.com/gofiber/fiber.git
synced 2025-05-01 13:16:18 +00:00
* Update pull_request_template.md * Update v3-changes.md * Update CONTRIBUTING.md (#2752) Grammar correction. * chore(encryptcookie)!: update default config (#2753) * chore(encryptcookie)!: update default config docs(encryptcookie): enhance documentation and examples BREAKING CHANGE: removed the hardcoded "csrf_" from the Except. * docs(encryptcookie): reads or modifies cookies * chore(encryptcookie): csrf config example * docs(encryptcookie): md table spacing * build(deps): bump actions/setup-go from 4 to 5 (#2754) Bumps [actions/setup-go](https://github.com/actions/setup-go) from 4 to 5. - [Release notes](https://github.com/actions/setup-go/releases) - [Commits](https://github.com/actions/setup-go/compare/v4...v5) --- updated-dependencies: - dependency-name: actions/setup-go dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * 🩹 middleware/logger/: log client IP address by default (#2755) * middleware/logger: Log client IP address by default. * Update doc. * fix: don't constrain middlewares' context-keys to strings 🐛 (#2751) * Revert "Revert "🐛 requestid.Config.ContextKey is interface{} (#2369)" (#2742)" This reverts commit 28be17f929cfa7d3c27dd292fc3956f2f9882e22. * fix: request ContextKey default value condition Should check for `nil` since it is `any`. * fix: don't constrain middlewares' context-keys to strings `context` recommends using "unexported type" as context keys to avoid collisions https://pkg.go.dev/github.com/gofiber/fiber/v2#Ctx.Locals. The official go blog also recommends this https://go.dev/blog/context. `fiber.Ctx.Locals(key any, value any)` correctly allows consumers to use unexported types or e.g. strings. But some fiber middlewares constrain their context-keys to `string` in their "default config structs", making it impossible to use unexported types. This PR removes the `string` _constraint_ from all middlewares, allowing to now use unexported types as per the official guidelines. However the default value is still a string, so it's not a breaking change, and anyone still using strings as context keys is not affected. * 📚 Update app.md for indentation (#2761) Update app.md for indentation * build(deps): bump github.com/google/uuid from 1.4.0 to 1.5.0 (#2762) Bumps [github.com/google/uuid](https://github.com/google/uuid) from 1.4.0 to 1.5.0. - [Release notes](https://github.com/google/uuid/releases) - [Changelog](https://github.com/google/uuid/blob/master/CHANGELOG.md) - [Commits](https://github.com/google/uuid/compare/v1.4.0...v1.5.0) --- updated-dependencies: - dependency-name: github.com/google/uuid dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * build(deps): bump github/codeql-action from 2 to 3 (#2763) Bumps [github/codeql-action](https://github.com/github/codeql-action) from 2 to 3. - [Release notes](https://github.com/github/codeql-action/releases) - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) - [Commits](https://github.com/github/codeql-action/compare/v2...v3) --- updated-dependencies: - dependency-name: github/codeql-action dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Changing default log output (#2730) changing default log output Closes #2729 * Update hooks.md fix wrong hooks signature * 🩹 Fix: CORS middleware should use the defined AllowedOriginsFunc config when AllowedOrigins is empty (#2771) * 🐛 [Bug]: Adaptator + otelfiber issue #2641 (#2772) * 🩹🚨 - fix for redirect with query params (#2748) * redirect with query params did not work, fix it and add test for it * redirect middleware - fix test typo * ♻️ logger/middleware colorize logger error message #2593 (#2773) * ✨ feat: add liveness and readiness checks (#2509) * ✨ feat: add liveness and readiness checkers * 📝 docs: add docs for liveness and readiness * ✨ feat: add options method for probe checkers * ✅ tests: add tests for liveness and readiness * ♻️ refactor: change default endpoint values * ♻️ refactor: change default value for liveness endpoint * 📝 docs: add return status for liveness and readiness probes * ♻️ refactor: change probechecker to middleware * 📝 docs: move docs to middleware session * ♻️ refactor: apply gofumpt formatting * ♻️ refactor: remove unused parameter * split config and apply a review * apply reviews and add testcases * add benchmark * cleanup * rename middleware * fix linter * Update docs and config values * Revert change to IsReady * Updates based on code review * Update docs to match other middlewares --------- Co-authored-by: Muhammed Efe Cetin <efectn@protonmail.com> Co-authored-by: Juan Calderon-Perez <835733+gaby@users.noreply.github.com> Co-authored-by: Juan Calderon-Perez <jgcalderonperez@protonmail.com> * prepare release v2.52.0 - add more Parser tests * fix healthcheck.md * configure workflows for V2 branch * configure workflows for V2 branch * Fix default value to false in docs of QueryBool (#2811) fix default value to false in docs of QueryBool * update queryParser config * Update ctx.md * Update routing.md * merge v2 in v3 * merge v2 in v3 * lint fixes * 📚 Doc: Fix code snippet indentation in /docs/api/middleware/keyauth.md Removes an an extra level of indentation in line 51 of `keyauth.md` [here](https://github.com/gofiber/fiber/blob/v2/docs/api/middleware/keyauth.md?plain=1#L51) * fix: healthcheck middleware not working with route group (#2863) * fix: healthcheck middleware not working with route group * perf: change verification method to improve perf * Update healthcheck_test.go * test: add not matching route test for strict routing * add more test cases * correct tests * correct test helpers * correct tests * correct tests --------- Co-authored-by: Juan Calderon-Perez <835733+gaby@users.noreply.github.com> Co-authored-by: René Werner <rene@gofiber.io> * merge v2 in v3 * Merge pull request from GHSA-fmg4-x8pw-hjhg * Enforce Wildcard Origins with AllowCredentials check * Expand unit-tests, fix issues with subdomains logic, update docs * Update cors.md * Added test using localhost, ipv4, and ipv6 address * improve documentation markdown --------- Co-authored-by: René Werner <rene@gofiber.io> * Update app.go prepare release v2.52.1 * fix cors domain normalize * fix sync-docs workflow * test: fix failing tests * fix sync-docs workflow * test: cors middleware use testify require * chore: fix lint warnings * chore: revert test isolation. * fixed the fasthttp ctx race condition problem * Update middleware/cors/utils.go Co-authored-by: Renan Bastos <renanbastos.tec@gmail.com> * fix sync_docs.sh * fix review comments/hints * fix review comments/hints * stabilize Test_Proxy_Timeout_Slow_Server test * stabilize Test_Proxy_.* tests * ignore bodyclose linter for tests use http.NoBody instead of nil * revert(tests): undo http.NoBody usage * fix(ctx pool): postpone the reset for some values shortly before the release in the pool * refactor(tests): use testify panic method instead of custom solution --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: tokelo-12 <113810058+tokelo-12@users.noreply.github.com> Co-authored-by: Jason McNeil <sixcolors@mac.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: iRedMail <2048991+iredmail@users.noreply.github.com> Co-authored-by: Benjamin Grosse <ste3ls@gmail.com> Co-authored-by: Mehmet Firat KOMURCU <mehmetfiratkomurcu@hotmail.com> Co-authored-by: Bruno <bdm2943@icloud.com> Co-authored-by: Muhammad Kholid B <muhammadkholidb@gmail.com> Co-authored-by: gilwo <gilwo@users.noreply.github.com> Co-authored-by: Lucas Lemos <lucashenriqueblemos@gmail.com> Co-authored-by: Muhammed Efe Cetin <efectn@protonmail.com> Co-authored-by: Juan Calderon-Perez <835733+gaby@users.noreply.github.com> Co-authored-by: Juan Calderon-Perez <jgcalderonperez@protonmail.com> Co-authored-by: Jongmin Kim <kjongmin26@gmail.com> Co-authored-by: Giovanni Rivera <rivera.giovanni271@gmail.com> Co-authored-by: Renan Bastos <renanbastos.tec@gmail.com>
854 lines
22 KiB
Go
854 lines
22 KiB
Go
// ⚡️ Fiber is an Express inspired web framework written in Go with ☕️
|
|
// 📃 Github Repository: https://github.com/gofiber/fiber
|
|
// 📌 API Documentation: https://docs.gofiber.io
|
|
|
|
package fiber
|
|
|
|
import (
|
|
"encoding/json"
|
|
"errors"
|
|
"fmt"
|
|
"io"
|
|
"net/http/httptest"
|
|
"os"
|
|
"testing"
|
|
|
|
"github.com/gofiber/utils/v2"
|
|
"github.com/stretchr/testify/require"
|
|
"github.com/valyala/fasthttp"
|
|
)
|
|
|
|
var routesFixture routeJSON
|
|
|
|
func init() {
|
|
dat, err := os.ReadFile("./.github/testdata/testRoutes.json")
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
if err := json.Unmarshal(dat, &routesFixture); err != nil {
|
|
panic(err)
|
|
}
|
|
}
|
|
|
|
func Test_Route_Match_SameLength(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
app := New()
|
|
|
|
app.Get("/:param", func(c Ctx) error {
|
|
return c.SendString(c.Params("param"))
|
|
})
|
|
|
|
resp, err := app.Test(httptest.NewRequest(MethodGet, "/:param", nil))
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, 200, resp.StatusCode, "Status code")
|
|
|
|
body, err := io.ReadAll(resp.Body)
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, ":param", app.getString(body))
|
|
|
|
// with param
|
|
resp, err = app.Test(httptest.NewRequest(MethodGet, "/test", nil))
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, 200, resp.StatusCode, "Status code")
|
|
|
|
body, err = io.ReadAll(resp.Body)
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, "test", app.getString(body))
|
|
}
|
|
|
|
func Test_Route_Match_Star(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
app := New()
|
|
|
|
app.Get("/*", func(c Ctx) error {
|
|
return c.SendString(c.Params("*"))
|
|
})
|
|
|
|
resp, err := app.Test(httptest.NewRequest(MethodGet, "/*", nil))
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, 200, resp.StatusCode, "Status code")
|
|
|
|
body, err := io.ReadAll(resp.Body)
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, "*", app.getString(body))
|
|
|
|
// with param
|
|
resp, err = app.Test(httptest.NewRequest(MethodGet, "/test", nil))
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, 200, resp.StatusCode, "Status code")
|
|
|
|
body, err = io.ReadAll(resp.Body)
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, "test", app.getString(body))
|
|
|
|
// without parameter
|
|
route := Route{
|
|
star: true,
|
|
path: "/*",
|
|
routeParser: routeParser{},
|
|
}
|
|
params := [maxParams]string{}
|
|
match := route.match("", "", ¶ms)
|
|
require.True(t, match)
|
|
require.Equal(t, [maxParams]string{}, params)
|
|
|
|
// with parameter
|
|
match = route.match("/favicon.ico", "/favicon.ico", ¶ms)
|
|
require.True(t, match)
|
|
require.Equal(t, [maxParams]string{"favicon.ico"}, params)
|
|
|
|
// without parameter again
|
|
match = route.match("", "", ¶ms)
|
|
require.True(t, match)
|
|
require.Equal(t, [maxParams]string{}, params)
|
|
}
|
|
|
|
func Test_Route_Match_Root(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
app := New()
|
|
|
|
app.Get("/", func(c Ctx) error {
|
|
return c.SendString("root")
|
|
})
|
|
|
|
resp, err := app.Test(httptest.NewRequest(MethodGet, "/", nil))
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, 200, resp.StatusCode, "Status code")
|
|
|
|
body, err := io.ReadAll(resp.Body)
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, "root", app.getString(body))
|
|
}
|
|
|
|
func Test_Route_Match_Parser(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
app := New()
|
|
|
|
app.Get("/foo/:ParamName", func(c Ctx) error {
|
|
return c.SendString(c.Params("ParamName"))
|
|
})
|
|
app.Get("/Foobar/*", func(c Ctx) error {
|
|
return c.SendString(c.Params("*"))
|
|
})
|
|
resp, err := app.Test(httptest.NewRequest(MethodGet, "/foo/bar", nil))
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, 200, resp.StatusCode, "Status code")
|
|
|
|
body, err := io.ReadAll(resp.Body)
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, "bar", app.getString(body))
|
|
|
|
// with star
|
|
resp, err = app.Test(httptest.NewRequest(MethodGet, "/Foobar/test", nil))
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, 200, resp.StatusCode, "Status code")
|
|
|
|
body, err = io.ReadAll(resp.Body)
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, "test", app.getString(body))
|
|
}
|
|
|
|
func Test_Route_Match_Middleware(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
app := New()
|
|
|
|
app.Use("/foo/*", func(c Ctx) error {
|
|
return c.SendString(c.Params("*"))
|
|
})
|
|
|
|
resp, err := app.Test(httptest.NewRequest(MethodGet, "/foo/*", nil))
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, 200, resp.StatusCode, "Status code")
|
|
|
|
body, err := io.ReadAll(resp.Body)
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, "*", app.getString(body))
|
|
|
|
// with param
|
|
resp, err = app.Test(httptest.NewRequest(MethodGet, "/foo/bar/fasel", nil))
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, 200, resp.StatusCode, "Status code")
|
|
|
|
body, err = io.ReadAll(resp.Body)
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, "bar/fasel", app.getString(body))
|
|
}
|
|
|
|
func Test_Route_Match_UnescapedPath(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
app := New(Config{UnescapePath: true})
|
|
|
|
app.Use("/créer", func(c Ctx) error {
|
|
return c.SendString("test")
|
|
})
|
|
|
|
resp, err := app.Test(httptest.NewRequest(MethodGet, "/cr%C3%A9er", nil))
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, StatusOK, resp.StatusCode, "Status code")
|
|
|
|
body, err := io.ReadAll(resp.Body)
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, "test", app.getString(body))
|
|
// without special chars
|
|
resp, err = app.Test(httptest.NewRequest(MethodGet, "/créer", nil))
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, StatusOK, resp.StatusCode, "Status code")
|
|
|
|
// check deactivated behavior
|
|
app.config.UnescapePath = false
|
|
resp, err = app.Test(httptest.NewRequest(MethodGet, "/cr%C3%A9er", nil))
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, StatusNotFound, resp.StatusCode, "Status code")
|
|
}
|
|
|
|
func Test_Route_Match_WithEscapeChar(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
app := New()
|
|
// static route and escaped part
|
|
app.Get("/v1/some/resource/name\\:customVerb", func(c Ctx) error {
|
|
return c.SendString("static")
|
|
})
|
|
// group route
|
|
group := app.Group("/v2/\\:firstVerb")
|
|
group.Get("/\\:customVerb", func(c Ctx) error {
|
|
return c.SendString("group")
|
|
})
|
|
// route with resource param and escaped part
|
|
app.Get("/v3/:resource/name\\:customVerb", func(c Ctx) error {
|
|
return c.SendString(c.Params("resource"))
|
|
})
|
|
|
|
// check static route
|
|
resp, err := app.Test(httptest.NewRequest(MethodGet, "/v1/some/resource/name:customVerb", nil))
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, StatusOK, resp.StatusCode, "Status code")
|
|
|
|
body, err := io.ReadAll(resp.Body)
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, "static", app.getString(body))
|
|
|
|
// check group route
|
|
resp, err = app.Test(httptest.NewRequest(MethodGet, "/v2/:firstVerb/:customVerb", nil))
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, StatusOK, resp.StatusCode, "Status code")
|
|
|
|
body, err = io.ReadAll(resp.Body)
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, "group", app.getString(body))
|
|
|
|
// check param route
|
|
resp, err = app.Test(httptest.NewRequest(MethodGet, "/v3/awesome/name:customVerb", nil))
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, StatusOK, resp.StatusCode, "Status code")
|
|
|
|
body, err = io.ReadAll(resp.Body)
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, "awesome", app.getString(body))
|
|
}
|
|
|
|
func Test_Route_Match_Middleware_HasPrefix(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
app := New()
|
|
|
|
app.Use("/foo", func(c Ctx) error {
|
|
return c.SendString("middleware")
|
|
})
|
|
|
|
resp, err := app.Test(httptest.NewRequest(MethodGet, "/foo/bar", nil))
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, 200, resp.StatusCode, "Status code")
|
|
|
|
body, err := io.ReadAll(resp.Body)
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, "middleware", app.getString(body))
|
|
}
|
|
|
|
func Test_Route_Match_Middleware_Root(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
app := New()
|
|
|
|
app.Use("/", func(c Ctx) error {
|
|
return c.SendString("middleware")
|
|
})
|
|
|
|
resp, err := app.Test(httptest.NewRequest(MethodGet, "/everything", nil))
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, 200, resp.StatusCode, "Status code")
|
|
|
|
body, err := io.ReadAll(resp.Body)
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, "middleware", app.getString(body))
|
|
}
|
|
|
|
func Test_Router_Register_Missing_Handler(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
app := New()
|
|
defer func() {
|
|
if err := recover(); err != nil {
|
|
require.Equal(t, "missing handler/middleware in route: /doe\n", fmt.Sprintf("%v", err))
|
|
}
|
|
}()
|
|
app.register([]string{"USE"}, "/doe", nil, nil)
|
|
}
|
|
|
|
func Test_Ensure_Router_Interface_Implementation(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
var app any = (*App)(nil)
|
|
_, ok := app.(Router)
|
|
require.True(t, ok)
|
|
|
|
var group any = (*Group)(nil)
|
|
_, ok = group.(Router)
|
|
require.True(t, ok)
|
|
}
|
|
|
|
func Test_Router_Handler_Catch_Error(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
app := New()
|
|
app.config.ErrorHandler = func(_ Ctx, _ error) error {
|
|
return errors.New("fake error")
|
|
}
|
|
|
|
app.Get("/", func(_ Ctx) error {
|
|
return ErrForbidden
|
|
})
|
|
|
|
c := &fasthttp.RequestCtx{}
|
|
|
|
app.Handler()(c)
|
|
|
|
require.Equal(t, StatusInternalServerError, c.Response.Header.StatusCode())
|
|
}
|
|
|
|
func Test_Route_Static_Root(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
dir := "./.github/testdata/fs/css"
|
|
app := New()
|
|
app.Static("/", dir, Static{
|
|
Browse: true,
|
|
})
|
|
|
|
resp, err := app.Test(httptest.NewRequest(MethodGet, "/", nil))
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, 200, resp.StatusCode, "Status code")
|
|
|
|
resp, err = app.Test(httptest.NewRequest(MethodGet, "/style.css", nil))
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, 200, resp.StatusCode, "Status code")
|
|
|
|
body, err := io.ReadAll(resp.Body)
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Contains(t, app.getString(body), "color")
|
|
|
|
app = New()
|
|
app.Static("/", dir)
|
|
|
|
resp, err = app.Test(httptest.NewRequest(MethodGet, "/", nil))
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, 404, resp.StatusCode, "Status code")
|
|
|
|
resp, err = app.Test(httptest.NewRequest(MethodGet, "/style.css", nil))
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, 200, resp.StatusCode, "Status code")
|
|
|
|
body, err = io.ReadAll(resp.Body)
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Contains(t, app.getString(body), "color")
|
|
}
|
|
|
|
func Test_Route_Static_HasPrefix(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
dir := "./.github/testdata/fs/css"
|
|
app := New()
|
|
app.Static("/static", dir, Static{
|
|
Browse: true,
|
|
})
|
|
|
|
resp, err := app.Test(httptest.NewRequest(MethodGet, "/static", nil))
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, 200, resp.StatusCode, "Status code")
|
|
|
|
resp, err = app.Test(httptest.NewRequest(MethodGet, "/static/", nil))
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, 200, resp.StatusCode, "Status code")
|
|
|
|
resp, err = app.Test(httptest.NewRequest(MethodGet, "/static/style.css", nil))
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, 200, resp.StatusCode, "Status code")
|
|
|
|
body, err := io.ReadAll(resp.Body)
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Contains(t, app.getString(body), "color")
|
|
|
|
app = New()
|
|
app.Static("/static/", dir, Static{
|
|
Browse: true,
|
|
})
|
|
|
|
resp, err = app.Test(httptest.NewRequest(MethodGet, "/static", nil))
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, 200, resp.StatusCode, "Status code")
|
|
|
|
resp, err = app.Test(httptest.NewRequest(MethodGet, "/static/", nil))
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, 200, resp.StatusCode, "Status code")
|
|
|
|
resp, err = app.Test(httptest.NewRequest(MethodGet, "/static/style.css", nil))
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, 200, resp.StatusCode, "Status code")
|
|
|
|
body, err = io.ReadAll(resp.Body)
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Contains(t, app.getString(body), "color")
|
|
|
|
app = New()
|
|
app.Static("/static", dir)
|
|
|
|
resp, err = app.Test(httptest.NewRequest(MethodGet, "/static", nil))
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, 404, resp.StatusCode, "Status code")
|
|
|
|
resp, err = app.Test(httptest.NewRequest(MethodGet, "/static/", nil))
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, 404, resp.StatusCode, "Status code")
|
|
|
|
resp, err = app.Test(httptest.NewRequest(MethodGet, "/static/style.css", nil))
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, 200, resp.StatusCode, "Status code")
|
|
|
|
body, err = io.ReadAll(resp.Body)
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Contains(t, app.getString(body), "color")
|
|
|
|
app = New()
|
|
app.Static("/static/", dir)
|
|
|
|
resp, err = app.Test(httptest.NewRequest(MethodGet, "/static", nil))
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, 404, resp.StatusCode, "Status code")
|
|
|
|
resp, err = app.Test(httptest.NewRequest(MethodGet, "/static/", nil))
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, 404, resp.StatusCode, "Status code")
|
|
|
|
resp, err = app.Test(httptest.NewRequest(MethodGet, "/static/style.css", nil))
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Equal(t, 200, resp.StatusCode, "Status code")
|
|
|
|
body, err = io.ReadAll(resp.Body)
|
|
require.NoError(t, err, "app.Test(req)")
|
|
require.Contains(t, app.getString(body), "color")
|
|
}
|
|
|
|
func Test_Router_NotFound(t *testing.T) {
|
|
app := New()
|
|
app.Use(func(c Ctx) error {
|
|
return c.Next()
|
|
})
|
|
appHandler := app.Handler()
|
|
c := &fasthttp.RequestCtx{}
|
|
|
|
c.Request.Header.SetMethod("DELETE")
|
|
c.URI().SetPath("/this/route/does/not/exist")
|
|
|
|
appHandler(c)
|
|
|
|
require.Equal(t, 404, c.Response.StatusCode())
|
|
require.Equal(t, "Cannot DELETE /this/route/does/not/exist", string(c.Response.Body()))
|
|
}
|
|
|
|
func Test_Router_NotFound_HTML_Inject(t *testing.T) {
|
|
app := New()
|
|
app.Use(func(c Ctx) error {
|
|
return c.Next()
|
|
})
|
|
appHandler := app.Handler()
|
|
c := &fasthttp.RequestCtx{}
|
|
|
|
c.Request.Header.SetMethod("DELETE")
|
|
c.URI().SetPath("/does/not/exist<script>alert('foo');</script>")
|
|
|
|
appHandler(c)
|
|
|
|
require.Equal(t, 404, c.Response.StatusCode())
|
|
require.Equal(t, "Cannot DELETE /does/not/exist<script>alert('foo');</script>", string(c.Response.Body()))
|
|
}
|
|
|
|
//////////////////////////////////////////////
|
|
///////////////// BENCHMARKS /////////////////
|
|
//////////////////////////////////////////////
|
|
|
|
func registerDummyRoutes(app *App) {
|
|
h := func(_ Ctx) error {
|
|
return nil
|
|
}
|
|
for _, r := range routesFixture.GithubAPI {
|
|
app.Add([]string{r.Method}, r.Path, h)
|
|
}
|
|
}
|
|
|
|
// go test -v -run=^$ -bench=Benchmark_App_MethodNotAllowed -benchmem -count=4
|
|
func Benchmark_App_MethodNotAllowed(b *testing.B) {
|
|
app := New()
|
|
h := func(c Ctx) error {
|
|
return c.SendString("Hello World!")
|
|
}
|
|
app.All("/this/is/a/", h)
|
|
app.Get("/this/is/a/dummy/route/oke", h)
|
|
appHandler := app.Handler()
|
|
c := &fasthttp.RequestCtx{}
|
|
|
|
c.Request.Header.SetMethod("DELETE")
|
|
c.URI().SetPath("/this/is/a/dummy/route/oke")
|
|
|
|
b.ResetTimer()
|
|
for n := 0; n < b.N; n++ {
|
|
appHandler(c)
|
|
}
|
|
b.StopTimer()
|
|
require.Equal(b, 405, c.Response.StatusCode())
|
|
require.Equal(b, MethodGet, string(c.Response.Header.Peek("Allow")))
|
|
require.Equal(b, utils.StatusMessage(StatusMethodNotAllowed), string(c.Response.Body()))
|
|
}
|
|
|
|
// go test -v ./... -run=^$ -bench=Benchmark_Router_NotFound -benchmem -count=4
|
|
func Benchmark_Router_NotFound(b *testing.B) {
|
|
app := New()
|
|
app.Use(func(c Ctx) error {
|
|
return c.Next()
|
|
})
|
|
registerDummyRoutes(app)
|
|
appHandler := app.Handler()
|
|
c := &fasthttp.RequestCtx{}
|
|
|
|
c.Request.Header.SetMethod("DELETE")
|
|
c.URI().SetPath("/this/route/does/not/exist")
|
|
|
|
b.ResetTimer()
|
|
for n := 0; n < b.N; n++ {
|
|
appHandler(c)
|
|
}
|
|
require.Equal(b, 404, c.Response.StatusCode())
|
|
require.Equal(b, "Cannot DELETE /this/route/does/not/exist", string(c.Response.Body()))
|
|
}
|
|
|
|
// go test -v ./... -run=^$ -bench=Benchmark_Router_Handler -benchmem -count=4
|
|
func Benchmark_Router_Handler(b *testing.B) {
|
|
app := New()
|
|
registerDummyRoutes(app)
|
|
appHandler := app.Handler()
|
|
|
|
c := &fasthttp.RequestCtx{}
|
|
|
|
c.Request.Header.SetMethod("DELETE")
|
|
c.URI().SetPath("/user/keys/1337")
|
|
|
|
b.ResetTimer()
|
|
|
|
for n := 0; n < b.N; n++ {
|
|
appHandler(c)
|
|
}
|
|
}
|
|
|
|
func Benchmark_Router_Handler_Strict_Case(b *testing.B) {
|
|
app := New(Config{
|
|
StrictRouting: true,
|
|
CaseSensitive: true,
|
|
})
|
|
registerDummyRoutes(app)
|
|
appHandler := app.Handler()
|
|
|
|
c := &fasthttp.RequestCtx{}
|
|
|
|
c.Request.Header.SetMethod("DELETE")
|
|
c.URI().SetPath("/user/keys/1337")
|
|
|
|
b.ResetTimer()
|
|
|
|
for n := 0; n < b.N; n++ {
|
|
appHandler(c)
|
|
}
|
|
}
|
|
|
|
// go test -v ./... -run=^$ -bench=Benchmark_Router_Chain -benchmem -count=4
|
|
func Benchmark_Router_Chain(b *testing.B) {
|
|
app := New()
|
|
handler := func(c Ctx) error {
|
|
return c.Next()
|
|
}
|
|
app.Get("/", handler, handler, handler, handler, handler, handler)
|
|
|
|
appHandler := app.Handler()
|
|
|
|
c := &fasthttp.RequestCtx{}
|
|
|
|
c.Request.Header.SetMethod(MethodGet)
|
|
c.URI().SetPath("/")
|
|
b.ResetTimer()
|
|
for n := 0; n < b.N; n++ {
|
|
appHandler(c)
|
|
}
|
|
}
|
|
|
|
// go test -v ./... -run=^$ -bench=Benchmark_Router_WithCompression -benchmem -count=4
|
|
func Benchmark_Router_WithCompression(b *testing.B) {
|
|
app := New()
|
|
handler := func(c Ctx) error {
|
|
return c.Next()
|
|
}
|
|
app.Get("/", handler)
|
|
app.Get("/", handler)
|
|
app.Get("/", handler)
|
|
app.Get("/", handler)
|
|
app.Get("/", handler)
|
|
app.Get("/", handler)
|
|
|
|
appHandler := app.Handler()
|
|
c := &fasthttp.RequestCtx{}
|
|
|
|
c.Request.Header.SetMethod(MethodGet)
|
|
c.URI().SetPath("/")
|
|
b.ResetTimer()
|
|
for n := 0; n < b.N; n++ {
|
|
appHandler(c)
|
|
}
|
|
}
|
|
|
|
// go test -run=^$ -bench=Benchmark_Startup_Process -benchmem -count=9
|
|
func Benchmark_Startup_Process(b *testing.B) {
|
|
for n := 0; n < b.N; n++ {
|
|
app := New()
|
|
registerDummyRoutes(app)
|
|
app.startupProcess()
|
|
}
|
|
}
|
|
|
|
// go test -v ./... -run=^$ -bench=Benchmark_Router_Next -benchmem -count=4
|
|
func Benchmark_Router_Next(b *testing.B) {
|
|
app := New()
|
|
registerDummyRoutes(app)
|
|
app.startupProcess()
|
|
|
|
request := &fasthttp.RequestCtx{}
|
|
|
|
request.Request.Header.SetMethod("DELETE")
|
|
request.URI().SetPath("/user/keys/1337")
|
|
var res bool
|
|
var err error
|
|
|
|
c := app.AcquireCtx(request).(*DefaultCtx) //nolint:errcheck, forcetypeassert // not needed
|
|
|
|
b.ResetTimer()
|
|
for n := 0; n < b.N; n++ {
|
|
c.indexRoute = -1
|
|
res, err = app.next(c)
|
|
}
|
|
require.NoError(b, err)
|
|
require.True(b, res)
|
|
require.Equal(b, 4, c.indexRoute)
|
|
}
|
|
|
|
// go test -v ./... -run=^$ -bench=Benchmark_Route_Match -benchmem -count=4
|
|
func Benchmark_Route_Match(b *testing.B) {
|
|
var match bool
|
|
var params [maxParams]string
|
|
|
|
parsed := parseRoute("/user/keys/:id")
|
|
route := &Route{
|
|
use: false,
|
|
root: false,
|
|
star: false,
|
|
routeParser: parsed,
|
|
Params: parsed.params,
|
|
path: "/user/keys/:id",
|
|
|
|
Path: "/user/keys/:id",
|
|
Method: "DELETE",
|
|
}
|
|
route.Handlers = append(route.Handlers, func(_ Ctx) error {
|
|
return nil
|
|
})
|
|
b.ResetTimer()
|
|
for n := 0; n < b.N; n++ {
|
|
match = route.match("/user/keys/1337", "/user/keys/1337", ¶ms)
|
|
}
|
|
|
|
require.True(b, match)
|
|
require.Equal(b, []string{"1337"}, params[0:len(parsed.params)])
|
|
}
|
|
|
|
// go test -v ./... -run=^$ -bench=Benchmark_Route_Match_Star -benchmem -count=4
|
|
func Benchmark_Route_Match_Star(b *testing.B) {
|
|
var match bool
|
|
var params [maxParams]string
|
|
|
|
parsed := parseRoute("/*")
|
|
route := &Route{
|
|
use: false,
|
|
root: false,
|
|
star: true,
|
|
routeParser: parsed,
|
|
Params: parsed.params,
|
|
path: "/user/keys/bla",
|
|
|
|
Path: "/user/keys/bla",
|
|
Method: "DELETE",
|
|
}
|
|
route.Handlers = append(route.Handlers, func(_ Ctx) error {
|
|
return nil
|
|
})
|
|
b.ResetTimer()
|
|
|
|
for n := 0; n < b.N; n++ {
|
|
match = route.match("/user/keys/bla", "/user/keys/bla", ¶ms)
|
|
}
|
|
|
|
require.True(b, match)
|
|
require.Equal(b, []string{"user/keys/bla"}, params[0:len(parsed.params)])
|
|
}
|
|
|
|
// go test -v ./... -run=^$ -bench=Benchmark_Route_Match_Root -benchmem -count=4
|
|
func Benchmark_Route_Match_Root(b *testing.B) {
|
|
var match bool
|
|
var params [maxParams]string
|
|
|
|
parsed := parseRoute("/")
|
|
route := &Route{
|
|
use: false,
|
|
root: true,
|
|
star: false,
|
|
path: "/",
|
|
routeParser: parsed,
|
|
Params: parsed.params,
|
|
|
|
Path: "/",
|
|
Method: "DELETE",
|
|
}
|
|
route.Handlers = append(route.Handlers, func(_ Ctx) error {
|
|
return nil
|
|
})
|
|
|
|
b.ResetTimer()
|
|
|
|
for n := 0; n < b.N; n++ {
|
|
match = route.match("/", "/", ¶ms)
|
|
}
|
|
|
|
require.True(b, match)
|
|
require.Equal(b, []string{}, params[0:len(parsed.params)])
|
|
}
|
|
|
|
// go test -v ./... -run=^$ -bench=Benchmark_Router_Handler_CaseSensitive -benchmem -count=4
|
|
func Benchmark_Router_Handler_CaseSensitive(b *testing.B) {
|
|
app := New()
|
|
app.config.CaseSensitive = true
|
|
registerDummyRoutes(app)
|
|
appHandler := app.Handler()
|
|
|
|
c := &fasthttp.RequestCtx{}
|
|
|
|
c.Request.Header.SetMethod("DELETE")
|
|
c.URI().SetPath("/user/keys/1337")
|
|
|
|
b.ResetTimer()
|
|
|
|
for n := 0; n < b.N; n++ {
|
|
appHandler(c)
|
|
}
|
|
}
|
|
|
|
// go test -v ./... -run=^$ -bench=Benchmark_Router_Handler_Unescape -benchmem -count=4
|
|
func Benchmark_Router_Handler_Unescape(b *testing.B) {
|
|
app := New()
|
|
app.config.UnescapePath = true
|
|
registerDummyRoutes(app)
|
|
app.Delete("/créer", func(_ Ctx) error {
|
|
return nil
|
|
})
|
|
|
|
appHandler := app.Handler()
|
|
|
|
c := &fasthttp.RequestCtx{}
|
|
|
|
c.Request.Header.SetMethod(MethodDelete)
|
|
c.URI().SetPath("/cr%C3%A9er")
|
|
|
|
b.ResetTimer()
|
|
|
|
for n := 0; n < b.N; n++ {
|
|
c.URI().SetPath("/cr%C3%A9er")
|
|
appHandler(c)
|
|
}
|
|
}
|
|
|
|
// go test -run=^$ -bench=Benchmark_Router_Handler_StrictRouting -benchmem -count=4
|
|
func Benchmark_Router_Handler_StrictRouting(b *testing.B) {
|
|
app := New()
|
|
app.config.CaseSensitive = true
|
|
registerDummyRoutes(app)
|
|
appHandler := app.Handler()
|
|
|
|
c := &fasthttp.RequestCtx{}
|
|
|
|
c.Request.Header.SetMethod("DELETE")
|
|
c.URI().SetPath("/user/keys/1337")
|
|
|
|
b.ResetTimer()
|
|
|
|
for n := 0; n < b.N; n++ {
|
|
appHandler(c)
|
|
}
|
|
}
|
|
|
|
// go test -run=^$ -bench=Benchmark_Router_Github_API -benchmem -count=16
|
|
func Benchmark_Router_Github_API(b *testing.B) {
|
|
app := New()
|
|
registerDummyRoutes(app)
|
|
app.startupProcess()
|
|
|
|
c := &fasthttp.RequestCtx{}
|
|
var match bool
|
|
var err error
|
|
|
|
b.ResetTimer()
|
|
|
|
for i := range routesFixture.TestRoutes {
|
|
c.Request.Header.SetMethod(routesFixture.TestRoutes[i].Method)
|
|
for n := 0; n < b.N; n++ {
|
|
c.URI().SetPath(routesFixture.TestRoutes[i].Path)
|
|
|
|
ctx := app.AcquireCtx(c).(*DefaultCtx) //nolint:errcheck, forcetypeassert // not needed
|
|
|
|
match, err = app.next(ctx)
|
|
app.ReleaseCtx(ctx)
|
|
}
|
|
|
|
require.NoError(b, err)
|
|
require.True(b, match)
|
|
}
|
|
}
|
|
|
|
type testRoute struct {
|
|
Method string `json:"method"`
|
|
Path string `json:"path"`
|
|
}
|
|
|
|
type routeJSON struct {
|
|
TestRoutes []testRoute `json:"test_routes"`
|
|
GithubAPI []testRoute `json:"github_api"`
|
|
}
|