govuk_content_item_loader 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a533cf2cd72d38cfd19f7ef5555bb14c93156638ff6220d1dd494d92550a390
-  data.tar.gz: a1e9a897b7b82e747d81434c1d5965d550507edaa3a2a5ae4abde20df63e62ac
+  metadata.gz: 947921788377a6a5dd65917c2f546d8baaabbab0183a9673df551a064b422457
+  data.tar.gz: 9aecaf319b535faa6172cf652cd195e89dadc0dd92858db2c25b9737309b9e48
 SHA512:
-  metadata.gz: 85e6a82e33eb3fab62a93bfda0eeff17314f6ac79b4a6e9f2f09b138cbfa5c9c3812557b0638a5d294d9f28c790ee5f6b2e24293b28bd7042699e17c13b037b3
-  data.tar.gz: 7fd62a7aecc2bd6a214a92c6576a0469b3766d548ba699326f9798f7330d2f7b8fa5a219fca55fdac83e064aff2bd5a0e3ffe664ac1518ac6c8b36fe22af35f1
+  metadata.gz: 6f5f426102604ffce580a33b0fead1eb99d623f4500cd308669bf95b4ab49d9239e7d4dab37917ce32a513ec28cc3a8682c09833aca0136bff5cee5b7a443c0a
+  data.tar.gz: ee6e8a19ff172558e8aaa0a86c80c189f41213f09cc1715e00e18b2e0be62d32d7e40a815ec745880c197f97135c7d622b57725050a5ad2120989fe334bb9ebf

data/.github/workflows/autorelease.yml

@@ -6,7 +6,5 @@ on:
 jobs:
   autorelease:
     uses: alphagov/govuk-infrastructure/.github/workflows/autorelease-rubygem.yml@main
-    with:
-      gem_name: content_block_tools
     secrets:
       GH_TOKEN: ${{ secrets.GOVUK_CI_GITHUB_API_TOKEN }}

data/.github/workflows/ci.yml

@@ -38,7 +38,7 @@ jobs:
     - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
       with:
         ref: ${{ inputs.ref || github.ref }}
-    - uses: ruby/setup-ruby@09a7688d3b55cf0e976497ff046b70949eeaccfd # v1.288.0
+    - uses: ruby/setup-ruby@6ca151fd1bfcfd6fe0c4eb6837eb0584d0134a0c # v1.290.0
       with:
         ruby-version: ${{ matrix.ruby }}
         bundler-cache: true

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.1.0
+
+- Add Content Store fallback for failed Graphql requests
+
 ## 1.0.0
 
 - Add GraphQL traffic rates initializer.

data/docs/adr/01-new-gem-for-conditional-content-loading.md

@@ -0,0 +1,73 @@
+# ADR 1: Create a dedicated gem for conditional GraphQL content loading
+Status: Accepted
+Date: 2026-02-17
+
+## Context
+As part of the migration to GraphQL-backed content retrieval [RFC-172](https://github.com/alphagov/govuk-rfcs/blob/main/rfc-172-graphql-for-govuk.md), we are introducing a temporary (medium-term) ConditionalContentItemLoader that determines whether a request should load content from:
+* The Content Store (REST), or
+* The Publishing API via GraphQL
+
+This decision is made at request time and depends on:
+* Request parameters
+* Environment state (e.g. draft host)
+* Allow-list configuration
+* Probabilistic traffic splitting
+
+It includes Prometheus metrics labelling for monitoring and alerting.
+
+The loader is required across seven frontend applications.
+
+## Problem
+We need a centralised implementation to:
+* Avoid duplication and divergence across multiple apps
+* Maintain clear architectural boundaries
+* Keep configuration and routing logic co-located
+
+## Decision
+We will create a Ruby gem to encapsulate the conditional content loader and its configuration, with minimal dependencies.
+
+## Rationale
+1. Shared across multiple applications
+One gem ensures consistent behaviour and easier rollout coordination.
+
+1. Maintenance burden is acceptable
+The gem is small, with few dependencies.
+
+1. Not a good fit for `gds-api-adapters`
+`gds-api-adapters` is designed around a clear architectural pattern:
+* Each adapter corresponds to a single external API
+* Adapter methods map directly to HTTP endpoints
+* Namespaces reflect a 1:1 relationship with APIs
+
+The conditional loader does not fit this model as it's a higher-level orchestration layer, not a client abstraction. Adding it to gds-api-adapters would:
+* Blur architectural boundaries
+* Violate separation of concerns
+* Break the established software design pattern of the gem
+
+1. Not a good fit for `govuk_app_config`
+That library is intended for generic application configuration, not behaviour orchestration used by a subset of apps.
+
+1. Explicitly not using `govuk_ab_testing`
+`govuk_ab_testing` was considered. This is not a generic A/B test or experiment framework use case. Embedding this logic in govuk_ab_testing would conflate experimentation infrastructure with migration routing logic.
+
+1. Co-location with configuration
+The loader depends on configuration established via GovukGraphqlTrafficRates.configure which would fit in govuk_app_config. However, keeping it in the same gem reduces complexity and risk of misconfiguration. 
+
+## Alternatives considered
+- Duplicate in each app – rejected due to divergence risk.
+- Add to `gds-api-adapters` – rejected; violates separation of concerns.
+- Add to `govuk_app_config` – rejected; not just application configuration.
+- Add to `govuk_ab_testing` – rejected; not experimentation logic.
+
+## Consequences
+
+### Positive
+* Consistent behaviour across multiple applications
+* Clean architectural separation
+* Centralised rollout
+* Clear ownership of GraphQL migration logic
+* Versioned upgrades
+
+### Negative
+* One additional gem to maintain
+* Increase in dependency management overhead

data/lib/govuk_content_item_loader/govuk_conditional_content_item_loader.rb

@@ -9,7 +9,9 @@ class GovukConditionalContentItemLoader
   end
 
   def load
-    can_load_from_graphql? ? content_item_from_graphql : content_item_from_content_store
+    return content_item_from_content_store unless can_load_from_graphql?
+
+    content_item_from_graphql || content_item_from_content_store
   end
 
   def can_load_from_graphql?
@@ -32,10 +34,10 @@ private
     publishing_api_client.graphql_live_content_item(base_path)
   rescue GdsApi::HTTPErrorResponse => e
     set_prometheus_labels(graphql_status_code: e.code)
-    raise e
-  rescue GdsApi::TimedOutException => e
+    false
+  rescue GdsApi::TimedOutException
     set_prometheus_labels(graphql_api_timeout: true)
-    raise e
+    false
   end
 
   def content_item_from_content_store

data/lib/govuk_content_item_loader/version.rb

@@ -1,3 +1,3 @@
 module GovukContentItemLoader
-  VERSION = "1.0.0".freeze
+  VERSION = "1.1.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_content_item_loader
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - GOV.UK Dev
@@ -157,6 +157,7 @@ files:
 - LICENCE
 - README.md
 - Rakefile
+- docs/adr/01-new-gem-for-conditional-content-loading.md
 - govuk_content_item_loader.gemspec
 - lib/govuk_content_item_loader.rb
 - lib/govuk_content_item_loader/govuk_conditional_content_item_loader.rb
@@ -180,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.7
 specification_version: 4
 summary: Provides a standardised content item loader for GOV.UK frontend apps with
   configurable GraphQL traffic routing and automatic fallback to the Content Store