feat: add context management to framework handlers and update related tests

sattvikc · sattvikc · commit 6d381a535715 · 2025-07-22T19:09:08.000+05:30
diff --git a/ROADMAP.md b/ROADMAP.md
@@ -2,7 +2,6 @@
 
 ## Features
 
-- [ ] Shared context
 - [ ] Response Headers
 - [ ] Non-json responses
 - [ ] Middleware
diff --git a/pkg/context/context.go b/pkg/context/context.go
@@ -22,3 +22,7 @@ func (c *Context) Contains(key string) bool {
 	_, ok := c.data[key]
 	return ok
 }
+
+func (c *Context) Delete(key string) {
+	delete(c.data, key)
+}
diff --git a/pkg/framework/fiberframework/framework.go b/pkg/framework/fiberframework/framework.go
@@ -4,6 +4,7 @@ import (
 	"net/http"
 	"net/http/httptest"
 
+	"github.com/go-simpl/simplapi/pkg/context"
 	"github.com/go-simpl/simplapi/pkg/framework"
 	"github.com/gofiber/fiber/v2"
 	"github.com/gofiber/fiber/v2/middleware/adaptor"
@@ -21,49 +22,49 @@ func New(app *fiber.App) framework.Framework {
 
 func (f *fiberFramework) GET(path string, handler framework.FrameworkHandler) {
 	f.app.Get(path, func(c *fiber.Ctx) error {
-		return handler(NewRequest(c), NewResponse(c))
+		return handler(NewRequest(c), NewResponse(c), context.New())
 	})
 }
 
 func (f *fiberFramework) POST(path string, handler framework.FrameworkHandler) {
 	f.app.Post(path, func(c *fiber.Ctx) error {
-		return handler(NewRequest(c), NewResponse(c))
+		return handler(NewRequest(c), NewResponse(c), context.New())
 	})
 }
 
 func (f *fiberFramework) PUT(path string, handler framework.FrameworkHandler) {
 	f.app.Put(path, func(c *fiber.Ctx) error {
-		return handler(NewRequest(c), NewResponse(c))
+		return handler(NewRequest(c), NewResponse(c), context.New())
 	})
 }
 
 func (f *fiberFramework) PATCH(path string, handler framework.FrameworkHandler) {
 	f.app.Patch(path, func(c *fiber.Ctx) error {
-		return handler(NewRequest(c), NewResponse(c))
+		return handler(NewRequest(c), NewResponse(c), context.New())
 	})
 }
 
 func (f *fiberFramework) DELETE(path string, handler framework.FrameworkHandler) {
 	f.app.Delete(path, func(c *fiber.Ctx) error {
-		return handler(NewRequest(c), NewResponse(c))
+		return handler(NewRequest(c), NewResponse(c), context.New())
 	})
 }
 
 func (f *fiberFramework) OPTIONS(path string, handler framework.FrameworkHandler) {
 	f.app.Options(path, func(c *fiber.Ctx) error {
-		return handler(NewRequest(c), NewResponse(c))
+		return handler(NewRequest(c), NewResponse(c), context.New())
 	})
 }
 
 func (f *fiberFramework) HEAD(path string, handler framework.FrameworkHandler) {
 	f.app.Head(path, func(c *fiber.Ctx) error {
-		return handler(NewRequest(c), NewResponse(c))
+		return handler(NewRequest(c), NewResponse(c), context.New())
 	})
 }
 
 func (f *fiberFramework) TRACE(path string, handler framework.FrameworkHandler) {
 	f.app.Trace(path, func(c *fiber.Ctx) error {
-		return handler(NewRequest(c), NewResponse(c))
+		return handler(NewRequest(c), NewResponse(c), context.New())
 	})
 }
 
diff --git a/pkg/framework/ginframework/framework.go b/pkg/framework/ginframework/framework.go
@@ -5,6 +5,7 @@ import (
 	"net/http/httptest"
 
 	"github.com/gin-gonic/gin"
+	"github.com/go-simpl/simplapi/pkg/context"
 	"github.com/go-simpl/simplapi/pkg/framework"
 )
 
@@ -20,7 +21,7 @@ func New(engine *gin.Engine) framework.Framework {
 
 func (g *ginFramework) GET(path string, handler framework.FrameworkHandler) {
 	g.engine.GET(path, func(c *gin.Context) {
-		err := handler(NewRequest(c), NewResponse(c))
+		err := handler(NewRequest(c), NewResponse(c), context.New())
 		if err != nil {
 			c.AbortWithError(http.StatusInternalServerError, err)
 		}
@@ -29,7 +30,7 @@ func (g *ginFramework) GET(path string, handler framework.FrameworkHandler) {
 
 func (g *ginFramework) POST(path string, handler framework.FrameworkHandler) {
 	g.engine.POST(path, func(c *gin.Context) {
-		err := handler(NewRequest(c), NewResponse(c))
+		err := handler(NewRequest(c), NewResponse(c), context.New())
 		if err != nil {
 			c.AbortWithError(http.StatusInternalServerError, err)
 		}
@@ -38,7 +39,7 @@ func (g *ginFramework) POST(path string, handler framework.FrameworkHandler) {
 
 func (g *ginFramework) PUT(path string, handler framework.FrameworkHandler) {
 	g.engine.PUT(path, func(c *gin.Context) {
-		err := handler(NewRequest(c), NewResponse(c))
+		err := handler(NewRequest(c), NewResponse(c), context.New())
 		if err != nil {
 			c.AbortWithError(http.StatusInternalServerError, err)
 		}
@@ -47,7 +48,7 @@ func (g *ginFramework) PUT(path string, handler framework.FrameworkHandler) {
 
 func (g *ginFramework) PATCH(path string, handler framework.FrameworkHandler) {
 	g.engine.PATCH(path, func(c *gin.Context) {
-		err := handler(NewRequest(c), NewResponse(c))
+		err := handler(NewRequest(c), NewResponse(c), context.New())
 		if err != nil {
 			c.AbortWithError(http.StatusInternalServerError, err)
 		}
@@ -56,7 +57,7 @@ func (g *ginFramework) PATCH(path string, handler framework.FrameworkHandler) {
 
 func (g *ginFramework) DELETE(path string, handler framework.FrameworkHandler) {
 	g.engine.DELETE(path, func(c *gin.Context) {
-		err := handler(NewRequest(c), NewResponse(c))
+		err := handler(NewRequest(c), NewResponse(c), context.New())
 		if err != nil {
 			c.AbortWithError(http.StatusInternalServerError, err)
 		}
@@ -65,7 +66,7 @@ func (g *ginFramework) DELETE(path string, handler framework.FrameworkHandler) {
 
 func (g *ginFramework) OPTIONS(path string, handler framework.FrameworkHandler) {
 	g.engine.OPTIONS(path, func(c *gin.Context) {
-		err := handler(NewRequest(c), NewResponse(c))
+		err := handler(NewRequest(c), NewResponse(c), context.New())
 		if err != nil {
 			c.AbortWithError(http.StatusInternalServerError, err)
 		}
@@ -74,7 +75,7 @@ func (g *ginFramework) OPTIONS(path string, handler framework.FrameworkHandler)
 
 func (g *ginFramework) HEAD(path string, handler framework.FrameworkHandler) {
 	g.engine.HEAD(path, func(c *gin.Context) {
-		err := handler(NewRequest(c), NewResponse(c))
+		err := handler(NewRequest(c), NewResponse(c), context.New())
 		if err != nil {
 			c.AbortWithError(http.StatusInternalServerError, err)
 		}
@@ -83,7 +84,7 @@ func (g *ginFramework) HEAD(path string, handler framework.FrameworkHandler) {
 
 func (g *ginFramework) TRACE(path string, handler framework.FrameworkHandler) {
 	g.engine.Handle("TRACE", path, func(c *gin.Context) {
-		err := handler(NewRequest(c), NewResponse(c))
+		err := handler(NewRequest(c), NewResponse(c), context.New())
 		if err != nil {
 			c.AbortWithError(http.StatusInternalServerError, err)
 		}
diff --git a/pkg/framework/iface.go b/pkg/framework/iface.go
@@ -3,6 +3,8 @@ package framework
 import (
 	"mime/multipart"
 	"net/http"
+
+	"github.com/go-simpl/simplapi/pkg/context"
 )
 
 type Framework interface {
@@ -19,7 +21,7 @@ type Framework interface {
 	TestRequest(req *http.Request) (*http.Response, error)
 }
 
-type FrameworkHandler func(req FrameworkRequest, res FrameworkResponse) error
+type FrameworkHandler func(req FrameworkRequest, res FrameworkResponse, ctx *context.Context) error
 
 type FrameworkRequest interface {
 	ParseJSONBody(target interface{}) error
diff --git a/pkg/handler/main.go b/pkg/handler/main.go
@@ -5,6 +5,7 @@ import (
 	"reflect"
 
 	"github.com/go-simpl/simplapi/errors"
+	"github.com/go-simpl/simplapi/pkg/context"
 	"github.com/go-simpl/simplapi/pkg/framework"
 	"github.com/go-simpl/simplapi/pkg/reflection"
 	"github.com/go-simpl/simplapi/types"
@@ -29,10 +30,15 @@ func WrapHandler(handler interface{}, next framework.FrameworkHandler) framework
 		panic("handler must return an error at the last position")
 	}
 
-	createParams := func(req framework.FrameworkRequest) ([]reflect.Value, error) {
+	createParams := func(req framework.FrameworkRequest, ctx *context.Context) ([]reflect.Value, error) {
 		numInputs := handlerType.NumIn()
 		inputs := make([]reflect.Value, numInputs)
 		for i := 0; i < numInputs; i++ {
+			if handlerType.In(i) == reflect.TypeOf(ctx) {
+				inputs[i] = reflect.ValueOf(ctx)
+				continue
+			}
+
 			inputs[i] = reflect.New(handlerType.In(i)).Elem()
 			err := reflection.PopulateValueFromTypeUsingContext(req, handlerType.In(i), inputs[i])
 			if err != nil {
@@ -42,8 +48,8 @@ func WrapHandler(handler interface{}, next framework.FrameworkHandler) framework
 		return inputs, nil
 	}
 
-	return func(req framework.FrameworkRequest, res framework.FrameworkResponse) error {
-		inputs, err := createParams(req)
+	return func(req framework.FrameworkRequest, res framework.FrameworkResponse, ctx *context.Context) error {
+		inputs, err := createParams(req, ctx)
 		if err != nil {
 			if typeErr, ok := err.(errors.TypeError); ok {
 				res.SetStatusCode(http.StatusUnprocessableEntity)
@@ -79,7 +85,7 @@ func WrapHandler(handler interface{}, next framework.FrameworkHandler) framework
 		}
 
 		if next != nil {
-			return next(req, res)
+			return next(req, res, ctx)
 		}
 
 		return nil
diff --git a/pkg/swagger/helper.go b/pkg/swagger/helper.go
@@ -7,6 +7,7 @@ import (
 	"reflect"
 	"strings"
 
+	"github.com/go-simpl/simplapi/pkg/context"
 	"github.com/go-simpl/simplapi/types"
 )
 
@@ -28,6 +29,10 @@ func UpdateDefinitionUsingParamTypes(definition map[string]interface{}, paramTyp
 	HEADER_EXCLUSIONS := map[string]bool{"content-type": true, "content-length": true, "user-agent": true}
 
 	for _, paramType := range paramTypes {
+		if paramType == reflect.TypeOf((*context.Context)(nil)) {
+			continue
+		}
+
 		for i := 0; i < paramType.NumField(); i++ {
 			field := paramType.Field(i)
 			if field.Tag.Get("body") != "" {
diff --git a/tests/chain_tests/chain_test.go b/tests/chain_tests/chain_test.go
@@ -4,11 +4,13 @@ import (
 	"errors"
 	"io"
 	"net/http"
+	"net/http/httptest"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
 
 	"github.com/go-simpl/simplapi"
+	"github.com/go-simpl/simplapi/pkg/context"
 
 	_ "github.com/go-simpl/simplapi/pkg/framework/fiberframework"
 )
@@ -127,3 +129,32 @@ func TestChainReturnedErrorFromFirstFunc(t *testing.T) {
 	bodyString := string(bodyBytes)
 	assert.Equal(t, `server error`, bodyString)
 }
+
+func TestContextInChain(t *testing.T) {
+	app := simplapi.New()
+	fApp := app.GetApp()
+
+	func1 := func(ctx *context.Context) (*HelloResponse, error) {
+		ctx.Set("test", "test")
+		return nil, nil
+	}
+
+	func2 := func(ctx *context.Context) (*HelloResponse, error) {
+		assert.Equal(t, "test", ctx.Get("test"))
+		ctx.Delete("test")
+		return nil, nil
+	}
+
+	func3 := func(ctx *context.Context) (*HelloResponse, error) {
+		assert.False(t, ctx.Contains("test"))
+		return &HelloResponse{Message: ""}, nil
+	}
+
+	app.GET("/", nil, func1, func2, func3)
+
+	req := httptest.NewRequest("GET", "/", nil)
+	response, err := fApp.TestRequest(req)
+	assert.NoError(t, err)
+
+	assert.Equal(t, http.StatusOK, response.StatusCode)
+}

Original file line number	Diff line number	Diff line change
`@@ -22,3 +22,7 @@ func (c *Context) Contains(key string) bool {`
`22`	`22`	`_, ok := c.data[key]`
`23`	`23`	`return ok`
`24`	`24`	`}`
	`25`	`+`
	`26`	`+func (c *Context) Delete(key string) {`
	`27`	`+ delete(c.data, key)`
	`28`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,8 @@ package framework`
`3`	`3`	`import (`
`4`	`4`	`"mime/multipart"`
`5`	`5`	`"net/http"`
	`6`	`+`
	`7`	`+ "github.com/go-simpl/simplapi/pkg/context"`
`6`	`8`	`)`
`7`	`9`
`8`	`10`	`type Framework interface {`
`@@ -19,7 +21,7 @@ type Framework interface {`
`19`	`21`	`TestRequest(req http.Request) (http.Response, error)`
`20`	`22`	`}`
`21`	`23`
`22`		`-type FrameworkHandler func(req FrameworkRequest, res FrameworkResponse) error`
	`24`	`+type FrameworkHandler func(req FrameworkRequest, res FrameworkResponse, ctx *context.Context) error`
`23`	`25`
`24`	`26`	`type FrameworkRequest interface {`
`25`	`27`	`ParseJSONBody(target interface{}) error`