🧹 chore: Add FullPath() helper to context (#3837)

Author: gaby

ctx.go

@@ -317,6 +317,11 @@ func (c *DefaultCtx) Route() *Route {
 	return c.route
 }
 
+// FullPath returns the matched route path, including any group prefixes.
+func (c *DefaultCtx) FullPath() string {
+	return c.Route().Path
+}
+
 // Matched returns true if the current request path was matched by the router.
 func (c *DefaultCtx) Matched() bool {
 	return c.getMatched()

ctx_interface_gen.go

@@ -3653,6 +3653,73 @@ func Test_Ctx_Route(t *testing.T) {
 	require.Empty(t, c.Route().Handlers)
 }
 
+// go test -run Test_Ctx_FullPath
+func Test_Ctx_FullPath(t *testing.T) {
+	t.Parallel()
+
+	app := New()
+	app.Get("/test", func(c Ctx) error {
+		require.Equal(t, "/test", c.FullPath())
+		return c.SendStatus(StatusOK)
+	})
+
+	resp, err := app.Test(httptest.NewRequest(MethodGet, "/test", nil))
+	require.NoError(t, err, "app.Test(req)")
+	defer func() { require.NoError(t, resp.Body.Close()) }()
+
+	require.Equal(t, StatusOK, resp.StatusCode)
+}
+
+// go test -run Test_Ctx_FullPath_Group
+func Test_Ctx_FullPath_Group(t *testing.T) {
+	t.Parallel()
+
+	app := New()
+	group := app.Group("/v1")
+	group.Get("/test", func(c Ctx) error {
+		require.Equal(t, "/v1/test", c.FullPath())
+		return c.SendStatus(StatusOK)
+	})
+
+	resp, err := app.Test(httptest.NewRequest(MethodGet, "/v1/test", nil))
+	require.NoError(t, err, "app.Test(req)")
+	defer func() { require.NoError(t, resp.Body.Close()) }()
+
+	require.Equal(t, StatusOK, resp.StatusCode)
+}
+
+// go test -run Test_Ctx_FullPath_Middleware
+func Test_Ctx_FullPath_Middleware(t *testing.T) {
+	t.Parallel()
+
+	app := New()
+
+	var recorded []string
+
+	app.Use(func(c Ctx) error {
+		recorded = append(recorded, c.FullPath())
+
+		if err := c.Next(); err != nil {
+			return err
+		}
+
+		recorded = append(recorded, c.FullPath())
+		return nil
+	})
+
+	app.Get("/test", func(c Ctx) error {
+		require.Equal(t, "/test", c.FullPath())
+		return c.SendStatus(StatusOK)
+	})
+
+	resp, err := app.Test(httptest.NewRequest(MethodGet, "/test", nil))
+	require.NoError(t, err, "app.Test(req)")
+	defer func() { require.NoError(t, resp.Body.Close()) }()
+
+	require.Equal(t, StatusOK, resp.StatusCode)
+	require.Equal(t, []string{"/", "/test"}, recorded)
+}
+
 // go test -run Test_Ctx_RouteNormalized
 func Test_Ctx_RouteNormalized(t *testing.T) {
 	t.Parallel()

ctx_test.go

@@ -420,6 +420,35 @@ func MyMiddleware() fiber.Handler {
 }
 ```
 
+### FullPath
+
+Returns the full path of the matched route. This includes any prefixes that were added by [groups](../guide/routing.md#grouping-routes) or mounts.
+
+```go title="Signature"
+func (c fiber.Ctx) FullPath() string
+```
+
+```go title="Example"
+api := app.Group("/api")
+api.Get("/users/:id", func(c fiber.Ctx) error {
+  return c.JSON(fiber.Map{
+    "route": c.FullPath(), // "/api/users/:id"
+  })
+})
+
+app.Use(func(c fiber.Ctx) error {
+  beforeNext := c.FullPath() // "/"
+
+  if err := c.Next(); err != nil {
+    return err
+  }
+
+  afterNext := c.FullPath() // "/api/users/:id"
+  // ... react to the downstream handler's route path
+  return nil
+})
+```
+
 ### Matched
 
 Returns `true` if the current request path was matched by the router.