mirror of https://github.com/go-gitea/gitea.git
Switch to ansi_up for ansi rendering in actions (#25401)
Fixes: https://github.com/go-gitea/gitea/issues/24777pull/25425/head^2
silverwind
2 years ago
committed by
GitHub
parent
656d3cc719
commit
93cd579269
@ -1,30 +0,0 @@
|
||||
import {expect, test} from 'vitest';
|
||||
|
||||
import {ansiLogToHTML} from './RepoActionView.vue';
|
||||
import AnsiToHTML from 'ansi-to-html';
|
||||
|
||||
test('processConsoleLine', () => {
|
||||
expect(ansiLogToHTML('abc')).toEqual('abc');
|
||||
expect(ansiLogToHTML('abc\n')).toEqual('abc');
|
||||
expect(ansiLogToHTML('abc\r\n')).toEqual('abc');
|
||||
expect(ansiLogToHTML('\r')).toEqual('');
|
||||
expect(ansiLogToHTML('\rx\rabc')).toEqual('x\nabc');
|
||||
expect(ansiLogToHTML('\rabc\rx\r')).toEqual('abc\nx');
|
||||
|
||||
expect(ansiLogToHTML('\x1b[30mblack\x1b[37mwhite')).toEqual('<span style="color:#000">black<span style="color:#AAA">white</span></span>');
|
||||
expect(ansiLogToHTML('<script>')).toEqual('<script>');
|
||||
|
||||
|
||||
// upstream AnsiToHTML has bugs when processing "\033[1A" and "\033[1B", we fixed these control sequences in our code
|
||||
// if upstream could fix these bugs, we can remove these tests and remove our patch code
|
||||
const ath = new AnsiToHTML({escapeXML: true});
|
||||
expect(ath.toHtml('\x1b[1A\x1b[2Ktest\x1b[1B\x1b[1A\x1b[2K')).toEqual('AtestBA'); // AnsiToHTML bug
|
||||
expect(ath.toHtml('\x1b[1A\x1b[2K\rtest\r\x1b[1B\x1b[1A\x1b[2K')).toEqual('A\rtest\rBA'); // AnsiToHTML bug
|
||||
|
||||
// test our patched behavior
|
||||
expect(ansiLogToHTML('\x1b[1A\x1b[2Ktest\x1b[1B\x1b[1A\x1b[2K')).toEqual('test');
|
||||
expect(ansiLogToHTML('\x1b[1A\x1b[2K\rtest\r\x1b[1B\x1b[1A\x1b[2K')).toEqual('test');
|
||||
|
||||
// treat "\033[0K" and "\033[0J" (Erase display/line) as "\r", then it will be covered to "\n" finally.
|
||||
expect(ansiLogToHTML('a\x1b[Kb\x1b[2Jc')).toEqual('a\nb\nc');
|
||||
});
|
||||
@ -0,0 +1,44 @@
|
||||
import AnsiUp from 'ansi_up';
|
||||
|
||||
const replacements = [
|
||||
[/\x1b\[\d+[A-H]/g, ''], // Move cursor, treat them as no-op
|
||||
[/\x1b\[\d?[JK]/g, '\r'], // Erase display/line, treat them as a Carriage Return
|
||||
];
|
||||
|
||||
// render ANSI to HTML
|
||||
export function renderAnsi(line) {
|
||||
// create a fresh ansi_up instance because otherwise previous renders can influence
|
||||
// the output of future renders, because ansi_up is stateful and remembers things like
|
||||
// unclosed opening tags for colors.
|
||||
const ansi_up = new (AnsiUp.default || AnsiUp)();
|
||||
|
||||
if (line.endsWith('\r\n')) {
|
||||
line = line.substring(0, line.length - 2);
|
||||
} else if (line.endsWith('\n')) {
|
||||
line = line.substring(0, line.length - 1);
|
||||
}
|
||||
|
||||
if (line.includes('\x1b')) {
|
||||
for (const [regex, replacement] of replacements) {
|
||||
line = line.replace(regex, replacement);
|
||||
}
|
||||
}
|
||||
|
||||
if (!line.includes('\r')) {
|
||||
return ansi_up.ansi_to_html(line);
|
||||
}
|
||||
|
||||
// handle "\rReading...1%\rReading...5%\rReading...100%",
|
||||
// convert it into a multiple-line string: "Reading...1%\nReading...5%\nReading...100%"
|
||||
const lines = [];
|
||||
for (const part of line.split('\r')) {
|
||||
if (part === '') continue;
|
||||
const partHtml = ansi_up.ansi_to_html(part);
|
||||
if (partHtml !== '') {
|
||||
lines.push(partHtml);
|
||||
}
|
||||
}
|
||||
|
||||
// the log message element is with "white-space: break-spaces;", so use "\n" to break lines
|
||||
return lines.join('\n');
|
||||
}
|
||||
@ -0,0 +1,21 @@
|
||||
import {expect, test} from 'vitest';
|
||||
import {renderAnsi} from './ansi.js';
|
||||
|
||||
test('renderAnsi', () => {
|
||||
expect(renderAnsi('abc')).toEqual('abc');
|
||||
expect(renderAnsi('abc\n')).toEqual('abc');
|
||||
expect(renderAnsi('abc\r\n')).toEqual('abc');
|
||||
expect(renderAnsi('\r')).toEqual('');
|
||||
expect(renderAnsi('\rx\rabc')).toEqual('x\nabc');
|
||||
expect(renderAnsi('\rabc\rx\r')).toEqual('abc\nx');
|
||||
expect(renderAnsi('\x1b[30mblack\x1b[37mwhite')).toEqual('<span style="color:rgb(0,0,0)">black</span><span style="color:rgb(255,255,255)">white</span>'); // unclosed
|
||||
expect(renderAnsi('<script>')).toEqual('<script>');
|
||||
expect(renderAnsi('\x1b[1A\x1b[2Ktest\x1b[1B\x1b[1A\x1b[2K')).toEqual('test');
|
||||
expect(renderAnsi('\x1b[1A\x1b[2K\rtest\r\x1b[1B\x1b[1A\x1b[2K')).toEqual('test');
|
||||
expect(renderAnsi('\x1b[1A\x1b[2Ktest\x1b[1B\x1b[1A\x1b[2K')).toEqual('test');
|
||||
expect(renderAnsi('\x1b[1A\x1b[2K\rtest\r\x1b[1B\x1b[1A\x1b[2K')).toEqual('test');
|
||||
|
||||
// treat "\033[0K" and "\033[0J" (Erase display/line) as "\r", then it will be covered to "\n" finally.
|
||||
expect(renderAnsi('a\x1b[Kb\x1b[2Jc')).toEqual('a\nb\nc');
|
||||
expect(renderAnsi('\x1b[48;5;88ma\x1b[38;208;48;5;159mb\x1b[m')).toEqual(`<span style="background-color:rgb(135,0,0)">a</span><span style="background-color:rgb(175,255,255)">b</span>`);
|
||||
});
|
||||
Loading…
Reference in New Issue