refactor(graphql): refactor metadata loader, add missing tests

Author: kamilmysliwiec

packages/graphql/lib/plugin/metadata-loader.ts

@@ -1,7 +1,11 @@
 import { METADATA_FACTORY_NAME } from './plugin-constants';
 
 export class MetadataLoader {
-  public static readonly refreshHooks = new Set<() => void>();
+  private static readonly refreshHooks = new Array<() => void>();
+
+  static addRefreshHook(hook: () => void) {
+    return MetadataLoader.refreshHooks.unshift(hook);
+  }
 
   async load(metadata: Record<string, any>) {
     const pkgMetadata = metadata['@nestjs/graphql'];
@@ -12,11 +16,16 @@ export class MetadataLoader {
     if (models) {
       await this.applyMetadata(models);
     }
+    this.runHooks();
+  }
 
+  private runHooks() {
     MetadataLoader.refreshHooks.forEach((hook) => hook());
   }
 
-  private async applyMetadata(meta: Record<string, any>) {
+  private async applyMetadata(
+    meta: Array<[Promise<unknown>, Record<string, any>]>,
+  ) {
     const loadPromises = meta.map(async ([fileImport, fileMeta]) => {
       const fileRef = await fileImport;
       Object.keys(fileMeta).map((key) => {

packages/graphql/lib/schema-builder/utils/get-fields-and-decorator.util.ts

@@ -36,7 +36,7 @@ export function getFieldsAndDecoratorForType<T>(
   if (!fields) {
     throw new UnableToFindFieldsError(objType.name);
   }
-  fields = inheritClassFields(objType, fields);
+  fields = inheritClassFields(objType, fields, options);
 
   return {
     fields,
@@ -82,6 +82,7 @@ function getClassMetadataAndFactoryByTargetAndType(
 function inheritClassFields(
   objType: Type<unknown>,
   fields: PropertyMetadata[],
+  options?: { overrideFields?: boolean },
 ) {
   try {
     const parentClass = Object.getPrototypeOf(objType);
@@ -90,8 +91,13 @@ function inheritClassFields(
     }
     const { fields: parentFields } = getFieldsAndDecoratorForType(
       parentClass as Type<unknown>,
+      options,
+    );
+    return inheritClassFields(
+      parentClass,
+      [...parentFields, ...fields],
+      options,
     );
-    return inheritClassFields(parentClass, [...parentFields, ...fields]);
   } catch (err) {
     return fields;
   }

packages/graphql/lib/type-helpers/intersection-type.helper.ts

@@ -42,10 +42,8 @@ export function IntersectionType<A, B>(
   function applyFields(fields: PropertyMetadata[]) {
     fields.forEach((item) => {
       if (isFunction(item.typeFn)) {
-        /**
-         * Execute type function eagarly to update the type options object (before "clone" operation)
-         * when the passed function (e.g., @Field(() => Type)) lazily returns an array.
-         */
+        // Execute type function eagerly to update the type options object (before "clone" operation)
+        // when the passed function (e.g., @Field(() => Type)) lazily returns an array.
         item.typeFn();
       }
 
@@ -58,7 +56,9 @@ export function IntersectionType<A, B>(
   }
   applyFields(fields);
 
-  MetadataLoader.refreshHooks.add(() => {
+  // Register a refresh hook to update the fields when the serialized metadata
+  // is loaded from file.
+  MetadataLoader.addRefreshHook(() => {
     const { fields: fieldsA } = getFieldsAndDecoratorForType(classARef, {
       overrideFields: true,
     });

packages/graphql/lib/type-helpers/omit-type.helper.ts

@@ -40,10 +40,8 @@ export function OmitType<T, K extends keyof T>(
       .filter((item) => !keys.includes(item.name as K))
       .forEach((item) => {
         if (isFunction(item.typeFn)) {
-          /**
-           * Execute type function eagarly to update the type options object (before "clone" operation)
-           * when the passed function (e.g., @Field(() => Type)) lazily returns an array.
-           */
+          // Execute type function eagerly to update the type options object (before "clone" operation)
+          // when the passed function (e.g., @Field(() => Type)) lazily returns an array.
           item.typeFn();
         }
 
@@ -56,7 +54,9 @@ export function OmitType<T, K extends keyof T>(
   }
   applyFields(fields);
 
-  MetadataLoader.refreshHooks.add(() => {
+  // Register a refresh hook to update the fields when the serialized metadata
+  // is loaded from file.
+  MetadataLoader.addRefreshHook(() => {
     const { fields } = getFieldsAndDecoratorForType(classRef, {
       overrideFields: true,
     });

packages/graphql/lib/type-helpers/partial-type.helper.ts

@@ -36,10 +36,8 @@ export function PartialType<T>(
   function applyFields(fields: PropertyMetadata[]) {
     fields.forEach((item) => {
       if (isFunction(item.typeFn)) {
-        /**
-         * Execute type function eagerly to update the type options object (before "clone" operation)
-         * when the passed function (e.g., @Field(() => Type)) lazily returns an array.
-         */
+        // Execute type function eagerly to update the type options object (before "clone" operation)
+        // when the passed function (e.g., @Field(() => Type)) lazily returns an array.
         item.typeFn();
       }
       Field(item.typeFn, { ...item.options, nullable: true })(
@@ -52,6 +50,15 @@ export function PartialType<T>(
   }
   applyFields(fields);
 
+  // Register a refresh hook to update the fields when the serialized metadata
+  // is loaded from file.
+  MetadataLoader.addRefreshHook(() => {
+    const { fields } = getFieldsAndDecoratorForType(classRef, {
+      overrideFields: true,
+    });
+    applyFields(fields);
+  });
+
   if (PartialObjectType[METADATA_FACTORY_NAME]) {
     const pluginFields = Object.keys(
       PartialObjectType[METADATA_FACTORY_NAME](),
@@ -60,12 +67,6 @@ export function PartialType<T>(
       applyIsOptionalDecorator(PartialObjectType, key),
     );
   }
-  MetadataLoader.refreshHooks.add(() => {
-    const { fields } = getFieldsAndDecoratorForType(classRef, {
-      overrideFields: true,
-    });
-    applyFields(fields);
-  });
 
   Object.defineProperty(PartialObjectType, 'name', {
     value: `Partial${classRef.name}`,

packages/graphql/lib/type-helpers/pick-type.helper.ts

@@ -41,10 +41,8 @@ export function PickType<T, K extends keyof T>(
       .filter((item) => keys.includes(item.name as K))
       .forEach((item) => {
         if (isFunction(item.typeFn)) {
-          /**
-           * Execute type function eagarly to update the type options object (before "clone" operation)
-           * when the passed function (e.g., @Field(() => Type)) lazily returns an array.
-           */
+          // Execute type function eagerly to update the type options object (before "clone" operation)
+          // when the passed function (e.g., @Field(() => Type)) lazily returns an array.
           item.typeFn();
         }
 
@@ -57,11 +55,14 @@ export function PickType<T, K extends keyof T>(
   }
   applyFields(fields);
 
-  MetadataLoader.refreshHooks.add(() => {
+  // Register a refresh hook to update the fields when the serialized metadata
+  // is loaded from file.
+  MetadataLoader.addRefreshHook(() => {
     const { fields } = getFieldsAndDecoratorForType(classRef, {
       overrideFields: true,
     });
     applyFields(fields);
   });
+
   return PickObjectType as Type<Pick<T, (typeof keys)[number]>>;
 }

packages/graphql/tests/plugin/type-helpers/fixtures/base-type.fixture.ts

@@ -0,0 +1,17 @@
+import { Directive, Extensions, Field, ObjectType } from '../../../../lib/decorators';
+
+@ObjectType({ isAbstract: true })
+export abstract class BaseType {
+  @Field()
+  @Directive('@upper')
+  @Extensions({ extension: true })
+  id: string;
+
+  @Field()
+  createdAt: Date;
+
+  @Field()
+  updatedAt: Date;
+
+  meta: string;
+}

packages/graphql/tests/plugin/type-helpers/fixtures/create-user-dto.fixture.ts

@@ -0,0 +1,26 @@
+import { Transform } from 'class-transformer';
+import { IsBoolean, MinLength } from 'class-validator';
+import { Directive, Extensions, Field, ObjectType } from '../../../../lib/decorators';
+
+@ObjectType()
+export class CreateUserDto {
+  @Transform((str) => str + '_transformed')
+  @MinLength(10)
+  @Field({ nullable: true })
+  @Directive('@upper')
+  login: string;
+
+  @Transform((str) => str + '_transformed')
+  @MinLength(10)
+  @Field()
+  @Directive('@upper')
+  @Extensions({ extension: true })
+  password: string;
+
+  @Field({ name: 'id' })
+  @Extensions({ extension: true })
+  _id: string;
+
+  @IsBoolean()
+  active: boolean;
+}

packages/graphql/tests/plugin/type-helpers/fixtures/serialized-metadata.fixture.ts

@@ -0,0 +1,26 @@
+export const SERIALIZED_METADATA = {
+  '@nestjs/graphql': {
+    models: [
+      [
+        import('./base-type.fixture'),
+        {
+          BaseType: {
+            meta: {
+              type: () => String,
+            },
+          },
+        },
+      ],
+      [
+        import('./create-user-dto.fixture'),
+        {
+          CreateUserDto: {
+            active: {
+              type: () => Boolean,
+            },
+          },
+        },
+      ],
+    ],
+  },
+}

packages/graphql/tests/plugin/type-helpers/omit-type.helper.spec.ts

@@ -1,32 +1,8 @@
-import { Transform } from 'class-transformer';
-import { MinLength } from 'class-validator';
-import {
-  Directive,
-  Extensions,
-  Field,
-  ObjectType,
-} from '../../../lib/decorators';
 import { getFieldsAndDecoratorForType } from '../../../lib/schema-builder/utils/get-fields-and-decorator.util';
 import { OmitType } from '../../../lib/type-helpers';
+import { CreateUserDto } from './fixtures/create-user-dto.fixture';
 
 describe('OmitType', () => {
-  @ObjectType()
-  class CreateUserDto {
-    @MinLength(10)
-    @Field({ nullable: true })
-    login: string;
-
-    @Transform((str) => str + '_transformed')
-    @MinLength(10)
-    @Field()
-    @Directive('@upper')
-    @Extensions({ extension: true })
-    password: string;
-
-    @Field({ name: 'id' })
-    _id: string;
-  }
-
   class UpdateUserDto extends OmitType(CreateUserDto, ['login', '_id']) {}
 
   it('should inherit all fields except for "login" and "_id"', () => {