From 4e63a601e97833cf115f0570decfdbdd5c322a0d Mon Sep 17 00:00:00 2001 From: Jonathan Bobel Date: Wed, 31 Jan 2024 11:10:46 -0500 Subject: [PATCH 01/59] Bug - very small content update on pricing page --- app/templates/views/pricing/index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/templates/views/pricing/index.html b/app/templates/views/pricing/index.html index 436da7735..73c67770e 100644 --- a/app/templates/views/pricing/index.html +++ b/app/templates/views/pricing/index.html @@ -30,7 +30,7 @@ more parts towards the allowance if you:

Long text messages

-

If a text message is longer than 160 characters (including spaces), it counts as more than one message.

+

If a text message is longer than 160 characters (including spaces), it counts as more than one message part.

{% call mapping_table( From d82b56c6443a5161bd0b81ece153ba3b39cefd36 Mon Sep 17 00:00:00 2001 From: Jonathan Bobel Date: Thu, 1 Feb 2024 12:09:43 -0500 Subject: [PATCH 02/59] Updates per Meghan --- app/templates/views/guidance/index.html | 4 +-- app/templates/views/roadmap.html | 4 +-- app/templates/views/security.html | 37 ++----------------------- app/templates/views/support/index.html | 6 ++-- 4 files changed, 9 insertions(+), 42 deletions(-) diff --git a/app/templates/views/guidance/index.html b/app/templates/views/guidance/index.html index e754ef245..b7d6ffa1a 100644 --- a/app/templates/views/guidance/index.html +++ b/app/templates/views/guidance/index.html @@ -41,7 +41,7 @@

To create and format your message

  1. All messages start from a template
    2. -
  2. Click “Send Messages”. You’ll see existing templates.
    3. +
  3. Click “Send Messages”. You’ll see existing templates.
  4. Add a new template or choose an existing template and select Edit.
@@ -120,7 +120,7 @@ {# Identify your program #} -

Identify your program

+

Identify your program

You can help your recipients identify your texts as legitimate by customizing your messages to clearly state who they are from. Consider using the program or benefit name that is most familiar to your recipients.

diff --git a/app/templates/views/roadmap.html b/app/templates/views/roadmap.html index 6ea2e7cfb..58c9ad4d1 100644 --- a/app/templates/views/roadmap.html +++ b/app/templates/views/roadmap.html @@ -50,9 +50,9 @@
  • Message send/failure analytics
    • - Next +

    Next

    -

    If the pilot is successful, we hope to recruit additional high-impact partners to improve outcomes for low-income individuals and families.

    +

    If the pilot is successful, we hope to recruit additional partners to improve outcomes for low-income individuals and families.

    Goals during this stage:

    diff --git a/app/templates/views/security.html b/app/templates/views/security.html index d676b37bf..35abece07 100644 --- a/app/templates/views/security.html +++ b/app/templates/views/security.html @@ -65,9 +65,9 @@

    Protect sensitive information

    Some messages include sensitive information like security codes or password reset links.

    If you’re sending a message with sensitive information, you can choose to hide those details on the Notify dashboard once the message has been sent. This means that only the message recipient will be able to see that information.

    + Screenshot of a teat message in review with the link to 'hide personalization after sending' circled. -

    User permissions and signing in

    -

    You can set different user permissions in Notify. This lets you control who in your team has access to certain parts of the service.

    Two-factor authentication

    To sign in to Notify, you’ll need to enter:

      @@ -76,11 +76,6 @@

    If signing in with a text message is a problem for your team, contact us to find out about using an email link instead.

    - Screenshot of a teat message in review with the link to 'hide personalization after sending' circled. - -

    How to hide PII after sending a message

    -

    User permissions and signing in

    You can set different user permissions in Notify. This lets you control who in your team has access to certain parts of the service.

    @@ -93,32 +88,4 @@

    If signing in with a text message is a problem for your team, contact us to find out about using an email link instead.

    - - - - - - {% endblock %} diff --git a/app/templates/views/support/index.html b/app/templates/views/support/index.html index d9d6abd53..dd5ad9c10 100644 --- a/app/templates/views/support/index.html +++ b/app/templates/views/support/index.html @@ -13,9 +13,9 @@

    Contact us

    Notify is designed to be easy to use.

      -
    • For information on personalization and data preparation, see Guidance.
      • -
    • For help interpreting delivery reports, see Delivery Status.
      • -
    • For details on pricing and what counts as a message part, see Pricing.
      • +
    • For information on personalization and data preparation, see Guidance.
      • +
    • For help interpreting delivery reports, see Delivery Status.
      • +
    • For details on pricing and what counts as a message part, see Pricing.

    If you have other questions, we are available at notify-support@gsa.gov.

    From 3ac65b122c50510576cd22eb3c2547fe1433885e Mon Sep 17 00:00:00 2001 From: Beverly Nguyen Date: Fri, 2 Feb 2024 14:52:48 -0800 Subject: [PATCH 03/59] inital preview page --- app/main/views/send.py | 55 ++++++++++++++- app/templates/views/check/ok.html | 79 +++++++++++---------- app/templates/views/check/preview.html | 96 ++++++++++++++++++++++++++ 3 files changed, 188 insertions(+), 42 deletions(-) create mode 100644 app/templates/views/check/preview.html diff --git a/app/main/views/send.py b/app/main/views/send.py index 91e9814af..1d1304dc4 100644 --- a/app/main/views/send.py +++ b/app/main/views/send.py @@ -13,6 +13,7 @@ from notifications_utils.recipients import RecipientCSV, first_column_headings from notifications_utils.sanitise_text import SanitiseASCII from xlrd.biffh import XLRDError from xlrd.xldate import XLDateError +from pprint import pprint from app import ( current_service, @@ -563,6 +564,7 @@ def _check_messages(service_id, template_id, upload_id, preview_row): sent_previously=job_api_client.has_sent_previously( service_id, template.id, db_template["version"], original_file_name ), + template_id=template_id ) @@ -606,17 +608,18 @@ def check_messages(service_id, template_id, upload_id, row_index=2): metadata_kwargs["sender_id"] = session["sender_id"] set_metadata_on_csv_upload(service_id, upload_id, **metadata_kwargs) - + session['scheduled_for']=request.form.get("scheduled_for", "") return render_template("views/check/ok.html", **data) @main.route("/services//start-job/", methods=["POST"]) @user_has_permissions("send_messages", restrict_admin_usage=True) def start_job(service_id, upload_id): + scheduled_for = session.pop('scheduled_for', None) job_api_client.create_job( upload_id, service_id, - scheduled_for=request.form.get("scheduled_for", ""), + scheduled_for=scheduled_for, ) session.pop("sender_id", None) @@ -630,6 +633,54 @@ def start_job(service_id, upload_id): ) +@main.route( + "/services///check//preview", + methods=["POST"], +) +@main.route( + "/services///check//row-/preview", + methods=["POST"], +) +@main.route("/services//preview-job/", methods=["POST"]) +@user_has_permissions("send_messages", restrict_admin_usage=True) +def preview_job(service_id, template_id, upload_id, row_index=2): + # Store form data in session temporarily + session['scheduled_for'] = request.form.get('scheduled_for', 'Not specified') + # session.pop("sender_id", None) + data = _check_messages(service_id, template_id, upload_id, row_index) + data["allowed_file_extensions"] = Spreadsheet.ALLOWED_FILE_EXTENSIONS + + if ( + data["recipients"].too_many_rows + or not data["count_of_recipients"] + or not data["recipients"].has_recipient_columns + or data["recipients"].duplicate_recipient_column_headers + or data["recipients"].missing_column_headers + or data["sent_previously"] + ): + return render_template("views/check/column-errors.html", **data) + + if data["row_errors"]: + return render_template("views/check/row-errors.html", **data) + + if data["errors"]: + return render_template("views/check/column-errors.html", **data) + + metadata_kwargs = { + "notification_count": data["count_of_recipients"], + "template_id": template_id, + "valid": True, + "original_file_name": data.get("original_file_name", ""), + } + + if session.get("sender_id"): + metadata_kwargs["sender_id"] = session["sender_id"] + + set_metadata_on_csv_upload(service_id, upload_id, **metadata_kwargs) + + return render_template('views/check/preview.html', data=session['scheduled_for'], **data) + + def fields_to_fill_in(template, prefill_current_user=False): if not prefill_current_user: return first_column_headings[template.template_type] + list( diff --git a/app/templates/views/check/ok.html b/app/templates/views/check/ok.html index b795a5971..6fc96f73b 100644 --- a/app/templates/views/check/ok.html +++ b/app/templates/views/check/ok.html @@ -19,11 +19,11 @@ {% block maincolumn_content %} - {{ page_header('Preview of {}'.format(template.name)) }} + {{ page_header('Select delivery time') }} {{ template|string }}
    -
    + {% if choose_time_form %} {{ choose_time_form.scheduled_for(param_extensions={ @@ -36,56 +36,55 @@ }) }} {% endif %} + {% if not request.args.from_test %} +

    Send list

    +

    {{ original_file_name }}

    + {% endif %} {% set button_text %} - Send {{ count_of_recipients|message_count(template.template_type) }} + Preview send + {% endset %} {{ usaButton({ "text": button_text }) }}
    - {% if not request.args.from_test %} - -

    {{ original_file_name }}

    - -
    - {% call(item, row_number) list_table( - recipients.displayed_rows, - caption=original_file_name, - caption_visible=False, - field_headings=[ - 'Row in file'|safe - ] + recipients.column_headers - ) %} - {% call index_field() %} - - {% if (item.index + 2) == preview_row %} - {{ item.index + 2 }} - {% else %} - {{ item.index + 2 }} - {% endif %} - - {% endcall %} - {% for column in recipients.column_headers %} - {% if item[column].ignore %} - {{ text_field(item[column].data or '', status='default') }} + - {% endif %} - - {% if count_of_displayed_recipients < count_of_recipients %} + {% endblock %} diff --git a/app/templates/views/check/preview.html b/app/templates/views/check/preview.html new file mode 100644 index 000000000..14b9166f3 --- /dev/null +++ b/app/templates/views/check/preview.html @@ -0,0 +1,96 @@ +{% extends "withnav_template.html" %} +{% from "components/banner.html" import banner_wrapper %} +{% from "components/table.html" import list_table, field, text_field, index_field, hidden_field_heading %} +{% from "components/page-header.html" import page_header %} +{% from "components/components/button/macro.njk" import usaButton %} +{% from "components/components/skip-link/macro.njk" import usaSkipLink %} +{% from "components/components/back-link/macro.njk" import usaBackLink %} + +{% set file_contents_header_id = 'file-preview' %} + +{% block service_page_title %} + {{ "Preview of {}".format(template.name) }} +{% endblock %} + + +{% block backLink %} + {{ usaBackLink({ "href": back_link }) }} +{% endblock %} + +{% block maincolumn_content %} + + {{ page_header('Send messages') }} +

    Message

    + {{ template|string }} +
    +
    + + + {% if not request.args.from_test %} + +

    Preview list

    + +
      +
    • +
      + Description Icon +
      +
      +

      {{ original_file_name }}

      +
      +
      • +
    + + +
    + {% call(item, row_number) list_table( + recipients.displayed_rows, + caption=original_file_name, + caption_visible=False, + field_headings=recipients.column_headers + ) %} + {% for column in recipients.column_headers %} + {% if item[column].ignore %} + {{ text_field(item[column].data or '', status='default') }} + {% else %} + {{ text_field(item[column].data or '') }} + {% endif %} + {% endfor %} + {% if item[None].data %} + {% for column in item[None].data %} + {{ text_field(column, status='default') }} + {% endfor %} + {% endif %} + {% endcall %} +
    + + {% endif %} +

    The service be charged 10 message parts for a total of 20 messages when this batch it sent + There are 480 of 500 messages remaining in your service

    +

    Does everything look good?

    + {% set button_text %} + Send + + {% endset %} + {{ usaButton({ "text": button_text }) }} + +
    +
    + + + + +{% endblock %} From c073d2efacdd6292a1572d2919401153a1b6f3df Mon Sep 17 00:00:00 2001 From: Beverly Nguyen Date: Fri, 2 Feb 2024 16:14:50 -0800 Subject: [PATCH 04/59] revising message preview --- app/main/views/send.py | 7 +------ app/templates/views/check/preview.html | 4 ++++ 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/app/main/views/send.py b/app/main/views/send.py index 1d1304dc4..6c014b102 100644 --- a/app/main/views/send.py +++ b/app/main/views/send.py @@ -637,11 +637,6 @@ def start_job(service_id, upload_id): "/services///check//preview", methods=["POST"], ) -@main.route( - "/services///check//row-/preview", - methods=["POST"], -) -@main.route("/services//preview-job/", methods=["POST"]) @user_has_permissions("send_messages", restrict_admin_usage=True) def preview_job(service_id, template_id, upload_id, row_index=2): # Store form data in session temporarily @@ -678,7 +673,7 @@ def preview_job(service_id, template_id, upload_id, row_index=2): set_metadata_on_csv_upload(service_id, upload_id, **metadata_kwargs) - return render_template('views/check/preview.html', data=session['scheduled_for'], **data) + return render_template('views/check/preview.html', data=session['scheduled_for'], **data, metadata_kwargs=metadata_kwargs) def fields_to_fill_in(template, prefill_current_user=False): diff --git a/app/templates/views/check/preview.html b/app/templates/views/check/preview.html index 14b9166f3..1c07bffc6 100644 --- a/app/templates/views/check/preview.html +++ b/app/templates/views/check/preview.html @@ -21,6 +21,10 @@ {{ page_header('Send messages') }}

    Message

    + {% if data %} +

    Time: {{data | format_datetime_short_america}}

    + {% endif %} +

    File: {{metadata_kwargs.original_file_name}}

    {{ template|string }}
    From 74d8ed834008dd9ae477df7c69f622b8f0a9e975 Mon Sep 17 00:00:00 2001 From: Jonathan Bobel Date: Mon, 5 Feb 2024 13:32:53 -0500 Subject: [PATCH 05/59] 1050 - Fixing repsonsive issues in the header - and beyond --- .../uswds/_uswds-theme-custom-styles.scss | 15 ++- .../components/components/header/template.njk | 115 +++++++++--------- 2 files changed, 73 insertions(+), 57 deletions(-) diff --git a/app/assets/sass/uswds/_uswds-theme-custom-styles.scss b/app/assets/sass/uswds/_uswds-theme-custom-styles.scss index b5f2147cd..fb26072ce 100644 --- a/app/assets/sass/uswds/_uswds-theme-custom-styles.scss +++ b/app/assets/sass/uswds/_uswds-theme-custom-styles.scss @@ -26,7 +26,7 @@ i.e. .usa-logo { font-family: family("sans"); margin: units(4) 0; - @include at-media-max('mobile-lg') { + @include at-media-max('desktop') { margin: units(4) 0 units(4) units(2); } img { @@ -43,6 +43,16 @@ i.e. text-decoration: underline; } } + @include at-media-max('desktop') { + padding: 0 units(2); + ul li { + padding-bottom: units(1); + } + } + } + .usa-nav-container { + max-width: 100%; + padding: 0; } } @@ -343,6 +353,9 @@ td.table-empty-message { background-image: url(../img/material-icons/description.svg); } } + .job-table, .dashboard-table { + overflow-x: scroll; + } } .dashboard-table { diff --git a/app/templates/components/components/header/template.njk b/app/templates/components/components/header/template.njk index 6cc8cabd8..7719ac2c8 100644 --- a/app/templates/components/components/header/template.njk +++ b/app/templates/components/components/header/template.njk @@ -44,61 +44,64 @@
    -
    - - {% if current_user.is_authenticated %} - - {% endif %} -
    - + {% if current_user.is_authenticated %} + + {% endif %} +
    + +
    From d6f012ee9e0106df05286d0deeff6c0a12de4af7 Mon Sep 17 00:00:00 2001 From: Beverly Nguyen Date: Tue, 6 Feb 2024 16:08:14 -0800 Subject: [PATCH 06/59] editing and creating new preview functions and backlinks --- app/assets/sass/uswds/_legacy-styles.scss | 4 +- app/main/views/send.py | 117 +++++++++++------- app/templates/views/check/ok.html | 41 +----- app/templates/views/check/preview.html | 38 ++---- app/templates/views/notifications/check.html | 11 +- .../views/notifications/preview.html | 65 ++++++++++ 6 files changed, 153 insertions(+), 123 deletions(-) create mode 100644 app/templates/views/notifications/preview.html diff --git a/app/assets/sass/uswds/_legacy-styles.scss b/app/assets/sass/uswds/_legacy-styles.scss index 3b09e2218..a4a6e3d2c 100644 --- a/app/assets/sass/uswds/_legacy-styles.scss +++ b/app/assets/sass/uswds/_legacy-styles.scss @@ -54,7 +54,7 @@ .sms-message-recipient { color: color('gray-cool-90'); - margin: 0 0 units(1); + margin: units(1) 0 units(1); } .sms-message-status { @@ -131,7 +131,7 @@ &-label, &-button-label { font-weight: bold; - font-size: 19px; + font-size: 19px; display: block; margin: 0 0 10px 0; } diff --git a/app/main/views/send.py b/app/main/views/send.py index 6c014b102..96389898b 100644 --- a/app/main/views/send.py +++ b/app/main/views/send.py @@ -527,11 +527,17 @@ def _check_messages(service_id, template_id, upload_id, preview_row): back_link = url_for( "main.send_one_off", service_id=service_id, template_id=template.id ) + back_link_from_preview = url_for( + "main.send_one_off", service_id=service_id, template_id=template.id + ) choose_time_form = None else: back_link = url_for( "main.send_messages", service_id=service_id, template_id=template.id ) + back_link_from_preview = url_for( + "main.check_messages", service_id=service_id, template_id=template.id, upload_id=upload_id + ) choose_time_form = ChooseTimeForm() if preview_row < 2: @@ -559,6 +565,7 @@ def _check_messages(service_id, template_id, upload_id, preview_row): remaining_messages=remaining_messages, choose_time_form=choose_time_form, back_link=back_link, + back_link_from_preview=back_link_from_preview, first_recipient_column=recipients.recipient_column_headers[0], preview_row=preview_row, sent_previously=job_api_client.has_sent_previously( @@ -612,6 +619,34 @@ def check_messages(service_id, template_id, upload_id, row_index=2): return render_template("views/check/ok.html", **data) +@main.route( + "/services///check//preview", + methods=["POST"], +) +@user_has_permissions("send_messages", restrict_admin_usage=True) +def preview_job(service_id, template_id, upload_id, row_index=2): + session['scheduled_for'] = request.form.get('scheduled_for', 'Not specified') + data = _check_messages(service_id, template_id, upload_id, row_index) + data["allowed_file_extensions"] = Spreadsheet.ALLOWED_FILE_EXTENSIONS + if ( + data["recipients"].too_many_rows + or not data["count_of_recipients"] + or not data["recipients"].has_recipient_columns + or data["recipients"].duplicate_recipient_column_headers + or data["recipients"].missing_column_headers + or data["sent_previously"] + ): + return render_template("views/check/column-errors.html", **data) + + if data["row_errors"]: + return render_template("views/check/row-errors.html", **data) + + if data["errors"]: + return render_template("views/check/column-errors.html", **data) + + return render_template('views/check/preview.html', scheduled_for=session['scheduled_for'], **data, +) + @main.route("/services//start-job/", methods=["POST"]) @user_has_permissions("send_messages", restrict_admin_usage=True) def start_job(service_id, upload_id): @@ -633,49 +668,6 @@ def start_job(service_id, upload_id): ) -@main.route( - "/services///check//preview", - methods=["POST"], -) -@user_has_permissions("send_messages", restrict_admin_usage=True) -def preview_job(service_id, template_id, upload_id, row_index=2): - # Store form data in session temporarily - session['scheduled_for'] = request.form.get('scheduled_for', 'Not specified') - # session.pop("sender_id", None) - data = _check_messages(service_id, template_id, upload_id, row_index) - data["allowed_file_extensions"] = Spreadsheet.ALLOWED_FILE_EXTENSIONS - - if ( - data["recipients"].too_many_rows - or not data["count_of_recipients"] - or not data["recipients"].has_recipient_columns - or data["recipients"].duplicate_recipient_column_headers - or data["recipients"].missing_column_headers - or data["sent_previously"] - ): - return render_template("views/check/column-errors.html", **data) - - if data["row_errors"]: - return render_template("views/check/row-errors.html", **data) - - if data["errors"]: - return render_template("views/check/column-errors.html", **data) - - metadata_kwargs = { - "notification_count": data["count_of_recipients"], - "template_id": template_id, - "valid": True, - "original_file_name": data.get("original_file_name", ""), - } - - if session.get("sender_id"): - metadata_kwargs["sender_id"] = session["sender_id"] - - set_metadata_on_csv_upload(service_id, upload_id, **metadata_kwargs) - - return render_template('views/check/preview.html', data=session['scheduled_for'], **data, metadata_kwargs=metadata_kwargs) - - def fields_to_fill_in(template, prefill_current_user=False): if not prefill_current_user: return first_column_headings[template.template_type] + list( @@ -721,7 +713,15 @@ def get_send_test_page_title(template_type, entering_recipient, name=None): return "Personalize this message" -def get_back_link(service_id, template, step_index, placeholders=None): +def get_back_link(service_id, template, step_index, placeholders=None, preview=False,): + if preview: + return url_for( + "main.check_notification", + service_id=service_id, + template_id=template.id, + ) + + if step_index == 0: if should_skip_template_page(template._template): return url_for( @@ -826,6 +826,8 @@ def _check_notification(service_id, template_id, exception=None): back_link = get_back_link(service_id, template, len(placeholders), placeholders) + back_link_from_preview = get_back_link(service_id, template, len(placeholders), placeholders, preview=True) + choose_time_form = ChooseTimeForm() if (not session.get("recipient")) or not all_placeholders_in_session( @@ -839,6 +841,7 @@ def _check_notification(service_id, template_id, exception=None): return dict( template=template, back_link=back_link, + back_link_from_preview=back_link_from_preview, choose_time_form=choose_time_form, **(get_template_error_dict(exception) if exception else {}), ) @@ -869,6 +872,29 @@ def get_template_error_dict(exception): "original_file_name": False, } +@main.route( + "/services//template//notification/check/preview", + methods=["POST"], +) +@user_has_permissions("send_messages", restrict_admin_usage=True) +def preview_notification(service_id, template_id): + recipient = get_recipient() + if not recipient: + return redirect( + url_for( + ".send_one_off", + service_id=service_id, + template_id=template_id, + ) + ) + + session['scheduled_for'] = request.form.get('scheduled_for', 'Not specified') + + return render_template( + "views/notifications/preview.html", + **_check_notification(service_id, template_id), data=session['scheduled_for'] + ) + @main.route( "/services//template//notification/check", @@ -876,6 +902,7 @@ def get_template_error_dict(exception): ) @user_has_permissions("send_messages", restrict_admin_usage=True) def send_notification(service_id, template_id): + scheduled_for = session.pop('scheduled_for', None) recipient = get_recipient() if not recipient: return redirect( @@ -910,7 +937,7 @@ def send_notification(service_id, template_id): job_api_client.create_job( upload_id, service_id, - scheduled_for=request.form.get("scheduled_for", ""), + scheduled_for=scheduled_for, template_id=template_id, original_file_name=filename, notification_count=1, diff --git a/app/templates/views/check/ok.html b/app/templates/views/check/ok.html index 6fc96f73b..f70b6232e 100644 --- a/app/templates/views/check/ok.html +++ b/app/templates/views/check/ok.html @@ -41,50 +41,11 @@

    {{ original_file_name }}

    {% endif %} {% set button_text %} - Preview send - + Preview {% endset %} {{ usaButton({ "text": button_text }) }}
    - - - {% endblock %} diff --git a/app/templates/views/check/preview.html b/app/templates/views/check/preview.html index 1c07bffc6..c7b303a8a 100644 --- a/app/templates/views/check/preview.html +++ b/app/templates/views/check/preview.html @@ -14,35 +14,23 @@ {% block backLink %} - {{ usaBackLink({ "href": back_link }) }} + {{ usaBackLink({ "href": back_link_from_preview }) }} {% endblock %} {% block maincolumn_content %} - {{ page_header('Send messages') }} + {{ page_header('Preview') }}

    Message

    - {% if data %} -

    Time: {{data | format_datetime_short_america}}

    + {% if scheduled_for %} +

    Time: {{scheduled_for}}

    {% endif %} -

    File: {{metadata_kwargs.original_file_name}}

    +

    File: {{original_file_name}}

    {{ template|string }}
    - {% if not request.args.from_test %} -

    Preview list

    -
    • @@ -53,8 +41,6 @@
    - -
    {% call(item, row_number) list_table( recipients.displayed_rows, @@ -76,25 +62,15 @@ {% endif %} {% endcall %}
    - {% endif %} -

    The service be charged 10 message parts for a total of 20 messages when this batch it sent - There are 480 of 500 messages remaining in your service

    +

    Does everything look good?

    {% set button_text %} Send - {% endset %} {{ usaButton({ "text": button_text }) }}
    - - - - {% endblock %} diff --git a/app/templates/views/notifications/check.html b/app/templates/views/notifications/check.html index 5bc970f9b..fec77f779 100644 --- a/app/templates/views/notifications/check.html +++ b/app/templates/views/notifications/check.html @@ -40,17 +40,16 @@ {% endcall %} {% else %} - {{ page_header('Preview of ‘{}’'.format(template.name)) }} + {{ page_header('Select delivery time') }} {% endif %} {{ template|string }}
    {% if not error %} @@ -64,7 +63,9 @@ } }) }} {% endif %} - {% set button_text %}Send 1 {{ 1|message_count_label(template.template_type, suffix='') }}{% endset %} + {% set button_text %} + Preview + {% endset %} {{ usaButton({ "text": button_text }) }} {% endif %}
    diff --git a/app/templates/views/notifications/preview.html b/app/templates/views/notifications/preview.html new file mode 100644 index 000000000..868caefd3 --- /dev/null +++ b/app/templates/views/notifications/preview.html @@ -0,0 +1,65 @@ +{% extends "withnav_template.html" %} +{% from "components/banner.html" import banner_wrapper %} +{% from "components/page-header.html" import page_header %} +{% from "components/components/back-link/macro.njk" import usaBackLink %} +{% from "components/components/button/macro.njk" import usaButton %} + +{% block service_page_title %} + {{ "Error" if error else "Preview of ‘{}’".format(template.name) }} +{% endblock %} + +{% block backLink %} + {{ usaBackLink({ "href": back_link_from_preview }) }} +{% endblock %} + +{% block maincolumn_content %} + {% if error == 'not-allowed-to-send-to' %} +
    + {% call banner_wrapper(type='dangerous') %} + {% with + count_of_recipients=1, + template_type_label=( + 'phone number' if template.template_type == 'sms' else 'email address' + ) + %} + {% include "partials/check/not-allowed-to-send-to.html" %} + {% endwith %} + {% endcall %} +
    + {% elif error == 'too-many-messages' %} +
    + {% call banner_wrapper(type='dangerous') %} + {% include "partials/check/too-many-messages.html" %} + {% endcall %} +
    + {% elif error == 'message-too-long' %} + {# the only row_errors we can get when sending one off messages is that the message is too long #} +
    + {% call banner_wrapper(type='dangerous') %} + {% include "partials/check/message-too-long.html" %} + {% endcall %} +
    + {% else %} + {{ page_header('Preview of ‘{}’'.format(template.name)) }} + {% endif %} + + {{ template|string }} + +
    +
    + + {% if not error %} + {% set button_text %} + Send + {% endset %} + {{ usaButton({ "text": button_text }) }} + {% endif %} +
    +
    + +{% endblock %} From 8eb329b444bc01c00171fb4af3829615d46f07c5 Mon Sep 17 00:00:00 2001 From: Beverly Nguyen Date: Tue, 6 Feb 2024 16:42:11 -0800 Subject: [PATCH 07/59] removing comments --- app/main/views/send.py | 1 - 1 file changed, 1 deletion(-) diff --git a/app/main/views/send.py b/app/main/views/send.py index a07a9009e..59d3ff386 100644 --- a/app/main/views/send.py +++ b/app/main/views/send.py @@ -13,7 +13,6 @@ from notifications_utils.recipients import RecipientCSV, first_column_headings from notifications_utils.sanitise_text import SanitiseASCII from xlrd.biffh import XLRDError from xlrd.xldate import XLDateError -from pprint import pprint from app import ( current_service, From 15105bf5061ba46d490f6549e1700dd27be8091f Mon Sep 17 00:00:00 2001 From: Beverly Nguyen Date: Tue, 6 Feb 2024 17:06:18 -0800 Subject: [PATCH 08/59] fixed style checks --- app/main/views/send.py | 7 ++++--- app/templates/views/check/preview.html | 3 +-- app/templates/views/notifications/preview.html | 2 ++ 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/app/main/views/send.py b/app/main/views/send.py index 59d3ff386..bc527ae10 100644 --- a/app/main/views/send.py +++ b/app/main/views/send.py @@ -614,7 +614,7 @@ def check_messages(service_id, template_id, upload_id, row_index=2): metadata_kwargs["sender_id"] = session["sender_id"] set_metadata_on_csv_upload(service_id, upload_id, **metadata_kwargs) - session['scheduled_for']=request.form.get("scheduled_for", "") + session['scheduled_for'] = request.form.get("scheduled_for", "") return render_template("views/check/ok.html", **data) @@ -644,7 +644,8 @@ def preview_job(service_id, template_id, upload_id, row_index=2): return render_template("views/check/column-errors.html", **data) return render_template('views/check/preview.html', scheduled_for=session['scheduled_for'], **data, -) + ) + @main.route("/services//start-job/", methods=["POST"]) @user_has_permissions("send_messages", restrict_admin_usage=True) @@ -720,7 +721,6 @@ def get_back_link(service_id, template, step_index, placeholders=None, preview=F template_id=template.id, ) - if step_index == 0: if should_skip_template_page(template._template): return url_for( @@ -871,6 +871,7 @@ def get_template_error_dict(exception): "original_file_name": False, } + @main.route( "/services//template//notification/check/preview", methods=["POST"], diff --git a/app/templates/views/check/preview.html b/app/templates/views/check/preview.html index c7b303a8a..caab43cad 100644 --- a/app/templates/views/check/preview.html +++ b/app/templates/views/check/preview.html @@ -63,8 +63,7 @@ {% endcall %}
    {% endif %} - +

    This message will be delivered to 400 phone numbers and will use a total of 800 message parts, leaving Washington DSHS with 249,200 message parts remaining.

    Does everything look good?

    {% set button_text %} Send diff --git a/app/templates/views/notifications/preview.html b/app/templates/views/notifications/preview.html index 868caefd3..dd009fdcb 100644 --- a/app/templates/views/notifications/preview.html +++ b/app/templates/views/notifications/preview.html @@ -53,6 +53,8 @@ help='3' if help else 0 )}}" class='page-footer'> +

    This message will be delivered to 400 phone numbers and will use a total of 800 message parts, leaving Washington DSHS with 249,200 message parts remaining.

    +

    Does everything look good?

    {% if not error %} {% set button_text %} Send From fbf902e1684c1b645249ff8fd34e4a52740bdbe6 Mon Sep 17 00:00:00 2001 From: Beverly Nguyen Date: Tue, 6 Feb 2024 17:14:46 -0800 Subject: [PATCH 09/59] fixed style checks --- app/main/views/send.py | 3 +-- app/templates/views/check/preview.html | 2 +- app/templates/views/notifications/preview.html | 2 +- 3 files changed, 3 insertions(+), 4 deletions(-) diff --git a/app/main/views/send.py b/app/main/views/send.py index bc527ae10..d81eca83d 100644 --- a/app/main/views/send.py +++ b/app/main/views/send.py @@ -643,8 +643,7 @@ def preview_job(service_id, template_id, upload_id, row_index=2): if data["errors"]: return render_template("views/check/column-errors.html", **data) - return render_template('views/check/preview.html', scheduled_for=session['scheduled_for'], **data, - ) + return render_template('views/check/preview.html', scheduled_for=session['scheduled_for'], **data) @main.route("/services//start-job/", methods=["POST"]) diff --git a/app/templates/views/check/preview.html b/app/templates/views/check/preview.html index caab43cad..8dd40e612 100644 --- a/app/templates/views/check/preview.html +++ b/app/templates/views/check/preview.html @@ -63,7 +63,7 @@ {% endcall %} {% endif %} -

    This message will be delivered to 400 phone numbers and will use a total of 800 message parts, leaving Washington DSHS with 249,200 message parts remaining.

    +

    Placeholder: This message will be delivered to 400 phone numbers and will use a total of 800 message parts, leaving Washington DSHS with 249,200 message parts remaining.

    Does everything look good?

    {% set button_text %} Send diff --git a/app/templates/views/notifications/preview.html b/app/templates/views/notifications/preview.html index dd009fdcb..468e91f3b 100644 --- a/app/templates/views/notifications/preview.html +++ b/app/templates/views/notifications/preview.html @@ -53,7 +53,7 @@ help='3' if help else 0 )}}" class='page-footer'> -

    This message will be delivered to 400 phone numbers and will use a total of 800 message parts, leaving Washington DSHS with 249,200 message parts remaining.

    +

    Placeholder: This message will be delivered to 400 phone numbers and will use a total of 800 message parts, leaving Washington DSHS with 249,200 message parts remaining.

    Does everything look good?

    {% if not error %} {% set button_text %} From b019dc3fe9cfd4ca944a491b4a94a8956941fb3c Mon Sep 17 00:00:00 2001 From: Beverly Nguyen Date: Thu, 8 Feb 2024 18:43:17 -0800 Subject: [PATCH 10/59] updated pytest --- app/assets/sass/uswds/_legacy-styles.scss | 2 +- app/main/views/send.py | 43 ++++++--- app/templates/views/check/ok.html | 6 +- app/templates/views/check/preview.html | 6 +- app/templates/views/notifications/check.html | 5 +- tests/app/main/views/test_conversation.py | 2 +- tests/app/main/views/test_send.py | 97 ++++++++++++-------- tests/app/main/views/test_tour.py | 3 +- tests/app/test_navigation.py | 2 + 9 files changed, 102 insertions(+), 64 deletions(-) diff --git a/app/assets/sass/uswds/_legacy-styles.scss b/app/assets/sass/uswds/_legacy-styles.scss index a4a6e3d2c..242bb0f74 100644 --- a/app/assets/sass/uswds/_legacy-styles.scss +++ b/app/assets/sass/uswds/_legacy-styles.scss @@ -48,7 +48,7 @@ } } -.sms-message-sender { +.sms-message-sender, .sms-message-file-name, .sms-message-scheduler { margin: units(1) 0 0; } diff --git a/app/main/views/send.py b/app/main/views/send.py index d81eca83d..90834d965 100644 --- a/app/main/views/send.py +++ b/app/main/views/send.py @@ -535,7 +535,10 @@ def _check_messages(service_id, template_id, upload_id, preview_row): "main.send_messages", service_id=service_id, template_id=template.id ) back_link_from_preview = url_for( - "main.check_messages", service_id=service_id, template_id=template.id, upload_id=upload_id + "main.check_messages", + service_id=service_id, + template_id=template.id, + upload_id=upload_id, ) choose_time_form = ChooseTimeForm() @@ -570,7 +573,7 @@ def _check_messages(service_id, template_id, upload_id, preview_row): sent_previously=job_api_client.has_sent_previously( service_id, template.id, db_template["version"], original_file_name ), - template_id=template_id + template_id=template_id, ) @@ -614,17 +617,20 @@ def check_messages(service_id, template_id, upload_id, row_index=2): metadata_kwargs["sender_id"] = session["sender_id"] set_metadata_on_csv_upload(service_id, upload_id, **metadata_kwargs) - session['scheduled_for'] = request.form.get("scheduled_for", "") return render_template("views/check/ok.html", **data) @main.route( "/services///check//preview", - methods=["POST"], + methods=["GET"], +) +@main.route( + "/services///check//preview/row-", + methods=["GET"], ) @user_has_permissions("send_messages", restrict_admin_usage=True) def preview_job(service_id, template_id, upload_id, row_index=2): - session['scheduled_for'] = request.form.get('scheduled_for', 'Not specified') + session["scheduled_for"] = request.args.get("scheduled_for", "") data = _check_messages(service_id, template_id, upload_id, row_index) data["allowed_file_extensions"] = Spreadsheet.ALLOWED_FILE_EXTENSIONS if ( @@ -643,13 +649,15 @@ def preview_job(service_id, template_id, upload_id, row_index=2): if data["errors"]: return render_template("views/check/column-errors.html", **data) - return render_template('views/check/preview.html', scheduled_for=session['scheduled_for'], **data) + return render_template( + "views/check/preview.html", scheduled_for=session["scheduled_for"], **data + ) @main.route("/services//start-job/", methods=["POST"]) @user_has_permissions("send_messages", restrict_admin_usage=True) def start_job(service_id, upload_id): - scheduled_for = session.pop('scheduled_for', None) + scheduled_for = session.pop("scheduled_for", None) job_api_client.create_job( upload_id, service_id, @@ -712,7 +720,13 @@ def get_send_test_page_title(template_type, entering_recipient, name=None): return "Personalize this message" -def get_back_link(service_id, template, step_index, placeholders=None, preview=False,): +def get_back_link( + service_id, + template, + step_index, + placeholders=None, + preview=False, +): if preview: return url_for( "main.check_notification", @@ -824,7 +838,9 @@ def _check_notification(service_id, template_id, exception=None): back_link = get_back_link(service_id, template, len(placeholders), placeholders) - back_link_from_preview = get_back_link(service_id, template, len(placeholders), placeholders, preview=True) + back_link_from_preview = get_back_link( + service_id, template, len(placeholders), placeholders, preview=True + ) choose_time_form = ChooseTimeForm() @@ -873,7 +889,7 @@ def get_template_error_dict(exception): @main.route( "/services//template//notification/check/preview", - methods=["POST"], + methods=["GET"], ) @user_has_permissions("send_messages", restrict_admin_usage=True) def preview_notification(service_id, template_id): @@ -887,11 +903,12 @@ def preview_notification(service_id, template_id): ) ) - session['scheduled_for'] = request.form.get('scheduled_for', 'Not specified') + session["scheduled_for"] = request.args.get("scheduled_for", "") return render_template( "views/notifications/preview.html", - **_check_notification(service_id, template_id), data=session['scheduled_for'] + **_check_notification(service_id, template_id), + scheduled_for=session["scheduled_for"], ) @@ -901,7 +918,7 @@ def preview_notification(service_id, template_id): ) @user_has_permissions("send_messages", restrict_admin_usage=True) def send_notification(service_id, template_id): - scheduled_for = session.pop('scheduled_for', None) + scheduled_for = session.pop("scheduled_for", "") recipient = get_recipient() if not recipient: return redirect( diff --git a/app/templates/views/check/ok.html b/app/templates/views/check/ok.html index f70b6232e..95fd1abea 100644 --- a/app/templates/views/check/ok.html +++ b/app/templates/views/check/ok.html @@ -1,6 +1,5 @@ {% extends "withnav_template.html" %} {% from "components/banner.html" import banner_wrapper %} -{% from "components/table.html" import list_table, field, text_field, index_field, hidden_field_heading %} {% from "components/page-header.html" import page_header %} {% from "components/components/button/macro.njk" import usaButton %} {% from "components/components/skip-link/macro.njk" import usaSkipLink %} @@ -9,7 +8,7 @@ {% set file_contents_header_id = 'file-preview' %} {% block service_page_title %} - {{ "Preview of {}".format(template.name) }} + {{ "Select delivery time" }} {% endblock %} @@ -23,8 +22,7 @@ {{ template|string }}
    -
    - + {% if choose_time_form %} {{ choose_time_form.scheduled_for(param_extensions={ 'formGroup': {'classes': 'bottom-gutter-2-3'}, diff --git a/app/templates/views/check/preview.html b/app/templates/views/check/preview.html index 8dd40e612..ae8ecea91 100644 --- a/app/templates/views/check/preview.html +++ b/app/templates/views/check/preview.html @@ -1,6 +1,6 @@ {% extends "withnav_template.html" %} {% from "components/banner.html" import banner_wrapper %} -{% from "components/table.html" import list_table, field, text_field, index_field, hidden_field_heading %} +{% from "components/table.html" import list_table, field, text_field, hidden_field_heading %} {% from "components/page-header.html" import page_header %} {% from "components/components/button/macro.njk" import usaButton %} {% from "components/components/skip-link/macro.njk" import usaSkipLink %} @@ -22,9 +22,9 @@ {{ page_header('Preview') }}

    Message

    {% if scheduled_for %} -

    Time: {{scheduled_for}}

    +

    Time: {{scheduled_for}}

    {% endif %} -

    File: {{original_file_name}}

    +

    File: {{original_file_name}}

    {{ template|string }}
    diff --git a/app/templates/views/notifications/check.html b/app/templates/views/notifications/check.html index fec77f779..86f704495 100644 --- a/app/templates/views/notifications/check.html +++ b/app/templates/views/notifications/check.html @@ -5,7 +5,7 @@ {% from "components/components/button/macro.njk" import usaButton %} {% block service_page_title %} - {{ "Error" if error else "Preview of ‘{}’".format(template.name) }} + {{ "Error" if error else "Select delivery time" }} {% endblock %} {% block backLink %} @@ -46,12 +46,11 @@ {{ template|string }}
    - - {% if not error %} {% if choose_time_form %} {{ choose_time_form.scheduled_for(param_extensions={ diff --git a/tests/app/main/views/test_conversation.py b/tests/app/main/views/test_conversation.py index 215a8e828..1139cd43f 100644 --- a/tests/app/main/views/test_conversation.py +++ b/tests/app/main/views/test_conversation.py @@ -391,7 +391,7 @@ def test_conversation_reply_redirects_with_phone_number_from_notification( ) for element, expected_text in [ - ("h1", "Preview of ‘Two week reminder’"), + ("h1", "Select delivery time"), (".sms-message-recipient", "To: 2021234567"), ( ".sms-message-wrapper", diff --git a/tests/app/main/views/test_send.py b/tests/app/main/views/test_send.py index 7448c44cf..f98bf789c 100644 --- a/tests/app/main/views/test_send.py +++ b/tests/app/main/views/test_send.py @@ -963,39 +963,19 @@ def test_upload_valid_csv_shows_preview_and_table( ) page = client_request.get( - "main.check_messages", + "main.preview_job", service_id=SERVICE_ONE_ID, template_id=fake_uuid, upload_id=fake_uuid, **extra_args, ) - mock_s3_set_metadata.assert_called_once_with( - SERVICE_ONE_ID, - fake_uuid, - notification_count=3, - template_id=fake_uuid, - valid=True, - original_file_name="example.csv", - ) - - assert page.h1.text.strip() == "Preview of Two week reminder" + assert page.h1.text.strip() == "Preview" + assert page.select("h2")[1].text.strip() == "Preview list" + assert page.h2.text.strip() == "Message" assert page.select_one(".sms-message-recipient").text.strip() == expected_recipient assert page.select_one(".sms-message-wrapper").text.strip() == expected_message - - assert page.select_one(".table-field-index").text.strip() == "2" - - if expected_link_in_first_row: - assert page.select_one(".table-field-index a")["href"] == url_for( - "main.check_messages", - service_id=SERVICE_ONE_ID, - template_id=fake_uuid, - upload_id=fake_uuid, - row_index=2, - original_file_name="example.csv", - ) - else: - assert not page.select_one(".table-field-index").select_one("a") + assert not page.select_one(".table-field-index") for row_index, row in enumerate( [ @@ -1043,7 +1023,7 @@ def test_upload_valid_csv_shows_preview_and_table( for index, cell in enumerate(row): row = page.select("table tbody tr")[row_index] assert "id" not in row - assert normalize_spaces(str(row.select("td")[index + 1])) == cell + assert normalize_spaces(str(row.select("td")[index])) == cell def test_show_all_columns_if_there_are_duplicate_recipient_columns( @@ -1674,7 +1654,7 @@ def test_send_one_off_email_to_self_without_placeholders_redirects_to_check_page _follow_redirects=True, ) - assert page.select("h1")[0].text.strip() == "Preview of ‘Two week reminder’" + assert page.select("h1")[0].text.strip() == "Select delivery time" @pytest.mark.parametrize( @@ -1901,10 +1881,10 @@ def test_upload_csvfile_with_valid_phone_shows_all_numbers( original_file_name="example.csv", ) - assert "202 867 0701" in page.text - assert "202 867 0749" in page.text - assert "202 867 0750" not in page.text - assert "Only showing the first 50 rows" in page.text + assert "Select delivery time" in page.text + # assert "202 867 0749" in page.text + # assert "202 867 0750" not in page.text + # assert "Only showing the first 50 rows" in page.text mock_get_notification_count.assert_called_with(service_one["id"]) @@ -1988,7 +1968,7 @@ def test_test_message_can_only_be_sent_now( assert 'name="scheduled_for"' not in content -def test_send_button_is_correctly_labelled( +def test_preview_button_is_correctly_labelled( client_request, mocker, mock_get_live_service, @@ -2013,9 +1993,7 @@ def test_send_button_is_correctly_labelled( template_id=fake_uuid, ) - assert normalize_spaces(page.select_one("main [type=submit]").text) == ( - "Send 1,000 text messages" - ) + assert normalize_spaces(page.select_one("main [type=submit]").text) == ("Preview") @pytest.mark.parametrize("when", ["", "2016-08-25T13:04:21.767198"]) @@ -2043,6 +2021,8 @@ def test_create_job_should_call_api( "valid": True, } } + with client_request.session_transaction() as session: + session["scheduled_for"] = when page = client_request.post( "main.start_job", @@ -2593,7 +2573,7 @@ def test_check_notification_redirects_if_session_not_populated( ) -def test_check_notification_shows_preview( +def test_check_notification_shows_scheduler( client_request, service_one, fake_uuid, mock_get_service_template ): with client_request.session_transaction() as session: @@ -2604,7 +2584,7 @@ def test_check_notification_shows_preview( "main.check_notification", service_id=service_one["id"], template_id=fake_uuid ) - assert page.h1.text.strip() == "Preview of ‘Two week reminder’" + assert page.h1.text.strip() == "Select delivery time" assert (page.find_all("a", {"class": "usa-back-link"})[0]["href"]) == url_for( "main.send_one_off_step", service_id=service_one["id"], @@ -2615,6 +2595,49 @@ def test_check_notification_shows_preview( # assert tour not visible assert not page.select(".banner-tour") + # post to send_notification with help=0 to ensure no back link is then shown + assert page.form.attrs["action"] == url_for( + "main.preview_notification", + service_id=service_one["id"], + template_id=fake_uuid, + ) + + assert normalize_spaces(page.select_one("main [type=submit]").text) == ("Preview") + + +@pytest.mark.parametrize("when", ["", "2016-08-25T13:04:21.767198"]) +def test_preview_notification_shows_preview( + client_request, + service_one, + fake_uuid, + mock_get_service_template, + when, +): + with client_request.session_transaction() as session: + session["recipient"] = "2028675301" + session["placeholders"] = {} + + # with client_request.session_transaction() as session: + # session["scheduled_for"] = when + + page = client_request.get( + "main.preview_notification", service_id=service_one["id"], template_id=fake_uuid + ) + + # if when: + # assert page.h1.text.strip() == when + # else: + # assert page.h1.text.strip() == "Now" + assert page.h1.text.strip() == "Preview of ‘Two week reminder’" + assert (page.find_all("a", {"class": "usa-back-link"})[0]["href"]) == url_for( + "main.check_notification", + service_id=service_one["id"], + template_id=fake_uuid, + ) + + # assert tour not visible + assert not page.select(".banner-tour") + # post to send_notification with help=0 to ensure no back link is then shown assert page.form.attrs["action"] == url_for( "main.send_notification", diff --git a/tests/app/main/views/test_tour.py b/tests/app/main/views/test_tour.py index 1d34a9999..749a8097f 100644 --- a/tests/app/main/views/test_tour.py +++ b/tests/app/main/views/test_tour.py @@ -544,10 +544,9 @@ def test_should_200_for_check_tour_notification( # post to send_notification keeps help argument assert page.form.attrs["action"] == url_for( - "main.send_notification", + "main.preview_notification", service_id=SERVICE_ONE_ID, template_id=fake_uuid, - help="3", ) diff --git a/tests/app/test_navigation.py b/tests/app/test_navigation.py index 110bae914..a80455ab7 100644 --- a/tests/app/test_navigation.py +++ b/tests/app/test_navigation.py @@ -140,6 +140,8 @@ EXCLUDED_ENDPOINTS = tuple( "platform_admin_list_complaints", "platform_admin_reports", "platform_admin_splash_page", + "preview_job", + "preview_notification", "pricing", "privacy", "received_text_messages_callback", From 49d270521a96324085854d4f7544727de1f337ba Mon Sep 17 00:00:00 2001 From: Beverly Nguyen Date: Tue, 13 Feb 2024 13:29:38 -0800 Subject: [PATCH 11/59] revision requestsed changes --- app/assets/sass/uswds/_legacy-styles.scss | 4 ++-- app/templates/views/check/ok.html | 4 ---- app/templates/views/check/preview.html | 18 +++++++++--------- app/templates/views/notifications/preview.html | 10 +++++++--- 4 files changed, 18 insertions(+), 18 deletions(-) diff --git a/app/assets/sass/uswds/_legacy-styles.scss b/app/assets/sass/uswds/_legacy-styles.scss index 242bb0f74..48cd63df8 100644 --- a/app/assets/sass/uswds/_legacy-styles.scss +++ b/app/assets/sass/uswds/_legacy-styles.scss @@ -48,8 +48,8 @@ } } -.sms-message-sender, .sms-message-file-name, .sms-message-scheduler { - margin: units(1) 0 0; +.sms-message-sender, .sms-message-file-name, .sms-message-scheduler, .sms-message-template { + margin: units(1) 0 units(1); } .sms-message-recipient { diff --git a/app/templates/views/check/ok.html b/app/templates/views/check/ok.html index 95fd1abea..6a925c7d1 100644 --- a/app/templates/views/check/ok.html +++ b/app/templates/views/check/ok.html @@ -34,10 +34,6 @@ }) }} {% endif %} - {% if not request.args.from_test %} -

    Send list

    -

    {{ original_file_name }}

    - {% endif %} {% set button_text %} Preview {% endset %} diff --git a/app/templates/views/check/preview.html b/app/templates/views/check/preview.html index ae8ecea91..379db7519 100644 --- a/app/templates/views/check/preview.html +++ b/app/templates/views/check/preview.html @@ -21,16 +21,16 @@ {{ page_header('Preview') }}

    Message

    - {% if scheduled_for %} -

    Time: {{scheduled_for}}

    - {% endif %} +

    Scheduled: + {{ scheduled_for if scheduled_for else 'Now'}}

    File: {{original_file_name}}

    +

    Template: {{template.name}}

    {{ template|string }}
    {% if not request.args.from_test %} -

    Preview list

    +

    Recipients list

    • @@ -41,11 +41,11 @@
    -
    +
    {% call(item, row_number) list_table( recipients.displayed_rows, - caption=original_file_name, - caption_visible=False, + caption="Note: Only the first 5 rows are dislayed here.", + caption_visible=True, field_headings=recipients.column_headers ) %} {% for column in recipients.column_headers %} @@ -63,10 +63,10 @@ {% endcall %}
    {% endif %} -

    Placeholder: This message will be delivered to 400 phone numbers and will use a total of 800 message parts, leaving Washington DSHS with 249,200 message parts remaining.

    +

    Placeholder: This message will be delivered to 400 phone numbers and will use a total of 800 message parts, leaving Washington DSHS with 249,200 message parts remaining.

    Does everything look good?

    {% set button_text %} - Send + {{ "Scheduled" if scheduled_for else 'Send'}} {% endset %} {{ usaButton({ "text": button_text }) }} diff --git a/app/templates/views/notifications/preview.html b/app/templates/views/notifications/preview.html index 468e91f3b..b0b66efe7 100644 --- a/app/templates/views/notifications/preview.html +++ b/app/templates/views/notifications/preview.html @@ -40,9 +40,13 @@ {% endcall %}
    {% else %} - {{ page_header('Preview of ‘{}’'.format(template.name)) }} + {{ page_header('Preview') }} {% endif %} +

    Message

    +

    Scheduled: + {{ scheduled_for if scheduled_for else 'Now'}}

    +

    Template: {{template.name}}

    {{ template|string }}
    @@ -53,11 +57,11 @@ help='3' if help else 0 )}}" class='page-footer'> -

    Placeholder: This message will be delivered to 400 phone numbers and will use a total of 800 message parts, leaving Washington DSHS with 249,200 message parts remaining.

    +

    Placeholder: This message will be delivered to 400 phone numbers and will use a total of 800 message parts, leaving Washington DSHS with 249,200 message parts remaining.

    Does everything look good?

    {% if not error %} {% set button_text %} - Send + {{ "Scheduled" if scheduled_for else 'Send'}} {% endset %} {{ usaButton({ "text": button_text }) }} {% endif %} From 01eac988f1d959b86af95503f1d5b256f6c8fd67 Mon Sep 17 00:00:00 2001 From: Beverly Nguyen Date: Tue, 13 Feb 2024 14:02:05 -0800 Subject: [PATCH 12/59] fixed testing --- app/templates/views/check/preview.html | 2 +- tests/app/main/views/test_send.py | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/app/templates/views/check/preview.html b/app/templates/views/check/preview.html index 379db7519..fda9bc5f6 100644 --- a/app/templates/views/check/preview.html +++ b/app/templates/views/check/preview.html @@ -44,7 +44,7 @@
    {% call(item, row_number) list_table( recipients.displayed_rows, - caption="Note: Only the first 5 rows are dislayed here.", + caption="Note: Only the first 5 rows are displayed here.", caption_visible=True, field_headings=recipients.column_headers ) %} diff --git a/tests/app/main/views/test_send.py b/tests/app/main/views/test_send.py index f98bf789c..c25dfc2cf 100644 --- a/tests/app/main/views/test_send.py +++ b/tests/app/main/views/test_send.py @@ -971,7 +971,7 @@ def test_upload_valid_csv_shows_preview_and_table( ) assert page.h1.text.strip() == "Preview" - assert page.select("h2")[1].text.strip() == "Preview list" + assert page.select("h2")[1].text.strip() == "Recipients list" assert page.h2.text.strip() == "Message" assert page.select_one(".sms-message-recipient").text.strip() == expected_recipient assert page.select_one(".sms-message-wrapper").text.strip() == expected_message @@ -2628,7 +2628,7 @@ def test_preview_notification_shows_preview( # assert page.h1.text.strip() == when # else: # assert page.h1.text.strip() == "Now" - assert page.h1.text.strip() == "Preview of ‘Two week reminder’" + assert page.h1.text.strip() == "Preview" assert (page.find_all("a", {"class": "usa-back-link"})[0]["href"]) == url_for( "main.check_notification", service_id=service_one["id"], From 843e4bb2faa3e4a848bb77df3b1cda893fb54158 Mon Sep 17 00:00:00 2001 From: Beverly Nguyen Date: Tue, 13 Feb 2024 16:18:50 -0800 Subject: [PATCH 13/59] fixed testing and removed recipient --- app/main/views/send.py | 2 +- tests/app/main/views/test_send.py | 7 ------- 2 files changed, 1 insertion(+), 8 deletions(-) diff --git a/app/main/views/send.py b/app/main/views/send.py index 90834d965..df53ef3c6 100644 --- a/app/main/views/send.py +++ b/app/main/views/send.py @@ -502,7 +502,7 @@ def _check_messages(service_id, template_id, upload_id, preview_row): template = get_template( db_template, current_service, - show_recipient=True, + show_recipient=False, email_reply_to=email_reply_to, sms_sender=sms_sender, ) diff --git a/tests/app/main/views/test_send.py b/tests/app/main/views/test_send.py index c25dfc2cf..0586d74e1 100644 --- a/tests/app/main/views/test_send.py +++ b/tests/app/main/views/test_send.py @@ -908,26 +908,22 @@ def test_upload_valid_csv_redirects_to_check_page( ( "extra_args", "expected_link_in_first_row", - "expected_recipient", "expected_message", ), [ ( {}, None, - "To: 2028675301", "Test Service: A, Template content with & entity", ), ( {"row_index": 2}, None, - "To: 2028675301", "Test Service: A, Template content with & entity", ), ( {"row_index": 4}, True, - "To: 2028675303", "Test Service: C, Template content with & entity", ), ], @@ -946,7 +942,6 @@ def test_upload_valid_csv_shows_preview_and_table( fake_uuid, extra_args, expected_link_in_first_row, - expected_recipient, expected_message, ): with client_request.session_transaction() as session: @@ -973,7 +968,6 @@ def test_upload_valid_csv_shows_preview_and_table( assert page.h1.text.strip() == "Preview" assert page.select("h2")[1].text.strip() == "Recipients list" assert page.h2.text.strip() == "Message" - assert page.select_one(".sms-message-recipient").text.strip() == expected_recipient assert page.select_one(".sms-message-wrapper").text.strip() == expected_message assert not page.select_one(".table-field-index") @@ -2895,7 +2889,6 @@ def test_send_notification_shows_email_error_in_trial_mode( @pytest.mark.parametrize( ("endpoint", "extra_args"), [ - ("main.check_messages", {"template_id": uuid4(), "upload_id": uuid4()}), ("main.send_one_off_step", {"template_id": uuid4(), "step_index": 0}), ], ) From eccf8cb3e7b669eb7ec4af031cb93461f91b6d8c Mon Sep 17 00:00:00 2001 From: Beverly Nguyen Date: Fri, 16 Feb 2024 11:44:25 -0800 Subject: [PATCH 14/59] added new change from ux meeting as requested --- app/assets/sass/uswds/_legacy-styles.scss | 4 ++-- app/main/views/send.py | 24 ++++++++++++++++--- app/templates/views/check/preview.html | 17 +++++++------ .../views/notifications/preview.html | 17 +++++++------ 4 files changed, 43 insertions(+), 19 deletions(-) diff --git a/app/assets/sass/uswds/_legacy-styles.scss b/app/assets/sass/uswds/_legacy-styles.scss index 48cd63df8..b96a24844 100644 --- a/app/assets/sass/uswds/_legacy-styles.scss +++ b/app/assets/sass/uswds/_legacy-styles.scss @@ -48,8 +48,8 @@ } } -.sms-message-sender, .sms-message-file-name, .sms-message-scheduler, .sms-message-template { - margin: units(1) 0 units(1); +.sms-message-sender, .sms-message-file-name, .sms-message-scheduler, .sms-message-template, .sms-message-sender { + margin:0.25rem 0 0; } .sms-message-recipient { diff --git a/app/main/views/send.py b/app/main/views/send.py index df53ef3c6..a8367f7da 100644 --- a/app/main/views/send.py +++ b/app/main/views/send.py @@ -39,7 +39,7 @@ from app.utils import PermanentRedirect, should_skip_template_page, unicode_trun from app.utils.csv import Spreadsheet, get_errors_for_csv from app.utils.templates import get_template from app.utils.user import user_has_permissions - +from pprint import pprint def get_example_csv_fields(column_headers, use_example_as_example, submitted_fields): if use_example_as_example: @@ -574,6 +574,7 @@ def _check_messages(service_id, template_id, upload_id, preview_row): service_id, template.id, db_template["version"], original_file_name ), template_id=template_id, + db_template=db_template ) @@ -617,6 +618,7 @@ def check_messages(service_id, template_id, upload_id, row_index=2): metadata_kwargs["sender_id"] = session["sender_id"] set_metadata_on_csv_upload(service_id, upload_id, **metadata_kwargs) + return render_template("views/check/ok.html", **data) @@ -649,8 +651,14 @@ def preview_job(service_id, template_id, upload_id, row_index=2): if data["errors"]: return render_template("views/check/column-errors.html", **data) + simplifed_template = get_template( + data.get('db_template', {}), + current_service, + ) + return render_template( - "views/check/preview.html", scheduled_for=session["scheduled_for"], **data + "views/check/preview.html", scheduled_for=session["scheduled_for"], **data, + simplifed_template=simplifed_template ) @@ -857,6 +865,7 @@ def _check_notification(service_id, template_id, exception=None): back_link=back_link, back_link_from_preview=back_link_from_preview, choose_time_form=choose_time_form, + db_template=db_template, **(get_template_error_dict(exception) if exception else {}), ) @@ -904,11 +913,20 @@ def preview_notification(service_id, template_id): ) session["scheduled_for"] = request.args.get("scheduled_for", "") + data = _check_notification(service_id, template_id) + db_template = data.get('db_template', None) + + simplifed_template = get_template( + db_template, + current_service, + ) return render_template( "views/notifications/preview.html", - **_check_notification(service_id, template_id), + **data, scheduled_for=session["scheduled_for"], + simplifed_template=simplifed_template, + recipient=recipient, ) diff --git a/app/templates/views/check/preview.html b/app/templates/views/check/preview.html index fda9bc5f6..f6fe2cb04 100644 --- a/app/templates/views/check/preview.html +++ b/app/templates/views/check/preview.html @@ -20,12 +20,15 @@ {% block maincolumn_content %} {{ page_header('Preview') }} +
    +

    Scheduled: {{ scheduled_for if scheduled_for else 'Now'}}

    +

    File: {{original_file_name}}

    +

    Template: {{template.name}}

    +

    From: {{ template.sender }}

    +
    +

    Message

    -

    Scheduled: - {{ scheduled_for if scheduled_for else 'Now'}}

    -

    File: {{original_file_name}}

    -

    Template: {{template.name}}

    - {{ template|string }} +
    {{ simplifed_template|string }}
    @@ -63,10 +66,10 @@ {% endcall %}
    {% endif %} -

    Placeholder: This message will be delivered to 400 phone numbers and will use a total of 800 message parts, leaving Washington DSHS with 249,200 message parts remaining.

    +

    Does everything look good?

    {% set button_text %} - {{ "Scheduled" if scheduled_for else 'Send'}} + {{ "Schedule" if scheduled_for else 'Send'}} {% endset %} {{ usaButton({ "text": button_text }) }} diff --git a/app/templates/views/notifications/preview.html b/app/templates/views/notifications/preview.html index b0b66efe7..13ef103b0 100644 --- a/app/templates/views/notifications/preview.html +++ b/app/templates/views/notifications/preview.html @@ -5,7 +5,7 @@ {% from "components/components/button/macro.njk" import usaButton %} {% block service_page_title %} - {{ "Error" if error else "Preview of ‘{}’".format(template.name) }} + {{ "Error" if error else "Preview" }} {% endblock %} {% block backLink %} @@ -42,12 +42,15 @@ {% else %} {{ page_header('Preview') }} {% endif %} -

    Message

    +
    +

    Scheduled: {{ scheduled_for if scheduled_for else 'Now'}}

    +

    Template: {{template.name}}

    +

    From: {{ template.sender }}

    +

    To: {{ recipient }}

    +
    -

    Scheduled: - {{ scheduled_for if scheduled_for else 'Now'}}

    -

    Template: {{template.name}}

    - {{ template|string }} +

    Message

    +
    {{ simplifed_template|string }}
    Date: Fri, 16 Feb 2024 11:54:59 -0800 Subject: [PATCH 15/59] merge main --- app/main/views/send.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/app/main/views/send.py b/app/main/views/send.py index a8367f7da..b53d763b0 100644 --- a/app/main/views/send.py +++ b/app/main/views/send.py @@ -39,7 +39,7 @@ from app.utils import PermanentRedirect, should_skip_template_page, unicode_trun from app.utils.csv import Spreadsheet, get_errors_for_csv from app.utils.templates import get_template from app.utils.user import user_has_permissions -from pprint import pprint + def get_example_csv_fields(column_headers, use_example_as_example, submitted_fields): if use_example_as_example: @@ -915,7 +915,6 @@ def preview_notification(service_id, template_id): session["scheduled_for"] = request.args.get("scheduled_for", "") data = _check_notification(service_id, template_id) db_template = data.get('db_template', None) - simplifed_template = get_template( db_template, current_service, From c38388401736566c772424eb36b2ad34a8cd21d5 Mon Sep 17 00:00:00 2001 From: Beverly Nguyen Date: Fri, 16 Feb 2024 17:19:03 -0800 Subject: [PATCH 16/59] fixed test --- app/main/views/send.py | 35 ++++---- app/templates/views/check/preview.html | 89 +++++++++---------- .../views/notifications/preview.html | 2 +- 3 files changed, 62 insertions(+), 64 deletions(-) diff --git a/app/main/views/send.py b/app/main/views/send.py index b53d763b0..9f98c9a71 100644 --- a/app/main/views/send.py +++ b/app/main/views/send.py @@ -506,9 +506,14 @@ def _check_messages(service_id, template_id, upload_id, preview_row): email_reply_to=email_reply_to, sms_sender=sms_sender, ) + simplifed_template = get_template( + db_template, + current_service, + show_recipient=False, + ) recipients = RecipientCSV( contents, - template=template, + template=template or simplifed_template, max_initial_rows_shown=50, max_errors_shown=50, guestlist=itertools.chain.from_iterable( @@ -547,6 +552,7 @@ def _check_messages(service_id, template_id, upload_id, preview_row): if preview_row < len(recipients) + 2: template.values = recipients[preview_row - 2].recipient_and_personalisation + simplifed_template.values = recipients[preview_row - 2].recipient_and_personalisation elif preview_row > 2: abort(404) @@ -574,7 +580,7 @@ def _check_messages(service_id, template_id, upload_id, preview_row): service_id, template.id, db_template["version"], original_file_name ), template_id=template_id, - db_template=db_template + simplifed_template=simplifed_template, ) @@ -651,14 +657,10 @@ def preview_job(service_id, template_id, upload_id, row_index=2): if data["errors"]: return render_template("views/check/column-errors.html", **data) - simplifed_template = get_template( - data.get('db_template', {}), - current_service, - ) - return render_template( - "views/check/preview.html", scheduled_for=session["scheduled_for"], **data, - simplifed_template=simplifed_template + "views/check/preview.html", + scheduled_for=session["scheduled_for"], + **data, ) @@ -841,7 +843,10 @@ def _check_notification(service_id, template_id, exception=None): email_reply_to=email_reply_to, sms_sender=sms_sender, ) - + simplifed_template = get_template( + db_template, + current_service, + ) placeholders = fields_to_fill_in(template) back_link = get_back_link(service_id, template, len(placeholders), placeholders) @@ -867,6 +872,7 @@ def _check_notification(service_id, template_id, exception=None): choose_time_form=choose_time_form, db_template=db_template, **(get_template_error_dict(exception) if exception else {}), + simplifed_template=simplifed_template ) @@ -913,18 +919,11 @@ def preview_notification(service_id, template_id): ) session["scheduled_for"] = request.args.get("scheduled_for", "") - data = _check_notification(service_id, template_id) - db_template = data.get('db_template', None) - simplifed_template = get_template( - db_template, - current_service, - ) return render_template( "views/notifications/preview.html", - **data, + **_check_notification(service_id, template_id), scheduled_for=session["scheduled_for"], - simplifed_template=simplifed_template, recipient=recipient, ) diff --git a/app/templates/views/check/preview.html b/app/templates/views/check/preview.html index f6fe2cb04..d47e9e779 100644 --- a/app/templates/views/check/preview.html +++ b/app/templates/views/check/preview.html @@ -29,50 +29,49 @@

    Message

    {{ simplifed_template|string }}
    -
    - - - {% if not request.args.from_test %} -

    Recipients list

    -
      -
    • -
      - Description Icon -
      -
      -

      {{ original_file_name }}

      -
      -
      • -
    -
    - {% call(item, row_number) list_table( - recipients.displayed_rows, - caption="Note: Only the first 5 rows are displayed here.", - caption_visible=True, - field_headings=recipients.column_headers - ) %} - {% for column in recipients.column_headers %} - {% if item[column].ignore %} - {{ text_field(item[column].data or '', status='default') }} - {% else %} - {{ text_field(item[column].data or '') }} - {% endif %} - {% endfor %} - {% if item[None].data %} - {% for column in item[None].data %} - {{ text_field(column, status='default') }} - {% endfor %} - {% endif %} - {% endcall %} -
    - {% endif %} - -

    Does everything look good?

    - {% set button_text %} - {{ "Schedule" if scheduled_for else 'Send'}} - {% endset %} - {{ usaButton({ "text": button_text }) }} - - + {% if not request.args.from_test %} +

    Recipients list

    +
    +
      +
    • + Description Icon +
      +

      {{ original_file_name }}

      +
      +
      • +
    +
    + {% call(item, row_number) list_table( + recipients.displayed_rows, + caption="Note: Only the first 5 rows are displayed here.", + caption_visible=True, + field_headings=recipients.column_headers + ) %} + {% for column in recipients.column_headers %} + {% if item[column].ignore %} + {{ text_field(item[column].data or '', status='default') }} + {% else %} + {{ text_field(item[column].data or '') }} + {% endif %} + {% endfor %} + {% if item[None].data %} + {% for column in item[None].data %} + {{ text_field(column, status='default') }} + {% endfor %} + {% endif %} + {% endcall %} +
    + {% endif %} + +
    + +

    Does everything look good?

    + {% set button_text %} + {{ "Schedule" if scheduled_for else 'Send'}} + {% endset %} + {{ usaButton({ "text": button_text }) }} +
    {% endblock %} diff --git a/app/templates/views/notifications/preview.html b/app/templates/views/notifications/preview.html index 13ef103b0..a22fda5bb 100644 --- a/app/templates/views/notifications/preview.html +++ b/app/templates/views/notifications/preview.html @@ -60,7 +60,7 @@ help='3' if help else 0 )}}" class='page-footer'> -

    Placeholder: This message will be delivered to 400 phone numbers and will use a total of 800 message parts, leaving Washington DSHS with 249,200 message parts remaining.

    +

    Does everything look good?

    {% if not error %} {% set button_text %} From 02d1c2b26eaa21eadec3eb52a293954fd30da075 Mon Sep 17 00:00:00 2001 From: Beverly Nguyen Date: Fri, 16 Feb 2024 18:01:36 -0800 Subject: [PATCH 17/59] fixed test --- app/main/views/send.py | 1 - tests/app/main/views/test_send.py | 12 ++---------- 2 files changed, 2 insertions(+), 11 deletions(-) diff --git a/app/main/views/send.py b/app/main/views/send.py index 9f98c9a71..4460c20ad 100644 --- a/app/main/views/send.py +++ b/app/main/views/send.py @@ -870,7 +870,6 @@ def _check_notification(service_id, template_id, exception=None): back_link=back_link, back_link_from_preview=back_link_from_preview, choose_time_form=choose_time_form, - db_template=db_template, **(get_template_error_dict(exception) if exception else {}), simplifed_template=simplifed_template ) diff --git a/tests/app/main/views/test_send.py b/tests/app/main/views/test_send.py index 0586d74e1..019331d64 100644 --- a/tests/app/main/views/test_send.py +++ b/tests/app/main/views/test_send.py @@ -1876,9 +1876,8 @@ def test_upload_csvfile_with_valid_phone_shows_all_numbers( ) assert "Select delivery time" in page.text - # assert "202 867 0749" in page.text - # assert "202 867 0750" not in page.text - # assert "Only showing the first 50 rows" in page.text + assert "202 867 0749" not in page.text + assert "202 867 0750" not in page.text mock_get_notification_count.assert_called_with(service_one["id"]) @@ -2611,24 +2610,17 @@ def test_preview_notification_shows_preview( session["recipient"] = "2028675301" session["placeholders"] = {} - # with client_request.session_transaction() as session: - # session["scheduled_for"] = when page = client_request.get( "main.preview_notification", service_id=service_one["id"], template_id=fake_uuid ) - # if when: - # assert page.h1.text.strip() == when - # else: - # assert page.h1.text.strip() == "Now" assert page.h1.text.strip() == "Preview" assert (page.find_all("a", {"class": "usa-back-link"})[0]["href"]) == url_for( "main.check_notification", service_id=service_one["id"], template_id=fake_uuid, ) - # assert tour not visible assert not page.select(".banner-tour") From 2e7aeb1dbf83141e449acdf3eb373f0a26807060 Mon Sep 17 00:00:00 2001 From: Beverly Nguyen Date: Fri, 16 Feb 2024 18:05:13 -0800 Subject: [PATCH 18/59] fixed test --- tests/app/main/views/test_send.py | 2 -- 1 file changed, 2 deletions(-) diff --git a/tests/app/main/views/test_send.py b/tests/app/main/views/test_send.py index 019331d64..5fcf1fc14 100644 --- a/tests/app/main/views/test_send.py +++ b/tests/app/main/views/test_send.py @@ -2610,11 +2610,9 @@ def test_preview_notification_shows_preview( session["recipient"] = "2028675301" session["placeholders"] = {} - page = client_request.get( "main.preview_notification", service_id=service_one["id"], template_id=fake_uuid ) - assert page.h1.text.strip() == "Preview" assert (page.find_all("a", {"class": "usa-back-link"})[0]["href"]) == url_for( "main.check_notification", From e3ff679b5ed15099b32e9f40c3330ba48acdf38b Mon Sep 17 00:00:00 2001 From: Beverly Nguyen Date: Tue, 20 Feb 2024 11:32:05 -0800 Subject: [PATCH 19/59] added padding to td --- app/assets/sass/uswds/_uswds-theme-custom-styles.scss | 3 +++ 1 file changed, 3 insertions(+) diff --git a/app/assets/sass/uswds/_uswds-theme-custom-styles.scss b/app/assets/sass/uswds/_uswds-theme-custom-styles.scss index addf9cc7a..1236eaf5b 100644 --- a/app/assets/sass/uswds/_uswds-theme-custom-styles.scss +++ b/app/assets/sass/uswds/_uswds-theme-custom-styles.scss @@ -405,6 +405,9 @@ td.table-empty-message { th { padding: 0.5rem 0.5rem; } + td { + padding: 0.8rem; + } } #template-list { From 60bcd9ddbd7c228efe8a04732ac06f3eb9f2ca8b Mon Sep 17 00:00:00 2001 From: Beverly Nguyen Date: Tue, 20 Feb 2024 11:56:26 -0800 Subject: [PATCH 20/59] added padding to td --- app/assets/sass/uswds/_uswds-theme-custom-styles.scss | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/app/assets/sass/uswds/_uswds-theme-custom-styles.scss b/app/assets/sass/uswds/_uswds-theme-custom-styles.scss index 1236eaf5b..1d55791df 100644 --- a/app/assets/sass/uswds/_uswds-theme-custom-styles.scss +++ b/app/assets/sass/uswds/_uswds-theme-custom-styles.scss @@ -403,10 +403,10 @@ td.table-empty-message { width: 5%; } th { - padding: 0.5rem 0.5rem; + padding: 0.5rem 1rem } td { - padding: 0.8rem; + padding: 0.5rem 1rem } } From e71351d94938779145a1478c6683e3eafcc5a327 Mon Sep 17 00:00:00 2001 From: Carlo Costino Date: Fri, 23 Feb 2024 16:02:16 -0500 Subject: [PATCH 21/59] Add E2E documentation and clean E2E tests This changeset adds additional documentation for how to write new E2E tests and cleans up the two existing tests slightly to make better use of the fixtures that are defined. Signed-off-by: Carlo Costino --- docs/end_to_end_tests.md | 99 +++++++++++++++++++ tests/end_to_end/conftest.py | 21 +++- tests/end_to_end/test_accounts_page.py | 4 - .../test_landing_and_sign_in_pages.py | 9 +- 4 files changed, 118 insertions(+), 15 deletions(-) diff --git a/docs/end_to_end_tests.md b/docs/end_to_end_tests.md index 02eec2e8b..557bdf327 100644 --- a/docs/end_to_end_tests.md +++ b/docs/end_to_end_tests.md @@ -106,6 +106,105 @@ All of the E2E tests are found in the `tests/end_to_end` folder and are written as `pytest` scripts using [Playwright's Python Framework](https://playwright.dev/python/docs/writing-tests). +Inside the `tests/end_to_end` folder you'll see a `conftest.py` file, +which is similar to the one found in the root `tests` folder but is +specific to the E2E tests. + +There a few fixtures defined in here, but the three most important at +this time are these: + +- `end_to_end_context`: A Playwright context object needed to interact + with a browser instance. +- `authenticated_page`: A Playwright page object that has gone through + the sign in process the E2E user is authenticated. +- `unauthenticated_page`: A Playwright page object that has only loaded + the home page; no authentication done. + +In short, if you're starting a test from scratch and testing pages that +do not require authentication, you'll start with the +`unauthenticated_page` fixture and work from there. + +Any test that requires you to be authenticated, you'll start with the +`authenticated_page` object as that'll have taken care of getting +everything set for you and logged into the site with the E2E test user. + +The `end_to_end_context` fixture is there more for the two page than for +direct use, but there may be instances where it's easier to get data +or manipulate tests in ways that are better done with the context object +instead of working back from the page object. + + +### Creating a new test file + +If you want to create a new test file to help organize tests (a great +idea!), it will be handy to import the Playwright `expect` and set the +base URL/URI for yourself, like this: + +```python +from playwright.sync_api import expect + +E2E_TEST_URI = os.getenv("NOTIFY_E2E_TEST_URI") +``` + +By importing Playwright's `expect` object for tests and setting +something like `E2E_TEST_URI` for yourself, it will make writing tests +much easier. + + +### Using the fixtures + +To use the `authenticated_page` or `unauthenticated_page` fixtures, you +start by defining a test function and then passing in the fixture you +need as a positional argument. This works the same as the other +functions defined to create a test for pytest. + +For example, the test for the landing page starts with this: + +```python +def test_landing_page(unauthenticated_page): + page = unauthenticated_page + ... +``` + +Note the passing in of the `unauthenticated_page` fixture - there is no +need to import this or anything, just pass it into the function. pytest +takes care of everything else for you. + +The second line that defines a `page` variable is a convenience, since +you'll be referencing the page object a lot. This is recommended to +help keep tests readable while keeping fixture names descriptive. + +If you need to test an authenticate page, such as the accounts page, +use the `authenticated_page` fixture instead, like so: + +```python +def test_add_new_service_workflow(authenticated_page): + page = authenticated_page + ... +``` + +Again, it's helpful to assign the fixture to a `page` variable for easy +reference throughout the test. + +Lastly, if you need want access to the Playwright context object that is +used behind the page fixtures, you can reference it directly as well: + +```python +def test_add_new_service_workflow(authenticated_page, end_to_end_context): + page = authenticated_page + + # Prepare for adding a new service later in the test. + current_date_time = datetime.datetime.now() + new_service_name = "E2E Federal Test Service {now} - {browser_type}".format( + now=current_date_time.strftime("%m/%d/%Y %H:%M:%S"), + browser_type=end_to_end_context.browser.browser_type.name, + ) + ... +``` + +In this example, I've used the context to get to the browser object +itself to get the name of the browser for test data. + ## Maintaining E2E Tests with GitHub diff --git a/tests/end_to_end/conftest.py b/tests/end_to_end/conftest.py index 48d1bcd35..4819ec007 100644 --- a/tests/end_to_end/conftest.py +++ b/tests/end_to_end/conftest.py @@ -89,17 +89,30 @@ def end_to_end_authenticated_context(browser): @pytest.fixture(scope="session") -def authenticated_page(end_to_end_context): - # Open a new page and go to the staging site. +def unauthenticated_page(end_to_end_context): page = end_to_end_context.new_page() - page.goto(f"{E2E_TEST_URI}/") - sign_in_button = page.get_by_role("link", name="Sign in") + # Wait for the next page to fully load. + page.wait_for_load_state("domcontentloaded") + + return page + + +@pytest.fixture(scope="session") +def authenticated_page(end_to_end_context): + # Open a new page and go to the site. + page = end_to_end_context.new_page() + page.goto(f"{E2E_TEST_URI}/") + + # Wait for the next page to fully load. + page.wait_for_load_state("domcontentloaded") # Sign in to the site - E2E test accounts are set to flow through. + sign_in_button = page.get_by_role("link", name="Sign in") sign_in_button.click() # Wait for the next page to fully load. page.wait_for_load_state("domcontentloaded") + return page diff --git a/tests/end_to_end/test_accounts_page.py b/tests/end_to_end/test_accounts_page.py index 411728e33..b6fe8c5ac 100644 --- a/tests/end_to_end/test_accounts_page.py +++ b/tests/end_to_end/test_accounts_page.py @@ -9,10 +9,6 @@ E2E_TEST_URI = os.getenv("NOTIFY_E2E_TEST_URI") def test_add_new_service_workflow(authenticated_page, end_to_end_context): page = authenticated_page - page.goto(f"{E2E_TEST_URI}/") - - # Wait for the next page to fully load. - page.wait_for_load_state("domcontentloaded") # Prepare for adding a new service later in the test. current_date_time = datetime.datetime.now() diff --git a/tests/end_to_end/test_landing_and_sign_in_pages.py b/tests/end_to_end/test_landing_and_sign_in_pages.py index dd6a70beb..8b0f04f86 100644 --- a/tests/end_to_end/test_landing_and_sign_in_pages.py +++ b/tests/end_to_end/test_landing_and_sign_in_pages.py @@ -6,13 +6,8 @@ from playwright.sync_api import expect E2E_TEST_URI = os.getenv("NOTIFY_E2E_TEST_URI") -def test_landing_page(end_to_end_context): - # Open a new page and go to the staging site. - page = end_to_end_context.browser.new_page() - page.goto(f"{E2E_TEST_URI}/") - - # Check to make sure that we've arrived at the next page. - page.wait_for_load_state("domcontentloaded") +def test_landing_page(unauthenticated_page): + page = unauthenticated_page # Check the page title exists and matches what we expect. expect(page).to_have_title(re.compile("Notify.gov")) From 34d20c4d65cb6a23d10b7bf5df02adb3122e8ff0 Mon Sep 17 00:00:00 2001 From: Carlo Costino Date: Fri, 23 Feb 2024 16:53:39 -0500 Subject: [PATCH 22/59] Trying to get landing page test working again Signed-off-by: Carlo Costino --- tests/end_to_end/test_landing_and_sign_in_pages.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/tests/end_to_end/test_landing_and_sign_in_pages.py b/tests/end_to_end/test_landing_and_sign_in_pages.py index 8b0f04f86..ab1f885b1 100644 --- a/tests/end_to_end/test_landing_and_sign_in_pages.py +++ b/tests/end_to_end/test_landing_and_sign_in_pages.py @@ -7,7 +7,12 @@ E2E_TEST_URI = os.getenv("NOTIFY_E2E_TEST_URI") def test_landing_page(unauthenticated_page): + # Open a new page and go to the staging site. page = unauthenticated_page + page.goto(f"{E2E_TEST_URI}/") + + # Check to make sure that we've arrived at the next page. + page.wait_for_load_state("domcontentloaded") # Check the page title exists and matches what we expect. expect(page).to_have_title(re.compile("Notify.gov")) From c891bc1b3f800c60dc5bef7b9392dbdf394e256d Mon Sep 17 00:00:00 2001 From: Carlo Costino Date: Fri, 23 Feb 2024 17:02:18 -0500 Subject: [PATCH 23/59] Another attempt at fixing the landing page test Signed-off-by: Carlo Costino --- tests/end_to_end/conftest.py | 5 ----- 1 file changed, 5 deletions(-) diff --git a/tests/end_to_end/conftest.py b/tests/end_to_end/conftest.py index 4819ec007..91e52ac40 100644 --- a/tests/end_to_end/conftest.py +++ b/tests/end_to_end/conftest.py @@ -91,11 +91,6 @@ def end_to_end_authenticated_context(browser): @pytest.fixture(scope="session") def unauthenticated_page(end_to_end_context): page = end_to_end_context.new_page() - page.goto(f"{E2E_TEST_URI}/") - - # Wait for the next page to fully load. - page.wait_for_load_state("domcontentloaded") - return page From 5c6a23c87342f5ea50b4c438a92db9bdb2d2ae34 Mon Sep 17 00:00:00 2001 From: Carlo Costino Date: Fri, 23 Feb 2024 17:10:41 -0500 Subject: [PATCH 24/59] Undo changes to the landing page test Signed-off-by: Carlo Costino --- tests/end_to_end/conftest.py | 11 +++-------- tests/end_to_end/test_landing_and_sign_in_pages.py | 6 +++--- 2 files changed, 6 insertions(+), 11 deletions(-) diff --git a/tests/end_to_end/conftest.py b/tests/end_to_end/conftest.py index 91e52ac40..f21fbe0fc 100644 --- a/tests/end_to_end/conftest.py +++ b/tests/end_to_end/conftest.py @@ -68,11 +68,6 @@ def login_for_end_to_end_testing(browser): context.storage_state(path=auth_state_path) -@pytest.fixture(scope="session") -def end_to_end_context(browser): - context = browser.new_context() - return context - @pytest.fixture(scope="session") def end_to_end_authenticated_context(browser): @@ -89,9 +84,9 @@ def end_to_end_authenticated_context(browser): @pytest.fixture(scope="session") -def unauthenticated_page(end_to_end_context): - page = end_to_end_context.new_page() - return page +def end_to_end_context(browser): + context = browser.new_context() + return context @pytest.fixture(scope="session") diff --git a/tests/end_to_end/test_landing_and_sign_in_pages.py b/tests/end_to_end/test_landing_and_sign_in_pages.py index ab1f885b1..a9148cb31 100644 --- a/tests/end_to_end/test_landing_and_sign_in_pages.py +++ b/tests/end_to_end/test_landing_and_sign_in_pages.py @@ -6,9 +6,9 @@ from playwright.sync_api import expect E2E_TEST_URI = os.getenv("NOTIFY_E2E_TEST_URI") -def test_landing_page(unauthenticated_page): - # Open a new page and go to the staging site. - page = unauthenticated_page +def test_landing_page(end_to_end_context): + # Open a new page and go to the site. + page = end_to_end_context.browser.new_page() page.goto(f"{E2E_TEST_URI}/") # Check to make sure that we've arrived at the next page. From 564fc7352120829ad28320eb9897736efaaa3f3e Mon Sep 17 00:00:00 2001 From: Carlo Costino Date: Fri, 23 Feb 2024 17:38:47 -0500 Subject: [PATCH 25/59] Fixed up documentation to match current state; blackened formatting Signed-off-by: Carlo Costino --- docs/end_to_end_tests.md | 29 +++++++++---------- tests/app/main/views/test_manage_users.py | 6 ++-- tests/app/main/views/test_template_folders.py | 8 +++-- tests/conftest.py | 14 +++++---- tests/end_to_end/conftest.py | 1 - 5 files changed, 30 insertions(+), 28 deletions(-) diff --git a/docs/end_to_end_tests.md b/docs/end_to_end_tests.md index 557bdf327..11758a16e 100644 --- a/docs/end_to_end_tests.md +++ b/docs/end_to_end_tests.md @@ -110,29 +110,22 @@ Inside the `tests/end_to_end` folder you'll see a `conftest.py` file, which is similar to the one found in the root `tests` folder but is specific to the E2E tests. -There a few fixtures defined in here, but the three most important at -this time are these: +There a few fixtures defined in here, but the two most important at this +time are these: - `end_to_end_context`: A Playwright context object needed to interact with a browser instance. - `authenticated_page`: A Playwright page object that has gone through the sign in process the E2E user is authenticated. -- `unauthenticated_page`: A Playwright page object that has only loaded - the home page; no authentication done. In short, if you're starting a test from scratch and testing pages that do not require authentication, you'll start with the -`unauthenticated_page` fixture and work from there. +`end_to_end_context` fixture and work from there. Any test that requires you to be authenticated, you'll start with the `authenticated_page` object as that'll have taken care of getting everything set for you and logged into the site with the E2E test user. -The `end_to_end_context` fixture is there more for the two page than for -direct use, but there may be instances where it's easier to get data -or manipulate tests in ways that are better done with the context object -instead of working back from the page object. - ### Creating a new test file @@ -153,7 +146,7 @@ much easier. ### Using the fixtures -To use the `authenticated_page` or `unauthenticated_page` fixtures, you +To use the `authenticated_page` or `end_to_end_context` fixtures, you start by defining a test function and then passing in the fixture you need as a positional argument. This works the same as the other functions defined to create a test for pytest. @@ -161,12 +154,17 @@ functions defined to create a test for pytest. For example, the test for the landing page starts with this: ```python -def test_landing_page(unauthenticated_page): - page = unauthenticated_page +def test_landing_page(end_to_end_context): + # Open a new page and go to the site. + page = end_to_end_context.browser.new_page() + page.goto(f"{E2E_TEST_URI}/") + + # Check to make sure that we've arrived at the next page. + page.wait_for_load_state("domcontentloaded") ... ``` -Note the passing in of the `unauthenticated_page` fixture - there is no +Note the passing in of the `end_to_end_context` fixture - there is no need to import this or anything, just pass it into the function. pytest takes care of everything else for you. @@ -187,7 +185,8 @@ Again, it's helpful to assign the fixture to a `page` variable for easy reference throughout the test. Lastly, if you need want access to the Playwright context object that is -used behind the page fixtures, you can reference it directly as well: +used behind the page fixtures, you can reference it directly as well +using the `end_to_end_context` fixture: ```python def test_add_new_service_workflow(authenticated_page, end_to_end_context): diff --git a/tests/app/main/views/test_manage_users.py b/tests/app/main/views/test_manage_users.py index 9bdabf925..c3d128155 100644 --- a/tests/app/main/views/test_manage_users.py +++ b/tests/app/main/views/test_manage_users.py @@ -862,9 +862,9 @@ def test_should_show_page_if_prefilled_user_is_already_invited( mock_get_invites_for_service, platform_admin_user, ): - active_user_with_permission_to_other_service[ - "email_address" - ] = "user_1@testnotify.gsa.gov" + active_user_with_permission_to_other_service["email_address"] = ( + "user_1@testnotify.gsa.gov" + ) client_request.login(platform_admin_user) mocker.patch( "app.models.user.user_api_client.get_user", diff --git a/tests/app/main/views/test_template_folders.py b/tests/app/main/views/test_template_folders.py index fae020e58..0bf2fcb08 100644 --- a/tests/app/main/views/test_template_folders.py +++ b/tests/app/main/views/test_template_folders.py @@ -31,9 +31,11 @@ def _folder(name, folder_id=None, parent=None, users_with_permission=None): "name": name, "id": folder_id or str(uuid.uuid4()), "parent_id": parent, - "users_with_permission": users_with_permission - if users_with_permission is not None - else [sample_uuid()], + "users_with_permission": ( + users_with_permission + if users_with_permission is not None + else [sample_uuid()] + ), } diff --git a/tests/conftest.py b/tests/conftest.py index 6c4f94b4f..4c2ceeea9 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -904,9 +904,11 @@ def create_service_templates(service_id, number_of_templates=4): "{}_template_{}".format(template_type, template_number), template_type, "{} template {} content".format(template_type, template_number), - subject="{} template {} subject".format(template_type, template_number) - if template_type == "email" - else None, + subject=( + "{} template {} subject".format(template_type, template_number) + if template_type == "email" + else None + ), ) ) @@ -1101,9 +1103,9 @@ def active_user_with_permission_to_other_service( active_user_with_permission_to_two_services["permissions"].pop(SERVICE_ONE_ID) active_user_with_permission_to_two_services["services"].pop(0) active_user_with_permission_to_two_services["name"] = "Service Two User" - active_user_with_permission_to_two_services[ - "email_address" - ] = "service-two-user@test.gsa.gov" + active_user_with_permission_to_two_services["email_address"] = ( + "service-two-user@test.gsa.gov" + ) return active_user_with_permission_to_two_services diff --git a/tests/end_to_end/conftest.py b/tests/end_to_end/conftest.py index f21fbe0fc..16940d4e0 100644 --- a/tests/end_to_end/conftest.py +++ b/tests/end_to_end/conftest.py @@ -68,7 +68,6 @@ def login_for_end_to_end_testing(browser): context.storage_state(path=auth_state_path) - @pytest.fixture(scope="session") def end_to_end_authenticated_context(browser): # Create and load a previously authenticated context for Playwright E2E From 66909e96249a56385b8454c25505a31a731a7762 Mon Sep 17 00:00:00 2001 From: Beverly Nguyen Date: Fri, 23 Feb 2024 17:50:25 -0800 Subject: [PATCH 26/59] added conditional --- app/main/views/dashboard.py | 1 + 1 file changed, 1 insertion(+) diff --git a/app/main/views/dashboard.py b/app/main/views/dashboard.py index 24b3e0490..4d5aca14d 100644 --- a/app/main/views/dashboard.py +++ b/app/main/views/dashboard.py @@ -76,6 +76,7 @@ def service_dashboard(service_id): "notifications": aggregate_notifications_by_job.get(job["id"], []), } for job in job_response + if aggregate_notifications_by_job.get(job["id"], []) ] return render_template( "views/dashboard/dashboard.html", From 470574e1971b47fe4e6329c8f701323c2116569e Mon Sep 17 00:00:00 2001 From: Kenneth Kehl <@kkehl@flexion.us> Date: Tue, 20 Feb 2024 08:28:26 -0800 Subject: [PATCH 27/59] enable login.gov link on demo and production and adjust test --- app/main/views/sign_in.py | 2 +- tests/app/main/views/test_sign_in.py | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/app/main/views/sign_in.py b/app/main/views/sign_in.py index be313c59b..853b33648 100644 --- a/app/main/views/sign_in.py +++ b/app/main/views/sign_in.py @@ -198,7 +198,7 @@ def sign_in(): form=form, again=bool(redirect_url), other_device=other_device, - login_gov_enabled=bool(notify_env in ["development", "staging"]), + login_gov_enabled=True, password_reset_url=password_reset_url, initial_signin_url=initial_signin_url, ) diff --git a/tests/app/main/views/test_sign_in.py b/tests/app/main/views/test_sign_in.py index 7970afa08..453790536 100644 --- a/tests/app/main/views/test_sign_in.py +++ b/tests/app/main/views/test_sign_in.py @@ -21,8 +21,8 @@ def test_render_sign_in_template_for_new_user(client_request): # Removing for the pilot # assert page.select('main a')[0].text == 'create one now' # assert page.select('main a')[0]['href'] == url_for('main.register') - assert page.select("main a")[0].text == "Forgot your password?" - assert page.select("main a")[0]["href"] == url_for("main.forgot_password") + assert page.select("main a")[1].text == "Forgot your password?" + assert page.select("main a")[1]["href"] == url_for("main.forgot_password") assert "Sign in again" not in normalize_spaces(page.text) From 4e32ef37b6515e04d3215e0ed8b39d6f8e93954b Mon Sep 17 00:00:00 2001 From: Carlo Costino Date: Tue, 20 Feb 2024 12:43:31 -0500 Subject: [PATCH 28/59] Adjust connectivity to Login.gov - Adds Login.gov to remaining egress proxies (both prototype and production URLs) - Swaps links to Login.gov to production environment Signed-off-by: Carlo Costino --- .github/workflows/deploy-demo.yml | 10 +++++----- .github/workflows/deploy.yml | 10 +++++----- deploy-config/egress_proxy/notify-admin-demo.allow.acl | 2 ++ .../egress_proxy/notify-admin-production.allow.acl | 2 ++ 4 files changed, 14 insertions(+), 10 deletions(-) diff --git a/.github/workflows/deploy-demo.yml b/.github/workflows/deploy-demo.yml index e1d76775a..bf9757493 100644 --- a/.github/workflows/deploy-demo.yml +++ b/.github/workflows/deploy-demo.yml @@ -56,12 +56,12 @@ jobs: NR_BROWSER_KEY: ${{ secrets.NR_BROWSER_KEY }} LOGIN_PEM: ${{ secrets.LOGIN_PEM }} LOGIN_DOT_GOV_CLIENT_ID: "urn:gov:gsa:openidconnect.profiles:sp:sso:gsa:notify-gov" - LOGIN_DOT_GOV_USER_INFO_URL: "https://idp.int.identitysandbox.gov/api/openid_connect/userinfo" - LOGIN_DOT_GOV_ACCESS_TOKEN_URL: "https://idp.int.identitysandbox.gov/api/openid_connect/token" - LOGIN_DOT_GOV_LOGOUT_URL: "https://idp.int.identitysandbox.gov/openid_connect/logout?client_id=urn:gov:gsa:openidconnect.profiles:sp:sso:gsa:notify-gov&post_logout_redirect_uri=https://notify-demo.app.cloud.gov/sign-out" - LOGIN_DOT_GOV_BASE_LOGOUT_URL: "https://idp.int.identitysandbox.gov/openid_connect/logout?" + LOGIN_DOT_GOV_USER_INFO_URL: "https://secure.login.gov/api/openid_connect/userinfo" + LOGIN_DOT_GOV_ACCESS_TOKEN_URL: "https://secure.login.gov/api/openid_connect/token" + LOGIN_DOT_GOV_LOGOUT_URL: "https://secure.login.gov/openid_connect/logout?client_id=urn:gov:gsa:openidconnect.profiles:sp:sso:gsa:notify-gov&post_logout_redirect_uri=https://notify-demo.app.cloud.gov/sign-out" + LOGIN_DOT_GOV_BASE_LOGOUT_URL: "https://secure.login.gov/openid_connect/logout?" LOGIN_DOT_GOV_SIGNOUT_REDIRECT: "https://notify-demo.app.cloud.gov/sign-out" - LOGIN_DOT_GOV_INITIAL_SIGNIN_URL: "https://idp.int.identitysandbox.gov/openid_connect/authorize?acr_values=http%3A%2F%2Fidmanagement.gov%2Fns%2Fassurance%2Fial%2F1&client_id=urn:gov:gsa:openidconnect.profiles:sp:sso:gsa:notify-gov&nonce=01234567890123456789012345&prompt=select_account&redirect_uri=https://notify-demo.app.cloud.gov/sign-in&response_type=code&scope=openid+email&state=abcdefghijklmnopabcdefghijklmnop" + LOGIN_DOT_GOV_INITIAL_SIGNIN_URL: "https://secure.login.gov/openid_connect/authorize?acr_values=http%3A%2F%2Fidmanagement.gov%2Fns%2Fassurance%2Fial%2F1&client_id=urn:gov:gsa:openidconnect.profiles:sp:sso:gsa:notify-gov&nonce=01234567890123456789012345&prompt=select_account&redirect_uri=https://notify-demo.app.cloud.gov/sign-in&response_type=code&scope=openid+email&state=abcdefghijklmnopabcdefghijklmnop" with: cf_username: ${{ secrets.CLOUDGOV_USERNAME }} cf_password: ${{ secrets.CLOUDGOV_PASSWORD }} diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 767acae72..915994d58 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -62,12 +62,12 @@ jobs: NR_BROWSER_KEY: ${{ secrets.NR_BROWSER_KEY }} LOGIN_PEM: ${{ secrets.LOGIN_PEM }} LOGIN_DOT_GOV_CLIENT_ID: "urn:gov:gsa:openidconnect.profiles:sp:sso:gsa:notify-gov" - LOGIN_DOT_GOV_USER_INFO_URL: "https://idp.int.identitysandbox.gov/api/openid_connect/userinfo" - LOGIN_DOT_GOV_ACCESS_TOKEN_URL: "https://idp.int.identitysandbox.gov/api/openid_connect/token" - LOGIN_DOT_GOV_LOGOUT_URL: "https://idp.int.identitysandbox.gov/openid_connect/logout?client_id=urn:gov:gsa:openidconnect.profiles:sp:sso:gsa:notify-gov&post_logout_redirect_uri=https://notify-staging.app.cloud.gov/sign-out" - LOGIN_DOT_GOV_BASE_LOGOUT_URL: "https://idp.int.identitysandbox.gov/openid_connect/logout?" + LOGIN_DOT_GOV_USER_INFO_URL: "https://secure.login.gov/api/openid_connect/userinfo" + LOGIN_DOT_GOV_ACCESS_TOKEN_URL: "https://secure.login.gov/api/openid_connect/token" + LOGIN_DOT_GOV_LOGOUT_URL: "https://secure.login.gov/openid_connect/logout?client_id=urn:gov:gsa:openidconnect.profiles:sp:sso:gsa:notify-gov&post_logout_redirect_uri=https://notify-staging.app.cloud.gov/sign-out" + LOGIN_DOT_GOV_BASE_LOGOUT_URL: "https://secure.login.gov/openid_connect/logout?" LOGIN_DOT_GOV_SIGNOUT_REDIRECT: "https://notify-staging.app.cloud.gov/sign-out" - LOGIN_DOT_GOV_INITIAL_SIGNIN_URL: "https://idp.int.identitysandbox.gov/openid_connect/authorize?acr_values=http%3A%2F%2Fidmanagement.gov%2Fns%2Fassurance%2Fial%2F1&client_id=urn:gov:gsa:openidconnect.profiles:sp:sso:gsa:notify-gov&nonce=01234567890123456789012345&prompt=select_account&redirect_uri=https://notify-staging.app.cloud.gov/sign-in&response_type=code&scope=openid+email&state=abcdefghijklmnopabcdefghijklmnop" + LOGIN_DOT_GOV_INITIAL_SIGNIN_URL: "https://secure.login.gov/openid_connect/authorize?acr_values=http%3A%2F%2Fidmanagement.gov%2Fns%2Fassurance%2Fial%2F1&client_id=urn:gov:gsa:openidconnect.profiles:sp:sso:gsa:notify-gov&nonce=01234567890123456789012345&prompt=select_account&redirect_uri=https://notify-staging.app.cloud.gov/sign-in&response_type=code&scope=openid+email&state=abcdefghijklmnopabcdefghijklmnop" with: cf_username: ${{ secrets.CLOUDGOV_USERNAME }} cf_password: ${{ secrets.CLOUDGOV_PASSWORD }} diff --git a/deploy-config/egress_proxy/notify-admin-demo.allow.acl b/deploy-config/egress_proxy/notify-admin-demo.allow.acl index 4718f99e7..41bf3a365 100644 --- a/deploy-config/egress_proxy/notify-admin-demo.allow.acl +++ b/deploy-config/egress_proxy/notify-admin-demo.allow.acl @@ -1,2 +1,4 @@ gov-collector.newrelic.com egress-proxy-notify-admin-demo.apps.internal +idp.int.identitysandbox.gov +secure.login.gov diff --git a/deploy-config/egress_proxy/notify-admin-production.allow.acl b/deploy-config/egress_proxy/notify-admin-production.allow.acl index 2173a6b4b..8103b0915 100644 --- a/deploy-config/egress_proxy/notify-admin-production.allow.acl +++ b/deploy-config/egress_proxy/notify-admin-production.allow.acl @@ -1,2 +1,4 @@ gov-collector.newrelic.com egress-proxy-notify-admin-production.apps.internal +idp.int.identitysandbox.gov +secure.login.gov From 92fc35b6f60b2349f7a83f47d84c6f3d85022ba2 Mon Sep 17 00:00:00 2001 From: Carlo Costino Date: Mon, 26 Feb 2024 17:39:33 -0500 Subject: [PATCH 29/59] Only enable Login.gov link for demo right now We are holding off on production until we have a chance to share more information with pilot partners. Signed-off-by: Carlo Costino --- app/main/views/sign_in.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/main/views/sign_in.py b/app/main/views/sign_in.py index 853b33648..c6eaee87e 100644 --- a/app/main/views/sign_in.py +++ b/app/main/views/sign_in.py @@ -198,7 +198,7 @@ def sign_in(): form=form, again=bool(redirect_url), other_device=other_device, - login_gov_enabled=True, + login_gov_enabled=bool(notify_env in ["development", "staging", "demo"]), password_reset_url=password_reset_url, initial_signin_url=initial_signin_url, ) From f8b8dd5fb3018f428c57563d08d1b9e187347c5b Mon Sep 17 00:00:00 2001 From: Carlo Costino Date: Mon, 26 Feb 2024 17:59:18 -0500 Subject: [PATCH 30/59] Fix broken test and include note about why Signed-off-by: Carlo Costino --- tests/app/main/views/test_sign_in.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/tests/app/main/views/test_sign_in.py b/tests/app/main/views/test_sign_in.py index 453790536..5675946dc 100644 --- a/tests/app/main/views/test_sign_in.py +++ b/tests/app/main/views/test_sign_in.py @@ -21,8 +21,10 @@ def test_render_sign_in_template_for_new_user(client_request): # Removing for the pilot # assert page.select('main a')[0].text == 'create one now' # assert page.select('main a')[0]['href'] == url_for('main.register') - assert page.select("main a")[1].text == "Forgot your password?" - assert page.select("main a")[1]["href"] == url_for("main.forgot_password") + # TODO: Fix this test to be less brittle! If the Login.gov link is enabled, + # then these indices need to be 1 instead of 0. + assert page.select("main a")[0].text == "Forgot your password?" + assert page.select("main a")[0]["href"] == url_for("main.forgot_password") assert "Sign in again" not in normalize_spaces(page.text) From 6ec0de4b63abc456c0f491f942094005c85f26cd Mon Sep 17 00:00:00 2001 From: Carlo Costino Date: Mon, 26 Feb 2024 18:07:26 -0500 Subject: [PATCH 31/59] One final note about why the test is brittle Signed-off-by: Carlo Costino --- tests/app/main/views/test_sign_in.py | 1 + 1 file changed, 1 insertion(+) diff --git a/tests/app/main/views/test_sign_in.py b/tests/app/main/views/test_sign_in.py index 5675946dc..f85c756ea 100644 --- a/tests/app/main/views/test_sign_in.py +++ b/tests/app/main/views/test_sign_in.py @@ -23,6 +23,7 @@ def test_render_sign_in_template_for_new_user(client_request): # assert page.select('main a')[0]['href'] == url_for('main.register') # TODO: Fix this test to be less brittle! If the Login.gov link is enabled, # then these indices need to be 1 instead of 0. + # Currently it's not enabled for the test or production environments. assert page.select("main a")[0].text == "Forgot your password?" assert page.select("main a")[0]["href"] == url_for("main.forgot_password") assert "Sign in again" not in normalize_spaces(page.text) From 2c6e02137bbdcdf1ccceeee49877c743dc518fce Mon Sep 17 00:00:00 2001 From: Jonathan Bobel Date: Thu, 1 Feb 2024 12:09:43 -0500 Subject: [PATCH 32/59] Updates per Meghan --- app/templates/views/guidance/index.html | 4 +-- app/templates/views/roadmap.html | 4 +-- app/templates/views/security.html | 37 ++----------------------- app/templates/views/support/index.html | 6 ++-- 4 files changed, 9 insertions(+), 42 deletions(-) diff --git a/app/templates/views/guidance/index.html b/app/templates/views/guidance/index.html index e754ef245..b7d6ffa1a 100644 --- a/app/templates/views/guidance/index.html +++ b/app/templates/views/guidance/index.html @@ -41,7 +41,7 @@

    To create and format your message

    1. All messages start from a template
      2. -
    2. Click “Send Messages”. You’ll see existing templates.
      3. +
    3. Click “Send Messages”. You’ll see existing templates.
    4. Add a new template or choose an existing template and select Edit.
    @@ -120,7 +120,7 @@ {# Identify your program #} -

    Identify your program

    +

    Identify your program

    You can help your recipients identify your texts as legitimate by customizing your messages to clearly state who they are from. Consider using the program or benefit name that is most familiar to your recipients.

    diff --git a/app/templates/views/roadmap.html b/app/templates/views/roadmap.html index 6ea2e7cfb..58c9ad4d1 100644 --- a/app/templates/views/roadmap.html +++ b/app/templates/views/roadmap.html @@ -50,9 +50,9 @@
  • Message send/failure analytics
    • - Next +

    Next

    -

    If the pilot is successful, we hope to recruit additional high-impact partners to improve outcomes for low-income individuals and families.

    +

    If the pilot is successful, we hope to recruit additional partners to improve outcomes for low-income individuals and families.

    Goals during this stage:

    diff --git a/app/templates/views/security.html b/app/templates/views/security.html index d676b37bf..35abece07 100644 --- a/app/templates/views/security.html +++ b/app/templates/views/security.html @@ -65,9 +65,9 @@

    Protect sensitive information

    Some messages include sensitive information like security codes or password reset links.

    If you’re sending a message with sensitive information, you can choose to hide those details on the Notify dashboard once the message has been sent. This means that only the message recipient will be able to see that information.

    + Screenshot of a teat message in review with the link to 'hide personalization after sending' circled. -

    User permissions and signing in

    -

    You can set different user permissions in Notify. This lets you control who in your team has access to certain parts of the service.

    Two-factor authentication

    To sign in to Notify, you’ll need to enter:

      @@ -76,11 +76,6 @@

    If signing in with a text message is a problem for your team, contact us to find out about using an email link instead.

    - Screenshot of a teat message in review with the link to 'hide personalization after sending' circled. - -

    How to hide PII after sending a message

    -

    User permissions and signing in

    You can set different user permissions in Notify. This lets you control who in your team has access to certain parts of the service.

    @@ -93,32 +88,4 @@

    If signing in with a text message is a problem for your team, contact us to find out about using an email link instead.

    - - - - - - {% endblock %} diff --git a/app/templates/views/support/index.html b/app/templates/views/support/index.html index d9d6abd53..dd5ad9c10 100644 --- a/app/templates/views/support/index.html +++ b/app/templates/views/support/index.html @@ -13,9 +13,9 @@

    Contact us

    Notify is designed to be easy to use.

      -
    • For information on personalization and data preparation, see Guidance.
      • -
    • For help interpreting delivery reports, see Delivery Status.
      • -
    • For details on pricing and what counts as a message part, see Pricing.
      • +
    • For information on personalization and data preparation, see Guidance.
      • +
    • For help interpreting delivery reports, see Delivery Status.
      • +
    • For details on pricing and what counts as a message part, see Pricing.

    If you have other questions, we are available at notify-support@gsa.gov.

    From e9f96332870e9e0f59769dbbcf1cce9c5386938a Mon Sep 17 00:00:00 2001 From: Carlo Costino Date: Tue, 27 Feb 2024 11:01:37 -0500 Subject: [PATCH 33/59] Fix typo --- app/templates/views/security.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/templates/views/security.html b/app/templates/views/security.html index 35abece07..6d0b3e67d 100644 --- a/app/templates/views/security.html +++ b/app/templates/views/security.html @@ -66,7 +66,7 @@

    Some messages include sensitive information like security codes or password reset links.

    If you’re sending a message with sensitive information, you can choose to hide those details on the Notify dashboard once the message has been sent. This means that only the message recipient will be able to see that information.

    Screenshot of a teat message in review with the link to 'hide personalization after sending' circled. + alt="Screenshot of a test message in review with the link to 'hide personalization after sending' circled.">

    Two-factor authentication

    To sign in to Notify, you’ll need to enter:

    From 116953b33f0e24627f7ca4f14ce2f412c66a6aa3 Mon Sep 17 00:00:00 2001 From: Jonathan Bobel Date: Tue, 27 Feb 2024 12:42:47 -0500 Subject: [PATCH 34/59] Adjusting conditional logic to hide responsive menu button if navigation isn't present --- app/templates/components/components/header/template.njk | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/app/templates/components/components/header/template.njk b/app/templates/components/components/header/template.njk index 7719ac2c8..2c690329a 100644 --- a/app/templates/components/components/header/template.njk +++ b/app/templates/components/components/header/template.njk @@ -55,12 +55,11 @@ notify.gov - + {% if params.navigation %} + + {% endif %}
    - {% if current_user.is_authenticated %} - - {% endif %} -
    +
    + + + +
    +
    + + {% if current_user.is_authenticated %} + + {% endif %} +
    + +
    diff --git a/app/templates/new/components/skip-link/README.md b/app/templates/new/components/skip-link/README.md new file mode 100644 index 000000000..feb7c6614 --- /dev/null +++ b/app/templates/new/components/skip-link/README.md @@ -0,0 +1,15 @@ +# Skip link + +## Installation + +See the [main README quick start guide](https://github.com/alphagov/govuk-frontend#quick-start) for how to install this component. + +## Guidance and Examples + +Find out when to use the skip link component in your service in the [GOV.UK Design System](https://design-system.service.gov.uk/components/skip-link). + +## Component options + +Use options to customize the appearance, content and behavior of a component when using a macro, for example, changing the text. + +See [options table](https://design-system.service.gov.uk/components/skip-link/#options-example-default) for details. diff --git a/app/templates/new/components/skip-link/macro-options.json b/app/templates/new/components/skip-link/macro-options.json new file mode 100644 index 000000000..9a36a1267 --- /dev/null +++ b/app/templates/new/components/skip-link/macro-options.json @@ -0,0 +1,32 @@ +[ + { + "name": "text", + "type": "string", + "required": true, + "description": "If `html` is set, this is not required. Text to use within the skip link component. If `html` is provided, the `text` argument will be ignored." + }, + { + "name": "html", + "type": "string", + "required": true, + "description": "If `text` is set, this is not required. HTML to use within the skip link component. If `html` is provided, the `text` argument will be ignored." + }, + { + "name": "href", + "type": "string", + "required": true, + "description": "The value of the skip link href attribute. Defaults to" + }, + { + "name": "classes", + "type": "string", + "required": false, + "description": "Classes to add to the skip link." + }, + { + "name": "attributes", + "type": "object", + "required": false, + "description": "HTML attributes (for example data attributes) to add to the skip link." + } +] diff --git a/app/templates/new/components/skip-link/macro.njk b/app/templates/new/components/skip-link/macro.njk new file mode 100644 index 000000000..4b1d7ff9a --- /dev/null +++ b/app/templates/new/components/skip-link/macro.njk @@ -0,0 +1,3 @@ +{% macro usaSkipLink(params) %} + {%- include "./template.njk" -%} +{% endmacro %} diff --git a/app/templates/new/components/skip-link/template.njk b/app/templates/new/components/skip-link/template.njk new file mode 100644 index 000000000..e0dad15a8 --- /dev/null +++ b/app/templates/new/components/skip-link/template.njk @@ -0,0 +1,7 @@ + + {{- params.html | safe if params.html else params.text -}} + + + + Skip to main content + diff --git a/app/templates/new/templates_glossary.md b/app/templates/new/templates_glossary.md new file mode 100644 index 000000000..cdf824871 --- /dev/null +++ b/app/templates/new/templates_glossary.md @@ -0,0 +1,27 @@ + +# New Templates Glossary + +This document serves as a glossary for the templates directory structure of the project. + +## Directory Structure + +- `/templates` + - **/layouts**: Contains base templates and shared layouts used across the site. Simply put, it defines the overall structure or skeleton of the application (less frequently revised). + - `base.html`: The main base template from which all other templates inherit. + - `/admin` + - `admin-base.html`: A specialized layout for admin pages. It extends `base.html` but can include additional styling, scripts, or components specific to admin interfaces to enhance security and organization. + - `withnav.html`: A variation of the base layout that includes a sidebar. + - `/error`: Templates for handling HTTP errors + - **/components**: Houses reusable UI components that can be included in multiple templates and can be tailored with different content or links depending on the context.(more frequently revised or customized) + - `header.html`: Template for the site's header, included in `base.html`. + - `footer.html`: Template for the site's footer, included in `base.html`. + - **/partials**: For smaller, reusable pieces of templates, like navigation breadcrumbs or pagination controls we could put this folder into components but if it's more specific to layouts, we can move it into that folder as a sub directory + - **/views** (or **/pages**): Individual page templates that use the base layouts, components, and partials to present content. + +### Best Practices + +- Use **inheritance** (`{% extends %}`) to build on base layouts. +- Employ **components** (`{% include %}`) for reusable UI elements to keep the code DRY and facilitate easier updates. + +### Notes +- Macro json files are just guides on how to structure a dict. It's not actually being used as data being passed to components From dd37e277a54c6bea8aa84c2acc4202afb23d2d10 Mon Sep 17 00:00:00 2001 From: Beverly Nguyen Date: Thu, 29 Feb 2024 10:56:50 -0800 Subject: [PATCH 39/59] updated relative path --- app/templates/new/base.html | 6 +- app/templates/new/components/footer/README.md | 15 --- .../new/components/footer/macro-options.json | 115 ----------------- app/templates/new/components/footer/macro.njk | 3 - .../new/components/footer/template.njk | 117 ------------------ app/templates/new/components/header/README.md | 15 --- .../new/components/header/macro-options.json | 88 ------------- app/templates/new/components/header/macro.njk | 3 - .../new/components/header/template.njk | 104 ---------------- .../new/components/skip-link/README.md | 15 --- .../components/skip-link/macro-options.json | 32 ----- .../new/components/skip-link/macro.njk | 3 - .../new/components/skip-link/template.njk | 7 -- 13 files changed, 3 insertions(+), 520 deletions(-) delete mode 100644 app/templates/new/components/footer/README.md delete mode 100644 app/templates/new/components/footer/macro-options.json delete mode 100644 app/templates/new/components/footer/macro.njk delete mode 100644 app/templates/new/components/footer/template.njk delete mode 100644 app/templates/new/components/header/README.md delete mode 100644 app/templates/new/components/header/macro-options.json delete mode 100644 app/templates/new/components/header/macro.njk delete mode 100644 app/templates/new/components/header/template.njk delete mode 100644 app/templates/new/components/skip-link/README.md delete mode 100644 app/templates/new/components/skip-link/macro-options.json delete mode 100644 app/templates/new/components/skip-link/macro.njk delete mode 100644 app/templates/new/components/skip-link/template.njk diff --git a/app/templates/new/base.html b/app/templates/new/base.html index 38ffb049d..2db02b21a 100644 --- a/app/templates/new/base.html +++ b/app/templates/new/base.html @@ -1,6 +1,6 @@ -{% from "./components/skip-link/macro.njk" import usaSkipLink -%} -{% from "./components/header/macro.njk" import usaHeader -%} -{% from "./components/footer/macro.njk" import usaFooter -%} +{% from "../components/components/skip-link/macro.njk" import usaSkipLink -%} +{% from "../components/components/header/macro.njk" import usaHeader -%} +{% from "../components/components/footer/macro.njk" import usaFooter -%} {# specify absolute url for the static assets folder e.g. http://wwww.domain.com/assets #} {%- set assetUrl = assetUrl | default(assetPath) -%} diff --git a/app/templates/new/components/footer/README.md b/app/templates/new/components/footer/README.md deleted file mode 100644 index 49c5a7082..000000000 --- a/app/templates/new/components/footer/README.md +++ /dev/null @@ -1,15 +0,0 @@ -# Footer - -## Installation - -See the [main README quick start guide](https://github.com/alphagov/govuk-frontend#quick-start) for how to install this component. - -## Guidance and Examples - -Find out when to use the footer component in your service in the [GOV.UK Design System](https://design-system.service.gov.uk/components/footer). - -## Component options - -Use options to customize the appearance, content and behavior of a component when using a macro, for example, changing the text. - -See [options table](https://design-system.service.gov.uk/components/footer/#options-example-default) for details. diff --git a/app/templates/new/components/footer/macro-options.json b/app/templates/new/components/footer/macro-options.json deleted file mode 100644 index f6e2967db..000000000 --- a/app/templates/new/components/footer/macro-options.json +++ /dev/null @@ -1,115 +0,0 @@ -[ - { - "name": "meta", - "type": "object", - "required": false, - "description": "Object containing options for the meta navigation.", - "params": [ - { - "name": "visuallyHiddenTitle", - "type": "string", - "description": "Title for a meta item section, which defaults to Support links" - }, - { - "name": "html", - "type": "string", - "description": "HTML to add to the meta section of the footer, which will appear below any links specified using meta.items." - }, - { - "name": "text", - "type": "string", - "description": "Text to add to the meta section of the footer, which will appear below any links specified using meta.items. If meta.html is specified, this option is ignored." - }, - { - "name": "items", - "type": "array", - "required": false, - "description": "Array of items for use in the meta section of the footer.", - "params": [ - { - "name": "text", - "type": "string", - "required": false, - "description": "List item text in the meta section of the footer." - }, - { - "name": "href", - "type": "string", - "required": false, - "description": "List item href attribute in the meta section of the footer." - }, - { - "name": "attributes", - "type": "object", - "required": false, - "description": "HTML attributes (for example data attributes) to add to the anchor in the footer meta section." - } - ] - } - ] - }, - { - "name": "navigation", - "type": "array", - "required": false, - "description": "Array of items for use in the navigation section of the footer.", - "params": [ - { - "name": "title", - "type": "string", - "required": false, - "description": "Title for a section" - }, - { - "name": "columns", - "type": "integer", - "required": false, - "description": "Amount of columns to display items in navigation section of the footer." - }, - { - "name": "items", - "type": "array", - "required": false, - "description": "Array of items to display in the list in navigation section of the footer.", - "params": [ - { - "name": "text", - "type": "string", - "required": false, - "description": "List item text in the navigation section of the footer." - }, - { - "name": "href", - "type": "string", - "required": false, - "description": "List item href attribute in the navigation section of the footer. Both `text` and `href` attributes need to be present to create a link." - }, - { - "name": "attributes", - "type": "object", - "required": false, - "description": "HTML attributes (for example data attributes) to add to the anchor in the footer navigation section." - } - ] - } - ] - }, - { - "name": "containerClasses", - "type": "string", - "required": false, - "description": "Classes that can be added to the inner container, useful if you want to make the footer full width." - }, - { - "name": "classes", - "type": "string", - "required": false, - "description": "Classes to add to the footer component container." - }, - { - "name": "attributes", - "type": "object", - "required": false, - "description": "HTML attributes (for example data attributes) to add to the footer component container." - } -] diff --git a/app/templates/new/components/footer/macro.njk b/app/templates/new/components/footer/macro.njk deleted file mode 100644 index d0f92f065..000000000 --- a/app/templates/new/components/footer/macro.njk +++ /dev/null @@ -1,3 +0,0 @@ -{% macro usaFooter(params) %} - {%- include "./template.njk" -%} -{% endmacro %} diff --git a/app/templates/new/components/footer/template.njk b/app/templates/new/components/footer/template.njk deleted file mode 100644 index 6864f718a..000000000 --- a/app/templates/new/components/footer/template.njk +++ /dev/null @@ -1,117 +0,0 @@ -
    - {#
    - Return to top -
    #} -
    -
    -
    -
    - {# {% if params.navigation %} - - {% endif %} #} -
    -
    -
    - {% if params.meta %} -

    {{ params.meta.visuallyHiddenTitle | default("Support links") }}

    - {% if params.meta.items %} - {% for item in params.meta.items %} - - {{ item.text }} - - {% endfor %} - {% endif %} - {% if params.meta.text or params.meta.html %} -
    - {{ params.meta.html | safe if params.meta.html else params.meta.text }} -
    - {% endif %} - {% endif %} -
    -
    -
    -
    - - -
    -
    -
    -
    -
    -

    beta.notify.gov

    -

    An official website of the General - Services Administration

    -
    -
    -
    - -
    -
    -
    - Looking for U.S. government information and services? -
    - Visit USA.gov -
    -
    -
    diff --git a/app/templates/new/components/header/README.md b/app/templates/new/components/header/README.md deleted file mode 100644 index a3ea34967..000000000 --- a/app/templates/new/components/header/README.md +++ /dev/null @@ -1,15 +0,0 @@ -# Header - -## Installation - -See the [main README quick start guide](https://github.com/alphagov/govuk-frontend#quick-start) for how to install this component. - -## Guidance and Examples - -Find out when to use the header component in your service in the [GOV.UK Design System](https://design-system.service.gov.uk/components/header). - -## Component options - -Use options to customize the appearance, content and behavior of a component when using a macro, for example, changing the text. - -See [options table](https://design-system.service.gov.uk/components/header/#options-example-default) for details. diff --git a/app/templates/new/components/header/macro-options.json b/app/templates/new/components/header/macro-options.json deleted file mode 100644 index 4411e8100..000000000 --- a/app/templates/new/components/header/macro-options.json +++ /dev/null @@ -1,88 +0,0 @@ -[ - { - "name": "homepageUrl", - "type": "string", - "required": false, - "description": "The url of the homepage. Defaults to /" - }, - { - "name": "assetsPath", - "type": "string", - "required": false, - "description": "The public path for the assets folder. If not provided it defaults to /assets/images" - }, - { - "name": "productName", - "type": "string", - "required": false, - "description": "Header title that is placed next to GOV.UK. Used for product names (i.e. Pay, Verify)" - }, - { - "name": "serviceName", - "type": "string", - "required": false, - "description": "Header title that is placed next to GOV.UK. Used for product names (i.e. Pay, Verify)" - }, - { - "name": "serviceUrl", - "type": "string", - "required": false, - "description": "Url for the service name anchor." - }, - { - "name": "navigation", - "type": "array", - "required": false, - "description": "An array of navigation item objects.", - "params": [ - { - "name": "text", - "type": "string", - "required": false, - "description": "Text of the navigation item." - }, - { - "name": "href", - "type": "string", - "required": false, - "description": "Url of the navigation item anchor. Both `href` and `text` attributes for navigation items need to be provided to create an item." - }, - { - "name": "active", - "type": "boolean", - "required": false, - "description": "Flag to mark the navigation item as active or not." - }, - { - "name": "attributes", - "type": "object", - "required": false, - "description": "HTML attributes (for example data attributes) to add to the navigation item anchor." - } - ] - }, - { - "name": "navigationClasses", - "type": "string", - "required": false, - "description": "Classes for the navigation section of the header." - }, - { - "name": "containerClasses", - "type": "string", - "required": false, - "description": "Classes for the container, useful if you want to make the header fixed width." - }, - { - "name": "classes", - "type": "string", - "required": false, - "description": "Classes to add to the header container." - }, - { - "name": "attributes", - "type": "object", - "required": false, - "description": "HTML attributes (for example data attributes) to add to the header container." - } -] diff --git a/app/templates/new/components/header/macro.njk b/app/templates/new/components/header/macro.njk deleted file mode 100644 index 3f0101fc2..000000000 --- a/app/templates/new/components/header/macro.njk +++ /dev/null @@ -1,3 +0,0 @@ -{% macro usaHeader(params) %} - {%- include "./template.njk" -%} -{% endmacro %} diff --git a/app/templates/new/components/header/template.njk b/app/templates/new/components/header/template.njk deleted file mode 100644 index 6cc8cabd8..000000000 --- a/app/templates/new/components/header/template.njk +++ /dev/null @@ -1,104 +0,0 @@ - -
    -
    -
    -
    -
    - -
    - - -
    -
    - -
    -
    - - -
    -
    - - {% if current_user.is_authenticated %} - - {% endif %} -
    - -
    diff --git a/app/templates/new/components/skip-link/README.md b/app/templates/new/components/skip-link/README.md deleted file mode 100644 index feb7c6614..000000000 --- a/app/templates/new/components/skip-link/README.md +++ /dev/null @@ -1,15 +0,0 @@ -# Skip link - -## Installation - -See the [main README quick start guide](https://github.com/alphagov/govuk-frontend#quick-start) for how to install this component. - -## Guidance and Examples - -Find out when to use the skip link component in your service in the [GOV.UK Design System](https://design-system.service.gov.uk/components/skip-link). - -## Component options - -Use options to customize the appearance, content and behavior of a component when using a macro, for example, changing the text. - -See [options table](https://design-system.service.gov.uk/components/skip-link/#options-example-default) for details. diff --git a/app/templates/new/components/skip-link/macro-options.json b/app/templates/new/components/skip-link/macro-options.json deleted file mode 100644 index 9a36a1267..000000000 --- a/app/templates/new/components/skip-link/macro-options.json +++ /dev/null @@ -1,32 +0,0 @@ -[ - { - "name": "text", - "type": "string", - "required": true, - "description": "If `html` is set, this is not required. Text to use within the skip link component. If `html` is provided, the `text` argument will be ignored." - }, - { - "name": "html", - "type": "string", - "required": true, - "description": "If `text` is set, this is not required. HTML to use within the skip link component. If `html` is provided, the `text` argument will be ignored." - }, - { - "name": "href", - "type": "string", - "required": true, - "description": "The value of the skip link href attribute. Defaults to" - }, - { - "name": "classes", - "type": "string", - "required": false, - "description": "Classes to add to the skip link." - }, - { - "name": "attributes", - "type": "object", - "required": false, - "description": "HTML attributes (for example data attributes) to add to the skip link." - } -] diff --git a/app/templates/new/components/skip-link/macro.njk b/app/templates/new/components/skip-link/macro.njk deleted file mode 100644 index 4b1d7ff9a..000000000 --- a/app/templates/new/components/skip-link/macro.njk +++ /dev/null @@ -1,3 +0,0 @@ -{% macro usaSkipLink(params) %} - {%- include "./template.njk" -%} -{% endmacro %} diff --git a/app/templates/new/components/skip-link/template.njk b/app/templates/new/components/skip-link/template.njk deleted file mode 100644 index e0dad15a8..000000000 --- a/app/templates/new/components/skip-link/template.njk +++ /dev/null @@ -1,7 +0,0 @@ - - {{- params.html | safe if params.html else params.text -}} - - - - Skip to main content - From 98297515d8ff71ac059ca0fbdae29a36c8accf20 Mon Sep 17 00:00:00 2001 From: Beverly Nguyen Date: Thu, 29 Feb 2024 16:36:11 -0800 Subject: [PATCH 40/59] updated base.html template to also include admin-template --- app/templates/new/base.html | 368 ++++++++++++++++-- .../new/layouts/withnav_template.html | 41 ++ app/templates/new/templates_glossary.md | 20 +- 3 files changed, 394 insertions(+), 35 deletions(-) create mode 100644 app/templates/new/layouts/withnav_template.html diff --git a/app/templates/new/base.html b/app/templates/new/base.html index 2db02b21a..7f806b660 100644 --- a/app/templates/new/base.html +++ b/app/templates/new/base.html @@ -1,65 +1,373 @@ -{% from "../components/components/skip-link/macro.njk" import usaSkipLink -%} -{% from "../components/components/header/macro.njk" import usaHeader -%} -{% from "../components/components/footer/macro.njk" import usaFooter -%} -{# specify absolute url for the static assets folder e.g. http://wwww.domain.com/assets #} -{%- set assetUrl = assetUrl | default(assetPath) -%} +{% from "components/banner.html" import banner %} +{% from "./components/components/skip-link/macro.njk" import usaSkipLink -%} +{% from "./components/components/header/macro.njk" import usaHeader -%} +{% from "./components/components/footer/macro.njk" import usaFooter -%} + + - {% block pageTitle %}Notify.gov{% endblock %} + + {% block pageTitle %} + {% block per_page_title %} {% endblock %}Notify.gov + <!-- on templates that were using content_template.html, we might need to use the {{ content_page_title }} variable for the per_page_title --> + {% endblock %} + {% if config['NR_MONITOR_ON'] %} {% include "partials/newrelic.html" -%} {% endif %} - {# Ensure that older IE versions always render with the correct rendering engine #} - {% block headIcons %} - - - - + + + + {% endblock %} - {% block head %}{% endblock %} - {# The default og:image is added below head so that scrapers see any custom metatags first, and this is just a fallback #} - {% block meta %} - - + {% block head %} + + {% block extra_stylesheets %} + {% endblock %} + {% if g.hide_from_search_engines %} + + {% endif %} + + {# The default og:image is added below head so that scrapers see any custom metatags first, and this is just a fallback #} + {% block meta_format_detection %} + + {% endblock %} + {% block meta %} + + + {% endblock %} + {% endblock %} + - {% block bodyStart %}{% endblock %} - + {% block bodyStart %} + {% block extra_javascripts_before_body %} + + + + {% endblock %} + {% endblock %} +
    block skipLink {% block skipLink %} {{ usaSkipLink({ "href": '#main-content', "text": 'Skip to main content' }) }} {% endblock %} +
    +
    block header {% block header %} - {{ usaHeader({}) }} - {% endblock %} + {% if current_user.is_authenticated %} + {% if current_user.platform_admin %} + {% set navigation = [ + { + "href": url_for("main.show_accounts_or_dashboard"), + "text": "Current service", + "active": header_navigation.is_selected('accounts-or-dashboard') + }, + { + "href": url_for('main.get_started'), + "text": "Using Notify", + "active": header_navigation.is_selected('using_notify') + }, + { + "href": url_for('main.features'), + "text": "Features", + "active": header_navigation.is_selected('features') + }, + { + "href": url_for('main.platform_admin_splash_page'), + "text": "Platform admin", + "active": header_navigation.is_selected('platform-admin') + }, + { + "href": url_for('main.support'), + "text": "Contact us", + "active": header_navigation.is_selected('support') + } + ] %} + {% if current_service %} + {% set secondaryNavigation = [ + { + "href": url_for('main.service_settings', service_id=current_service.id), + "text": "Settings", + "active": secondary_navigation.is_selected('settings') + }, + { + "href": url_for('main.sign_out'), + "text": "Sign out" + } + ] %} + {% else %} + {% set secondaryNavigation = [ + { + "href": url_for('main.sign_out'), + "text": "Sign out" + } + ] %} + {% endif %} + {% else %} + {% set navigation = [ + { + "href": url_for("main.show_accounts_or_dashboard"), + "text": "Current service", + "active": header_navigation.is_selected('accounts-or-dashboard') + }, + { + "href": url_for('main.get_started'), + "text": "Using Notify", + "active": header_navigation.is_selected('using_notify') + }, + { + "href": url_for('main.features'), + "text": "Features", + "active": header_navigation.is_selected('features') + }, + { + "href": url_for('main.support'), + "text": "Contact us", + "active": header_navigation.is_selected('support') + }, + { + "href": url_for('main.user_profile'), + "text": "User profile", + "active": header_navigation.is_selected('user-profile') + } + ] %} + {% if current_service %} + {% set secondaryNavigation = [ + { + "href": url_for('main.service_settings', service_id=current_service.id), + "text": "Settings", + "active": secondary_navigation.is_selected('settings') + }, + { + "href": url_for('main.sign_out'), + "text": "Sign out" + } + ] %} + {% else %} + {% set secondaryNavigation = [ + { + "href": url_for('main.sign_out'), + "text": "Sign out" + } + ] %} + {% endif %} + {% endif %} + {% else %} + + {# {% set navigation = [ + { + "href": url_for('main.get_started'), + "text": "Using Notify", + "active": header_navigation.is_selected('using_notify') + }, + { + "href": url_for('main.features'), + "text": "Features", + "active": header_navigation.is_selected('features') + }, + { + "href": url_for('main.support'), + "text": "Contact us", + "active": header_navigation.is_selected('support') + }, + { + "href": url_for('main.sign_in'), + "text": "Sign in", + "active": header_navigation.is_selected('sign-in') + } + ] %} #} + {% endif %} + {{ usaHeader({ + "homepageUrl": url_for('main.show_accounts_or_dashboard'), + "productName": "Notify", + "navigation": navigation, + "navigationClasses": "govuk-header__navigation--end", + "secondaryNavigation": secondaryNavigation, + "assetsPath": asset_path + "images" + }) }} + {% endblock %} +
    + +
    block main {% block main %} -
    - {% block beforeContent %}{% endblock %} -
    - {% block content %}{% endblock %} -
    -
    +
    + {% block beforeContent %} + {% block backLink %}{% endblock %} + {% endblock %} + {% block mainClasses %} + +
    + {% endblock %} + {% block content %} + {% block flash_messages %} + + {% endblock %} + {% block maincolumn_content %} + {% block fromContentTemplatetwoColumnGrid %} +
    + {% if navigation_links %} +
    + {{ sub_navigation(navigation_links) }} +
    +
    + {% else %} +
    + {% endif %} + {% block content_column_content %}{% endblock %} +
    +
    + + {% endblock %} + {% endblock %} + {% endblock %} +
    +
    {% endblock %} +
    +
    block footer {% block footer %} - {{ usaFooter({}) }} - {% endblock %} - {% block bodyEnd %}{% endblock %} + {% if current_service and current_service.research_mode %} + {% set meta_suffix = 'Built by the Technology Transformation Servicesresearch mode' %} + {% else %} + {% set meta_suffix = 'Built by the Technology Transformation Services' %} + {% endif %} + + {{ usaFooter({ + "classes": "js-footer", + "navigation": [ + { + "title": "About Notify", + "columns": 1, + "items": [ + { + "href": url_for("main.features"), + "text": "Features" + }, + { + "href": url_for("main.roadmap"), + "text": "Roadmap" + }, + { + "href": url_for("main.security"), + "text": "Security" + }, + { + "href": url_for("main.terms"), + "text": "Terms of use" + }, + ] + }, + { + "title": "Using Notify", + "columns": 1, + "items": [ + { + "href": url_for("main.get_started"), + "text": "Get started" + }, + { + "href": url_for("main.pricing"), + "text": "Pricing" + }, + { + "href": url_for("main.trial_mode_new"), + "text": "Trial mode" + }, + { + "href": url_for("main.message_status"), + "text": "Delivery status" + }, + { + "href": url_for("main.guidance_index"), + "text": "Guidance" + }, + { + "href": url_for("main.documentation"), + "text": "API documentation" + } + ] + }, + { + "title": "Support", + "columns": 1, + "items": [ + { + "href": url_for('main.support'), + "text": "Contact us" + }, + ] + }, + ], + "meta": { + "items": meta_items, + "html": meta_suffix + } + }) }} + + {% if current_user.is_authenticated %} + {% block sessionUserWarning %} + +
    +
    +

    + Your session will end soon. + Please choose to extend your session or sign out. Your session will expire in 5 minutes or less. +

    +
    +

    You have been inactive for too long. + Your session will expire in . +

    +
    +
    +
      +
    • + +
      • +
    • + +
      • +
    +
    +
    +
    +     + {% endblock %} + {% endif %} + + {% endblock %} +
    + + {% block bodyEnd %} + {% block extra_javascripts %} + {% endblock %} + + + + + {% endblock %} diff --git a/app/templates/new/layouts/withnav_template.html b/app/templates/new/layouts/withnav_template.html new file mode 100644 index 000000000..78cd85e6a --- /dev/null +++ b/app/templates/new/layouts/withnav_template.html @@ -0,0 +1,41 @@ +{% extends "base.html" %} + +{% block per_page_title %} + {% block service_page_title %}{% endblock %} – {{ current_service.name }} +{% endblock %} + +{% block main %} +
    + {% block serviceNavigation %} + {% include "service_navigation.html" %} + {% endblock %} + +
    + {% if help %} +
    + {% else %} +
    + {% endif %} + {% block sideNavigation %} + {% include "main_nav.html" %} + + {% endblock %} +
    + {% if help %} +
    + {% else %} +
    + {% endif %} + {% block beforeContent %} + {% block backLink %}{% endblock %} + {% endblock %} +
    + {% block content %} + {% include 'flash_messages.html' %} + {% block maincolumn_content %}{% endblock %} + {% endblock %} +
    +
    +
    +
    +{% endblock %} diff --git a/app/templates/new/templates_glossary.md b/app/templates/new/templates_glossary.md index cdf824871..a34d06b01 100644 --- a/app/templates/new/templates_glossary.md +++ b/app/templates/new/templates_glossary.md @@ -6,16 +6,13 @@ This document serves as a glossary for the templates directory structure of the ## Directory Structure - `/templates` + - `base.html`: The main base template from which all other templates inherit. This template is a combination of the old admin_template and main_template.html - **/layouts**: Contains base templates and shared layouts used across the site. Simply put, it defines the overall structure or skeleton of the application (less frequently revised). - - `base.html`: The main base template from which all other templates inherit. - - `/admin` - - `admin-base.html`: A specialized layout for admin pages. It extends `base.html` but can include additional styling, scripts, or components specific to admin interfaces to enhance security and organization. - - `withnav.html`: A variation of the base layout that includes a sidebar. + - `withnav_template.html`: A variation of the base layout that includes a sidebar. - `/error`: Templates for handling HTTP errors - **/components**: Houses reusable UI components that can be included in multiple templates and can be tailored with different content or links depending on the context.(more frequently revised or customized) - `header.html`: Template for the site's header, included in `base.html`. - `footer.html`: Template for the site's footer, included in `base.html`. - - **/partials**: For smaller, reusable pieces of templates, like navigation breadcrumbs or pagination controls we could put this folder into components but if it's more specific to layouts, we can move it into that folder as a sub directory - **/views** (or **/pages**): Individual page templates that use the base layouts, components, and partials to present content. ### Best Practices @@ -25,3 +22,16 @@ This document serves as a glossary for the templates directory structure of the ### Notes - Macro json files are just guides on how to structure a dict. It's not actually being used as data being passed to components + + + +### Old Layout Templates We Don't Need +- withoutnav_template.html Delete +- main_template.html Delete +- settings_templates.html Delete +- settings_nav.html (move to /new/navigation directory) +- main_nav.html (move to /new/navigation directory) +- service_navigation.html (move to /new/navigation directory) +- org_template, could be under it's own directory called /organization +- org_nav.html (move to /new/navigation directory) +- -content_template.html Delete and consolidate to base template From ebd04e44c2ed61e00bc18995aba25e434498eaed Mon Sep 17 00:00:00 2001 From: Beverly Nguyen Date: Thu, 29 Feb 2024 16:38:41 -0800 Subject: [PATCH 41/59] revert main_Template --- app/templates/admin_template.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/templates/admin_template.html b/app/templates/admin_template.html index bd4383579..c48f768ce 100644 --- a/app/templates/admin_template.html +++ b/app/templates/admin_template.html @@ -1,4 +1,4 @@ -{% extends "new/base.html" %} +{% extends "main_template.html" %} {% from "components/banner.html" import banner %} {% block headIcons %} From 996db0d60bd7765bbffb79f3bf862daf1027f8ae Mon Sep 17 00:00:00 2001 From: Beverly Nguyen Date: Fri, 1 Mar 2024 10:38:07 -0800 Subject: [PATCH 42/59] relative path update --- app/templates/new/base.html | 23 +++++++++++------------ app/templates/new/templates_glossary.md | 6 +++--- 2 files changed, 14 insertions(+), 15 deletions(-) diff --git a/app/templates/new/base.html b/app/templates/new/base.html index 7f806b660..b175cff51 100644 --- a/app/templates/new/base.html +++ b/app/templates/new/base.html @@ -1,7 +1,7 @@ -{% from "components/banner.html" import banner %} -{% from "./components/components/skip-link/macro.njk" import usaSkipLink -%} -{% from "./components/components/header/macro.njk" import usaHeader -%} -{% from "./components/components/footer/macro.njk" import usaFooter -%} +{% from "../components/banner.html" import banner %} +{% from "../components/components/skip-link/macro.njk" import usaSkipLink -%} +{% from "../components/components/header/macro.njk" import usaHeader -%} +{% from "../components/components/footer/macro.njk" import usaFooter -%} @@ -59,16 +59,15 @@ {% endblock %} {% endblock %} -
    block skipLink + {% block skipLink %} {{ usaSkipLink({ "href": '#main-content', "text": 'Skip to main content' }) }} {% endblock %} -
    -
    block header + {% block header %} {% if current_user.is_authenticated %} {% if current_user.platform_admin %} @@ -203,9 +202,9 @@ "assetsPath": asset_path + "images" }) }} {% endblock %} -
    + -
    block main + {% block main %}
    {% block beforeContent %} @@ -240,9 +239,9 @@
    {% endblock %} -
    + -
    block footer + {% block footer %} {% if current_service and current_service.research_mode %} @@ -359,7 +358,7 @@ {% endif %} {% endblock %} -
    + {% block bodyEnd %} {% block extra_javascripts %} diff --git a/app/templates/new/templates_glossary.md b/app/templates/new/templates_glossary.md index a34d06b01..894628d89 100644 --- a/app/templates/new/templates_glossary.md +++ b/app/templates/new/templates_glossary.md @@ -6,7 +6,7 @@ This document serves as a glossary for the templates directory structure of the ## Directory Structure - `/templates` - - `base.html`: The main base template from which all other templates inherit. This template is a combination of the old admin_template and main_template.html + - `base.html`: The main base template from which all other templates inherit. This template is a combination of `main_template`, `admin_template`, `settings_template`, and `content_template`. - **/layouts**: Contains base templates and shared layouts used across the site. Simply put, it defines the overall structure or skeleton of the application (less frequently revised). - `withnav_template.html`: A variation of the base layout that includes a sidebar. - `/error`: Templates for handling HTTP errors @@ -20,8 +20,8 @@ This document serves as a glossary for the templates directory structure of the - Use **inheritance** (`{% extends %}`) to build on base layouts. - Employ **components** (`{% include %}`) for reusable UI elements to keep the code DRY and facilitate easier updates. -### Notes -- Macro json files are just guides on how to structure a dict. It's not actually being used as data being passed to components +### Observation Notes +- The macro-options.json files in the header and footer component act as structural guides. They aren't directly used as data passed to the usaFooter function/macro. Instead, these files outline the expected properties and provide a description of their purpose. The `usaFooter` macro component is currently only invoked in the `admin_template`, which will eventually serve as the `base.html` template. This will simplify the approach when we change the footer macros to componenets by eliminating the need to dynamically pass this data from the base.html template. From cea10446f7f8abaeb5c7efc642cea584c8f7ee9d Mon Sep 17 00:00:00 2001 From: Beverly Nguyen Date: Mon, 4 Mar 2024 11:03:22 -0800 Subject: [PATCH 43/59] added notes and org_template --- app/templates/new/layouts/org_template.html | 35 +++++++++++++++++++ .../new/layouts/withnav_template.html | 2 +- app/templates/new/templates_glossary.md | 10 +++--- 3 files changed, 41 insertions(+), 6 deletions(-) create mode 100644 app/templates/new/layouts/org_template.html diff --git a/app/templates/new/layouts/org_template.html b/app/templates/new/layouts/org_template.html new file mode 100644 index 000000000..5e04003fd --- /dev/null +++ b/app/templates/new/layouts/org_template.html @@ -0,0 +1,35 @@ +{% extends "base.html" %} + +{% block per_page_title %} + {% block org_page_title %}{% endblock %} – {{ current_org.name }} +{% endblock %} + +{% block main %} +
    +
    + {% if current_user.platform_admin %} + Organizations + {% endif %} +
    + {{ current_org.name }} +
    + Switch service +
    +
    +
    + {% include "org_nav.html" %} +
    +
    + {% block beforeContent %} + {% block backLink %}{% endblock %} + {% endblock %} +
    + {% block content %} + {% include 'flash_messages.html' %} + {% block maincolumn_content %}{% endblock %} + {% endblock %} +
    +
    +
    +
    +{% endblock %} diff --git a/app/templates/new/layouts/withnav_template.html b/app/templates/new/layouts/withnav_template.html index 78cd85e6a..412a004d0 100644 --- a/app/templates/new/layouts/withnav_template.html +++ b/app/templates/new/layouts/withnav_template.html @@ -9,7 +9,7 @@ {% block serviceNavigation %} {% include "service_navigation.html" %} {% endblock %} - +
    {% if help %}
    diff --git a/app/templates/new/templates_glossary.md b/app/templates/new/templates_glossary.md index 894628d89..81325e26c 100644 --- a/app/templates/new/templates_glossary.md +++ b/app/templates/new/templates_glossary.md @@ -6,10 +6,10 @@ This document serves as a glossary for the templates directory structure of the ## Directory Structure - `/templates` - - `base.html`: The main base template from which all other templates inherit. This template is a combination of `main_template`, `admin_template`, `settings_template`, and `content_template`. + - `base.html`: The main base template from which all other templates inherit. This template is a combination of `main_template`, `admin_template`, `withoutnav_template` and `content_template`. - **/layouts**: Contains base templates and shared layouts used across the site. Simply put, it defines the overall structure or skeleton of the application (less frequently revised). - `withnav_template.html`: A variation of the base layout that includes a sidebar. - - `/error`: Templates for handling HTTP errors + - `org_template.html`: A variaton of the withnav_template - **/components**: Houses reusable UI components that can be included in multiple templates and can be tailored with different content or links depending on the context.(more frequently revised or customized) - `header.html`: Template for the site's header, included in `base.html`. - `footer.html`: Template for the site's footer, included in `base.html`. @@ -28,10 +28,10 @@ This document serves as a glossary for the templates directory structure of the ### Old Layout Templates We Don't Need - withoutnav_template.html Delete - main_template.html Delete -- settings_templates.html Delete +- settings_templates.html `withnav_template` can be used to replace `settings_template`. - settings_nav.html (move to /new/navigation directory) - main_nav.html (move to /new/navigation directory) - service_navigation.html (move to /new/navigation directory) -- org_template, could be under it's own directory called /organization +- org_template, could be under it's own directory called /layout/organization - org_nav.html (move to /new/navigation directory) -- -content_template.html Delete and consolidate to base template +- content_template.html Delete From 026ed52ce53620fce2b8864f2836ed7a10e7adb6 Mon Sep 17 00:00:00 2001 From: Jonathan Bobel Date: Tue, 5 Mar 2024 09:51:25 -0500 Subject: [PATCH 44/59] When resizing the viewport for the header, I noticed other responsive issues and addressed them here --- .../uswds/_uswds-theme-custom-styles.scss | 2 +- app/templates/content_template.html | 4 +- app/templates/main_nav.html | 2 +- .../partials/notifications/notifications.html | 2 +- app/templates/settings_template.html | 8 +- .../views/activity/notifications.html | 2 + app/templates/views/api/callbacks.html | 38 ++-- app/templates/views/dashboard/_jobs.html | 206 +++++++++--------- app/templates/views/dashboard/dashboard.html | 2 +- app/templates/views/performance.html | 124 ++++++----- app/templates/views/usage.html | 2 + app/templates/withnav_template.html | 6 +- 12 files changed, 206 insertions(+), 192 deletions(-) diff --git a/app/assets/sass/uswds/_uswds-theme-custom-styles.scss b/app/assets/sass/uswds/_uswds-theme-custom-styles.scss index e65bf2350..55f17a795 100644 --- a/app/assets/sass/uswds/_uswds-theme-custom-styles.scss +++ b/app/assets/sass/uswds/_uswds-theme-custom-styles.scss @@ -355,7 +355,7 @@ td.table-empty-message { background-image: url(../img/material-icons/description.svg); } } - .job-table, .dashboard-table { + .table-wrapper { overflow-x: scroll; } } diff --git a/app/templates/content_template.html b/app/templates/content_template.html index abca0be7e..34b488bb5 100644 --- a/app/templates/content_template.html +++ b/app/templates/content_template.html @@ -11,10 +11,10 @@
    {% if navigation_links %} -
    +
    {{ sub_navigation(navigation_links) }}
    -
    +
    {% else %}
    {% endif %} diff --git a/app/templates/main_nav.html b/app/templates/main_nav.html index 65c875d7a..2f7306f09 100644 --- a/app/templates/main_nav.html +++ b/app/templates/main_nav.html @@ -1,7 +1,7 @@ {% if help %} {% include 'partials/tour.html' %} {% else %} -