don't include stack for defects (prevent leaking server information)

Effect-TS · Mar 21, 2024 · 556a227 · 556a227
1 parent 937151a
commit 556a227
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 8 deletions.
diff --git a/packages/schema/src/Schema.ts b/packages/schema/src/Schema.ts
@@ -6053,11 +6053,11 @@ export const TaggedError = <Self = never>(identifier?: string) =>
     identifier: identifier ?? tag,
     fields: extendFields({ [TAG]: literal(tag) }, fields),
     toStringOverride(self) {
-      if (typeof self.message !== "string" || self.message.length === 0) {
+      if (!(Predicate.isString(self.message) && self.message.length > 0)) {
         return Pretty.make(self.constructor as any)(self)
       }
       let message = `${self._tag}: ${self.message}`
-      if ("stack" in self) {
+      if (Predicate.isString(self.stack)) {
         message = `${message}\n${self.stack.split("\n").slice(1).join("\n")}`
       }
       return message
@@ -6628,16 +6628,20 @@ export const causeDefectUnknown: $unknown = transform(
   unknown,
   (u) => {
     if (Predicate.isObject(u) && "message" in u && typeof u.message === "string") {
-      return Object.assign(new Error(u.message, { cause: u }), u)
+      const err = new Error(u.message, { cause: u })
+      if ("name" in u && typeof u.name === "string") {
+        err.name = u.name
+      }
+      err.stack = "stack" in u && typeof u.stack === "string" ? u.stack : ""
+      return err
     }
     return String(u)
   },
   (defect) => {
     if (defect instanceof Error) {
       return {
         name: defect.name,
-        message: defect.message,
-        stack: defect.stack
+        message: defect.message
       }
     }
     return String(defect)

diff --git a/packages/schema/test/Cause/cause.test.ts b/packages/schema/test/Cause/cause.test.ts
@@ -142,15 +142,13 @@ describe("Cause > cause", () => {
     assert(failWithStack._tag === "Die")
     assert(
       typeof failWithStack.defect === "object" && failWithStack.defect !== null && "message" in failWithStack.defect &&
-        "stack" in failWithStack.defect && "name" in failWithStack.defect
+        "name" in failWithStack.defect
     )
     assert.strictEqual(failWithStack.defect.name, "Error")
     assert.strictEqual(failWithStack.defect.message, "fail")
-    assert.include(failWithStack.defect.stack, "cause.test.ts")
 
     failWithStack = S.encodeSync(schemaUnknown)(Cause.die(new Error("fail")))
     assert(failWithStack._tag === "Die")
     assert.strictEqual((failWithStack.defect as Error).message, "fail")
-    assert.include((failWithStack.defect as any).stack, "cause.test.ts")
   })
 })