fix(type): make sure methods are not part of deserialization/type gua…

…rd union resolver This basically excluded methods/methodSignatures when trying to run deserialization and type guards in deserialization mode.
deepkit · Feb 27, 2024 · eb08a73 · eb08a73
1 parent 1ce87cd
commit eb08a73
Show file tree

Hide file tree

Showing 3 changed files with 58 additions and 1 deletion.
diff --git a/packages/http/tests/router.spec.ts b/packages/http/tests/router.spec.ts
@@ -1733,7 +1733,8 @@ test('http body deep optional union', async () => {
         originalAd: AdTitleAndBasicAttributes | null = null;
         ad: AdTitleAndBasicAttributes | null = null;
 
-        constructor() {
+        hasAd() {
+            return !!this.ad;
         }
     }
 

diff --git a/packages/type/src/serializer.ts b/packages/type/src/serializer.ts
@@ -1339,6 +1339,11 @@ export function typeGuardObjectLiteral(type: TypeObjectLiteral | TypeClass, stat
 
             if (member.name === 'constructor') continue;
 
+            if (state.target === 'deserialize' && (member.kind === ReflectionKind.method || member.kind === ReflectionKind.methodSignature)) {
+                // methods can not be part of serialized data, so we skip them.
+                continue;
+            }
+
             const readName = member.kind === ReflectionKind.methodSignature || member.kind === ReflectionKind.method
                 ? getNameExpression(member.name, state)
                 : getNameExpression(state.isDeserialization ? state.namingStrategy.getPropertyName(member, state.registry.serializer.name) : memberNameToString(member.name), state);

diff --git a/packages/type/tests/serializer.spec.ts b/packages/type/tests/serializer.spec.ts
@@ -1220,3 +1220,54 @@ test('union with optional property', () => {
         expect(a).toEqual({ type: 'a', value: undefined });
     }
 });
+
+test("parcel search input deserialization", async () => {
+    class GeoLocation {
+        locality?: string;
+        postalCode?: string;
+
+        hasCoords() {
+            return true;
+        }
+    }
+
+    interface AdTitleAndBasicAttributes {
+        title: string;
+        attributes: {
+            plotSurface?: number,
+            buildingSurface: number,
+            ges?: string,
+            energyRate?: string,
+        };
+        location: GeoLocation,
+    }
+
+    class ParcelSearchParams {
+        ad: AdTitleAndBasicAttributes | null = null;
+    }
+
+    const data: any = {
+        "ad": {
+            "title": "Maison 4 pièces 92 m²",
+            "attributes": {
+                "buildingSurface": 92,
+                "energyRate": "D",
+                "ges": "E"
+            },
+            "location": {
+                "locality": "Paris",
+                "postalCode": "75000"
+            }
+        }
+    } as any;
+
+    const location = cast<GeoLocation>(data.ad.location);
+    expect(location).toBeInstanceOf(GeoLocation);
+    expect(location.locality).toBe("Paris");
+
+    const search = cast<ParcelSearchParams>(data);
+    expect(search.ad).not.toBeUndefined();
+    expect(search.ad!.location).toBeInstanceOf(GeoLocation);
+    expect(search?.ad?.attributes?.buildingSurface).toBe(92);
+    expect(search?.ad?.location.hasCoords()).toBeTruthy();
+});