[gqlgen] gin.Context 이용하기

문제

gin을 graphql(gqlgen)의 router로 사용하려고 할 때
gin.Context에 담아놓은 값들이, graphql resolver에서 사용할 수 있는 ctx(context.Context)에 담겨있지 않았다. 

 

gin.Context에 key-value로 저장한 값을

resolver의 ctx.Value("key")로 접근해서 사용하고 싶은 상황

 

 

gqlgen 공식 문서에서 제공하는 example에 gin.Context를 사용하는 방법이 안내되어 있다. 링크

하지만, 이 방법은 context.Context에 gin.Context를 그대로 담기 때문에 각각의 resolver에서 매번 아래의 작업을 해줘야 한다.

1. context.Context에서 gin.Context 꺼내기

2. gin.Context에서 원하는 값 꺼내기

func (r *resolver) Todo(ctx context.Context) (*Todo, error) {
	gc, err := GinContextFromContext(ctx) // 매번 gin.Context를 꺼내고
	if err != nil {
		return nil, err
	}

	// gc에서 필요한 값을 꺼내야 한다
	// ...
}

길지 않은 코드라고 생각할 수 있지만, 매 resolver에 불필요하게 중복된 코드가 들어가게 된다.

 

원인

그렇다면 왜, gqlgen resolver의 ctx에 gin.Context의 값이 들어있지 않은걸까?

 

gqlgen에서 제공하는 gin을 이용한 example을 보면, graphql handler에 gin.Context.Request를 넘기게 되고

 

...
// Defining the Graphql handler
func graphqlHandler() gin.HandlerFunc {
	// NewExecutableSchema and Config are in the generated.go file
	// Resolver is in the resolver.go file
	h := handler.NewDefaultServer(graph.NewExecutableSchema(graph.Config{Resolvers: &graph.Resolver{}}))

	return func(c *gin.Context) {
		h.ServeHTTP(c.Writer, c.Request) // 여기!
	}
}
...

h.ServeHTTP()에서는, 넘겨받은 Request.Context() (==Request.ctx) 를 사용하게 된다.

func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request) {
	defer func() {
		if err := recover(); err != nil {
			err := s.exec.PresentRecoveredError(r.Context(), err)
			gqlErr, _ := err.(*gqlerror.Error)
			resp := &graphql.Response{Errors: []*gqlerror.Error{gqlErr}}
			b, _ := json.Marshal(resp)
			w.WriteHeader(http.StatusUnprocessableEntity)
			w.Write(b)
		}
	}()

	r = r.WithContext(graphql.StartOperationTrace(r.Context())) // 여기!

	transport := s.getTransport(r)
	if transport == nil {
		sendErrorf(w, http.StatusBadRequest, "transport not supported")
		return
	}

	transport.Do(w, r, s.exec)
}

 

결과적으로,

 

gin.Context 의 하위에는 아래와 같은 필드들이 존재하고

// gin.Context
type Context struct {
	...
	Request   *http.Request
	Keys      map[string]any
	...
}

 

gin.Context에 Set()을 통해 저장하는 값들은 gin.Context.Keys 에 저장되는데

gqlgen resolver에 넘어가는 context는 gin.Context.Request.ctx 라서 접근할 수 없는 것이다.

 

해결방안

그렇다면 어떻게 원하는대로 사용할 수 있을까?

gin.Context에 key-value로 저장한 값을

resolver의 ctx.Value("key")로 접근해서 사용하고 싶은 상황

 

1. 사용할 값들을 gin.Context.Keys가 아닌 gin.Context.Request.ctx에 저장하기

이렇게 되면, 원하는 상황은 얻어낼 수 있지만 두 가지 단점이 생긴다.

1) gin middleware에서 context에 값을 저장하는 로직이 복잡해지고

2) 여러 개발자가 함께 작업할 때 gin.Context.Keys가 아니라 Request내부 ctx에 값을 저장해야 한다는 사실이 충분히 공유가 되어야 한다.

-> gqlgen 공식문서에서 제공하는 방법과 비교해서 이점이 없음

func ginMiddleware(c *gin.Context) {
    ctx := c.Request.Context()
    ctx = context.WithValue(ctx, key, value)
    c.Request = c.Request.WithContext(ctx)
}

 

2. h.ServeHTTP() 이전에, gin.Context.Keys에 존재하는 값들을 한 번에 gin.Context.Request.ctx로 넣어주기

h.ServeHTTP()를 호출하기 직전에 gin.Context.Keys에 존재하는 값들을

한 번에 gin.Context.Request.ctx로 넣어주는 방법이다.

...
// Defining the Graphql handler
func graphqlHandler() gin.HandlerFunc {
	// NewExecutableSchema and Config are in the generated.go file
	// Resolver is in the resolver.go file
	h := handler.NewDefaultServer(graph.NewExecutableSchema(graph.Config{Resolvers: &graph.Resolver{}}))

	return func(c *gin.Context) {
		ctx := c.Request.Context()
		for k, v := range c.Keys {
			ctx = context.WithValue(ctx, k, v)
		}
		req := c.Request.WithContext(ctx)
		h.ServeHTTP(c.Writer, req)
	}
}
...

 

이전 방법들과 크게 다른점이 없다고 느껴질 수 있지만 유지보수 측면에서 가장 좋은 방법이라고 생각했다.

후에 다른 개발자 혹은 이전 히스토리를 잊어버린 당사자가 context에 값을 추가로 저장해야할 상황에서 신경쓸 포인트가 줄어들기 때문이다.

 

 

굉장히 사소한 문제 같지만,

- 중복 코드 줄이기

- 쉬운 유지보수

측면에서 고민해볼 수 있었던 문제였다.