feat: [DHIS2-12362][DHIS2-12455] View and filter relationships #3241

eirikhaugstulen · 2023-05-02T14:07:26Z

This PR builds on the work of @jasminenguyennn and @JoakimSM.

Add a TrackedEntity relationships widget in the enrollment pages.

TL;DR:

Added self contained widget that fetches relationships and metadata required
Also able to pass in cached relationshiptypes (if so, no metadata will be fetched in the widget)
Creates portal to ref when adding new relationship

…ationship/DHIS2-12455_ListApplicableRelationshipTypes # Conflicts: # i18n/en.pot # src/core_modules/capture-core/components/Pages/Enrollment/EnrollmentPageDefault/EnrollmentPageDefault.container.js

…ationship/DHIS2-12455_ListApplicableRelationshipTypes # Conflicts: # i18n/en.pot

# Conflicts: # i18n/en.pot # src/core_modules/capture-core/components/Pages/Enrollment/EnrollmentPageDefault/EnrollmentPageDefault.component.js # src/core_modules/capture-core/components/Pages/Enrollment/EnrollmentPageDefault/EnrollmentPageDefault.types.js # src/core_modules/capture-core/components/Pages/EnrollmentEditEvent/EnrollmentEditEventPage.container.js

eirikhaugstulen · 2023-05-03T07:22:37Z

src/components/App/AppPages.component.js

-        <Route path="/" component={MainPage} />
-    </Switch>
+    <>
+        <ReactQueryDevtools />


Not sure if or where we want this, bit helps a lot during review and development to see the caching strategy.

eirikhaugstulen · 2023-05-03T08:10:59Z

...re_modules/capture-core/components/WidgetsRelationship/common/hooks/useLinkedEntityGroups.js

+import { useCallback, useEffect, useState } from 'react';
+import log from 'loglevel';
+import moment from 'moment';
+import { errorCreator } from 'capture-core-utils';


Can we use deps from our internal repo?

errorCreator is already used by other self-contained widgets. It looks like an easy function to re-rewrite, so maybe we can move it inside each widget?

This is fine @eirikhaugstulen. Helpers from capture-core-utils will have to be available to Widget library is some way.

eirikhaugstulen · 2023-05-03T08:28:34Z

src/core_modules/capture-core/reducers/descriptions/organisationUnits.reducerDescription.js

-}, 'organisationUnitRoots');
+}, 'organisationUnitRoots2222');


Was this introduced by something you thought of @JoakimSM? Do we keep it?

This looks like a typo to me

eirikhaugstulen · 2023-05-03T08:30:14Z

src/core_modules/capture-core/utils/reactQueryHelpers/query/useApiDataQuery.js

+            staleTime: 4 * 60 * 1000,
+            cacheTime: 10 * 60 * 1000,


What do we think is a sensible amount here?

eirikhaugstulen · 2023-05-03T08:31:11Z

src/core_modules/capture-core/utils/reactQueryHelpers/query/useMetadataQuery.js

+        cacheTime: Infinity,
+        staleTime: Infinity,


When do we want to refetch metadata from the API?

I think Infinity is fine.

simonadomnisoru · 2023-05-05T14:58:16Z

src/core_modules/capture-core/reducers/descriptions/organisationUnits.reducerDescription.js

-}, 'organisationUnitRoots');
+}, 'organisationUnitRoots2222');


This looks like a typo to me

...ore/components/WidgetsRelationship/common/AddNewRelationship/AddNewRelationship.component.js

simonadomnisoru · 2023-05-05T14:59:05Z

...kedEntityRelationship/NewTrackedEntityRelationship/NewTrackedEntityRelationship.component.js

+                    <Breadcrumbs
+                        currentStep={currentStep}
+                        onNavigate={handleNavigation}
+                        linkedEntityMetadataName={selectedLinkedEntityMetadata?.name}


Hey,
Does it make sense to add a fallback when the selectedLinkedEntityMetadata?.name is undefined?

Thanks!

simonadomnisoru · 2023-05-05T14:59:33Z

...idgetTrackedEntityRelationship/NewTrackedEntityRelationship/Breadcrumbs/breadcrumbs.types.js

