refactor: [TECH-1657] standardize format of redux orgunits (#3436)

cypress/e2e/WidgetsForEnrollmentPages/WidgetsForEnrollmentAddEventPage.feature

@@ -16,13 +16,16 @@ Feature: The user interacts with the widgets on the enrollment add event page
 
   Scenario: User can close the Enrollment Widget
     Given you land on the enrollment add event page by having typed #/enrollmentEventNew?programId=IpHINAT79UW&orgUnitId=DiszpKrYNg8&teiId=EaOyKGOIGRp&enrollmentId=wBU0RAsYjKE&stageId=A03MvHHogjR
+    And the enrollment widget should be opened
     When you click the enrollment widget toggle open close button
     Then the enrollment widget should be closed
 
   Scenario: User can close and reopen the Enrollment Widget
     Given you land on the enrollment add event page by having typed #/enrollmentEventNew?programId=IpHINAT79UW&orgUnitId=DiszpKrYNg8&teiId=EaOyKGOIGRp&enrollmentId=wBU0RAsYjKE&stageId=A03MvHHogjR
+    And the enrollment widget should be opened
+    When you click the enrollment widget toggle open close button
+    Then the enrollment widget should be closed
     When you click the enrollment widget toggle open close button
-    And you click the enrollment widget toggle open close button
     Then the enrollment widget should be opened
 
   Scenario: User can see the enrollment details

cypress/e2e/WidgetsForEnrollmentPages/WidgetsForEnrollmentDashboard.feature

@@ -48,13 +48,16 @@ Feature: The user interacts with the widgets on the enrollment dashboard
 
   Scenario: User can close the Enrollment Widget
     Given you land on the enrollment dashboard page by having typed #/enrollment?enrollmentId=wBU0RAsYjKE
+    And the enrollment widget should be opened
     When you click the enrollment widget toggle open close button
     Then the enrollment widget should be closed
 
   Scenario: User can close and reopen the Enrollment Widget
     Given you land on the enrollment dashboard page by having typed #/enrollment?enrollmentId=wBU0RAsYjKE
+    And the enrollment widget should be opened
+    When you click the enrollment widget toggle open close button
+    Then the enrollment widget should be closed
     When you click the enrollment widget toggle open close button
-    And you click the enrollment widget toggle open close button
     Then the enrollment widget should be opened
 
   Scenario: User can see the enrollment details

cypress/e2e/WidgetsForEnrollmentPages/WidgetsForEnrollmentEditEvent.feature

@@ -16,13 +16,16 @@ Feature: The user interacts with the widgets on the enrollment edit event
 
   Scenario: User can close the Enrollment Widget
     Given you land on the enrollment edit event page by having typed /#/enrollmentEventEdit?eventId=XGLkLlOXgmE&orgUnitId=DiszpKrYNg8
+    And the enrollment widget should be opened
     When you click the enrollment widget toggle open close button
     Then the enrollment widget should be closed
 
   Scenario: User can close and reopen the Enrollment Widget
     Given you land on the enrollment edit event page by having typed /#/enrollmentEventEdit?eventId=XGLkLlOXgmE&orgUnitId=DiszpKrYNg8
+    And the enrollment widget should be opened
+    When you click the enrollment widget toggle open close button
+    Then the enrollment widget should be closed
     When you click the enrollment widget toggle open close button
-    And you click the enrollment widget toggle open close button
     Then the enrollment widget should be opened
 
   Scenario: User can see the enrollment details

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

@@ -141,12 +141,12 @@ export type OrgUnitGroup = $ReadOnly<{|
     code: string,
 |}>;
 
-export type OrgUnit = $ReadOnly<{|
+export type OrgUnit = $ReadOnly<{
     id: string,
     name: string,
     code: string,
     groups: Array<OrgUnitGroup>,
-|}>;
+}>;
 
 export type RulesEngineInput = {|
     programRulesContainer: ProgramRulesContainer,

src/core_modules/capture-core/components/DataEntries/EnrollmentRegistrationEntry/EnrollmentRegistrationEntry.container.js

@@ -5,7 +5,7 @@ import { useSelector } from 'react-redux';
 import { EnrollmentRegistrationEntryComponent } from './EnrollmentRegistrationEntry.component';
 import type { OwnProps } from './EnrollmentRegistrationEntry.types';
 import { useLifecycle } from './hooks';
-import { useRulesEngineOrgUnit } from '../../../hooks';
+import { useCoreOrgUnit } from '../../../metadataRetrieval/coreOrgUnit';
 import { dataEntryHasChanges } from '../../DataEntry/common/dataEntryHasChanges';
 import {
     useBuildEnrollmentPayload,
@@ -21,7 +21,7 @@ export const EnrollmentRegistrationEntry: ComponentType<OwnProps> = ({
     onSave,
     ...passOnProps
 }) => {
-    const { orgUnit, error } = useRulesEngineOrgUnit(orgUnitId);
+    const { orgUnit, error } = useCoreOrgUnit(orgUnitId);
     const {
         ready,
         skipDuplicateCheck,

src/core_modules/capture-core/components/DataEntries/SingleEventRegistrationEntry/DataEntryWrapper/NewEventDataEntryWrapper.component.js

@@ -7,7 +7,7 @@ import { DataEntry } from './DataEntry/DataEntry.container';
 import { EventsList } from './RecentlyAddedEventsList/RecentlyAddedEventsList.container';
 import { useScopeTitleText } from '../../../../hooks/useScopeTitleText';
 import { useCurrentProgramInfo } from '../../../../hooks/useCurrentProgramInfo';
-import { useRulesEngineOrgUnit } from '../../../../hooks/useRulesEngineOrgUnit';
+import { useCoreOrgUnit } from '../../../../metadataRetrieval/coreOrgUnit';
 import { useLocationQuery } from '../../../../utils/routing';
 import { useRulesEngine } from './useRulesEngine';
 import type { PlainProps } from './NewEventDataEntryWrapper.types';
@@ -48,7 +48,7 @@ const NewEventDataEntryWrapperPlain = ({
 }: PlainProps) => {
     const { id: programId } = useCurrentProgramInfo();
     const orgUnitId = useLocationQuery().orgUnitId;
-    const { orgUnit, error } = useRulesEngineOrgUnit(orgUnitId);
+    const { orgUnit, error } = useCoreOrgUnit(orgUnitId);
     const rulesReady = useRulesEngine({ programId, orgUnit, formFoundation });
     const titleText = useScopeTitleText(programId);
 

src/core_modules/capture-core/components/DataEntries/TeiRegistrationEntry/TeiRegistrationEntry.component.js

@@ -8,7 +8,8 @@ import { useHistory } from 'react-router-dom';
 import { useScopeInfo } from '../../../hooks/useScopeInfo';
 import { scopeTypes } from '../../../metaData';
 import { TrackedEntityInstanceDataEntry } from '../TrackedEntityInstance';
-import { useCurrentOrgUnitInfo } from '../../../hooks/useCurrentOrgUnitInfo';
+import { useCurrentOrgUnitId } from '../../../hooks/useCurrentOrgUnitId';
+import { useCoreOrgUnit } from '../../../metadataRetrieval/coreOrgUnit';
 import type { Props, PlainProps } from './TeiRegistrationEntry.types';
 import { DiscardDialog } from '../../Dialogs/DiscardDialog.component';
 import { withSaveHandler } from '../../DataEntry';
@@ -54,7 +55,9 @@ const TeiRegistrationEntryPlain =
       const [showWarning, setShowWarning] = useState(false);
       const { scopeType } = useScopeInfo(selectedScopeId);
       const { formId, formFoundation } = useMetadataForRegistrationForm({ selectedScopeId });
-      const orgUnit = useCurrentOrgUnitInfo();
+      const orgUnitId = useCurrentOrgUnitId();
+      const { orgUnit } = useCoreOrgUnit(orgUnitId); // Tony: [DHIS2-15814] Change this to new hook
+      const orgUnitName = orgUnit ? orgUnit.name : '';
 
       const handleOnCancel = () => {
           if (!isUserInteractionInProgress) {
@@ -68,9 +71,9 @@ const TeiRegistrationEntryPlain =
           const url =
             scopeType === scopeTypes.TRACKER_PROGRAM
                 ?
-                buildUrlQueryString({ programId: selectedScopeId, orgUnitId: orgUnit.id })
+                buildUrlQueryString({ programId: selectedScopeId, orgUnitId })
                 :
-                buildUrlQueryString({ orgUnitId: orgUnit.id });
+                buildUrlQueryString({ orgUnitId });
           return push(`/?${url}`);
       };
 
@@ -79,9 +82,8 @@ const TeiRegistrationEntryPlain =
               {
                   scopeType === scopeTypes.TRACKED_ENTITY_TYPE && formId &&
                   <>
-                      {/* $FlowFixMe */}
                       <TrackedEntityInstanceDataEntry
-                          orgUnit={orgUnit}
+                          orgUnitId={orgUnitId}
                           formFoundation={formFoundation}
                           trackedEntityTypeId={selectedScopeId}
                           teiRegistrationMetadata={teiRegistrationMetadata}
@@ -114,7 +116,7 @@ const TeiRegistrationEntryPlain =
                           </Button>
                       </div>
                       <InfoIconText>
-                          {translatedTextWithStylesForTei(trackedEntityName.toLowerCase(), orgUnit.name)}
+                          {translatedTextWithStylesForTei(trackedEntityName.toLowerCase(), orgUnitName)}
                       </InfoIconText>
 
                       <DiscardDialog

src/core_modules/capture-core/components/DataEntries/TrackedEntityInstance/TrackedEntityInstanceDataEntry.component.js

@@ -42,7 +42,7 @@ class PreTeiDataEntryPure extends React.PureComponent<Object> {
 }
 
 type PreTeiDataEntryProps = {
-    orgUnit: Object,
+    orgUnitId: string,
     trackedEntityTypeId: string,
     onUpdateField: Function,
     onStartAsyncUpdateField: Function,
@@ -52,17 +52,17 @@ type PreTeiDataEntryProps = {
 
 export class PreTeiDataEntry extends React.Component<PreTeiDataEntryProps> {
     getValidationContext = () => {
-        const { orgUnit, onGetUnsavedAttributeValues, trackedEntityTypeId } = this.props;
+        const { orgUnitId, onGetUnsavedAttributeValues, trackedEntityTypeId } = this.props;
         return {
             trackedEntityTypeId,
-            orgUnitId: orgUnit.id,
+            orgUnitId,
             onGetUnsavedAttributeValues,
         };
     }
 
     render() {
         const {
-            orgUnit,
+            orgUnitId,
             trackedEntityTypeId,
             onUpdateField,
             onStartAsyncUpdateField,

src/core_modules/capture-core/components/LockedSelector/LockedSelector.actions.js

@@ -1,5 +1,6 @@
 // @flow
 import { actionCreator } from '../../actions/actions.utils';
+import type { CoreOrgUnit } from '../../metadataRetrieval/coreOrgUnit';
 
 export const lockedSelectorActionTypes = {
     LOADING_START: 'LockedSelector.Loading',
@@ -17,7 +18,7 @@ export const lockedSelectorActionTypes = {
 export const updateSelectionsFromUrl = (data: Object) => actionCreator(lockedSelectorActionTypes.FROM_URL_UPDATE)(data);
 export const validSelectionsFromUrl = () => actionCreator(lockedSelectorActionTypes.FROM_URL_CURRENT_SELECTIONS_VALID)();
 export const invalidSelectionsFromUrl = (error: string) => actionCreator(lockedSelectorActionTypes.FROM_URL_CURRENT_SELECTIONS_INVALID)({ error });
-export const setCurrentOrgUnitBasedOnUrl = (orgUnit: Object) => actionCreator(lockedSelectorActionTypes.FETCH_ORG_UNIT_SUCCESS)(orgUnit);
+export const setCurrentOrgUnitBasedOnUrl = (orgUnit: CoreOrgUnit) => actionCreator(lockedSelectorActionTypes.FETCH_ORG_UNIT_SUCCESS)(orgUnit);
 export const startLoading = () => actionCreator(lockedSelectorActionTypes.LOADING_START)();
 export const completeUrlUpdate = () => actionCreator(lockedSelectorActionTypes.FROM_URL_UPDATE_COMPLETE)();
 export const errorRetrievingOrgUnitBasedOnUrl = (error: string) => actionCreator(lockedSelectorActionTypes.FETCH_ORG_UNIT_ERROR)({ error });

src/core_modules/capture-core/components/LockedSelector/LockedSelector.epics.js

@@ -1,8 +1,8 @@
 // @flow
 import i18n from '@dhis2/d2-i18n';
 import { ofType } from 'redux-observable';
-import { catchError, filter, flatMap, map, startWith, switchMap } from 'rxjs/operators';
-import { from, of } from 'rxjs';
+import { filter, map, concatMap } from 'rxjs/operators';
+import { of } from 'rxjs';
 import {
     lockedSelectorActionTypes,
     invalidSelectionsFromUrl,
@@ -16,32 +16,25 @@ import {
 import { programCollection } from '../../metaDataMemoryStores';
 import { getLocationPathname, pageFetchesOrgUnitUsingTheOldWay } from '../../utils/url';
 import { getLocationQuery } from '../../utils/routing';
+import { getCoreOrgUnit } from '../../metadataRetrieval/coreOrgUnit';
 
-const orgUnitsQuery = id => ({ resource: 'organisationUnits', id });
-
-export const getOrgUnitDataBasedOnUrlUpdateEpic = (
-    action$: InputObservable,
-    store: ReduxStore,
-    { querySingleResource }: ApiUtils) =>
+export const getOrgUnitDataBasedOnUrlUpdateEpic = (action$: InputObservable, store: ReduxStore) =>
     action$.pipe(
         ofType(lockedSelectorActionTypes.FROM_URL_UPDATE),
         filter(action => action.payload.nextProps.orgUnitId),
-        switchMap((action) => {
+        concatMap((action) => {
             const { organisationUnits } = store.value;
             const { orgUnitId } = action.payload.nextProps;
             if (organisationUnits[orgUnitId]) {
                 return of(completeUrlUpdate());
             }
-            return from(querySingleResource(orgUnitsQuery(action.payload.nextProps.orgUnitId)))
-                .pipe(
-                    flatMap(response =>
-                        of(setCurrentOrgUnitBasedOnUrl({ id: response.id, name: response.displayName, code: response.code }))),
-                    catchError(() =>
-                        of(errorRetrievingOrgUnitBasedOnUrl(i18n.t('Could not get organisation unit')))),
-                    startWith(startLoading()),
-                );
-        },
-        ));
+            return of(startLoading(), getCoreOrgUnit({
+                orgUnitId,
+                onSuccess: setCurrentOrgUnitBasedOnUrl,
+                onError: () => errorRetrievingOrgUnitBasedOnUrl(i18n.t('Could not get organisation unit')),
+            }));
+        }),
+    );
 
 export const setOrgUnitDataEmptyBasedOnUrlUpdateEpic = (action$: InputObservable) =>
     action$.pipe(
@@ -76,4 +69,3 @@ export const validateSelectionsBasedOnUrlUpdateEpic = (action$: InputObservable)
 
             return validSelectionsFromUrl();
         }));
-

src/core_modules/capture-core/components/OrgUnitFetcher/OrgUnitFetcher.actions.js

@@ -1,6 +1,7 @@
 // @flow
 
 import { actionCreator } from '../../actions/actions.utils';
+import type { CoreOrgUnit } from '../../metadataRetrieval/coreOrgUnit';
 
 export const actionTypes = {
     FETCH_ORG_UNIT: 'OrgUnitFetcher.FetchOrgUnit',
@@ -11,6 +12,6 @@ export const actionTypes = {
 export const fetchOrgUnit = (orgUnitId: string) =>
     actionCreator(actionTypes.FETCH_ORG_UNIT)({ orgUnitId });
 
-export const setCurrentOrgUnit = (orgUnit: Object) => actionCreator(actionTypes.FETCH_ORG_UNIT_SUCCESS)(orgUnit);
+export const setCurrentOrgUnit = (orgUnit: CoreOrgUnit) => actionCreator(actionTypes.FETCH_ORG_UNIT_SUCCESS)(orgUnit);
 
 export const errorRetrievingOrgUnit = () => actionCreator(actionTypes.FETCH_ORG_UNIT_FAILURE)();

src/core_modules/capture-core/components/OrgUnitFetcher/OrgUnitFetcher.component.js

@@ -6,13 +6,7 @@ import { fetchOrgUnit } from './OrgUnitFetcher.actions';
 
 export const OrgUnitFetcher = (({ orgUnitId, children, error }: Object) => {
     const dispatch = useDispatch();
-    const { orgUnit } = useSelector(
-        ({
-            organisationUnits,
-        }) => ({
-            orgUnit: organisationUnits[orgUnitId],
-        }),
-    );
+    const orgUnit = useSelector(({ organisationUnits }) => organisationUnits[orgUnitId]);
 
     useEffect(() => {
         if (!orgUnit && orgUnitId) {

src/core_modules/capture-core/components/OrgUnitFetcher/OrgUnitFetcher.epics.js

@@ -1,17 +1,14 @@
 // @flow
 import { ofType } from 'redux-observable';
-import { catchError, map, switchMap } from 'rxjs/operators';
-import { from, of } from 'rxjs';
+import { map } from 'rxjs/operators';
+import { getCoreOrgUnit } from '../../metadataRetrieval/coreOrgUnit';
 import { actionTypes, setCurrentOrgUnit, errorRetrievingOrgUnit } from './OrgUnitFetcher.actions';
 
-
-const orgUnitsQuery = id => ({ resource: `organisationUnits/${id}` });
-
-export const orgUnitFetcherEpic = (action$: InputObservable, _: ReduxStore, { querySingleResource }: ApiUtils,
-) => action$.pipe(
+export const orgUnitFetcherEpic = (action$: InputObservable) => action$.pipe(
     ofType(actionTypes.FETCH_ORG_UNIT),
-    switchMap(({ payload: { orgUnitId } }) => from(querySingleResource(orgUnitsQuery(orgUnitId)))
-        .pipe(map(({ id, displayName: name }) => setCurrentOrgUnit({ id, name }))))
-    ,
-    catchError(() => of(errorRetrievingOrgUnit())),
+    map(({ payload: { orgUnitId } }) => getCoreOrgUnit({
+        orgUnitId,
+        onSuccess: orgUnit => setCurrentOrgUnit(orgUnit),
+        onError: errorRetrievingOrgUnit,
+    })),
 );

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

@@ -19,7 +19,7 @@ import {
     updateTeiDisplayName,
 } from '../EnrollmentPage.actions';
 import { useTrackerProgram } from '../../../../hooks/useTrackerProgram';
-import { useRulesEngineOrgUnit } from '../../../../hooks/useRulesEngineOrgUnit';
+import { useCoreOrgUnit } from '../../../../metadataRetrieval/coreOrgUnit';
 import { EnrollmentPageDefaultComponent } from './EnrollmentPageDefault.component';
 import {
     useProgramMetadata,
@@ -34,7 +34,7 @@ export const EnrollmentPageDefault = () => {
     const history = useHistory();
     const dispatch = useDispatch();
     const { enrollmentId, programId, teiId, orgUnitId } = useLocationQuery();
-    const { orgUnit, error } = useRulesEngineOrgUnit(orgUnitId);
+    const { orgUnit, error } = useCoreOrgUnit(orgUnitId);
     const { onLinkedRecordClick } = useLinkedRecordClick();
 
     const program = useTrackerProgram(programId);

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

@@ -10,7 +10,7 @@ import { useCommonEnrollmentDomainData, useRuleEffects } from '../../common/Enro
 import type { Props } from './ProgramStageSelector.types';
 import { useProgramFromIndexedDB } from '../../../../utils/cachedDataHooks/useProgramFromIndexedDB';
 import { useLocationQuery, buildUrlQueryString } from '../../../../utils/routing';
-import { useRulesEngineOrgUnit } from '../../../../hooks/useRulesEngineOrgUnit';
+import { useCoreOrgUnit } from '../../../../metadataRetrieval/coreOrgUnit';
 import { useTrackerProgram } from '../../../../hooks/useTrackerProgram';
 
 
@@ -24,7 +24,7 @@ export const ProgramStageSelector = ({ programId, orgUnitId, teiId, enrollmentId
         isError: programError,
     } = useProgramFromIndexedDB(programId);
 
-    const { orgUnit } = useRulesEngineOrgUnit(orgUnitId);
+    const { orgUnit } = useCoreOrgUnit(orgUnitId);
     const programRules = useTrackerProgram(programId);
 
     const ruleEffects = useRuleEffects({

src/core_modules/capture-core/components/Pages/New/RegistrationDataEntry/RegistrationDataEntry.component.js

@@ -15,7 +15,7 @@ import { ResultsPageSizeContext } from '../../shared-contexts';
 import { navigateToEnrollmentOverview } from '../../../../actions/navigateToEnrollmentOverview/navigateToEnrollmentOverview.actions';
 import { useLocationQuery } from '../../../../utils/routing';
 import { EnrollmentRegistrationEntryWrapper } from '../EnrollmentRegistrationEntryWrapper.component';
-import { useCurrentOrgUnitInfo } from '../../../../hooks/useCurrentOrgUnitInfo';
+import { useCurrentOrgUnitId } from '../../../../hooks/useCurrentOrgUnitId';
 
 const getStyles = ({ typography }) => ({
     container: {
@@ -97,7 +97,7 @@ const RegistrationDataEntryPlain = ({
     const { resultsPageSize } = useContext(ResultsPageSizeContext);
     const { scopeType, programName, trackedEntityName } = useScopeInfo(selectedScopeId);
     const titleText = useScopeTitleText(selectedScopeId);
-    const { id: reduxOrgUnitId } = useCurrentOrgUnitInfo();
+    const currentOrgUnitId = useCurrentOrgUnitId();
 
     const handleRegistrationScopeSelection = (id) => {
         setScopeId(id);
@@ -176,7 +176,7 @@ const RegistrationDataEntryPlain = ({
                             <Grid item md sm={9} xs={9} >
                                 <EnrollmentRegistrationEntryWrapper
                                     id={dataEntryId}
-                                    orgUnitId={reduxOrgUnitId}
+                                    orgUnitId={currentOrgUnitId}
                                     teiId={teiId}
                                     selectedScopeId={selectedScopeId}
                                     onSave={onSaveWithEnrollment}
@@ -231,7 +231,7 @@ const RegistrationDataEntryPlain = ({
                                 <TeiRegistrationEntry
                                     id={dataEntryId}
                                     selectedScopeId={selectedScopeId}
-                                    orgUnitId={reduxOrgUnitId}
+                                    orgUnitId={currentOrgUnitId}
                                     saveButtonText={i18n.t('Save {{trackedEntityName}}', {
                                         trackedEntityName,
                                         interpolation: { escapeValue: false },