VAGOV-TEAM-99444: Form Info page #20311

ryguyk · 2025-01-22T03:51:17Z

Description

Changes the existing "Start a conversion" page to "Form Info" page.
Makes the page handle both "create" and "edit" modes.
- Create mode: This is what it originally was before this PR. The form creates a new Digital Form node.
- Edit mode: The form can be revisited to update the form-info fields for an existing node.
Renders the form with a custom template.
Adds and wires up custom css specific to this page.
Adds unit and functional tests for new code.

Closes department-of-veterans-affairs/va.gov-team#99444

Testing done

Unit and functional tests added and updated.
Manual tests to ensure the form works as expected.
Manual tests to ensure other pages in Form Builder work as expected.

Screenshots

QA steps

Run the user/content creation script: drush scr scripts/content/form-builder.php.
Log in as test_user_form_builder.
Navigate to form-builder/form-info.
- Validate that the page loads and the (blank/uncompleted) form is visible.
Fill in the form and click "Save and continue".

Validate that the form submission works.
Validate that you are taken to /form-builder/{nid}/name-and-dob

On the name-and-dob page, click the "Back" button (this button will be going away, but for now it can be used to navigate back to the form-info page).
- Validate that the form-info page now loads at url: /form-builder/{nid}/form-info
- Validate that the form is populated with the fields you just added in the previous step.
Make a change to the form data and click "Save and continue".
On the name-and-dob page, again click the "Back" button.
- Validate, again, that the form-info page loads at url: /form-builder/{nid}/form-info.
- Validate that the form is populated and that the change you just made is reflected.

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 · 2025-01-22T03:51:40Z

Checking composer.lock changes...

github-actions · 2025-01-22T03:56:14Z

Checking composer.lock changes...

github-actions · 2025-01-22T15:58:33Z

Checking composer.lock changes...

github-actions · 2025-01-22T16:25:19Z

Checking composer.lock changes...

github-actions · 2025-01-22T18:11:49Z

Checking composer.lock changes...

github-actions · 2025-01-22T21:25:53Z

Checking composer.lock changes...

github-actions · 2025-01-23T01:08:53Z

Checking composer.lock changes...

github-actions · 2025-01-23T14:08:36Z

Checking composer.lock changes...

github-actions · 2025-01-23T14:59:57Z

Checking composer.lock changes...

github-actions · 2025-01-23T16:20:57Z

Checking composer.lock changes...

ryguyk · 2025-01-23T17:11:01Z

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

-   * After initially containing some logic, this function
-   * is now empty, and this entire class is a candiate
-   * for removal. Leaving it here for now, as it might prove
-   * necessary as we continue on.


This base class was initially used, then went through a time where the only logic it had was removed. Now, the need for two layers here (three separate base classes) has gone away, and this class is the only base class, so a lot of the logic from the others has been moved in here and this class has gotten new life.

ryguyk · 2025-01-23T17:15:18Z

docroot/modules/custom/va_gov_form_builder/va_gov_form_builder.module

+  // Add form themes.
+  $forms = ['form_info'];
+  foreach ($forms as $form) {
+    $theme['form__va_gov_form_builder__' . $form] = [
+      'path' => $path . '/templates/form',
+      'render element' => 'form',
+    ];
+  }


The steps for making a custom template work for a form page:

Register the theme in hook_theme.

Set the form #theme as the theme registered in step 1.

Create the twig template and name in accordance with theme key registered in step 1.

ryguyk · 2025-01-23T17:15:47Z

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

+      $this->isCreate = FALSE;
+    }
+
+    $form['#theme'] = 'form__va_gov_form_builder__form_info';


The steps for making a custom template work for a form page:

Register the theme in hook_theme.

Set the form #theme as the theme registered in step 1.

Create the twig template and name in accordance with theme key registered in step 1.

ryguyk · 2025-01-23T17:25:42Z

...les/custom/va_gov_form_builder/templates/form/form--va-gov-form-builder--form-info.html.twig

@@ -0,0 +1,30 @@
+{#


The steps for making a custom template work for a form page:

Register the theme in hook_theme.

Set the form #theme as the theme registered in step 1.

Create the twig template and name in accordance with theme key registered in step 1.

… into remaining base class.

…t least yet).

…ethods called immediately after.

- Updates test to handle change to button label.

- Removes tests related to back button. - Updates controller tests to check for populated vs. empty fields on edit vs. create mode.

…erisk "*".

