github-vet / github-vet/rangeloop-pointer-findings

IvanWhisper/apidoc2entity: generator/Generator.go; 3 LoC

Open
#10,701 0 comments 0 reactions 0 assignees View on GitHub
fresh tiny
Dominant language
No language data
Stars
0
Forks
0
PR merge metrics
PR metrics pending

Description

Found a possible issue in [IvanWhisper/apidoc2entity](https://www.github.com/IvanWhisper/apidoc2entity) at [generator/Generator.go](https://github.com/IvanWhisper/apidoc2entity/blob/16f97d078bfb64c63a4f8aa85f67846e068c4349/generator/Generator.go#L35-L37)

Below is the message reported by the analyzer for this snippet of code. Beware that the analyzer only reports the first
issue it finds, so please do not limit your consideration to the contents of the below message.

>

[Click here to see the code in its original context.](https://github.com/IvanWhisper/apidoc2entity/blob/16f97d078bfb64c63a4f8aa85f67846e068c4349/generator/Generator.go#L35-L37)

Click here to show the 3 line(s) of Go which triggered the analyzer.

```go
for _, field := range bstruct.BFields {
buf.WriteString(fieldfunc(&field))
}

```

Click here to show extra information the analyzer produced.

```
No path was found through the callgraph that could lead to a function which writes a pointer argument.

No path was found through the callgraph that could lead to a function which passes a pointer to third-party code.

root signature {fieldfunc 1} was not found in the callgraph; reference was passed directly to third-party code
```

Leave a reaction on this issue to contribute to the project by classifying this instance as a **Bug** :-1:, **Mitigated** :+1:, or **Desirable Behavior** :rocket:
See the descriptions of the classifications [here](https://github.com/github-vet/rangeclosure-findings#how-can-i-help) for more information.

commit ID: 16f97d078bfb64c63a4f8aa85f67846e068c4349

Contributor guide

No contributing guide indexed for this repository

Research direction

Read generator/Generator.go around lines 35-37 and inspect how fieldfunc uses the field pointer. Determine whether the range variable's address can escape or be retained, then verify the behavior with the repository's available tests or analyzer context. Done means the finding is classified as a bug, mitigated issue, or desirable behavior with supporting evidence.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
tooling
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.