mirror of
https://github.com/Crocmagnon/fatcontext.git
synced 2025-04-02 15:46:33 +02:00
Compare commits
13 commits
Author | SHA1 | Date | |
---|---|---|---|
![]() |
96ab752057 | ||
![]() |
2cfdadfd85 | ||
![]() |
5a001f2fbe | ||
![]() |
6f8b43553d | ||
![]() |
3947c6f8d5 | ||
![]() |
b568e8acf1 | ||
![]() |
ed135bb8e7 | ||
![]() |
12e5409dea | ||
![]() |
2046ce80db | ||
![]() |
7b0afb1f92 | ||
f887074f5d | |||
ef9d47d1f0 | |||
939d65bc16 |
17 changed files with 546 additions and 96 deletions
.github
.goreleaser.yaml.pre-commit-config.yamlREADME.mdcmd/fatcontext
go.modgo.sumpkg/analyzer
4
.github/dependabot.yml
vendored
4
.github/dependabot.yml
vendored
|
@ -6,6 +6,10 @@ updates:
|
|||
directory: "/"
|
||||
schedule:
|
||||
interval: "monthly"
|
||||
groups:
|
||||
github-actions:
|
||||
patterns:
|
||||
- "*" # Group all updates into a single larger pull request.
|
||||
- package-ecosystem: "gomod"
|
||||
directory: "/"
|
||||
schedule:
|
||||
|
|
2
.github/workflows/go.yml
vendored
2
.github/workflows/go.yml
vendored
|
@ -16,7 +16,7 @@ jobs:
|
|||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
go: ['1.22', '1.23']
|
||||
go: [stable, oldstable]
|
||||
os: [macos-latest, windows-latest, ubuntu-latest]
|
||||
name: build
|
||||
runs-on: ${{ matrix.os }}
|
||||
|
|
2
.github/workflows/golangci-lint.yml
vendored
2
.github/workflows/golangci-lint.yml
vendored
|
@ -16,7 +16,7 @@ jobs:
|
|||
golangci:
|
||||
strategy:
|
||||
matrix:
|
||||
go: ['1.22', '1.23']
|
||||
go: [stable, oldstable]
|
||||
name: lint
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
|
|
2
.github/workflows/goreleaser.yml
vendored
2
.github/workflows/goreleaser.yml
vendored
|
@ -17,6 +17,8 @@ jobs:
|
|||
fetch-depth: 0
|
||||
- name: Set up Go
|
||||
uses: actions/setup-go@v5
|
||||
with:
|
||||
go-version: stable
|
||||
- name: Run GoReleaser
|
||||
uses: goreleaser/goreleaser-action@v6
|
||||
with:
|
||||
|
|
|
@ -1,5 +1,7 @@
|
|||
# yaml-language-server: $schema=https://goreleaser.com/static/schema.json
|
||||
# vim: set ts=2 sw=2 tw=0 fo=cnqoj
|
||||
version: 2
|
||||
|
||||
force_token: github
|
||||
|
||||
before:
|
||||
|
@ -37,3 +39,6 @@ changelog:
|
|||
exclude:
|
||||
- "^docs:"
|
||||
- "^test:"
|
||||
|
||||
release:
|
||||
draft: true
|
||||
|
|
|
@ -9,7 +9,7 @@ repos:
|
|||
- id: end-of-file-fixer
|
||||
- id: trailing-whitespace
|
||||
- repo: https://github.com/golangci/golangci-lint
|
||||
rev: v1.63.4
|
||||
rev: v1.64.7
|
||||
hooks:
|
||||
- id: golangci-lint-full
|
||||
- repo: local
|
||||
|
|
|
@ -16,8 +16,6 @@ go install github.com/Crocmagnon/fatcontext/cmd/fatcontext@latest
|
|||
fatcontext ./...
|
||||
```
|
||||
|
||||
There are no specific configuration options or custom command-line flags.
|
||||
|
||||
## Example
|
||||
|
||||
```go
|
||||
|
|
|
@ -7,5 +7,5 @@ import (
|
|||
)
|
||||
|
||||
func main() {
|
||||
singlechecker.Main(analyzer.Analyzer)
|
||||
singlechecker.Main(analyzer.NewAnalyzer())
|
||||
}
|
||||
|
|
6
go.mod
6
go.mod
|
@ -2,9 +2,9 @@ module github.com/Crocmagnon/fatcontext
|
|||
|
||||
go 1.22.0
|
||||
|
||||
require golang.org/x/tools v0.28.0
|
||||
require golang.org/x/tools v0.30.0
|
||||
|
||||
require (
|
||||
golang.org/x/mod v0.22.0 // indirect
|
||||
golang.org/x/sync v0.10.0 // indirect
|
||||
golang.org/x/mod v0.23.0 // indirect
|
||||
golang.org/x/sync v0.11.0 // indirect
|
||||
)
|
||||
|
|
12
go.sum
12
go.sum
|
@ -1,8 +1,8 @@
|
|||
github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
|
||||
github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
|
||||
golang.org/x/mod v0.22.0 h1:D4nJWe9zXqHOmWqj4VMOJhvzj7bEZg4wEYa759z1pH4=
|
||||
golang.org/x/mod v0.22.0/go.mod h1:6SkKJ3Xj0I0BrPOZoBy3bdMptDDU9oJrpohJ3eWZ1fY=
|
||||
golang.org/x/sync v0.10.0 h1:3NQrjDixjgGwUOCaF8w2+VYHv0Ve/vGYSbdkTa98gmQ=
|
||||
golang.org/x/sync v0.10.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
|
||||
golang.org/x/tools v0.28.0 h1:WuB6qZ4RPCQo5aP3WdKZS7i595EdWqWR8vqJTlwTVK8=
|
||||
golang.org/x/tools v0.28.0/go.mod h1:dcIOrVd3mfQKTgrDVQHqCPMWy6lnhfhtX3hLXYVLfRw=
|
||||
golang.org/x/mod v0.23.0 h1:Zb7khfcRGKk+kqfxFaP5tZqCnDZMjC5VtUBs87Hr6QM=
|
||||
golang.org/x/mod v0.23.0/go.mod h1:6SkKJ3Xj0I0BrPOZoBy3bdMptDDU9oJrpohJ3eWZ1fY=
|
||||
golang.org/x/sync v0.11.0 h1:GGz8+XQP4FvTTrjZPzNKTMFtSXH80RAzG+5ghFPgK9w=
|
||||
golang.org/x/sync v0.11.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
|
||||
golang.org/x/tools v0.30.0 h1:BgcpHewrV5AUp2G9MebG4XPFI1E2W41zU1SaqVA9vJY=
|
||||
golang.org/x/tools v0.30.0/go.mod h1:c347cR/OJfw5TI+GfX7RUPNMdDRRbjvYTS0jPyvsVtY=
|
||||
|
|
|
@ -3,6 +3,7 @@ package analyzer
|
|||
import (
|
||||
"bytes"
|
||||
"errors"
|
||||
"flag"
|
||||
"fmt"
|
||||
"go/ast"
|
||||
"go/printer"
|
||||
|
@ -14,22 +15,45 @@ import (
|
|||
"golang.org/x/tools/go/ast/inspector"
|
||||
)
|
||||
|
||||
var Analyzer = &analysis.Analyzer{
|
||||
Name: "fatcontext",
|
||||
Doc: "detects nested contexts in loops and function literals",
|
||||
Run: run,
|
||||
Requires: []*analysis.Analyzer{inspect.Analyzer},
|
||||
const FlagCheckStructPointers = "check-struct-pointers"
|
||||
|
||||
func NewAnalyzer() *analysis.Analyzer {
|
||||
r := &runner{}
|
||||
|
||||
flags := flag.NewFlagSet("fatcontext", flag.ExitOnError)
|
||||
flags.BoolVar(&r.DetectInStructPointers, FlagCheckStructPointers, false,
|
||||
"set to true to detect potential fat contexts in struct pointers")
|
||||
|
||||
return &analysis.Analyzer{
|
||||
Name: "fatcontext",
|
||||
Doc: "detects nested contexts in loops and function literals",
|
||||
Run: r.run,
|
||||
Flags: *flags,
|
||||
Requires: []*analysis.Analyzer{inspect.Analyzer},
|
||||
}
|
||||
}
|
||||
|
||||
var errUnknown = errors.New("unknown node type")
|
||||
|
||||
func run(pass *analysis.Pass) (interface{}, error) {
|
||||
const (
|
||||
categoryInLoop = "nested context in loop"
|
||||
categoryInFuncLit = "nested context in function literal"
|
||||
categoryInStructPointer = "potential nested context in struct pointer"
|
||||
categoryUnsupported = "unsupported nested context type"
|
||||
)
|
||||
|
||||
type runner struct {
|
||||
DetectInStructPointers bool
|
||||
}
|
||||
|
||||
func (r *runner) run(pass *analysis.Pass) (interface{}, error) {
|
||||
inspctr := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
|
||||
|
||||
nodeFilter := []ast.Node{
|
||||
(*ast.ForStmt)(nil),
|
||||
(*ast.RangeStmt)(nil),
|
||||
(*ast.FuncLit)(nil),
|
||||
(*ast.FuncDecl)(nil),
|
||||
}
|
||||
|
||||
inspctr.Preorder(nodeFilter, func(node ast.Node) {
|
||||
|
@ -38,36 +62,26 @@ func run(pass *analysis.Pass) (interface{}, error) {
|
|||
return
|
||||
}
|
||||
|
||||
if body == nil {
|
||||
return
|
||||
}
|
||||
|
||||
assignStmt := findNestedContext(pass, node, body.List)
|
||||
if assignStmt == nil {
|
||||
return
|
||||
}
|
||||
|
||||
suggestedStmt := ast.AssignStmt{
|
||||
Lhs: assignStmt.Lhs,
|
||||
TokPos: assignStmt.TokPos,
|
||||
Tok: token.DEFINE,
|
||||
Rhs: assignStmt.Rhs,
|
||||
}
|
||||
suggested, err := render(pass.Fset, &suggestedStmt)
|
||||
category := getCategory(pass, node, assignStmt)
|
||||
|
||||
var fixes []analysis.SuggestedFix
|
||||
if err == nil {
|
||||
fixes = append(fixes, analysis.SuggestedFix{
|
||||
Message: "replace `=` with `:=`",
|
||||
TextEdits: []analysis.TextEdit{
|
||||
{
|
||||
Pos: assignStmt.Pos(),
|
||||
End: assignStmt.End(),
|
||||
NewText: suggested,
|
||||
},
|
||||
},
|
||||
})
|
||||
if r.shouldIgnoreReport(category) {
|
||||
return
|
||||
}
|
||||
|
||||
fixes := r.getSuggestedFixes(pass, assignStmt, category)
|
||||
|
||||
pass.Report(analysis.Diagnostic{
|
||||
Pos: assignStmt.Pos(),
|
||||
Message: getReportMessage(node),
|
||||
Message: category,
|
||||
SuggestedFixes: fixes,
|
||||
})
|
||||
})
|
||||
|
@ -75,31 +89,69 @@ func run(pass *analysis.Pass) (interface{}, error) {
|
|||
return nil, nil
|
||||
}
|
||||
|
||||
func getReportMessage(node ast.Node) string {
|
||||
func (r *runner) shouldIgnoreReport(category string) bool {
|
||||
return category == categoryInStructPointer && !r.DetectInStructPointers
|
||||
}
|
||||
|
||||
func (r *runner) getSuggestedFixes(pass *analysis.Pass, assignStmt *ast.AssignStmt, category string) []analysis.SuggestedFix {
|
||||
switch category {
|
||||
case categoryInStructPointer, categoryUnsupported:
|
||||
return nil
|
||||
}
|
||||
|
||||
suggestedStmt := ast.AssignStmt{
|
||||
Lhs: assignStmt.Lhs,
|
||||
TokPos: assignStmt.TokPos,
|
||||
Tok: token.DEFINE,
|
||||
Rhs: assignStmt.Rhs,
|
||||
}
|
||||
suggested, err := render(pass.Fset, &suggestedStmt)
|
||||
|
||||
var fixes []analysis.SuggestedFix
|
||||
if err == nil {
|
||||
fixes = append(fixes, analysis.SuggestedFix{
|
||||
Message: "replace `=` with `:=`",
|
||||
TextEdits: []analysis.TextEdit{
|
||||
{
|
||||
Pos: assignStmt.Pos(),
|
||||
End: assignStmt.End(),
|
||||
NewText: suggested,
|
||||
},
|
||||
},
|
||||
})
|
||||
}
|
||||
|
||||
return fixes
|
||||
}
|
||||
|
||||
func getCategory(pass *analysis.Pass, node ast.Node, assignStmt *ast.AssignStmt) string {
|
||||
switch node.(type) {
|
||||
case *ast.ForStmt, *ast.RangeStmt:
|
||||
return "nested context in loop"
|
||||
case *ast.FuncLit:
|
||||
return "nested context in function literal"
|
||||
return categoryInLoop
|
||||
}
|
||||
|
||||
if isPointer(pass, assignStmt.Lhs[0]) {
|
||||
return categoryInStructPointer
|
||||
}
|
||||
|
||||
switch node.(type) {
|
||||
case *ast.FuncLit, *ast.FuncDecl:
|
||||
return categoryInFuncLit
|
||||
default:
|
||||
return "unsupported nested context type"
|
||||
return categoryUnsupported
|
||||
}
|
||||
}
|
||||
|
||||
func getBody(node ast.Node) (*ast.BlockStmt, error) {
|
||||
forStmt, ok := node.(*ast.ForStmt)
|
||||
if ok {
|
||||
return forStmt.Body, nil
|
||||
}
|
||||
|
||||
rangeStmt, ok := node.(*ast.RangeStmt)
|
||||
if ok {
|
||||
return rangeStmt.Body, nil
|
||||
}
|
||||
|
||||
funcLit, ok := node.(*ast.FuncLit)
|
||||
if ok {
|
||||
return funcLit.Body, nil
|
||||
switch typedNode := node.(type) {
|
||||
case *ast.ForStmt:
|
||||
return typedNode.Body, nil
|
||||
case *ast.RangeStmt:
|
||||
return typedNode.Body, nil
|
||||
case *ast.FuncLit:
|
||||
return typedNode.Body, nil
|
||||
case *ast.FuncDecl:
|
||||
return typedNode.Body, nil
|
||||
}
|
||||
|
||||
return nil, errUnknown
|
||||
|
@ -108,44 +160,29 @@ func getBody(node ast.Node) (*ast.BlockStmt, error) {
|
|||
func findNestedContext(pass *analysis.Pass, node ast.Node, stmts []ast.Stmt) *ast.AssignStmt {
|
||||
for _, stmt := range stmts {
|
||||
// Recurse if necessary
|
||||
if inner, ok := stmt.(*ast.BlockStmt); ok {
|
||||
found := findNestedContext(pass, node, inner.List)
|
||||
if found != nil {
|
||||
switch typedStmt := stmt.(type) {
|
||||
case *ast.BlockStmt:
|
||||
if found := findNestedContext(pass, node, typedStmt.List); found != nil {
|
||||
return found
|
||||
}
|
||||
}
|
||||
|
||||
if inner, ok := stmt.(*ast.IfStmt); ok {
|
||||
found := findNestedContext(pass, node, inner.Body.List)
|
||||
if found != nil {
|
||||
case *ast.IfStmt:
|
||||
if found := findNestedContext(pass, node, typedStmt.Body.List); found != nil {
|
||||
return found
|
||||
}
|
||||
}
|
||||
|
||||
if inner, ok := stmt.(*ast.SwitchStmt); ok {
|
||||
found := findNestedContext(pass, node, inner.Body.List)
|
||||
if found != nil {
|
||||
case *ast.SwitchStmt:
|
||||
if found := findNestedContext(pass, node, typedStmt.Body.List); found != nil {
|
||||
return found
|
||||
}
|
||||
}
|
||||
|
||||
if inner, ok := stmt.(*ast.CaseClause); ok {
|
||||
found := findNestedContext(pass, node, inner.Body)
|
||||
if found != nil {
|
||||
case *ast.CaseClause:
|
||||
if found := findNestedContext(pass, node, typedStmt.Body); found != nil {
|
||||
return found
|
||||
}
|
||||
}
|
||||
|
||||
if inner, ok := stmt.(*ast.SelectStmt); ok {
|
||||
found := findNestedContext(pass, node, inner.Body.List)
|
||||
if found != nil {
|
||||
case *ast.SelectStmt:
|
||||
if found := findNestedContext(pass, node, typedStmt.Body.List); found != nil {
|
||||
return found
|
||||
}
|
||||
}
|
||||
|
||||
if inner, ok := stmt.(*ast.CommClause); ok {
|
||||
found := findNestedContext(pass, node, inner.Body)
|
||||
if found != nil {
|
||||
case *ast.CommClause:
|
||||
if found := findNestedContext(pass, node, typedStmt.Body); found != nil {
|
||||
return found
|
||||
}
|
||||
}
|
||||
|
@ -174,6 +211,10 @@ func findNestedContext(pass *analysis.Pass, node ast.Node, stmts []ast.Stmt) *as
|
|||
continue
|
||||
}
|
||||
|
||||
if isPointer(pass, assignStmt.Lhs[0]) {
|
||||
return assignStmt
|
||||
}
|
||||
|
||||
// allow assignment to non-pointer children of values defined within the loop
|
||||
if isWithinLoop(assignStmt.Lhs[0], node, pass) {
|
||||
continue
|
||||
|
@ -249,3 +290,13 @@ func getRootIdent(pass *analysis.Pass, node ast.Node) *ast.Ident {
|
|||
}
|
||||
}
|
||||
}
|
||||
|
||||
func isPointer(pass *analysis.Pass, exp ast.Node) bool {
|
||||
switch n := exp.(type) {
|
||||
case *ast.SelectorExpr:
|
||||
sel, ok := pass.TypesInfo.Selections[n]
|
||||
return ok && sel.Indirect()
|
||||
}
|
||||
|
||||
return false
|
||||
}
|
||||
|
|
|
@ -1,8 +1,6 @@
|
|||
package analyzer_test
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
|
||||
"golang.org/x/tools/go/analysis/analysistest"
|
||||
|
@ -10,12 +8,56 @@ import (
|
|||
"github.com/Crocmagnon/fatcontext/pkg/analyzer"
|
||||
)
|
||||
|
||||
func TestAll(t *testing.T) {
|
||||
wd, err := os.Getwd()
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to get wd: %s", err)
|
||||
func TestAnalyzer(t *testing.T) {
|
||||
testCases := []struct {
|
||||
desc string
|
||||
dir string
|
||||
options map[string]string
|
||||
}{
|
||||
{
|
||||
desc: "no func decl",
|
||||
dir: "common",
|
||||
},
|
||||
{
|
||||
desc: "no func decl",
|
||||
dir: "no_structpointer",
|
||||
},
|
||||
{
|
||||
desc: "func decl",
|
||||
dir: "common",
|
||||
options: map[string]string{
|
||||
analyzer.FlagCheckStructPointers: "true",
|
||||
},
|
||||
},
|
||||
{
|
||||
desc: "func decl",
|
||||
dir: "structpointer",
|
||||
options: map[string]string{
|
||||
analyzer.FlagCheckStructPointers: "true",
|
||||
},
|
||||
},
|
||||
}
|
||||
testdata := filepath.Join(filepath.Dir(filepath.Dir(wd)), "testdata")
|
||||
|
||||
analysistest.Run(t, testdata, analyzer.Analyzer, "./...")
|
||||
for _, test := range testCases {
|
||||
t.Run(test.desc+"_"+test.dir, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
a := analyzer.NewAnalyzer()
|
||||
|
||||
for k, v := range test.options {
|
||||
err := a.Flags.Set(k, v)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
}
|
||||
|
||||
analysistest.RunWithSuggestedFixes(t, analysistest.TestData(), a, test.dir)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestAnalyzer_cgo(t *testing.T) {
|
||||
a := analyzer.NewAnalyzer()
|
||||
|
||||
analysistest.Run(t, analysistest.TestData(), a, "cgo")
|
||||
}
|
||||
|
|
51
pkg/analyzer/testdata/src/cgo/cgo.go
vendored
Normal file
51
pkg/analyzer/testdata/src/cgo/cgo.go
vendored
Normal file
|
@ -0,0 +1,51 @@
|
|||
package cgo
|
||||
|
||||
/*
|
||||
#include <stdio.h>
|
||||
#include <stdlib.h>
|
||||
|
||||
void myprint(char* s) {
|
||||
printf("%d\n", s);
|
||||
}
|
||||
*/
|
||||
import "C"
|
||||
|
||||
import (
|
||||
"context"
|
||||
"unsafe"
|
||||
)
|
||||
|
||||
func _() {
|
||||
cs := C.CString("Hello from stdio\n")
|
||||
C.myprint(cs)
|
||||
C.free(unsafe.Pointer(cs))
|
||||
}
|
||||
|
||||
func _() {
|
||||
ctx := context.Background()
|
||||
|
||||
for i := 0; i < 10; i++ {
|
||||
ctx := context.WithValue(ctx, "key", i)
|
||||
ctx = context.WithValue(ctx, "other", "val")
|
||||
}
|
||||
|
||||
for i := 0; i < 10; i++ {
|
||||
ctx = context.WithValue(ctx, "key", i) // want "nested context in loop"
|
||||
ctx = context.WithValue(ctx, "other", "val")
|
||||
}
|
||||
|
||||
for item := range []string{"one", "two", "three"} {
|
||||
ctx = wrapContext(ctx) // want "nested context in loop"
|
||||
ctx := context.WithValue(ctx, "key", item)
|
||||
ctx = wrapContext(ctx)
|
||||
}
|
||||
|
||||
for {
|
||||
ctx = wrapContext(ctx) // want "nested context in loop"
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
func wrapContext(ctx context.Context) context.Context {
|
||||
return context.WithoutCancel(ctx)
|
||||
}
|
|
@ -1,4 +1,4 @@
|
|||
package src
|
||||
package common
|
||||
|
||||
import (
|
||||
"context"
|
251
pkg/analyzer/testdata/src/common/example.go.golden
vendored
Normal file
251
pkg/analyzer/testdata/src/common/example.go.golden
vendored
Normal file
|
@ -0,0 +1,251 @@
|
|||
package common
|
||||
|
||||
import (
|
||||
"context"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func example() {
|
||||
ctx := context.Background()
|
||||
|
||||
for i := 0; i < 10; i++ {
|
||||
ctx := context.WithValue(ctx, "key", i)
|
||||
ctx = context.WithValue(ctx, "other", "val")
|
||||
}
|
||||
|
||||
for i := 0; i < 10; i++ {
|
||||
ctx := context.WithValue(ctx, "key", i) // want "nested context in loop"
|
||||
ctx = context.WithValue(ctx, "other", "val")
|
||||
}
|
||||
|
||||
for item := range []string{"one", "two", "three"} {
|
||||
ctx := wrapContext(ctx) // want "nested context in loop"
|
||||
ctx := context.WithValue(ctx, "key", item)
|
||||
ctx = wrapContext(ctx)
|
||||
}
|
||||
|
||||
for {
|
||||
ctx := wrapContext(ctx) // want "nested context in loop"
|
||||
break
|
||||
}
|
||||
|
||||
// not fooled by shadowing in nested blocks
|
||||
for {
|
||||
err := doSomething()
|
||||
if err != nil {
|
||||
ctx := wrapContext(ctx)
|
||||
ctx = wrapContext(ctx)
|
||||
}
|
||||
|
||||
switch err {
|
||||
case nil:
|
||||
ctx := wrapContext(ctx)
|
||||
ctx = wrapContext(ctx)
|
||||
default:
|
||||
ctx := wrapContext(ctx)
|
||||
ctx = wrapContext(ctx)
|
||||
}
|
||||
|
||||
{
|
||||
ctx := wrapContext(ctx)
|
||||
ctx = wrapContext(ctx)
|
||||
}
|
||||
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
ctx := wrapContext(ctx)
|
||||
ctx = wrapContext(ctx)
|
||||
default:
|
||||
}
|
||||
|
||||
ctx := wrapContext(ctx) // want "nested context in loop"
|
||||
|
||||
break
|
||||
}
|
||||
|
||||
// detects contexts wrapped in function literals (this is risky as function literals can be called multiple times)
|
||||
_ = func() {
|
||||
ctx := wrapContext(ctx) // want "nested context in function literal"
|
||||
}
|
||||
|
||||
// this is fine because the context is created in the loop
|
||||
for {
|
||||
if ctx := context.Background(); doSomething() != nil {
|
||||
ctx = wrapContext(ctx)
|
||||
}
|
||||
}
|
||||
|
||||
for {
|
||||
ctx2 := context.Background()
|
||||
ctx := wrapContext(ctx) // want "nested context in loop"
|
||||
if doSomething() != nil {
|
||||
ctx2 = wrapContext(ctx2)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func wrapContext(ctx context.Context) context.Context {
|
||||
return context.WithoutCancel(ctx)
|
||||
}
|
||||
|
||||
func doSomething() error {
|
||||
return nil
|
||||
}
|
||||
|
||||
// storing contexts in a struct isn't recommended, but local copies of a non-pointer struct should act like local copies of a context.
|
||||
func inStructs(ctx context.Context) {
|
||||
for i := 0; i < 10; i++ {
|
||||
c := struct{ Ctx context.Context }{ctx}
|
||||
c.Ctx = context.WithValue(c.Ctx, "key", i)
|
||||
c.Ctx = context.WithValue(c.Ctx, "other", "val")
|
||||
}
|
||||
|
||||
for i := 0; i < 10; i++ {
|
||||
c := []struct{ Ctx context.Context }{{ctx}}
|
||||
c[0].Ctx = context.WithValue(c[0].Ctx, "key", i)
|
||||
c[0].Ctx = context.WithValue(c[0].Ctx, "other", "val")
|
||||
}
|
||||
|
||||
c := struct{ Ctx context.Context }{ctx}
|
||||
for i := 0; i < 10; i++ {
|
||||
c := c
|
||||
c.Ctx = context.WithValue(c.Ctx, "key", i)
|
||||
c.Ctx = context.WithValue(c.Ctx, "other", "val")
|
||||
}
|
||||
|
||||
pc := &struct{ Ctx context.Context }{ctx}
|
||||
for i := 0; i < 10; i++ {
|
||||
c := pc
|
||||
c.Ctx := context.WithValue(c.Ctx, "key", i) // want "nested context in loop"
|
||||
c.Ctx = context.WithValue(c.Ctx, "other", "val")
|
||||
}
|
||||
|
||||
r := []struct{ Ctx context.Context }{{ctx}}
|
||||
for i := 0; i < 10; i++ {
|
||||
r[0].Ctx := context.WithValue(r[0].Ctx, "key", i) // want "nested context in loop"
|
||||
r[0].Ctx = context.WithValue(r[0].Ctx, "other", "val")
|
||||
}
|
||||
|
||||
rp := []*struct{ Ctx context.Context }{{ctx}}
|
||||
for i := 0; i < 10; i++ {
|
||||
rp[0].Ctx := context.WithValue(rp[0].Ctx, "key", i) // want "nested context in loop"
|
||||
rp[0].Ctx = context.WithValue(rp[0].Ctx, "other", "val")
|
||||
}
|
||||
}
|
||||
|
||||
func inVariousNestedBlocks(ctx context.Context) {
|
||||
for {
|
||||
err := doSomething()
|
||||
if err != nil {
|
||||
ctx := wrapContext(ctx) // want "nested context in loop"
|
||||
}
|
||||
|
||||
break
|
||||
}
|
||||
|
||||
for {
|
||||
err := doSomething()
|
||||
if err != nil {
|
||||
if true {
|
||||
ctx := wrapContext(ctx) // want "nested context in loop"
|
||||
}
|
||||
}
|
||||
|
||||
break
|
||||
}
|
||||
|
||||
for {
|
||||
err := doSomething()
|
||||
switch err {
|
||||
case nil:
|
||||
ctx := wrapContext(ctx) // want "nested context in loop"
|
||||
}
|
||||
|
||||
break
|
||||
}
|
||||
|
||||
for {
|
||||
err := doSomething()
|
||||
switch err {
|
||||
default:
|
||||
ctx := wrapContext(ctx) // want "nested context in loop"
|
||||
}
|
||||
|
||||
break
|
||||
}
|
||||
|
||||
for {
|
||||
ctx := wrapContext(ctx)
|
||||
|
||||
err := doSomething()
|
||||
if err != nil {
|
||||
ctx = wrapContext(ctx)
|
||||
}
|
||||
|
||||
break
|
||||
}
|
||||
|
||||
for {
|
||||
{
|
||||
ctx := wrapContext(ctx) // want "nested context in loop"
|
||||
}
|
||||
|
||||
break
|
||||
}
|
||||
|
||||
for {
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
ctx := wrapContext(ctx) // want "nested context in loop"
|
||||
default:
|
||||
}
|
||||
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
// this middleware could run on every request, bloating the request parameter level context and causing a memory leak
|
||||
func badMiddleware(ctx context.Context) func() error {
|
||||
return func() error {
|
||||
ctx := wrapContext(ctx) // want "nested context in function literal"
|
||||
return doSomethingWithCtx(ctx)
|
||||
}
|
||||
}
|
||||
|
||||
// this middleware is fine, as it doesn't modify the context of parent function
|
||||
func okMiddleware(ctx context.Context) func() error {
|
||||
return func() error {
|
||||
ctx := wrapContext(ctx)
|
||||
return doSomethingWithCtx(ctx)
|
||||
}
|
||||
}
|
||||
|
||||
// this middleware is fine, as it only modifies the context passed to it
|
||||
func okMiddleware2(ctx context.Context) func(ctx context.Context) error {
|
||||
return func(ctx context.Context) error {
|
||||
ctx = wrapContext(ctx)
|
||||
return doSomethingWithCtx(ctx)
|
||||
}
|
||||
}
|
||||
|
||||
func doSomethingWithCtx(ctx context.Context) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func testCasesInit(t *testing.T) {
|
||||
cases := []struct {
|
||||
ctx context.Context
|
||||
}{
|
||||
{},
|
||||
{
|
||||
ctx: context.WithValue(context.Background(), "key", "value"),
|
||||
},
|
||||
}
|
||||
for _, tc := range cases {
|
||||
t.Run("some test", func(t *testing.T) {
|
||||
if tc.ctx == nil {
|
||||
tc.ctx = context.Background()
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
23
pkg/analyzer/testdata/src/no_structpointer/example.go
vendored
Normal file
23
pkg/analyzer/testdata/src/no_structpointer/example.go
vendored
Normal file
|
@ -0,0 +1,23 @@
|
|||
package common
|
||||
|
||||
import (
|
||||
"context"
|
||||
)
|
||||
|
||||
type Container struct {
|
||||
Ctx context.Context
|
||||
}
|
||||
|
||||
func something() func(*Container) {
|
||||
return func(r *Container) {
|
||||
ctx := r.Ctx
|
||||
ctx = context.WithValue(ctx, "key", "val")
|
||||
r.Ctx = ctx
|
||||
}
|
||||
}
|
||||
|
||||
func blah(r *Container) {
|
||||
ctx := r.Ctx
|
||||
ctx = context.WithValue(ctx, "key", "val")
|
||||
r.Ctx = ctx
|
||||
}
|
23
pkg/analyzer/testdata/src/structpointer/example.go
vendored
Normal file
23
pkg/analyzer/testdata/src/structpointer/example.go
vendored
Normal file
|
@ -0,0 +1,23 @@
|
|||
package common
|
||||
|
||||
import (
|
||||
"context"
|
||||
)
|
||||
|
||||
type Container struct {
|
||||
Ctx context.Context
|
||||
}
|
||||
|
||||
func something() func(*Container) {
|
||||
return func(r *Container) {
|
||||
ctx := r.Ctx
|
||||
ctx = context.WithValue(ctx, "key", "val")
|
||||
r.Ctx = ctx // want "potential nested context in struct pointer"
|
||||
}
|
||||
}
|
||||
|
||||
func blah(r *Container) {
|
||||
ctx := r.Ctx
|
||||
ctx = context.WithValue(ctx, "key", "val")
|
||||
r.Ctx = ctx // want "potential nested context in struct pointer"
|
||||
}
|
Loading…
Add table
Reference in a new issue