Allow custom (extra) texter profile fields to be used in scripts #1961

codygordon · 2021-03-23T18:54:53Z

Description

We need to insert custom texter profile fields into scripts which resulted some significant changes to the existing profile_fields implementation. cc @jeffm2001

Pull in this setting from getConfig so we can use an instance-wide variable
For consistency in variable naming, changed it to TEXTER_PROFILE_FIELDS, however using profile_fields setting var name will still work for backwards compatability
Added an isRequired key to the profile settings objects – this is really necessary for WFP so users can optionally enter some customized data. For backward compatibility, if legacy extra profile fields are unchanged and isRequired is not defined, those fields will be treated as if they had "isRequired": true so expected behavior of existing fields doesn't change. For new fields added, "isRequired": false should be added if it is optional.
Added a conditional env var called SCRIPTS_USE_TEXTER_PROFILE_FIELDS that will make any extra texter profile fields defined in TEXTER_PROFILE_FIELDS populate in the script editor. These will show up in the script editor with a prefix of texter_

Example of working isRequired vs not fields:

Showing up in script editor:

Checklist:

I have manually tested my changes on desktop and mobile
The test suite passes locally with my changes
If my change is a UI change, I have attached a screenshot to the description section of this pull request
My change is 300 lines of code or less, or has a documented reason in the description why it’s longer
I have made any necessary changes to the documentation
I have added tests that prove my fix is effective or that my feature works
My PR is labeled [WIP] if it is in progress

src/lib/scripts.js

jeffm2001 · 2021-03-29T15:15:38Z

I don't have time right now to test this thoroughly, but glancing through the code, it seems fine to me. My one question is do we actually need the SCRIPTS_USE_TEXTER_PROFILE_FIELDS env var? Wondering if we should just always make the tester profile fields available in the script. I'm trying to think of a scenario where that would be a problem, and not coming up with one.

codygordon · 2021-03-29T16:18:29Z

@jeffm2001 I can't either but implemented it this way with the spirit of disrupting others as little as possible, so for most folks they wouldn't see any change unless they choose to (of course this time other than the breaking change regarding var name / isRequired I mentioned).

I was also considering adding another key to the fields themselves, like useInScripts or the like.

schuyler1d

++ let's remove the environmental variable -- I appreciate the care to avoid disrupting folks, but this has no backwards-incompatible implications so we don't need one.

We only need new variables if it would break previous things (e.g. if you were changing or removing the availability of those script choices).

…fields

schuyler1d

👍

schuyler1d

I didn't realize this was backwards incompatible -- I would like to avoid that.

Further with a bit extra scrutiny I don't think the cacheable campaign thing needs to be included.

src/server/api/organization.js

src/server/api/user.js

schuyler1d · 2021-09-10T16:25:41Z

src/server/models/cacheable_queries/campaign.js

+    customFields = Object.keys(JSON.parse(firstContact.custom_fields));
  }
-  return [];
+


is this part necessary? This is caching the field list to be sent about the contact -- I don't think we need this at all as these are texter fields, not contact fields.

@crayolakat to answer @schuyler1d's question here, this is necessary because it's grabbing the existing contact custom fields to be merged with the texter fields to be cached on the campaign, allowing them to be used in scripts.

see this line:
https://github.com/MoveOnOrg/Spoke/pull/1961/files#diff-612db26be6b7f5a0cdd54b604ffa5d5afb3bd8208271fea120755796f1803972R77

…ke into texter-script-fields

crayolakat · 2022-01-05T19:58:50Z

Hi @codygordon , while testing, I am seeing the following error message

That message appears when I click into a required field, and then click out without typing anything. Is the error message supposed to say that, or should it say "Zip Code is a required field" similar to what's in the screenshot provided in the description of your PR?

codygordon · 2022-07-04T19:16:40Z

@crayolakat sorry this took so long, I totally missed this and thought it had already been deployed!

I fixed the weird validation message, as well as a couple bugs I noticed while re-reviewing.

crayolakat

Thanks @codygordon !

Another small thing I noticed:

Create a new user and join an organization. You'll be taken to a page asking you to complete your profile
Don't fill out any additional fields and click "SAVE"
Issue: No validation errors appear telling the user they need to fill out required fields

Can we add validation errors at that step?

codygordon · 2022-07-09T18:45:38Z

@crayolakat good flag, this wasn't working properly when extra was null or undefined. Pushed a fix!

codygordon requested a review from schuyler1d March 23, 2021 18:57

codygordon commented Mar 23, 2021

View reviewed changes

src/lib/scripts.js Outdated Show resolved Hide resolved

codygordon force-pushed the texter-script-fields branch 2 times, most recently from ffb97cf to 1a1a3c2 Compare March 23, 2021 19:51

texter profile fields overhaul

60dac53

codygordon force-pushed the texter-script-fields branch from 1a1a3c2 to 60dac53 Compare March 27, 2021 17:38

codygordon requested a review from jeffm2001 March 27, 2021 17:59

Frydafly added A-contact loaders Area: Related to ingesting and importing contacts using the contact loaders framework S-waiting on review Status: Awaiting review from the assignee but also interested parties labels Mar 27, 2021

schuyler1d requested changes Mar 30, 2021

View reviewed changes

schuyler1d added S-waiting on author Status: PR is awaiting some action (such as code changes) from the PR author and removed S-waiting on review Status: Awaiting review from the assignee but also interested parties labels Mar 30, 2021

codygordon added 2 commits May 11, 2021 09:06

Merge branch 'main' of github.com:MoveOnOrg/Spoke into texter-script-…

5319807

…fields

remove SCRIPTS_USE_TEXTER_PROFILE_FIELDS

715941d

codygordon requested a review from schuyler1d May 11, 2021 16:10

schuyler1d approved these changes Sep 9, 2021

View reviewed changes

schuyler1d added S-ready for stage-main (qa) Status (ADMINS ONLY): PR label for those ready to be added for stage: Approved, tests, etc and removed S-waiting on author Status: PR is awaiting some action (such as code changes) from the PR author labels Sep 9, 2021

schuyler1d requested changes Sep 10, 2021

View reviewed changes

schuyler1d added S-waiting on author Status: PR is awaiting some action (such as code changes) from the PR author and removed S-ready for stage-main (qa) Status (ADMINS ONLY): PR label for those ready to be added for stage: Approved, tests, etc labels Sep 10, 2021

codygordon added 2 commits December 2, 2021 10:08

Merge branch 'texter-script-fields' of github.com:WorkingFamilies/Spo…

0435bf6

…ke into texter-script-fields

TEXTER_PROFILE_FIELDS fallback for backwards compatability

e1e4298

codygordon force-pushed the texter-script-fields branch from 679fe5c to e1e4298 Compare December 2, 2021 17:10

codygordon requested a review from crayolakat December 2, 2021 17:20

edit texter profile fields in org settings / back-compat for isRequired

54f3e71

codygordon removed the request for review from jeffm2001 January 7, 2022 17:15

codygordon added 4 commits July 4, 2022 11:05

Merge branch 'moveon-main' into texter-script-fields

d5570e9

handle authUser.extra parse error

ff0f688

texter fields - fix sqlite save and UI state mutation bugs

f9c7f5c

texter required fields - fix null validation msg

a3b65c5

crayolakat requested changes Jul 7, 2022

View reviewed changes

userEdit validation - set empty user.extra object if undefined/null

a0ead3e

Merge branch 'moveon-main' into texter-script-fields

1b31512

jeffm2001 mentioned this pull request Oct 18, 2024

Fix user edit with extra fields #2489

Open

7 tasks

Allow custom (extra) texter profile fields to be used in scripts #1961

Are you sure you want to change the base?

Allow custom (extra) texter profile fields to be used in scripts #1961

Uh oh!

Conversation

codygordon commented Mar 23, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist:

Uh oh!

Uh oh!

jeffm2001 commented Mar 29, 2021

Uh oh!

codygordon commented Mar 29, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

schuyler1d left a comment

Choose a reason for hiding this comment

Uh oh!

schuyler1d left a comment

Choose a reason for hiding this comment

Uh oh!

schuyler1d left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

schuyler1d Sep 10, 2021

Choose a reason for hiding this comment

Uh oh!

codygordon Dec 2, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

crayolakat commented Jan 5, 2022

Uh oh!

codygordon commented Jul 4, 2022

Uh oh!

crayolakat left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codygordon commented Jul 9, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

codygordon commented Mar 23, 2021 •

edited

Loading

codygordon commented Mar 29, 2021 •

edited

Loading

codygordon Dec 2, 2021 •

edited

Loading

crayolakat left a comment •

edited

Loading