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

RESTWS-956 - Erroneous response when totalCount is included in query … #625

Merged
merged 2 commits into from
Sep 20, 2024

Conversation

alaboso
Copy link
Contributor

@alaboso alaboso commented Sep 19, 2024

Description of what I changed

I added totalCount as an optional parameter in EncounterSearchHandler2_0 to fix the error in link

Issue I worked on

https://openmrs.atlassian.net/browse/RESTWS-956

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

@@ -48,8 +48,8 @@ public class EncounterSearchHandler2_0 implements SearchHandler {
Collections.singletonList("2.0.* - 9.*"),
Collections.singletonList(new SearchQuery.Builder(
"Allows you to find Encounter by patient and encounterType (and optionally by from and to date range)")
.withRequiredParameters("patient").withOptionalParameters("visit", "encounterType", DATE_FROM, DATE_TO, "order")
.build()));
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 add a test for this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure, on 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 have added EncounterSearchHandler2_0Test

…on filters (patient, encounterType) and limit (size of results limited is not necessarily same as totalCount)
* @throws Exception
*/
@Test
public void search_shouldReturnEncountersWithTotalCountFilteredByPatient() throws Exception {
Copy link
Member

Choose a reason for hiding this comment

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

Did you notice that this test passes even without your fix?

* @throws Exception
*/
@Test
public void search_shouldReturnEncountersWithTotalCountFilteredByPatientLimitedToOne() throws Exception {
Copy link
Member

Choose a reason for hiding this comment

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

Did you notice that this test passes even without your fix?

@alaboso
Copy link
Contributor Author

alaboso commented Sep 20, 2024

@dkayiwa - I take note of your comments. The real test is this -> search_shouldReturnEncountersWithTotalCountFilteredByPatientAndEncounterType which checks that given and encounterType and totalCount, the results should be filtered.

I could remove search_shouldReturnEncountersWithTotalCountFilteredByPatient though it clearly distinguishes the filtering...

In my opinion, search_shouldReturnEncountersWithTotalCountFilteredByPatientLimitedToOne should remain to clearly distinguish that the size of results returned is not necessarily the same as totalCount OR, add limit to search_shouldReturnEncountersWithTotalCountFilteredByPatientAndEncounterType after the current existing Assertions

@dkayiwa dkayiwa merged commit eb0b5d7 into openmrs:master Sep 20, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants