Merge pull request #192 from jhipster/feature/dto-validation-issue182

Angelo Manganiello · web-flow · commit 8704de3596b0 · 2020-12-14T09:04:32.000+01:00
Feature/dto validation issue182
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,7 +13,8 @@
 
 # [1.4.0](https://github.com/jhipster/generator-jhipster-nodejs/tree/v1.4.0)
 
--   Dto implementation in the rest nestjs api[issue #181](https://github.com/jhipster/generator-jhipster-nodejs/issues/181)
+-   Add validation in dto nestjs controllers [issue #182](https://github.com/jhipster/generator-jhipster-nodejs/issues/182)
+-   Dto implementation in the rest nestjs api [issue #181](https://github.com/jhipster/generator-jhipster-nodejs/issues/181)
 -   Protractor or another tool for client e2e tests [issue #101](https://github.com/jhipster/generator-jhipster-nodejs/issues/101)
 -   Support the account management with user registration, delete, creation and changes password with settings [issue #166](https://github.com/jhipster/generator-jhipster-nodejs/issues/166)
 -   NestJS migration from 6 to 7 version [issue #183](https://github.com/jhipster/generator-jhipster-nodejs/issues/183)
diff --git a/ROADMAP.md b/ROADMAP.md
@@ -51,11 +51,11 @@ To contribute for the next featues, fork the repo and open a pull request regard
 -   [x] Jhipster client e2e protractor tests integrated
 -   [x] Other core/admin jhipster management api
 -   [x] DTOs based rest api
+-   [x] Validation
 
 ## To DO for next release
 
 -   [ ] Add MongoDB support
--   [ ] Validation
 -   [ ] Export json/yaml for swagger to integrate with jhipster gateway
 -   [ ] pagination options in client
 -   [ ] Elastic Search support
diff --git a/generators/entity-server/templates/server/src/common/field_validators.ejs b/generators/entity-server/templates/server/src/common/field_validators.ejs
@@ -16,7 +16,7 @@
  See the License for the specific language governing permissions and
  limitations under the License.
 -%>
-<%#	Returns a string of all validator annotations for the entity field. -%>
+<%# Returns a string of all validator annotations for the entity field. -%>
 <%
 const field = fields[idx];
 let result = '';
@@ -28,16 +28,16 @@ if (field.fieldValidate === true) {
     const isBlob = field.fieldType === 'byte[]';
 
     if (rules.includes('required') && !isBlob) {
-        validators.push('@NotNull');
+        validators.push('@IsNotEmpty()');
     }
     if (rules.includes('minlength') && !rules.includes('maxlength')) {
-        validators.push('@Size(min = ' + field.fieldValidateRulesMinlength + ')');
+        validators.push('@MinLength(' + field.fieldValidateRulesMinlength + ')');
     }
     if (rules.includes('maxlength') && !rules.includes('minlength')) {
-        validators.push('@Size(max = ' + field.fieldValidateRulesMaxlength + ')');
+        validators.push('@MaxLength(' + field.fieldValidateRulesMaxlength + ')');
     }
     if (rules.includes('minlength') && rules.includes('maxlength')) {
-        validators.push('@Size(min = ' + field.fieldValidateRulesMinlength + ', max = ' + field.fieldValidateRulesMaxlength + ')');
+        validators.push('@Length(' + field.fieldValidateRulesMinlength + ', ' + field.fieldValidateRulesMaxlength + ')');
     }
     // Not supported anymore because the server can't check the size of the blob before downloading it completely.
     // if (rules.includes('minbytes') && !rules.includes('maxbytes')) {
@@ -50,25 +50,15 @@ if (field.fieldValidate === true) {
     //     validators.push('@Size(min = ' + field.fieldValidateRulesMinbytes + ', max = ' + field.fieldValidateRulesMaxbytes + ')');
     // }
     if (rules.includes('min')) {
-        if (field.fieldType === 'Float' || field.fieldType === 'Double' || field.fieldType === 'BigDecimal') {
-            validators.push('@DecimalMin(value = "' + field.fieldValidateRulesMin + '")');
-        } else {
-            const isLong = (field.fieldValidateRulesMin > MAX_VALUE || field.fieldType == 'Long') ? 'L' : '';
-            validators.push('@Min(value = ' + field.fieldValidateRulesMin + isLong + ')');
-        }
+        validators.push('@Min(' + field.fieldValidateRulesMin + ')');
     }
     if (rules.includes('max')) {
-        if (field.fieldType === 'Float' || field.fieldType === 'Double' || field.fieldType === 'BigDecimal') {
-            validators.push('@DecimalMax(value = "' + field.fieldValidateRulesMax + '")');
-        } else {
-            const isLong = (field.fieldValidateRulesMax > MAX_VALUE || field.fieldType == 'Long') ? 'L' : '';
-            validators.push('@Max(value = ' + field.fieldValidateRulesMax + isLong + ')');
-        }
+        validators.push('@Max(' + field.fieldValidateRulesMax + ')');
     }
     if (rules.includes('pattern')) {
-        validators.push('@Pattern(regexp = "' + field.fieldValidateRulesPatternJava  + '")');
+        validators.push('@Matches("' + field.fieldValidateRulesPatternJava  + '")');
     }
     result =  validators.join('\n    ');
     result += '\n';
 } -%>
-<%# WIP: todo - result -%>
+<%- result -%>
diff --git a/generators/entity-server/templates/server/src/domain/entity.ts.ejs b/generators/entity-server/templates/server/src/domain/entity.ts.ejs
@@ -53,7 +53,7 @@ export class <%= asEntity(entityClass) %> extends BaseEntity  {
         if (fieldValidateRules.includes('unique')) {
             unique = true;
         } _%>
-    <%- include ../common/field_validators -%>
+
     <%_ } _%>
         <%_ if (fields[idx].fieldIsEnum) { _%>
     @Column({type: 'simple-enum', name: '<%-fieldNameAsDatabaseColumn %>', enum: <%= fieldType %>})
diff --git a/generators/entity-server/templates/server/src/service/dto/entity.dto.ts.ejs b/generators/entity-server/templates/server/src/service/dto/entity.dto.ts.ejs
@@ -1,7 +1,7 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 import { ApiModelProperty } from '@nestjs/swagger';
 <%_ if (validation) { _%>
-import { validate, Contains, IsString, IsInt, Length, IsEmail, Min, Max } from 'class-validator';
+import { IsNotEmpty, MinLength, MaxLength, Length, Min, Max, Matches } from 'class-validator';
 <%_ } _%>
 import { BaseDTO } from './base.dto';
 
@@ -34,10 +34,8 @@ export class <%= asEntity(entityClass) %>DTO extends BaseDTO {
     <%- formatAsFieldJavadoc(fields[idx].javadoc) %>
     <%_ }
         let required = false;
-        let unique = false;
         const fieldValidate = fields[idx].fieldValidate;
         const fieldValidateRules = fields[idx].fieldValidateRules;
-        const fieldValidateRulesMaxlength = fields[idx].fieldValidateRulesMaxlength;
         const fieldType = fields[idx].fieldType;
         const fieldTypeBlobContent = fields[idx].fieldTypeBlobContent;
         const fieldName = fields[idx].fieldName;
@@ -48,17 +46,11 @@ export class <%= asEntity(entityClass) %>DTO extends BaseDTO {
             if (fieldValidateRules.includes('required')) {
                 required = true;
             }
-            if (fieldValidateRules.includes('unique')) {
-                unique = true;
-            } _%>
-        <%- include ../../common/field_validators -%>
+            _%>
+            <%- include ../../common/field_validators -%>
         <%_ } _%>
             <%_ if (fields[idx].fieldIsEnum) { _%>
             @ApiModelProperty({ enum: <%= fieldType %>, <%_ if (typeof fields[idx].javadoc != 'undefined') { _%> description: '<%- formatAsApiDescription(fields[idx].javadoc) %>' <%_ } else { _%> description: '<%= fieldName %> enum field' <%_ } if (!required) { _%>, required: false <%_ } _%>})
-            <%_ } else if (['Instant', 'ZonedDateTime', 'LocalDate'].includes(fieldType)) { _%>
-
-            <%_ } else if (fieldType === 'BigDecimal') { _%>
-
             <%_ } else { _%>
             @ApiModelProperty({ <%_ if (typeof fields[idx].javadoc != 'undefined') { _%> description: '<%- formatAsApiDescription(fields[idx].javadoc) %>' <%_ } else { _%> description: '<%= fieldName %> field' <%_ } if (!required) { _%>, required: false <%_ } _%>})
             <%_ } _%>
diff --git a/test-integration/samples/monolith-client-auth-i18n-template-jdl/monolith-client-auth-i18n-template-jdl.jdl b/test-integration/samples/monolith-client-auth-i18n-template-jdl/monolith-client-auth-i18n-template-jdl.jdl
@@ -35,7 +35,7 @@ entity BloodPressure {
 }
 entity Weight {
   timestamp ZonedDateTime required
-  weight Double 
+  weight Double
 }
 entity Points {
   date LocalDate required
@@ -45,7 +45,7 @@ entity Points {
   notes String maxlength(140)
 }
 entity Preferences {
-  weeklyGoal Integer required max(21)
+  weeklyGoal Integer
   weightUnits Units required
 }
 
diff --git a/test-integration/samples/monolith-client-auth-template-jdl/monolith-client-auth-template-jdl.jdl b/test-integration/samples/monolith-client-auth-template-jdl/monolith-client-auth-template-jdl.jdl
@@ -43,7 +43,7 @@ TEACHER
 
 entity DemetraUser {
 	gender Gender required,
-	address String required,
+	address String minlength(1) maxlength(100) required,
 	borndate LocalDate required,
 	cf String required unique,
 	usertype UserType required,
@@ -52,7 +52,7 @@ entity DemetraUser {
 
 entity SingleCourse {
 	title String required unique,
-	description String,
+	description String pattern(/^[A-Z]$/),
 	isnotonlyfordegree Boolean required,
 	cfu Integer,
 	courseimage Blob,
@@ -64,7 +64,6 @@ entity Activity {
 	description String,
 	mynumber Double,
 	creationtime ZonedDateTime
-
 }
 
 relationship OneToOne {
diff --git a/test/entity.spec.js b/test/entity.spec.js
@@ -97,18 +97,36 @@ describe('Subgenerator entity of nodejs JHipster blueprint', () => {
             assert.fileContent(greatEntityPath, "@Column({ name: 'name', nullable: true, unique: true })");
             assert.fileContent(greatEntityPath, 'name: string;');
 
+            // name UUID with validation and swagger annotation
+            assert.fileContent(greatEntityDTOPath, 'name: string;');
+            assert.fileContent(greatEntityDTOPath, '@MinLength(5)');
+            assert.fileContent(greatEntityDTOPath, "@ApiModelProperty({ description: 'name field', required: false })");
+
             // Gender enum field with swagger annotation
             assert.fileContent(greatEntityPath, "@Column({ type: 'simple-enum', name: 'gender', enum: Gender })");
             assert.fileContent(greatEntityPath, 'gender: Gender;');
             assert.fileContent(greatEntityDTOPath, 'gender: Gender;');
             assert.fileContent(greatEntityDTOPath, "@ApiModelProperty({ enum: Gender, description: 'gender enum field' })");
 
-            // address String required field with swagger annotation
-            assert.fileContent(greatEntityPath, "@Column({ name: 'address' })");
+            // address string required field
+            assert.fileContent(greatEntityPath, "@Column({ name: 'address', length: 100 })");
             assert.fileContent(greatEntityPath, 'address: string;');
+
+            // address string with validation and swagger annotation
             assert.fileContent(greatEntityDTOPath, 'address: string;');
+            assert.fileContent(greatEntityDTOPath, '@IsNotEmpty()');
+            assert.fileContent(greatEntityDTOPath, '@Length(1, 100)');
             assert.fileContent(greatEntityDTOPath, "@ApiModelProperty({ description: 'address field' })");
 
+            // description string field
+            assert.fileContent(greatEntityPath, "@Column({ name: 'description', nullable: true })");
+            assert.fileContent(greatEntityPath, 'description: string;');
+
+            // description string with validation and swagger annotation
+            assert.fileContent(greatEntityDTOPath, 'description: string;');
+            assert.fileContent(greatEntityDTOPath, "@Matches('^[A-Z]$')");
+            assert.fileContent(greatEntityDTOPath, "@ApiModelProperty({ description: 'description field', required: false })");
+
             // istrue Boolean field with swagger annotation
             assert.fileContent(greatEntityPath, "@Column({ type: 'boolean', name: 'istrue', nullable: true })");
             assert.fileContent(greatEntityPath, 'istrue: boolean;');
@@ -119,6 +137,8 @@ describe('Subgenerator entity of nodejs JHipster blueprint', () => {
             assert.fileContent(greatEntityPath, "@Column({ type: 'date', name: 'borndate' })");
             assert.fileContent(greatEntityPath, 'borndate: any;');
 
+            assert.fileContent(greatEntityDTOPath, "@ApiModelProperty({ description: 'borndate field' })");
+
             // profileimage Blob field
             assert.fileContent(greatEntityPath, "@Column({ type: 'blob', name: 'profileimage', nullable: true })");
             assert.fileContent(greatEntityPath, 'profileimage: any;');
@@ -147,6 +167,12 @@ describe('Subgenerator entity of nodejs JHipster blueprint', () => {
             assert.fileContent(greatEntityPath, "@Column({ type: 'double', name: 'mynumber', nullable: true })");
             assert.fileContent(greatEntityPath, 'mynumber: number;');
 
+            // mynumber with validation and swagger annotation
+            assert.fileContent(greatEntityDTOPath, 'mynumber: number;');
+            assert.fileContent(greatEntityDTOPath, '@Min(1)');
+            assert.fileContent(greatEntityDTOPath, '@Max(100)');
+            assert.fileContent(greatEntityDTOPath, "@ApiModelProperty({ description: 'mynumber field', required: false })");
+
             // count Long field
             assert.fileContent(greatEntityPath, "@Column({ type: 'long', name: 'count', nullable: true })");
             assert.fileContent(greatEntityPath, 'count: number;');
diff --git a/test/templates/.jhipster/GreatEntity.json b/test/templates/.jhipster/GreatEntity.json
@@ -5,8 +5,18 @@
             "fieldName": "name",
             "fieldType": "UUID",
             "fieldValidateRules": [
-                "unique"
-            ]
+                "unique",
+                "minlength"
+            ],
+            "fieldValidateRulesMinlength": "5"
+        },
+        {
+            "fieldName": "description",
+            "fieldType": "String",
+            "fieldValidateRules": [
+                "pattern"
+            ],
+            "fieldValidateRulesPattern": "^[A-Z]$"
         },
         {
             "fieldName": "gender",
@@ -20,8 +30,12 @@
             "fieldName": "address",
             "fieldType": "String",
             "fieldValidateRules": [
+                "minlength",
+                "maxlength",
                 "required"
-            ]
+            ],
+            "fieldValidateRulesMinlength": "1",
+            "fieldValidateRulesMaxlength": "100"
         },
         {
             "fieldName": "istrue",
@@ -64,7 +78,13 @@
         },
         {
             "fieldName": "mynumber",
-            "fieldType": "Double"
+            "fieldType": "Double",
+            "fieldValidateRules": [
+                "min",
+                "max"
+            ],
+            "fieldValidateRulesMin": "1",
+            "fieldValidateRulesMax": "100"
         },
         {
             "fieldName": "count",
@@ -92,4 +112,4 @@
     "jpaMetamodelFiltering": false,
     "fluentMethods": true,
     "readOnly": false
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ entity BloodPressure {`
`35`	`35`	`}`
`36`	`36`	`entity Weight {`
`37`	`37`	`timestamp ZonedDateTime required`
`38`		`- weight Double`
	`38`	`+ weight Double`
`39`	`39`	`}`
`40`	`40`	`entity Points {`
`41`	`41`	`date LocalDate required`
`@@ -45,7 +45,7 @@ entity Points {`
`45`	`45`	`notes String maxlength(140)`
`46`	`46`	`}`
`47`	`47`	`entity Preferences {`
`48`		`- weeklyGoal Integer required max(21)`
	`48`	`+ weeklyGoal Integer`
`49`	`49`	`weightUnits Units required`
`50`	`50`	`}`
`51`	`51`