alphagov/govuk-coronavirus-vulnerable-people-form

Helps the public get support during the COVID-19 pandemic

This codebase is archived. It has been superseded by alphagov/govuk-shielded-vulnerable-people-service.

CoronavirusForm

This is an application for submitting a form.

Getting started

The instructions will help you to get the application running locally on your machine.

Prequisites

You'll need an Amazon DynamoDB local instance running in a docker container.

You'll need a JavaScript runtime: https://github.com/rails/execjs
Clone the app and run bundle locally.

Running DynamoDB

Docker

Run the following to set up the local version of DynamoDB

    docker pull amazon/dynamodb-local
    docker run -d -p 8000:8000 amazon/dynamodb-local

Running the application (DynamoDB will need to be running)

foreman start

Running the tests

bundle exec rake

VCR

Some of our tests use VCR to generate stubbed responses. Read about how to test with VCR.

Running Sidekiq

We're using Sidekiq, a redis-backed queue, which plays nicely with ActiveJob and ActionMailer, to send emails.

In staging and production, we run instances of the application as workers, to process the email queue.

Locally

Sidekiq will start automatically when you run foreman start, but you can also run it alone with bundle exec sidekiq.

Sending emails or SMSs locally

Change the delivery method in development.rb:

config.action_mailer.delivery_method = :notify_email

You'll then need to pass a GOV.UK Notify API key as an environment variable NOTIFY_API_KEY as well the GOVUK_NOTIFY_EMAIL_TEMPLATE_ID and GOVUK_NOTIFY_SMS_TEMPLATE_ID template IDs.

You can create an api key here: https://www.notifications.service.gov.uk/services/6ba785b8-71e0-4d0e-9f41-b7aa8876e5a9/api/keys

Make sure to pick either "Team and whitelist" or "Testing". The api key can be revoked later.

If you're testing SMS as well, make sure you have a mobile number associated with your Notify profile.

Running the app

GOVUK_NOTIFY_EMAIL_TEMPLATE_ID=<email_template_id_from_notify> GOVUK_NOTIFY_SMS_TEMPLATE_ID=<sms_template_id_from_notify> NOTIFY_API_KEY=<your_api_key> foreman start

If your Notify service doesn't have a template you'll need to create a template in Notify.

The template should have a Message of ((body)) only.

Deployment pipeline

Every commit to master is deployed to GOV.UK PaaS by this concourse pipeline, which is configured in concourse/pipeline.yml.

The concourse pipeline has credentials for the govuk-forms-deployer user in GOV.UK PaaS. This user has the SpaceDeveloper role, so it can cf push the application.

How to deploy breaking changes

Details can be found here.

Licence

MIT License

govuk-coronavirus-vulnerable-people-form's Issues

Performance: minify CSS

Potential 7kb saving

404 and 500 error pages load entirety of GOV.UK Frontend / Design System CSS

The static error pages use a downloaded version of the GOV.UK Design System CSS - this should be replaced with only the styles needed for the page, which could be inlined.

Performance: CDN Static assets, consider caching policy

This would mean people dont need to download static assets multiple times through the question pages.

https://web.dev/uses-long-cache-ttl/?utm_source=lighthouse&utm_medium=devtools

Validation: support address, check postcode regex isnt too clever

It looks a bit clever, we need to make sure it doesnt restrict input by making too many assumptions about postcodes.

Going from check answers to address form doesn't persist first two lines of address

1. Fill in form with address fields
2. Complete form
3. From check answers / summary page, edit the address

Expected all of address to be in form, but the first two lines of address are not there.

Test in Safari and Chrome, both in private mode and normal mode.

Validation: Name, assumes that all people have a first name and last name. Is this the case?

https://www.kalzumeus.com/2010/06/17/falsehoods-programmers-believe-about-names/

Might want to consider making this validation just to check that they've entered something. Or just use a single 'name' field.

Validation: contact details, should we require at least one form?

Validation: date of birth, should fields accept words instead of numbers for months? e.g. Jan instead of 1

Right now it will stop users who use words.

Ensure hint text is black

Tim suggestion since users of this service may be more likely to have visual impairments and we know this can be a problem sometimes.

Support address second line does not have a label

Contact page form errors, doesn't retain form values

1. Add phone numbers to contact details page
2. Put in wrong email address - eg 123

When the page shows the error message, the two phone numbers have been lost.

Expected - all of the values should be retained, even if wrong.

Refactor: should temp or cough related code be removed?

http://localhost:5000/coronavirus-form/temperature-or-cough

Make sure this service is not indexed from Google

Only the start page should be indexed to prevent users from accidentally starting halfway through the service.

Performance: Check performance stuff

1. gzip enabled?
2. CSS custom build so not using 'all components'?

Assets requested from CSS do not have a long cache time

URL	Cache TTL	Size
/assets/light-94a07e06a1-v2-eedfb3c….woff2	None	50 KB
/assets/bold-b542beb274-v2-06eba01….woff2	None	31 KB
/assets/govuk-crest-2x-c654888….png	None	9 KB
/assets/application-5dfb935….js	1 d	164 KB
/assets/application-7151bdd….css	1 d	26 KB
/assets/print-639d73a….css	1 d	3 KB

We should:

• see if it's possible to cache all assets not just css
• increase the cache time from 1d to something longer

This'll mean that there's no risk of users re-downloading the font between page transitions, which would make the page loads significantly slower.

• https://web.dev/uses-long-cache-ttl/#how-to-cache-static-resources-using-http-caching

Refactor: Upstream improvements to publishing components gem to remove TODOs in custom Scss

After deadline: improve change your answers 'change links' so they're shorter

Check your answers summary table needs more whitespace below it

Validation: date of birth, check if date is in the past

"Date of birth must be in the past"

Making a note to come back to this if I have time, not critical.

User can say they don't live in England from check answers page

1. Fill in form
2. On check answers page, edit 'Do you live in England?' question
3. Say 'No'

Page then goes back to check answers / summary page. Should it display the 'Not eligible' page?

Add service name to header

Just a thought, going on the design system and service manual, but is there any intention to add the service name to the header? If so, happy to open a pull request.

Validation: support address, review if county should be optional

At the moment it is a require field if postcode is not supplied, does this make sense? The validation could be simpler for users if county was optional.

Usability: Should the 'NHS Number' text input use a numeric keyboard?

Host the favicon.ico 'locally' for improved performance

At the moment we have a whole new TCP connection created to www.gov.uk, which is then redirecting back to the assets domain. A whole TCP connection for a 301 redirect and a 5KB icon file is a waste. We should look at hosting the icon on the service domain and linking to it in the <head>.

Waterfall:

Connection view:

WebPageTest results

Some error summarys linking to the form tag instead of the first input

In radio form groups, the field linked to is not the first input but instead the form itself.

It should focus the first input.

See http://govuk-frontend-review.herokuapp.com/full-page-examples/how-do-you-want-to-sign-in for an example of how the error summary should work.

Update 'home' breadcrumbs to 'back buttons'

Review use of autocomplete and spellcheck attributes

Autocomplete can massively help disabled people and is a WCAG 2.1 requirement.

https://www.w3.org/TR/WCAG21/#input-purposes

The GOV.UK Design System examples include autocomplete / spellcheck attributes in their examples:

https://design-system.service.gov.uk/patterns

We should take care to only use it where we're confident autofill would be desirable.

Validation: put 'Error:' prefix in title when an error is being shown