Replace usages of bytes.Buffer with strings.Builder #14539
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
mattrobenolt
requested review from
deepthi,
mattlord,
rohit-nayak-ps,
harshit-gangal,
systay,
shlomi-noach,
GuptaManan100,
frouioui,
ajm188 and
vmg
as code owners
Review ChecklistHello reviewers! 👋 Please follow this checklist when reviewing this Pull Request. General
Tests
Documentation
New flags
If a workflow is added or modified:
Backward compatibility
|
vitess-bot
bot
added
NeedsDescriptionUpdate
mattrobenolt
commented
Nov 17, 2023
| @@ -65,7 +65,7 @@ func (buf *Buffer) String() string { | |||
| // is _not_ allocated, so modifying this buffer after calling StringUnsafe will lead | |||
| // to undefined behavior. | |||
| func (buf *Buffer) StringUnsafe() string { | |||
| return *(*string)(unsafe.Pointer(&buf.bytes)) | |||
| return unsafe.String(unsafe.SliceData(buf.bytes), len(buf.bytes)) | |||
There was a problem hiding this comment.
I can pull this out into a separate change, but just came across it while doing all of this, and figured it'd be good to adopt the newer convention from go1.20.
| if tcase.outSQL != buf.String() { | ||
| t.Errorf("%v.EncodeSQL = %q, want %q", tcase.in, buf.String(), tcase.outSQL) | ||
| } | ||
| buf = &bytes.Buffer{} | ||
| tcase.in.EncodeASCII(buf) | ||
| buf.Reset() |
There was a problem hiding this comment.
Changed to just reset and reuse the buffer instead of creating a new one.
| @@ -301,7 +300,7 @@ func registerDebugBlockProfileRate() { | |||
| runtime.SetBlockProfileRate(rate) | |||
| log.Infof("Set block profile rate to: %d", rate) | |||
| w.Header().Set("Content-Type", "text/plain") | |||
| w.Write([]byte(message)) | |||
| io.WriteString(w, message) | |||
There was a problem hiding this comment.
Other places within here were using io.WriteString, so maintained the convention.
| var b strings.Builder | ||
| sqlparser.EncodeValue(&b, v) | ||
| bindVars[k] = b.String() | ||
| buf.Reset() |
There was a problem hiding this comment.
Might as well reuse the buffer here.
mattrobenolt
force-pushed
the
strings-builder
branch
3 times, most recently
from
4e04278 to
4c8b368
Compare
I went through each of these manually and eyeballed to make sure they followed the pattern of only creating the buffer and using the result of .String() after later. I didn't do everything within tests since I didn't think it was too relevant. I also unified some of the usage patterns to be `var buf strings.Builder` as opposed to `buf := new(bytes.Buffer)` etc. All of the rest of the changes were just from gofmt. I'm assuming they are fine, but I understand this adds some more noise to the diffs and might not be desired. I can look into teasing them out if that's a concern. But overall, this change should yield 1 less memory allocation since the bytes -> string is done without an extra allocation. Signed-off-by: Matt Robenolt <[email protected]>
mattrobenolt
force-pushed
the
strings-builder
branch
from
4c8b368 to
0147a05
Compare
vmg
approved these changes
Nov 17, 2023
vmg
added
Type: Internal Cleanup
Type: Performance
Component: General
deepthi
approved these changes
Nov 17, 2023
Yeah, I considered that, but figured it wasn't really worth it. It's likely an impact, but hard to quantify if it's measurable or not and would depend on the workload, etc. |
ejortegau
pushed a commit
to slackhq/vitess
that referenced
this pull request
Dec 13, 2023
Signed-off-by: Matt Robenolt <[email protected]>
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.
Description
I went through each of these manually and eyeballed to make sure they followed the pattern of only creating the buffer and using the result of .String() after later.
I didn't do everything within tests since I didn't think it was too relevant.
I also unified some of the usage patterns to be
var buf strings.Builderas opposed tobuf := new(bytes.Buffer)etc.All of the rest of the changes were just from gofmt. I'm assuming they are fine, but I understand this adds some more noise to the diffs and might not be desired. I can look into teasing them out if that's a concern.
But overall, this change should yield 1 less memory allocation since the bytes -> string is done without an extra allocation.
Related Issue(s)
Checklist
Deployment Notes