Skip to content

Latest commit

 

History

History
226 lines (175 loc) · 9.75 KB

CHANGELOG.md

File metadata and controls

226 lines (175 loc) · 9.75 KB
Raw

Standard Reports UI: change log

1.5.4 - 2024-09

  • (Jon) Updated the application exceptions controller to instrument the ActiveSupport::Notifications for internal errors GH-139
  • (Jon) Updated config/initializers/prometheus.rb to include the Middleware instrumentation fix for the 0 memory bug by notifying Action Dispatch subscribers on Prometheus initialise GH-139
  • (Jon) Updated config/puma.rb to include metrics plugin and port information for the metrics endpoint as environment variable, with default, to enable running multiple sibling HMLR apps locally if needed without port conflicts GH-139
  • (Jon) Updated the lr_common_styles gem to the latest 1.9.9 patch release.
  • (Jon) Moved all mirrored configuration settings from individual environments into the application configuration to reduce the need to manage multiple sources of truth
  • (Jon) Implemented improved boilerplate metrics integration to offer analysis of current application usage stats
  • (Jon) Added process_threads gauge to prometheus metrics alongside isolating thread counts to specific status' as per the Rails thread documentation GH-148
  • (Jon) Updated the approach to resolve GH-142
  • (Jon) Excluded prometheus metrics from the testing environment to reduce noise in the logs
  • (Jon) Added puma-metrics gem to provide base metrics for the Puma web server
  • (Jon) Added the internal_error_event metric to the improved error controls
  • (Jon) Tweaked the application controller to improve error control and display provided message in themed pages to match the rest of the application
  • (Jon) Added puma.stats to footer template in development environment only, again as per the approach in the LR_Common_Styles gem
  • (Jon) Reorganised makefile targets alphabetically as well as mirrored other improvements from the other applications in the suite
  • (Jon) Updated .rubocop.yml primarily reorganising the rules alphabetically as well as adding CountAsOne to both Metrics/ClassLength and Metrics/MethodLength; includes files with removed earlier disabling of said rules!
  • (Jon) Updated .gitignore to include ignoring byebug history as well as sets the tmp directory ignore to be anywhere, not just at the project root

1.5.3 - 2024-09

  • (Dan) Fixes bug XXS vulnerability 133
  • (Dan) Update the error messages for the postcode selectors step 3/7 so each error message is unique to the postcode selector 120
  • (Dan) Updates alt text for screenshots of example reports 115
  • (Dan) Updates report page styles so links are underlined and gives download report page a seperate page title
  • (Dan) Updates gemfile to use v1.9.5 lr_common_styles
  • (Dan) Updates the page titles throughout the app 116
  • (Dan) Updates the button text on reports page to be dynamic and adds aria labels to help screen readers 119
  • (Dan) Update the error message for the postcode selectors step 3/7 120
  • (Dan) Update the error message for the postcode selectors step 3/7 120
  • (Dan) Updates step 3/7 to return user input rather than false when user inputs invalid value 118
  • (Dan) Adds underline text to laning page of standard reports and to help link114
  • (Dan) Styled the help button to match PPD 117
  • (Dan) Adds more descriptive text to action buttons on the report page 115

1.5.2 - 2023-11-27

  • (Jon) Updated the lr_common_styles gem to the latest 1.9.3 patch release.

1.5.1 - 2023-11-23

  • (Jon) Updated the lr_common_styles gem to the latest 1.9.2 patch release.
    • Also includes minor patch updates for gems, please see the Gemfile.lock for details.

1.5.0.1 - 2023-07-11

  • (Jon) Updated the app/controllers/application_controller.rb to include the before_action for the change_default_caching_policy method to ensure the default Cache-Control header for all requests is set to 5 minutes (300 seconds).

