Skip to content

(feat) O3-4201: Enhance Number Question Labels Display Unit and Range (Min/Max) from Concept #454

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.

Sign up for GitHub

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

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

(feat) O3-4201: Enhance Number Question Labels Display Unit and Range (Min/Max) from Concept #454

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
035c318
get units, absolute high, absolute low from concept api, add (units) …
D-matz Dec 21, 2024
a8f625a
display units and min/max from number component instead of field labe…
D-matz Jan 9, 2025
9248fd2
make unit/range format consistent with lab result
D-matz Jan 10, 2025
da40307
Merge remote-tracking branch 'upstream/main' into O3-4201-Enhance-Num…
D-matz Mar 8, 2025
43ee1f0
concept type from esm-framwork, spacing for unit/range cases, field l…
D-matz Mar 23, 2025
3cc336f
import isNil and type concept, default for translation and in test, o…
D-matz Mar 26, 2025
3e9a51c
allow test to work with default value object?
D-matz Mar 26, 2025
9342a90
recommended external modules second
D-matz Mar 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion src/components/inputs/number/number.component.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,28 @@ import { useFormProviderContext } from '../../../provider/form-provider';
import FieldLabel from '../../field-label/field-label.component';
import { isEmpty } from '../../../validators/form-validator';


const extractFieldUnitsAndRange = (concept) => {
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 wrap this in a useCallback?

Copy link
Member

Choose a reason for hiding this comment

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

No, actually, you shouldn't do that here. This is actually done correctly. Functions defined inside functional components would be swapped with a new instance every time the function is called (so, every time the renderer detects that the component might change). useCallback() prevents that by ensuring the variable keeps a stable reference to the same function until the dependency array changes. Since this function isn't defined in a functional component body, references to this function will always be stable references to the same function, so useCallback() isn't needed here (and, IMO, we should prefer these ancillary functions be defined outside of functional components wherever feasible).

All that said, the concept argument here must have a type defined.

Copy link
Member

Choose a reason for hiding this comment

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

Oohh yeah! My bad! For some reason I assumed that the function was defined in the body of the functional component which isn't the case here. It definitely doesn't make sense to memoize such a function.

Copy link
Author

Choose a reason for hiding this comment

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

Should concept come from esm-framework? Or somewhere else or just manually define the interface there? Thanks

if (!concept) {
return '';
}

const { hiAbsolute, lowAbsolute, units } = concept;
const displayUnit = units ? ` ${units}` : '';

const hasLowerLimit = lowAbsolute != null;
const hasUpperLimit = hiAbsolute != null;
Copy link
Member

Choose a reason for hiding this comment

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

Again !==. But I think here it's preferential to just use isNil() from lodash.


if (hasLowerLimit && hasUpperLimit) {
return ` (${lowAbsolute} - ${hiAbsolute} ${displayUnit})`;
Copy link
Member

Choose a reason for hiding this comment

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

Don't hard-code prepended spaces in strings here.

} else if (hasUpperLimit) {
return ` (<= ${hiAbsolute} ${displayUnit})`;
} else if (hasLowerLimit) {
return ` (>= ${lowAbsolute} ${displayUnit})`;
}
return units ? ` (${displayUnit})` : '';
};

