azdo-cli 0.19.0-feature-automata.685 → 0.19.0-feature-037-api-error-surfacing.693

package/dist/index.js

@@ -326,6 +326,52 @@ async function fetchRaw(url, init) {
   const body = await response.text();
   return { status: response.status, body };
 }
+var MAX_DETAIL_CHARS = 500;
+var MAX_RAW_BODY_CHARS = 200;
+var failureDetails = /* @__PURE__ */ new WeakMap();
+function describeFailureBody(body, contentType) {
+  if (body === null) return null;
+  const trimmed = body.trim();
+  if (trimmed === "") return null;
+  if (contentType.toLowerCase().startsWith("text/html") || trimmed.startsWith("<")) {
+    return null;
+  }
+  const redacted = redactBody(trimmed) ?? trimmed;
+  let parsed;
+  try {
+    parsed = JSON.parse(redacted);
+  } catch {
+    return truncateDetail(redacted.slice(0, MAX_RAW_BODY_CHARS));
+  }
+  if (typeof parsed !== "object" || parsed === null) {
+    return truncateDetail(redacted.slice(0, MAX_RAW_BODY_CHARS));
+  }
+  const record = parsed;
+  const parts = [];
+  if (typeof record.message === "string" && record.message.trim() !== "") {
+    parts.push(record.message.trim());
+  }
+  if (typeof record.typeKey === "string" && record.typeKey.trim() !== "") {
+    parts.push(`[${record.typeKey.trim()}]`);
+  } else if (typeof record.errorCode === "number" || typeof record.errorCode === "string") {
+    parts.push(`[errorCode ${record.errorCode}]`);
+  }
+  if (parts.length === 0) {
+    return truncateDetail(redacted.slice(0, MAX_RAW_BODY_CHARS));
+  }
+  return truncateDetail(parts.join(" "));
+}
+function truncateDetail(detail) {
+  const collapsed = detail.replace(/\s+/g, " ").trim();
+  if (collapsed === "") return null;
+  return collapsed.length > MAX_DETAIL_CHARS ? `${collapsed.slice(0, MAX_DETAIL_CHARS)}\u2026(truncated)` : collapsed;
+}
+function withDetail(sentinel, detail) {
+  return detail === null ? sentinel : `${sentinel}: ${detail}`;
+}
+function httpError(response) {
+  return new Error(withDetail(`HTTP_${response.status}`, failureDetails.get(response) ?? null));
+}
 async function fetchWithErrors(url, init) {
   const writer = getActiveTraceWriter();
   let response;
@@ -334,6 +380,7 @@ async function fetchWithErrors(url, init) {
   } catch (err) {
     throw new Error("NETWORK_ERROR", { cause: err });
   }
+  let tracedBody = null;
   if (writer) {
     const reqHeaders = redactHeaders(init.headers ?? {});
     const reqBody = typeof init.body === "string" ? redactBody(init.body) : null;
@@ -343,6 +390,7 @@ async function fetchWithErrors(url, init) {
       responseBody = await clone.text();
     } catch {
     }
+    tracedBody = responseBody;
     const respHeaders = {};
     response.headers.forEach((v, k) => {
       respHeaders[k] = v;
@@ -359,18 +407,33 @@ async function fetchWithErrors(url, init) {
     };
     writer.append(entry);
   }
-  if (response.status === 401) throw new Error("AUTH_FAILED");
-  if (response.status === 403) throw new Error("PERMISSION_DENIED");
+  const contentType = response.headers?.get("content-type") ?? "";
+  let failureDetail = null;
+  if (!response.ok) {
+    let body = tracedBody;
+    if (body === null) {
+      try {
+        body = await response.clone().text();
+      } catch {
+        body = null;
+      }
+    }
+    failureDetail = describeFailureBody(body, contentType);
+    if (failureDetail !== null) {
+      failureDetails.set(response, failureDetail);
+    }
+  }
+  if (response.status === 401) throw new Error(withDetail("AUTH_FAILED", failureDetail));
+  if (response.status === 403) throw new Error(withDetail("PERMISSION_DENIED", failureDetail));
   if (response.status === 404) {
     let detail = "";
     try {
-      const body = await response.text();
+      const body = tracedBody ?? await response.text();
       detail = ` | url=${url} | body=${body}`;
     } catch {
     }
     throw new Error(`NOT_FOUND${detail}`);
   }
-  const contentType = response.headers?.get("content-type") ?? "";
   if (contentType.toLowerCase().startsWith("text/html")) {
     throw new Error("AUTH_FAILED");
   }
@@ -464,7 +527,7 @@ async function readWriteResponse(response, errorCode) {
     throw new Error(`${errorCode}: ${serverMessage}`);
   }
   if (!response.ok) {
-    throw new Error(`HTTP_${response.status}`);
+    throw httpError(response);
   }
   const data = await response.json();
   return {
@@ -487,7 +550,7 @@ async function getWorkItemFields(context, id, cred) {
     }
   }
   if (!response.ok) {
-    throw new Error(`HTTP_${response.status}`);
+    throw httpError(response);
   }
   const data = await response.json();
   return data.fields;
@@ -539,7 +602,7 @@ async function fetchWorkItemResponse(context, id, cred, options = {}) {
     }
   }
   if (!response.ok) {
-    throw new Error(`HTTP_${response.status}`);
+    throw httpError(response);
   }
   return await response.json();
 }
@@ -550,7 +613,7 @@ async function getOrgFieldNames(context, cred) {
   url.searchParams.set("api-version", "7.1");
   const response = await fetchWithErrors(url.toString(), { headers: authHeaders(cred) });
   if (!response.ok) {
-    throw new Error(`HTTP_${response.status}`);
+    throw httpError(response);
   }
   const data = await response.json();
   return (data.value ?? []).map((f) => f.referenceName);
@@ -632,7 +695,7 @@ async function getWorkItemFieldValue(context, id, cred, fieldName) {
     }
   }
   if (!response.ok) {
-    throw new Error(`HTTP_${response.status}`);
+    throw httpError(response);
   }
   const data = await response.json();
   const value = data.fields[fieldName];
@@ -650,7 +713,7 @@ async function listWorkItemComments(context, id, cred) {
       { headers: authHeaders(cred) }
     );
     if (!response.ok) {
-      throw new Error(`HTTP_${response.status}`);
+      throw httpError(response);
     }
     const data = await response.json();
     comments.push(
@@ -680,7 +743,7 @@ async function addWorkItemComment(context, id, cred, text, format = "html") {
     throw new Error(`BAD_REQUEST: ${serverMessage}`);
   }
   if (!response.ok) {
-    throw new Error(`HTTP_${response.status}`);
+    throw httpError(response);
   }
   const data = await response.json();
   return {
@@ -732,7 +795,7 @@ async function applyWorkItemPatch(context, id, cred, operations) {
 async function downloadAttachment(url, cred) {
   const response = await fetchWithErrors(url, { headers: authHeaders(cred) });
   if (!response.ok) {
-    throw new Error(`HTTP_${response.status}`);
+    throw httpError(response);
   }
   return response.arrayBuffer();
 }
@@ -757,7 +820,7 @@ async function createAttachment(context, fileName, content, cred) {
     }
   }
   if (!response.ok) {
-    throw new Error(`HTTP_${response.status}`);
+    throw httpError(response);
   }
   return await response.json();
 }
@@ -1547,6 +1610,23 @@ function toMarkdown(content) {
 }
 
 // src/services/command-helpers.ts
+function isSentinel(message, sentinel) {
+  return message === sentinel || message.startsWith(`${sentinel}: `);
+}
+function sentinelDetail(message, sentinel) {
+  return message.startsWith(`${sentinel}: `) ? message.slice(sentinel.length + 2) : null;
+}
+function splitSentinel(message) {
+  const separator = message.indexOf(": ");
+  return separator === -1 ? { sentinel: message, detail: null } : { sentinel: message.slice(0, separator), detail: message.slice(separator + 2) };
+}
+function writeErrorDetail(message, sentinel) {
+  const detail = sentinelDetail(message, sentinel);
+  if (detail !== null) {
+    process.stderr.write(`  ${detail}
+`);
+  }
+}
 async function promptYesNo(prompt) {
   if (!process.stdin.isTTY) return true;
   process.stderr.write(prompt);
@@ -1608,16 +1688,18 @@ function handleCommandError(err, id, context, scope = "write", exit = true) {
   const error = err instanceof Error ? err : new Error(String(err));
   const msg = error.message;
   const scopeLabel = scope === "read" ? "Work Items (read)" : "Work Items (Read & Write)";
-  if (msg === "AUTH_FAILED") {
+  if (isSentinel(msg, "AUTH_FAILED")) {
     process.stderr.write(
       `Error: Authentication failed. Check that your PAT is valid and has the "${scopeLabel}" scope.
 `
     );
-  } else if (msg === "PERMISSION_DENIED") {
+    writeErrorDetail(msg, "AUTH_FAILED");
+  } else if (isSentinel(msg, "PERMISSION_DENIED")) {
     process.stderr.write(
       `Error: Access denied. Your PAT may lack ${scope} permissions for project "${context?.project}".
 `
     );
+    writeErrorDetail(msg, "PERMISSION_DENIED");
   } else if (msg.startsWith("NOT_FOUND")) {
     process.stderr.write(
       `Error: Work item ${id} not found in ${context?.org}/${context?.project}.
@@ -3132,10 +3214,10 @@ function buildUpsertResult(action, writeResult, fields, fallbackWorkItemType) {
   };
 }
 function isUpdateWriteError(err) {
-  return err.message === "AUTH_FAILED" || err.message === "PERMISSION_DENIED" || err.message.startsWith("NOT_FOUND") || err.message === "NETWORK_ERROR" || err.message.startsWith("BAD_REQUEST:") || err.message.startsWith("UPDATE_REJECTED:");
+  return isSentinel(err.message, "AUTH_FAILED") || isSentinel(err.message, "PERMISSION_DENIED") || err.message.startsWith("NOT_FOUND") || err.message === "NETWORK_ERROR" || err.message.startsWith("BAD_REQUEST:") || err.message.startsWith("UPDATE_REJECTED:");
 }
 function isCreateWriteError(err) {
-  return err.message === "AUTH_FAILED" || err.message === "PERMISSION_DENIED" || err.message === "NETWORK_ERROR" || err.message.startsWith("BAD_REQUEST:") || err.message.startsWith("HTTP_");
+  return isSentinel(err.message, "AUTH_FAILED") || isSentinel(err.message, "PERMISSION_DENIED") || err.message === "NETWORK_ERROR" || err.message.startsWith("BAD_REQUEST:") || err.message.startsWith("HTTP_");
 }
 function handleUpsertError(err, id, context) {
   if (!(err instanceof Error)) {
@@ -3465,7 +3547,7 @@ function isThreadResolved(status2) {
 }
 async function readJsonResponse(response) {
   if (!response.ok) {
-    throw new Error(`HTTP_${response.status}`);
+    throw httpError(response);
   }
   return response.json();
 }
@@ -3552,19 +3634,32 @@ async function getPullRequestBuilds(context, cred, prId) {
     isBlocking: null
   }));
 }
+var MAX_PR_DESCRIPTION_CHARS = 4e3;
+var DESCRIPTION_SEPARATOR = "\n\n";
 function composeDescription(description, template) {
-  if (description !== void 0 && template !== null) {
-    return `${description}
-
-${template.content}`;
-  }
-  if (description !== void 0) {
-    return description;
-  }
-  if (template !== null) {
-    return template.content;
+  if (description === void 0 && template === null) {
+    return null;
   }
-  return null;
+  const provided = description ?? "";
+  const templateContent = template?.content ?? "";
+  const separator = description !== void 0 && template !== null ? DESCRIPTION_SEPARATOR : "";
+  const text = `${provided}${separator}${templateContent}`;
+  return {
+    text,
+    providedChars: provided.length,
+    separatorChars: separator.length,
+    templateChars: templateContent.length,
+    templatePath: template?.path ?? null,
+    totalChars: text.length
+  };
+}
+function formatDescriptionOverflow(composed) {
+  const overflow = composed.totalChars - MAX_PR_DESCRIPTION_CHARS;
+  const breakdown = composed.templateChars > 0 && composed.providedChars > 0 ? ` (${composed.providedChars} provided + ${composed.separatorChars} separator + ${composed.templateChars} from the repository pull request template ${composed.templatePath})` : composed.templateChars > 0 ? ` (all of it from the repository pull request template ${composed.templatePath})` : "";
+  return `description is ${composed.totalChars} characters${breakdown}, exceeding the Azure DevOps limit of ${MAX_PR_DESCRIPTION_CHARS} characters. Shorten the description by at least ${overflow} characters.`;
+}
+function describeDescriptionBudget(composed) {
+  return `description: ${composed.providedChars} provided + ${composed.separatorChars} separator + ${composed.templateChars} template = ${composed.totalChars} characters (client limit ${MAX_PR_DESCRIPTION_CHARS})`;
 }
 async function openPullRequest(context, repo, cred, sourceBranch, title, description) {
   const existing = await listPullRequests(context, repo, cred, sourceBranch, {
@@ -3585,29 +3680,40 @@ async function openPullRequest(context, repo, cred, sourceBranch, title, descrip
   const repository = await getRepository(context, repo, cred);
   const defaultBranch = repository.defaultBranch ? repository.defaultBranch.replace(/^refs\/heads\//, "") : "develop";
   const template = await resolvePullRequestTemplate(context, repo, cred, defaultBranch, "develop");
-  const finalDescription = composeDescription(description, template);
-  if (finalDescription === null) {
+  const composed = composeDescription(description, template);
+  if (composed === null) {
     throw new Error("DESCRIPTION_REQUIRED");
   }
+  if (composed.totalChars > MAX_PR_DESCRIPTION_CHARS) {
+    throw new Error(`DESCRIPTION_TOO_LONG: ${formatDescriptionOverflow(composed)}`);
+  }
   const payload = {
     sourceRefName: `refs/heads/${sourceBranch}`,
     targetRefName: "refs/heads/develop",
     title,
-    description: finalDescription
+    description: composed.text
   };
   const url = new URL(
     `https://dev.azure.com/${encodeURIComponent(context.org)}/${encodeURIComponent(context.project)}/_apis/git/repositories/${encodeURIComponent(repo)}/pullrequests`
   );
   url.searchParams.set("api-version", "7.1");
-  const response = await fetchWithErrors(url.toString(), {
-    method: "POST",
-    headers: {
-      ...authHeaders(cred),
-      "Content-Type": "application/json"
-    },
-    body: JSON.stringify(payload)
-  });
-  const data = await readJsonResponse(response);
+  let data;
+  try {
+    const response = await fetchWithErrors(url.toString(), {
+      method: "POST",
+      headers: {
+        ...authHeaders(cred),
+        "Content-Type": "application/json"
+      },
+      body: JSON.stringify(payload)
+    });
+    data = await readJsonResponse(response);
+  } catch (err) {
+    if (err instanceof Error && err.message.startsWith("HTTP_400")) {
+      throw new Error(`${err.message} | ${describeDescriptionBudget(composed)}`, { cause: err });
+    }
+    throw err;
+  }
   return {
     branch: sourceBranch,
     targetBranch: "develop",
@@ -3745,7 +3851,7 @@ async function patchWorkItemRelations(context, cred, workItemId, operation) {
     body: JSON.stringify([operation])
   });
   if (!response.ok) {
-    throw new Error(`HTTP_${response.status}`);
+    throw httpError(response);
   }
 }
 async function linkWorkItemToPullRequest(context, repo, cred, prId, workItemId) {
@@ -3794,7 +3900,7 @@ async function resolveReviewerIdentity(org, cred, input) {
       headers: authHeaders(cred)
     });
   } catch (err) {
-    if (err instanceof Error && err.message === "AUTH_FAILED") {
+    if (err instanceof Error && isSentinel(err.message, "AUTH_FAILED")) {
       throw new Error("IDENTITY_SCOPE_MISSING", { cause: err });
     }
     throw err;
@@ -3853,7 +3959,7 @@ async function removePullRequestReviewer(context, repo, cred, prId, reviewerId)
     headers: authHeaders(cred)
   });
   if (!response.ok) {
-    throw new Error(`HTTP_${response.status}`);
+    throw httpError(response);
   }
   return { reviewer: existing, noop: false };
 }
@@ -3892,7 +3998,7 @@ async function fetchRepositoryItemContent(context, repo, cred, path3, branch) {
     throw err;
   }
   if (!response.ok) {
-    throw new Error(`HTTP_${response.status}`);
+    throw httpError(response);
   }
   return response.text();
 }
@@ -4027,7 +4133,7 @@ function writeError(message, exitCode = 1) {
 }
 function handlePrCommandError(err, context, mode = "read") {
   const error = err instanceof Error ? err : new Error(String(err));
-  if (error.message === "AUTH_FAILED") {
+  if (isSentinel(error.message, "AUTH_FAILED")) {
     const scopeLabel = mode === "write" ? "Code (Read & Write)" : "Code (Read)";
     writeError(`Authentication failed. Check that your PAT is valid and has the "${scopeLabel}" scope.`, EXIT_NOT_PERMITTED);
     const credentialHint = describeResolvedCredential();
@@ -4035,6 +4141,7 @@ function handlePrCommandError(err, context, mode = "read") {
       process.stderr.write(`  ${credentialHint}
 `);
     }
+    writeErrorDetail(error.message, "AUTH_FAILED");
     return;
   }
   if (error.message === "IDENTITY_SCOPE_MISSING") {
@@ -4044,8 +4151,9 @@ function handlePrCommandError(err, context, mode = "read") {
     );
     return;
   }
-  if (error.message === "PERMISSION_DENIED") {
+  if (isSentinel(error.message, "PERMISSION_DENIED")) {
     writeError(`Access denied. Your PAT may lack ${mode} permissions for project "${context?.project}".`, EXIT_NOT_PERMITTED);
+    writeErrorDetail(error.message, "PERMISSION_DENIED");
     return;
   }
   if (error.message === "NETWORK_ERROR") {
@@ -4057,7 +4165,12 @@ function handlePrCommandError(err, context, mode = "read") {
     return;
   }
   if (error.message.startsWith("HTTP_")) {
-    writeError(`Azure DevOps request failed with ${error.message}.`);
+    const { sentinel, detail } = splitSentinel(error.message);
+    writeError(`Azure DevOps request failed with ${sentinel}.`);
+    if (detail !== null) {
+      process.stderr.write(`  ${detail}
+`);
+    }
     return;
   }
   writeError(error.message);
@@ -4289,6 +4402,10 @@ ${result.pullRequest.url ?? "\u2014"}
         writeError("--description is required for pull request creation.");
         return;
       }
+      if (err instanceof Error && err.message.startsWith("DESCRIPTION_TOO_LONG: ")) {
+        writeError(err.message.slice("DESCRIPTION_TOO_LONG: ".length));
+        return;
+      }
       handlePrCommandError(err, context, "write");
     }
   });
@@ -5098,7 +5215,7 @@ function withApiVersion(url) {
 }
 async function readJsonResponse2(response) {
   if (!response.ok) {
-    throw new Error(`HTTP_${response.status}`);
+    throw httpError(response);
   }
   return await response.json();
 }
@@ -5374,7 +5491,7 @@ async function getRunLog(context, cred, buildId, logId) {
   );
   const response = await fetchWithErrors(url.toString(), { headers: authHeaders(cred) });
   if (!response.ok) {
-    throw new Error(`HTTP_${response.status}`);
+    throw httpError(response);
   }
   return response.text();
 }
@@ -5390,12 +5507,14 @@ function writeError2(message) {
 }
 function handlePipelineError(err, context) {
   const error = err instanceof Error ? err : new Error(String(err));
-  if (error.message === "AUTH_FAILED") {
+  if (isSentinel(error.message, "AUTH_FAILED")) {
     writeError2('Authentication failed. Check that your credential is valid and has the "Build (Read)" scope.');
+    writeErrorDetail(error.message, "AUTH_FAILED");
     return;
   }
-  if (error.message === "PERMISSION_DENIED") {
+  if (isSentinel(error.message, "PERMISSION_DENIED")) {
     writeError2(`Access denied. Your credential may lack pipeline permissions for project "${context?.project}".`);
+    writeErrorDetail(error.message, "PERMISSION_DENIED");
     return;
   }
   if (error.message === "NETWORK_ERROR") {
@@ -5407,7 +5526,12 @@ function handlePipelineError(err, context) {
     return;
   }
   if (error.message.startsWith("HTTP_")) {
-    writeError2(`Azure DevOps request failed with ${error.message}.`);
+    const { sentinel, detail } = splitSentinel(error.message);
+    writeError2(`Azure DevOps request failed with ${sentinel}.`);
+    if (detail !== null) {
+      process.stderr.write(`  ${detail}
+`);
+    }
     return;
   }
   writeError2(error.message);
@@ -6299,7 +6423,7 @@ function mapRelationType(raw) {
   };
 }
 async function readJsonResponse3(response) {
-  if (!response.ok) throw new Error(`HTTP_${response.status}`);
+  if (!response.ok) throw httpError(response);
   return await response.json();
 }
 function parseTargetId(url) {
@@ -6347,7 +6471,7 @@ async function addWorkItemRelation(context, cred, type, id1, id2) {
       { op: "add", path: "/relations/-", value: { rel: relType.referenceName, url: targetUrl } }
     ])
   });
-  if (!response.ok) throw new Error(`HTTP_${response.status}`);
+  if (!response.ok) throw httpError(response);
   return { status: "added", type: relType.name, referenceName: relType.referenceName, id1, id2 };
 }
 async function removeWorkItemRelation(context, cred, type, id1, id2) {
@@ -6367,7 +6491,7 @@ async function removeWorkItemRelation(context, cred, type, id1, id2) {
     headers: { ...authHeaders(cred), "Content-Type": "application/json-patch+json" },
     body: JSON.stringify([{ op: "remove", path: `/relations/${index}` }])
   });
-  if (!response.ok) throw new Error(`HTTP_${response.status}`);
+  if (!response.ok) throw httpError(response);
   return { status: "removed", type: relType.name, referenceName: relType.referenceName, id1, id2 };
 }
 async function listWorkItemRelations(context, cred, id) {
@@ -6455,11 +6579,12 @@ function handleRelationError(err, id1) {
     const target = id1 !== void 0 ? id1 : "unknown";
     process.stderr.write(`Error: work item #${target} not found.
 `);
-  } else if (msg === "AUTH_FAILED") {
+  } else if (isSentinel(msg, "AUTH_FAILED")) {
     process.stderr.write(
       `Error: authentication failed. Check your PAT has Work Items \u2192 Read & Write scope.
 `
     );
+    writeErrorDetail(msg, "AUTH_FAILED");
   } else {
     process.stderr.write(`Error: ${msg}
 `);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "azdo-cli",
-  "version": "0.19.0-feature-automata.685",
+  "version": "0.19.0-feature-037-api-error-surfacing.693",
   "description": "Azure DevOps CLI tool",
   "type": "module",
   "bin": {