Add extended field handling to facility details #1593

TaiWilkin · 2022-01-18T19:34:15Z

Overview

Makes the facility details subsections expandable to show additional
content (details from other matches, claims, etc.) when not in embed
mode.

Adds extended field subsections (number of workers, native language
name, and so on) when values are present and the map is not in embed
mode.

Adds nonstandard/contributor field subsections when values are present
in embed mode.

Connects #1540

Demo

Closed items

Opened items

Extended fields

Nonstandard / contributor fields (in embed)

Notes

Anticipated extended fields have been included in the list of fields to attempt to render if available, in addition to the existing extended fields. However, because these are not yet present in the API response, some tweaking might be necessary once they are being returned from the API to ensure all formatting / etc are working as expected.

Some changes have been made to the styling of the items and header based on the updated wireframes.

Testing Instructions

Run ./scripts/server
View a facility with multiple matches and confirm that other names, addresses, and GPS coordinates are available when expanding the subsections.
Submit and approve a claim for the facility, then submit a claim name, address, and number of workers.
The new claim details should be displayed in the expandable lists of facility details.
Submit and setup nonstandard fields for the facility.
Open the facility details in the embedded map preview. No items should be expandable, the contributors sections and expanded fields should be hidden, and the nonstandard fields should be shown.

Checklist

fixup! commits have been squashed
CI passes after rebase
CHANGELOG.md updated with summary of features or fixes, following Keep a Changelog guidelines

TaiWilkin · 2022-01-18T19:40:35Z

src/app/src/components/FacilityDetailSidebarContributors.jsx

