Skip to content

♻️ refactor: Change c.Redirect() default status #3415

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

♻️ refactor: Change c.Redirect() default status #3415

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
54e8138
Set default redirect response status to 303 SeeOther
andradei Apr 18, 2025
1140672
Add tests to Redirect default status change.
andradei Apr 19, 2025
2779e5c
Update docs.
andradei Apr 19, 2025
b17b5ad
Fix remaining tests to reflect redirect 303 status as the new default…
andradei Apr 19, 2025
cf68f93
Update redirect_test.go
gaby Apr 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/api/redirect.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The redirect methods are used to redirect the context (request) to a different U
Redirects to the URL derived from the specified path, with a specified [status](#status), a positive integer that corresponds to an HTTP status code.

:::info
If **not** specified, status defaults to **302 Found**.
If **not** specified, status defaults to **303 See Other**.
:::

```go title="Signature"
Expand All @@ -24,7 +24,7 @@ func (r *Redirect) To(location string) error

```go title="Example"
app.Get("/coffee", func(c fiber.Ctx) error {
// => HTTP - GET 301 /teapot
// => HTTP - GET 301 /teapot
return c.Redirect().Status(fiber.StatusMovedPermanently).To("/teapot")
})

Expand All @@ -35,11 +35,11 @@ app.Get("/teapot", func(c fiber.Ctx) error {

```go title="More examples"
app.Get("/", func(c fiber.Ctx) error {
// => HTTP - GET 302 /foo/bar
// => HTTP - GET 303 /foo/bar
return c.Redirect().To("/foo/bar")
// => HTTP - GET 302 ../login
// => HTTP - GET 303 ../login
return c.Redirect().To("../login")
// => HTTP - GET 302 http://example.com
// => HTTP - GET 303 http://example.com
return c.Redirect().To("http://example.com")
// => HTTP - GET 301 https://example.com
return c.Redirect().Status(301).To("http://example.com")
Expand Down Expand Up @@ -92,7 +92,7 @@ app.Get("/user/:name", func(c fiber.Ctx) error {
Redirects back to the referer URL. It redirects to a fallback URL if the referer header doesn't exist, with a specified status, a positive integer that corresponds to an HTTP status code.

:::info
If **not** specified, status defaults to **302 Found**.
If **not** specified, status defaults to **303 See Other**.
:::

```go title="Signature"
Expand Down Expand Up @@ -134,7 +134,7 @@ func (r *Redirect) Status(status int) *Redirect

```go title="Example"
app.Get("/coffee", func(c fiber.Ctx) error {
// => HTTP - GET 301 /teapot
// => HTTP - GET 301 /teapot
return c.Redirect().Status(fiber.StatusMovedPermanently).To("/teapot")
})
```
Expand Down
8 changes: 4 additions & 4 deletions redirect.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import (
var redirectPool = sync.Pool{
New: func() any {
return &Redirect{
status: StatusFound,
status: StatusSeeOther,
messages: make(redirectionMsgs, 0),
}
},
Expand Down Expand Up @@ -61,7 +61,7 @@ type FlashMessage struct {
type Redirect struct {
c *DefaultCtx // Embed ctx
messages redirectionMsgs // Flash messages and old input data
status int // Status code of redirection. Default: StatusFound
status int // Status code of redirection. Default: 303 StatusSeeOther
}

// RedirectConfig A config to use with Redirect().Route()
Expand Down Expand Up @@ -92,13 +92,13 @@ func ReleaseRedirect(r *Redirect) {
}

func (r *Redirect) release() {
r.status = 302
r.status = StatusSeeOther
r.messages = r.messages[:0]
r.c = nil
}

// Status sets the status code of redirection.
// If status is not specified, status defaults to 302 Found.
// If status is not specified, status defaults to 303 See Other.
func (r *Redirect) Status(code int) *Redirect {
r.status = code

Expand Down
34 changes: 17 additions & 17 deletions redirect_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ func Test_Redirect_To(t *testing.T) {

err := c.Redirect().To("http://default.com")
require.NoError(t, err)
require.Equal(t, 302, c.Response().StatusCode())
require.Equal(t, 303, c.Response().StatusCode())
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use fiber.StatusSeeOther

require.Equal(t, "http://default.com", string(c.Response().Header.Peek(HeaderLocation)))

err = c.Redirect().Status(301).To("http://example.com")
Expand All @@ -39,7 +39,7 @@ func Test_Redirect_To_WithFlashMessages(t *testing.T) {

err := c.Redirect().With("success", "2").With("success", "1").With("message", "test", 2).To("http://example.com")
require.NoError(t, err)
require.Equal(t, 302, c.Response().StatusCode())
require.Equal(t, 303, c.Response().StatusCode())
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use fiber.StatusSeeOther

require.Equal(t, "http://example.com", string(c.Response().Header.Peek(HeaderLocation)))

c.RequestCtx().Request.Header.Set(HeaderCookie, c.GetRespHeader(HeaderSetCookie)) // necessary for testing
Expand Down Expand Up @@ -68,7 +68,7 @@ func Test_Redirect_Route_WithParams(t *testing.T) {
},
})
require.NoError(t, err)
require.Equal(t, 302, c.Response().StatusCode())
require.Equal(t, 303, c.Response().StatusCode())
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use fiber.StatusSeeOther

require.Equal(t, "/user/fiber", string(c.Response().Header.Peek(HeaderLocation)))
}

Expand All @@ -88,7 +88,7 @@ func Test_Redirect_Route_WithParams_WithQueries(t *testing.T) {
Queries: map[string]string{"data[0][name]": "john", "data[0][age]": "10", "test": "doe"},
})
require.NoError(t, err)
require.Equal(t, 302, c.Response().StatusCode())
require.Equal(t, 303, c.Response().StatusCode())

// analysis of query parameters with url parsing, since a map pass is always randomly ordered
location, err := url.Parse(string(c.Response().Header.Peek(HeaderLocation)))
Expand All @@ -112,7 +112,7 @@ func Test_Redirect_Route_WithOptionalParams(t *testing.T) {
},
})
require.NoError(t, err)
require.Equal(t, 302, c.Response().StatusCode())
require.Equal(t, 303, c.Response().StatusCode())
require.Equal(t, "/user/fiber", string(c.Response().Header.Peek(HeaderLocation)))
}

Expand All @@ -127,7 +127,7 @@ func Test_Redirect_Route_WithOptionalParamsWithoutValue(t *testing.T) {

err := c.Redirect().Route("user")
require.NoError(t, err)
require.Equal(t, 302, c.Response().StatusCode())
require.Equal(t, 303, c.Response().StatusCode())
require.Equal(t, "/user/", string(c.Response().Header.Peek(HeaderLocation)))
}

Expand All @@ -146,7 +146,7 @@ func Test_Redirect_Route_WithGreedyParameters(t *testing.T) {
},
})
require.NoError(t, err)
require.Equal(t, 302, c.Response().StatusCode())
require.Equal(t, 303, c.Response().StatusCode())
require.Equal(t, "/user/test/routes", string(c.Response().Header.Peek(HeaderLocation)))
}