const NumberField: React.FC<FormFieldInputProps> = ({ field, value, errors, warnings, setFieldValue }) => {
const { t } = useTranslation();
const [lastBlurredValue, setLastBlurredValue] = useState(value);
Expand Down Expand Up @@ -61,7 +83,7 @@ const NumberField: React.FC<FormFieldInputProps> = ({ field, value, errors, warn
id={field.id}
invalid={errors.length > 0}
invalidText={errors[0]?.message}
label={<FieldLabel field={field} />}
label={<FieldLabel field={field} customLabel={t(field.label) + extractFieldUnitsAndRange(field.meta?.concept)} />}
Copy link
Member

Choose a reason for hiding this comment

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

Please don't do string concatenation like this with translated strings. Use i18next's interpolation feature for this.

Copy link
Member

Choose a reason for hiding this comment

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

In this case, the code now hard-codes a word order that doesn't make sense in LTR languages.

Copy link
Author

Choose a reason for hiding this comment

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

I changed the label to t('{{fieldDescription}} {{unitsAndRange}}' but not sure if that's correct as I haven't used i18n before or tested a right to left language case. Thanks for the i18n help.

max={Number(field.questionOptions.max) || undefined}
min={Number(field.questionOptions.min) || undefined}
name={field.id}
Expand Down
30 changes: 30 additions & 0 deletions src/components/inputs/number/number.test.tsx
View file
Open in desktop
Copy link
Author

Choose a reason for hiding this comment

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

not really sure about jest.mock('react-i18next', () => ({...
it seemed needed for the new i18n label t('{{fieldDescription}} {{unitsAndRange}}'... but I'm not sure if that's correct

Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,25 @@ const numberFieldMock = {
readonly: false,
};

const numberFieldMockWithUnitsAndRange = {
Copy link
Member

Choose a reason for hiding this comment

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

It would be nice to have a more comprehensive set of tests.

Copy link
Author

Choose a reason for hiding this comment

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

added a few more cases (only units, only range, only max)

Copy link
Member

Choose a reason for hiding this comment

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

Could you add one for lowAbsolute only as well? That should cover things.

label: 'Weight',
type: 'obs',
id: 'weight',
questionOptions: {
rendering: 'number',
},
meta: {
concept: {
units: 'kg',
lowAbsolute: 0,
hiAbsolute: 200,
}
},
isHidden: false,
isDisabled: false,
readonly: false,
};

const renderNumberField = async (props) => {
await act(() => render(<NumberField {...props} />));
};
Expand Down Expand Up @@ -104,4 +123,15 @@ describe('NumberField Component', () => {
const inputElement = screen.getByLabelText('Weight(kg):') as HTMLInputElement;
expect(inputElement).toBeDisabled();
});

it('renders units and range', async () => {
await renderNumberField({
field: numberFieldMockWithUnitsAndRange,
value: '',
errors: [],
warnings: [],
setFieldValue: jest.fn(),
});
expect(screen.getByLabelText('Weight (0 - 200 kg)')).toBeInTheDocument();
});
});
2 changes: 1 addition & 1 deletion src/hooks/useConcepts.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { type FetchResponse, type OpenmrsResource, openmrsFetch, restBaseUrl } f
type ConceptFetchResponse = FetchResponse<{ results: Array<OpenmrsResource> }>;

const conceptRepresentation =
'custom:(uuid,display,conceptClass:(uuid,display),answers:(uuid,display),conceptMappings:(conceptReferenceTerm:(conceptSource:(name),code)))';
'custom:(units,lowAbsolute,hiAbsolute,uuid,display,conceptClass:(uuid,display),answers:(uuid,display),conceptMappings:(conceptReferenceTerm:(conceptSource:(name),code)))';
Copy link
Member

Choose a reason for hiding this comment

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

@ibacher when is it necessary to use hiCritical vs lowCritical?

Copy link
Member

Choose a reason for hiding this comment

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

All of the values that aren't lowAbsolute and hiAbsolute are basically only for displaying concerning results (outside the normal range, but inside the critical range) or critical results (outside the critical range, but within the absolute range). Does that make sense? lowAbsolute and hiAbsolute should be rare and only in cases where the value can never exceed that range (e.g., SpO2 is a percent, so it's always between 0 and 100; heights and weights should never be a negative number, things like that).

Copy link
Member

Choose a reason for hiding this comment

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

But we can handle critical icons in a separate PR.


export function useConcepts(references: Set<string>): {
concepts: Array<OpenmrsResource> | undefined;
Expand Down
14 changes: 14 additions & 0 deletions src/hooks/useFormFieldsMeta.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,20 @@ export function useFormFieldsMeta(rawFormFields: FormField[], concepts: OpenmrsR
const matchingConcept = findConceptByReference(field.questionOptions.concept, concepts);
field.questionOptions.concept = matchingConcept ? matchingConcept.uuid : field.questionOptions.concept;
field.label = field.label ? field.label : matchingConcept?.display;

if (matchingConcept) {
if (matchingConcept.lowAbsolute != undefined && matchingConcept.hiAbsolute != undefined) {
Copy link
Member

Choose a reason for hiding this comment

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

It's always better to use typeof x !== 'undefined', though this kind of works, but only because SWC will re-write the undefineds here to void 0. In any case, please use exact comparisons (!== and ===).

Copy link
Member

Choose a reason for hiding this comment

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

Also, please just implement @samuelmale's suggestion. It's much cleaner.

Copy link
Author

Choose a reason for hiding this comment

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

applied suggestion @samuelmale ty

field.questionOptions.min = matchingConcept.lowAbsolute;
field.questionOptions.max = matchingConcept.hiAbsolute;
}
else if (matchingConcept.lowAbsolute != undefined) {
field.questionOptions.min = matchingConcept.lowAbsolute;
}
else if (matchingConcept.hiAbsolute != undefined) {
field.questionOptions.max = matchingConcept.hiAbsolute;
}
}

if (
codedTypes.includes(field.questionOptions.rendering) &&
!field.questionOptions.answers?.length &&
Expand Down
Loading