strip ansi control chars from PR comments when called with {"color": "always"}
#859
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,23 @@ | ||
| import * as core from '@actions/core'; | ||
| import { context, getOctokit } from '@actions/github'; | ||
| import AnsiToHtml from 'ansi-to-html'; | ||
| import dedent from 'dedent'; | ||
| import invariant from 'ts-invariant'; | ||
| import { Config } from '../config'; | ||
|
|
||
| function ansiToHtml( | ||
| message: string, | ||
| { maxLength }: { maxLength?: number } = { maxLength: undefined }, | ||
| ) { | ||
| const convert = new AnsiToHtml(); | ||
| let html = convert.toHtml(message); | ||
| while (maxLength !== undefined && html.length > maxLength) { | ||
| message = message.substring(0, message.length - 1); | ||
| html = convert.toHtml(message); | ||
| } | ||
| return html; | ||
| } | ||
|
|
||
| export async function handlePullRequestMessage( | ||
| config: Config, | ||
| projectName: string, | ||
|
|
@@ -20,7 +34,7 @@ export async function handlePullRequestMessage( | |
|
|
||
| const summary = '<summary>Pulumi report</summary>'; | ||
|
|
||
| const rawBody = ansiToHtml(output, { maxLength: 64_000 }); | ||
|
There was a problem hiding this comment. Since this PR touches this code, would you mind pulling this value into a constant so it's not a "magic number"? I'd appreciate it :D |
||
| // a line break between heading and rawBody is needed | ||
| // otherwise the backticks won't work as intended | ||
| const body = dedent` | ||
|
|
@@ -29,9 +43,9 @@ export async function handlePullRequestMessage( | |
| <details> | ||
| ${summary} | ||
|
|
||
| <pre> | ||
| ${rawBody} | ||
| </pre> | ||
| ${ | ||
| rawBody.length === 64_000 | ||
| ? '**Warn**: The output was too long and trimmed.' | ||
|
|
@@ -53,8 +67,9 @@ export async function handlePullRequestMessage( | |
| ...repo, | ||
| issue_number: nr, | ||
| }); | ||
| const comment = comments.find( | ||
| (comment) => | ||
| comment.body.startsWith(heading) && comment.body.includes(summary), | ||
|
Comment on lines
+70
to
+72
There was a problem hiding this comment. This looks like its a purely aesthetic change, right? NBD, just checking. |
||
| ); | ||
|
|
||
| // If comment exists, update it. | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you explain in a comment what this code is doing? It looks like it's truncating the message body according to the max length of the message.
However, it looks like it's only cutting out a single character at a time and attempting to convert to HTML again. I imagine that would be very slow if html.length >>>> maxLength.