github-actions · 2025-01-24T23:13:56Z

Checking composer.lock changes...

va-cms-bot · 2025-01-24T23:45:56Z

Cypress Accessibility Violations

`/test-data-quae`

ID: button-name
Impact: critical
Tags: cat.name-role-value, wcag2a, wcag412, section508, section508.22.a, TTv5, TT6.a, EN-301-549, EN-9.4.1.2, ACT
Description: Ensure buttons have discernible text
Help: Buttons must have discernible text
Nodes:

HTML: <button class="proofing-element-help" role="tooltip" data-proofing-help-title="About 'Page introduction' field" data-proofing-help="Add an introduction that helps visitors understand if information on the page is relevant to them."> <span aria-hidden="true">i</span> </button>
Impact: critical
Target: .field--name-field-intro-text-limited-html > .field__label > .proofing-element-help[role="tooltip"]
Summary: Fix any of the following:
Element does not have inner text that is visible to screen readers
aria-label attribute does not exist or is empty
aria-labelledby attribute does not exist, references elements that do not exist or references elements that are empty
Element has no title attribute
Element does not have an implicit (wrapped) <label>
Element does not have an explicit <label>
Element's default semantics were not overridden with role="none" or role="presentation"
HTML: <button class="proofing-element-help" role="tooltip" data-proofing-help-title="About 'Generate a table of contents from major headings' field" data-proofing-help="By checking this box, all h2's below this point on the page will be linked with with anchor links. This helps users navigate content on very long pages. Do not check this box unless there is at least 2 h2's on the page.">
Impact: critical
Target: .field--name-field-table-of-contents-boolean > .field__label > .proofing-element-help[role="tooltip"]
Summary: Fix any of the following:
Element does not have inner text that is visible to screen readers
aria-label attribute does not exist or is empty
aria-labelledby attribute does not exist, references elements that do not exist or references elements that are empty
Element has no title attribute
Element does not have an implicit (wrapped) <label>
Element does not have an explicit <label>
Element's default semantics were not overridden with role="none" or role="presentation"
HTML: <button class="proofing-element-help" role="tooltip" data-proofing-help-title="About 'Main content' field" data-proofing-help="The main body of the page, which appears below the featured content."> <span aria-hidden="true">i</span> </button>
Impact: critical
Target: button[data-proofing-help-title="About 'Main content' field"]
Summary: Fix any of the following:
Element does not have inner text that is visible to screen readers
aria-label attribute does not exist or is empty
aria-labelledby attribute does not exist, references elements that do not exist or references elements that are empty
Element has no title attribute
Element does not have an implicit (wrapped) <label>
Element does not have an explicit <label>
Element's default semantics were not overridden with role="none" or role="presentation"

va-cms-bot temporarily deployed to Tugboat January 22, 2025 03:51 Destroyed

va-cms-bot temporarily deployed to Tugboat January 22, 2025 03:56 Destroyed

va-cms-bot temporarily deployed to Tugboat January 22, 2025 08:45 Destroyed

va-cms-bot temporarily deployed to Tugboat January 22, 2025 15:58 Destroyed

va-cms-bot temporarily deployed to Tugboat January 22, 2025 16:25 Destroyed

va-cms-bot temporarily deployed to Tugboat January 22, 2025 18:11 Destroyed

va-cms-bot temporarily deployed to Tugboat January 22, 2025 21:25 Destroyed

va-cms-bot temporarily deployed to Tugboat January 23, 2025 01:08 Destroyed

va-cms-bot temporarily deployed to Tugboat January 23, 2025 08:45 Destroyed

ryguyk force-pushed the VAGOV-TEAM-99444-form-info branch from 2de78db to 175f283 Compare January 23, 2025 14:08

va-cms-bot temporarily deployed to Tugboat January 23, 2025 14:08 Destroyed

va-cms-bot temporarily deployed to Tugboat January 23, 2025 14:59 Destroyed

ryguyk requested a review from derekhouck January 23, 2025 15:23

ryguyk marked this pull request as ready for review January 23, 2025 15:23

ryguyk requested a review from a team as a code owner January 23, 2025 15:23

va-cms-bot temporarily deployed to Tugboat January 23, 2025 16:20 Destroyed

ryguyk commented Jan 23, 2025

View reviewed changes

ryguyk added 24 commits January 24, 2025 17:13

Sets back-button redirect to the edit page rather than create page.

6fabcd3

