(fix) Load contactAttributeTypes from patient banner config #1290
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes an issue where contact details would not render in patient banners outside of the patient chart. The [contactAttributeTypes config property](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/patient-banner/contact-details/usePatientAttributes.ts#L34), which determines which person attributes are displayed in the contact details section, is defined in the [patient banner app's config schema](https://github.com/openmrs/openmrs-esm-patient-banner-app/blob/main/packages/esm-patient-banner-app/src/config-schema.json) rather than the styleguide's schema. Fixes an issue where contact details would not render in patient banners outside of the patient chart. The [contactAttributeTypes config property](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/patient-banner/contact-details/usePatientAttributes.ts#L34), which determines which person attributes are displayed in the contact details section, is defined in the [patient banner app's config schema](https://github.com/openmrs/openmrs-esm-patient-banner-app/blob/main/packages/esm-patient-banner-app/src/config-schema.json) rather than the styleguide's schema. Fixes an issue where contact details would not render in patient banners outside of the patient chart. The [contactAttributeTypes config property](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/patient-banner/contact-details/usePatientAttributes.ts#L34), which determines which person attributes are displayed in the contact details section, is defined in the [patient banner app's config schema](https://github.com/openmrs/openmrs-esm-patient-chart/blob/main/packages/esm-patient-banner-app/src/config-schema.ts#L4) rather than the styleguide's schema. The useConfig call signature in the [usePatientContactAttributes hook](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/patient-banner/contact-details/usePatientAttributes.ts#L33) incorrectly assumes that the `contactAttributeTypes` property exists in the styleguide config schema. To fix this, we need to load the property from the patient banner's config schema asynchronously by specifying `@openmrs/esm-patient-banner-app` as the `externalModuleName`. Other changes in this diff include: - Memoizing the hook's return value to prevent unnecessary filtering of attributes on every render. - Adding explicit error handling in the hook's return value. - Extending the JSDoc comment string to include a note about the patient banner app's config schema as well as properly documenting the hook's return value. - Initializing the `contactAttributeTypes` array as an empty array to avoid potential issues with falsy values.
|
Size Change: -88.4 kB (-1.4%) Total Size: 6.21 MB
ℹ️ View Unchanged
|
NethmiRodrigo
approved these changes
Feb 18, 2025
|
Looks like you're getting the failing patient management e2e test too that I was attempting to fix here - openmrs/openmrs-esm-patient-management#1487 |
3 tasks
ibacher
approved these changes
Feb 18, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Requirements
feat,fix, orchore, among others). See existing PR titles for inspiration.For changes to apps
If applicable
Summary
Fixes an issue where contact details would not render in patient banners outside of the patient chart. The contactAttributeTypes config property, which determines which person attributes are displayed in the contact details section, is defined in the patient banner app's config schema rather than the styleguide's schema.
The useConfig call signature in the usePatientContactAttributes hook incorrectly assumes that the
contactAttributeTypesproperty exists in the styleguide config schema. To fix this, we need to load the property from the patient banner's config schema asynchronously by specifying@openmrs/esm-patient-banner-appas theexternalModuleName.Other changes in this diff include:
contactAttributeTypesarray as an empty array to avoid potential issues with falsy values.Screenshots
Before
After
Related Issue
Other