+export type Props = {|
+    currentStep: $Values<typeof NEW_TRACKED_ENTITY_RELATIONSHIP_WIZARD_STEPS>,
+    onNavigate: ($Values<typeof NEW_TRACKED_ENTITY_RELATIONSHIP_WIZARD_STEPS>) => void,
+    linkedEntityMetadataName?: string,


Hey,
IMHO linkedEntityMetadataName should not accept null or undefined values to avoid showing empty links. How about changing the type to linkedEntityMetadataName: string instead? WDYT?

Hey @simonadomnisoru,
Yes, completely agree that we should have a fallback here. The reason it's null or undefined is just because of Flow I think as it could be undefined if currentStep === 0. Just to clarify, I'm guessing that the image you provided is a bug and that we should fallback to displayName here. Therefore, it would never actually be undefined. One fallback we could add however is to not show anything after New TEI Relationship if the name is undefined. Then it's no longer a breadcrumb, but a label of the widget. WDYT?

Agreed, fallback to displayName in useApplicableTypesAndSides (Probably empty because toFromName is not required in the metadata)

...tTrackedEntityRelationship/NewTrackedEntityRelationship/Breadcrumbs/Breadcrumbs.component.js

simonadomnisoru · 2023-05-05T15:39:20Z

...re_modules/capture-core/components/WidgetsRelationship/common/hooks/useLinkedEntityGroups.js

+import { useCallback, useEffect, useState } from 'react';
+import log from 'loglevel';
+import moment from 'moment';
+import { errorCreator } from 'capture-core-utils';


errorCreator is already used by other self-contained widgets. It looks like an easy function to re-rewrite, so maybe we can move it inside each widget?

JoakimSM · 2023-05-19T12:34:42Z

...PageDefault/TrackedEntityRelationshipsWrapper/TrackedEntityRelationshipsWrapper.component.js

@@ -0,0 +1,47 @@
+// @flow


This file is used from both EnrollmentPageDefault and EnrollmentEditEvent, but resides within EnrollmentPageDefault. Great if we can move it to Pages/common/TEIRelationshipsWidget

JoakimSM · 2023-05-19T13:48:13Z

...mentPageDefault/TrackedEntityRelationshipsWrapper/TrackedEntityRelationshipsWrapper.types.js

+    addRelationshipRenderElement: HTMLDivElement,
+    onOpenAddRelationship: () => void,
+    onCloseAddRelationship: () => void,
+    onLinkedRecordClick: (parameters: Url) => void,


Can we use UrlParameters from capture-core/components/WidgetsRelationship/common/Types/RelationshipData.types.js as the type (instead of Url). This will fix a flow error in TrackedEntityRelationshipsWrapper.component (that you have suppressed)

JoakimSM · 2023-05-23T10:29:16Z

...dules/capture-core/components/Pages/EnrollmentEditEvent/EnrollmentEditEventPage.container.js

    const onGoBack = () =>
        history.push(`/enrollment?${buildUrlQueryString({ enrollmentId })}`);

    const onHandleScheduleSave = (eventData: Object) => {
        dispatch(updateEnrollmentEvents(eventId, eventData));
        history.push(`enrollment?${buildUrlQueryString({ enrollmentId })}`);
    };
-    const enrollmentSite = useCommonEnrollmentDomainData(teiId, enrollmentId, programId).enrollment;
+    const onLinkedRecordClick = (parameters) => {
+        dispatch(clickLinkedRecord(parameters));


clickLinkedRecord should have been moved to TEIRelationshipsWidget, but I'm wondering if we really need an action and an epic here. Can we simply create a reusable function / hook and place that in TEIRelationshipsWidget? (I'm aware you didn't write this, but great if we can fix it)

JoakimSM · 2023-05-23T10:56:51Z

...idgetTrackedEntityRelationship/NewTrackedEntityRelationship/Breadcrumbs/breadcrumbs.types.js

+export type Props = {|
+    currentStep: $Values<typeof NEW_TRACKED_ENTITY_RELATIONSHIP_WIZARD_STEPS>,
+    onNavigate: ($Values<typeof NEW_TRACKED_ENTITY_RELATIONSHIP_WIZARD_STEPS>) => void,
+    linkedEntityMetadataName?: string,


Agreed, fallback to displayName in useApplicableTypesAndSides (Probably empty because toFromName is not required in the metadata)

JoakimSM · 2023-05-23T11:00:48Z

...ship/NewTrackedEntityRelationship/LinkedEntityMetadataSelector/useApplicableTypesAndSides.js

@@ -0,0 +1,170 @@
+// @flow


Did you make major changes in this file? (Blame says Eirik on most of the lines, but probably because of formatting?)

JoakimSM · 2023-05-23T13:38:53Z

...ore_modules/capture-core/components/WidgetsRelationship/common/hooks/useRelationshipTypes.js

+            params: {
+                fields: 'id,displayName,valueType',
+                filter: `id:in:[${Object.keys(attributeIds).join(',')}]`,
+                paging: false,


I'm wondering if we should enable paging here. In this particular case we will probably not get a performance improvement, but I think it is/was best practice to keep the url length < 2000 characters (and there is a limit in the browsers). Can you look into how to enable paging in a generic way (i.e. use useMetadataApiQuery, but have it to the paging for us. In this particular instance we should probably wait for all the pages to be retrieved before emitting the result, but this is not always the case).

JoakimSM · 2023-05-23T13:46:24Z

...ore_modules/capture-core/components/WidgetsRelationship/common/hooks/useRelationshipTypes.js

+            resource: 'trackedEntityAttributes',
+            params: {
+                fields: 'id,displayName,valueType',
+                filter: `id:in:[${Object.keys(attributeIds).join(',')}]`,


if no attributes are found, we should avoid the api request. Might be best to compute the query later?

Not sure I completely understood what you meant here, @JoakimSM. Let's have a chat the next time we speak.

JoakimSM · 2023-05-23T14:21:29Z

src/core_modules/capture-core/components/WidgetsRelationship/common/hooks/useRelationships.js

@@ -0,0 +1,31 @@
+// @flow
+import { useMemo } from 'react';
+import { useApiDataQuery } from '../../../../utils/reactQueryHelpers/query/useApiDataQuery';


NIT 1: maybe we can simplify the url here like we do for useMetadataApiQuery?
NIT 2: I agree useApiDataQuery is better than useDataApiQuery. Can you change useMetadataApiQuery (and useMetadataCustomQuery) to use the same "format" (useApiMetadataQuery etc)?

JoakimSM · 2023-05-23T14:40:11Z

...re_modules/capture-core/components/WidgetsRelationship/common/hooks/useLinkedEntityGroups.js

+import { useCallback, useEffect, useState } from 'react';
+import log from 'loglevel';
+import moment from 'moment';
+import { errorCreator } from 'capture-core-utils';


This is fine @eirikhaugstulen. Helpers from capture-core-utils will have to be available to Widget library is some way.

JoakimSM · 2023-05-25T09:39:48Z

src/core_modules/capture-core/utils/reactQueryHelpers/query/useMetadataQuery.js

+        cacheTime: Infinity,
+        staleTime: Infinity,


I think Infinity is fine.

…_ViewRelationships # Conflicts: # i18n/en.pot

eirikhaugstulen · 2023-05-26T08:58:31Z

Thanks for the reviews, @simonadomnisoru & @JoakimSM. Should be updated now 👍

simonadomnisoru

Hey @eirikhaugstulen,
I get TypeError: trackedEntityType.name is undefined when clicking the New Relationship button. Can you have a look?

Screen.Recording.2023-05-31.at.09.09.03.mov

Thanks!

simonadomnisoru · 2023-06-22T13:21:38Z

src/core_modules/capture-core/components/WidgetsRelationship/common/Types/index.js

Should the folder Types name start with lowercase instead?

simonadomnisoru · 2023-06-22T13:26:49Z

...core/components/WidgetsRelationship/common/RelationshipsWidget/linkedEntitiesViewer.types.js

Does it make sense to move this file, as well as the rest of the *.types.js from this folder to the RelationshipsWidget/types folder? Thank you!

…_ViewRelationships # Conflicts: # i18n/en.pot # src/core_modules/capture-core/components/Pages/EnrollmentEditEvent/EnrollmentEditEventPage.component.js # src/core_modules/capture-core/components/Pages/EnrollmentEditEvent/EnrollmentEditEventPage.container.js

github-actions · 2023-07-25T13:39:59Z

🚀 Deployed on https://deploy-preview-3241--dhis2-capture.netlify.app

jasminenguyennn and others added 30 commits January 21, 2022 07:58

feat: [DHIS2-12362] add widget relationship component

ac4b6fe

feat: first draft to New TEI relationship

7d9f3de

feat: [DHIS2-12362] add relationship widget

07b42fa

feat: [DHIS2-12362] compute tei data

c85b9d0

feat: [DHIS2-12362] add relationship in redux

11a2bf7

feat: [DHIS2-12362] minor change

9362c1a

Merge remote-tracking branch 'origin/master' into eh/feat/new-tei-rel…

f15bf33

…ationship/DHIS2-12455_ListApplicableRelationshipTypes # Conflicts: # i18n/en.pot # src/core_modules/capture-core/components/Pages/Enrollment/EnrollmentPageDefault/EnrollmentPageDefault.container.js

feat: first draft to new TEI relationshiphandler

addbe06

fix: add constraint to state

98445b7

Merge branch 'master' into DHIS2-12362

e944f77

fix: [DHIS2-12362] minor update

748fecc

fix: [DHIS2-12362] minor update

56c568b

fix: [DHIS2-12362] add event relationshio

6b6d0dd

fix: [DHIS2-12362] update tet

2fb5620

chore: [DHIS2-12362] cleanup fromconstraint

279f639

fix: [DHIS2-12362] fix flow

d8a1e89

fix: [DHIS2-12362] fix flow

6ff4edb

fix: [DHIS2-12362] fix flow

fd5c535

fix: [DHIS2-12362] fix flow

5faa3e1

fix: [DHIS2-12362] minor fix

65b9ecc

fix: [DHIS2-12362] minor fix

a9492bd

fix: [DHIS2-12362] minor fix

6650036

Merge branch 'master' into DHIS2-12362

8f3a652

chore: [DHIS2-12362] update relationships

02a2802

chore: [DHIS2-12362] update relationships

e9b4a70

fix: [DHIS2-12362] fix flow

eb7239d

feat: [DHIS2-12362] add relationship to view enrollment event

ffb7b2f

Merge remote-tracking branch 'origin/master' into eh/feat/new-tei-rel…

4abf6ef

…ationship/DHIS2-12455_ListApplicableRelationshipTypes # Conflicts: # i18n/en.pot

fix: changed object for displaying relationships & breadcrumbs

d0b115d

feat: initial layout for linking relationship to existing TEI

d88383a

JoakimSM and others added 7 commits April 18, 2023 11:36

feat: continue relationships

67b827a

Merge branch 'master' into DHIS2-12615

bc15dc4

fix: postmerge

1e76f2f

chore: temp

dc5b88d

feat: first iteration of Relationships Widget

43a9c57

fix: code cleanup

7685ec3

eirikhaugstulen commented May 3, 2023

View reviewed changes

eirikhaugstulen marked this pull request as ready for review May 3, 2023 08:37

eirikhaugstulen requested a review from a team as a code owner May 3, 2023 08:37

simonadomnisoru reviewed May 5, 2023

View reviewed changes

chore: review comments

c3331c8

JoakimSM reviewed May 25, 2023

View reviewed changes

eirikhaugstulen added 2 commits May 26, 2023 10:54

chore: review comments

518456a

Merge remote-tracking branch 'origin/master' into eh/feat/DHIS2-12362…

4ad1bea

…_ViewRelationships # Conflicts: # i18n/en.pot

eirikhaugstulen mentioned this pull request May 30, 2023

feat: [DHIS2-12362] TEI relationship #2497

Closed

simonadomnisoru reviewed May 31, 2023

View reviewed changes

feat: [DHIS2-12362] display relationships

5c49e06

simonadomnisoru reviewed Jun 22, 2023

View reviewed changes

eirikhaugstulen added 2 commits July 25, 2023 11:21

fix: flow

ce6cf2f

eirikhaugstulen changed the base branch from master to eh/epics/DHIS2-12361_TeiRelationshipWidget July 25, 2023 13:36

eirikhaugstulen added the testing label Jul 25, 2023

chore: revert merge conflict

19deb4b

eirikhaugstulen added testing and removed testing labels Jul 25, 2023

eirikhaugstulen merged commit 438d2cd into eh/epics/DHIS2-12361_TeiRelationshipWidget Jul 28, 2023

eirikhaugstulen deleted the eh/feat/DHIS2-12362_ViewRelationships branch July 28, 2023 09:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: [DHIS2-12362][DHIS2-12455] View and filter relationships #3241

feat: [DHIS2-12362][DHIS2-12455] View and filter relationships #3241

eirikhaugstulen commented May 2, 2023 •

edited

Loading

eirikhaugstulen May 3, 2023

eirikhaugstulen May 3, 2023

simonadomnisoru May 5, 2023

JoakimSM May 23, 2023

eirikhaugstulen May 3, 2023

simonadomnisoru May 5, 2023

eirikhaugstulen May 3, 2023

eirikhaugstulen May 3, 2023

JoakimSM May 25, 2023

simonadomnisoru May 5, 2023

simonadomnisoru May 5, 2023

simonadomnisoru May 5, 2023

eirikhaugstulen May 23, 2023

JoakimSM May 23, 2023

simonadomnisoru May 5, 2023

JoakimSM May 19, 2023

JoakimSM May 19, 2023

JoakimSM May 23, 2023

JoakimSM May 23, 2023

JoakimSM May 23, 2023

JoakimSM May 23, 2023

JoakimSM May 23, 2023

eirikhaugstulen May 26, 2023

JoakimSM May 23, 2023

JoakimSM May 23, 2023

JoakimSM May 25, 2023

eirikhaugstulen commented May 26, 2023

simonadomnisoru left a comment

simonadomnisoru Jun 22, 2023

simonadomnisoru Jun 22, 2023

github-actions bot commented Jul 25, 2023 •

edited

Loading

		}, 'organisationUnitRoots');
		}, 'organisationUnitRoots2222');

feat: [DHIS2-12362][DHIS2-12455] View and filter relationships #3241

feat: [DHIS2-12362][DHIS2-12455] View and filter relationships #3241

Conversation

eirikhaugstulen commented May 2, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eirikhaugstulen commented May 26, 2023

simonadomnisoru left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Jul 25, 2023 • edited Loading

eirikhaugstulen commented May 2, 2023 •

edited

Loading

github-actions bot commented Jul 25, 2023 •

edited

Loading