Skip to content
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.

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

Add unknown class name to deserialization error #303

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

marcinciarka
Copy link

This pull request includes a small change to the src/transformer.ts file. The change improves the error message by including the class name in the message.

  • src/transformer.ts: Modified the error message to include the class name when deserialization fails.

@piotrwitek
Copy link

piotrwitek commented Nov 7, 2024

This is awesome change, would help debug various issues when deserialization fails when class or other element is not registered or it's module not imported. Would love to have that merged! ❤️

Copy link
Collaborator

@Skn0tt Skn0tt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wonderful change, thank you! could you add a test for it?

src/transformer.ts Outdated Show resolved Hide resolved
Co-authored-by: Simon Knott <[email protected]>
@marcinciarka
Copy link
Author

wonderful change, thank you! could you add a test for it?

@Skn0tt tried for a while now and I can't seem to make it throw that error in tests, can I get some help with this? :)

@Skn0tt
Copy link
Collaborator

Skn0tt commented Nov 25, 2024

Try this:

❯ git diff src
diff --git a/src/index.test.ts b/src/index.test.ts
index e314728..ee49e72 100644
--- a/src/index.test.ts
+++ b/src/index.test.ts
@@ -810,6 +810,9 @@ describe('stringify & parse', () => {
       );
       expect(deserialized.s7).toBeInstanceOf(Train);
       expect(typeof deserialized.s7.brag()).toBe('string');
+
+      meta.values.s7 = [['class', 'Plane']];
+      expect(() => SuperJSON.deserialize(JSON.parse(JSON.stringify({ json, meta })))).toThrowError(`Trying to deserialize unknown class 'Plane' - check https://github.com/blitz-js/superjson/issues/116#issuecomment-773996564`)
     });
 
     describe('with accessor attributes', () => {

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants