Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TRUNK-1992: patientServiceImpl.getIdentifierValidator(String pivClassName) shouldn't return default Luhn validator #4537

Merged
merged 1 commit into from
Feb 10, 2024

Conversation

ManojLL
Copy link
Contributor

@ManojLL ManojLL commented Jan 21, 2024

Description of what I changed

Refactor PatientServiceImpl.getIdentifierValidator(String pivClassName) to throw an exception when the identifier class is not found, instead of returning the default lunch validator.

Issue I worked on

see https://issues.openmrs.org/browse/TRUNK-1992

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

@Test
public void getIdentifierValidator_shouldThrowPatientIdentifierExceptionWhenClassNotFound() throws Exception {
String invalidClassName = "com.example.InvalidIdentifierValidator";
String expectedErrorMessage = "Could not find patient identifier validator com.example.InvalidIdentifierValidator";
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because these are used only once, do we even need variables for them?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dkayiwa I remove these variables.

@@ -1319,7 +1319,7 @@ public IdentifierValidator getIdentifierValidator(String pivClassName) {
}
catch (ClassNotFoundException e) {
log.error("Could not find patient identifier validator " + pivClassName, e);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we really log this exception if we are throwing it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I remove the log this exception.

@@ -1318,8 +1318,7 @@ public IdentifierValidator getIdentifierValidator(String pivClassName) {
return getIdentifierValidator((Class<IdentifierValidator>) Context.loadClass(pivClassName));
}
catch (ClassNotFoundException e) {
log.error("Could not find patient identifier validator " + pivClassName, e);
return getDefaultIdentifierValidator();
throw new PatientIdentifierException("Could not find patient identifier validator " + pivClassName);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we also pass the original exception in the constructor?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

passed the original exception to the constructor.

…eImpl.getIdentifierValidator(String pivClassName)

TRUNK-1992: Remove returning default lunch validator in PatientServiceImpl getIdentifierValidator(String pivClassName)

TRUNK-1992: Remove returning default lunch validator in PatientServiceImpl getIdentifierValidator(String pivClassName)
@@ -3294,4 +3294,10 @@ public void getPatientIdentifiersByPatientProgram_shouldGetPatientsByIdentifierB
assertEquals(patientIdentifier.iterator().next().getIdentifier(), "XXXCCCAAA11");
}

@Test
public void getIdentifierValidator_shouldThrowPatientIdentifierExceptionWhenClassNotFound() throws Exception {
PatientIdentifierException patientIdentifierException = assertThrows(PatientIdentifierException.class, () -> patientService.getIdentifierValidator("com.example.InvalidIdentifierValidator"));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you also add a test for should not throw exception when class is found?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dkayiwa It seems in the patientService, this test has already added , So it checks whether the getIdentifierValidator method returns the expected IdentifierValidator class when found.

@dkayiwa dkayiwa merged commit ecb570f into openmrs:master Feb 10, 2024
6 checks passed
Wandji69 pushed a commit to Wandji69/openmrs-core that referenced this pull request Mar 29, 2024
…eImpl.getIdentifierValidator(String pivClassName) (openmrs#4537)

TRUNK-1992: Remove returning default lunch validator in PatientServiceImpl getIdentifierValidator(String pivClassName)

TRUNK-1992: Remove returning default lunch validator in PatientServiceImpl getIdentifierValidator(String pivClassName)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants