VATEAM-90652: Create List & Loop pattern

[derekhouck]

Description

Creates a Paragraph type in Drupal for the "List & Loop" pattern. (See the Multiple responses documentation for more details on the pattern.) The Paragraph type includes an "Optional?" boolean field. Adds the new Paragraph type to the list of available Paragraph types in the "Steps" field of the Digital Form content type.

• Closes Create List & Loop pattern va.gov-team#90652

Testing done

• Manually created a Digital Form with a Step that included the "List & Loop" Paragraph type.
• Ran the updated script in my local environment and verified the creation of Digital Forms with the proper Steps.

Screenshots

The "List & Loop" pattern as part of the "Add Step" modal:

An expanded "List & Loop" Paragraph inside the "Steps" field of a Digital Form:

QA steps

As an administrator

1. Go to Manage > Content > Add content > Digital Form
2. In the "Steps" field, click "Add Step"
   • Verify "Digital Form: List & Loop" appears as one of the patterns in the "Add Step" modal.
3. Click "Add" underneath "Digital Form: List & Loop"
   • Verify the "Digital Form: List & Loop" Paragraph appears expanded in the "Steps" field.
   • Verify the "Title" field is required and has a default value of "Multiple responses"
   • Verify a checkbox field is present labeled "Optional?"
4. Select the "Optional?" checkbox
5. Fill out the other required fields on the Digital Form and click "Save" at the bottom of the page.
   • Verify the Digital Form saves successfully.
   • Verify the "Multiple responses" Paragraph is included in the "Steps" field of the view page.
   • Verify the "Optional?" field is set to "Yes"

Definition of Done

• Documentation has been updated, if applicable.
• Tests have been added if necessary.
• Automated tests have passed.
• Code Quality Tests have passed.
• Acceptance Criteria in related issue are met.
• Manual Code Review Approved.
• If there are field changes, front end output has been thoroughly checked.

Select Team for PR review

• CMS Team
• Public websites
• Facilities
• User support
• Accelerated Publishing

Is this PR blocked by another PR?

• DO NOT MERGE

Does this PR need review from a Product Owner

• Needs PO review

CMS user-facing announcement

Is an announcement needed to let editors know of this change?

• Yes, and it's written in issue ____ and queued for publication.
  • Merge and ping the UX writer so they are ready to publish after deployment
• Yes, but it hasn't yet been written
  • Don't merge yet -- ping the UX writer to write and queue content
• No announcement is needed for this code change.
  • Merge & carry on unburdened by announcements

[github-actions]

Checking composer.lock changes...

[github-actions]

GitHub Workflows (.github/workflows/*.yml)

Have you...

• pinned all affected GitHub Actions at a specific commit by SHA?
• reviewed the source code of the action at the commit you are pinning?
• confirmed that no GitHub security measures are being bypassed?
• checked for any injection of user content into protected contexts?
• reviewed Security hardening for GitHub Actions?
• reviewed GitHub Workflows?

[ryguyk]

This makes sense in the context of the approach you have mentioned (i.e. all List-and-Loop paragraphs will map to Employment History at the moment).

I do still have some questions/hesitations around that mental model, but I do agree that it can work. I think my biggest hesitation is that there's nothing immediately obvious here that this will be an Employment History component once it makes its way to the browser. But perhaps we just need to be ok with that for now.

[ryguyk]

This screenshot makes me wonder some more about the relationship between this general List-and-Loop component and the specific instance of it that we are interested in currently (Employment History). This screenshot makes sense here, but I think we might need one specific to Employment History for the Form Builder.

This is, of course, very speculative and dependent upon design decisions. But this is making me wonder about the more general underlying implementation of specific instances of List and Loop. For example, let's assume we'll offer an Employment History pattern in the Form Builder (this has been debated, to be clear). In that case, would we have a pre-defined Employment History paragraph, or would we map that Form-Builder component to an underlying List-and-Loop paragraph with generated/mapped fields?

None of this is critical right now. Just some things that come to mind as I look at this screenshot that looks much different than the others. The others show web-facing UI components. This shows something much different and caught my eye, which made me think about some of the deeper implications.

[derekhouck]

Yeah, I don't think I documented this anywhere other than my mind, which is not the best. I see Employment History and all other List & Loop "variations" as options within the List & Loop Paragraph type. Initially, that may just be a single field called "variation" or something that has options like "Employment History" and "Treatment records." Eventually, I would expect us to need to support a "Custom" option that will require adding individual fields within it, but that would be an enhancement down the line.

Now, even though all these variations would live within the List & Loop Paragraph type, we can still present them as separate "Steps" in the Form Builder UI if we wish to do so. As you mentioned above, the Steps would map to a certain configuration of the List & Loop Paragraph.