Removes test classes for now-unused Form base classes. Combines tests…

28eced2

… into remaining base class.

Removes condition to only save on updated node. Doesn't apply here (a…

b2a8c2e

…t least yet).

Updates tests for controller.

31376cd

Updates tests for FormName form.

60d0718

Small update to test for back button on NameAndDobTest

e859adf

Removes unnecessary check for empty value.

a8a5cfc

Adds unit test for getDigitalForm method on the service.

0ac61a2

Changes "Form Name" to "Form Info". Updates routes, class names, etc.

61da8f5

Updates page title and removes help text.

f6dd0c5

Changes "Continue" button text to "Save and continue".

bc14c00

Change page subtitle on Form Info page.

56c4424

Removes redundant drupalGet callls. This is handled in the shared m…

0ae5372

…ethods called immediately after.

- Adds tests asserting correct subtitle.

e7543b4

- Updates test to handle change to button label.

- Removes back button on Form Info page.

bc92d7a

- Removes tests related to back button. - Updates controller tests to check for populated vs. empty fields on edit vs. create mode.

Changes required field label to "(*Required)" rather than just an ast…

a08b2c8

…erisk "*".

Removes help text from various fields.

a112929

Configures custom template and css for Form Info page.

0acc217

Renders form via template and styles via css.

e0a619a

Changes color on form-field hint text.

429837e

Updates test to align with updated page text.

b21b770

Updates LibrariesTest to check for new libraries.

190598f

Updates ModuleTest to ensure presence of form themes.

8a1f175

Makes form elements fill form width so they all match.

7f0adc4

ryguyk force-pushed the VAGOV-TEAM-99444-form-info branch from 046da8c to 7f0adc4 Compare January 24, 2025 23:13

va-cms-bot temporarily deployed to Tugboat January 24, 2025 23:13 Destroyed

ryguyk merged commit b9365f9 into main Jan 24, 2025
18 checks passed

ryguyk deleted the VAGOV-TEAM-99444-form-info branch January 24, 2025 23:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

VAGOV-TEAM-99444: Form Info page #20311

VAGOV-TEAM-99444: Form Info page #20311

ryguyk commented Jan 22, 2025 •

edited by derekhouck

Loading

github-actions bot commented Jan 22, 2025

github-actions bot commented Jan 22, 2025

github-actions bot commented Jan 22, 2025

github-actions bot commented Jan 22, 2025

github-actions bot commented Jan 22, 2025

github-actions bot commented Jan 22, 2025

github-actions bot commented Jan 23, 2025

github-actions bot commented Jan 23, 2025

github-actions bot commented Jan 23, 2025

github-actions bot commented Jan 23, 2025

ryguyk Jan 23, 2025 •

edited

Loading

ryguyk Jan 23, 2025 •

edited

Loading

ryguyk Jan 23, 2025 •

edited

Loading

ryguyk Jan 23, 2025

github-actions bot commented Jan 24, 2025

va-cms-bot commented Jan 24, 2025

VAGOV-TEAM-99444: Form Info page #20311

VAGOV-TEAM-99444: Form Info page #20311

Conversation

ryguyk commented Jan 22, 2025 • edited by derekhouck Loading

Description

Testing done

Screenshots

QA steps

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 Jan 22, 2025

github-actions bot commented Jan 22, 2025

github-actions bot commented Jan 22, 2025

github-actions bot commented Jan 22, 2025

github-actions bot commented Jan 22, 2025

github-actions bot commented Jan 22, 2025

github-actions bot commented Jan 23, 2025

github-actions bot commented Jan 23, 2025

github-actions bot commented Jan 23, 2025

github-actions bot commented Jan 23, 2025

ryguyk Jan 23, 2025 • edited Loading

Choose a reason for hiding this comment

ryguyk Jan 23, 2025 • edited Loading

Choose a reason for hiding this comment

ryguyk Jan 23, 2025 • edited Loading

Choose a reason for hiding this comment

ryguyk Jan 23, 2025

Choose a reason for hiding this comment

github-actions bot commented Jan 24, 2025

va-cms-bot commented Jan 24, 2025

Cypress Accessibility Violations

/test-data-quae

ryguyk commented Jan 22, 2025 •

edited by derekhouck

Loading

ryguyk Jan 23, 2025 •

edited

Loading

ryguyk Jan 23, 2025 •

edited

Loading

ryguyk Jan 23, 2025 •

edited

Loading

`/test-data-quae`