Skip to content

Commit

Permalink
fixes #3038 "v3 Flash Message with redirect is not working" (#3046)
Browse files Browse the repository at this point in the history 
* fixes #3038
🐞 [Bug]: v3 Flash Message with redirect is not working #3038

* fixes #3038
🐞 [Bug]: v3 Flash Message with redirect is not working #3038
  • Loading branch information
@ReneWerner87
ReneWerner87 authored Jun 28, 2024
1 parent 2db1858 commit dbba6cf
Show file tree
Hide file tree
Showing 3 changed files with 116 additions and 48 deletions.
74 changes: 40 additions & 34 deletions redirect.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,8 @@ func (r *Redirect) To(location string) error {
r.c.setCanonical(HeaderLocation, location)
r.c.Status(r.status)

r.processFlashMessages()

return nil
}

Expand All @@ -200,38 +202,6 @@ func (r *Redirect) Route(name string, config ...RedirectConfig) error {
return err
}

// Flash messages
if len(r.messages) > 0 || len(r.oldInput) > 0 {
messageText := bytebufferpool.Get()
defer bytebufferpool.Put(messageText)

// flash messages
for i, message := range r.messages {
messageText.WriteString(message)
// when there are more messages or oldInput -> add a comma
if len(r.messages)-1 != i || (len(r.messages)-1 == i && len(r.oldInput) > 0) {
messageText.WriteString(CookieDataSeparator)
}
}
r.messages = r.messages[:0]

// old input data
i := 1
for k, v := range r.oldInput {
messageText.WriteString(OldInputDataPrefix + k + CookieDataAssigner + v)
if len(r.oldInput) != i {
messageText.WriteString(CookieDataSeparator)
}
i++
}

r.c.Cookie(&Cookie{
Name: FlashCookieName,
Value: r.c.app.getString(messageText.Bytes()),
SessionOnly: true,
})
}