-                    verified={contributor.is_verified}
-                />
+            {visibleContributors.map(contributor => (
+                <ListItem


Switched from using the FacilityDetailSidebarDetail here because the structure is different enough now to make it overly complex

TaiWilkin · 2022-01-18T19:42:26Z

src/app/src/components/FacilityDetailSidebarDetail.jsx

-        <ShowOnly when={!hideTopDivider}>
-            <Divider className={classes.divider} />
+    <ListItem className={classes.item}>
+        <ShowOnly when={verified}>


I'm showing the verified badge when an extended field is verified (presumably includes when the contributor is verified, based on upcoming changes). Do we want this, or should there be no badge for verified items?

It makes sense that we visually indicate the status of these items. I like shoing the badge.

TaiWilkin · 2022-01-18T19:46:40Z

src/app/src/components/FacilityDetailSidebarHeader.jsx

@@ -90,7 +90,7 @@ const getContent = ({
        secondary: 'Claim this facility',
        icon: <BadgeUnclaimed />,
        style: {
-            background: 'rgb(9, 18, 50)',
+            background: 'rgb(61, 50, 138)',


Updating to new unclaimed header color per new wireframes

TaiWilkin · 2022-01-18T19:47:36Z

src/app/src/util/constants.js

@@ -715,3 +715,37 @@ export const facilitySidebarActions = {
    CLAIM_FACILITY: 'Claim this facility',
    VIEW_ON_OAR: 'View on the Open Apparel Registry',
 };
+
+export const EXTENDED_FIELD_TYPES = [


The constant array of extended field types includes anticipated fields which aren't yet included in the API

jwalgran

Nice work on the implementation! The code is clear and I was able to successfully work through the testing instructions without any issues.

I did see some things I did not expect, but I don't think they necessarily fall withing the scope of this PR. Please create follow up issues or add subtasks to one of our existing issues (listed under #1585) if appropriate.

After claiming the facility, I would expect the values for the claimed fa facility to be promoted to the top of the list. In my testing it appeared at the end of the list

In my testing some addresses appear without a contributor name or date.

In my test I created an embedded map as "Service Provider A" but when I view a facility that was originally created under a different contributor ("Factory A"), I see that contributor's name. We need to avoid showing any other contributor names.

jwalgran · 2022-01-19T19:00:24Z

src/app/src/components/FacilityDetailSidebarDetail.jsx

-        <ShowOnly when={!hideTopDivider}>
-            <Divider className={classes.divider} />
+    <ListItem className={classes.item}>
+        <ShowOnly when={verified}>


It makes sense that we visually indicate the status of these items. I like shoing the badge.

TaiWilkin · 2022-01-19T21:04:07Z

After claiming the facility, I would expect the values for the claimed fa facility to be promoted to the top of the list. In my testing it appeared at the end of the list

This is caused by a) the prioritization of the name/address/location on the facility over the extended fields, and b) the combination/prioritization of the other_names/_addresses/_locations with the extended fields.

In my testing some addresses appear without a contributor name or date.

This is caused by the combination of the other_names/_addresses/_locations with the extended fields (they don't include the contribution data).

In my test I created an embedded map as "Service Provider A" but when I view a facility that was originally created under a different contributor ("Factory A"), I see that contributor's name. We need to avoid showing any other contributor names.

This is caused by the prioritization or and inclusion of contribution data for the facility object's name/address/locations.
These three issues will be fixed by updating the facility details and list APIs, specifically by:

Including the other_names/_addresses/_locations information with the extended_fields when serializing to allow proper server-side sorting and inclusion of contributor data
Prioritizing the name/address/location from an active/verified facility claim over the facility object's name/address/location when serializing (unless it is in embed mode and prefer_contributor_name is active, in which case prefer the contributor name)
Adjusting the created_from to hide other contributor information in embed mode
These tasks have been added to #1570

Makes the facility details subsections expandable to show additional content (details from other matches, claims, etc.) when not in embed mode. Adds extended field subsections (number of workers, native language name, and so on) when values are present and the map is not in embed mode. Adds nonstandard/contributor field subsections when values are present in embed mode.

TaiWilkin · 2022-01-19T21:16:09Z

Thank you for reviewing!

TaiWilkin requested a review from jwalgran January 18, 2022 19:39

TaiWilkin assigned jwalgran Jan 18, 2022

TaiWilkin commented Jan 18, 2022

View reviewed changes

TaiWilkin force-pushed the tw/expand-fields branch from c5544c4 to 7169940 Compare January 18, 2022 19:44

TaiWilkin commented Jan 18, 2022

View reviewed changes

jwalgran approved these changes Jan 19, 2022

View reviewed changes

jwalgran assigned TaiWilkin and unassigned jwalgran Jan 19, 2022

TaiWilkin mentioned this pull request Jan 19, 2022

Expand ExtendedField.FIELD_CHOICES #1595

Merged

3 tasks

TaiWilkin force-pushed the tw/expand-fields branch from 7169940 to 3480673 Compare January 19, 2022 21:07

TaiWilkin merged commit 468c038 into develop Jan 19, 2022

TaiWilkin deleted the tw/expand-fields branch January 19, 2022 21:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add extended field handling to facility details #1593

Add extended field handling to facility details #1593

TaiWilkin commented Jan 18, 2022 •

edited

TaiWilkin Jan 18, 2022

TaiWilkin Jan 18, 2022

jwalgran Jan 19, 2022

TaiWilkin Jan 18, 2022

TaiWilkin Jan 18, 2022

jwalgran left a comment

jwalgran Jan 19, 2022

TaiWilkin commented Jan 19, 2022 •

edited

TaiWilkin commented Jan 19, 2022

Add extended field handling to facility details #1593

Add extended field handling to facility details #1593

Conversation

TaiWilkin commented Jan 18, 2022 • edited

Overview

Demo

Notes

Testing Instructions

Checklist

TaiWilkin Jan 18, 2022

Choose a reason for hiding this comment

TaiWilkin Jan 18, 2022

Choose a reason for hiding this comment

jwalgran Jan 19, 2022

Choose a reason for hiding this comment

TaiWilkin Jan 18, 2022

Choose a reason for hiding this comment

TaiWilkin Jan 18, 2022

Choose a reason for hiding this comment

jwalgran left a comment

Choose a reason for hiding this comment

jwalgran Jan 19, 2022

Choose a reason for hiding this comment

TaiWilkin commented Jan 19, 2022 • edited

TaiWilkin commented Jan 19, 2022

TaiWilkin commented Jan 18, 2022 •

edited

TaiWilkin commented Jan 19, 2022 •

edited