Skip to content

feat: add trend indicators to PR comments and CI summary #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
maximn merged 2 commits into from
Apr 4, 2026
Merged

feat: add trend indicators to PR comments and CI summary #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dff8a58
✨ feat: add trend indicators to PR comments and CI summary
maximn Apr 4, 2026
fa5d3e7
chore: rebuild dist
maximn Apr 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
144 changes: 135 additions & 9 deletions dist/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55149,7 +55149,7 @@ Object.defineProperty(exports, "__esModule", ({ value: true }));
exports.detectPerfRegressions = detectPerfRegressions;
exports.buildDurationSparkline = buildDurationSparkline;
const comparison_1 = __nccwpck_require__(88232);
const SPARKLINE_CHARS = '▁▂▃▄▅▆▇█';
const trends_1 = __nccwpck_require__(55709);
function median(values) {
const sorted = [...values].sort((a, b) => a - b);
const mid = Math.floor(sorted.length / 2);
Expand Down Expand Up @@ -55206,20 +55206,83 @@ function detectPerfRegressions(entries, threshold = 200) {
function buildDurationSparkline(entries) {
if (entries.length === 0)
return '';
const durations = entries.map((e) => e.summary.duration);
const min = Math.min(...durations);
const max = Math.max(...durations);
return (0, trends_1.buildSparkline)(entries.map((e) => e.summary.duration));
}


/***/ }),

