fix(json-mapper): fix issue with ReadOnly decorator

tsedio · Aug 29, 2022 · 78eced3 · 78eced3
1 parent b0b4360
commit 78eced3
Show file tree

Hide file tree

Showing 5 changed files with 42 additions and 5 deletions.
diff --git a/packages/orm/mongoose/src/utils/createSchema.ts b/packages/orm/mongoose/src/utils/createSchema.ts
@@ -116,10 +116,10 @@ export function buildMongooseSchema(target: any): MongooseSchemaMetadata {
       return;
     }
 
-    // Keeping the Mongoose Schema separate so it can overwrite everything once schema has been built.
+    // Keeping the Mongoose Schema separate, so it can overwrite everything once schema has been built.
     const schemaTypeOptions: any = propertyMetadata.store.get(MONGOOSE_SCHEMA) || {};
 
-    if (schemaTypeOptions.schemaIgnore || propertyMetadata.schema.isReadOnly) {
+    if (schemaTypeOptions.schemaIgnore || propertyMetadata.isGetterOnly()) {
       return;
     }
 

diff --git a/packages/orm/mongoose/test/readonly.integration.spec.ts b/packages/orm/mongoose/test/readonly.integration.spec.ts
@@ -1,7 +1,7 @@
 import {Inject, Injectable, PlatformTest} from "@tsed/common";
 import {getJsonSchema, Groups, Name, Property, ReadOnly, Required} from "@tsed/schema";
 import {TestMongooseContext} from "@tsed/testing-mongoose";
-import {Immutable, Model, MongooseModel, ObjectID} from "../src/index";
+import {Immutable, Model, MongooseModel, ObjectID, SchemaIgnore} from "../src/index";
 
 class BaseModel {
   @ObjectID("id")
@@ -12,12 +12,14 @@ class BaseModel {
   @Required()
   @Immutable()
   @ReadOnly()
+  @SchemaIgnore()
   @Name("created_at")
   @Groups("!create", "!update")
   createdAt: number = Date.now();
 
   @Required()
   @ReadOnly()
+  @SchemaIgnore()
   @Name("updated_at")
   @Groups("!create", "!update")
   updatedAt: number = Date.now();

diff --git a/packages/specs/json-mapper/src/utils/deserialize.ts b/packages/specs/json-mapper/src/utils/deserialize.ts
@@ -161,7 +161,7 @@ export function plainObjectToClass<T = any>(src: any, options: JsonDeserializerO
       collectionType: propStore.collectionType
     });
 
-    if (!propStore.schema.isReadOnly) {
+    if (!propStore.isGetterOnly()) {
       if (value !== undefined) {
         out[propStore.propertyName] = value;
       } else if (options.partial) {

diff --git a/packages/specs/schema/src/domain/JsonEntityStore.spec.ts b/packages/specs/schema/src/domain/JsonEntityStore.spec.ts
@@ -53,6 +53,7 @@ describe("JsonEntityStore", () => {
     expect(storeProp.isPrimitive).toBe(true);
     expect(storeProp.isObject).toBe(false);
     expect(storeProp.isClass).toBe(false);
+    expect(storeProp.isGetterOnly()).toBeFalsy();
 
     // METHOD
     const storeMethod = JsonEntityStore.from(Model).children.get("method") as JsonMethodStore;
@@ -92,6 +93,7 @@ describe("JsonEntityStore", () => {
     expect(storeParam.isPrimitive).toBe(true);
     expect(storeParam.isObject).toBe(false);
     expect(storeParam.isClass).toBe(false);
+    expect(storeParam.isGetterOnly()).toBe(false);
   });
   it("should manage enum from babel", () => {
     enum MyEnum {
@@ -110,4 +112,34 @@ describe("JsonEntityStore", () => {
 
     expect(store.type).toEqual(String);
   });
+
+  describe("isGetterOnly()", () => {
+    it("should create JsonEntityStore on getter", () => {
+      class Model {
+        @Property()
+        get id() {
+          return "id";
+        }
+      }
+
+      // CLASS
+      // PROPERTY
+      const storeProp = JsonEntityStore.from(Model).children.get("id") as JsonPropertyStore;
+      expect(storeProp.isGetterOnly()).toBeTruthy();
+    });
+    it("should create JsonEntityStore on getter/setter", () => {
+      class Model {
+        @Property()
+        get id() {
+          return "id";
+        }
+        set id(id: string) {}
+      }
+
+      // CLASS
+      // PROPERTY
+      const storeProp = JsonEntityStore.from(Model).children.get("id") as JsonPropertyStore;
+      expect(storeProp.isGetterOnly()).toBeFalsy();
+    });
+  });
 });
diff --git a/packages/specs/schema/src/domain/JsonEntityStore.ts b/packages/specs/schema/src/domain/JsonEntityStore.ts
@@ -57,7 +57,7 @@ export abstract class JsonEntityStore implements JsonEntityStoreOptions {
   /**
    * Method's descriptor
    */
-  readonly descriptor: number;
+  readonly descriptor: PropertyDescriptor;
   /**
    * Decorator type used to declare the JsonSchemaStore.
    */
@@ -95,6 +95,9 @@ export abstract class JsonEntityStore implements JsonEntityStoreOptions {
     this.parent = this;
   }
 
+  isGetterOnly() {
+    return isObject(this.descriptor) && !this.descriptor.value && this.descriptor.get && !this.descriptor.set;
+  }
   /**
    * Return the class name of the entity.
    * @returns {string}