VAGOV-TEAM: 93059, 93060, 94023 #19541

ryguyk · 2024-10-18T03:18:30Z

Description

Relates to:

This is a PR that implements a first pass at some of the initial pieces of building out the Form Builder UI in Drupal. It's important to note that there are a lot of moving pieces/architectural decisions that we'll need to navigate in building out this custom UI, and I ran up against some of them already in this PR. Instead of trying to waterfall this whole thing, this PR is a first pass, and we'll iterate and be agile as we go.

Features added:

Routing
Controller
Three form steps:
- Intro ("Working with the Form Builder") - this name "Intro" might be changed in the future, as there might be a different intro page.
- "Start a conversion"
- Name and DOB

Testing done

Adds unit tests for some abstract base form classes. Adds functional tests for controller and form pages.

See QA steps for additional testing.

Screenshots

QA steps

Prerequisites

Ensure Form Builder module is installed/enabled.
Log in as admin

Form Builder - Entry

Navigate to /form-builder
- Ensure redirect to form-builder/intro

Form Builder - Intro

You should now be at form-builder/intro
- Click 'Start conversion' button.

Form Builder - Start conversion

You should now be at form-builder/start-conversion
- Complete the form.
- Validate that the digital form is created (you should be redirected to the name-and-dob page with a node id in the URL.

Form Builder - Name and DOB

You should now be at form-builder/{node_id}/name-and-dob
- Click 'Continue'.
- Validate that the digital form node has a name-and-dob chapter added (you should be at the default node-edit form and should be able to see all fields on the node.

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

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 · 2024-10-18T03:18:51Z

Checking composer.lock changes...

github-actions · 2024-10-18T04:06:53Z

Checking composer.lock changes...

github-actions · 2024-10-18T04:26:58Z

Checking composer.lock changes...

- Scaffolds va_gov_form_builder custom module. - Adds service for validating uniqueness of a node based on a given field.

- Updates controller test accordingly.

- Adds Form Builder "Start a conversion" page. - Adds Form Builder "Name and DOB" page. - Adds unit and functional tests. - Adds Traits for tests. - Updates router/controller for the three pages.

…a arguments seems standard.

github-actions · 2024-10-18T13:00:16Z

Checking composer.lock changes...

derekhouck · 2024-10-18T14:31:45Z

Feedback after going through the QA steps:

I had to flush the caches after I checked out the branch. Once I did, /form-builder went to the right page.
When I get to form-builder/{node_id}/name-and-dob, there's no indication on the page that any of the information I input on the previous page has been saved. I realize some of this may appear in the sidebar that will come later. But at the very least, it might be good to put the name of the form in either the breadcrumbs or the h1.
When a step name is display-only and not editable, we should probably do more to visually indicate this. BW may have suggestions on accessible ways to indicate a read-only state.

derekhouck

I don't want to hold you up, so I'm going to approve this because I don't see anything here that absolutely needs to get changed before we merge. However, I would like to see tickets added as comments for the following items if they're not addressed by this PR:

The form's name on form pages after the "Start Conversion" form page (this may be handled by an "implement sidebar" ticket)
The read-only "Step name" field looking less like a field users can edit.
Validation of steps/chapters within Form Builder
1-to-1 matching of field validations between Form Builder and Digital Form content type (OMB Number can only be 9 characters, for example)
Adding permissions for Form Builder that are separate from the Digital Form content type.

docroot/modules/custom/va_gov_form_builder/src/Controller/VaGovFormBuilderController.php

docroot/modules/custom/va_gov_form_builder/src/Form/NameAndDob.php

docroot/modules/custom/va_gov_form_builder/src/Form/Base/FormBuilderBase.php

docroot/modules/custom/va_gov_form_builder/src/Form/NameAndDob.php

docroot/modules/custom/va_gov_form_builder/src/Form/Base/FormBuilderNodeBase.php

docroot/modules/custom/va_gov_form_builder/va_gov_form_builder.routing.yml

github-actions · 2024-10-23T18:08:24Z

Checking composer.lock changes...

va-cms-bot temporarily deployed to Tugboat October 18, 2024 03:18 Destroyed

va-cms-bot temporarily deployed to Tugboat October 18, 2024 04:06 Destroyed

ryguyk mentioned this pull request Oct 18, 2024

VAGOV-TEAM-93059-93060-form-builder: Adds routing, controller, and two form steps #19399

Closed

27 tasks

ryguyk changed the title ~~Vagov team 93059 93060 94023~~ VAGOV-TEAM: 93059, 93060, 94023 Oct 18, 2024

va-cms-bot temporarily deployed to Tugboat October 18, 2024 04:26 Destroyed

va-cms-bot temporarily deployed to Tugboat October 18, 2024 08:58 Destroyed

ryguyk added 21 commits October 18, 2024 07:59

VAGOV-TEAM-90124:

f3deb3f

- Scaffolds va_gov_form_builder custom module. - Adds service for validating uniqueness of a node based on a given field.

Adds namespaces to test files.

cc6face

Removes now-unused services file.

04b9ce5

Removes custom service originally built to handle validation.

e93e3ab

Adds a routing.yml file for va_gov_form_builder module.

13c87d1

Adds routing and controller for va_gov_form_builder.

5a906fa

Adds forms for Intro and StartConversion form-builder steps.

fd186f9

Creates a Trait for some shared testing constants.

fadd2b4

Uses new Trait in existing UniqueFieldValidatorTest

3b36632

Adds functional tests for controller.

fbfe7cf

Adds functional test for Intro form page.

08f1621

Adds functional test for StartConversion form page.

718dff9

Removes login from controller test.

06a253b

- Updates controller to remove constructor and call parent::create().

8dbf964

- Updates controller test accordingly.

Corrects incorrect namespace in controller test.

9733a76

Updates functional test to properly indicate @group functional

25b1c71

Adds module dependency to functional tests.

893fa1d

- Adds Form Builder "Intro" page.

2e9d8db

- Adds Form Builder "Start a conversion" page. - Adds Form Builder "Name and DOB" page. - Adds unit and functional tests. - Adds Traits for tests. - Updates router/controller for the three pages.

Qualifies ReflectionClass

0b740f2

Ignore PHPStan on call to drupalFormBuilder->getForm, as passing extr…

555ff14

…a arguments seems standard.

Adds controller test for nameAndDob.

7fc0db9

ryguyk force-pushed the VAGOV-TEAM-93059-93060-94023 branch from fc52aaa to 7fc0db9 Compare October 18, 2024 12:59

va-cms-bot temporarily deployed to Tugboat October 18, 2024 13:00 Destroyed

ryguyk marked this pull request as ready for review October 18, 2024 13:33

ryguyk requested a review from a team as a code owner October 18, 2024 13:33

derekhouck approved these changes Oct 18, 2024

View reviewed changes

va-cms-bot temporarily deployed to Tugboat October 19, 2024 08:52 Destroyed

va-cms-bot temporarily deployed to Tugboat October 20, 2024 08:59 Destroyed

va-cms-bot temporarily deployed to Tugboat October 21, 2024 08:52 Destroyed

va-cms-bot temporarily deployed to Tugboat October 22, 2024 08:56 Destroyed

va-cms-bot temporarily deployed to Tugboat October 23, 2024 08:48 Destroyed

Merge branch 'main' into VAGOV-TEAM-93059-93060-94023

701ba90

va-cms-bot temporarily deployed to Tugboat October 23, 2024 18:08 Destroyed

ryguyk merged commit 3f1408f into main Oct 23, 2024
18 checks passed

ryguyk deleted the VAGOV-TEAM-93059-93060-94023 branch October 23, 2024 20:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

VAGOV-TEAM: 93059, 93060, 94023 #19541

VAGOV-TEAM: 93059, 93060, 94023 #19541

ryguyk commented Oct 18, 2024 •

edited by derekhouck

Loading

github-actions bot commented Oct 18, 2024

github-actions bot commented Oct 18, 2024

github-actions bot commented Oct 18, 2024

github-actions bot commented Oct 18, 2024

derekhouck commented Oct 18, 2024

derekhouck left a comment

github-actions bot commented Oct 23, 2024

VAGOV-TEAM: 93059, 93060, 94023 #19541

VAGOV-TEAM: 93059, 93060, 94023 #19541

Conversation

ryguyk commented Oct 18, 2024 • edited by derekhouck Loading

Description

Testing done

Screenshots

QA steps

Prerequisites

Form Builder - Entry

Form Builder - Intro

Form Builder - Start conversion

Form Builder - Name and DOB

Definition of Done

Select Team for PR review

Is this PR blocked by another PR?

Does this PR need review from a Product Owner

CMS user-facing announcement

github-actions bot commented Oct 18, 2024

github-actions bot commented Oct 18, 2024

github-actions bot commented Oct 18, 2024

github-actions bot commented Oct 18, 2024

derekhouck commented Oct 18, 2024

derekhouck left a comment

Choose a reason for hiding this comment

github-actions bot commented Oct 23, 2024

ryguyk commented Oct 18, 2024 •

edited by derekhouck

Loading