feat: [DHIS2-18746][DHIS2-18903] Show org. unit in edit event form

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

@@ -144,6 +144,7 @@ export type OrgUnitGroup = $ReadOnly<{|
 export type OrgUnit = $ReadOnly<{
     id: string,
     name: string,
+    path?: string,
     code: string,
     groups: Array<OrgUnitGroup>,
 }>;

src/core_modules/capture-core/components/Pages/EnrollmentEditEvent/TopBar.container.js

@@ -65,6 +65,7 @@ export const TopBar = ({
             onResetOrgUnitId={() => resetOrgUnitId()}
             isUserInteractionInProgress={isUserInteractionInProgress}
             onStartAgain={() => reset()}
+            isReadOnly={mode === dataEntryKeys.EDIT}
         >
             <SingleLockedSelect
                 displayOnly

src/core_modules/capture-core/components/Pages/ViewEvent/TopBar.container.js

@@ -11,21 +11,22 @@ import {
     resetCategoryOption,
     resetAllCategoryOptions,
 } from './ViewEventPage.actions';
-
 import { TopBarActions } from '../../TopBarActions';
 
 type TopBarProps = {
     isUserInteractionInProgress: boolean,
     programId?: string,
     orgUnitId?: string,
     selectedCategories?: any,
+    isReadOnly: boolean,
     formIsOpen: boolean,
 };
 
 export const TopBar = ({
     programId,
     orgUnitId,
     selectedCategories,
+    isReadOnly,
     isUserInteractionInProgress,
     formIsOpen,
 }: TopBarProps) => {
@@ -63,6 +64,7 @@ export const TopBar = ({
             isUserInteractionInProgress={isUserInteractionInProgress}
             formIsOpen={formIsOpen}
             onStartAgain={() => reset()}
+            isReadOnly={isReadOnly}
         >
             <TopBarActions
                 selectedProgramId={programId}

src/core_modules/capture-core/components/Pages/ViewEvent/ViewEventPage.component.js

@@ -11,9 +11,10 @@ import { inMemoryFileStore } from '../../DataEntry/file/inMemoryFileStore';
 type Props = {
   isUserInteractionInProgress: boolean,
   showAddRelationship: boolean,
+  isReadOnly: boolean,
 };
 
-export const ViewEventPageComponent = ({ isUserInteractionInProgress, showAddRelationship }: Props) => {
+export const ViewEventPageComponent = ({ isUserInteractionInProgress, showAddRelationship, isReadOnly }: Props) => {
     const { serverVersion: { minor } } = useConfig();
     useEffect(() => inMemoryFileStore.clear, []);
 
@@ -29,6 +30,7 @@ export const ViewEventPageComponent = ({ isUserInteractionInProgress, showAddRel
                 programId={programId}
                 orgUnitId={orgUnitId}
                 selectedCategories={selectedCategories}
+                isReadOnly={isReadOnly}
                 isUserInteractionInProgress={isUserInteractionInProgress}
                 formIsOpen
             />

src/core_modules/capture-core/components/Pages/ViewEvent/ViewEventPage.container.js

@@ -7,6 +7,7 @@ import { withLoadingIndicator, withErrorMessageHandler } from '../../../HOC';
 
 const mapStateToProps = (state: ReduxState) => {
     const eventDetailsSection = state.viewEventPage.eventDetailsSection || {};
+    const isReadOnly = eventDetailsSection.showEditEvent;
     const isUserInteractionInProgress =
       (state.currentSelections.complete && eventDetailsSection.showEditEvent)
           ?
@@ -17,6 +18,7 @@ const mapStateToProps = (state: ReduxState) => {
         error: state.activePage.viewEventLoadError && state.activePage.viewEventLoadError.error,
         ready: !state.activePage.lockedSelectorLoads,
         isUserInteractionInProgress,
+        isReadOnly,
         showAddRelationship: state.viewEventPage.showAddRelationship,
     };
 };

src/core_modules/capture-core/components/WidgetEventEdit/DataEntry/editEventDataEntry.actions.js

@@ -9,8 +9,11 @@ import {
     updateRulesEffects,
 } from '../../../rules';
 import { RenderFoundation, Program } from '../../../metaData';
-import { getEventDateValidatorContainers } from './fieldValidators/eventDate.validatorContainersGetter';
-import { getCategoryOptionsValidatorContainers } from './fieldValidators/categoryOptions.validatorContainersGetter';
+import {
+    getEventDateValidatorContainers,
+    getOrgUnitValidatorContainers,
+    getCategoryOptionsValidatorContainers,
+} from './fieldValidators';
 import {
     getConvertGeometryIn,
     convertGeometryOut,
@@ -110,6 +113,11 @@ export const openEventForEditInDataEntry = ({
             type: 'DATE',
             validatorContainers: getEventDateValidatorContainers(),
         },
+        {
+            id: 'orgUnit',
+            type: 'ORGANISATION_UNIT',
+            validatorContainers: getOrgUnitValidatorContainers(),
+        },
         {
             clientId: 'geometry',
             dataEntryId: 'geometry',

src/core_modules/capture-core/components/WidgetEventEdit/DataEntry/epics/editEventDataEntry.epics.js

@@ -4,7 +4,6 @@ import { from } from 'rxjs';
 import { ofType } from 'redux-observable';
 import { map, switchMap } from 'rxjs/operators';
 import { batchActions } from 'redux-batched-actions';
-import type { OrgUnit } from '@dhis2/rules-engine-javascript';
 import { rulesExecutedPostUpdateField } from '../../../DataEntry/actions/dataEntry.actions';
 import {
     batchActionTypes as editEventDataEntryBatchActionTypes,
@@ -26,13 +25,13 @@ import { getDataEntryKey } from '../../../DataEntry/common/getDataEntryKey';
 import { prepareEnrollmentEventsForRulesEngine } from '../../../../events/prepareEnrollmentEvents';
 import { getEnrollmentForRulesEngine, getAttributeValuesForRulesEngine } from '../../helpers';
 import type { QuerySingleResource } from '../../../../utils/api';
+import { getCoreOrgUnitFn, orgUnitFetched } from '../../../../metadataRetrieval/coreOrgUnit';
 
 const runRulesForEditSingleEvent = async ({
     store,
     dataEntryId,
     itemId,
     uid,
-    orgUnit,
     fieldData,
     programId,
     querySingleResource,
@@ -42,7 +41,6 @@ const runRulesForEditSingleEvent = async ({
     itemId: string,
     uid: string,
     programId: string,
-    orgUnit: OrgUnit,
     fieldData?: ?FieldData,
     querySingleResource: QuerySingleResource
 }) => {
@@ -66,6 +64,10 @@ const runRulesForEditSingleEvent = async ({
     // $FlowFixMe
     const currentEvent = { ...currentEventValues, ...currentEventMainData, eventId };
 
+    const { coreOrgUnit, cached } =
+        // $FlowFixMe
+        await getCoreOrgUnitFn(querySingleResource)(currentEvent.orgUnit?.id, store.value.organisationUnits);
+
     let effects;
     if (program instanceof TrackerProgram) {
         const { enrollment, attributeValues } = state.enrollmentDomain;
@@ -82,7 +84,7 @@ const runRulesForEditSingleEvent = async ({
         effects = getApplicableRuleEffectsForTrackerProgram({
             program,
             stage,
-            orgUnit,
+            orgUnit: coreOrgUnit,
             currentEvent: { ...currentEvent, createdAt: apiCurrentEventOriginal.createdAt },
             otherEvents: prepareEnrollmentEventsForRulesEngine(apiOtherEvents),
             enrollmentData: getEnrollmentForRulesEngine(enrollment),
@@ -91,7 +93,7 @@ const runRulesForEditSingleEvent = async ({
     } else {
         effects = getApplicableRuleEffectsForEventProgram({
             program,
-            orgUnit,
+            orgUnit: coreOrgUnit,
             currentEvent,
         });
     }
@@ -105,6 +107,7 @@ const runRulesForEditSingleEvent = async ({
     return batchActions([
         updateRulesEffects(effectsWithValidations, formId),
         rulesExecutedPostUpdateField(dataEntryId, itemId, uid),
+        ...(coreOrgUnit && !cached ? [orgUnitFetched(coreOrgUnit)] : []),
     ],
     editEventDataEntryBatchActionTypes.RULES_EFFECTS_ACTIONS_BATCH);
 };
@@ -114,20 +117,19 @@ export const runRulesOnUpdateDataEntryFieldForEditSingleEventEpic = (
     store: ReduxStore,
     { querySingleResource }: ApiUtils,
 ) =>
-// $FlowSuppress
+    // $FlowSuppress
     action$.pipe(
         ofType(editEventDataEntryBatchActionTypes.UPDATE_DATA_ENTRY_FIELD_EDIT_SINGLE_EVENT_ACTION_BATCH),
         map(actionBatch =>
             actionBatch.payload.find(action => action.type === editEventDataEntryActionTypes.START_RUN_RULES_ON_UPDATE),
         ),
         switchMap((action) => {
-            const { dataEntryId, itemId, uid, orgUnit, programId } = action.payload;
+            const { dataEntryId, itemId, uid, programId } = action.payload;
             const runRulesForEditSingleEventPromise = runRulesForEditSingleEvent({
                 store,
                 dataEntryId,
                 itemId,
                 uid,
-                orgUnit,
                 programId,
                 querySingleResource,
             });
@@ -139,7 +141,7 @@ export const runRulesOnUpdateFieldForEditSingleEventEpic = (
     store: ReduxStore,
     { querySingleResource }: ApiUtils,
 ) =>
-// $FlowSuppress
+    // $FlowSuppress
     action$.pipe(
         ofType(editEventDataEntryBatchActionTypes.UPDATE_FIELD_EDIT_SINGLE_EVENT_ACTION_BATCH),
         map(actionBatch =>
@@ -153,7 +155,6 @@ export const runRulesOnUpdateFieldForEditSingleEventEpic = (
                 dataEntryId,
                 itemId,
                 uid,
-                orgUnit,
                 programId,
             } = action.payload;
             const fieldData: FieldData = {
@@ -166,7 +167,6 @@ export const runRulesOnUpdateFieldForEditSingleEventEpic = (
                 dataEntryId,
                 itemId,
                 uid,
-                orgUnit,
                 fieldData,
                 programId,
                 querySingleResource,

src/core_modules/capture-core/components/WidgetEventEdit/EditEventDataEntry/EditEventDataEntry.component.js

@@ -33,6 +33,7 @@ import {
     withDefaultFieldContainer,
     withDefaultShouldUpdateInterface,
     VirtualizedSelectField,
+    SingleOrgUnitSelectField,
 } from '../../FormFields/New';
 import { statusTypes, translatedStatusTypes } from '../../../events/statusTypes';
 import labelTypeClasses from '../DataEntry/dataEntryFieldLabels.module.css';
@@ -48,6 +49,7 @@ import {
     withDataEntryFields,
 } from '../../DataEntryDhis2Helpers/';
 import type { UserFormField } from '../../FormFields/UserField';
+import { getOrgUnitValidatorContainers } from '../DataEntry/fieldValidators';
 
 const tabMode = Object.freeze({
     REPORT: 'REPORT',
@@ -197,6 +199,47 @@ const buildScheduleDateSettingsFn = () => {
     return scheduleDateSettings;
 };
 
+const buildOrgUnitSettingsFn = () => {
+    const orgUnitComponent =
+        withCalculateMessages(overrideMessagePropNames)(
+            withFocusSaver()(
+                withDefaultFieldContainer()(
+                    withDefaultShouldUpdateInterface()(
+                        withLabel({
+                            onGetUseVerticalOrientation: (props: Object) => props.formHorizontal,
+                            onGetCustomFieldLabeClass: (props: Object) =>
+                                `${props.fieldOptions.fieldLabelMediaBasedClass} ${labelTypeClasses.dateLabel}`,
+                        })(
+                            withDisplayMessages()(
+                                withInternalChangeHandler()(
+                                    withFilterProps(defaultFilterProps)(SingleOrgUnitSelectField),
+                                ),
+                            ),
+                        ),
+                    ),
+                ),
+            ),
+        );
+
+    const orgUnitSettings = {
+        getComponent: () => orgUnitComponent,
+        getComponentProps: (props: Object) => createComponentProps(props, {
+            width: props && props.formHorizontal ? 150 : 350,
+            label: i18n.t('Organisation unit'),
+            required: true,
+        }),
+        getPropName: () => 'orgUnit',
+        getValidatorContainers: () => getOrgUnitValidatorContainers(),
+        getMeta: () => ({
+            placement: placements.TOP,
+            section: dataEntrySectionNames.BASICINFO,
+        }),
+    };
+
+    return orgUnitSettings;
+};
+
+
 const pointComponent = withCalculateMessages(overrideMessagePropNames)(
     withFocusSaver()(
         withDefaultFieldContainer()(
@@ -359,7 +402,8 @@ const saveHandlerConfig = {
 const AOCFieldBuilderHOC = withAOCFieldBuilder({})(withDataEntryFields(getCategoryOptionsSettingsFn())(DataEntry));
 const CleanUpHOC = withCleanUp()(AOCFieldBuilderHOC);
 const GeometryField = withDataEntryFieldIfApplicable(buildGeometrySettingsFn())(CleanUpHOC);
-const ScheduleDateField = withDataEntryField(buildScheduleDateSettingsFn())(GeometryField);
+const OrgUnitField = withDataEntryField(buildOrgUnitSettingsFn())(GeometryField);
+const ScheduleDateField = withDataEntryField(buildScheduleDateSettingsFn())(OrgUnitField);
 const ReportDateField = withDataEntryField(buildReportDateSettingsFn())(ScheduleDateField);
 const SaveableDataEntry = withSaveHandler(saveHandlerConfig)(withMainButton()(ReportDateField));
 const CancelableDataEntry = withCancelButton(getCancelOptions)(SaveableDataEntry);

src/core_modules/capture-core/components/WidgetEventEdit/EditEventDataEntry/editEventDataEntry.epics.js

@@ -121,6 +121,7 @@ export const saveEditedEventEpic = (action$: InputObservable, store: ReduxStore,
             const serverData = {
                 events: [{
                     ...mainDataServerValues,
+                    orgUnit: mainDataServerValues.orgUnit.id,
                     attributeOptionCombo: undefined,
                     dataValues: formFoundation
                         .getElements()

src/core_modules/capture-core/components/WidgetEventEdit/ViewEventDataEntry/ViewEventDataEntry.component.js

@@ -150,7 +150,7 @@ const buildOrgUnitSettingsFn = () => {
             label: i18n.t('Organisation unit'),
             valueConverter: value => dataElement.convertValue(value, valueConvertFn),
         }),
-        getPropName: () => 'orgUnitId',
+        getPropName: () => 'orgUnit',
         getMeta: () => ({
             placement: placements.TOP,
             section: dataEntrySectionNames.BASICINFO,

src/core_modules/capture-core/components/WidgetEventEdit/ViewEventDataEntry/viewEventDataEntry.actions.js

@@ -67,15 +67,15 @@ export const loadViewEventDataEntry =
                 type: 'DATE',
                 validatorContainers: getEventDateValidatorContainers(),
             },
-            {
-                id: 'orgUnitId',
-                type: 'ORGANISATION_UNIT',
-                validatorContainers: getOrgUnitValidatorContainers(),
-            },
             {
                 id: 'scheduledAt',
                 type: 'DATE',
             },
+            {
+                id: 'orgUnit',
+                type: 'ORGANISATION_UNIT',
+                validatorContainers: getOrgUnitValidatorContainers(),
+            },
             {
                 clientId: 'geometry',
                 dataEntryId: 'geometry',
@@ -118,6 +118,11 @@ export const loadViewEventDataEntry =
             dataEntryPropsToInclude.push(...Object.keys(attributeCategoryOptions).map(id => ({ id, type: 'TEXT' })));
         }
 
+        const clientValuesForDataEntry = {
+            ...eventContainer.event,
+            orgUnit: { id: orgUnit.id, name: orgUnit.name, path: orgUnit.path },
+        };
+
         const extraProps = {
             eventId: eventContainer.event.eventId,
         };
@@ -126,7 +131,7 @@ export const loadViewEventDataEntry =
         loadEditDataEntryAsync(
             dataEntryId,
             dataEntryKey,
-            eventContainer.event,
+            clientValuesForDataEntry,
             eventContainer.values,
             dataEntryPropsToInclude,
             foundation,
@@ -163,7 +168,6 @@ export const loadViewEventDataEntry =
             });
         }
         const filteredEffects = filterApplicableRuleEffects(effects, effectActions.ASSIGN_VALUE);
-
         return [
             ...dataEntryActions,
             updateRulesEffects(filteredEffects, formId),