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

(feat) Add configurability to Recently Searched Patients feature #959

Merged
merged 2 commits into from
Feb 5, 2024

Conversation

denniskigen
Copy link
Member

@denniskigen denniskigen commented Jan 30, 2024

Requirements

  • This PR has a title that briefly describes the work done including the ticket number. If there is a ticket, make sure your PR title includes a conventional commit label. See existing PR titles for inspiration.
  • My work conforms to the OpenMRS 3.0 Styleguide and design documentation.
  • My work includes tests or is validated by existing tests.

Summary

This PR makes the Recently Searched Patients feature configurable by toggling it on only when the showRecentlySearchedPatients config property is truthy (it defaults to false). This is a precursor to future work aimed at improving the performance of the feature.

Presently, looking up 10 recently searched patient records by default when the search box is launched is not ideal from a performance perspective. Making this behaviour configurable means users get the default, performant search experience out of the box, and then implementers can choose to opt into the Recently Searched Patients functionality.

I've also removed use of the lodash debounce function, leveraging the useDebounce hook instead for debounce functionality to the CompactPatientSearchComponent component. I've also updated the openmrs and @openmrs/esm-framework libraries to enable us to leverage some improvements to the configuration system.

Here's a sample config schema that enables the feature:

{
  "@openmrs/esm-patient-search-app": {
    "search": {
      "showRecentlySearchedPatients": true
    }
  }
}

Screenshots

configurable-recent-patient-search.mp4

Related Issue

None

Other

None

@denniskigen denniskigen force-pushed the feat/configurable-recent-search branch from b6b4d5a to 3c456ab Compare January 30, 2024 22:34
Copy link
Contributor

github-actions bot commented Jan 30, 2024

Size Change: +83 kB (+3%)

Total Size: 2.89 MB

