Fix: Truncate Buildkite Annotation #1645
Conversation
🦋 Changeset detectedLatest commit: aa3c271 The changes in this PR will be included in the next version bump. Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
src/api/buildkite/annotate.ts
Outdated
| @@ -44,6 +49,18 @@ export const annotate = async ( | |||
| return; | |||
| } | |||
|
|
|||
| // Check if the annotation exceeds the maximum size | |||
| const buffer = Buffer.from(markdown, 'utf-8'); | |||
There was a problem hiding this comment.
I might be missing something obvious! What's the reason to use a buffer here?
There was a problem hiding this comment.
As opposed to string.length directly?
My understanding is that the buildkite annotation max is based on a byte size rather than a character length, so this is a more accurate comparison and would account for any characters that may be longer than a byte.
There was a problem hiding this comment.
Interesting, I'm not seeing the distinction drawn in https://buildkite.com/docs/agent/v3/cli-annotate
There was a problem hiding this comment.
Also, I think string length should be ok on that front:
$ node
> '🙂↔️' .length
5
There was a problem hiding this comment.
Oh wow! Did not know .length behaved like that.
There was a problem hiding this comment.
String.length counts UTF-16 code units though. Can we confirm how Buildkite measures its limit?
Co-authored-by: Aaron Moat <2937187+AaronMoat@users.noreply.github.com>
Co-authored-by: Aaron Moat <2937187+AaronMoat@users.noreply.github.com>
…dieEK/skuba into longer-buildkite-annotation
Description
When a Buildkite annotation is over
1 MiBan error occurs.This PR truncates the buildkite annotation to avoid that error, while still logging the full message to the build log.
Motivation & Context
Resolves #1331
Discussion
MAX_SIZEcould potentially be passed in as optional attribute ofoptsif desired, would improve testability and possibly add some flexibility if max size ever needs to be different for different situations.