Merge pull request #3070 from SeedCompany/validation

Author: CarsonF

src/common/validators/short-id.validator.ts

@@ -1,6 +1,6 @@
 import { ArgumentMetadata, PipeTransform } from '@nestjs/common';
 import { ValidationOptions } from 'class-validator';
-import { ValidationException } from '../../core/validation.pipe';
+import { ValidationException } from '~/core/validation';
 import { isValidId } from '../generate-id';
 import { ValidateBy } from './validateBy';
 

src/common/validators/validateBy.ts

@@ -1,16 +1,25 @@
-import { FnLike } from '@seedcompany/common';
+import { Type } from '@nestjs/common';
 import {
   registerDecorator,
   ValidationOptions,
   ValidatorConstraintInterface,
 } from 'class-validator';
+import { MergeExclusive } from 'type-fest';
 
-export interface ValidateByOptions {
-  name: string;
-  constraints?: any[];
-  validator: ValidatorConstraintInterface | FnLike;
-  async?: boolean;
-}
+export type ValidateByOptions =
+  | MergeExclusive<
+      {
+        validator: ValidatorConstraintInterface;
+        name: string;
+        async?: boolean;
+        constraints?: any[];
+      },
+      {
+        validator: Type<ValidatorConstraintInterface>;
+        constraints?: any[];
+      }
+    >
+  | Type<ValidatorConstraintInterface>;
 
 export const ValidateBy =
   (
@@ -19,13 +28,11 @@ export const ValidateBy =
   ): PropertyDecorator =>
   (object: Record<string, any>, propertyName: string | symbol) => {
     registerDecorator({
-      name: options.name,
       target: object.constructor,
       propertyName: propertyName as string,
       options: validationOptions,
-      constraints: options.constraints,
-      validator: options.validator,
-      async: options.async,
+      ...options,
+      validator: typeof options === 'function' ? options : options.validator,
     });
   };
 

src/components/changeset/changeset.module.ts

@@ -4,13 +4,15 @@ import { ChangesetAwareResolver } from './changeset-aware.resolver';
 import { ValidateChangesetEditablePipe } from './changeset.arg';
 import { ChangesetRepository } from './changeset.repository';
 import { ChangesetResolver } from './changeset.resolver';
