feat: [DHIS2-13343] hidden program stage rule effect (#3406)

cypress/integration/EnrollmentPage/HiddenProgramStage.feature

@@ -0,0 +1,7 @@
+Feature: Hidden program stage
+
+    Scenario: The user cannot add an event in a hidden program stage
+        Given you add an enrollment event that will result in a rule effect to hide a program stage
+        Then the New Postpartum care visit event button is disabled in the stages and events widget
+        And and an error is show in the Postpartum care visit stage
+        And the Postpartum care visit button is disabled in the enrollmentEventNew page

cypress/integration/EnrollmentPage/HiddenProgramStage/index.js

@@ -0,0 +1,66 @@
+import moment from 'moment';
+
+const cleanUpIfApplicable = () => {
+    cy.buildApiUrl(
+        'tracker',
+        'trackedEntities/uW8Y7AIcRKA?program=WSGAb5XwJ3Y&fields=enrollments',
+    )
+        .then(url => cy.request(url))
+        .then(({ body }) => {
+            const enrollment = body.enrollments?.find(e => e.enrollment === 'fmhIsWXVDmS');
+            const event = enrollment?.events?.find(e => e.programStage === 'PFDfvmGpsR3');
+            if (!event) {
+                return null;
+            }
+            return cy
+                .buildApiUrl('events', event.event)
+                .then(eventUrl =>
+                    cy.request('DELETE', eventUrl));
+        });
+};
+
+Given('you add an enrollment event that will result in a rule effect to hide a program stage', () => {
+    cleanUpIfApplicable();
+    cy.visit(
+        '/#/enrollmentEventNew?enrollmentId=fmhIsWXVDmS&orgUnitId=s7SLtx8wmRA&programId=WSGAb5XwJ3Y&stageId=PFDfvmGpsR3&teiId=uW8Y7AIcRKA',
+    );
+
+    cy.get('[data-test="capture-ui-input"]')
+        .eq(0)
+        .type(moment().format('YYYY-MM-DD'))
+        .blur();
+
+    cy
+        .get('[data-test="virtualized-select"]')
+        .eq(6)
+        .click()
+        .contains('Termination of pregnancy')
+        .click();
+
+    cy.contains('[data-test="dhis2-uicore-button"]', 'Save without completing').click();
+});
+
+Then('the New Postpartum care visit event button is disabled in the stages and events widget', () => {
+    cy.contains('[data-test="create-new-button"]', 'New Postpartum care visit event')
+        .should('be.disabled');
+});
+
+Then('and an error is show in the Postpartum care visit stage', () => {
+    cy.visit(
+        '/#/enrollmentEventNew?enrollmentId=fmhIsWXVDmS&orgUnitId=s7SLtx8wmRA&programId=WSGAb5XwJ3Y&teiId=uW8Y7AIcRKA&stageId=bbKtnxRZKEP',
+    );
+    cy.contains('[data-test="dhis2-uicore-button"]', 'Complete')
+        .should('be.disabled');
+    cy.contains('[data-test="dhis2-uicore-button"]', 'Save without completing')
+        .should('be.disabled');
+    cy.contains('[data-test="dhis2-uicore-noticebox-content"]', 'You can\'t add any more Postpartum care visit events')
+        .should('exist');
+});
+
+Then('the Postpartum care visit button is disabled in the enrollmentEventNew page', () => {
+    cy.visit(
+        '/#/enrollmentEventNew?enrollmentId=fmhIsWXVDmS&orgUnitId=s7SLtx8wmRA&programId=WSGAb5XwJ3Y&teiId=uW8Y7AIcRKA',
+    );
+
+    cy.contains('[data-test="program-stage-selector-button"]', 'Postpartum care visit').should('be.disabled');
+});

i18n/en.pot

@@ -5,8 +5,8 @@ msgstr ""
 "Content-Type: text/plain; charset=utf-8\n"
 "Content-Transfer-Encoding: 8bit\n"
 "Plural-Forms: nplurals=2; plural=(n != 1)\n"
-"POT-Creation-Date: 2023-08-22T12:04:52.436Z\n"
-"PO-Revision-Date: 2023-08-22T12:04:52.436Z\n"
+"POT-Creation-Date: 2023-09-04T07:07:59.195Z\n"
+"PO-Revision-Date: 2023-09-04T07:07:59.195Z\n"
 
 msgid "Choose one or more dates..."
 msgstr "Choose one or more dates..."

packages/rules-engine/src/processors/rulesEffectsProcessor/rulesEffectsProcessor.js

@@ -12,6 +12,7 @@ import type {
     IConvertOutputRulesEffectsValue,
     AssignOutputEffect,
     HideOutputEffect,
+    HideProgramStageEffect,
     MessageEffect,
     GeneralErrorEffect,
     GeneralWarningEffect,
@@ -207,6 +208,17 @@ export function getRulesEffectsProcessor(
         };
     }
 
+    function processHideProgramStage(effect: ProgramRuleEffect): ?HideProgramStageEffect {
+        if (!effect.programStageId) {
+            return null;
+        }
+
+        return {
+            type: effectActions.HIDE_PROGRAM_STAGE,
+            id: effect.programStageId,
+        };
+    }
+
     function processMakeCompulsory(effect: ProgramRuleEffect): Array<CompulsoryEffect> {
         return createEffectsForConfiguredDataTypes(effect, () => ({
             type: effectActions.MAKE_COMPULSORY,
@@ -267,6 +279,7 @@ export function getRulesEffectsProcessor(
         [effectActions.SHOW_WARNING]: processShowWarning,
         [effectActions.SHOW_ERROR_ONCOMPLETE]: processShowErrorOnComplete,
         [effectActions.SHOW_WARNING_ONCOMPLETE]: processShowWarningOnComplete,
+        [effectActions.HIDE_PROGRAM_STAGE]: processHideProgramStage,
         [effectActions.HIDE_SECTION]: processHideSection,
         [effectActions.MAKE_COMPULSORY]: processMakeCompulsory,
         [effectActions.DISPLAY_TEXT]: processDisplayText,

packages/rules-engine/src/rulesEngine.types.js

@@ -30,6 +30,10 @@ export type HideOutputEffect = OutputEffect & {
 
 };
 
+export type HideProgramStageEffect = OutputEffect & {
+
+};
+
 export type MessageEffect = OutputEffect & {
     message: string,
 };

src/core_modules/capture-core/components/Pages/Enrollment/EnrollmentPageDefault/EnrollmentPageDefault.component.js

@@ -63,6 +63,7 @@ export const EnrollmentPageDefaultPlain = ({
     onUpdateEnrollmentDate,
     onUpdateIncidentDate,
     onEnrollmentError,
+    ruleEffects,
 }: PlainProps) => (
     <>
         <div className={classes.title}>{i18n.t('Enrollment Dashboard')}</div>
@@ -71,6 +72,7 @@ export const EnrollmentPageDefaultPlain = ({
                 <EnrollmentQuickActions
                     stages={stages}
                     events={events}
+                    ruleEffects={ruleEffects}
                 />
                 <WidgetStagesAndEvents
                     programId={program.id}
@@ -79,6 +81,7 @@ export const EnrollmentPageDefaultPlain = ({
                     onViewAll={onViewAll}
                     onCreateNew={onCreateNew}
                     onEventClick={onEventClick}
+                    ruleEffects={ruleEffects}
                 />
             </div>
             <div className={classes.rightColumn}>

src/core_modules/capture-core/components/Pages/Enrollment/EnrollmentPageDefault/EnrollmentPageDefault.container.js

@@ -7,6 +7,7 @@ import { useDispatch } from 'react-redux';
 import { useHistory } from 'react-router-dom';
 import {
     useCommonEnrollmentDomainData,
+    useRuleEffects,
     updateEnrollmentAttributeValues,
     updateEnrollmentDate,
     updateIncidentDate,
@@ -24,7 +25,6 @@ import {
     useProgramMetadata,
     useHideWidgetByRuleLocations,
     useProgramStages,
-    useRuleEffects,
 } from './hooks';
 import { buildUrlQueryString, useLocationQuery } from '../../../../utils/routing';
 import { useFilteredWidgetData } from './hooks/useFilteredWidgetData';
@@ -126,6 +126,7 @@ export const EnrollmentPageDefault = () => {
             onUpdateEnrollmentDate={onUpdateEnrollmentDate}
             onUpdateIncidentDate={onUpdateIncidentDate}
             onEnrollmentError={onEnrollmentError}
+            ruleEffects={ruleEffects}
         />
     );
 };

src/core_modules/capture-core/components/Pages/Enrollment/EnrollmentPageDefault/EnrollmentPageDefault.types.js

@@ -1,4 +1,5 @@
 // @flow
+import { typeof effectActions } from '@dhis2/rules-engine-javascript';
 import type { Program } from 'capture-core/metaData';
 import type { Stage } from 'capture-core/components/WidgetStagesAndEvents/types/common.types';
 import type { WidgetEffects, HideWidgets } from '../../common/EnrollmentOverviewDomain';
@@ -22,6 +23,7 @@ export type Props = {|
     onUpdateEnrollmentDate: (enrollmentDate: string) => void,
     onUpdateIncidentDate: (incidentDate: string) => void,
     onEnrollmentError: (message: string) => void,
+    ruleEffects?: Array<{id: string, type: $Values<effectActions>}>;
 |};
 
 export type PlainProps = {|

src/core_modules/capture-core/components/Pages/Enrollment/EnrollmentPageDefault/EnrollmentQuickActions/EnrollmentQuickActions.component.js

@@ -19,7 +19,7 @@ const styles = {
 
 };
 
-const EnrollmentQuickActionsComponent = ({ stages, events, classes }) => {
+const EnrollmentQuickActionsComponent = ({ stages, events, ruleEffects, classes }) => {
     const [open, setOpen] = useState(true);
     const history = useHistory();
     const { enrollmentId, programId, teiId, orgUnitId } = useLocationQuery();
@@ -33,10 +33,20 @@ const EnrollmentQuickActionsComponent = ({ stages, events, classes }) => {
         return mutatedStage;
     }), [events, stages]);
 
+    const hiddenProgramStageRuleEffects = useMemo(
+        () => ruleEffects?.filter(ruleEffect => ruleEffect.type === 'HIDEPROGRAMSTAGE'),
+        [ruleEffects],
+    );
+
     const noStageAvailable = useMemo(
-        () => stagesWithEventCount.every(programStage =>
-            (!programStage.repeatable && programStage.eventCount > 0),
-        ), [stagesWithEventCount]);
+        () =>
+            stagesWithEventCount.every(
+                programStage =>
+                    (!programStage.repeatable && programStage.eventCount > 0) ||
+                    hiddenProgramStageRuleEffects?.find(ruleEffect => ruleEffect.id === programStage.id),
+            ),
+        [stagesWithEventCount, hiddenProgramStageRuleEffects],
+    );
 
     const onNavigationFromQuickActions = (tab: string) => {
         history.push(`/enrollmentEventNew?${buildUrlQueryString({ programId, teiId, enrollmentId, orgUnitId, tab })}`);

src/core_modules/capture-core/components/Pages/Enrollment/EnrollmentPageDefault/hooks/index.js

@@ -3,5 +3,4 @@ export { useTeiAttributes } from './useTeiAttributes';
 export { useProgramMetadata } from './useProgramMetadata';
 export { useHideWidgetByRuleLocations } from './useHideWidgetByRuleLocations';
 export { useProgramStages } from './useProgramStages';
-export { useRuleEffects } from './useRuleEffects';
-export type { UseRuleEffectsInput } from './useRuleEffects.types';
+

src/core_modules/capture-core/components/Pages/EnrollmentAddEvent/ProgramStageSelector/ProgramStageSelector.component.js

@@ -26,7 +26,8 @@ const styles = {
 const ProgramStageSelectorComponentPlain = ({ programStages, onSelectProgramStage, onCancel, classes }) => (
     <div className={classes.container}>
         {programStages.map((programStage) => {
-            const disableStage = !programStage.repeatable && programStage.eventCount > 0;
+            const disableStage =
+                (!programStage.repeatable && programStage.eventCount > 0) || programStage.hiddenProgramStage;
             return (
                 <div
                     key={programStage.id}

src/core_modules/capture-core/components/Pages/EnrollmentAddEvent/ProgramStageSelector/ProgramStageSelector.container.js

@@ -6,22 +6,33 @@ import log from 'loglevel';
 import { ProgramStageSelectorComponent } from './ProgramStageSelector.component';
 import { Widget } from '../../../Widget';
 import { errorCreator } from '../../../../../capture-core-utils';
-import { useCommonEnrollmentDomainData } from '../../common/EnrollmentOverviewDomain';
+import { useCommonEnrollmentDomainData, useRuleEffects } from '../../common/EnrollmentOverviewDomain';
 import type { Props } from './ProgramStageSelector.types';
 import { useProgramFromIndexedDB } from '../../../../utils/cachedDataHooks/useProgramFromIndexedDB';
 import { useLocationQuery, buildUrlQueryString } from '../../../../utils/routing';
+import { useRulesEngineOrgUnit } from '../../../../hooks/useRulesEngineOrgUnit';
+import { useTrackerProgram } from '../../../../hooks/useTrackerProgram';
 
 
 export const ProgramStageSelector = ({ programId, orgUnitId, teiId, enrollmentId }: Props) => {
     const history = useHistory();
     const { tab } = useLocationQuery();
-    const { error: enrollmentsError, enrollment } = useCommonEnrollmentDomainData(teiId, enrollmentId, programId);
+    const { error: enrollmentsError, enrollment, attributeValues } = useCommonEnrollmentDomainData(teiId, enrollmentId, programId);
     const {
         program,
         isLoading: programLoading,
         isError: programError,
     } = useProgramFromIndexedDB(programId);
 
+    const { orgUnit } = useRulesEngineOrgUnit(orgUnitId);
+    const programRules = useTrackerProgram(programId);
+
+    const ruleEffects = useRuleEffects({
+        orgUnit,
+        program: programRules,
+        apiEnrollment: enrollment,
+        apiAttributeValues: attributeValues,
+    });
 
     useEffect(() => {
         if (enrollmentsError || programError) {
@@ -42,9 +53,12 @@ export const ProgramStageSelector = ({ programId, orgUnitId, teiId, enrollmentId
             displayName: currentStage.displayName,
             style: currentStage.style,
             repeatable: currentStage.repeatable,
+            hiddenProgramStage: ruleEffects?.find(
+                ruleEffect => ruleEffect.type === 'HIDEPROGRAMSTAGE' && ruleEffect.id === currentStage.id,
+            ),
         });
         return accStage;
-    }, []), [enrollment?.events, program?.programStages, programLoading]);
+    }, []), [enrollment?.events, program?.programStages, programLoading, ruleEffects]);
 
     const onSelectProgramStage = (newStageId: string) =>
         history.push(`enrollmentEventNew?${buildUrlQueryString({

src/core_modules/capture-core/components/Pages/common/EnrollmentOverviewDomain/index.js

@@ -12,3 +12,4 @@ export {
     showEnrollmentError,
 } from './enrollment.actions';
 export { useCommonEnrollmentDomainData } from './useCommonEnrollmentDomainData';
+export { useRuleEffects } from './useRuleEffects';

src/core_modules/capture-core/components/Pages/common/EnrollmentOverviewDomain/useRuleEffects/index.js

@@ -0,0 +1,3 @@
+// @flow
+export { useRuleEffects } from './useRuleEffects';
+export type * from './useRuleEffects.types';

src/core_modules/capture-core/components/Pages/Enrollment/EnrollmentPageDefault/hooks/useRuleEffects.js → src/core_modules/capture-core/components/Pages/common/EnrollmentOverviewDomain/useRuleEffects/useRuleEffects.js

@@ -79,13 +79,16 @@ export const useRuleEffects = ({ orgUnit, program, apiEnrollment, apiAttributeVa
 
     useEffect(() => {
         if (orgUnit && attributeValues && enrollmentData && otherEvents) {
-            setRuleEffects(getApplicableRuleEffectsForTrackerProgram({
+            const effects = getApplicableRuleEffectsForTrackerProgram({
                 program,
                 orgUnit,
                 otherEvents,
                 attributeValues,
                 enrollmentData,
-            }, true));
+            }, true);
+            if (Array.isArray(effects)) {
+                setRuleEffects(effects);
+            }
         }
     }, [attributeValues, enrollmentData, orgUnit, otherEvents, program]);
 

src/core_modules/capture-core/components/Pages/Enrollment/EnrollmentPageDefault/hooks/useRuleEffects.types.js → src/core_modules/capture-core/components/Pages/common/EnrollmentOverviewDomain/useRuleEffects/useRuleEffects.types.js

@@ -4,7 +4,7 @@ import type { TrackerProgram } from 'capture-core/metaData';
 import type {
     EnrollmentData,
     AttributeValue,
-} from '../../../common/EnrollmentOverviewDomain/useCommonEnrollmentDomainData';
+} from '../useCommonEnrollmentDomainData';
 
 export type UseRuleEffectsInput = {|
     orgUnit?: ?OrgUnit,

src/core_modules/capture-core/components/WidgetEnrollmentEventNew/ErrorText/ErrorText.component.js

@@ -0,0 +1,20 @@
+// @flow
+import React from 'react';
+import i18n from '@dhis2/d2-i18n';
+import { NoticeBox } from '@dhis2/ui';
+import type { Props } from './ErrorText.types';
+
+export const ErrorText = ({ stageName }: Props) => (
+    <>
+        <br />
+        <NoticeBox error>
+            <span>
+                {i18n.t("You can't add any more {{ programStageName }} events", {
+                    programStageName: stageName,
+                    interpolation: { escapeValue: false },
+                })}
+            </span>
+        </NoticeBox>
+        <br />
+    </>
+);

src/core_modules/capture-core/components/WidgetEnrollmentEventNew/ErrorText/ErrorText.types.js

@@ -0,0 +1,5 @@
+// @flow
+
+export type Props = {|
+    stageName: string,
+|};

src/core_modules/capture-core/components/WidgetEnrollmentEventNew/ErrorText/index.js

@@ -0,0 +1,2 @@
+// @flow
+export { ErrorText } from './ErrorText.component';