Sets proper name on record type for identification

gingi · gingi · commit 1c2cb2cf59ff · 2023-11-09T12:53:06.000-05:00
Also supports a custom name on the `@Model()` decorator.
diff --git a/desktop/src/@batch-flask/core/record/decorators.ts b/desktop/src/@batch-flask/core/record/decorators.ts
@@ -56,13 +56,12 @@ export function ListProp<T>(type: any) {
     };
 }
 
-export function Model() {
+export function Model(name?: string) {
     return <T extends new(...args: any[]) => {}>(ctr: T) => {
         if (!(ctr.prototype instanceof Record)) {
             throw new RecordMissingExtendsError(ctr);
         }
-
-        return (class extends ctr {
+        const model = (class extends ctr {
             constructor(...args: any[]) {
                 const [data] = args;
                 if (data instanceof ctr) {
@@ -72,5 +71,7 @@ export function Model() {
                 (this as any)._completeInitialization();
             }
         });
+        Object.defineProperty(model, "name", { value: name || ctr.name });
+        return model;
     };
 }
diff --git a/desktop/src/@batch-flask/core/record/record.spec.ts b/desktop/src/@batch-flask/core/record/record.spec.ts
@@ -44,6 +44,12 @@ class InheritedTestRec extends SimpleTestRec {
     public d: number;
 }
 
+@Model("CustomName")
+class CustomNameRec extends Record<any> {
+    @Prop()
+    public id: string = "default-id";
+}
+
 describe("Record", () => {
     it("should throw an exeption when record doesn't extends Record class", () => {
         try {
@@ -176,4 +182,12 @@ describe("Record", () => {
         expect(SimpleTestRec.isStaticMethod).not.toBeFalsy();
         expect(SimpleTestRec.isStaticMethod()).toBe(true);
     });
+
+    it("should allow a custom record name to be set", () => {
+        const rec1 = new TestRec();
+        expect(rec1.constructor.name).toEqual("TestRec");
+
+        const rec2 = new CustomNameRec();
+        expect(rec2.constructor.name).toEqual("CustomName");
+    });
 });

Original file line number	Diff line number	Diff line change
`@@ -56,13 +56,12 @@ export function ListProp<T>(type: any) {`
`56`	`56`	`};`
`57`	`57`	`}`
`58`	`58`
`59`		`-export function Model() {`
	`59`	`+export function Model(name?: string) {`
`60`	`60`	`return <T extends new(...args: any[]) => {}>(ctr: T) => {`
`61`	`61`	`if (!(ctr.prototype instanceof Record)) {`
`62`	`62`	`throw new RecordMissingExtendsError(ctr);`
`63`	`63`	`}`
`64`		`-`
`65`		`- return (class extends ctr {`
	`64`	`+ const model = (class extends ctr {`
`66`	`65`	`constructor(...args: any[]) {`
`67`	`66`	`const [data] = args;`
`68`	`67`	`if (data instanceof ctr) {`
`@@ -72,5 +71,7 @@ export function Model() {`
`72`	`71`	`(this as any)._completeInitialization();`
`73`	`72`	`}`
`74`	`73`	`});`
	`74`	`+ Object.defineProperty(model, "name", { value: name \|\| ctr.name });`
	`75`	`+ return model;`
`75`	`76`	`};`
`76`	`77`	`}`