(feat) O3-3367 Add support for person attributes by CynthiaKamau · Pull Request #423 · openmrs/openmrs-esm-form-engine-lib

CynthiaKamau · 2024-11-19T10:41:17Z

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

Add support for person attributes

Schema :

{
  "name": "New person attributes  form ",
  "pages": [
    {
      "label": "newPage ",
      "sections": [
        {
          "label": "New section",
          "isExpanded": "true",
          "questions": [
            {
              "label": "Person attribute (String)",
              "type": "personAttribute",
              "required": false,
              "id": "bloodTyping",
              "questionOptions": {
                "rendering": "text",
                "attributeType": "8d871d18-c2cc-11de-8d13-0010c6dffd0f"
              }
            },
            {
              "label": "Person attribute (location drop down)",
              "type": "personAttribute",
              "required": false,
              "id": "bloodTyping1",
              "questionOptions": {
                "rendering": "ui-select-extended",
                "attributeType": "8d87236c-c2cc-11de-8d13-0010c6dffd0f"
              },
              "validators": []
            },
            {
              "label": "Person attribute (concept select drop down)",
              "type": "personAttribute",
              "required": false,
              "id": "bloodTyping2",
              "questionOptions": {
                "rendering": "ui-select-extended",
                "concept": "5272AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
                "attributeType": "8d871f2a-c2cc-11de-8d13-0010c6dffd0f"
              },
              "validators": []
            }
          ]
        }
      ]
    }
  ],
  "processor": "EncounterFormProcessor",
  "encounterType": "dd528487-82a5-4082-9c72-ed246bd49591",
  "referencedForms": [],
  "description": "Form that keeps HIV patient data",
  "version": "2.0",
  "uuid": "9478f8b6-0875-4127-b557-f8d844d1bd69"
}

Screenshots

Screen.Recording.2024-11-21.at.13.54.06.mov

Related Issue

Other

github-actions · 2024-11-19T10:44:12Z

Size Change: -265 kB (-17.25%) 👏

Total Size: 1.27 MB

Filename	Size	Change
`dist/524.js`	0 B	-265 kB (removed)	🏆

ℹ️ View Unchanged

Filename	Size	Change
`dist/148.js`	267 kB	0 B
`dist/151.js`	382 kB	0 B
`dist/225.js`	2.58 kB	0 B
`dist/260.js`	114 kB	0 B
`dist/277.js`	11.9 kB	0 B
`dist/300.js`	645 B	0 B
`dist/335.js`	968 B	0 B
`dist/353.js`	3.02 kB	0 B
`dist/41.js`	3.37 kB	0 B
`dist/422.js`	3.05 kB	0 B
`dist/499.js`	2.51 kB	0 B
`dist/540.js`	2.63 kB	0 B
`dist/55.js`	758 B	0 B
`dist/606.js`	2.24 kB	0 B
`dist/635.js`	14.4 kB	0 B
`dist/658.js`	1.85 kB	0 B
`dist/727.js`	87.2 kB	0 B
`dist/979.js`	6.87 kB	0 B
`dist/99.js`	691 B	0 B
`dist/993.js`	3.09 kB	0 B
`dist/main.js`	358 kB	+169 B (+0.05%)
`dist/openmrs-esm-form-engine-lib.js`	3.8 kB	+1 B (+0.03%)

_{compressed-size-action}

ibacher · 2024-11-22T13:04:13Z

So the immediate thing I see here is that we're embedding "format" in the form. I don't really love when we duplicate metadata like this in forms. Just load the format from the backend definition of the attribute type, so we don't face weird issues where changing an attribute type causes forms to break.

src/types/index.ts

src/types/schema.ts

src/adapters/person-attributes-adapter.ts

src/hooks/useFormJson.tsx

samuelmale

Nice work @CynthiaKamau! Any chance we can have some integrational test cases covering all supported rendering types?

samuelmale · 2024-12-02T10:01:47Z

