O3-4257: Fix obsGroup children visibility when parent hideWhenExpression evaluates to true

[RajPrakash681]

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

Problem

When an obsGroup field has a hideWhenExpression that evaluates to true, the obsGroup and its child fields remained visible in the DOM instead of being hidden. This breaks the expected conditional visibility behavior.

Root Causes:

1. The hide property was in the behaviours array and not extracted to field level
2. The ObsGroup component didn't check for hidden state
3. Child fields weren't marked as hidden when parent was hidden
4. Component used useMemo which prevented re-rendering on state changes

Solution

1. Hook Changes (useEvaluateFormFieldExpressions.ts):

• Modified expression evaluation to set isParentHidden flag on child questions when parent field is hidden
• Ensures cascading hide behavior from parent obsGroup to all children

2. Component Changes (obs-group.component.tsx):

• Retrieve latest evaluated field state from formFields to get current hidden status
• Check if obsGroup itself is hidden (isHidden or isParentHidden)
• Return null early if obsGroup should be hidden (removes entire component from DOM)
• Filter child fields to exclude those with isHidden or isParentHidden flags
• Removed useMemo wrapper to allow proper re-rendering when field state changes

3. Test Coverage:

• Created obs-group-hide-test-form.json with obsGroup having hideWhenExpression
• Added comprehensive test case verifying:
  • ObsGroup and children initially visible
  • Clicking trigger hides obsGroup label and all child fields from DOM
  • Re-triggering makes them visible again
• Ensured form intent ('*') is passed to trigger proper behaviour extraction

Related Issue

https://issues.openmrs.org/browse/O3-5015

[RajPrakash681]

@NethmiRodrigo sorry for tagging you again i have tried to fix this also can you have a look at it

[RajPrakash681]

@denniskigen can you review this also please

[RajPrakash681]

@NethmiRodrigo @denniskigen please have a look at this.

[samuelmale]

The hide property was in the behaviours array and not extracted to field level

Does the issue happen if the hide property is defined at the field level?

[RajPrakash681]

@samuelmale You're right -in the current test form, the hide property is in the behaviours array and gets extracted to field level through applyFormIntent() in forms-loader.ts.

I haven't tested the scenario where hide is defined directly at the field level (bypassing the behaviors extraction).

Should I create a test case with the hide property defined directly at field level to verify if the issue occurs in both scenarios?

[samuelmale]

Yes! To help narrow down the issue, we need to rule out whether it's related to how form behaviours are processed or with the obs-group component itself. Create a form with hide logic defined directly at the field level, test out this form on the upstream branch (without your changes).

[RajPrakash681]

@samuelmale i have done that please have a look

[RajPrakash681]

@samuelmale please review it and please let me know if any further changes are required or is it good to merge ?

[samuelmale]

i have done that please have a look

Do the visibility issues happen when we define the hide logic at the field level? Can you share your findings?

[RajPrakash681]

No, visibility issues do NOT occur when we define the hide logic at the field level.

I've tested and verified both scenarios:

Behavior-based hide logic (using behaviours array)

Direct field-level hide logic (defined directly on the field)

Both work correctly. Here's why:
When an obsGroup's hideWhenExpression evaluates to true, the evaluateHide function sets isHidden on the parent obsGroup.
For fields with children (like obsGroups), it automatically cascades the visibility by setting isParentHidden = true on all child fields.The ObsGroup component filters out children where child.isHidden || child.isParentHidden is true.

Both test cases pass successfully, confirming this behavior.

[RajPrakash681]

@samuelmale sir any updates about it

[RajPrakash681]

@samuelmale sir any updates about it

sir update please ! very eager to know whether it got fixed or not! 😊

[samuelmale]

No, visibility issues do NOT occur when we define the hide logic at the field level.

This means that the issue is linked to how form intents (behaviours) are processed; that being said, here is the related logic.

[RajPrakash681]

No, visibility issues do NOT occur when we define the hide logic at the field level.

This means that the issue is linked to how form intents (behaviours) are processed; that being said, here is the related logic.

Hey Samuel,

You were right - the issue was in the behavior processing logic. I added a check so child questions only process behaviors if they have them (matching parent logic), and made children inherit parent's hide expression during form loading.

[samuelmale]

Assuming the issue is related to how form intents are handled in the src/utils/forms-loader.ts, is it necessary to make changes in this file?

[RajPrakash681]

Assuming the issue is related to how form intents are handled in the src/utils/forms-loader.ts, is it necessary to make changes in this file?

I tested the fix by reverting obs-group.component.tsx to its original state (before commit eb663d8), and the tests FAILED without those changes. This proves that both fixes are necessary:

The forms-loader.ts fix ensures children inherit the parent's hide property at form load time.

The obs-group.component.tsx changes provide runtime filtering by checking isHidden and isParentHidden to properly hide the children.

The two layers work together one at form loading, one at rendering.

The testing demonstrated that:

Without obs-group.component.tsx changes: Tests FAIL (groups and children still render when they should be hidden)

[RajPrakash681]

@samuelmale

[RajPrakash681]

@samuelmale an updates on this pr as i have implemented few changes!

[RajPrakash681]

@samuelmale any update on how to move forward!?