Skip to content

fix: STRF-XX - Improved upload error output #1247

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

Open
AndrewBarber wants to merge 2 commits into
base: master
Choose a base branch
from
Open

fix: STRF-XX - Improved upload error output #1247

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
321c10e
fix: STRF-XX - Improved upload error output
AndrewBarber Dec 17, 2024
30d4f31
fix: STRF-XX - Improved upload error output
AndrewBarber Dec 17, 2024
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
5 changes: 5 additions & 0 deletions lib/theme-api-client.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,11 @@ async function getJob({ accessToken, apiHost, storeHash, jobId, resultFilter })
const error = new Error('Job Failed');
error.name = 'JobCompletionStatusCheckError';
error.messages = (payload.data && payload.data.errors) || [{ message: payload.title }];
//append a message to visit troubleshooting page, to help diagnose the issue.
if (error.messages) {
const visitTroubleshootingPage = `\nThe following page may help diagnose the issue: https://developer.bigcommerce.com/docs/storefront/stencil/deployment/upload-errors.`;
error.messages.message += visitTroubleshootingPage;
}
throw error;
}
if (!payload.data || payload.data.status !== 'COMPLETED') {
Expand Down