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

keybase/client: go/chat/unfurl/scrape_generic.go; 27 LoC

Open
#16,171 0 comments 0 reactions 0 assignees View on GitHub
fresh small
Dominant language
No language data
Stars
0
Forks
0
PR merge metrics
PR metrics pending

Description

Found a possible issue in [keybase/client](https://www.github.com/keybase/client) at [go/chat/unfurl/scrape_generic.go](https://github.com/keybase/client/blob/a144e0ce38ee9e495cc5acbcd4ef859f5534d820/go/chat/unfurl/scrape_generic.go#L58-L84)

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 80 may store a reference to content

[Click here to see the code in its original context.](https://github.com/keybase/client/blob/a144e0ce38ee9e495cc5acbcd4ef859f5534d820/go/chat/unfurl/scrape_generic.go#L58-L84)

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

```go
for _, content := range contents {
content = strings.Trim(content, " ")
if content == "" {
continue
}
switch ranker.setter {
case setTitle:
generic.setTitle(content, score)
case setURL:
url := fullURL(hostname, content)
generic.setURL(url, score)
case setSiteName:
generic.setSiteName(content, score)
case setFaviconURL:
url := fullURL(hostname, content)
generic.setFaviconURL(&url, score)
case setImageURL:
url := fullURL(hostname, content)
generic.setImageURL(&url, score)
case setPublishTime:
s.setAndParsePubTime(ctx, content, generic, score)
case setDescription:
generic.setDescription(&content, score)
case setVideo:
generic.setVideo(content, score)
}
}

```

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 {
"(setDescription, 2)" -> {}
}

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: a144e0ce38ee9e495cc5acbcd4ef859f5534d820

Contributor guide

No contributing guide indexed for this repository

Research direction

Read go/chat/unfurl/scrape_generic.go around lines 58-84, then trace setDescription and the pointer passed from the range loop. Determine whether the analyzer finding represents a bug, mitigated behavior, or desirable behavior, and record the corresponding reaction; no comments or linked pull request indicate further project guidance.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.