Fix runtime error: invalid memory address or nil pointer dereference in Gin

This error occurs when Go code dereferences a nil pointer, typically by accessing a field or calling a method on a nil value returned from a function. In Gin handlers, this often happens when database queries return nil results or when request binding fails silently. Fix it by checking for nil before dereferencing pointers.

Reading the Stack Trace

Here's what each line means:

• /app/handlers/user.go:18 (0x8a2f4d): Line 18 of user.go accesses user.Name on a nil pointer returned by the database query.
• runtime error: invalid memory address or nil pointer dereference: The Go runtime detected an attempt to access memory at address 0x0 (nil), which is always invalid.
• [Recovery] panic recovered:: Gin's recovery middleware caught the panic and prevented the server from crashing, returning a 500 response.

Common Causes

func GetUser(c *gin.Context) {
	id := c.Param("id")
	user, _ := db.FindUserByID(id)
	c.JSON(200, gin.H{"name": user.Name}) // user is nil if not found
}

func GetUser(c *gin.Context) {
	user, _ := db.FindUserByID(c.Param("id"))
	// _ discards the "not found" error
	c.JSON(200, gin.H{"name": user.Name})
}

func GetUser(c *gin.Context) {
	var user *User // nil by default
	c.JSON(200, gin.H{"name": user.Name}) // dereferencing nil
}

The Fix

Always check both the error return and the nil pointer before using the result. Return early with appropriate HTTP status codes (500 for errors, 404 for not found) so the nil pointer is never dereferenced.

func GetUser(c *gin.Context) {
	id := c.Param("id")
	user, _ := db.FindUserByID(id)
	c.JSON(200, gin.H{"name": user.Name})
}

func GetUser(c *gin.Context) {
	id := c.Param("id")
	user, err := db.FindUserByID(id)
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to query user"})
		return
	}
	if user == nil {
		c.JSON(http.StatusNotFound, gin.H{"error": "user not found"})
		return
	}
	c.JSON(http.StatusOK, gin.H{"name": user.Name})
}

Testing the Fix

package handlers

import (
	"encoding/json"
	"net/http"
	"net/http/httptest"
	"testing"

	"github.com/gin-gonic/gin"
)

func setupRouter() *gin.Engine {
	gin.SetMode(gin.TestMode)
	r := gin.Default()
	r.GET("/api/users/:id", GetUser)
	return r
}

func TestGetUser_ExistingUser(t *testing.T) {
	router := setupRouter()
	w := httptest.NewRecorder()
	req, _ := http.NewRequest("GET", "/api/users/1", nil)
	router.ServeHTTP(w, req)

	if w.Code != http.StatusOK {
		t.Errorf("expected status 200, got %d", w.Code)
	}

	var body map[string]string
	json.Unmarshal(w.Body.Bytes(), &body)
	if body["name"] == "" {
		t.Error("expected name to be non-empty")
	}
}

func TestGetUser_NonExistentUser(t *testing.T) {
	router := setupRouter()
	w := httptest.NewRecorder()
	req, _ := http.NewRequest("GET", "/api/users/99999", nil)
	router.ServeHTTP(w, req)

	if w.Code != http.StatusNotFound {
		t.Errorf("expected status 404, got %d", w.Code)
	}
}

func TestGetUser_DoesNotPanic(t *testing.T) {
	router := setupRouter()
	w := httptest.NewRecorder()
	req, _ := http.NewRequest("GET", "/api/users/invalid", nil)

	defer func() {
		if r := recover(); r != nil {
			t.Errorf("handler panicked: %v", r)
		}
	}()

	router.ServeHTTP(w, req)
}

Run your tests:

go test ./...

Pushing Through CI/CD

git checkout -b fix/nil-pointer-dereference,git add handlers/user.go handlers/user_test.go,git commit -m "fix: check for nil pointer before accessing user fields",git push origin fix/nil-pointer-dereference

Your CI config should look something like this:

name: CI
on:
  pull_request:
    branches: [main]
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-go@v5
        with:
          go-version: '1.22'
      - run: go mod download
      - run: go vet ./...
      - run: go test -race -coverprofile=coverage.out ./...
      - run: go build ./...

The Full Manual Process: 18 Steps

Here's every step you just went through to fix this one bug:

1. Notice the error alert or see it in your monitoring tool
2. Open the error dashboard and read the stack trace
3. Identify the file and line number from the stack trace
4. Open your IDE and navigate to the file
5. Read the surrounding code to understand context
6. Reproduce the error locally
7. Identify the root cause
8. Write the fix
9. Run the test suite locally
10. Fix any failing tests
11. Write new tests covering the edge case
12. Run the full test suite again
13. Create a new git branch
14. Commit and push your changes
15. Open a pull request
16. Wait for code review
17. Merge and deploy to production
18. Monitor production to confirm the error is resolved

Total time: 30-60 minutes. For one bug.

go get github.com/bugstack/sdk

import "github.com/bugstack/sdk"

func init() {
  bugstack.Init(os.Getenv("BUGSTACK_API_KEY"))
}

Deploying the Fix (Manual Path)

1. Run go test ./... locally to confirm nil pointer checks work.
2. Run go vet ./... to catch other potential issues.
3. Open a pull request with the nil check fix.
4. Have a teammate review and approve the PR.
5. Merge to main and verify the endpoint returns proper errors in staging.

Frequently Asked Questions