Ensure to close StreamFrame channel

[nakabonne]

A tiny fix to close the StreamFream channel before finishing the streaming by the <-cancel channel.

Let's say you use FrameReader.Read(), now we have no way to quit the select block even when the streaming finished. (Actually we can pass cancelCh chan struct{} to NewFrameReader but I'd like to stop reading when <-ctx.Done())

Therefore, I would say it should close immediately as soon as the streaming finished.

[hashicorp-cla]

All committers have signed the CLA.

[nakabonne]

Should I do anything else to make the CI successful? Please tell me if there is, thank you.

[tgross]

Hi @nakabonne! Sorry for the delay in reviewing this. I'm looking at the only call site we currently have for this function in Nomad (ref api/fs.go#L341-L357) and it looks like the results end up being the same either way in our current implementation. But this change probably makes it more clear for callers, so LGTM.

I'm not worried about the CI we see failing here, as those are for docs and need approval to run anyways. But for some reason none of the unit tests ran for this PR and I'm not sure why. I'm going to try to rebase this PR on main and see if I can get the build to kick off.

[tgross]

Tests are green, so LGTM! Thanks @nakabonne!

[nakabonne]

@tgross Thank you for maintaining this great project!

[github-actions]

I'm going to lock this pull request because it has been closed for 120 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.