Merge pull request #139 from gbmoretti/deserialize-error-dx

Throws a descriptive error when Arbor fails to find the type
drborges · Nov 1, 2024 · 42b9f3b · 42b9f3b
2 parents b462e44 + 754a99f
commit 42b9f3b
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 0 deletions.
diff --git a/.yarn/install-state.gz b/.yarn/install-state.gz
diff --git a/packages/arbor-json/src/Json.ts b/packages/arbor-json/src/Json.ts
@@ -126,6 +126,8 @@ export class Json {
       } else if (Type) {
         const instance = new Type()
         return Object.assign(instance, value.$value)
+      } else {
+        throw new Error(`Unknown type: ${value.$type}. Can't deserialize.`)
       }
     }
 

diff --git a/packages/arbor-json/tests/Json.test.ts b/packages/arbor-json/tests/Json.test.ts
@@ -110,6 +110,15 @@ describe("Json", () => {
       expect(deserialized).toBeInstanceOf(TodoList)
       expect(deserialized).toEqual(todoList)
     })
+
+    it("throws exception when custom type is not found", () => {
+      const serialized =
+        '{"$value":{"uuid":"a","text":"Clean the house"},"$type":"Task"}'
+
+      expect(() => parse(serialized)).toThrow(
+        "Unknown type: Task. Can't deserialize."
+      )
+    })
   })
 
   describe("custom type with custom $type key", () => {