/***/ 55709:
/***/ ((__unused_webpack_module, exports) => {

"use strict";

Object.defineProperty(exports, "__esModule", ({ value: true }));
exports.buildSparkline = buildSparkline;
exports.computeTrends = computeTrends;
const SPARKLINE_CHARS = '▁▂▃▄▅▆▇█';
const PASS_RATE_THRESHOLD = 1.0;
const DURATION_THRESHOLD = 5.0;
const MIN_SPARKLINE_ENTRIES = 5;
function buildSparkline(values) {
if (values.length === 0)
return '';
const min = Math.min(...values);
const max = Math.max(...values);
if (min === max) {
return SPARKLINE_CHARS[4].repeat(durations.length);
return SPARKLINE_CHARS[4].repeat(values.length);
}
const range = max - min;
return durations
.map((d) => {
const idx = Math.round(((d - min) / range) * (SPARKLINE_CHARS.length - 1));
return values
.map((v) => {
const idx = Math.round(((v - min) / range) * (SPARKLINE_CHARS.length - 1));
return SPARKLINE_CHARS[idx];
})
.join('');
}
function classifyDirection(delta, threshold) {
if (delta > threshold)
return 'up';
if (delta < -threshold)
return 'down';
return 'stable';
}
function computeTrends(entries) {
const current = entries[entries.length - 1];
const previous = entries.slice(0, -1);
const currentPassRate = current.summary.total > 0 ? (current.summary.passed / current.summary.total) * 100 : 0;
const prevPassRates = previous.map((e) => e.summary.total > 0 ? (e.summary.passed / e.summary.total) * 100 : 0);
const avgPrevPassRate = prevPassRates.reduce((sum, r) => sum + r, 0) / prevPassRates.length;
const passRateDelta = currentPassRate - avgPrevPassRate;
const currentDuration = current.summary.duration;
const prevDurations = previous.map((e) => e.summary.duration);
const avgPrevDuration = prevDurations.reduce((sum, d) => sum + d, 0) / prevDurations.length;
const durationDelta = currentDuration - avgPrevDuration;
const durationDeltaPercent = avgPrevDuration !== 0 ? (durationDelta / avgPrevDuration) * 100 : 0;
const previousEntry = entries.length >= 2 ? entries[entries.length - 2] : null;
const testCountDelta = previousEntry ? current.summary.total - previousEntry.summary.total : 0;
const allPassRates = entries.map((e) => e.summary.total > 0 ? (e.summary.passed / e.summary.total) * 100 : 0);
const allDurations = entries.map((e) => e.summary.duration);
return {
passRate: {
direction: classifyDirection(passRateDelta, PASS_RATE_THRESHOLD),
current: currentPassRate,
delta: passRateDelta,
sparkline: entries.length >= MIN_SPARKLINE_ENTRIES ? buildSparkline(allPassRates) : '',
},
duration: {
direction: classifyDirection(durationDeltaPercent, DURATION_THRESHOLD),
current: currentDuration,
delta: durationDelta,
deltaPercent: durationDeltaPercent,
sparkline: entries.length >= MIN_SPARKLINE_ENTRIES ? buildSparkline(allDurations) : '',
},
testCount: {
current: current.summary.total,
delta: testCountDelta,
},
};
}


/***/ }),
Expand Down Expand Up @@ -55284,6 +55347,7 @@ const manager_1 = __nccwpck_require__(75878);
const comparison_1 = __nccwpck_require__(88232);
const flaky_detection_1 = __nccwpck_require__(87690);
const perf_regression_1 = __nccwpck_require__(77994);
const trends_1 = __nccwpck_require__(55709);
const DEFAULT_SLOWEST_TESTS = 10;
const DEFAULT_FLAKY_THRESHOLD = 2;
const DEFAULT_PERF_THRESHOLD = 200;
Expand Down Expand Up @@ -55474,6 +55538,15 @@ async function run() {
else if (historyEnabled && loadedHistory) {
core.debug('Need at least 3 runs for performance regression detection');
}
let trends = null;
if (loadedHistory && loadedHistory.entries.length >= 3) {
try {
trends = (0, trends_1.computeTrends)(loadedHistory.entries);
}
catch (err) {
core.debug(`Trend computation failed: ${err instanceof Error ? err.message : String(err)}`);
}
}
let baseDelta = null;
const baseBranch = (process.env.GITHUB_BASE_REF || '').replace(/^refs\/heads\//, '');
if (historyEnabled && baseBranch && loadedHistory) {
Expand Down Expand Up @@ -55532,6 +55605,7 @@ async function run() {
testsChanged,
flaky,
perfRegression,
trends,
});
if (createCheck) {
if (githubToken) {
Expand All @@ -55557,6 +55631,7 @@ async function run() {
testsChanged,
flaky,
perfRegression,
trends,
baseDelta: historyEnabled && baseBranch ? baseDelta : undefined,
baseBranch: historyEnabled && baseBranch ? baseBranch : undefined,
},
Expand Down Expand Up @@ -55783,6 +55858,7 @@ async function postPrComment(options) {

Object.defineProperty(exports, "__esModule", ({ value: true }));
exports.renderBaseBranchSection = renderBaseBranchSection;
exports.renderTrendLine = renderTrendLine;
exports.renderTestJobSection = renderTestJobSection;
exports.renderFlakyCompact = renderFlakyCompact;
exports.renderPerfRegressionCompact = renderPerfRegressionCompact;
Expand Down Expand Up @@ -55882,6 +55958,22 @@ function renderBaseBranchSection(baseDelta, baseBranch) {
}
return lines.join('\n');
}
const TREND_ARROW = {
up: '↑',
stable: '→',
down: '↓',
};
function renderTrendLine(trends) {
const passSign = trends.passRate.delta >= 0 ? '+' : '';
const passArrow = TREND_ARROW[trends.passRate.direction];
const passStr = `Pass rate: ${trends.passRate.current.toFixed(1)}% ${passArrow} (${passSign}${trends.passRate.delta.toFixed(1)}%)`;
const durSign = trends.duration.delta >= 0 ? '+' : '';
const durArrow = TREND_ARROW[trends.duration.direction];
const durStr = `Duration: ${(0, summary_1.formatDuration)(trends.duration.current)} ${durArrow} (${durSign}${(0, summary_1.formatDuration)(Math.abs(trends.duration.delta))}, ${durSign}${trends.duration.deltaPercent.toFixed(1)}%)`;
const countSign = trends.testCount.delta >= 0 ? '+' : '';
const countStr = `Tests: ${trends.testCount.current} (${countSign}${trends.testCount.delta})`;
return `📈 ${passStr} · ${durStr} · ${countStr}`;
}
function renderTestJobSection(section) {
const safeKey = sanitizeMarkerName(section.testJobName);
const statusEmoji = section.failed > 0 ? '❌' : '✅';
Expand All @@ -55893,6 +55985,9 @@ function renderTestJobSection(section) {
statsLine += ` | Health: ${section.healthScore}/100`;
}
lines.push(statsLine);
if (section.trends) {
lines.push(renderTrendLine(section.trends));
}
lines.push('');
if (section.highlights.length > 0) {
const sorted = [...section.highlights].sort((a, b) => SEVERITY_ORDER[a.severity] - SEVERITY_ORDER[b.severity]);
Expand Down Expand Up @@ -56069,13 +56164,14 @@ exports.renderHighlights = renderHighlights;
exports.renderDeltaSection = renderDeltaSection;
exports.renderTestsChangedSection = renderTestsChangedSection;
exports.renderFlakySection = renderFlakySection;
exports.renderTrendsSection = renderTrendsSection;
exports.renderPerfRegressionSection = renderPerfRegressionSection;
const core = __importStar(__nccwpck_require__(16966));
const MAX_FAILED_TESTS_SHOWN = 25;
const MAX_ERROR_MESSAGE_LENGTH = 200;
const MAX_STACK_TRACE_LINES = 30;
async function generateSummary(options) {
const { parsed, apiSuccess, healthScore, dashboardUrl, flakyCount, highlights, slowestTests, delta, testsChanged, flaky, perfRegression, } = options;
const { parsed, apiSuccess, healthScore, dashboardUrl, flakyCount, highlights, slowestTests, delta, testsChanged, flaky, perfRegression, trends, } = options;
const { summary } = parsed;
const passRate = summary.total > 0 ? ((summary.passed / summary.total) * 100).toFixed(1) : '0.0';
core.summary.addHeading('TestGlance Results', 2);
Expand Down Expand Up @@ -56104,6 +56200,9 @@ async function generateSummary(options) {
if (highlights && highlights.length > 0) {
core.summary.addRaw(renderHighlights(highlights, dashboardUrl));
}
if (trends) {
core.summary.addRaw(renderTrendsSection(trends));
}
if (delta) {
core.summary.addRaw(renderDeltaSection(delta));
}
Expand Down Expand Up @@ -56392,6 +56491,33 @@ function renderFlakySection(result) {
}
return lines.join('');
}
const TREND_ARROW = {
up: '↑',
stable: '→',
down: '↓',
};
function renderTrendsSection(trends) {
const lines = ['### Trends\n\n'];
const passSign = trends.passRate.delta >= 0 ? '+' : '';
const passArrow = TREND_ARROW[trends.passRate.direction];
let passLine = `**Pass rate:** `;
if (trends.passRate.sparkline) {
passLine += `${trends.passRate.sparkline} `;
}
passLine += `${trends.passRate.current.toFixed(1)}% ${passArrow} (${passSign}${trends.passRate.delta.toFixed(1)}%)\n\n`;
lines.push(passLine);
const durSign = trends.duration.delta >= 0 ? '+' : '';
const durArrow = TREND_ARROW[trends.duration.direction];
let durLine = `**Duration:** `;
if (trends.duration.sparkline) {
durLine += `${trends.duration.sparkline} `;
}
durLine += `${formatDuration(trends.duration.current)} ${durArrow} (${durSign}${formatDuration(Math.abs(trends.duration.delta))})\n\n`;
lines.push(durLine);
const countSign = trends.testCount.delta >= 0 ? '+' : '';
lines.push(`**Tests:** ${trends.testCount.current} (${countSign}${trends.testCount.delta})\n\n`);
return lines.join('');
}
const MAX_PERF_REGRESSIONS_SHOWN = 15;
function renderPerfRegressionSection(result) {
const lines = ['### Performance Regressions\n\n'];
Expand Down
2 changes: 1 addition & 1 deletion dist/index.js.map
View file
Open in desktop

Large diffs are not rendered by default.

116 changes: 116 additions & 0 deletions src/__tests__/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -456,6 +456,7 @@ describe('run() integration', () => {
testsChanged: null,
flaky: null,
perfRegression: null,
trends: null,
});
});

Expand All @@ -480,6 +481,7 @@ describe('run() integration', () => {
testsChanged: null,
flaky: null,
perfRegression: null,
trends: null,
});
});

Expand Down Expand Up @@ -1733,4 +1735,118 @@ describe('run() integration', () => {
expect(typeof summaryCall.perfRegression.sparkline).toBe('string');
});
});

describe('trend indicators (Story 7.7)', () => {
function makeTrendHistory(entryCount: number) {
const entries = Array.from({ length: entryCount }, (_, i) => ({
timestamp: `2026-04-0${(i % 9) + 1}T12:00:00.000Z`,
commitSha: `sha${i}`,
summary: {
total: 100 + i,
passed: 95 + i,
failed: 3,
skipped: 2,
errored: 0,
duration: 10.0 + i,
},
tests: [
{ name: 'test1', suite: 'suite1', status: 'passed' as const, duration: 0.5 },
{ name: 'test2', suite: 'suite1', status: 'passed' as const, duration: 0.5 },
],
}));
return JSON.stringify({ version: 1, branch: 'main', entries });
}

async function setupTrendHistoryWithEntries(entryCount: number) {
setupInputs({ history: 'true' });
process.env.GITHUB_REF_NAME = 'main';
process.env.GITHUB_SHA = 'abc1234';

const cache = await import('@actions/cache');
(cache.restoreCache as ReturnType<typeof vi.fn>).mockResolvedValueOnce('some-cache-key');

const fs = await import('node:fs');
(fs.existsSync as ReturnType<typeof vi.fn>).mockImplementation(
(p: string) => typeof p === 'string' && p.includes('history.json'),
);
mockReadFileSync.mockImplementation((p: string) => {
if (typeof p === 'string' && p.includes('history.json'))
return makeTrendHistory(entryCount);
return '<xml>content</xml>';
});
}

it('trends computed and passed to summary when >= 3 entries', async () => {
await setupTrendHistoryWithEntries(3);

await run();

const summaryCall = mockGenerateSummary.mock.calls[0][0];
expect(summaryCall.trends).not.toBeNull();
expect(summaryCall.trends.passRate).toBeDefined();
expect(summaryCall.trends.duration).toBeDefined();
expect(summaryCall.trends.testCount).toBeDefined();
});

it('trends is null when < 3 entries', async () => {
await setupTrendHistoryWithEntries(1);

await run();

const summaryCall = mockGenerateSummary.mock.calls[0][0];
expect(summaryCall.trends).toBeNull();
});

it('trends is null when history is disabled', async () => {
setupInputs({ history: 'false' });

await run();

const summaryCall = mockGenerateSummary.mock.calls[0][0];
expect(summaryCall.trends).toBeNull();
});

it('trends error does not fail the action', async () => {
await setupTrendHistoryWithEntries(3);

const trendsModule = await import('../history/trends');
vi.spyOn(trendsModule, 'computeTrends').mockImplementationOnce(() => {
throw new Error('trends computation boom');
});

await run();

expect(mockSetFailed).not.toHaveBeenCalled();
expect(mockDebug).toHaveBeenCalledWith(expect.stringContaining('trends computation boom'));

const summaryCall = mockGenerateSummary.mock.calls[0][0];
expect(summaryCall.trends).toBeNull();
});

it('trends is passed to PR comment section', async () => {
setupInputs({ history: 'true', 'github-token': 'gh_token' });
process.env.GITHUB_REF_NAME = 'main';
process.env.GITHUB_SHA = 'abc1234';

const cache = await import('@actions/cache');
(cache.restoreCache as ReturnType<typeof vi.fn>).mockResolvedValueOnce('some-cache-key');

const fs = await import('node:fs');
(fs.existsSync as ReturnType<typeof vi.fn>).mockImplementation(
(p: string) => typeof p === 'string' && p.includes('history.json'),
);
mockReadFileSync.mockImplementation((p: string) => {
if (typeof p === 'string' && p.includes('history.json')) return makeTrendHistory(3);
return '<xml>content</xml>';
});

await run();

const prCommentCall = mockPostPrComment.mock.calls[0]?.[0];
if (prCommentCall) {
expect(prCommentCall.section.trends).not.toBeNull();
expect(prCommentCall.section.trends.passRate).toBeDefined();
}
});
});
});
Loading
Loading