Merge pull request #266 from github/truncate-post-deploy-messages

handle messages that are bigger than issue body limit

Author: GrantBirki

__tests__/functions/actions-status.test.js

@@ -1,4 +1,5 @@
 import {actionStatus} from '../../src/functions/action-status'
+import {truncateCommentBody} from '../../src/functions/truncate-comment-body'
 
 var context
 var octokit
@@ -156,3 +157,28 @@ test('uses default log url when the "message" variable is empty for a success',
     repo: 'test'
   })
 })
+
+test('truncates the message when it is too large for an issue comment', async () => {
+  const message = 'a'.repeat(65538)
+  expect(await actionStatus(context, octokit, 123, message, true)).toBe(
+    undefined
+  )
+  expect(octokit.rest.issues.createComment).toHaveBeenCalledWith({
+    body: truncateCommentBody(message),
+    issue_number: 1,
+    owner: 'corp',
+    repo: 'test'
+  })
+  expect(octokit.rest.reactions.createForIssueComment).toHaveBeenCalledWith({
+    comment_id: '1',
+    content: 'rocket',
+    owner: 'corp',
+    repo: 'test'
+  })
+  expect(octokit.rest.reactions.deleteForIssueComment).toHaveBeenCalledWith({
+    comment_id: '1',
+    owner: 'corp',
+    reaction_id: 123,
+    repo: 'test'
+  })
+})

__tests__/functions/truncate-comment-body.test.js

@@ -0,0 +1,14 @@
+import {truncateCommentBody} from '../../src/functions/truncate-comment-body'
+
+test('truncates a long message', () => {
+  const message = 'a'.repeat(65537)
+  const got = truncateCommentBody(message)
+  expect(got).toContain('The message is too large to be posted as a comment.')
+  expect(got.length).toBeLessThanOrEqual(65536)
+})
+
+test('does not truncate a short message', () => {
+  const message = 'a'.repeat(65536)
+  const got = truncateCommentBody(message)
+  expect(got).toEqual(message)
+})

dist/index.js

@@ -1,3 +1,5 @@
+import {truncateCommentBody} from './truncate-comment-body'
+
 // Default failure reaction
 const thumbsDown = '-1'
 // Default success reaction
@@ -28,11 +30,10 @@ export async function actionStatus(
     message = 'Unknown error, [check logs](' + log_url + ') for more details.'
   }
 
-  // add a comment to the issue with the message
   await octokit.rest.issues.createComment({
     ...context.repo,
     issue_number: context.issue.number,
-    body: message
+    body: truncateCommentBody(message)
   })
 
   // Select the reaction to add to the issue_comment

dist/index.js.map

@@ -0,0 +1,20 @@
+const truncatedMessageStart =
+  'The message is too large to be posted as a comment.\n<details><summary>Click to see the truncated message</summary>\n'
+const truncatedMessageEnd = '\n</details>'
+// The maximum length of an issue comment body
+const maxCommentLength = 65536
+
+// Helper function to truncate the body of a comment if it is too long. If the message is too long,
+// it will be truncated and wrapped in a details tag. If the message is short enough, it will be
+// returned as is.
+// :param message: The message to be truncated (String)
+export function truncateCommentBody(message) {
+  if (message.length <= maxCommentLength) {
+    return message
+  }
+  let truncated = message.substring(
+    0,
+    maxCommentLength - truncatedMessageStart.length - truncatedMessageEnd.length
+  )
+  return truncatedMessageStart + truncated + truncatedMessageEnd
+}