Bug - Checks containing a lot of logs/data are not sent to GitHub about github-checks-plugin

[timja]

cc @mrginglymus

[j-martin]

I think that's what https://github.com/jenkinsci/github-checks-plugin/pull/101/files is supposed to do. It might just be that the max size be lowered to allow the rest of the payload to be sent.

https://github.com/jenkinsci/github-checks-plugin/pull/101/files#diff-fd0d45e50475b17adec8ca170773d293c9de8536261d66d1f1484598723a862cR37

I am guessing saying it is specific to 1.10 might be wrong.

This is the error we are seeing in our logs so I guess it is still coming from GitHub:

[GitHub Checks] Failed Publishing GitHub checks: org.kohsuke.github.GHFileNotFoundException: https://api.github.com/repos/alloytech/alloy/check-runs/1961940126 {"message":"Validation Failed","errors":[{"resource":"CheckRun","code":"custom","field":"summary","message":"summary exceeds a maximum bytesize of 65535"}],"documentation_url":"https://docs.github.com/rest/reference/checks#update-a-check-run"}

[mrginglymus]

What plugin is sending these checks, or is it a manual invocation of the publishChecks step?

[KalleOlaviNiemitalo]

The GitHub error response says "a maximum bytesize of 65535" but TruncatedString counts characters rather than bytes.

[KalleOlaviNiemitalo]

https://github.community/t/undocumented-65535-character-limit-on-requests/117564 likewise says the limit is 65535 bytes, and applies to each property separately.

I hope that encoding a newline as \n in a JSON string won't consume two of those bytes.

[KalleOlaviNiemitalo]

From jenkinsci/junit-plugin#192 (comment), GitLab and Bitbucket Server have limits given in characters rather than bytes. It might be best to make the Checks API plugin provide an array of strings and make the GitHub Checks plugin measure how many bytes each string will cost.

[mrginglymus]

I can see two things to do - we can update TruncatedString to truncate on byte-length rather than char-length. If that's the root of this problem, then we'll solve it without having to update anything else.

The other thing is to make the TruncatedString able to truncate on char or bytes at the callers discretion; as there's only one at the moment it's less urgent to implement that.

[timja]

The other thing is to make the TruncatedString able to truncate on char or bytes at the callers discretion; as there's only one at the moment it's less urgent to implement that.

not published yet but this was just hosted:
https://github.com/jenkinsci/gitea-checks-plugin

[mrginglymus]

I'm doing it now, and it's easy enough to do both. PR incoming...

[mrginglymus]

jenkinsci/checks-api-plugin#88