[Go] panic: runtime error: invalid memory address or nil pointer dereference 에러 해결

개요

fiber 프레임워크를 사용하여 웹소켓 채팅 서버를 개발 중 http 에서 websocket 으로 프로토콜을 업그레이드 하는 과정에서 발생한 문제.

 

에러 발생

주석에 달아놓은 것 처럼 websocket handler 내부에서 fiber.Ctx 에 접근하자마자 에러가 발생했다.

유효하지 않은 메모리 주소이거나 nil pointer 에러가 발생했다는데, ServeHttp() 메서드 진입시점에서 c 를 로그로 확인했을 땐 정상 값이 출력됐다.

즉 websocker 핸들러 내부에서 fiber.Ctx 를 접근하지 못하는 것이 원인이라 생각했다.

func (r *Room) ServeHTTP(c *fiber.Ctx) error {
   if r == nil {
     return fiber.NewError(fiber.StatusInternalServerError, "Room is not initialized")
   }
   return websocket.New(func(conn *websocket.Conn) {
     if conn == nil {
       log.Println("WebSocket connection failed")
       return
     }
     authCookie := c.Cookies("auth") // log 확인 결과 해당 라인에서 에러 발생
     if authCookie == "" {
       log.Println("auth cookie is failed")
       return
     }

     client := &Client{
       Socket: conn,
       Send:   make(chan *message, messageBufferSize),
       Room:   r,
       Name:   authCookie,
     }

     if client == nil {
       log.Println("Failed to create client")
       return
     }

     r.Join <- client

     defer func() {
       if r != nil && client != nil {
         r.Leave <- client
       }
     }()

     go client.Write()
     client.Read()
   })(c)
}

 

원인

원인은 webSocket.New() 핸들러 함수 내에서 c *fiber.Ctx에 액세스할 수 없는 문제였다.

이는 WebSocket 연결이 HTTP 연결을 업그레이드하므로 기존의 컨텍스트를 더 이상 사용할 수 없기 때문이다.

 

왜 fiber의 Context 는 websocket 내에서 사용할 수 없을까?

변수 c가 WebSocket 핸들러 내부에서 사용할 수 없는 이유는 WebSocket 프로토콜의 특성과 Fiber 프레임워크의 구현 방식 때문이다. 

 

1. Http에서 WebSocket 으로 변환

- websocket 연결은 일반 HTTP 요청으로 시작하여 프로토콜 업그레이드를 통해 이뤄진다.

- 업그레이드 완료 시, 커넥션은 더 이상 Http 가 아닌 WebSocket 프로토콜을 사용한다.

 

2. Fiber 컨텍스트의 수명

- c *fiber.Ctx 는 http 요청의 컨텍스트 정보를 담고 있다.

- 이 컨텍스트는 http 요청의 수명 주기 동안만 유효하다. 즉 websocket 으로 업그레이드 된 시점 부터는 더 이상 유효하지 않다.

 

정리하면 WebSocket 핸들러 내부에서 c *fiber.Ctx를 직접 사용하는 경우 런타임 에러가 발생할 수 있다.

즉 WebSocket 연결 전에 필요한 정보(예: 쿠키, 헤더 등)를 미리 추출하여 WebSocket 핸들러에 전달하는 방식을 사용하는 식으로 코드를 개선해야한다. 이렇게 하면 WebSocket 연결 동안 필요한 정보를 안전하게 사용할 수 있다.

 

 

변경된 코드

websocket.New() 내부에서 직접 fibet.Ctx 를 참조한 기존 코드와 달리

개선된 코드에서는  fiber.Ctx 에서 필요한 정보를 미리 추출하는 식으로 변경했다.

그리하여 websocket handler 내부에서는 필요한 정보만 전달받아 사용할 수 있다.

func (r *Room) ServeHTTP(c *fiber.Ctx) error {
    if r == nil {
        return fiber.NewError(fiber.StatusInternalServerError, "Room is not initialized")
    }

    authCookie := c.Cookies("auth")
    if authCookie == "" {
        return fiber.NewError(fiber.StatusUnauthorized, "Auth cookie is missing")
    }

    return websocket.New(func(conn *websocket.Conn) {
        if conn == nil {
            log.Println("WebSocket connection failed")
            return
        }

        client := &Client{
            Socket: conn,
            Send:   make(chan *message, messageBufferSize),
            Room:   r,
            Name:   authCookie, // Use the authCookie we got earlier
        }

        if client == nil {
            log.Println("Failed to create client")
            return
        }

        r.Join <- client

        defer func() {
            if r != nil && client != nil {
                r.Leave <- client
            }
        }()

        go client.Write()
        client.Read()
    })(c)
}