SuperJSON: This hack is actually still needed.

This commit is contained in:
Enrico Ros
2024-08-10 21:50:48 -07:00
parent 2c3f237ccc
commit f9262e0f1f
+52 -43
View File
@@ -6,48 +6,57 @@
import superjson from 'superjson';
/**
* NOTE: 2024-08-10: this doesn't seem to be needed anymore, as such we use plain `superjson` as-is.
* WORKAROUND: an incredibly weird bug with NextJS-14.2.4 + tRPC v11 + SuperJSON
*
* If the serialized object has 'undefined' values (e.g. {json.name: null, meta.values.name=['undefined']},
* superjson will try to apply the format conversion from the 'null' to the 'undefined' value directly to the input object.
*
* This somehow fails with tRPC-11 and NextJS-14.2.4. There may be immutability somewhere.
*
* While a slot workaround would be to deepcopy (JSON.parse(JSON.stringify(object)) the object
* we use a more lightweight approach that only works on top-level properties.
*
* May be related to https://github.com/blitz-js/superjson/issues/242 ?
* May be related to https://github.com/blitz-js/superjson/issues/283 ?
*
* NOTEs:
* - 2024-08-10 (1): this doesn't seem to be needed anymore, as such we use plain `superjson` as-is
* - 2024-08-10 (2): this is actually still needed: the issue is when delivering input data to tRPC calls,
* where nulls won't be converted to `undefined`. Furthermore, add the `shallowClone` function to handle
* the case of arrays, in addition to objects.
*/
export const transformer = superjson;
function deserializeWithWorkaround<T = unknown>(object: any): T {
// /**
// * WORKAROUND: an incredibly weird bug with NextJS-14.2.4 + tRPC v11 + SuperJSON
// *
// * If the serialized object has 'undefined' values (e.g. {json.name: null, meta.values.name=['undefined']},
// * superjson will try to apply the format conversion from the 'null' to the 'undefined' value directly to the input object.
// *
// * This somehow fails with tRPC-11 and NextJS-14.2.4. There may be immutability somewhere.
// *
// * While a slot workaround would be to deepcopy (JSON.parse(JSON.stringify(object)) the object
// * we use a more lightweight approach that only works on top-level properties.
// *
// * May be related to https://github.com/blitz-js/superjson/issues/242 ?
// * May be related to https://github.com/blitz-js/superjson/issues/283 ?
// */
// function deserializeWithWorkaround<T = unknown>(object: any): T {
//
// // Second-level (object.json: {..}) mutability workaround
// if (object && object instanceof Object && object?.meta && object?.json) {
// object = { ...object, json: { ...object.json } };
// }
//
// return superjson.deserialize<T>(object);
// }
//
//
// export const transformer = {
// serialize: superjson.serialize,
// deserialize: deserializeWithWorkaround,
//
// // The following commented code is here just to let us place breakpoints quickly
//
// // serialize: (object: any): any => {
// // const serialized = superjson.serialize(object);
// // return serialized;
// // }
//
// // deserialize: (object: any): any => {
// // const des = superjson.deserialize(object);
// // return des;
// // }
// };
// Second-level (object.json: {..}) mutability workaround
// This triggers when both `meta` and `json` are present, which means SuperJSON has
// special instructionf for the `json` object.
if (object && object instanceof Object && object?.meta && object?.json)
object = { ...object, json: shallowClone(object.json) };
return superjson.deserialize<T>(object);
}
function shallowClone(obj: any): any {
if (obj === null || typeof obj !== 'object')
return obj;
if (Array.isArray(obj))
return [...obj];
return { ...obj };
}
export const transformer = {
serialize: superjson.serialize,
deserialize: deserializeWithWorkaround,
// The following commented code is here just to let us place breakpoints quickly
// serialize: (object: any): any => {
// const serialized = superjson.serialize(object);
// return serialized;
// }
// deserialize: (object: any): any => {
// const des = superjson.deserialize(object);
// return des;
// }
};