Issue #627 custom message for format (#632)

vickyrathod · web-flow · commit 2822c6965bd8 · 2023-01-10T14:56:53.000-05:00
* Issue #627 custom message for format * issue 627 updated document for custom message
diff --git a/doc/cust-msg.md b/doc/cust-msg.md
@@ -1,10 +1,11 @@
-This document explains how users can create their custom message for schema validation.
+# Custom Message Support
+Users can add their own custom messages for schema validation using the instructions in this page.
 
+The json schema itself has a place for the customised message.
 
-We can provide the custom message in the json schema itself.
-
-<b> Example of schema with default message: </b>
-
+## Examples
+### Example 1 :
+The custom message can be provided outside properties for each type, as shown in the schema below.
 ````json
 {
   "type": "object",
@@ -17,46 +18,48 @@ We can provide the custom message in the json schema itself.
       "type": "array",
       "maxItems": 3
     }
+  },
+  "message": {
+    "maxItems" : "MaxItem must be 3 only",
+    "type" : "Invalid type"
   }
 }
 ````
-
-
-<b> Example of schema with a custom message: </b>
-
+### Example 2 :
+To keep custom messages distinct for each type, one can even give them in each property.
 ````json
 {
   "type": "object",
   "properties": {
-    "firstName": {
+    "dateTime": {
       "type": "string",
-      "description": "The person's first name."
+      "format": "date",
+      "message": {
+        "format": "Keep date format yyyy-mm-dd"
+      }
     },
-    "foo": {
-      "type": "array",
-      "maxItems": 3
+    "uuid": {
+      "type": "string",
+      "format": "uuid",
+      "message": {
+        "format": "Input should be uuid"
+      }
     }
-  },
-  "message": {
-    "maxItems" : "MaxItem must be 3 only",
-    "type" : "Invalid type"
   }
 }
 ````
 
-
-
+## Format
 ````json
 "message": {
     [validationType] : [customMessage]
   }
 ````
+Users can express custom message in the **'message'** field. 
+The **'validation type'** should be the key and the **'custom message'** should be the value.
 
-In the message field users can declare their custom message. The key should be the <b>validation type</b>, and the value should be the <b>custom message</b>.
-
-
-Also, we can make format the dynamic message with properties returned from [ValidationMessage.java](https://github.com/networknt/json-schema-validator/blob/master/src/main/java/com/networknt/schema/ValidationMessage.java) class such as <b>arguments, path e.t.c.</b>
+Also, we can make format the dynamic message with properties returned from [ValidationMessage.java](https://github.com/networknt/json-schema-validator/blob/master/src/main/java/com/networknt/schema/ValidationMessage.java) class such as **arguments, path e.t.c.**
 
 
 
-Take a look at the [PR](https://github.com/networknt/json-schema-validator/pull/438)
+Take a look at the [PR1](https://github.com/networknt/json-schema-validator/pull/438) and [PR2](https://github.com/networknt/json-schema-validator/pull/632)
diff --git a/src/main/java/com/networknt/schema/DateTimeValidator.java b/src/main/java/com/networknt/schema/DateTimeValidator.java
@@ -34,8 +34,8 @@ public class DateTimeValidator extends BaseJsonValidator implements JsonValidato
     private final String DATE = "date";
     private final String DATETIME = "date-time";
 
-    public DateTimeValidator(String schemaPath, JsonNode schemaNode, JsonSchema parentSchema, ValidationContext validationContext, String formatName) {
-        super(schemaPath, schemaNode, parentSchema, ValidatorTypeCode.DATETIME, validationContext);
+    public DateTimeValidator(String schemaPath, JsonNode schemaNode, JsonSchema parentSchema, ValidationContext validationContext, String formatName, ValidatorTypeCode type) {
+        super(schemaPath, schemaNode, parentSchema, type, validationContext);
         this.formatName = formatName;
         this.validationContext = validationContext;
         parseErrorCode(getValidatorType().getErrorCodeKey());
diff --git a/src/main/java/com/networknt/schema/FormatKeyword.java b/src/main/java/com/networknt/schema/FormatKeyword.java
@@ -52,21 +52,27 @@ public JsonValidator newValidator(String schemaPath, JsonNode schemaNode, JsonSc
             format = formats.get(formatName);
             // if you set custom format, override default Email/DateTime/UUID Validator
             if (format != null) {
-                return new FormatValidator(schemaPath, schemaNode, parentSchema, validationContext, format);
+                return new FormatValidator(schemaPath, schemaNode, parentSchema, validationContext, format, type);
             }
             // Validate date and time separately
             if (formatName.equals(DATE) || formatName.equals(DATE_TIME)) {
-                return new DateTimeValidator(schemaPath, schemaNode, parentSchema, validationContext, formatName);
+                ValidatorTypeCode typeCode = ValidatorTypeCode.DATETIME;
+                // Set custom error message
+                typeCode.setCustomMessage(type.getCustomMessage());
+                return new DateTimeValidator(schemaPath, schemaNode, parentSchema, validationContext, formatName, typeCode);
             } else if (formatName.equals(UUID)) {
-                return new UUIDValidator(schemaPath, schemaNode, parentSchema, validationContext, formatName);
+                ValidatorTypeCode typeCode = ValidatorTypeCode.UUID;
+                // Set custom error message
+                typeCode.setCustomMessage(type.getCustomMessage());
+                return new UUIDValidator(schemaPath, schemaNode, parentSchema, validationContext, formatName, typeCode);
             } else if (formatName.equals(EMAIL)) {
-                return new EmailValidator(schemaPath, schemaNode, parentSchema, validationContext, formatName);
+                return new EmailValidator(schemaPath, schemaNode, parentSchema, validationContext, formatName, type);
             }
             else if (formatName.equals(DURATION)) {
-                return new DurationValidator(schemaPath, schemaNode, parentSchema, validationContext, formatName);
+                return new DurationValidator(schemaPath, schemaNode, parentSchema, validationContext, formatName, type);
             }
         }
-        return new FormatValidator(schemaPath, schemaNode, parentSchema, validationContext, format);
+        return new FormatValidator(schemaPath, schemaNode, parentSchema, validationContext, format, type);
     }
 
     @Override
@@ -78,6 +84,4 @@ public String getValue() {
     public void setCustomMessage(String message) {
         type.setCustomMessage(message);
     }
-
-
 }
diff --git a/src/main/java/com/networknt/schema/FormatValidator.java b/src/main/java/com/networknt/schema/FormatValidator.java
@@ -30,8 +30,8 @@ public class FormatValidator extends BaseJsonValidator implements JsonValidator
 
     private final Format format;
 
-    public FormatValidator(String schemaPath, JsonNode schemaNode, JsonSchema parentSchema, ValidationContext validationContext, Format format) {
-        super(schemaPath, schemaNode, parentSchema, ValidatorTypeCode.FORMAT, validationContext);
+    public FormatValidator(String schemaPath, JsonNode schemaNode, JsonSchema parentSchema, ValidationContext validationContext, Format format, ValidatorTypeCode type) {
+        super(schemaPath, schemaNode, parentSchema, type, validationContext);
         this.format = format;
         this.validationContext = validationContext;
         parseErrorCode(getValidatorType().getErrorCodeKey());
diff --git a/src/main/java/com/networknt/schema/UUIDValidator.java b/src/main/java/com/networknt/schema/UUIDValidator.java
@@ -32,8 +32,8 @@ public class UUIDValidator extends BaseJsonValidator implements JsonValidator {
 
     private static final String regex = "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$";
 
-    public UUIDValidator(String schemaPath, JsonNode schemaNode, JsonSchema parentSchema, ValidationContext validationContext, String formatName) {
-        super(schemaPath, schemaNode, parentSchema, ValidatorTypeCode.UUID, validationContext);
+    public UUIDValidator(String schemaPath, JsonNode schemaNode, JsonSchema parentSchema, ValidationContext validationContext, String formatName, ValidatorTypeCode type) {
+        super(schemaPath, schemaNode, parentSchema, type, validationContext);
         this.formatName = formatName;
         parseErrorCode(getValidatorType().getErrorCodeKey());
         this.validationContext = validationContext;
diff --git a/src/main/java/com/networknt/schema/format/DurationValidator.java b/src/main/java/com/networknt/schema/format/DurationValidator.java
@@ -63,8 +63,8 @@ public boolean isValid(String duration) {
         return true;
     }
 
-    public DurationValidator(String schemaPath, JsonNode schemaNode, JsonSchema parentSchema, ValidationContext validationContext, String formatName) {
-        super(schemaPath, schemaNode, parentSchema, ValidatorTypeCode.FORMAT, validationContext);
+    public DurationValidator(String schemaPath, JsonNode schemaNode, JsonSchema parentSchema, ValidationContext validationContext, String formatName, ValidatorTypeCode type) {
+        super(schemaPath, schemaNode, parentSchema, type, validationContext);
         this.formatName = formatName;
         this.validationContext = validationContext;
         parseErrorCode(getValidatorType().getErrorCodeKey());
diff --git a/src/main/java/com/networknt/schema/format/EmailValidator.java b/src/main/java/com/networknt/schema/format/EmailValidator.java
@@ -137,8 +137,8 @@ protected boolean isValidUser(String user) {
         return USER_PATTERN.matcher(user).matches();
     }
 
-    public EmailValidator(String schemaPath, JsonNode schemaNode, JsonSchema parentSchema, ValidationContext validationContext, String formatName) {
-        super(schemaPath, schemaNode, parentSchema, ValidatorTypeCode.FORMAT, validationContext);
+    public EmailValidator(String schemaPath, JsonNode schemaNode, JsonSchema parentSchema, ValidationContext validationContext, String formatName,  ValidatorTypeCode type) {
+        super(schemaPath, schemaNode, parentSchema, type, validationContext);
         this.formatName = formatName;
         this.validationContext = validationContext;
         parseErrorCode(getValidatorType().getErrorCodeKey());
diff --git a/src/test/java/com/networknt/schema/Issue627Test.java b/src/test/java/com/networknt/schema/Issue627Test.java
@@ -0,0 +1,2 @@
+package com.networknt.schema;public class Issue627Test {
+}
diff --git a/src/test/resources/data/issue627.json b/src/test/resources/data/issue627.json
@@ -0,0 +1,5 @@
+{
+  "dateTime": "2022-07-33",
+  "email": "inValidEmail",
+  "uuid": "inValidUUID"
+}
diff --git a/src/test/resources/schema/issue627-v7.json b/src/test/resources/schema/issue627-v7.json
@@ -0,0 +1,20 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "dateTime": {
+      "type": "string",
+      "format": "date",
+      "message": {
+        "format": "Keep date format yyyy-mm-dd"
+      }
+    },
+    "uuid": {
+      "type": "string",
+      "format": "uuid",
+      "message": {
+        "format": "Input should be uuid"
+      }
+    }
+  }
+}

Original file line number	Diff line number	Diff line change
`@@ -52,21 +52,27 @@ public JsonValidator newValidator(String schemaPath, JsonNode schemaNode, JsonSc`
`52`	`52`	`format = formats.get(formatName);`
`53`	`53`	`// if you set custom format, override default Email/DateTime/UUID Validator`
`54`	`54`	`if (format != null) {`
`55`		`- return new FormatValidator(schemaPath, schemaNode, parentSchema, validationContext, format);`
	`55`	`+ return new FormatValidator(schemaPath, schemaNode, parentSchema, validationContext, format, type);`
`56`	`56`	`}`
`57`	`57`	`// Validate date and time separately`
`58`	`58`	`if (formatName.equals(DATE) \|\| formatName.equals(DATE_TIME)) {`
`59`		`- return new DateTimeValidator(schemaPath, schemaNode, parentSchema, validationContext, formatName);`
	`59`	`+ ValidatorTypeCode typeCode = ValidatorTypeCode.DATETIME;`
	`60`	`+ // Set custom error message`
	`61`	`+ typeCode.setCustomMessage(type.getCustomMessage());`
	`62`	`+ return new DateTimeValidator(schemaPath, schemaNode, parentSchema, validationContext, formatName, typeCode);`
`60`	`63`	`} else if (formatName.equals(UUID)) {`
`61`		`- return new UUIDValidator(schemaPath, schemaNode, parentSchema, validationContext, formatName);`
	`64`	`+ ValidatorTypeCode typeCode = ValidatorTypeCode.UUID;`
	`65`	`+ // Set custom error message`
	`66`	`+ typeCode.setCustomMessage(type.getCustomMessage());`
	`67`	`+ return new UUIDValidator(schemaPath, schemaNode, parentSchema, validationContext, formatName, typeCode);`
`62`	`68`	`} else if (formatName.equals(EMAIL)) {`
`63`		`- return new EmailValidator(schemaPath, schemaNode, parentSchema, validationContext, formatName);`
	`69`	`+ return new EmailValidator(schemaPath, schemaNode, parentSchema, validationContext, formatName, type);`
`64`	`70`	`}`
`65`	`71`	`else if (formatName.equals(DURATION)) {`
`66`		`- return new DurationValidator(schemaPath, schemaNode, parentSchema, validationContext, formatName);`
	`72`	`+ return new DurationValidator(schemaPath, schemaNode, parentSchema, validationContext, formatName, type);`
`67`	`73`	`}`
`68`	`74`	`}`
`69`		`- return new FormatValidator(schemaPath, schemaNode, parentSchema, validationContext, format);`
	`75`	`+ return new FormatValidator(schemaPath, schemaNode, parentSchema, validationContext, format, type);`
`70`	`76`	`}`
`71`	`77`
`72`	`78`	`@Override`
`@@ -78,6 +84,4 @@ public String getValue() {`
`78`	`84`	`public void setCustomMessage(String message) {`
`79`	`85`	`type.setCustomMessage(message);`
`80`	`86`	`}`
`81`		`-`
`82`		`-`
`83`	`87`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+package com.networknt.schema;public class Issue627Test {`
	`2`	`+}`