Expand All @@ -161,7 +161,7 @@ func Test_Redirect_Back(t *testing.T) {

err := c.Redirect().Back("/")
require.NoError(t, err)
require.Equal(t, 302, c.Response().StatusCode())
require.Equal(t, 303, c.Response().StatusCode())
require.Equal(t, "/", string(c.Response().Header.Peek(HeaderLocation)))

err = c.Redirect().Back()
Expand All @@ -182,7 +182,7 @@ func Test_Redirect_Back_WithFlashMessages(t *testing.T) {

err := c.Redirect().With("success", "1").With("message", "test").Back("/")
require.NoError(t, err)
require.Equal(t, 302, c.Response().StatusCode())
require.Equal(t, 303, c.Response().StatusCode())
require.Equal(t, "/", string(c.Response().Header.Peek(HeaderLocation)))

c.RequestCtx().Request.Header.Set(HeaderCookie, c.GetRespHeader(HeaderSetCookie)) // necessary for testing
Expand Down Expand Up @@ -211,7 +211,7 @@ func Test_Redirect_Back_WithReferer(t *testing.T) {
c.Request().Header.Set(HeaderReferer, "/back")
err := c.Redirect().Back("/")
require.NoError(t, err)
require.Equal(t, 302, c.Response().StatusCode())
require.Equal(t, 303, c.Response().StatusCode())
require.Equal(t, "/back", c.Get(HeaderReferer))
require.Equal(t, "/back", string(c.Response().Header.Peek(HeaderLocation)))
}
Expand All @@ -233,7 +233,7 @@ func Test_Redirect_Route_WithFlashMessages(t *testing.T) {
require.Contains(t, c.redirect.messages, redirectionMsg{key: "message", value: "test", level: 0, isOldInput: false})

require.NoError(t, err)
require.Equal(t, 302, c.Response().StatusCode())
require.Equal(t, 303, c.Response().StatusCode())
require.Equal(t, "/user", string(c.Response().Header.Peek(HeaderLocation)))

c.RequestCtx().Request.Header.Set(HeaderCookie, c.GetRespHeader(HeaderSetCookie)) // necessary for testing
Expand Down Expand Up @@ -270,7 +270,7 @@ func Test_Redirect_Route_WithOldInput(t *testing.T) {
require.Contains(t, c.redirect.messages, redirectionMsg{key: "name", value: "tom", isOldInput: true})

require.NoError(t, err)
require.Equal(t, 302, c.Response().StatusCode())
require.Equal(t, 303, c.Response().StatusCode())
require.Equal(t, "/user", string(c.Response().Header.Peek(HeaderLocation)))

c.RequestCtx().Request.Header.Set(HeaderCookie, c.GetRespHeader(HeaderSetCookie)) // necessary for testing
Expand Down Expand Up @@ -306,7 +306,7 @@ func Test_Redirect_Route_WithOldInput(t *testing.T) {
require.Contains(t, c.redirect.messages, redirectionMsg{key: "name", value: "tom", isOldInput: true})

require.NoError(t, err)
require.Equal(t, 302, c.Response().StatusCode())
require.Equal(t, 303, c.Response().StatusCode())
require.Equal(t, "/user", string(c.Response().Header.Peek(HeaderLocation)))

c.RequestCtx().Request.Header.Set(HeaderCookie, c.GetRespHeader(HeaderSetCookie)) // necessary for testing
Expand Down Expand Up @@ -350,7 +350,7 @@ func Test_Redirect_Route_WithOldInput(t *testing.T) {
require.Contains(t, c.redirect.messages, redirectionMsg{key: "name", value: "tom", isOldInput: true})

require.NoError(t, err)
require.Equal(t, 302, c.Response().StatusCode())
require.Equal(t, 303, c.Response().StatusCode())
require.Equal(t, "/user", string(c.Response().Header.Peek(HeaderLocation)))

c.RequestCtx().Request.Header.Set(HeaderCookie, c.GetRespHeader(HeaderSetCookie)) // necessary for testing
Expand Down Expand Up @@ -480,7 +480,7 @@ func Benchmark_Redirect_Route(b *testing.B) {
}

require.NoError(b, err)
require.Equal(b, 302, c.Response().StatusCode())
require.Equal(b, 303, c.Response().StatusCode())
require.Equal(b, "/user/fiber", string(c.Response().Header.Peek(HeaderLocation)))
}

Expand Down Expand Up @@ -508,7 +508,7 @@ func Benchmark_Redirect_Route_WithQueries(b *testing.B) {
}

require.NoError(b, err)
require.Equal(b, 302, c.Response().StatusCode())
require.Equal(b, 303, c.Response().StatusCode())
// analysis of query parameters with url parsing, since a map pass is always randomly ordered
location, err := url.Parse(string(c.Response().Header.Peek(HeaderLocation)))
require.NoError(b, err, "url.Parse(location)")
Expand All @@ -535,7 +535,7 @@ func Benchmark_Redirect_Route_WithFlashMessages(b *testing.B) {
}

require.NoError(b, err)
require.Equal(b, 302, c.Response().StatusCode())
require.Equal(b, 303, c.Response().StatusCode())
require.Equal(b, "/user", string(c.Response().Header.Peek(HeaderLocation)))

c.RequestCtx().Request.Header.Set(HeaderCookie, c.GetRespHeader(HeaderSetCookie)) // necessary for testing
Expand Down
Loading