govuk_app_config 9.17.13 → 9.17.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80b7af86469ce96f2f6b1418f270cda24089a639dbd243f5955493fa0b65e401
-  data.tar.gz: c6c97ccf511bd531716bbb122c013e2892faee9f1af857f6c2c272624d7b090d
+  metadata.gz: 377fba4f067fe0e3691781cb68c3435fe4eb291e259ec713e4e6d5fa2ebc4949
+  data.tar.gz: 33d889c59d259dc2972061573442c93f3aab86e3dcc84d82a4cc9d82451c8c24
 SHA512:
-  metadata.gz: 3f9ebfb589e7fe72a713a7bcb1077033f8b2fffe07ba76ca7f6465f064a7d653bd09bc680793c6f3a822eacbbdb654cdf23e2f058ce80e471190bb9a7568a624
-  data.tar.gz: 785260aa586b84a664fb5c95ab881cc92e0840dc7861bb0302ff476d57b4e74cfe21c17e5b592723b156953d42ca7c1e57f0634be261bf0e2a383112429f0040
+  metadata.gz: 739b366a7748e82afbf46a7316c3c54cec51434e7ffc4f2314e645a2f67fe349509a0fa231154cfcd7cfa780d549683b795da4cd12d4c82a8831c98a4729e2b4
+  data.tar.gz: 7505b631665cf5a734b6cd0cb115074747eb6f56d5f58a8001c0d9efc3feb9bcca25ee3be2ee703109a3eb4d51b1ae6ce5846888ac1fc2f22a4d036df8025e3b

data/.gitignore

@@ -3,7 +3,6 @@
 /Gemfile.lock
 /_yardoc/
 /coverage/
-/doc/
 /pkg/
 /spec/reports/
 /tmp/

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 9.17.15
+
+* Update dependencies
+
+# 9.17.14
+
+* Added ADR docs
+
 # 9.17.13
 
 * Fix a syntax error in ky translations

data/doc/adr/0001-timezone-usage-across-gov-uk.md

@@ -0,0 +1,60 @@
+# 1. Timezone usage across GOV.UK
+
+Date: 2025-06-27
+
+## Status
+
+Accepted
+
+## Context
+
+Within the landscape of GOV.UK, we have 3 main categories of deployables: Publishing Apps, API Services, Frontend Apps. 
+
+Timestamps are being passed between these apps and services. We need a consistent decision in handling timezones so we do not end up displaying the wrong date during British Summer Time where are we one hour out of sync with UTC.
+
+## Decision
+
+The decision is for all `Publishing Apps` and `Frontend Apps` to default to `London` timezone (which will switch to BST during summer, and UTC during winter); and for all `API Services` to default to UTC. Reasons and some exceptions to the rule are listed below.
+
+This means all apps need to parse Date and Timestamp with timezone parsing. More on this in `Consequences` section.
+
+### Reasonings
+
+- In most cases, we use London as the timezone.
+We make an exception for APIs, where we mostly want to provide UTC dates. A major reason for not migrating APIs to London timezone is because migrating major services like `Publishing API` may have consequences that we have yet to fully analyse.  
+- We also make an exception for travel advice publisher which is a `Publishing App` which operates in UTC. `Travel Advice Publisher` has users in lots of different local timezones. If we can improve the app to display in appropriate timezones we may be able to migrate it to use default London as other publishing apps do.
+
+### Exceptions
+
+All `Publishing Apps` and `Frontend Apps` are in `London` timezone except*: 
+
+| App | Timezone | Reason                                                                                                |
+|---|---|-------------------------------------------------------------------------------------------------------|
+| Travel Advice Publisher | UTC | Publishers are publishing for many different timezones in which London timestamps may cause confusion |
+
+All `API Services` are in `UTC` timezone except*: 
+
+| API             | Timezone | Reason                |
+|-----------------|----------|-----------------------|
+| Email Alert API | London   | Has not been migrated |
+
+
+*A full audit has yet to be conducted to ensure all our applications and APIs adhere to the above.
+
+## Consequences
+
+With the discrepancy that Publishing Apps and Frontends operate in `London` timezones, but APIs operate in `UTC`, we run the risk of displaying wrong information to Publishers and the Public if we are parsing timestamps without their timezones. 
+
+Take the following Example scenario: 
+
+- Publishing App schedules article to publish at midnight BST, e.g. `01-07-2025 00:00 BST` which is equivalent to the day before in UTC `30-06-2025 23:00 UTC`
+- This is sent to Publishing API and subsequently Search API
+- Publishing time set in Publishing API and Search API as `30-06-2025 23:00 UTC`
+- Frontend needs to parse the Date to display as Publication date. 
+  - If the Date is simply parsed as `Date.parse(publication_date)` we get `30-06-2025` which is the **wrong** date. 
+  - We **must** parse in the zone before extracting the date. E.g. `Time.zone.parse(publication_date).to_date` to get the correct date `01-07-2025`
+
+## Actions yet to take
+
+- Do a full audit of which Timezone each Service or App operate in to identify exceptions to the rule
+- Implement a linter guard to ensure we are not trapped in situations such as the one detailed above under `Consequences`. e.g. Error or Warn on all plain `Date.parse` or `Chronic` date parsing without timezone configured.

data/govuk_app_config.gemspec

@@ -39,7 +39,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.10"
   spec.add_development_dependency "rspec-its", "~> 2.0"
-  spec.add_development_dependency "rubocop-govuk", "5.1.15"
+  spec.add_development_dependency "rubocop-govuk", "5.1.16"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "webmock"
 end

data/lib/govuk_app_config/version.rb

@@ -1,3 +1,3 @@
 module GovukAppConfig
-  VERSION = "9.17.13".freeze
+  VERSION = "9.17.15".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_app_config
 version: !ruby/object:Gem::Version
-  version: 9.17.13
+  version: 9.17.15
 platform: ruby
 authors:
 - GOV.UK Dev
@@ -291,14 +291,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.1.15
+        version: 5.1.16
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.1.15
+        version: 5.1.16
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -352,6 +352,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- doc/adr/0001-timezone-usage-across-gov-uk.md
 - docs/healthchecks.md
 - govuk_app_config.gemspec
 - lib/govuk_app_config.rb