src/adapters/person-attributes-adapter.ts

+export const PersonAttributesAdapter: FormFieldValueAdapter = {
+  transformFieldValue: function (field: FormField, value: any, context: FormContextProps) {
+    clearSubmission(field);
+    if (field.meta?.previousValue?.value === value || isEmpty(value)) {


What happens if the user tries to delete an attribute in edit mode?

if (field.meta?.previousValue && isEmpty(value)) { // should we void the attribute? }

samuelmale · 2024-12-02T10:03:41Z

src/adapters/person-attributes-adapter.ts

+import { clearSubmission } from '../utils/common-utils';
+import { isEmpty } from '../validators/form-validator';
+
+export const PersonAttributesAdapter: FormFieldValueAdapter = {


Are you planning on adding some test coverage for this adapter?

src/hooks/useFormJson.tsx

src/hooks/usePersonAttributes.tsx

src/processors/encounter/encounter-form-processor.ts

src/types/index.ts

src/datasources/person-attribute-datasource.ts

samuelmale · 2024-12-02T10:29:06Z

src/datasources/person-attribute-datasource.ts

+  async fetchData(searchTerm: string, config?: Record<string, any>, uuid?: string): Promise<any[]> {
+    const rep = 'v=custom:(uuid,display)';
+    const url = `${restBaseUrl}/location?${rep}`;
+    const { data } = await openmrsFetch(searchTerm ? `${url}&q=${searchTerm}` : url);
+
+    return data?.results;
+  }


This data source seems to just load locations (not tied down to the "attribute" model). Anything stopping you from reusing the existing location DS`?

src/transformers/default-schema-transformer.ts

src/components/inputs/ui-select-extended/ui-select-extended.component.tsx

ibacher · 2024-12-02T18:36:45Z

src/datasources/person-attribute-datasource.ts

+  async fetchData(searchTerm: string, config?: Record<string, any>, uuid?: string): Promise<any[]> {
+    const rep = 'v=custom:(uuid,display)';
+    const url = `${restBaseUrl}/location?${rep}`;
+    const { data } = await openmrsFetch(searchTerm ? `${url}&q=${searchTerm}` : url);
+
+    return data?.results;
+  }


ibacher · 2024-12-02T18:36:58Z

src/datasources/select-concept-answers-datasource.ts


  fetchData(searchTerm: string, config?: Record<string, any>): Promise<any[]> {
-    const apiUrl = this.url.replace('conceptUuid', config.referencedValue || config.concept);
+    const apiUrl = this.url.replace('conceptUuid', config.concept || config.referencedValue);


Why the inversion here?

src/hooks/useFormJson.tsx

ibacher · 2024-12-02T18:45:12Z

src/hooks/usePersonAttributes.tsx

+    if (patientUuid) {
+      openmrsFetch(`${restBaseUrl}/patient/${patientUuid}?v=custom:(attributes)`)
+        .then((response) => {
+          setPersonAttributes(response?.data?.attributes);


Suggested change

setPersonAttributes(response?.data?.attributes);

setPersonAttributes(response.data?.attributes);

Is there some reason we're not using SWR here?

ibacher · 2024-12-02T18:49:25Z

src/registry/inbuilt-components/inbuiltControls.ts

  ...controlTemplates.map((template) => ({
    name: template.name,
-    component: templateToComponentMap.find((component) => component.name === template.name).baseControlComponent,
+    component: templateToComponentMap.find((component) => component.name === template.name)?.baseControlComponent,


Don't really understand why we need the ? here?

src/registry/registry.ts

ibacher · 2024-12-02T18:58:32Z

src/registry/registry.ts

-
-  transformers.push(...inbuiltFormTransformers.map((inbuiltTransformer) => inbuiltTransformer.component));
-
+  const inbuiltTransformersPromises = inbuiltFormTransformers.map(async (inbuiltTransformer) => {
+    const transformer = inbuiltTransformer.component;
+    if (transformer instanceof Promise) {
+      return await transformer;
+    }
+    return transformer;
+  });
+  const resolvedInbuiltTransformers = await Promise.all(inbuiltTransformersPromises);
+  transformers.push(...resolvedInbuiltTransformers);
  transformers.forEach((transformer) => {
    const inbuiltTransformer = inbuiltFormTransformers.find((t) => t.component === transformer);
-    registryCache.formSchemaTransformers[inbuiltTransformer.name] = transformer;
+    if (inbuiltTransformer) {
+      registryCache.formSchemaTransformers[inbuiltTransformer.name] = transformer;
+    }


Could we refactor this? The code is way more complicated than it needs to be and has way more iterations than it needs to. For example:

transformers = transformers.concat(inbuildFormTransformers.map((transformer) => transformer.component ? ({...transformer, component: Promise.resolve(transformer.component)}) : null).filter(Boolean).map(async (transformer) => { const theTransformer = await transformer.component; registryCache.formSchemaTransformers[transformer.name] = theTransformer; return theTransformer; }));

src/transformers/default-schema-transformer.ts

CynthiaKamau marked this pull request as draft November 19, 2024 10:41

CynthiaKamau force-pushed the O3-3367 branch 2 times, most recently from be9d967 to 48be05c Compare November 21, 2024 11:22

CynthiaKamau marked this pull request as ready for review November 21, 2024 11:25

CynthiaKamau force-pushed the O3-3367 branch 2 times, most recently from 7b25040 to ebf119f Compare November 21, 2024 11:42

CynthiaKamau marked this pull request as draft November 21, 2024 11:48

CynthiaKamau force-pushed the O3-3367 branch from ebf119f to f95290b Compare November 22, 2024 07:35

CynthiaKamau marked this pull request as ready for review November 22, 2024 07:43

CynthiaKamau requested review from ibacher, samuelmale and usamaidrsk November 22, 2024 07:43

CynthiaKamau force-pushed the O3-3367 branch 4 times, most recently from 8ac443b to e0f7bcc Compare November 27, 2024 09:15

CynthiaKamau requested a review from pirupius November 28, 2024 06:26

pirupius reviewed Nov 29, 2024

View reviewed changes

src/types/index.ts Show resolved Hide resolved

src/types/schema.ts Outdated Show resolved Hide resolved

src/adapters/person-attributes-adapter.ts Outdated Show resolved Hide resolved

src/hooks/useFormJson.tsx Show resolved Hide resolved

CynthiaKamau force-pushed the O3-3367 branch from e0f7bcc to e9aa02e Compare November 29, 2024 09:14

samuelmale requested changes Dec 2, 2024

View reviewed changes

ibacher reviewed Dec 2, 2024

View reviewed changes

CynthiaKamau force-pushed the O3-3367 branch 2 times, most recently from e967865 to cb6a495 Compare December 16, 2024 12:12

CynthiaKamau force-pushed the O3-3367 branch 2 times, most recently from a920aa0 to 6776aac Compare January 15, 2025 11:16

CynthiaKamau requested review from ibacher, pirupius and samuelmale January 15, 2025 11:18

CynthiaKamau added 3 commits January 22, 2025 10:55

(feat) O3-3367 Add support for person attributes

1c32060

code review

7f6067b

code review

d951e44

CynthiaKamau force-pushed the O3-3367 branch from 6776aac to d951e44 Compare January 22, 2025 08:19

	setPersonAttributes(response?.data?.attributes);
	setPersonAttributes(response.data?.attributes);

Conversation

CynthiaKamau commented Nov 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Requirements

Summary

Screenshots

Related Issue

Other

Uh oh!

github-actions bot commented Nov 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ibacher commented Nov 22, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

samuelmale left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

CynthiaKamau commented Nov 19, 2024 •

edited

Loading

github-actions bot commented Nov 19, 2024 •

edited

Loading