Skip to content

Format containers api errors better #10321

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
emily-shen merged 2 commits into from
Aug 13, 2025
Merged

Format containers api errors better #10321

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
8ace61e
format api errors better
emily-shen Aug 11, 2025
064abed
changeset
emily-shen Aug 12, 2025
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 .changeset/soft-donuts-grin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"wrangler": patch
---

print prettier errors during container deployment
55 changes: 24 additions & 31 deletions packages/wrangler/src/containers/deploy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ import {
ApiError,
ApplicationsService,
CreateApplicationRolloutRequest,
DeploymentMutationError,
resolveImageName,
RolloutsService,
} from "@cloudflare/containers-shared";
Expand Down Expand Up @@ -348,25 +347,21 @@ export async function apply(
}

function formatError(err: ApiError): string {
// TODO: this is bad bad. Please fix like we do in create.ts.
// On Cloudchamber API side, we have to improve as well the object validation errors,
// so we can detect them here better and pinpoint to the user what's going on.
if (
err.body.error === DeploymentMutationError.VALIDATE_INPUT &&
err.body.details !== undefined
) {
let message = "";
for (const key in err.body.details) {
message += ` ${brandColor(key)} ${err.body.details[key]}\n`;
try {
const maybeError = JSON.parse(err.body.error);
if (
maybeError.error !== undefined &&
maybeError.details !== undefined &&
typeof maybeError.details === "object"
) {
let message = "";
for (const key in maybeError.details) {
message += `${brandColor(key)} ${maybeError.details[key]}\n`;
}
return message;
}

return message;
}

if (err.body.error !== undefined) {
return ` ${err.body.error}`;
}

} catch {}
// if we can't make it pretty, just dump out the error body
return JSON.stringify(err.body);
}

Expand All @@ -387,28 +382,26 @@ const doAction = async (
try {
application = await promiseSpinner(
ApplicationsService.createApplication(action.application),
{ message: `Creating ${action.application.name}` }
{ message: `Creating "${action.application.name}"` }
);
} catch (err) {
if (!(err instanceof Error)) {
throw err;
}

if (!(err instanceof ApiError)) {
throw new UserError(
throw new FatalError(
`Unexpected error creating application: ${err.message}`
);
}

if (err.status === 400) {
throw new UserError(
`Error creating application due to a misconfiguration\n${formatError(err)}`
`Error creating application due to a misconfiguration:\n${formatError(err)}`
);
}

throw new UserError(
`Error creating application due to an internal error (request id: ${err.body.request_id}):\n${formatError(err)}`
Copy link
Copy Markdown
Contributor Author

@emily-shen emily-shen Aug 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we don't seem to ever be getting a request id so let's just get rid of this

);
throw new UserError(`Error creating application:\n${formatError(err)}`);
}

success(
Expand All @@ -432,18 +425,18 @@ const doAction = async (

if (!(err instanceof ApiError)) {
throw new UserError(
`Unexpected error modifying application ${action.name}: ${err.message}`
`Unexpected error modifying application "${action.name}": ${err.message}`
);
}

if (err.status === 400) {
throw new UserError(
`Error modifying application ${action.name} due to a misconfiguration:\n\n\t${formatError(err)}`
`Error modifying application "${action.name}" due to a misconfiguration:\n\n\t${formatError(err)}`
);
}

throw new UserError(
`Error modifying application ${action.name} due to an internal error (request id: ${err.body.request_id}):\n${formatError(err)}`
`Error modifying application "${action.name}":\n${formatError(err)}`
);
}

Expand All @@ -468,18 +461,18 @@ const doAction = async (

if (!(err instanceof ApiError)) {
throw new UserError(
`Unexpected error rolling out application ${action.name}:\n${err.message}`
`Unexpected error rolling out application "${action.name}":\n${err.message}`
);
}

if (err.status === 400) {
throw new UserError(
`Error rolling out application ${action.name} due to a misconfiguration:\n\n\t${formatError(err)}`
`Error rolling out application "${action.name}" due to a misconfiguration:\n\n\t${formatError(err)}`
);
}

throw new UserError(
`Error rolling out application ${action.name} due to an internal error (request id: ${err.body.request_id}): ${formatError(err)}`
`Error rolling out application "${action.name}":\n${formatError(err)}`
);
}
}
Expand Down
Loading