+import { ObjectViewPipe } from './dto';
 import { EnforceChangesetEditablePipe } from './enforce-changeset-editable.pipe';
 
 @Module({
   providers: [
     ChangesetAwareResolver,
     ChangesetResolver,
     ChangesetRepository,
+    ObjectViewPipe,
     { provide: APP_PIPE, useClass: EnforceChangesetEditablePipe },
     ValidateChangesetEditablePipe,
   ],

src/components/changeset/dto/changeset.args.ts

@@ -1,7 +1,7 @@
-import { PipeTransform } from '@nestjs/common';
+import { Injectable, PipeTransform } from '@nestjs/common';
 import { Args, ArgsType } from '@nestjs/graphql';
-import { ID, IdField, ObjectView } from '../../../common';
-import { ValidationPipe } from '../../../core/validation.pipe';
+import { ID, IdField, ObjectView } from '~/common';
+import { ValidationPipe } from '~/core/validation';
 
 /**
  * A helper for id & changeset arguments.
@@ -20,15 +20,15 @@ export type IdsAndView = ChangesetIds & { view: ObjectView };
 export const IdsAndViewArg = () =>
   Args({ type: () => ChangesetIds }, ObjectViewPipe);
 
-class ObjectViewPipe implements PipeTransform {
-  async transform({ id, changeset }: ChangesetIds) {
-    await new ValidationPipe().transform(
-      { id, changeset },
-      {
-        metatype: ChangesetIds,
-        type: 'body',
-      },
-    );
+@Injectable()
+export class ObjectViewPipe implements PipeTransform {
+  constructor(private readonly validator: ValidationPipe) {}
+
+  async transform(input: ChangesetIds) {
+    const { id, changeset } = await this.validator.transform(input, {
+      metatype: ChangesetIds,
+      type: 'body',
+    });
     const view: ObjectView = changeset ? { changeset } : { active: true };
     return { id, changeset, view };
   }

src/core/core.module.ts

@@ -1,5 +1,5 @@
 import { Global, Module } from '@nestjs/common';
-import { APP_FILTER, APP_INTERCEPTOR, APP_PIPE } from '@nestjs/core';
+import { APP_FILTER, APP_INTERCEPTOR } from '@nestjs/core';
 import { DataLoaderModule } from '@seedcompany/data-loader';
 import { EmailModule } from '@seedcompany/nestjs-email';
 import { ConsoleModule } from 'nestjs-console';
@@ -19,7 +19,7 @@ import { ResourceModule } from './resources/resource.module';
 import { ScalarProviders } from './scalars.resolver';
 import { TimeoutInterceptor } from './timeout.interceptor';
 import { TracingModule } from './tracing';
-import { ValidationPipe } from './validation.pipe';
+import { ValidationModule } from './validation/validation.module';
 import { WaitResolver } from './wait.resolver';
 
 @Global()
@@ -36,13 +36,13 @@ import { WaitResolver } from './wait.resolver';
     EventsModule,
     TracingModule,
     ResourceModule,
+    ValidationModule,
   ],
   providers: [
     AwsS3Factory,
     ExceptionNormalizer,
     ExceptionFilter,
     { provide: APP_FILTER, useExisting: ExceptionFilter },
-    { provide: APP_PIPE, useClass: ValidationPipe },
     { provide: APP_INTERCEPTOR, useClass: TimeoutInterceptor },
     WaitResolver,
     ...ScalarProviders,
@@ -60,6 +60,7 @@ import { WaitResolver } from './wait.resolver';
     EventsModule,
     ResourceModule,
     TracingModule,
+    ValidationModule,
   ],
 })
 export class CoreModule {}

src/core/exception/exception.filter.ts

@@ -4,7 +4,7 @@ import { GqlContextType, GqlExceptionFilter } from '@nestjs/graphql';
 import { mapValues } from '@seedcompany/common';
 import { ConfigService } from '../config/config.service';
 import { ILogger, Logger, LogLevel } from '../logger';
-import { ValidationException } from '../validation.pipe';
+import { ValidationException } from '../validation';
 import { ExceptionJson, ExceptionNormalizer } from './exception.normalizer';
 import { isFromHackAttempt } from './is-from-hack-attempt';
 

src/core/validation/index.ts

@@ -0,0 +1,2 @@
+export * from './validation.exception';
+export * from './validation.pipe';

src/core/validation.pipe.ts renamed to src/core/validation/validation.exception.ts

@@ -1,24 +1,9 @@
-import {
-  ValidationPipe as BaseValidationPipe,
-  Injectable,
-  ValidationError,
-} from '@nestjs/common';
+import { ValidationError } from '@nestjs/common';
 import { entries } from '@seedcompany/common';
 import { SetRequired } from 'type-fest';
 import { fileURLToPath } from 'url';
-import { ClientException } from '../common/exceptions';
-import { jestSkipFileInExceptionSource } from './exception';
-
-@Injectable()
-export class ValidationPipe extends BaseValidationPipe {
-  constructor() {
-    super({
-      transform: true,
-      skipMissingProperties: true,
-      exceptionFactory: (es) => new ValidationException(es),
-    });
-  }
-}
+import { ClientException } from '~/common/exceptions';
+import { jestSkipFileInExceptionSource } from '../exception';
 
 export class ValidationException extends ClientException {
   readonly errors: Record<string, Record<string, string>>;

src/core/validation/validation.module.ts

@@ -0,0 +1,14 @@
+import { Module } from '@nestjs/common';
+import { APP_PIPE } from '@nestjs/core';
+import { Validator } from 'class-validator';
+import { ValidationPipe } from './validation.pipe';
+
+@Module({
+  providers: [
+    Validator,
+    ValidationPipe,
+    { provide: APP_PIPE, useExisting: ValidationPipe },
+  ],
+  exports: [ValidationPipe],
+})
+export class ValidationModule {}

src/core/validation/validation.pipe.ts

@@ -0,0 +1,35 @@
+import {
+  ValidationPipe as BaseValidationPipe,
+  Injectable,
+} from '@nestjs/common';
+import { ModuleRef } from '@nestjs/core';
+import { useContainer, ValidatorOptions } from 'class-validator';
+import { ValidationException } from './validation.exception';
+
+@Injectable()
+export class ValidationPipe extends BaseValidationPipe {
+  constructor(private readonly moduleRef: ModuleRef) {
+    super({
+      transform: true,
+      skipMissingProperties: true,
+      exceptionFactory: (es) => new ValidationException(es),
+    });
+  }
+  private readonly containerForLib = {
+    get: (type: any) => {
+      if (type.name === 'CustomConstraint') {
+        // Prototype-less constraints. Null to fall back to default, which just calls constructor once.
+        return null;
+      }
+      return this.moduleRef.get(type);
+    },
+  };
+
+  protected async validate(
+    object: object,
+    validatorOptions?: ValidatorOptions,
+  ) {
+    useContainer(this.containerForLib, { fallback: true });
+    return await super.validate(object, validatorOptions);
+  }
+}