Enable the default embed map custom fields by default #1365

jwalgran · 2021-05-27T20:04:52Z

Overview

We only show the custom field configuration UI to embedded map users at higher price tiers but the default transparency pledge fields are available to any embedded map user. To keep the configuration simple, we modify the client side code to enable these fields default by default and give them nicely formatted labels.

Connects #1362

Notes

We add a migration to allow for the embed config field on Contributor to be blank since without this change you are not able to save a Contributor record in the Django admin unless an embed config has been created.

To ensure that the list of non-standard field names is unique we combine it with the default field list using sets rather than lists.

Demo

Testing Instructions

Run migrations
Log in as an admin and modify the Contributor to have the "Embed" level of access
Log in as a user/contributor without an embed configuration. I used c4@example.com.
Open the developer tools network tab
Browse http://localhost:6543/settings, click the embed tab, and configure the embed. Verify that POST/PUT requests are made with the default transparency pledge fields enabled and labeled.
Upload
test-transparency-pledge-fields.csv and fully process it
- ./scripts/manage batch_process --list-id {id} --action parse
- ./scripts/manage batch_process --list-id {id} --action geocode
- ./scripts/manage batch_process --list-id {id} --action match
Use serve the markup below on localhost and browse it. Verify that the "Some Software Co." facility lists all 4 transparency pledge fields

<!doctype html>

<html lang="en">
    <head>
        <meta charset="UTF-8"/>
        <title>OAR Embed Demo</title>
    </head>
    <body>
        <h1>
            <div>
                My embedded map
            </div>
        </h1>
        <li>item one</li>
        <li>item b</li>
        <li>item the third</li>


        <!-- embed -->
        <iframe
            src="http://localhost:6543/?contributors=4&embed=1"
            frameBorder="0"
            style="width:1000px;height:750px"
            title="embedded-map"
        />
        <!-- end -->

    </body>
</html>

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 · 2021-05-28T13:13:18Z

This is working as described, but I have one concern with this implementation. Currently, if a user without an existing embed config logs in at a higher embed level and navigates to the settings page, it will display the default fields as visible; however, they haven't actually been enabled until the user interacts with the page and initiates a POST request.

jwalgran · 2021-05-28T17:59:59Z

@TaiWilkin I pushed 67dea9e which adds some server side handling for returning default fields when there is no saved config to override them. Ready for another look.

TaiWilkin

This is working very well! Nice fix-up.
I noted a couple of small typos, but otherwise this is good to go.

TaiWilkin · 2021-05-28T18:31:01Z

src/django/api/models.py

@@ -2070,6 +2070,15 @@ class NonstandardField(models.Model):
    class Meta:
        unique_together = ('contributor', 'column_name')

+    # Keys in this set must be kept in sync with
+    # defaultNonstandarFieldLabels in app/src/app/util/embededMap.js


Typo - missing a 'd' in Nonstandard and in embedded

Without this you cannot save a Contributor record in the Django admin unless an embed config has been created.

To ensure the list of field keys is unique we combine sets rather than lists.

We only show the custom field configuration UI to embedded map users at higher price tiers but the default transparency pledge fields are available to any embedded map user. To keep the configuration simple, we modify the client side code to enable these fields default by default and give them nicely formatted labels.

This handles the case where a contributor copies their embed config without making any changes, and therefore has not created any config rows in the database. Before this change they would not be able to see the default transparency pledge fields.

jwalgran · 2021-05-28T22:30:08Z

Thanks for the review and the excellent suggestion. The revised implementation is much better.

jwalgran requested a review from TaiWilkin May 27, 2021 20:04

jwalgran assigned TaiWilkin May 27, 2021

TaiWilkin approved these changes May 28, 2021

View reviewed changes

TaiWilkin assigned jwalgran and unassigned TaiWilkin May 28, 2021

Allow the embed config field on Contributor to be blank

ef08a00

Without this you cannot save a Contributor record in the Django admin unless an embed config has been created.

jwalgran force-pushed the feature/jcw/default-embed-fields branch from 67dea9e to fb53c72 Compare May 28, 2021 22:20

jwalgran added 4 commits May 28, 2021 15:20

Prevent duplicate values in the non-standard field list API

f2e3b05

To ensure the list of field keys is unique we combine sets rather than lists.

Update CHANGELOG

11ed9ac

jwalgran force-pushed the feature/jcw/default-embed-fields branch from fb53c72 to 11ed9ac Compare May 28, 2021 22:20

jwalgran merged commit 5f8d5a4 into develop May 28, 2021

jwalgran deleted the feature/jcw/default-embed-fields branch May 28, 2021 22:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enable the default embed map custom fields by default #1365

Enable the default embed map custom fields by default #1365

jwalgran commented May 27, 2021 •

edited

TaiWilkin commented May 28, 2021

jwalgran commented May 28, 2021

TaiWilkin left a comment

TaiWilkin May 28, 2021

jwalgran commented May 28, 2021

Enable the default embed map custom fields by default #1365

Enable the default embed map custom fields by default #1365

Conversation

jwalgran commented May 27, 2021 • edited

Overview

Notes

Demo

Testing Instructions

Checklist

TaiWilkin commented May 28, 2021

jwalgran commented May 28, 2021

TaiWilkin left a comment

Choose a reason for hiding this comment

TaiWilkin May 28, 2021

Choose a reason for hiding this comment

jwalgran commented May 28, 2021

jwalgran commented May 27, 2021 •

edited