Merge pull request #626 from citizensadvice/CP-864-integrate-cookies-engine

Chore: Integrate cookie preferences engine [CP-864]

Author: KPobeeNorris

.github/resources/preview-overrides.yaml

@@ -22,3 +22,4 @@ envVars:
   RAILS_ENV: production
   USE_TEST_SUPPLIERS: ${{ vars.USE_TEST_SUPPLIERS }}
   FF_SMALL_SUPPLIER_STARS: ${{ vars.FF_SMALL_SUPPLIER_STARS }}
+  FF_NEW_COOKIE_MANAGEMENT: ${{ vars.FF_NEW_COOKIE_MANAGEMENT }}

Gemfile

@@ -41,6 +41,9 @@ gem "citizens_advice_components",
     tag: "v8.1.0",
     glob: "engine/*.gemspec"
 
+gem "citizens_advice_cookie_preferences",
+    github: "citizensadvice/cookie-preferences"
+
 # The citizens_advice_components gem uses view component but we also use this to write
 # our app components so explicitly name it as an application dependency.
 gem "view_component", "~> 4.0"

Gemfile.lock

@@ -19,6 +19,16 @@ GIT
       rubocop-rspec (~> 3.5)
       rubocop-rspec_rails (~> 2.31)
 
+GIT
+  remote: https://github.com/citizensadvice/cookie-preferences.git
+  revision: 287a515c578be03c6951fe3545e0ad2858224b2d
+  specs:
+    citizens_advice_cookie_preferences (0.1.0)
+      citizens_advice_components (> 8.0.0)
+      meta-tags
+      rails (>= 7.1.0)
+      view_component (>= 2.0.0, < 5.0)
+
 GIT
   remote: https://github.com/citizensadvice/design-system.git
   revision: c3cb623bf7eeac13c5573d7594032bc10f611021
@@ -136,7 +146,7 @@ GEM
     climate_control (1.2.0)
     coderay (1.1.3)
     concurrent-ruby (1.3.5)
-    connection_pool (2.5.3)
+    connection_pool (2.5.4)
     crack (1.0.0)
       bigdecimal
       rexml
@@ -293,7 +303,7 @@ GEM
       uri
     net-http-persistent (4.0.6)
       connection_pool (~> 2.2, >= 2.2.4)
-    net-imap (0.5.9)
+    net-imap (0.5.10)
       date
       net-protocol
     net-pop (0.1.2)
@@ -534,6 +544,7 @@ DEPENDENCIES
   capybara_accessible_selectors!
   citizens-advice-style!
   citizens_advice_components!
+  citizens_advice_cookie_preferences!
   climate_control
   cssbundling-rails
   cucumber-rails

app/assets/stylesheets/appliance-calculator.scss

@@ -6,3 +6,5 @@
 @import "appliance-calculator/components/usages_table";
 @import "appliance-calculator/components/most-expensive-appliance";
 @import "appliance-calculator/components/last_added_appliance";
+@import 'citizens_advice_cookie_preferences/components/cookie-banner';
+@import 'citizens_advice_cookie_preferences/components/cookie-preferences';

app/assets/stylesheets/energy-csr-table.scss

@@ -2,3 +2,5 @@
 @import "./reset";
 @import "./fonts";
 @import "./components";
+@import 'citizens_advice_cookie_preferences/components/cookie-banner';
+@import 'citizens_advice_cookie_preferences/components/cookie-preferences';

app/controllers/application_controller.rb

@@ -3,6 +3,7 @@
 class ApplicationController < ActionController::Base
   include SwiftypeMeta
   include DataLayer
+  include CitizensAdviceCookiePreferences::Helpers
 
   def internal_server_error
     render template: "errors/500", status: :internal_server_error

app/controllers/concerns/data_layer.rb

@@ -19,12 +19,18 @@ def custom_data_layer_properties
   end
 
   def default_data_layer_properties
-    {
+    properties = {
       platform: "content-platform",
       siteType: "Public Website",
       # language confusingly represents the current country: England, Wales etc.
       # but needs to have this name to match up with Episerver page data.
       language: (helpers.current_country || "england").to_s.capitalize
     }
+
+    if Feature.enabled?("FF_NEW_COOKIE_MANAGEMENT") && allow_analytics_cookies?
+      properties.merge({ analyticsCookiesAccepted: "True" })
+    else
+      properties
+    end
   end
 end

app/lib/feature.rb

@@ -5,7 +5,11 @@
 # Tiny class for checking if a feature is enabled
 class Feature
   def self.enabled?(flag_name)
-    # Use ActiveModel's boolean type which recognises the strings 'false'/'0'/'' as false values
+    # Setting "false" in the cdk returns "False", which isn't classed a falsey value by ActiveModel::Type::Boolean,
+    # so we need to explicitly return false in these cases
+    return false if ENV.fetch(flag_name, nil) == "False"
+
+    # Use ActiveModel's boolean type which recognises the strings 'false'/'0' etc as false values
     ActiveModel::Type::Boolean.new.cast(ENV.fetch(flag_name, nil))
   end
 end

app/views/layouts/application.html.haml

@@ -23,6 +23,8 @@
   %body{ class: ("cas" if scotland?) }
     = render "shared/google_tag_manager_no_script"
     = render "shared/half_star_svg"
+    - if Feature.enabled?("FF_NEW_COOKIE_MANAGEMENT") && !cookies_preference_page?
+      = render CitizensAdviceCookiePreferences::CookieBanner.new
 
     .wrapper
       = render HeaderComponent.new
@@ -48,3 +50,6 @@
                                    columns: public_website_footer_nav_links)
 
     = javascript_include_tag digested_js_file_name("application.js"), defer: true
+
+    - if Feature.enabled?("FF_NEW_COOKIE_MANAGEMENT")
+      = javascript_include_tag "citizens_advice_cookie_preferences/application", nonce: true

app/views/shared/_google_tag_manager_no_script.html.haml

@@ -1,4 +1,5 @@
 -# haml-lint:disable InlineStyles
-%noscript
-  %iframe{ src: "https://www.googletagmanager.com/ns.html?id=GTM-T5MB575",
-           height: "0", width: "0", style: "display:none;visibility:hidden" }
+- if !Feature.enabled?("FF_NEW_COOKIE_MANAGEMENT") || allow_analytics_cookies?
+  %noscript
+    %iframe{ src: "https://www.googletagmanager.com/ns.html?id=GTM-T5MB575",
+             height: "0", width: "0", style: "display:none;visibility:hidden" }