Skip to content

Repository navigation

fix(api): show the Socket API's error message on failed requests #1627

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
Oskar Haarklou Veileborg (BarrensZeppelin) merged 1 commit into from
Oct 19, 2026
Merged

fix(api): show the Socket API's error message on failed requests #1627

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
38 changes: 23 additions & 15 deletions src/utils/api.mts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,26 @@ function _httpsRequestFetch(
})
}

/**
* The cause for a failed request to `path`, with the explanation the Socket
* API gives in its `{ error: { message } }` body when there is one.
*/
async function describeApiFailure(
response: Response,
path: string,
): Promise<string> {
let serverMessage: unknown
try {
serverMessage = (JSON.parse(await response.text()) as any)?.error?.message
} catch {
// A body that isn't JSON carries no message.
}
const reason = await getErrorMessageForHttpStatusCode(response.status)
return typeof serverMessage === 'string' && serverMessage
? `${response.statusText}: ${serverMessage} (reason: ${reason}) (path: ${path})`
: `${response.statusText} (reason: ${reason}) (path: ${path})`
}

export async function apiFetch(
url: string,
init: ApiFetchInit = {},
Expand Down Expand Up @@ -259,7 +279,7 @@ function logPermissionsFor403(cmdPath?: string | undefined): void {
}

// The Socket API server that should be used for operations.
export function getDefaultApiBaseUrl(): string | undefined {
export function getDefaultApiBaseUrl(): string {
const baseUrl =
constants.ENV.SOCKET_CLI_API_BASE_URL ||
getConfigValueOrUndef(CONFIG_KEY_API_BASE_URL)
Expand Down Expand Up @@ -501,10 +521,6 @@ export async function handleApiCallNoSpinner<R extends SocketSdkReturnedResult>(

async function queryApi(path: string, apiToken: string) {
const baseUrl = getDefaultApiBaseUrl()
if (!baseUrl) {
throw new Error('Socket API base URL is not configured.')
}

const url = `${baseUrl}${baseUrl.endsWith('/') ? '' : '/'}${path}`
const result = await apiFetch(url, {
method: 'GET',
Expand Down Expand Up @@ -601,7 +617,7 @@ export async function queryApiSafeTextWithStatus(
return {
ok: false,
message: 'Socket API error',
cause: `${result.statusText} (reason: ${await getErrorMessageForHttpStatusCode(status)}) (path: ${path})`,
cause: await describeApiFailure(result, path),
data: {
code: status,
},
Expand Down Expand Up @@ -697,14 +713,6 @@ export async function sendApiRequest<T>(
}

const baseUrl = getDefaultApiBaseUrl()
if (!baseUrl) {
return {
ok: false,
message: 'Configuration Error',
cause:
'Socket API endpoint is not configured. Please check your environment configuration.',
}
}

const { body, commandPath, description, method } = {
__proto__: null,
Expand Down Expand Up @@ -769,7 +777,7 @@ export async function sendApiRequest<T>(
return {
ok: false,
message: 'Socket API error',
cause: `${result.statusText} (reason: ${await getErrorMessageForHttpStatusCode(status)}) (path: ${path})`,
cause: await describeApiFailure(result, path),
data: {
code: status,
},
Expand Down
Loading