// Check queries
if len(cfg.Queries) > 0 {
queryText := bytebufferpool.Get()
Expand Down Expand Up @@ -270,8 +240,8 @@ func (r *Redirect) Back(fallback ...string) error {
return r.To(location)
}

// setFlash is a method to get flash messages before removing them
func (r *Redirect) setFlash() {
// parseAndClearFlashMessages is a method to get flash messages before removing them
func (r *Redirect) parseAndClearFlashMessages() {
// parse flash messages
cookieValue := r.c.Cookies(FlashCookieName)

Expand All @@ -289,6 +259,42 @@ func (r *Redirect) setFlash() {
r.c.ClearCookie(FlashCookieName)
}

// processFlashMessages is a helper function to process flash messages and old input data
// and set them as cookies
func (r *Redirect) processFlashMessages() {
// Flash messages
if len(r.messages) > 0 || len(r.oldInput) > 0 {
messageText := bytebufferpool.Get()
defer bytebufferpool.Put(messageText)

// flash messages
for i, message := range r.messages {
messageText.WriteString(message)
// when there are more messages or oldInput -> add a comma
if len(r.messages)-1 != i || (len(r.messages)-1 == i && len(r.oldInput) > 0) {
messageText.WriteString(CookieDataSeparator)
}
}
r.messages = r.messages[:0]

// old input data
i := 1
for k, v := range r.oldInput {
messageText.WriteString(OldInputDataPrefix + k + CookieDataAssigner + v)
if len(r.oldInput) != i {
messageText.WriteString(CookieDataSeparator)
}
i++
}

r.c.Cookie(&Cookie{
Name: FlashCookieName,
Value: r.c.app.getString(messageText.Bytes()),
SessionOnly: true,
})
}
}

// parseMessage is a helper function to parse flash messages and old input data
func parseMessage(raw string) (string, string) { //nolint: revive // not necessary
if i := findNextNonEscapedCharsetPosition(raw, []byte(CookieDataAssigner)); i != -1 {
Expand Down
88 changes: 75 additions & 13 deletions redirect_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,24 @@ func Test_Redirect_To(t *testing.T) {
require.Equal(t, "http://example.com", string(c.Response().Header.Peek(HeaderLocation)))
}

// go test -run Test_Redirect_To_WithFlashMessages
func Test_Redirect_To_WithFlashMessages(t *testing.T) {
t.Parallel()
app := New()
c := app.AcquireCtx(&fasthttp.RequestCtx{})

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

equal := c.GetRespHeader(HeaderSetCookie) == "fiber_flash=success:1,message:test; path=/; SameSite=Lax" || c.GetRespHeader(HeaderSetCookie) == "fiber_flash=message:test,success:1; path=/; SameSite=Lax"
require.True(t, equal)

c.Redirect().parseAndClearFlashMessages()
require.Equal(t, "fiber_flash=; expires=Tue, 10 Nov 2009 23:00:00 GMT", c.GetRespHeader(HeaderSetCookie))
}

// go test -run Test_Redirect_Route_WithParams
func Test_Redirect_Route_WithParams(t *testing.T) {
t.Parallel()
Expand Down Expand Up @@ -149,6 +167,29 @@ func Test_Redirect_Back(t *testing.T) {
require.ErrorAs(t, err, &ErrRedirectBackNoFallback)
}

// go test -run Test_Redirect_Back_WithFlashMessages
func Test_Redirect_Back_WithFlashMessages(t *testing.T) {
t.Parallel()

app := New()
app.Get("/user", func(c Ctx) error {
return c.SendString("user")
}).Name("user")

c := app.AcquireCtx(&fasthttp.RequestCtx{}).(*DefaultCtx) //nolint:errcheck, forcetypeassert // not needed

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

equal := c.GetRespHeader(HeaderSetCookie) == "fiber_flash=success:1,message:test; path=/; SameSite=Lax" || c.GetRespHeader(HeaderSetCookie) == "fiber_flash=message:test,success:1; path=/; SameSite=Lax"
require.True(t, equal)

c.Redirect().parseAndClearFlashMessages()
require.Equal(t, "fiber_flash=; expires=Tue, 10 Nov 2009 23:00:00 GMT", c.GetRespHeader(HeaderSetCookie))
}

// go test -run Test_Redirect_Back_WithReferer
func Test_Redirect_Back_WithReferer(t *testing.T) {
t.Parallel()
Expand Down Expand Up @@ -188,7 +229,7 @@ func Test_Redirect_Route_WithFlashMessages(t *testing.T) {
equal := c.GetRespHeader(HeaderSetCookie) == "fiber_flash=success:1,message:test; path=/; SameSite=Lax" || c.GetRespHeader(HeaderSetCookie) == "fiber_flash=message:test,success:1; path=/; SameSite=Lax"
require.True(t, equal)

c.Redirect().setFlash()
c.Redirect().parseAndClearFlashMessages()
require.Equal(t, "fiber_flash=; expires=Tue, 10 Nov 2009 23:00:00 GMT", c.GetRespHeader(HeaderSetCookie))
}

Expand Down Expand Up @@ -216,12 +257,12 @@ func Test_Redirect_Route_WithOldInput(t *testing.T) {
require.Contains(t, c.GetRespHeader(HeaderSetCookie), ",old_input_data_id:1")
require.Contains(t, c.GetRespHeader(HeaderSetCookie), ",old_input_data_name:tom")

c.Redirect().setFlash()
c.Redirect().parseAndClearFlashMessages()
require.Equal(t, "fiber_flash=; expires=Tue, 10 Nov 2009 23:00:00 GMT", c.GetRespHeader(HeaderSetCookie))
}

// go test -run Test_Redirect_setFlash
func Test_Redirect_setFlash(t *testing.T) {
// go test -run Test_Redirect_parseAndClearFlashMessages
func Test_Redirect_parseAndClearFlashMessages(t *testing.T) {
t.Parallel()

app := New()
Expand All @@ -233,7 +274,7 @@ func Test_Redirect_setFlash(t *testing.T) {

c.Request().Header.Set(HeaderCookie, "fiber_flash=success:1,message:test,old_input_data_name:tom,old_input_data_id:1")

c.Redirect().setFlash()
c.Redirect().parseAndClearFlashMessages()

require.Equal(t, "fiber_flash=; expires=Tue, 10 Nov 2009 23:00:00 GMT", c.GetRespHeader(HeaderSetCookie))

Expand Down Expand Up @@ -416,12 +457,12 @@ func Benchmark_Redirect_Route_WithFlashMessages(b *testing.B) {
equal := c.GetRespHeader(HeaderSetCookie) == "fiber_flash=success:1,message:test; path=/; SameSite=Lax" || c.GetRespHeader(HeaderSetCookie) == "fiber_flash=message:test,success:1; path=/; SameSite=Lax"
require.True(b, equal)

c.Redirect().setFlash()
c.Redirect().parseAndClearFlashMessages()
require.Equal(b, "fiber_flash=; expires=Tue, 10 Nov 2009 23:00:00 GMT", c.GetRespHeader(HeaderSetCookie))
}

// go test -v -run=^$ -bench=Benchmark_Redirect_setFlash -benchmem -count=4
func Benchmark_Redirect_setFlash(b *testing.B) {
// go test -v -run=^$ -bench=Benchmark_Redirect_parseAndClearFlashMessages -benchmem -count=4
func Benchmark_Redirect_parseAndClearFlashMessages(b *testing.B) {
app := New()
app.Get("/user", func(c Ctx) error {
return c.SendString("user")
Expand All @@ -435,7 +476,7 @@ func Benchmark_Redirect_setFlash(b *testing.B) {
b.ResetTimer()

for n := 0; n < b.N; n++ {
c.Redirect().setFlash()
c.Redirect().parseAndClearFlashMessages()
}

require.Equal(b, "fiber_flash=; expires=Tue, 10 Nov 2009 23:00:00 GMT", c.GetRespHeader(HeaderSetCookie))
Expand All @@ -449,6 +490,27 @@ func Benchmark_Redirect_setFlash(b *testing.B) {
require.Equal(b, map[string]string{"id": "1", "name": "tom"}, c.Redirect().OldInputs())
}

// go test -v -run=^$ -bench=Benchmark_Redirect_processFlashMessages -benchmem -count=4
func Benchmark_Redirect_processFlashMessages(b *testing.B) {
app := New()
app.Get("/user", func(c Ctx) error {
return c.SendString("user")
}).Name("user")

c := app.AcquireCtx(&fasthttp.RequestCtx{}).(*DefaultCtx) //nolint:errcheck, forcetypeassert // not needed

c.Redirect().With("success", "1").With("message", "test")

b.ReportAllocs()
b.ResetTimer()

for n := 0; n < b.N; n++ {
c.Redirect().processFlashMessages()
}

require.Equal(b, "fiber_flash=success:1,message:test; path=/; SameSite=Lax", c.GetRespHeader(HeaderSetCookie))
}

// go test -v -run=^$ -bench=Benchmark_Redirect_Messages -benchmem -count=4
func Benchmark_Redirect_Messages(b *testing.B) {
app := New()
Expand All @@ -459,7 +521,7 @@ func Benchmark_Redirect_Messages(b *testing.B) {
c := app.AcquireCtx(&fasthttp.RequestCtx{}).(*DefaultCtx) //nolint:errcheck, forcetypeassert // not needed

c.Request().Header.Set(HeaderCookie, "fiber_flash=success:1,message:test,old_input_data_name:tom,old_input_data_id:1")
c.Redirect().setFlash()
c.Redirect().parseAndClearFlashMessages()

var msgs map[string]string

Expand All @@ -484,7 +546,7 @@ func Benchmark_Redirect_OldInputs(b *testing.B) {
c := app.AcquireCtx(&fasthttp.RequestCtx{}).(*DefaultCtx) //nolint:errcheck, forcetypeassert // not needed

c.Request().Header.Set(HeaderCookie, "fiber_flash=success:1,message:test,old_input_data_name:tom,old_input_data_id:1")
c.Redirect().setFlash()
c.Redirect().parseAndClearFlashMessages()

var oldInputs map[string]string

Expand All @@ -509,7 +571,7 @@ func Benchmark_Redirect_Message(b *testing.B) {
c := app.AcquireCtx(&fasthttp.RequestCtx{}).(*DefaultCtx) //nolint:errcheck, forcetypeassert // not needed

c.Request().Header.Set(HeaderCookie, "fiber_flash=success:1,message:test,old_input_data_name:tom,old_input_data_id:1")
c.Redirect().setFlash()
c.Redirect().parseAndClearFlashMessages()

var msg string

Expand All @@ -534,7 +596,7 @@ func Benchmark_Redirect_OldInput(b *testing.B) {
c := app.AcquireCtx(&fasthttp.RequestCtx{}).(*DefaultCtx) //nolint:errcheck, forcetypeassert // not needed

c.Request().Header.Set(HeaderCookie, "fiber_flash=success:1,message:test,old_input_data_name:tom,old_input_data_id:1")
c.Redirect().setFlash()
c.Redirect().parseAndClearFlashMessages()

var input string

Expand Down
2 changes: 1 addition & 1 deletion router.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ func (app *App) requestHandler(rctx *fasthttp.RequestCtx) {

// check flash messages
if strings.Contains(utils.UnsafeString(c.Request().Header.RawHeaders()), FlashCookieName) {
c.Redirect().setFlash()
c.Redirect().parseAndClearFlashMessages()
}

// Find match in stack
Expand Down

0 comments on commit dbba6cf

Please sign in to comment.