Compare commits

...

56 commits

Author SHA1 Message Date
dependabot[bot]
bc6bc802c2 build(deps): bump golangci/golangci-lint-action
Bumps the github-actions group with 1 update: [golangci/golangci-lint-action](https://github.com/golangci/golangci-lint-action).


Updates `golangci/golangci-lint-action` from 6 to 7
- [Release notes](https://github.com/golangci/golangci-lint-action/releases)
- [Commits](https://github.com/golangci/golangci-lint-action/compare/v6...v7)

---
updated-dependencies:
- dependency-name: golangci/golangci-lint-action
  dependency-version: '7'
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: github-actions
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-04-02 19:09:31 +02:00
ecae7266e2 migrate to golangci-lint v2 and enable stricter linters 2025-04-02 19:07:19 +02:00
pre-commit-ci[bot]
134c7a8397 [pre-commit.ci] pre-commit autoupdate
updates:
- [github.com/golangci/golangci-lint: v1.64.7 → v2.0.2](https://github.com/golangci/golangci-lint/compare/v1.64.7...v2.0.2)
2025-04-02 19:07:19 +02:00
e5c81ff0dd update minimum go version 2025-04-02 18:39:55 +02:00
dependabot[bot]
a3efb8903a build(deps): bump golang.org/x/tools from 0.30.0 to 0.31.0
Bumps [golang.org/x/tools](https://github.com/golang/tools) from 0.30.0 to 0.31.0.
- [Release notes](https://github.com/golang/tools/releases)
- [Commits](https://github.com/golang/tools/compare/v0.30.0...v0.31.0)

---
updated-dependencies:
- dependency-name: golang.org/x/tools
  dependency-version: 0.31.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-04-02 18:39:55 +02:00
pre-commit-ci[bot]
96ab752057 [pre-commit.ci] pre-commit autoupdate
updates:
- [github.com/golangci/golangci-lint: v1.64.6 → v1.64.7](https://github.com/golangci/golangci-lint/compare/v1.64.6...v1.64.7)
2025-03-17 23:05:55 +01:00
pre-commit-ci[bot]
2cfdadfd85 [pre-commit.ci] pre-commit autoupdate
updates:
- [github.com/golangci/golangci-lint: v1.64.5 → v1.64.6](https://github.com/golangci/golangci-lint/compare/v1.64.5...v1.64.6)
2025-03-03 23:53:01 +01:00
dependabot[bot]
5a001f2fbe build(deps): bump golang.org/x/tools from 0.29.0 to 0.30.0
Bumps [golang.org/x/tools](https://github.com/golang/tools) from 0.29.0 to 0.30.0.
- [Release notes](https://github.com/golang/tools/releases)
- [Commits](https://github.com/golang/tools/compare/v0.29.0...v0.30.0)

---
updated-dependencies:
- dependency-name: golang.org/x/tools
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-03-02 08:26:11 +01:00
pre-commit-ci[bot]
6f8b43553d [pre-commit.ci] pre-commit autoupdate
updates:
- [github.com/golangci/golangci-lint: v1.63.4 → v1.64.5](https://github.com/golangci/golangci-lint/compare/v1.63.4...v1.64.5)
2025-02-18 00:25:11 +01:00
dependabot[bot]
3947c6f8d5 build(deps): bump golang.org/x/tools from 0.28.0 to 0.29.0
Bumps [golang.org/x/tools](https://github.com/golang/tools) from 0.28.0 to 0.29.0.
- [Release notes](https://github.com/golang/tools/releases)
- [Commits](https://github.com/golang/tools/compare/v0.28.0...v0.29.0)

---
updated-dependencies:
- dependency-name: golang.org/x/tools
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-01-17 01:09:26 +01:00
Fernandez Ludovic
b568e8acf1 chore: groups github action updates 2025-01-17 00:57:15 +01:00
Fernandez Ludovic
ed135bb8e7 chore: use stable and olstable instead of explicit versions 2025-01-17 00:57:15 +01:00
Fernandez Ludovic
12e5409dea tests: add tests on suggested fixes 2025-01-17 00:54:35 +01:00
Fernandez Ludovic
2046ce80db fix: cgo 2025-01-17 00:46:58 +01:00
Fernandez Ludovic
7b0afb1f92 tests: rewrite tests 2025-01-17 00:46:58 +01:00
f887074f5d refactor: nested context recursion 2025-01-17 00:02:58 +01:00
ef9d47d1f0 feat: better discriminate assignations to struct pointers 2025-01-17 00:02:58 +01:00
939d65bc16 fix(goreleaser): draft release 2025-01-14 17:33:18 +01:00
54e593c1c6 feat: ignore context.TODO and context.Background
Related to 
2025-01-14 17:05:35 +01:00
529e088561 fix: goreleaser v2 2025-01-13 22:58:40 +01:00
pre-commit-ci[bot]
52f7fb588c [pre-commit.ci] pre-commit autoupdate
updates:
- [github.com/golangci/golangci-lint: v1.62.2 → v1.63.4](https://github.com/golangci/golangci-lint/compare/v1.62.2...v1.63.4)
2025-01-07 07:49:41 +01:00
dependabot[bot]
6130ad946e build(deps): bump golang.org/x/tools from 0.27.0 to 0.28.0
Bumps [golang.org/x/tools](https://github.com/golang/tools) from 0.27.0 to 0.28.0.
- [Release notes](https://github.com/golang/tools/releases)
- [Commits](https://github.com/golang/tools/compare/v0.27.0...v0.28.0)

---
updated-dependencies:
- dependency-name: golang.org/x/tools
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-01-01 22:41:48 +01:00
dependabot[bot]
48ee2433d6 build(deps): bump golang.org/x/tools from 0.26.0 to 0.27.0
Bumps [golang.org/x/tools](https://github.com/golang/tools) from 0.26.0 to 0.27.0.
- [Release notes](https://github.com/golang/tools/releases)
- [Commits](https://github.com/golang/tools/compare/v0.26.0...v0.27.0)

---
updated-dependencies:
- dependency-name: golang.org/x/tools
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-12-01 23:53:16 +01:00
pre-commit-ci[bot]
4c828f7302 [pre-commit.ci] pre-commit autoupdate
updates:
- [github.com/golangci/golangci-lint: v1.62.0 → v1.62.2](https://github.com/golangci/golangci-lint/compare/v1.62.0...v1.62.2)
2024-11-26 16:37:34 +01:00
Oleksandr Redko
632a706303 refactor: avoid one string to []byte conversion 2024-11-20 15:58:58 +01:00
Oleksandr Redko
98578576b8 chore: format with goimports 2024-11-20 15:56:39 +01:00
pre-commit-ci[bot]
4ad817c8f3 [pre-commit.ci] pre-commit autoupdate
updates:
- [github.com/golangci/golangci-lint: v1.61.0 → v1.62.0](https://github.com/golangci/golangci-lint/compare/v1.61.0...v1.62.0)
2024-11-12 07:25:20 +01:00
dependabot[bot]
fae7a27f40 build(deps): bump golang.org/x/tools from 0.25.0 to 0.26.0
Bumps [golang.org/x/tools](https://github.com/golang/tools) from 0.25.0 to 0.26.0.
- [Release notes](https://github.com/golang/tools/releases)
- [Commits](https://github.com/golang/tools/compare/v0.25.0...v0.26.0)

---
updated-dependencies:
- dependency-name: golang.org/x/tools
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-11-02 09:32:26 +01:00
Gabriel Augendre
fbf73fbd4d
update badge link to wiki 2024-10-30 16:37:48 +01:00
Gabriel Augendre
ed98e56f00
prevent concurrent coverage reports 2024-10-30 16:35:52 +01:00
Gabriel Augendre
7f2b12beab
add coverage badge 2024-10-30 16:29:06 +01:00
Gabriel Augendre
9b1b0c8986
remove unused contrib folder 2024-10-30 16:28:56 +01:00
Gabriel Augendre
1c05d23bb3
fix condition on coverage report job 2024-10-30 16:23:45 +01:00
Gabriel Augendre
e1e94fa7d4
use separate job with specific permissions for coverage report 2024-10-30 16:23:02 +01:00
pre-commit-ci[bot]
db40be2dee [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
2024-10-30 16:17:27 +01:00
Gabriel Augendre
0c76b071d6 add coverage report 2024-10-30 16:17:27 +01:00
Gabriel Augendre
cddb074802
add badges in readme 2024-10-30 15:35:31 +01:00
pre-commit-ci[bot]
548d1beeac [pre-commit.ci] pre-commit autoupdate
updates:
- [github.com/pre-commit/pre-commit-hooks: v4.6.0 → v5.0.0](https://github.com/pre-commit/pre-commit-hooks/compare/v4.6.0...v5.0.0)
2024-10-07 23:43:57 -04:00
dependabot[bot]
7e1e279ad5 build(deps): bump golang.org/x/tools from 0.24.0 to 0.25.0
Bumps [golang.org/x/tools](https://github.com/golang/tools) from 0.24.0 to 0.25.0.
- [Release notes](https://github.com/golang/tools/releases)
- [Commits](https://github.com/golang/tools/compare/v0.24.0...v0.25.0)

---
updated-dependencies:
- dependency-name: golang.org/x/tools
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-10-02 13:53:46 +02:00
pre-commit-ci[bot]
88173f8b3f [pre-commit.ci] pre-commit autoupdate
updates:
- [github.com/golangci/golangci-lint: v1.60.3 → v1.61.0](https://github.com/golangci/golangci-lint/compare/v1.60.3...v1.61.0)
2024-09-10 07:13:57 +02:00
dependabot[bot]
4dc5fc8817 build(deps): bump golang.org/x/tools from 0.23.0 to 0.24.0
Bumps [golang.org/x/tools](https://github.com/golang/tools) from 0.23.0 to 0.24.0.
- [Release notes](https://github.com/golang/tools/releases)
- [Commits](https://github.com/golang/tools/compare/v0.23.0...v0.24.0)

---
updated-dependencies:
- dependency-name: golang.org/x/tools
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-09-02 00:16:13 +02:00
Fernandez Ludovic
25eb4fa74b chore: ignore binary 2024-09-01 13:40:56 +02:00
Fernandez Ludovic
4526c31d1d fix: use mon go1.22.0 2024-09-01 13:40:56 +02:00
pre-commit-ci[bot]
8782199988 [pre-commit.ci] pre-commit autoupdate
updates:
- [github.com/golangci/golangci-lint: v1.60.1 → v1.60.3](https://github.com/golangci/golangci-lint/compare/v1.60.1...v1.60.3)
2024-08-27 08:09:22 +02:00
Gabriel Augendre
4410b65005
doc: update linter description 2024-08-26 10:30:12 +02:00
90afb8d3fa update readme 2024-08-26 07:47:30 +02:00
021f1b4ed6 cd: use go1.23 for golangci-lint 2024-08-26 07:46:50 +02:00
Venkatesh Kotwade
be0aa70f23
Detect nested contexts in function literals ()
* feat: Add detection for nested contexts in function literals
* feat: Improve detection of nested contexts in function literals
* refactor: Update getReportMessage function to handle unsupported nested context types
* use node instead of block
* refactor: use multi case
* added one more case
* feat: also added support for multiple contexts
2024-08-26 07:46:02 +02:00
0d2c4019d4 update go.mod to 1.22 2024-08-25 18:15:22 +02:00
77afd24616 cd: always run all test jobs 2024-08-25 16:00:22 +02:00
2e1ec44b79 drop support for go 1.21, and test against released go 1.23 2024-08-25 15:59:59 +02:00
0be9888cea
Merge pull request from Crocmagnon/pre-commit-ci-update-config
[pre-commit.ci] pre-commit autoupdate
2024-08-20 08:05:44 +02:00
pre-commit-ci[bot]
ab55c271f9
[pre-commit.ci] pre-commit autoupdate
updates:
- [github.com/golangci/golangci-lint: v1.59.1 → v1.60.1](https://github.com/golangci/golangci-lint/compare/v1.59.1...v1.60.1)
2024-08-19 22:52:08 +00:00
46a445090d
Merge pull request from Crocmagnon/dependabot/go_modules/golang.org/x/tools-0.23.0
build(deps): bump golang.org/x/tools from 0.22.0 to 0.23.0
2024-08-02 01:31:47 +02:00
dependabot[bot]
3df83da91f
build(deps): bump golang.org/x/tools from 0.22.0 to 0.23.0
Bumps [golang.org/x/tools](https://github.com/golang/tools) from 0.22.0 to 0.23.0.
- [Release notes](https://github.com/golang/tools/releases)
- [Commits](https://github.com/golang/tools/compare/v0.22.0...v0.23.0)

---
updated-dependencies:
- dependency-name: golang.org/x/tools
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-08-01 21:38:51 +00:00
a80e8ddef6 cd: test with 1.23rc2 2024-07-23 19:13:11 +02:00
20 changed files with 770 additions and 161 deletions

View file

@ -6,6 +6,10 @@ updates:
directory: "/" directory: "/"
schedule: schedule:
interval: "monthly" interval: "monthly"
groups:
github-actions:
patterns:
- "*" # Group all updates into a single larger pull request.
- package-ecosystem: "gomod" - package-ecosystem: "gomod"
directory: "/" directory: "/"
schedule: schedule:

View file

@ -14,8 +14,9 @@ permissions:
jobs: jobs:
build: build:
strategy: strategy:
fail-fast: false
matrix: matrix:
go: ['1.21', '1.22', '1.23.0-rc.1'] go: [stable, oldstable]
os: [macos-latest, windows-latest, ubuntu-latest] os: [macos-latest, windows-latest, ubuntu-latest]
name: build name: build
runs-on: ${{ matrix.os }} runs-on: ${{ matrix.os }}
@ -28,3 +29,21 @@ jobs:
run: go build -v ./... run: go build -v ./...
- name: Test - name: Test
run: make test run: make test
coverage:
name: coverage
permissions:
contents: write
concurrency:
group: coverage
runs-on: ubuntu-latest
needs: [build]
steps:
- name: Update coverage report
uses: ncruces/go-coverage-report@v0
with:
report: true
chart: true
amend: true
if: |
github.event_name == 'push'
continue-on-error: true

View file

@ -16,7 +16,7 @@ jobs:
golangci: golangci:
strategy: strategy:
matrix: matrix:
go: ['1.21', '1.22'] go: [stable, oldstable]
name: lint name: lint
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
@ -25,6 +25,6 @@ jobs:
with: with:
go-version: ${{ matrix.go }} go-version: ${{ matrix.go }}
- name: golangci-lint - name: golangci-lint
uses: golangci/golangci-lint-action@v6 uses: golangci/golangci-lint-action@v7
with: with:
version: latest version: latest

View file

@ -17,6 +17,8 @@ jobs:
fetch-depth: 0 fetch-depth: 0
- name: Set up Go - name: Set up Go
uses: actions/setup-go@v5 uses: actions/setup-go@v5
with:
go-version: stable
- name: Run GoReleaser - name: Run GoReleaser
uses: goreleaser/goreleaser-action@v6 uses: goreleaser/goreleaser-action@v6
with: with:

1
.gitignore vendored
View file

@ -1,3 +1,4 @@
.idea .idea
/fatcontext
dist/ dist/

View file

@ -1,3 +1,18 @@
version: "2"
issues: issues:
exclude-dirs: fix: true
- contrib linters:
default: all
disable:
- depguard
- exhaustruct
formatters:
enable:
- goimports
- gofmt
- gofumpt
- golines
settings:
goimports:
local-prefixes:
- github.com/Crocmagnon/fatcontext

View file

@ -1,12 +1,6 @@
# This is an example .goreleaser.yml file with some sensible defaults.
# Make sure to check the documentation at https://goreleaser.com
# The lines below are called `modelines`. See `:help modeline`
# Feel free to remove those if you don't want/need to use them.
# yaml-language-server: $schema=https://goreleaser.com/static/schema.json # yaml-language-server: $schema=https://goreleaser.com/static/schema.json
# vim: set ts=2 sw=2 tw=0 fo=cnqoj # vim: set ts=2 sw=2 tw=0 fo=cnqoj
version: 2
version: 1
force_token: github force_token: github
@ -45,3 +39,6 @@ changelog:
exclude: exclude:
- "^docs:" - "^docs:"
- "^test:" - "^test:"
release:
draft: true

View file

@ -3,13 +3,13 @@ ci:
repos: repos:
- repo: https://github.com/pre-commit/pre-commit-hooks - repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.6.0 rev: v5.0.0
hooks: hooks:
- id: check-yaml - id: check-yaml
- id: end-of-file-fixer - id: end-of-file-fixer
- id: trailing-whitespace - id: trailing-whitespace
- repo: https://github.com/golangci/golangci-lint - repo: https://github.com/golangci/golangci-lint
rev: v1.59.1 rev: v2.0.2
hooks: hooks:
- id: golangci-lint-full - id: golangci-lint-full
- repo: local - repo: local

View file

@ -1,6 +1,10 @@
# fatcontext # fatcontext
`fatcontext` is a Go linter which detects potential fat contexts in loops. [![Go Reference](https://pkg.go.dev/badge/github.com/Crocmagnon/fatcontext.svg)](https://pkg.go.dev/github.com/Crocmagnon/fatcontext)
[![Go Report Card](https://goreportcard.com/badge/github.com/Crocmagnon/fatcontext)](https://goreportcard.com/report/github.com/Crocmagnon/fatcontext)
[![Go Coverage](https://github.com/Crocmagnon/fatcontext/wiki/coverage.svg)](https://github.com/Crocmagnon/fatcontext/wiki/Coverage)
`fatcontext` is a Go linter which detects potential fat contexts in loops or function literals.
They can lead to performance issues, as documented here: https://gabnotes.org/fat-contexts/ They can lead to performance issues, as documented here: https://gabnotes.org/fat-contexts/
## Installation / usage ## Installation / usage
@ -12,8 +16,6 @@ go install github.com/Crocmagnon/fatcontext/cmd/fatcontext@latest
fatcontext ./... fatcontext ./...
``` ```
There are no specific configuration options or custom command-line flags.
## Example ## Example
```go ```go

View file

@ -1,10 +1,12 @@
// Package main runs the analyzer. It's the CLI entrypoint.
package main package main
import ( import (
"github.com/Crocmagnon/fatcontext/pkg/analyzer"
"golang.org/x/tools/go/analysis/singlechecker" "golang.org/x/tools/go/analysis/singlechecker"
"github.com/Crocmagnon/fatcontext/pkg/analyzer"
) )
func main() { func main() {
singlechecker.Main(analyzer.Analyzer) singlechecker.Main(analyzer.NewAnalyzer())
} }

View file

@ -1,21 +0,0 @@
package contrib
import "context"
func ok() {
ctx := context.Background()
for i := 0; i < 10; i++ {
ctx := context.WithValue(ctx, "key", i)
_ = ctx
}
}
func notOk() {
ctx := context.Background()
for i := 0; i < 10; i++ {
ctx = context.WithValue(ctx, "key", i) // "nested context in loop"
_ = ctx
}
}

8
go.mod
View file

@ -1,10 +1,10 @@
module github.com/Crocmagnon/fatcontext module github.com/Crocmagnon/fatcontext
go 1.21 go 1.23.0
require golang.org/x/tools v0.22.0 require golang.org/x/tools v0.31.0
require ( require (
golang.org/x/mod v0.18.0 // indirect golang.org/x/mod v0.24.0 // indirect
golang.org/x/sync v0.7.0 // indirect golang.org/x/sync v0.12.0 // indirect
) )

14
go.sum
View file

@ -1,6 +1,8 @@
golang.org/x/mod v0.18.0 h1:5+9lSbEzPSdWkH32vYPBwEpX8KwDbM52Ud9xBUvNlb0= github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
golang.org/x/mod v0.18.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c= github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
golang.org/x/sync v0.7.0 h1:YsImfSBoP9QPYL0xyKJPq0gcaJdG3rInoqxTWbfQu9M= golang.org/x/mod v0.24.0 h1:ZfthKaKaT4NrhGVZHO1/WDTwGES4De8KtWO0SIbNJMU=
golang.org/x/sync v0.7.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= golang.org/x/mod v0.24.0/go.mod h1:IXM97Txy2VM4PJ3gI61r1YEk/gAj6zAHN3AdZt6S9Ww=
golang.org/x/tools v0.22.0 h1:gqSGLZqv+AI9lIQzniJ0nZDRG5GBPsSi+DRNHWNz6yA= golang.org/x/sync v0.12.0 h1:MHc5BpPuC30uJk597Ri8TV3CNZcTLu6B6z4lJy+g6Jw=
golang.org/x/tools v0.22.0/go.mod h1:aCwcsjqvq7Yqt6TNyX7QMU2enbQ/Gt0bo6krSeEri+c= golang.org/x/sync v0.12.0/go.mod h1:1dzgHSNfp02xaA81J2MS99Qcpr2w7fw1gpm99rleRqA=
golang.org/x/tools v0.31.0 h1:0EedkvKDbh+qistFTd0Bcwe/YLh4vHwWEkiI0toFIBU=
golang.org/x/tools v0.31.0/go.mod h1:naFTU+Cev749tSJRXJlna0T3WxKvb1kWEx15xA4SdmQ=

View file

@ -1,33 +1,69 @@
// Package analyzer contains everything related to the linter analysis.
package analyzer package analyzer
import ( import (
"bytes" "bytes"
"errors" "errors"
"flag"
"fmt" "fmt"
"go/ast" "go/ast"
"go/printer" "go/printer"
"go/token" "go/token"
"slices"
"golang.org/x/tools/go/analysis" "golang.org/x/tools/go/analysis"
"golang.org/x/tools/go/analysis/passes/inspect" "golang.org/x/tools/go/analysis/passes/inspect"
"golang.org/x/tools/go/ast/inspector" "golang.org/x/tools/go/ast/inspector"
) )
var Analyzer = &analysis.Analyzer{ // FlagCheckStructPointers is a possible flag for the analyzer.
// Exported to make it usable in golangci-lint.
const FlagCheckStructPointers = "check-struct-pointers"
// NewAnalyzer returns a fatcontext analyzer.
func NewAnalyzer() *analysis.Analyzer {
rnnr := &runner{}
flags := flag.NewFlagSet("fatcontext", flag.ExitOnError)
flags.BoolVar(&rnnr.DetectInStructPointers, FlagCheckStructPointers, false,
"set to true to detect potential fat contexts in struct pointers")
return &analysis.Analyzer{
Name: "fatcontext", Name: "fatcontext",
Doc: "detects nested contexts in loops", Doc: "detects nested contexts in loops and function literals",
Run: run, Run: rnnr.run,
Flags: *flags,
Requires: []*analysis.Analyzer{inspect.Analyzer}, Requires: []*analysis.Analyzer{inspect.Analyzer},
} }
}
var errUnknown = errors.New("unknown node type") var (
errUnknown = errors.New("unknown node type")
errInvalidAnalysis = errors.New("invalid analysis")
)
func run(pass *analysis.Pass) (interface{}, error) { const (
inspctr := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector) 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, typeValid := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
if !typeValid {
return nil, errInvalidAnalysis
}
nodeFilter := []ast.Node{ nodeFilter := []ast.Node{
(*ast.ForStmt)(nil), (*ast.ForStmt)(nil),
(*ast.RangeStmt)(nil), (*ast.RangeStmt)(nil),
(*ast.FuncLit)(nil),
(*ast.FuncDecl)(nil),
} }
inspctr.Preorder(nodeFilter, func(node ast.Node) { inspctr.Preorder(nodeFilter, func(node ast.Node) {
@ -36,11 +72,47 @@ func run(pass *analysis.Pass) (interface{}, error) {
return return
} }
assignStmt := findNestedContext(pass, body, body.List) if body == nil {
return
}
assignStmt := findNestedContext(pass, node, body.List)
if assignStmt == nil { if assignStmt == nil {
return return
} }
category := getCategory(pass, node, assignStmt)
if r.shouldIgnoreReport(category) {
return
}
fixes := r.getSuggestedFixes(pass, assignStmt, category)
pass.Report(analysis.Diagnostic{
Pos: assignStmt.Pos(),
Message: category,
SuggestedFixes: fixes,
})
})
return nil, nil //nolint:nilnil // we have no result to send to other analyzers
}
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{ suggestedStmt := ast.AssignStmt{
Lhs: assignStmt.Lhs, Lhs: assignStmt.Lhs,
TokPos: assignStmt.TokPos, TokPos: assignStmt.TokPos,
@ -57,81 +129,55 @@ func run(pass *analysis.Pass) (interface{}, error) {
{ {
Pos: assignStmt.Pos(), Pos: assignStmt.Pos(),
End: assignStmt.End(), End: assignStmt.End(),
NewText: []byte(suggested), NewText: suggested,
}, },
}, },
}) })
} }
pass.Report(analysis.Diagnostic{ return fixes
Pos: assignStmt.Pos(), }
Message: "nested context in loop",
SuggestedFixes: fixes,
})
}) func getCategory(pass *analysis.Pass, node ast.Node, assignStmt *ast.AssignStmt) string {
switch node.(type) {
case *ast.ForStmt, *ast.RangeStmt:
return categoryInLoop
}
return nil, nil if isPointer(pass, assignStmt.Lhs[0]) {
return categoryInStructPointer
}
switch node.(type) {
case *ast.FuncLit, *ast.FuncDecl:
return categoryInFuncLit
default:
return categoryUnsupported
}
} }
func getBody(node ast.Node) (*ast.BlockStmt, error) { func getBody(node ast.Node) (*ast.BlockStmt, error) {
forStmt, ok := node.(*ast.ForStmt) switch typedNode := node.(type) {
if ok { case *ast.ForStmt:
return forStmt.Body, nil return typedNode.Body, nil
} case *ast.RangeStmt:
return typedNode.Body, nil
rangeStmt, ok := node.(*ast.RangeStmt) case *ast.FuncLit:
if ok { return typedNode.Body, nil
return rangeStmt.Body, nil case *ast.FuncDecl:
return typedNode.Body, nil
} }
return nil, errUnknown return nil, errUnknown
} }
func findNestedContext(pass *analysis.Pass, block *ast.BlockStmt, stmts []ast.Stmt) *ast.AssignStmt { func findNestedContext(pass *analysis.Pass, node ast.Node, stmts []ast.Stmt) *ast.AssignStmt {
for _, stmt := range stmts { for _, stmt := range stmts {
// Recurse if necessary // Recurse if necessary
if inner, ok := stmt.(*ast.BlockStmt); ok { stmtList := getStmtList(stmt)
found := findNestedContext(pass, inner, inner.List) if found := findNestedContext(pass, node, stmtList); found != nil {
if found != nil {
return found return found
} }
}
if inner, ok := stmt.(*ast.IfStmt); ok {
found := findNestedContext(pass, inner.Body, inner.Body.List)
if found != nil {
return found
}
}
if inner, ok := stmt.(*ast.SwitchStmt); ok {
found := findNestedContext(pass, inner.Body, inner.Body.List)
if found != nil {
return found
}
}
if inner, ok := stmt.(*ast.CaseClause); ok {
found := findNestedContext(pass, block, inner.Body)
if found != nil {
return found
}
}
if inner, ok := stmt.(*ast.SelectStmt); ok {
found := findNestedContext(pass, inner.Body, inner.Body.List)
if found != nil {
return found
}
}
if inner, ok := stmt.(*ast.CommClause); ok {
found := findNestedContext(pass, block, inner.Body)
if found != nil {
return found
}
}
// Actually check for nested context // Actually check for nested context
assignStmt, ok := stmt.(*ast.AssignStmt) assignStmt, ok := stmt.(*ast.AssignStmt)
@ -149,16 +195,21 @@ func findNestedContext(pass *analysis.Pass, block *ast.BlockStmt, stmts []ast.St
} }
if assignStmt.Tok == token.DEFINE { if assignStmt.Tok == token.DEFINE {
break continue
}
// Ignore [context.Background] & [context.TODO].
if isContextFunction(assignStmt.Rhs[0], "Background", "TODO") {
continue
}
if isPointer(pass, assignStmt.Lhs[0]) {
return assignStmt
} }
// allow assignment to non-pointer children of values defined within the loop // allow assignment to non-pointer children of values defined within the loop
if lhs := getRootIdent(pass, assignStmt.Lhs[0]); lhs != nil { if isWithinLoop(assignStmt.Lhs[0], node, pass) {
if obj := pass.TypesInfo.ObjectOf(lhs); obj != nil { continue
if obj.Pos() >= block.Pos() && obj.Pos() < block.End() {
continue // definition is within the loop
}
}
} }
return assignStmt return assignStmt
@ -167,29 +218,99 @@ func findNestedContext(pass *analysis.Pass, block *ast.BlockStmt, stmts []ast.St
return nil return nil
} }
func getStmtList(stmt ast.Stmt) []ast.Stmt {
switch typedStmt := stmt.(type) {
case *ast.BlockStmt:
return typedStmt.List
case *ast.IfStmt:
return typedStmt.Body.List
case *ast.SwitchStmt:
return typedStmt.Body.List
case *ast.CaseClause:
return typedStmt.Body
case *ast.SelectStmt:
return typedStmt.Body.List
case *ast.CommClause:
return typedStmt.Body
}
return nil
}
// render returns the pretty-print of the given node.
func render(fset *token.FileSet, x interface{}) ([]byte, error) {
var buf bytes.Buffer
if err := printer.Fprint(&buf, fset, x); err != nil {
return nil, fmt.Errorf("printing node: %w", err)
}
return buf.Bytes(), nil
}
func isContextFunction(exp ast.Expr, fnName ...string) bool {
call, typeValid := exp.(*ast.CallExpr)
if !typeValid {
return false
}
selector, typeValid := call.Fun.(*ast.SelectorExpr)
if !typeValid {
return false
}
ident, typeValid := selector.X.(*ast.Ident)
if !typeValid {
return false
}
return ident.Name == "context" && slices.Contains(fnName, selector.Sel.Name)
}
func isWithinLoop(exp ast.Expr, node ast.Node, pass *analysis.Pass) bool {
lhs := getRootIdent(pass, exp)
if lhs == nil {
return false
}
obj := pass.TypesInfo.ObjectOf(lhs)
if obj == nil {
return false
}
scope := obj.Parent()
if scope == nil {
return false
}
return scope.Pos() >= node.Pos() && scope.End() <= node.End()
}
func getRootIdent(pass *analysis.Pass, node ast.Node) *ast.Ident { func getRootIdent(pass *analysis.Pass, node ast.Node) *ast.Ident {
for { for {
switch n := node.(type) { switch typedNode := node.(type) {
case *ast.Ident: case *ast.Ident:
return n return typedNode
case *ast.IndexExpr: case *ast.IndexExpr:
node = n.X node = typedNode.X
case *ast.SelectorExpr: case *ast.SelectorExpr:
if sel, ok := pass.TypesInfo.Selections[n]; ok && sel.Indirect() { if sel, ok := pass.TypesInfo.Selections[typedNode]; ok && sel.Indirect() {
return nil // indirected (pointer) roots don't imply a (safe) copy return nil // indirected (pointer) roots don't imply a (safe) copy
} }
node = n.X
node = typedNode.X
default: default:
return nil return nil
} }
} }
} }
// render returns the pretty-print of the given node func isPointer(pass *analysis.Pass, exp ast.Node) bool {
func render(fset *token.FileSet, x interface{}) (string, error) { switch n := exp.(type) { //nolint:gocritic // Future-proofing with switch instead of if.
var buf bytes.Buffer case *ast.SelectorExpr:
if err := printer.Fprint(&buf, fset, x); err != nil { sel, ok := pass.TypesInfo.Selections[n]
return "", fmt.Errorf("printing node: %w", err)
return ok && sel.Indirect()
} }
return buf.String(), nil
return false
} }

View file

@ -1,19 +1,67 @@
package analyzer_test package analyzer_test
import ( import (
"github.com/Crocmagnon/fatcontext/pkg/analyzer"
"golang.org/x/tools/go/analysis/analysistest"
"os"
"path/filepath"
"testing" "testing"
"golang.org/x/tools/go/analysis/analysistest"
"github.com/Crocmagnon/fatcontext/pkg/analyzer"
) )
func TestAll(t *testing.T) { func TestAnalyzer(t *testing.T) {
wd, err := os.Getwd() t.Parallel()
if err != nil {
t.Fatalf("Failed to get wd: %s", err)
}
testdata := filepath.Join(filepath.Dir(filepath.Dir(wd)), "testdata")
analysistest.Run(t, testdata, analyzer.Analyzer, "./...") 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",
},
},
}
for _, test := range testCases {
t.Run(test.desc+"_"+test.dir, func(t *testing.T) {
t.Parallel()
anlzr := analyzer.NewAnalyzer()
for k, v := range test.options {
err := anlzr.Flags.Set(k, v)
if err != nil {
t.Fatal(err)
}
}
analysistest.RunWithSuggestedFixes(t, analysistest.TestData(), anlzr, test.dir)
})
}
}
func TestAnalyzer_cgo(t *testing.T) {
t.Parallel()
a := analyzer.NewAnalyzer()
analysistest.Run(t, analysistest.TestData(), a, "cgo")
} }

51
pkg/analyzer/testdata/src/cgo/cgo.go vendored Normal file
View 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)
}

View file

@ -1,6 +1,9 @@
package src package common
import "context" import (
"context"
"testing"
)
func example() { func example() {
ctx := context.Background() ctx := context.Background()
@ -59,6 +62,26 @@ func example() {
break 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 { func wrapContext(ctx context.Context) context.Context {
@ -180,3 +203,49 @@ func inVariousNestedBlocks(ctx context.Context) {
break 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()
}
})
}
}

View 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()
}
})
}
}

View 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
}

View 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"
}