Use go-functional in repositories list methods
#3383
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
danail-branekov
force-pushed
the
use-iterators-in-repos
branch
2 times, most recently
from
dcbaa3c
to
0f99344
Compare
BooleanCat
reviewed
Jul 17, 2024
BooleanCat
reviewed
Jul 17, 2024
Comment on lines
+89
to
+144
| func readLines(r io.Reader, logger logr.Logger) []string { | ||
| lines := []string{} | ||
|
|
||
| var err error | ||
| var line []byte | ||
| bufReader := bufio.NewReader(r) | ||
| for { | ||
| line, err = bufReader.ReadBytes('\n') | ||
| lines = append(lines, string(line)) | ||
| if err != nil { | ||
| if err != io.EOF { | ||
| logger.Info("failed to parse pod logs", "err", err) | ||
| } | ||
| break | ||
| } |
There was a problem hiding this comment.
Using go-functional v2, see it.Lines - you can iterate over lines from a reader.
There was a problem hiding this comment.
lines, errs := itx.LinesString(r).Unzip()
if len(errs.Collect()) > 0 {
panic("Ahhh")
}
lines.Collect()There was a problem hiding this comment.
Or if you know reading cannot fail such as with reading from a string buffer:
lines := itx.LinesString(r).Left().Collect()There was a problem hiding this comment.
We wanted to get as much logs as we can regardless read errors. go-functional v1 LinesString did not look it supported that (i.e. it just failed) so we kept that code. When switching to v2 we would make use of itx.LinesString for sure
BooleanCat
reviewed
Jul 17, 2024
api/repositories/pod_repository.go
Outdated
| logReadCloser, err := k8sClient.CoreV1().Pods(pod.Namespace).GetLogs(pod.Name, &corev1.PodLogOptions{Timestamps: true, TailLines: &limit}).Stream(ctx) | ||
| if err != nil { | ||
| logger.Info("failed to fetch logs", "pod", pod.Name, "reason", err) | ||
| return iter.Lift([]LogRecord{}) |
There was a problem hiding this comment.
For this there's the more explicit iter.Exhausted[LogRecord]()
There was a problem hiding this comment.
ah, nice! Will use that :)
danail-branekov
force-pushed
the
use-iterators-in-repos
branch
2 times, most recently
from
fd4eeed
to
42b9d55
Compare
This eliminates quite some boilerplate code around filtering and mapping k8s resources. `go-functional` also replaces our inhouse filtering implementation. Also, this change removes code duplications in methods such as `GetSomethingByAandB` that list and filter resources. Instead of implementing the list operation themselves, they delegate to the relevant `list` method by constructing a list messages that matches the criteria they need. As a further improvement we could get rid of those methods and just invoke `repo.List` from the handlers. As a consequence of this change those methods now return a `NotFound` error rather than `Unauthorised` when the user is not allowed to list the resources. However, that is fine as the related api handlers mask fobidden errors as not found, so no change from API users' point of view Co-authored-by: Danail Branekov <danailster@gmail.com> Co-authored-by: Georgi Sabev <georgethebeatle@gmail.com>
danail-branekov
force-pushed
the
use-iterators-in-repos
branch
from
42b9d55
to
9ca1d22
Compare
georgethebeatle
approved these changes
Jul 19, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Is there a related GitHub Issue?
No
What is this change about?
This eliminates quite some boilerplate code around filtering and mapping
k8s resources.
go-functionalalso replaces our inhouse filteringimplementation.
Also, this change removes code duplications in methods such as
GetSomethingByAandBthat list and filter resources. Instead ofimplementing the list operation themselves, they delegate to the
relevant
listmethod by constructing a list messages that matches thecriteria they need. As a further improvement we could get rid of those
methods and just invoke
repo.Listfrom the handlers.As a consequence of this change those methods now return a
NotFounderror rather than
Unauthorisedwhen the user is not allowed to listthe resources. Still, that should be OK
Does this PR introduce a breaking change?
No
Tag your pair, your PM, and/or team
@georgethebeatle