github-vet / github-vet/rangeloop-pointer-findings
TicketsBot/TicketsGo: bot/listeners/messagequeue/ticketcloselistener.go; 48 LoC
- Dominant language
- No language data
- Stars
- 0
- Forks
- 0
- PR merge metrics
- PR metrics pending
Description
Found a possible issue in [TicketsBot/TicketsGo](https://www.github.com/TicketsBot/TicketsGo) at [bot/listeners/messagequeue/ticketcloselistener.go](https://github.com/TicketsBot/TicketsGo/blob/f95f46fb3784b5df662d9018c7262702a58024d8/bot/listeners/messagequeue/ticketcloselistener.go#L17-L64)
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.
> range-loop variable payload used in defer or goroutine at line 20
[Click here to see the code in its original context.](https://github.com/TicketsBot/TicketsGo/blob/f95f46fb3784b5df662d9018c7262702a58024d8/bot/listeners/messagequeue/ticketcloselistener.go#L17-L64)
Click here to show the 48 line(s) of Go which triggered the analyzer.
```go
for payload := range closes {
go func() {
// Get the ticket struct
ticket, err := dbclient.Client.Tickets.Get(payload.TicketId, payload.GuildId)
if err != nil {
sentry.Error(err)
return
}
// Check that this is a valid ticket
if ticket.GuildId == 0 {
return
}
// Get session
s := shardManager.ShardForGuild(ticket.GuildId)
if s == nil { // Not on this cluster
return
}
// Create error context for later
errorContext := sentry.ErrorContext{
Guild: ticket.GuildId,
User: payload.User,
Shard: s.ShardId,
}
// Get whether the guild is premium for log archiver
isPremium := make(chan bool)
go utils.IsPremiumGuild(s, ticket.GuildId, isPremium)
// Get the member object
member, err := s.GetGuildMember(ticket.GuildId, payload.User)
if err != nil {
sentry.LogWithContext(err, errorContext)
return
}
// Add reason to args
reason := strings.Split(payload.Reason, " ")
if ticket.ChannelId == nil {
return
}
logic.CloseTicket(s, ticket.GuildId, *ticket.ChannelId, 0, member, reason, false, <-isPremium)
}()
}
```
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: f95f46fb3784b5df662d9018c7262702a58024d8
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with bot/listeners/messagequeue/ticketcloselistener.go at the reported loop and read how closes and its payload are used by the goroutine. Verify the analyzer finding against the referenced commit and ensure each goroutine uses the intended ticket-close data without range-loop capture; done when the warning is resolved without changing ticket-closing behavior.
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
- 48/100