1.5.0 - 2023-07-05

  • (Jon) This sets the cache control headers to be public and cacheable with a retry limit of 5 mins as per the other cache settings. GH-114
  • (Jon) Primarily to add the Request ID in the headers to pass to SR Manager but also including the addition of the detailed_request_log to match the other apps and additional debugging messages while in development GH-124
  • (Jon) Keeping with the logging improvements this change rewrites the messages passed to the logging gem to ensure the included details are simple and straight to the point. This should also improve the issues reported in GH-117 , at least from the front-end point of view!
  • (Jon) Updated the README to include the API_SERVICE_URL variable to ensure the local standard_reports_manager instance is used in the test environment.
  • (Jon) Ensures we're using the latest version of json_rails_logger as well as other minor and patch updated gems

1.4.4 - 2023-06-07

  • (Jon) Updated the json_rails_logger gem to the latest 1.0.1 release.
    • Also includes minor patch updates for gems, please see the Gemfile.lock for details.

1.4.3 - 2023-06-03

  • (Jon) Updated the json_rails_logger gem to the latest 1.0.0 release.

1.4.2 - 2023-03-10

  • (Jon) Added a cli recommendation for running the sr-manager locally; resolved a markdown linting issue with using HTML in markdown; as well as fixed a simple typo in the localhost:3001 port example
  • (Jon) Refactors the elapsed time calculated for API requests to be resolved as microseconds rather than milliseconds. This is to improve the reporting of the elapsed time in the system tooling logs.
  • (Jon) Minor text changes to the Gemfile to include instructions for running Epimorphics specific gems locally during the development of those gems.
  • (Jon) Updated the production json_rails_logger gem version to be at least the current version ~>1.3.5 (this is to cover out of sync release versions)
  • (Jon) Updated the production lr_common_styles gem version to be at least the current version ~>1.9.1 (this is to cover out of sync release versions)
  • (Jon) Refactored better guards in entrypoint.sh to ensure the required env vars are set accordingly or deployment will fail noisily.
  • (Jon) Refactored the version cadence creation to include a SUFFIX value if provided; otherwise no SUFFIX is included in the version number.

1.4.1 - 2022-07-11

  • (Jon) Set the default root path environment variable to be /app/standard-reports in the production environment as well as updated variable requests to use fetch to future proof the codebase

1.4.0 - 2022-04-07

  • (Ian) Adopt all of the current Epimorphics best-practice deployment patterns, including shared GitHub actions, updated Makefile and Dockerfile, Prometheus monitoring, and updated version of Sentry.
  • (Ian) Updated the README as part of handover.

1.3.7

  • (Jon) Add Folkestone and Hythe to district names.

1.3.6 - 2021-10-22

  • (Joseph) Add North and West Northamptonshire to county names.
  • (Joseph) Add Bournemouth, Christchurch and Poole to county names.
  • (Joseph) Add Somerset West and Taunton to district names.
  • (Joseph) Add East Suffolk to district names.
  • (Joseph) Add West Suffolk to district names.

1.3.5

  • (Mairead) Added deployment sub repo and assisting deployment files
  • (Mairead) Added Object.assign polyfill

1.3.4 - 2021-06-25

  • (Joseph) Small config change to allow linking to privacy notice.

1.3.3 - 2021-03-08

  • Switch from Travis to Github actions for CI tests
  • dependency updates

1.3.2

  • added the accessibility statement

1.3.1 - 2020-09-22 (Ian)

  • added skip-to-main-content link

1.3.0 - 2020-09-21 (Ian)

Updates to improve WCAG compliance, including:

  • remove .text-muted on some elements to improve colour contrast
  • ensure that hidden elements are not tabbable
  • ensure that form elements have unique IDs
  • add aria-label to ensure that action intents are clear and unique
  • use standard button styles for the form actions

1.2.2 - 2020-07-06

  • Updates to Gem dependencies following some CVE warnings

1.2.1 - 2020-03-19

  • Updates to various gem dependencies following some CVE warnings, but keeping Rails at version 5 for now.

1.2.0 - 2019-12-17

  • Changed minor version number as we've switched to using a separate Sentry project for this app.

1.1.3 - 2019-12-11

  • Add validation to avoid SPARQL-injection attack via postal codes

1.1.2 - 2019-12-09

  • Add ActionController::BadRequest to the list of exceptions that Sentry will ignore

1.1.1 - 2019-10-10

  • General update of gem dependencies
  • Address deprecation warnings in MiniTest expectations
  • Added changelog