Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

USAGOV-1885: Pxbf release v0.6.0.beta.1 #1867

Merged
merged 8 commits into from
Aug 21, 2024

Conversation

scottqueen-bixal
Copy link
Contributor

@scottqueen-bixal scottqueen-bixal commented Aug 20, 2024

Benefit Finder v0.6.0.beta.1

https://github.com/GSA/px-benefit-finder/releases/tag/v0.6.0.beta.1

https://github.com/GSA/px-benefit-finder/milestone/10?closed=1

Description

Type of Changes

  • New Feature
  • Bugfix
  • Frontend (Twig, Sass, JS)
    • Add screenshot showing what it should look like
  • Drupal Config (requires "drush cim")
  • New Modules (requires rebuild)
  • Documentation
  • Infrastructure
    • CMS
    • WAF
    • Egress
    • Tools
  • Other

Testing Instructions

Related Github Issue

Design Improvements

DESIGN | Update Icons GSA/px-benefit-finder#1447
DESIGN | Update Relative Events CTA Cards GSA/px-benefit-finder#1448
DESIGN | Update Accordion(s) styles GSA/px-benefit-finder#1449
DESIGN | Update Layout Values GSA/px-benefit-finder#1451
Redesign | Colors GSA/px-benefit-finder#1629
Redesign | Buttons Pt1 GSA/px-benefit-finder#1632
Redesign | Buttons Pt2 GSA/px-benefit-finder#1633
Redesign | Italicize Step Indicator GSA/px-benefit-finder#1661
Redesign | Step List

Application Improvements

Adopting GSA's Error Identification GSA/px-benefit-finder#1121
Error Alert Design Updates GSA/px-benefit-finder#1643
Include additional text to resolve form field errors with fields GSA/px-benefit-finder#1513
Include a list of links to the fields that have errors in alerts GSA/px-benefit-finder#1512
Include error count in alert GSA/px-benefit-finder#1511
update package version and dependencies GSA/px-benefit-finder#1687
date field in memorable date doesn't recognize value 0 as error GSA/px-benefit-finder#1676

Data Layer Improvements

Create data layer event(s) to track error messages in analytics GSA/px-benefit-finder#1501

Content Improvements

Change "Click to select" in SP combo box GSA/px-benefit-finder#1043
Determine consistent translation for inline field errors GSA/px-benefit-finder#1555

Custom Module Improvements

Error Label Content Override GSA/px-benefit-finder#1614
Hide qualtrics survey, with exceptions GSA/px-benefit-finder#1701
Benefit finder page level surveys GSA/px-benefit-finder#1638
Add search title in JSON data GSA/px-benefit-finder#1674

Detailed Testing steps

Design Improvements

  • navigate the app and identify these design updates

DESIGN | Update Icons GSA/px-benefit-finder#1447

expected:
Screenshot 2024-08-20 at 2 22 03 PM

DESIGN | Update Relative Events CTA Cards GSA/px-benefit-finder#1448

expected:
Screenshot 2024-08-20 at 2 22 00 PM

DESIGN | Update Accordion(s) styles GSA/px-benefit-finder#1449

expected:
Screenshot 2024-08-20 at 2 22 26 PM

Redesign | Buttons Pt1 GSA/px-benefit-finder#1632

Redesign | Buttons Pt2 GSA/px-benefit-finder#1633

Screenshot 2024-08-20 at 2 21 25 PM

Redesign | Italicize Step Indicator GSA/px-benefit-finder#1661

Screenshot 2024-08-20 at 2 21 15 PM

Redesign | Step List
Screenshot 2024-08-20 at 2 20 44 PM

Application Improvements

Hide qualtrics survey, with exceptions GSA/px-benefit-finder#1701

  • ensure on page load that the survey div is in the DOM, bf-qual-survey with the hidden attribute is true
  • navigate to results view
  • ensure on page load that the survey div is in the DOM, bf-qual-survey with the hidden attribute is false

update package version and dependencies GSA/px-benefit-finder#1687

  • navigate to /death
  • inspect DOM
  • search for data-version
  • ensure version is 0.6.0.beta.1

date field in memorable date doesn't recognize value 0 as error GSA/px-benefit-finder#1676

  • navigate to /death
  • in the first step of the form, input 0 for the date field value of the first question
  • CLICK Continue
  • ensure that the day value indicates an error

Error Alert Design Updates GSA/px-benefit-finder#1643

  • navigate to /death
  • CLICK start
  • without completing any fields, CLICK Continue
  • ensure new styling and layout for error alerts

expected:
Screenshot 2024-08-08 at 10 13 18 AM

Include error count in alert GSA/px-benefit-finder#1511
Include a list of links to the fields that have errors in alerts GSA/px-benefit-finder#1512
Include additional text to resolve form field errors with fields GSA/px-benefit-finder#1513
Determine consistent translation for inline field errors GSA/px-benefit-finder#1555

  • ensure the number of errors indicated in the alert is equal to the number of inputs/selects that have errors
Screenshot 2024-08-01 at 3 57 19 PM
  • ensure that the error banner has a list of error descriptions, which are links to each of the error fields
Screenshot 2024-08-01 at 3 57 15 PM
  • ensure that selecting the error link takes you to the field described and focus that field
  • ensure the fields with errors have red borders around them
  • ensure each error fieldset should have an accompanying bf-error-detail field that indicates to the user to "fill out the {legend} field"

Expected:
en locale
Screenshot 2024-08-01 at 3 56 29 PM

  • ensure that when you resolve this error the error border is removed
  • ensure that when all fields in a field group are resolved the error border on the <fieldset /> is removed
  • ensure that when you resolve an error the error description is removed from the error banner list
  • ensure that when you resolve an error the error count decreases
  • ensure that when all errors are resolved all error indicators are removed

