TRUNK-6030 : The allergy field in the Allergy UI should validate the input string #4534

subhamkumarr · 2024-01-17T11:09:24Z

The allergy field in the Allergy UI allows the user to enter a numeric value, considering allergies cannot have numeric name, we must validate the input string before allowing the user to procced further

Description of what I changed

This pull request enhances the AllergyValidator in the Allergy UI to provide improved validation for the allergen field. Previously, the allergen field allowed users to enter numeric values, which is not a valid scenario for allergy names.

Changes Made:

Updated the AllergyValidator class to include validation for numeric values in the allergen field.
If the allergen field contains numeric values, a custom error is triggered to inform the user about the restriction on using
numeric values for allergy names.

How to Test:
- Enter a valid non-numeric allergen name. The validation should pass.
- Attempt to enter an allergen name containing numeric values. The validation should reject the input and display an appropriate error message.

Issue I worked on

https://openmrs.atlassian.net/issues/TRUNK-6030

Checklist: I completed these to help reviewers :)

My IDE is configured to follow the code style of this project.

No? Unsure? -> configure your IDE, format the code and add the changes with git add . && git commit --amend
I have added tests to cover my changes. (If you refactored
existing code that was well tested you do not have to add tests)

No? -> write tests and add them to this commit git add . && git commit --amend
I ran mvn clean package right before creating this pull request and
added all formatting changes to my commit.

No? -> execute above command
All new and existing tests passed.

No? -> figure out why and add the fix to your commit. It is your responsibility to make sure your code works.
My pull request is based on the latest changes of the master branch.

No? Unsure? -> execute command git pull --rebase upstream master

The allergy field in the Allergy UI allows the user to enter a numeric value, considering allergies cannot have numeric name, we must validate the input string before allowing the user to procced further

ManojLL · 2024-01-17T11:37:04Z

api/src/main/java/org/openmrs/validator/AllergyValidator.java

+			if (allergy.getAllergen() != null && StringUtils.isNumeric(allergy.getAllergen().getNonCodedAllergen())) {
+				errors.rejectValue("allergen", "error.allergyapi.allergy.Allergen.cannotContainNumeric");
+			}


It is better to move the if block inside the else block at line 79.

@ManojLL done.

moved `if` inside the `else` block

ManojLL · 2024-01-17T12:04:58Z

api/src/main/java/org/openmrs/validator/AllergyValidator.java

@@ -82,6 +82,11 @@ public void validate(Object target, Errors errors) {
 			} else if (!allergen.isCoded() && StringUtils.isBlank(allergen.getNonCodedAllergen())) {
 				errors.rejectValue("allergen", "allergyapi.allergen.nonCodedAllergen.required");
 			}
+
+			    // Additional validation: Ensure allergen does not contain numeric values


remove the comment

ManojLL · 2024-01-17T12:07:45Z

api/src/main/java/org/openmrs/validator/AllergyValidator.java

@@ -82,6 +82,11 @@ public void validate(Object target, Errors errors) {
 			} else if (!allergen.isCoded() && StringUtils.isBlank(allergen.getNonCodedAllergen())) {
 				errors.rejectValue("allergen", "allergyapi.allergen.nonCodedAllergen.required");
 			}
+
+			    // Additional validation: Ensure allergen does not contain numeric values
+				if (allergy.getAllergen() != null && StringUtils.isNumeric(allergy.getAllergen().getNonCodedAllergen())) {


Remove the condition allergy.getAllergen() != null && as it has already been checked

@ManojLL Done

@subhamkumarr When committing, include a meaningful commit message that references the relevant JIRA ticket ID,
ex:- TRUNK-6030 : validate the input string

Removed `allergy.getAllergen() != null &&` as it has already been checked

Comment removed

ManojLL · 2024-01-17T13:39:29Z

api/src/main/java/org/openmrs/validator/AllergyValidator.java

+				if (StringUtils.isNumeric(allergy.getAllergen().getNonCodedAllergen())) {
+					errors.rejectValue("allergen", "error.allergyapi.allergy.Allergen.cannotContainNumeric");
+				}


Remove the extra tab space and configure your IDE using this Also, replace allergy.getAllergen() with allergen.

ManojLL · 2024-01-17T13:47:53Z

api/src/test/java/org/openmrs/validator/AllergyValidatorTest.java

@@ -191,4 +191,12 @@ public void validate_shouldRejectNumericReactionValue() {
 		validator.validate(allergy, errors);
 		assertTrue(errors.hasErrors());
 	}
+	@Test


Insert a space between the method

@subhamkumarr Did you see this comment?

TRUNK-6030: validate the input string

subhamkumarr · 2024-01-17T14:22:13Z

@dkayiwa @ibacher Sir, Could you please review this PR.

ibacher · 2024-01-17T17:12:38Z

api/src/main/java/org/openmrs/validator/AllergyValidator.java

@@ -82,6 +82,10 @@ public void validate(Object target, Errors errors) {
 			} else if (!allergen.isCoded() && StringUtils.isBlank(allergen.getNonCodedAllergen())) {
 				errors.rejectValue("allergen", "allergyapi.allergen.nonCodedAllergen.required");
 			}
+
+			if (StringUtils.isNumeric(allergen.getNonCodedAllergen())) {
+				errors.rejectValue("allergen", "error.allergyapi.allergy.Allergen.cannotContainNumeric");


Notice, as above, this should probably not have the error prefix.

ibacher · 2024-01-17T17:13:02Z

api/src/test/java/org/openmrs/validator/AllergyValidatorTest.java

+		allergy.setAllergen(allergen);
+		Errors errors = new BindException(allergy,"allergy");
+		validator.validate(allergy, errors);
+		assertTrue(errors.hasErrors());


This should actually validate the error message.

@ibacher Sir, please check I made the changes.

@ibacher could you please review my PR.

TRUNK-6030 : validate the input string

TRUNK-6030: validate the input string

TRUNK-6030 : validate the input string

ibacher · 2024-01-19T20:28:54Z

api/src/test/java/org/openmrs/validator/AllergyValidatorTest.java

@@ -191,4 +191,12 @@ public void validate_shouldRejectNumericReactionValue() {
 		validator.validate(allergy, errors);
 		assertTrue(errors.hasErrors());
 	}
+	@Test


@subhamkumarr Did you see this comment?

ibacher · 2024-01-19T20:29:29Z

api/src/test/java/org/openmrs/validator/AllergyValidatorTest.java

+		validator.validate(allergy, errors);
+		assertTrue(errors.hasErrors());
+		assertTrue(errors.getAllErrors().stream()
+        .anyMatch(error -> "allergyapi.allergy.Allergen.cannotContainNumeric".equals(error.getCode())));	}


Indent here should be with tabs.

Also, the curly brace belongs on a new line. Please ensure you're following the Java Conventions and see this to setup your IDE (basically, whatever mechanism will take an Eclipse formatting configuration).

TRUNK-6030

29c680c

The allergy field in the Allergy UI allows the user to enter a numeric value, considering allergies cannot have numeric name, we must validate the input string before allowing the user to procced further

ManojLL reviewed Jan 17, 2024

View reviewed changes

TRUNK-6030

c6877ea

moved `if` inside the `else` block

subhamkumarr requested a review from ManojLL January 17, 2024 11:58

ManojLL reviewed Jan 17, 2024

View reviewed changes

subhamkumarr added 2 commits January 17, 2024 17:40

TRUNK-6030

4ea96dc

Removed `allergy.getAllergen() != null &&` as it has already been checked

TRUNK-6030

e97ebe6

Comment removed

subhamkumarr requested a review from ManojLL January 17, 2024 12:15

ManojLL reviewed Jan 17, 2024

View reviewed changes

Update AllergyValidator.java

22c9a46

TRUNK-6030: validate the input string

subhamkumarr requested a review from ManojLL January 17, 2024 14:07

ibacher requested changes Jan 17, 2024

View reviewed changes

Update AllergyValidatorTest.java

19764d3

TRUNK-6030 : validate the input string

subhamkumarr requested a review from ibacher January 17, 2024 18:45

subhamkumarr added 3 commits January 18, 2024 00:20

Update AllergyValidatorTest.java

e4b5326

TRUNK-6030 : validate the input string

TRUNK-6030

78742af

TRUNK-6030: validate the input string

Update AllergyValidator.java

339f7eb

TRUNK-6030 : validate the input string

ibacher reviewed Jan 19, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

TRUNK-6030 : The allergy field in the Allergy UI should validate the input string #4534

TRUNK-6030 : The allergy field in the Allergy UI should validate the input string #4534

subhamkumarr commented Jan 17, 2024 •

edited by ibacher

ManojLL Jan 17, 2024

subhamkumarr Jan 17, 2024 •

edited

ManojLL Jan 17, 2024

ManojLL Jan 17, 2024

subhamkumarr Jan 17, 2024 •

edited

ManojLL Jan 17, 2024

ManojLL Jan 17, 2024

ManojLL Jan 17, 2024

ibacher Jan 19, 2024

subhamkumarr commented Jan 17, 2024 •

edited

ibacher Jan 17, 2024

ibacher Jan 17, 2024

subhamkumarr Jan 17, 2024

subhamkumarr Jan 19, 2024

ibacher Jan 19, 2024

ibacher Jan 19, 2024

ibacher Jan 19, 2024

TRUNK-6030 : The allergy field in the Allergy UI should validate the input string #4534

Are you sure you want to change the base?

TRUNK-6030 : The allergy field in the Allergy UI should validate the input string #4534

Conversation

subhamkumarr commented Jan 17, 2024 • edited by ibacher

Description of what I changed

Changes Made:

How to Test:

Issue I worked on

Checklist: I completed these to help reviewers :)

Choose a reason for hiding this comment

subhamkumarr Jan 17, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

subhamkumarr Jan 17, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

subhamkumarr commented Jan 17, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

subhamkumarr commented Jan 17, 2024 •

edited by ibacher

subhamkumarr Jan 17, 2024 •

edited

subhamkumarr Jan 17, 2024 •

edited

subhamkumarr commented Jan 17, 2024 •

edited