@valbuild/shared 0.134.0 → 0.134.1

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @valbuild/shared
 
+## 0.134.1
+
+### Patch Changes
+
+- [#709](https://github.com/valbuild/val/pull/709) [`821e789`](https://github.com/valbuild/val/commit/821e789c1af47510af5d23eb96384ff78ddd7646) Thanks [@freekh](https://github.com/freekh)! - Show the reason behind a content-service error instead of just "Internal Server
+  Error".
+
+  `content.val.build` answers a handler that threw with `{ message: "Internal
+Server Error", details: "<the actual cause>" }`. Val was reading `message` and
+  dropping `details`, so a failed save put exactly this in front of an editor —
+  and the same text in the app's own logs, because Val was relaying it:
+
+  ```json
+  { "type": "patch-error", "message": "Internal Server Error", "errors": { … } }
+  ```
+
+  A string `details` is now appended to the message (capped at 500 characters).
+  A structured one is not: that is what a _refusal_ carries, and its summary is
+  already the message.
+
 ## 0.134.0
 
 ### Minor Changes

package/internal/dist/valbuild-shared-internal.cjs.dev.js

@@ -3057,12 +3057,59 @@ var Api = {
 // `number` is allowed because the client stringifies every query value before it
 // goes on the URL (see createValClient), so a numeric param round-trips fine.
 
+/**
+ * How long an appended `details` may be before it is cut.
+ *
+ * A thrown DAL error in the content service quotes the whole offending ROW back
+ * — which for a patch is every op the editor just made — so an uncapped append
+ * puts kilobytes of JSON in a dialog. The head is where the cause is; the tail
+ * is the evidence, and it belongs in the service's own logs.
+ */
+var MAX_DETAILS_LENGTH = 500;
 function getErrorMessageFromUnknownJson(json, fallback) {
   if (getSitemapTree._typeof(json) === "object" && json !== null && "message" in json && typeof json.message === "string") {
-    return json.message;
+    var details = detailsOf(json);
+    if (details === null || details === json.message) {
+      return json.message;
+    }
+    return "".concat(json.message, ": ").concat(details);
   }
   return fallback;
 }
+
+/**
+ * The cause the content service put beside its message, when it wrote one a
+ * person can read.
+ *
+ * `HttpError` in `home` is `{ statusCode, message?, details? }`, and `details`
+ * is filled in two quite different ways. Where a handler REFUSED, it holds the
+ * structured zod error whose summary is already the `message` — repeating it
+ * adds nothing. Where a handler THREW, `sendResult` writes `message:
+ * "Internal Server Error"` and puts the exception's own message in `details` —
+ * so there the message says nothing and the details say everything.
+ *
+ * Which is why the test is the TYPE rather than the status code: a string
+ * `details` is prose meant to be read, an object is a payload meant to be
+ * parsed. This takes the first and leaves the second.
+ *
+ * It was written after an hour was lost to the second case. A patch save
+ * against a content service that threw showed the Studio exactly
+ * `"Internal Server Error"` and nothing else, in a dialog with no other clue,
+ * while the service's answer had been carrying the reason the whole time.
+ */
+function detailsOf(json) {
+  if (!("details" in json) || typeof json.details !== "string") {
+    return null;
+  }
+  var details = json.details.trim();
+  if (details === "") {
+    return null;
+  }
+  if (details.length <= MAX_DETAILS_LENGTH) {
+    return details;
+  }
+  return "".concat(details.slice(0, MAX_DETAILS_LENGTH), "\u2026");
+}
 var DEFAULT_ERROR_MESSAGE = "Unknown error with unknown message from server";
 
 var createValClient = function createValClient(host, config // We want to use this in the future

package/internal/dist/valbuild-shared-internal.cjs.prod.js

@@ -3057,12 +3057,59 @@ var Api = {
 // `number` is allowed because the client stringifies every query value before it
 // goes on the URL (see createValClient), so a numeric param round-trips fine.
 
+/**
+ * How long an appended `details` may be before it is cut.
+ *
+ * A thrown DAL error in the content service quotes the whole offending ROW back
+ * — which for a patch is every op the editor just made — so an uncapped append
+ * puts kilobytes of JSON in a dialog. The head is where the cause is; the tail
+ * is the evidence, and it belongs in the service's own logs.
+ */
+var MAX_DETAILS_LENGTH = 500;
 function getErrorMessageFromUnknownJson(json, fallback) {
   if (getSitemapTree._typeof(json) === "object" && json !== null && "message" in json && typeof json.message === "string") {
-    return json.message;
+    var details = detailsOf(json);
+    if (details === null || details === json.message) {
+      return json.message;
+    }
+    return "".concat(json.message, ": ").concat(details);
   }
   return fallback;
 }
+
+/**
+ * The cause the content service put beside its message, when it wrote one a
+ * person can read.
+ *
+ * `HttpError` in `home` is `{ statusCode, message?, details? }`, and `details`
+ * is filled in two quite different ways. Where a handler REFUSED, it holds the
+ * structured zod error whose summary is already the `message` — repeating it
+ * adds nothing. Where a handler THREW, `sendResult` writes `message:
+ * "Internal Server Error"` and puts the exception's own message in `details` —
+ * so there the message says nothing and the details say everything.
+ *
+ * Which is why the test is the TYPE rather than the status code: a string
+ * `details` is prose meant to be read, an object is a payload meant to be
+ * parsed. This takes the first and leaves the second.
+ *
+ * It was written after an hour was lost to the second case. A patch save
+ * against a content service that threw showed the Studio exactly
+ * `"Internal Server Error"` and nothing else, in a dialog with no other clue,
+ * while the service's answer had been carrying the reason the whole time.
+ */
+function detailsOf(json) {
+  if (!("details" in json) || typeof json.details !== "string") {
+    return null;
+  }
+  var details = json.details.trim();
+  if (details === "") {
+    return null;
+  }
+  if (details.length <= MAX_DETAILS_LENGTH) {
+    return details;
+  }
+  return "".concat(details.slice(0, MAX_DETAILS_LENGTH), "\u2026");
+}
 var DEFAULT_ERROR_MESSAGE = "Unknown error with unknown message from server";
 
 var createValClient = function createValClient(host, config // We want to use this in the future

package/internal/dist/valbuild-shared-internal.esm.js

@@ -3050,12 +3050,59 @@ var Api = {
 // `number` is allowed because the client stringifies every query value before it
 // goes on the URL (see createValClient), so a numeric param round-trips fine.
 
+/**
+ * How long an appended `details` may be before it is cut.
+ *
+ * A thrown DAL error in the content service quotes the whole offending ROW back
+ * — which for a patch is every op the editor just made — so an uncapped append
+ * puts kilobytes of JSON in a dialog. The head is where the cause is; the tail
+ * is the evidence, and it belongs in the service's own logs.
+ */
+var MAX_DETAILS_LENGTH = 500;
 function getErrorMessageFromUnknownJson(json, fallback) {
   if (_typeof(json) === "object" && json !== null && "message" in json && typeof json.message === "string") {
-    return json.message;
+    var details = detailsOf(json);
+    if (details === null || details === json.message) {
+      return json.message;
+    }
+    return "".concat(json.message, ": ").concat(details);
   }
   return fallback;
 }
+
+/**
+ * The cause the content service put beside its message, when it wrote one a
+ * person can read.
+ *
+ * `HttpError` in `home` is `{ statusCode, message?, details? }`, and `details`
+ * is filled in two quite different ways. Where a handler REFUSED, it holds the
+ * structured zod error whose summary is already the `message` — repeating it
+ * adds nothing. Where a handler THREW, `sendResult` writes `message:
+ * "Internal Server Error"` and puts the exception's own message in `details` —
+ * so there the message says nothing and the details say everything.
+ *
+ * Which is why the test is the TYPE rather than the status code: a string
+ * `details` is prose meant to be read, an object is a payload meant to be
+ * parsed. This takes the first and leaves the second.
+ *
+ * It was written after an hour was lost to the second case. A patch save
+ * against a content service that threw showed the Studio exactly
+ * `"Internal Server Error"` and nothing else, in a dialog with no other clue,
+ * while the service's answer had been carrying the reason the whole time.
+ */
+function detailsOf(json) {
+  if (!("details" in json) || typeof json.details !== "string") {
+    return null;
+  }
+  var details = json.details.trim();
+  if (details === "") {
+    return null;
+  }
+  if (details.length <= MAX_DETAILS_LENGTH) {
+    return details;
+  }
+  return "".concat(details.slice(0, MAX_DETAILS_LENGTH), "\u2026");
+}
 var DEFAULT_ERROR_MESSAGE = "Unknown error with unknown message from server";
 
 var createValClient = function createValClient(host, config // We want to use this in the future

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@valbuild/shared",
-  "version": "0.134.0",
+  "version": "0.134.1",
   "private": false,
   "description": "Val shared types and utilities",
   "repository": {