darkhelm/notifications-admin
1
0
Fork 0
mirror of https://github.com/GSA/notifications-admin.git synced 2026-09-05 16:18:26 -04:00
Code Issues Packages Projects Releases Wiki Activity
Files
ebb82b2e80d926d7d76fa972bf11599350fed65c
notifications-admin/app/templates/partials/jobs/notifications.html

78 lines
2.9 KiB
HTML
Raw Normal View History

Remove date table field type No longer used anywhere.
2016-09-09 15:41:32 +01:00
{% from "components/table.html" import list_table, field, right_aligned_field_heading, row_heading, notification_status_field %}
Add a cancel job button If you schedule a job you might change your mind or circumstances might change. So you need to be able to cancel it. This commit adds a button on the job page which hits the `…/cancel` API endpoint for a job.
2016-09-01 15:40:49 +01:00
{% from "components/page-footer.html" import page_footer %}
Use a macro for form tags This will stop us repeatedly forgetting to add `novalidate` and `autocomplete='off'` to our forms (which is how most of them are set up). It uses sensible defaults, based on how we most-commonly configure forms: - most of our forms are `post`ed (but this can be overridden) - `autocomplete` should only be enabled where it makes sense, otherwise it’s more annoying than useful (but this can be overriden) - we should never be using HTML5 form validation because our own error styles and messages are better
2018-09-19 12:39:36 +01:00
{% from "components/form.html" import form_wrapper %}
Make job page poll for updates This is a first go at having the job page update without refreshing. The approach I’ve taken is to do all the rendering of HTML on the server side, rather than use a Javascipt templating engine like mustache. This ensures that we don’t have to maintain two sets of templates. So the approach is to split the job page into partials. These partials can then: - be included in the job page to render the whole page - be rendered indivudually and then returned as a blob of HTML inside a JSON response Then I’ve added a Javascript module which looks for areas of the page that should be reloaded. For each area of the page it will poll a URL and re-render that section of the page when it gets new HTML. It implements some throttling so that API calls will never happen more frequently than 0.67 times/second.
2016-03-02 17:36:20 +00:00
Make jobs notification partial a role of region Previously attempted in this commit by changing the element to a <section>: https://github.com/alphagov/notifications-admin/commit/e815a7323311a4487addd5bb99ee72b7412775fc This broke the updateContent.js, that polls the JSON endpoint for the partial and updates its content with changes sent back. From what I could tell, it broke it because the JS that does the update gets the diff between the current partial and the one sent in JSON and applies it to the current one. If the notification hasn't completed before the page loads, the partial added to the page has a <div> wrapping it, to initalise the updateContent.js JS. This means the diff ends up being between elements with a different level of hierarchy: Element 1: <div data-module="update-content"> <div class="ajax-block-container"> ... </div> </div> Element 2: <div class="ajax-block-container"> ... </div> This seems to work OK when the partial is a <div>, I assume because it's the same type of element as the wrapper, but not when it's a <section>: Element 1: <div data-module="update-content"> <section class="ajax-block-container"> ... </section> </div> Element 2: <section class="ajax-block-container"> ... </section> Because of all this, it's easier to just give it the role of 'region'.
2020-09-10 23:12:29 +01:00
<div class="ajax-block-container" aria-labelledby='pill-selected-item' role="region">
Make a job model for individual jobs This follows the pattern of what we’ve done with services, users and events. It gives us a better interface to the data we get back from the API than dealing with the raw JSON directly. Now is a good time to do this because we’re going to be making a bunch of changes to the jobs pages, and those changes will be easier to code and understand with a sesnsible model behind them.
2020-01-08 12:23:09 +00:00
{% if job.scheduled %}
Make a macro for the AJAX update module This is less repetitive than typing out the HTML with all its attributes every time. It also lets us wrap up the idea of ‘finished’ as a parameter, so the AJAX code will only be initiated when it’s needed, eg if a job is still processing.
2016-06-28 09:21:46 +01:00
Don’t allow paragraphs without class attribute All paragraphs should have class="govuk-body", or be otherwise custom-styled. This commit adds some extra checks to our test fixture that looks for paragraphs that don’t have any styling. Our test coverage is pretty good, so this should check almost all pages, and prevent regressions. I’ve done this in such a way that it can be extended for other elements (e.g. links) in the future.
2020-05-29 17:11:01 +01:00
<p class="govuk-body">
Revert "Merge pull request #1336 from alphagov/revert-show-notifications" This reverts commit 7e354ff341172041d6141b50833af6262308fcb4, reversing changes made to 6f3bcff32fbfc78b4df0558d08605a260786112f.
2017-06-24 17:12:45 +01:00
Sending
Update all links to use GOVUK Frontend style Includes: - turning off :visited styles to match existing design - swapping heading classes used to make links bold for the GOVUK Frontend bold override class - adding visually hidden text to some links to make them work when isolated from their context We may need to revisit whether some links, such as those for documentation and features, may benefit from having some indication that their target has been visited.
2019-12-06 07:53:46 +00:00
<a class="govuk-link govuk-link--no-visited-state" href="{{ url_for('.view_template_version', service_id=current_service.id, template_id=job.template.id, version=job.template_version) }}">{{ job.template.name }}</a>
Revert "Merge pull request #1336 from alphagov/revert-show-notifications" This reverts commit 7e354ff341172041d6141b50833af6262308fcb4, reversing changes made to 6f3bcff32fbfc78b4df0558d08605a260786112f.
2017-06-24 17:12:45 +01:00
{{ job.scheduled_for|format_datetime_relative }}
Make sure partials always have a wrapping `<div>` The diffDOM Javascript sometimes throws an error if it can’t calculate a diff between the original content of the page and the updated HTML delivered via AJAX. The problem seems to be when there’s not one, consistent top-level element for it to base its calculations on. This commit: - makes sure that all AJAX-delivered partials have a wrapping `<div>` - that this `<div>` has a consistent class name to make it clear why it’s there
2016-09-01 11:06:52 +01:00
</p>
Add a cancel job button If you schedule a job you might change your mind or circumstances might change. So you need to be able to cancel it. This commit adds a button on the job page which hits the `…/cancel` API endpoint for a job.
2016-09-01 15:40:49 +01:00
<div class="page-footer">
Use a macro for form tags This will stop us repeatedly forgetting to add `novalidate` and `autocomplete='off'` to our forms (which is how most of them are set up). It uses sensible defaults, based on how we most-commonly configure forms: - most of our forms are `post`ed (but this can be overridden) - `autocomplete` should only be enabled where it makes sense, otherwise it’s more annoying than useful (but this can be overriden) - we should never be using HTML5 form validation because our own error styles and messages are better
2018-09-19 12:39:36 +01:00
{% call form_wrapper() %}
Add a cancel job button If you schedule a job you might change your mind or circumstances might change. So you need to be able to cancel it. This commit adds a button on the job page which hits the `…/cancel` API endpoint for a job.
2016-09-01 15:40:49 +01:00
{{ page_footer(
button_text="Cancel sending",
destructive=True
) }}
Use a macro for form tags This will stop us repeatedly forgetting to add `novalidate` and `autocomplete='off'` to our forms (which is how most of them are set up). It uses sensible defaults, based on how we most-commonly configure forms: - most of our forms are `post`ed (but this can be overridden) - `autocomplete` should only be enabled where it makes sense, otherwise it’s more annoying than useful (but this can be overriden) - we should never be using HTML5 form validation because our own error styles and messages are better
2018-09-19 12:39:36 +01:00
{% endcall %}
Add a cancel job button If you schedule a job you might change your mind or circumstances might change. So you need to be able to cancel it. This commit adds a button on the job page which hits the `…/cancel` API endpoint for a job.
2016-09-01 15:40:49 +01:00
</div>
Show message on job page if job is scheduled If a job is scheduled then we can’t show the notifications yet, and the progress report will stay at 0%. In their place we should show what time a job will start. Later on (when the API is ready) this area of the page should also show a cancel button.
2016-08-25 16:49:31 +01:00
Make sure partials always have a wrapping `<div>` The diffDOM Javascript sometimes throws an error if it can’t calculate a diff between the original content of the page and the updated HTML delivered via AJAX. The problem seems to be when there’s not one, consistent top-level element for it to base its calculations on. This commit: - makes sure that all AJAX-delivered partials have a wrapping `<div>` - that this `<div>` has a consistent class name to make it clear why it’s there
2016-09-01 11:06:52 +01:00
{% else %}
Show message on job page if job is scheduled If a job is scheduled then we can’t show the notifications yet, and the progress report will stay at 0%. In their place we should show what time a job will start. Later on (when the API is ready) this area of the page should also show a cancel button.
2016-08-25 16:49:31 +01:00
Make sure partials always have a wrapping `<div>` The diffDOM Javascript sometimes throws an error if it can’t calculate a diff between the original content of the page and the updated HTML delivered via AJAX. The problem seems to be when there’s not one, consistent top-level element for it to base its calculations on. This commit: - makes sure that all AJAX-delivered partials have a wrapping `<div>` - that this `<div>` has a consistent class name to make it clear why it’s there
2016-09-01 11:06:52 +01:00
{% if notifications %}
Add a back to template link on job page When you’ve sent message(s) using a template, often the next thing you want to do is go and send the same template again, or edit it. Currently there’s no way of getting to a template from a job except for going back to the list of templates and re-finding it. This commit adds a link at the bottom of the job page that gives you a shortcut back to the individual template, where you can find actions like edit/send/etc.
2017-03-22 10:55:15 +00:00
<div class="dashboard-table bottom-gutter-3-2">
Make sure partials always have a wrapping `<div>` The diffDOM Javascript sometimes throws an error if it can’t calculate a diff between the original content of the page and the updated HTML delivered via AJAX. The problem seems to be when there’s not one, consistent top-level element for it to base its calculations on. This commit: - makes sure that all AJAX-delivered partials have a wrapping `<div>` - that this `<div>` has a consistent class name to make it clear why it’s there
2016-09-01 11:06:52 +01:00
{% endif %}
Make the job page look close to the activity page We can’t filter a job by notification status yet, but we can: - put the download link in the same place - make the table line up the same
2016-06-13 14:13:23 +01:00
Use template_type property directly from API It’s included in the job/upload response now[1]. So we don’t need to fetch the template every time we want to access it. 1. https://github.com/alphagov/notifications-api/pull/2728
2020-02-27 10:13:10 +00:00
{% if job.template_type == 'letter' %}
Show CSV download link for letter jobs
2018-03-06 10:24:01 +00:00
<div class="keyline-block bottom-gutter-1-2">
{% endif %}
Refactor ‘finished’ to the model layer By moving it from the view we reduce the complexity of the methods in the view layer, so it’s easier to see what they do. This also renames the variable `finished` to the property `processing_finished` to disambiguate from the `job_status` field in the JSON, which can also have a value of `finished`.
2020-01-08 16:23:43 +00:00
{% if job.still_processing %}
Use template_type property directly from API It’s included in the job/upload response now[1]. So we don’t need to fetch the template every time we want to access it. 1. https://github.com/alphagov/notifications-api/pull/2728
2020-02-27 10:13:10 +00:00
<p class="{% if job.template_type != 'letter' %}bottom-gutter{% endif %} hint">
Make a job model for individual jobs This follows the pattern of what we’ve done with services, users and events. It gives us a better interface to the data we get back from the API than dealing with the raw JSON directly. Now is a good time to do this because we’re going to be making a bunch of changes to the jobs pages, and those changes will be easier to code and understand with a sesnsible model behind them.
2020-01-08 12:23:09 +00:00
Report is {{ "{:.0f}%".format(job.percentage_complete * 0.99) }} complete…
Hide report on letter job
2017-07-13 09:57:15 +01:00
</p>
{% elif notifications %}
Use template_type property directly from API It’s included in the job/upload response now[1]. So we don’t need to fetch the template every time we want to access it. 1. https://github.com/alphagov/notifications-api/pull/2728
2020-02-27 10:13:10 +00:00
<p class="{% if job.template_type != 'letter' %}bottom-gutter{% endif %}">
Update all links to use GOVUK Frontend style Includes: - turning off :visited styles to match existing design - swapping heading classes used to make links bold for the GOVUK Frontend bold override class - adding visually hidden text to some links to make them work when isolated from their context We may need to revisit whether some links, such as those for documentation and features, may benefit from having some indication that their target has been visited.
2019-12-06 07:53:46 +00:00
<a href="{{ download_link }}" download class="govuk-link govuk-link--no-visited-state heading-small">Download this report</a>
Hide report on letter job
2017-07-13 09:57:15 +01:00
&emsp;
<span id="time-left">{{ time_left }}</span>
</p>
{% endif %}
Use template_type property directly from API It’s included in the job/upload response now[1]. So we don’t need to fetch the template every time we want to access it. 1. https://github.com/alphagov/notifications-api/pull/2728
2020-02-27 10:13:10 +00:00
{% if job.template_type == 'letter' %}
Show CSV download link for letter jobs
2018-03-06 10:24:01 +00:00
</div>
Link to failure reasons from job/activity pages If something has failed and you don’t know why, you should be able to find out why. Let’s try adding a link to the page explaining why, so it’s not just buried in the footer.
2016-07-11 13:53:55 +01:00
{% endif %}
Show message on job page if job is scheduled If a job is scheduled then we can’t show the notifications yet, and the progress report will stay at 0%. In their place we should show what time a job will start. Later on (when the API is ready) this area of the page should also show a cancel button.
2016-08-25 16:49:31 +01:00
Make sure partials always have a wrapping `<div>` The diffDOM Javascript sometimes throws an error if it can’t calculate a diff between the original content of the page and the updated HTML delivered via AJAX. The problem seems to be when there’s not one, consistent top-level element for it to base its calculations on. This commit: - makes sure that all AJAX-delivered partials have a wrapping `<div>` - that this `<div>` has a consistent class name to make it clear why it’s there
2016-09-01 11:06:52 +01:00
{% call(item, row_number) list_table(
notifications,
caption=uploaded_file_name,
caption_visible=False,
Rename property to more accurately describe purpose `recently_created` says it would just be looking at the `created_at` field to see if it's been created recently. Technically this method isn't doing that, whilst its behaviour would be similar, it's actually different and maybe therefore a bit misleading.
2020-01-21 14:07:23 +00:00
empty_message='No messages to show yet…' if job.awaiting_processing_or_recently_processed else 'These messages have been deleted because they were sent more than {} days ago'.format(service_data_retention_days),
Make sure partials always have a wrapping `<div>` The diffDOM Javascript sometimes throws an error if it can’t calculate a diff between the original content of the page and the updated HTML delivered via AJAX. The problem seems to be when there’s not one, consistent top-level element for it to base its calculations on. This commit: - makes sure that all AJAX-delivered partials have a wrapping `<div>` - that this `<div>` has a consistent class name to make it clear why it’s there
2016-09-01 11:06:52 +01:00
field_headings=[
'Recipient',
'Status'
],
field_headings_visible=False
Show message on job page if job is scheduled If a job is scheduled then we can’t show the notifications yet, and the progress report will stay at 0%. In their place we should show what time a job will start. Later on (when the API is ready) this area of the page should also show a cancel button.
2016-08-25 16:49:31 +01:00
) %}
Make sure partials always have a wrapping `<div>` The diffDOM Javascript sometimes throws an error if it can’t calculate a diff between the original content of the page and the updated HTML delivered via AJAX. The problem seems to be when there’s not one, consistent top-level element for it to base its calculations on. This commit: - makes sure that all AJAX-delivered partials have a wrapping `<div>` - that this `<div>` has a consistent class name to make it clear why it’s there
2016-09-01 11:06:52 +01:00
{% call row_heading() %}
Update all links to use GOVUK Frontend style Includes: - turning off :visited styles to match existing design - swapping heading classes used to make links bold for the GOVUK Frontend bold override class - adding visually hidden text to some links to make them work when isolated from their context We may need to revisit whether some links, such as those for documentation and features, may benefit from having some indication that their target has been visited.
2019-12-06 07:53:46 +00:00
<a class="govuk-link govuk-link--no-visited-state file-list-filename" href="{{ url_for('.view_notification', service_id=current_service.id, notification_id=item.id, from_job=job.id) }}">{{ item.to }}</a>
Revert "Merge pull request #1336 from alphagov/revert-show-notifications" This reverts commit 7e354ff341172041d6141b50833af6262308fcb4, reversing changes made to 6f3bcff32fbfc78b4df0558d08605a260786112f.
2017-06-24 17:12:45 +01:00
<p class="file-list-hint">
{{ item.preview_of_content }}
</p>
Make sure partials always have a wrapping `<div>` The diffDOM Javascript sometimes throws an error if it can’t calculate a diff between the original content of the page and the updated HTML delivered via AJAX. The problem seems to be when there’s not one, consistent top-level element for it to base its calculations on. This commit: - makes sure that all AJAX-delivered partials have a wrapping `<div>` - that this `<div>` has a consistent class name to make it clear why it’s there
2016-09-01 11:06:52 +01:00
{% endcall %}
Added letters info to service / admin dashboard & activity page
2017-10-02 12:34:10 +01:00
{{ notification_status_field(item) }}
Show message on job page if job is scheduled If a job is scheduled then we can’t show the notifications yet, and the progress report will stay at 0%. In their place we should show what time a job will start. Later on (when the API is ready) this area of the page should also show a cancel button.
2016-08-25 16:49:31 +01:00
{% endcall %}
Make a macro for the AJAX update module This is less repetitive than typing out the HTML with all its attributes every time. It also lets us wrap up the idea of ‘finished’ as a parameter, so the AJAX code will only be initiated when it’s needed, eg if a job is still processing.
2016-06-28 09:21:46 +01:00
Make sure partials always have a wrapping `<div>` The diffDOM Javascript sometimes throws an error if it can’t calculate a diff between the original content of the page and the updated HTML delivered via AJAX. The problem seems to be when there’s not one, consistent top-level element for it to base its calculations on. This commit: - makes sure that all AJAX-delivered partials have a wrapping `<div>` - that this `<div>` has a consistent class name to make it clear why it’s there
2016-09-01 11:06:52 +01:00
{% if more_than_one_page %}
<p class="table-show-more-link">
Only showing the first 50 rows
</p>
{% endif %}
{% if notifications %}
</div>
Show message on job page if job is scheduled If a job is scheduled then we can’t show the notifications yet, and the progress report will stay at 0%. In their place we should show what time a job will start. Later on (when the API is ready) this area of the page should also show a cancel button.
2016-08-25 16:49:31 +01:00
{% endif %}
Add a message if there are more than 50 rows Similar to how we do it on the check page, we should indicate if there are more results than we can show. No-one’s really complained about the absence of this, but it can’t hurt.
2016-08-02 10:34:27 +01:00
{% endif %}
Revert "Fix aria on jobs page"
2020-09-10 17:34:05 +01:00
</div>
Reference in New Issue Copy Permalink