Filename Size Change
packages/esm-active-visits-app/dist/130.js 123 kB +13.8 kB (+13%) ⚠️
packages/esm-appointments-app/dist/130.js 123 kB +13.8 kB (+13%) ⚠️
packages/esm-patient-list-management-app/dist/130.js 123 kB +13.8 kB (+13%) ⚠️
packages/esm-patient-registration-app/dist/130.js 123 kB +13.8 kB (+13%) ⚠️
packages/esm-patient-search-app/dist/130.js 123 kB +13.8 kB (+13%) ⚠️
packages/esm-service-queues-app/dist/130.js 123 kB +13.8 kB (+13%) ⚠️
ℹ️ View Unchanged
Filename Size Change
packages/esm-active-visits-app/dist/255.js 2.21 kB 0 B
packages/esm-active-visits-app/dist/271.js 671 B 0 B
packages/esm-active-visits-app/dist/277.js 12.2 kB 0 B
packages/esm-active-visits-app/dist/316.js 42.9 kB 0 B
packages/esm-active-visits-app/dist/319.js 631 B 0 B
packages/esm-active-visits-app/dist/382.js 1.15 kB 0 B
packages/esm-active-visits-app/dist/448.js 47.1 kB 0 B
packages/esm-active-visits-app/dist/460.js 727 B 0 B
packages/esm-active-visits-app/dist/574.js 553 B 0 B
packages/esm-active-visits-app/dist/588.js 6.66 kB 0 B
packages/esm-active-visits-app/dist/635.js 1.15 kB 0 B
packages/esm-active-visits-app/dist/644.js 671 B 0 B
packages/esm-active-visits-app/dist/729.js 3.1 kB 0 B
packages/esm-active-visits-app/dist/757.js 649 B 0 B
packages/esm-active-visits-app/dist/784.js 2.63 kB 0 B
packages/esm-active-visits-app/dist/788.js 551 B 0 B
packages/esm-active-visits-app/dist/807.js 864 B 0 B
packages/esm-active-visits-app/dist/833.js 669 B 0 B
packages/esm-active-visits-app/dist/879.js 2.94 kB 0 B
packages/esm-active-visits-app/dist/main.js 63.8 kB -1 B (0%)
packages/esm-active-visits-app/dist/openmrs-esm-active-visits-app.js 3.33 kB -1 B (0%)
packages/esm-appointments-app/dist/152.js 257 B 0 B
packages/esm-appointments-app/dist/255.js 2.23 kB 0 B
packages/esm-appointments-app/dist/271.js 2.16 kB 0 B
packages/esm-appointments-app/dist/303.js 258 B 0 B
packages/esm-appointments-app/dist/319.js 1.99 kB 0 B
packages/esm-appointments-app/dist/460.js 2.18 kB 0 B
packages/esm-appointments-app/dist/574.js 1.74 kB 0 B
packages/esm-appointments-app/dist/588.js 6.65 kB 0 B
packages/esm-appointments-app/dist/591.js 16.9 kB 0 B
packages/esm-appointments-app/dist/595.js 242 kB 0 B
packages/esm-appointments-app/dist/636.js 47.9 kB 0 B
packages/esm-appointments-app/dist/644.js 2.16 kB 0 B
packages/esm-appointments-app/dist/729.js 3.1 kB 0 B
packages/esm-appointments-app/dist/757.js 1.75 kB 0 B
packages/esm-appointments-app/dist/784.js 2.63 kB 0 B
packages/esm-appointments-app/dist/788.js 1.75 kB 0 B
packages/esm-appointments-app/dist/80.js 2.52 kB 0 B
packages/esm-appointments-app/dist/807.js 2.4 kB 0 B
packages/esm-appointments-app/dist/833.js 1.99 kB 0 B
packages/esm-appointments-app/dist/main.js 294 kB -1 B (0%)
packages/esm-appointments-app/dist/openmrs-esm-appointments-app.js 3.29 kB -1 B (0%)
packages/esm-patient-list-management-app/dist/255.js 2.21 kB 0 B
packages/esm-patient-list-management-app/dist/271.js 1.33 kB 0 B
packages/esm-patient-list-management-app/dist/295.js 99.3 kB 0 B
packages/esm-patient-list-management-app/dist/319.js 1.53 kB 0 B
packages/esm-patient-list-management-app/dist/382.js 1.15 kB 0 B
packages/esm-patient-list-management-app/dist/435.js 22.7 kB 0 B
packages/esm-patient-list-management-app/dist/460.js 1.73 kB 0 B
packages/esm-patient-list-management-app/dist/574.js 1.34 kB 0 B
packages/esm-patient-list-management-app/dist/588.js 6.66 kB 0 B
packages/esm-patient-list-management-app/dist/591.js 16.9 kB 0 B
packages/esm-patient-list-management-app/dist/635.js 1.15 kB 0 B
packages/esm-patient-list-management-app/dist/644.js 1.31 kB 0 B
packages/esm-patient-list-management-app/dist/716.js 4.66 kB 0 B
packages/esm-patient-list-management-app/dist/729.js 3.1 kB 0 B
packages/esm-patient-list-management-app/dist/757.js 1.51 kB 0 B
packages/esm-patient-list-management-app/dist/784.js 2.64 kB 0 B
packages/esm-patient-list-management-app/dist/788.js 1.34 kB 0 B
packages/esm-patient-list-management-app/dist/807.js 1.84 kB 0 B
packages/esm-patient-list-management-app/dist/833.js 1.6 kB 0 B
packages/esm-patient-list-management-app/dist/main.js 126 kB -1 B (0%)
packages/esm-patient-list-management-app/dist/openmrs-esm-patient-list-management-app.js 3.3 kB -1 B (0%)
packages/esm-patient-registration-app/dist/152.js 262 B 0 B
packages/esm-patient-registration-app/dist/209.js 36.4 kB 0 B
packages/esm-patient-registration-app/dist/255.js 2.21 kB 0 B
packages/esm-patient-registration-app/dist/271.js 1.6 kB 0 B
packages/esm-patient-registration-app/dist/303.js 260 B 0 B
packages/esm-patient-registration-app/dist/319.js 1.97 kB 0 B
packages/esm-patient-registration-app/dist/460.js 2.03 kB 0 B
packages/esm-patient-registration-app/dist/537.js 2.34 kB 0 B
packages/esm-patient-registration-app/dist/574.js 1.7 kB 0 B
packages/esm-patient-registration-app/dist/591.js 16.9 kB 0 B
packages/esm-patient-registration-app/dist/62.js 6.86 kB 0 B
packages/esm-patient-registration-app/dist/644.js 1.6 kB 0 B
packages/esm-patient-registration-app/dist/729.js 3.1 kB 0 B
packages/esm-patient-registration-app/dist/730.js 115 kB 0 B
packages/esm-patient-registration-app/dist/735.js 464 B 0 B
packages/esm-patient-registration-app/dist/757.js 1.96 kB 0 B
packages/esm-patient-registration-app/dist/784.js 2.64 kB 0 B
packages/esm-patient-registration-app/dist/788.js 1.63 kB 0 B
packages/esm-patient-registration-app/dist/807.js 2.43 kB 0 B
packages/esm-patient-registration-app/dist/833.js 1.97 kB 0 B
packages/esm-patient-registration-app/dist/879.js 2.94 kB 0 B
packages/esm-patient-registration-app/dist/884.js 6.1 kB 0 B
packages/esm-patient-registration-app/dist/main.js 153 kB 0 B
packages/esm-patient-registration-app/dist/openmrs-esm-patient-registration-app.js 3.34 kB 0 B
packages/esm-patient-search-app/dist/152.js 261 B 0 B
packages/esm-patient-search-app/dist/255.js 2.21 kB 0 B
packages/esm-patient-search-app/dist/271.js 936 B 0 B
packages/esm-patient-search-app/dist/303.js 260 B 0 B
packages/esm-patient-search-app/dist/319.js 950 B 0 B
packages/esm-patient-search-app/dist/379.js 25.4 kB +49 B (0%)
packages/esm-patient-search-app/dist/382.js 1.15 kB 0 B
packages/esm-patient-search-app/dist/460.js 1.07 kB 0 B
packages/esm-patient-search-app/dist/574.js 794 B 0 B
packages/esm-patient-search-app/dist/588.js 6.66 kB 0 B
packages/esm-patient-search-app/dist/591.js 16.9 kB 0 B
packages/esm-patient-search-app/dist/635.js 1.15 kB 0 B
packages/esm-patient-search-app/dist/644.js 936 B 0 B
packages/esm-patient-search-app/dist/688.js 22.7 kB 0 B
packages/esm-patient-search-app/dist/729.js 3.1 kB 0 B
packages/esm-patient-search-app/dist/757.js 950 B 0 B
packages/esm-patient-search-app/dist/784.js 2.63 kB 0 B
packages/esm-patient-search-app/dist/788.js 788 B 0 B
packages/esm-patient-search-app/dist/807.js 1.13 kB 0 B
packages/esm-patient-search-app/dist/833.js 982 B 0 B
packages/esm-patient-search-app/dist/main.js 51.4 kB +27 B (0%)
packages/esm-patient-search-app/dist/openmrs-esm-patient-search-app.js 3.34 kB 0 B
packages/esm-service-queues-app/dist/152.js 262 B 0 B
packages/esm-service-queues-app/dist/255.js 2.23 kB 0 B
packages/esm-service-queues-app/dist/271.js 3.11 kB 0 B
packages/esm-service-queues-app/dist/293.js 155 kB 0 B
packages/esm-service-queues-app/dist/303.js 261 B 0 B
packages/esm-service-queues-app/dist/319.js 3.14 kB 0 B
packages/esm-service-queues-app/dist/328.js 3.07 kB 0 B
packages/esm-service-queues-app/dist/389.js 2.42 kB 0 B
packages/esm-service-queues-app/dist/425.js 2.06 kB 0 B
packages/esm-service-queues-app/dist/460.js 3.96 kB 0 B
packages/esm-service-queues-app/dist/574.js 3.13 kB 0 B
packages/esm-service-queues-app/dist/588.js 6.66 kB 0 B
packages/esm-service-queues-app/dist/591.js 16.9 kB 0 B
packages/esm-service-queues-app/dist/616.js 2.71 kB 0 B
packages/esm-service-queues-app/dist/644.js 3.06 kB 0 B
packages/esm-service-queues-app/dist/694.js 2.64 kB 0 B
packages/esm-service-queues-app/dist/729.js 3.1 kB 0 B
packages/esm-service-queues-app/dist/757.js 3.13 kB 0 B
packages/esm-service-queues-app/dist/784.js 2.63 kB 0 B
packages/esm-service-queues-app/dist/788.js 3.12 kB 0 B
packages/esm-service-queues-app/dist/807.js 4.36 kB 0 B
packages/esm-service-queues-app/dist/833.js 3.62 kB 0 B
packages/esm-service-queues-app/dist/895.js 52.4 kB 0 B
packages/esm-service-queues-app/dist/981.js 2.92 kB 0 B
packages/esm-service-queues-app/dist/main.js 211 kB -1 B (0%)
packages/esm-service-queues-app/dist/openmrs-esm-service-queues-app.js 3.3 kB -1 B (0%)

compressed-size-action

Copy link
Contributor

@chibongho chibongho left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@mogoodrich mogoodrich left a comment

Choose a reason for hiding this comment

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

Thanks @denniskigen . I'm not super familiar with this code, so only gave a quick review, but looks good, and your reasoning in the PR is sound as well, thanks!

Copy link
Member

@ibacher ibacher left a comment

Choose a reason for hiding this comment

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

LGTM. Couple of nits.

@denniskigen denniskigen force-pushed the feat/configurable-recent-search branch from 0324255 to 31cc083 Compare January 31, 2024 19:14
@denniskigen denniskigen requested a review from ibacher January 31, 2024 19:56
@denniskigen denniskigen merged commit 99975aa into main Feb 5, 2024
6 checks passed
@denniskigen denniskigen deleted the feat/configurable-recent-search branch February 5, 2024 17:11
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.

4 participants