Skip to content

DOT-5874: Refactor PDF result fetching and enhance error handling for project ID #354

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
merged 1 commit into from
Sep 9, 2025
Merged

DOT-5874: Refactor PDF result fetching and enhance error handling for project ID #354

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 7 additions & 9 deletions src/lib/httpClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -686,22 +686,20 @@ export default class httpClient {
}

async fetchPdfResults(ctx: Context): Promise<any> {
const params: Record<string, string> = {
projectToken: this.projectToken
};
const params: Record<string, string> = {};

// Use buildId if available, otherwise use buildName
if (ctx.build.id) {
params.buildId = ctx.build.id;
} else if (ctx.build.name) {
params.buildName = ctx.build.name;
if (ctx.build.projectId) {
params.project_id = ctx.build.projectId;
} else {
throw new Error('Project ID not found to fetch PDF results');
}
params.build_id = ctx.build.id;

const auth = Buffer.from(`${this.username}:${this.accessKey}`).toString('base64');

try {
const response = await axios.request({
url: ctx.env.SMARTUI_UPLOAD_URL + '/automation/smart-ui/screenshot/build/status',
url: ctx.env.SMARTUI_UPLOAD_URL + '/smartui/2.0/build/screenshots',
method: 'GET',
params: params,
headers: {
Expand Down
56 changes: 24 additions & 32 deletions src/lib/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -526,55 +526,54 @@ export function startPdfPolling(ctx: Context) {
}

let attempts = 0;
const maxAttempts = 30; // 5 minutes (10 seconds * 30)
const maxAttempts = 60; // 5 minutes (10 seconds * 30)

console.log(chalk.yellow('Waiting for results...'));

const interval = setInterval(async () => {
attempts++;

try {
const response = await ctx.client.fetchPdfResults(ctx, ctx.log);
const response = await ctx.client.fetchPdfResults(ctx);

if (response.status === 'success' && response.data && response.data.Screenshots) {
if (response.screenshots) {
clearInterval(interval);

const pdfGroups = groupScreenshotsByPdf(response.data.Screenshots);

const pdfGroups = groupScreenshotsByPdf(response.screenshots);
const pdfsWithMismatches = countPdfsWithMismatches(pdfGroups);
const pagesWithMismatches = countPagesWithMismatches(response.data.Screenshots);
const pagesWithMismatches = countPagesWithMismatches(response.screenshots);

console.log(chalk.green('\n✓ PDF Test Results:'));
console.log(chalk.green(`Build Name: ${response.data.buildName}`));
console.log(chalk.green(`Project Name: ${response.data.projectName}`));
console.log(chalk.green(`Build Name: ${response.build.name}`));
console.log(chalk.green(`Project Name: ${response.project.name}`));
console.log(chalk.green(`Total PDFs: ${Object.keys(pdfGroups).length}`));
console.log(chalk.green(`Total Pages: ${response.data.Screenshots.length}`));
console.log(chalk.green(`Total Pages: ${response.screenshots.length}`));

if (pdfsWithMismatches > 0 || pagesWithMismatches > 0) {
console.log(chalk.yellow(`${pdfsWithMismatches} PDFs and ${pagesWithMismatches} Pages in build ${response.data.buildName} have changes present.`));
console.log(chalk.yellow(`${pdfsWithMismatches} PDFs and ${pagesWithMismatches} Pages in build ${response.build.name} have changes present.`));
} else {
console.log(chalk.green('All PDFs match the baseline.'));
}

Object.entries(pdfGroups).forEach(([pdfName, pages]) => {
const hasMismatch = pages.some(page => page.mismatchPercentage > 0);
const hasMismatch = pages.some(page => page.mismatch_percentage > 0);
const statusColor = hasMismatch ? chalk.yellow : chalk.green;

console.log(statusColor(`\n📄 ${pdfName} (${pages.length} pages)`));

pages.forEach(page => {
const pageStatusColor = page.mismatchPercentage > 0 ? chalk.yellow : chalk.green;
console.log(pageStatusColor(` - Page ${getPageNumber(page.screenshotName)}: ${page.status} (Mismatch: ${page.mismatchPercentage}%)`));
const pageStatusColor = page.mismatch_percentage > 0 ? chalk.yellow : chalk.green;
console.log(pageStatusColor(` - Page ${getPageNumber(page.screenshot_name)}: ${page.status} (Mismatch: ${page.mismatch_percentage}%)`));
});
});

const formattedResults = {
status: response.status,
status: 'success',
data: {
buildId: response.data.buildId,
buildName: response.data.buildName,
projectName: response.data.projectName,
buildStatus: response.data.buildStatus,
buildId: response.build.id,
buildName: response.build.name,
projectName: response.project.name,
buildStatus: response.build.build_satus,
pdfs: formatPdfsForOutput(pdfGroups)
}
};
Expand All @@ -588,12 +587,6 @@ export function startPdfPolling(ctx: Context) {
}

return;
} else if (response.status === 'error') {
clearInterval(interval);
console.log(chalk.red(`\nError fetching results: ${response.message || 'Unknown error'}`));
return;
} else {
process.stdout.write(chalk.yellow('.'));
}

if (attempts >= maxAttempts) {
Expand Down Expand Up @@ -625,7 +618,7 @@ function groupScreenshotsByPdf(screenshots: any[]): Record<string, any[]> {

screenshots.forEach(screenshot => {
// screenshot name format: "pdf-name.pdf#page-number"
const pdfName = screenshot.screenshotName.split('#')[0];
const pdfName = screenshot.screenshot_name.split('#')[0];

if (!pdfGroups[pdfName]) {
pdfGroups[pdfName] = [];
Expand All @@ -641,7 +634,7 @@ function countPdfsWithMismatches(pdfGroups: Record<string, any[]>): number {
let count = 0;

Object.values(pdfGroups).forEach(pages => {
if (pages.some(page => page.mismatchPercentage > 0)) {
if (pages.some(page => page.mismatch_percentage > 0)) {
count++;
}
});
Expand All @@ -650,7 +643,7 @@ function countPdfsWithMismatches(pdfGroups: Record<string, any[]>): number {
}

function countPagesWithMismatches(screenshots: any[]): number {
return screenshots.filter(screenshot => screenshot.mismatchPercentage > 0).length;
return screenshots.filter(screenshot => screenshot.mismatch_percentage > 0).length;
}

function formatPdfsForOutput(pdfGroups: Record<string, any[]>): any[] {
Expand All @@ -659,12 +652,11 @@ function formatPdfsForOutput(pdfGroups: Record<string, any[]>): any[] {
pdfName,
pageCount: pages.length,
pages: pages.map(page => ({
pageNumber: getPageNumber(page.screenshotName),
screenshotId: page.screenshotId,
mismatchPercentage: page.mismatchPercentage,
threshold: page.threshold,
pageNumber: getPageNumber(page.screenshot_name),
screenshotId: page.captured_image_id,
mismatchPercentage: page.mismatch_percentage,
status: page.status,
screenshotUrl: page.screenshotUrl
screenshotUrl: page.shareable_link
}))
};
});
Expand Down
3 changes: 3 additions & 0 deletions src/tasks/uploadPdfs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,9 @@ async function uploadPdfs(ctx: Context, pdfPath: string): Promise<void> {
ctx.build.id = response.buildId;
ctx.log.debug(`PDF upload successful. Build ID: ${ctx.build.id}`);
}
if (response && response.projectId) {
ctx.build.projectId = response.projectId;
}
} catch (error : any) {
throw new Error(error.message);
}
Expand Down
1 change: 1 addition & 0 deletions src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,7 @@ export interface Build {
baseline: boolean;
useKafkaFlow: boolean;
hasDiscoveryError: boolean;
projectId?: string;
}

export interface WebConfig {
Expand Down