Truncate commit message during Discord webhook push events #31970
Conversation
GiteaBot
added
the
lgtm/need 2
pull-request-size
bot
added
the
size/M
|
|
||
| // a limit of 50 is set because GitHub does the same | ||
| if len(message) > 50 { | ||
| message = fmt.Sprintf("%.47s...", message) |
There was a problem hiding this comment.
From reading the Go docs, it appears that this will treat message as bytes when truncating. Is there a better way of truncating the size of a Go string without having problems with unicode characters? I will continue to find a solution to this when I get the time.
There was a problem hiding this comment.
After further doc reading, I learned that precision is measured in runes when using the %s specifier (if I used %x it would be measured in bytes). So I think my current usage is fine.
There was a problem hiding this comment.
Are you able to test with unicode to see how discord would behave if we sent them truncated characters?
There was a problem hiding this comment.
I modified my test to contain unicode characters. I also realized len(message) returns the # of bytes in message rather than characters. Therefore, I opted to use utf8.RuneCountInString().
However, it appears that git commit messages, although typically utf-8 encoded, could accept other encodings. git encourages use of utf-8 for commit messages, but it doesn't enforce it. So I am not sure if the way I count the # of characters in message and how I truncate message is correct. Using utf8.RuneCountInString() could come with a performance cost (i.e. if the commit summary is very large).
| return pushTestPayloadWithCommitMessage("This is a commit summary that is longer than 50 characters\n\nThis is the message body.") | ||
| } | ||
|
|
||
| func pushTestPayloadWithCommitMessage(message string) *api.PushPayload { |
There was a problem hiding this comment.
Wanted to avoid test code duplication here by adding these 2 functions. I'm open for alternative ways to writing my test case.
This is in-line with what our other webhook implementations do.
kemzeb
force-pushed
the
feat-make-discord-msg-more-readable
branch
from
146603a
to
0983b27
Compare
GiteaBot
added
lgtm/need 1
Resolves #31668.