fix: post the summary without the queries table when the comment is too large (#170)

Author: cx-artur-ribeiro

src/commenter.js

@@ -130,8 +130,13 @@ function computeHeaders(flattenedQueries) {
     return [...new Set(tmpHeader.map(v => v))]
 }
 
+const MAX_COMMENT_LENGTH = 65536;
+
 async function postPRComment(results, repo, prNumber, octokit, commentWithQueries = false, excludedColumnsForCommentsWithQueries) {
-    const message = createComment(results, commentWithQueries, excludedColumnsForCommentsWithQueries);
+    let message = createComment(results, commentWithQueries, excludedColumnsForCommentsWithQueries);
+    if (message.length > MAX_COMMENT_LENGTH) {
+        message = createComment(results) + "_The queries table was omitted: it exceeds the GitHub comment size limit._\n";
+    }
 
     const comments = await octokit.paginate(octokit.rest.issues.listComments, {
         ...repo,

test/unit/commenter.test.js

@@ -129,7 +129,7 @@ test('GitHub comment size limit', async (t) => {
         assert.ok(postedBody(fake).length < MAX_COMMENT_LENGTH)
     })
 
-    await t.test('a huge report with queries still gets posted', knownBug('GitHub rejects bodies over 65536 characters with 422; the report must be truncated or split'), async (t) => {
+    await t.test('a huge report with queries still gets posted', async (t) => {
         const fake = await startFakeGitHub(t)
         const many = Array.from({ length: 400 }, (_, i) => finding({ file_name: `modules/service-${i}/main.tf`, line: i + 1 }))
         const results = kicsResults({ queries: [query({ files: many })] })