✨ feature: add initial support for hooks

[efectn]

Simple Usage:

func main() {
	app := fiber.New()

	app.OnResponse(func(c *fiber.Ctx, m fiber.Map) error {
		fmt.Print(c.Route())

		return nil
	})

	app.OnRoute(func(c *fiber.Ctx, m fiber.Map) error {
		fmt.Print(m)

		return nil
	})

	app.OnName(func(c *fiber.Ctx, m fiber.Map) error {
		fmt.Print(m)

		return nil
	})

	app.Get("/", func(c *fiber.Ctx) error {
		return c.SendString("-")
	}).Name("index")

	app.Listen(":5000")
}

Closes: #1758

To-Do List:

• Add detailed tests.
• Comment lines.
• Create documentations.

[ReneWerner87]

gave him some tasks to move all the code into a separate struct called hooks.go(+tests) and thus reduce the size of the file for the app

@hi019 what do you think about the different hooks

[hi019]

Will look tomorrow

[hi019]

Looks good, I'll test it out tomorrow. But why do we need OnResponse/OnRequest when the same thing can be done with a middleware? Also what about changing the hook signature to not return anything, so that the hook handles any errors itself?

[efectn]

Looks good, I'll test it out tomorrow. But why do we need OnResponse/OnRequest when the same thing can be done with a middleware? Also what about changing the hook signature to not return anything, so that the hook handles any errors itself?

OnX methods don't return anything already.
Right about onResponse/onRequest, i can remove them.

[hi019]

I mean HookHandler:

 type HookHandler = func(*Ctx, Map) error

[efectn]

I mean HookHandler:

 type HookHandler = func(*Ctx, Map) error

i thought handling OnRoute and OnListen errors would be useful but if you're not OK, i can remove them.

[hi019]

Actually, I think the current implementation is fine. I'll finish the review tomorrow

[hi019]

What about using a struct instead of a map for the hook function params, to provide better type safety? It would be nice if each hook had its own struct. Also this print statement seems to be executed twice:

package main

import (
	"fmt"
	"log"

	"github.com/gofiber/fiber/v2"
)

func main() {
	app := fiber.New(fiber.Config{DisableStartupMessage: true})

	app.Hooks().OnRoute(func(c *fiber.Ctx, m fiber.Map) error {
		fmt.Println(m["route"].(fiber.Route).Path)

		return nil
	})

	app.Get("/hello", h)
	log.Fatal(app.Listen(":3001"))
}

func h(c *fiber.Ctx) error {
	return c.Status(fiber.StatusOK).SendString("Hello")
}

It's because app.register is being called twice somehow. Still looking into that

[efectn]

What about using a struct instead of a map for the hook function params, to provide better type safety? It would be nice if each hook had its own struct. Also this print statement seems to be executed twice:

package main

import (
	"fmt"
	"log"

	"github.com/gofiber/fiber/v2"
)

func main() {
	app := fiber.New(fiber.Config{DisableStartupMessage: true})

	app.Hooks().OnRoute(func(c *fiber.Ctx, m fiber.Map) error {
		fmt.Println(m["route"].(fiber.Route).Path)

		return nil
	})

	app.Get("/hello", h)
	log.Fatal(app.Listen(":3001"))
}

func h(c *fiber.Ctx) error {
	return c.Status(fiber.StatusOK).SendString("Hello")
}

It's because app.register is being called twice somehow. Still looking into that

I think it's not bug because of Get creates GET and HEAD methods.

[efectn]

What about using a struct instead of a map for the hook function params, to provide better type safety? It would be nice if each hook had its own struct.

done

[hi019]

I meant changing the hook handlers to be something like this:

// Old
type HookHandler = func(*Ctx, Map) error

// New
// naming could be improved
type OnRouteHandler = func(*Ctx OnRouteParams)

This will prevent typecasting:

app.Hooks().OnRoute(func(c *fiber.Ctx, m fiber.OnRouteParams) error {
	// Old
	fmt.Println(m["route"].(fiber.Route).Path)

	// New
	fmt.Println(m.Route.Path)

	return nil
})

[efectn]

I meant changing the hook handlers to be something like this:

// Old
type HookHandler = func(*Ctx, Map) error

// New
// naming could be improved
type OnRouteHandler = func(*Ctx OnRouteParams)

This will prevent typecasting:

app.Hooks().OnRoute(func(c *fiber.Ctx, m fiber.OnRouteParams) error {
	// Old
	fmt.Println(m["route"].(fiber.Route).Path)

	// New
	fmt.Println(m.Route.Path)

	return nil
})

Good idea. I'll change it. Also i plan to add OnGroup. Thanks for suggestions.

[hi019]

Also we'll need to update your docs pr with the struct changes

[efectn]

Also we'll need to update your docs pr with the struct changes

I'll update docs tomorrow.

[efectn]

Also we'll need to update your docs pr with the struct changes

I'll update docs tomorrow.

done