Content Improvements

Change "Click to select" in SP combo box GSA/px-benefit-finder#1043

  • navigate to /death
  • CLICK start to navigate to first step of form
  • confirm that the <select/>'s have the following default labels and configuration

en

  "select": {
    "labelSelect": "Select an option",
    "defaultValue": "-Select-",
    ...
  },

Data Improvements

Create data layer event(s) to track error messages in analytics GSA/px-benefit-finder#1501

  • navigate to /death
  • CLICK continue without providing field values
  • confirm error banner is visible
  • console.log(window.dataLayer)
  • confirm bf_form_page_submit_attempt is in the dataLayer
  • confirm the event has a string of errors, that are the ids of the field values with errors
  • confirm the error count matches that presented in the UI
  • confirm that formSuccess is false

expected structure:

{
    "event": "bf_form_page_submit_attempt",
    "bfData": {
        "errors": "STRING, STRING, STRING,...",
        "errorCount": {
            "number": NUMBER,
            "string": "STRING"
        },
        "formSuccess": false
    }
}
  • resolve errors by providing values for required fields
  • CLICK Continue
  • console.log(window.dataLayer)
  • confirm a second bf_form_page_submit_attempt is in the dataLayer
  • confirm the event has an empty string of errors
  • confirm the error count is 0
  • confirm that formSuccess is true

expected structure:

{
    "event": "bf_form_page_submit_attempt",
    "bfData": {
        "errors": "",
        "errorCount": {
            "number": NUMBER,
            "string": "STRING"
        },
        "formSuccess": true
    }
}

Custom Module Improvements

Error Label Content Override GSA/px-benefit-finder#1614

  • Navigate to admin/content?combine=&type=bears_life_event_form&status=All&langcode=All
  • Go to life event form "Benefit finder: death of a loved one" edit page
  • Add "Input the date of birth" in Error Message field
  • Save as published
  • Navigate to benefit-finder/api/life-event/death
  • Verify errorMessage "Input the date of birth"

Add search title in JSON data GSA/px-benefit-finder#1674

  • Navigate to admin/content?combine=&type=bears_life_event&status=All&langcode=All
  • Go to life event "Benefit finder: retirement" edit page
  • Add "Approaching retirement" in search title field
  • Save as published
  • Go to life event "Benefit finder: disability" edit page
  • Add "Living with a disability or illness" in search title field
  • Save as published
  • Navigate to benefit-finder/api/life-event/death
  • Verify searchTitle in json data

image

  • Navigate to benefit-finder/api/life-event/death/jsonfile to generate JSON file

after generating json

  • navigate to "/benefit-finder/death`
  • complete required fields to get to Results view
  • ensure updated searchTitles are rendering in Relevant Benefits Cards
Screenshot 2024-08-20 at 10 44 51 AM

Change Requirements

  • Requires New Documentation (Link: {})
  • Requires New Config
  • Requires New Content

Validation Steps

  • Test instruction 1
  • Test instruction 2
  • Test instruction 3

Security Review

  • Adds/updates software (including a library or Drupal module)
  • Communication with external service
  • Changes permissions or workflow
  • Requires SSPP updates

Reviewer Reminders

  • Reviewed code changes
  • Reviewed functionality
  • Security review complete or not required

Post PR Approval Instructions

Follow these steps as soon as you merge the new changes.

  1. Go to the USAGov Circle CI project.
  2. Find the commit of this pull request.
  3. Build and deploy the changes.
  4. Update the Jira ticket by changing the ticket status to Review in Test and add a comment. State whether the change is already visible on cms-dev.usa.gov and beta-dev.usa.gov, or if the deployment is still in process.

gchi25
gchi25 previously approved these changes Aug 20, 2024
@gchi25 gchi25 requested a review from akf August 20, 2024 21:28
@scottqueen-bixal scottqueen-bixal marked this pull request as ready for review August 20, 2024 21:44
@akf akf changed the title Pxbf release v0.6.0.beta.1 USAGOV-1885: Pxbf release v0.6.0.beta.1 Aug 20, 2024
@akf
Copy link
Member

akf commented Aug 20, 2024

I'm getting an error message when I attempt to import configuration. I think you might have forgotten to include field.storage.paragraph.field_b_error_message.yml:

The import failed due to the following reasons:
Configuration field.field.paragraph.b_levent_elg_criteria.field_b_error_message depends on the field.storage.paragraph.field_b_error_message configuration that will not exist after import.

@scottqueen-bixal
Copy link
Contributor Author

I'm getting an error message when I attempt to import configuration. I think you might have forgotten to include field.storage.paragraph.field_b_error_message.yml:

The import failed due to the following reasons:
Configuration field.field.paragraph.b_levent_elg_criteria.field_b_error_message depends on the field.storage.paragraph.field_b_error_message configuration that will not exist after import.

Thanks @akf - I've included the missing storage config. I'll have @gchi25 check a few of these items again, but hopefully that resolves the import error you are getting.

@akf
Copy link
Member

akf commented Aug 21, 2024

Thanks @akf - I've included the missing storage config. I'll have @gchi25 check a few of these items again, but hopefully that resolves the import error you are getting.

Yes @scottqueen-bixal, it does!

Copy link
Member

@akf akf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All looks good to me. Since @gchi25 is going to take another look, I won't merge it -- but feel free to do that when you're ready!

@scottqueen-bixal scottqueen-bixal merged commit 8566bf7 into dev Aug 21, 2024
1 of 2 checks passed
@scottqueen-bixal scottqueen-bixal deleted the pxbf-release-v0.6.0.beta.1 branch August 21, 2024 15:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants