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

pajbot/pajbot2: cmd/bot/twitchstreamstore.go; 5 LoC

Open
#17,876 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 [pajbot/pajbot2](https://www.github.com/pajbot/pajbot2) at [cmd/bot/twitchstreamstore.go](https://github.com/pajbot/pajbot2/blob/02ec2d7a13b8ad7f946561a52da5dd844607f7bf/cmd/bot/twitchstreamstore.go#L82-L86)

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.

> function call at line 84 may store a reference to activeStream

[Click here to see the code in its original context.](https://github.com/pajbot/pajbot2/blob/02ec2d7a13b8ad7f946561a52da5dd844607f7bf/cmd/bot/twitchstreamstore.go#L82-L86)

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

```go
for _, activeStream := range data {
if stream, ok := s.streams[activeStream.UserID]; ok {
stream.Update(&activeStream)
}
}

```

Click here to show extra information the analyzer produced.

```
The following graphviz dot graph describes paths through the callgraph that could lead to a function which writes a pointer argument:
digraph G {
"(Update, 1)" -> {}
}

No path was found through the callgraph that could lead to a function which passes a pointer 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: 02ec2d7a13b8ad7f946561a52da5dd844607f7bf

Contributor guide

No contributing guide indexed for this repository

Research direction

Read cmd/bot/twitchstreamstore.go at lines 82-86 and inspect Update, the function named by the analyzer. Determine whether passing &activeStream can retain the range variable, then classify the finding as Bug, Mitigated, or Desirable Behavior using the issue's reaction options.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
backend
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.