Merge pull request #1969 from alphagov/show-custom-error-page-when-welsh-form-is-archived

Show custom error page when welsh form is archived

Author: DavidBiddle

app/controllers/forms/base_controller.rb

@@ -44,15 +44,28 @@ def set_available_languages
     end
 
     def set_form
-      begin
-        form_id = params.require(:form_id)
-        @form = Api::V2::FormDocumentRepository.find_with_mode(form_id:, mode:, language: locale)
-      rescue ActiveResource::ResourceNotFound
-        archived_form = Api::V2::FormDocumentRepository.find(form_id:, tag: :archived)
-        return render template: "forms/archived/show", locals: { form_name: archived_form.name }, status: :not_found if archived_form.present?
+      form_id = params.require(:form_id)
+      @form = Api::V2::FormDocumentRepository.find_with_mode(form_id:, mode:, language: locale)
+
+      if @form.blank?
+        I18n.with_locale(locale) do
+          if locale == "cy"
+            archived_welsh_version = Api::V2::FormDocumentRepository.find(form_id:, tag: :archived, language: :cy)
+            live_english_version = Api::V2::FormDocumentRepository.find(form_id:, tag: :live, language: :en)
+
+            if archived_welsh_version.present? && live_english_version.present?
+              return render template: "forms/archived_welsh/show",
+                            locals: { form: live_english_version },
+                            status: :not_found
+            end
+          end
+
+          archived_form = Api::V2::FormDocumentRepository.find(form_id:, tag: :archived)
+          return render template: "forms/archived/show", locals: { form_name: archived_form.name }, status: :not_found if archived_form.present?
+        end
       end
 
-      raise ActiveResource::ResourceNotFound, "Not Found" unless @form.start_page
+      raise ActiveResource::ResourceNotFound, "Not Found" unless @form.present? && @form.start_page
     end
   end
 end

app/services/api/v2/form_document_repository.rb

@@ -1,13 +1,18 @@
 class Api::V2::FormDocumentRepository
   class << self
     def find(form_id:, tag:, language: :en)
-      raise ActiveResource::ResourceNotFound.new(404, "Not Found") unless form_id.to_s =~ /^[[:alnum:]]+$/
+      return nil unless form_id.to_s =~ /^[[:alnum:]]+$/
 
-      form_document = Api::V2::FormDocumentResource.get(form_id, tag, **options_for_language(language))
-      form = Form.new(form_document, true)
-      form.document_json = form_document
-      form.prefix_options = { form_id:, tag: }
-      form
+      begin
+        form_document = Api::V2::FormDocumentResource.get(form_id, tag, **options_for_language(language))
+
+        form = Form.new(form_document, true)
+        form.document_json = form_document
+        form.prefix_options = { form_id:, tag: }
+        form
+      rescue ActiveResource::ResourceNotFound
+        nil
+      end
     end
 
     def find_with_mode(form_id:, mode:, language: :en)

app/services/form_submission_service.rb

@@ -52,6 +52,8 @@ def ensure_form_english
 
   def fetch_english_language_form
     @form = Api::V2::FormDocumentRepository.find_with_mode(form_id: form.id, mode:)
+
+    raise ActiveResource::ResourceNotFound.new(404, "Not Found") if @form.nil?
   end
 
   def validate_submission

app/views/forms/archived_welsh/show.html.erb

@@ -0,0 +1,13 @@
+<% set_page_title(form_title(form_name: form.name, page_name: t(".heading"), mode: @mode)) %>
+
+<div class="govuk-grid-row">
+  <div class="govuk-grid-column-two-thirds">
+    <h1 class="govuk-heading-l"><%= t(".heading") %></h1>
+
+    <p><%= t(".welsh_version_archived") %></p>
+
+    <p><%= t(".view_english_form") %></p>
+
+    <p><%= govuk_link_to(form.name, form_path(form_id: form.id, form_slug: form.form_slug, locale: nil), lang: "en", hreflang: "en", rel: "alternate") %></p>
+  </div>
+</div>

config/locales/cy.yml

@@ -342,9 +342,9 @@ cy:
     privacy_policy: Preifatrwydd
   form:
     archived:
-      heading: Sorry, this service is no longer available
-      service_unavailable: "“%{form_name}” has been archived and is no longer available."
-      title: Form archived
+      heading: Mae’n ddrwg gennym, nid yw’r gwasanaeth hwn ar gael mwyach
+      service_unavailable: Mae “%{form_name}” wedi’i archifo ac nid yw bellach ar gael.
+      title: Mae’n ddrwg gennym, nid yw’r gwasanaeth hwn ar gael mwyach
     check_your_answers:
       agree_and_submit: Cytuno a chyflwyno
       declaration: Datganiad
@@ -372,6 +372,11 @@ cy:
         max_answers: Ni allwch ychwanegu ateb arall i’r cwestiwn hwn gan eich bod wedi rhoi’r uchafswm o %{max_answers}
         radios_legend: Ydych chi angen ychwanegu ateb arall?
         title: Ychwanegu neu ddileu ateb i %{page_title}
+    archived_welsh:
+      show:
+        heading: Mae’n ddrwg gennym, nid yw’r gwasanaeth hwn ar gael yn Gymraeg mwyach
+        view_english_form: 'Gallwch lenwi’r ffurflen yn Saesneg o hyd:'
+        welsh_version_archived: Mae’r fersiwn Gymraeg o’r ffurflen hon wedi’i harchifo ac nid yw ar gael mwyach.
     back: Yn ôl
     remove_answer:
       show:

config/locales/en.yml

@@ -344,7 +344,7 @@ en:
     archived:
       heading: Sorry, this service is no longer available
       service_unavailable: "“%{form_name}” has been archived and is no longer available."
-      title: Form archived
+      title: Sorry, this service is no longer available
     check_your_answers:
       agree_and_submit: Agree and submit
       declaration: Declaration
@@ -372,6 +372,11 @@ en:
         max_answers: You cannot add another answer to this question as you’ve entered the maximum of %{max_answers}
         radios_legend: Do you need to add another answer?
         title: Add or remove answer to %{page_title}
+    archived_welsh:
+      show:
+        heading: Sorry, this service is no longer available in Welsh
+        view_english_form: 'You can still complete the form in English:'
+        welsh_version_archived: The Welsh version of this form has been archived and is no longer available.
     back: Back
     remove_answer:
       show:

spec/requests/forms/base_controller_spec.rb

@@ -51,6 +51,8 @@
       mock.get "/api/v2/forms/2#{api_url_suffix}?language=cy", req_headers, form_response_data.to_json, 200
       mock.get "/api/v2/forms/9999#{api_url_suffix}", req_headers, no_data_found_response, 404
       mock.get "/api/v2/forms/9999#{api_url_suffix}?language=cy", req_headers, no_data_found_response, 404
+      mock.get "/api/v2/forms/9999/archived", req_headers, no_data_found_response, 404
+      mock.get "/api/v2/forms/9999/archived?language=cy", req_headers, no_data_found_response, 404
     end
   end
 
@@ -343,6 +345,22 @@
           expect(response.body).to include(I18n.t("form.archived.title"))
         end
       end
+
+      context "when the form is an archived Welsh form with a live English version" do
+        before do
+          ActiveResource::HttpMock.respond_to do |mock|
+            mock.get "/api/v2/forms/2/live", req_headers, form_response_data.to_json, 200
+            mock.get "/api/v2/forms/2/live?language=cy", req_headers, nil, 404
+            mock.get "/api/v2/forms/2/archived?language=cy", req_headers, form_response_data.to_json, 200
+          end
+
+          get form_path(mode: "form", form_id: 2, form_slug: form_response_data.form_slug, locale: :cy)
+        end
+
+        it "Renders the form archived page" do
+          expect(Capybara.string(response.body)).to have_text(I18n.t("forms.archived_welsh.show.heading", locale: :cy))
+        end
+      end
     end
   end
 

spec/services/api/v2/form_document_repository_spec.rb

@@ -49,29 +49,25 @@
         let(:response_data) { nil }
         let(:status) { 404 }
 
-        it "raises ActiveResource::ResourceNotFound" do
-          expect { described_class.find(tag: :archived, form_id: form_id) }.to raise_error(ActiveResource::ResourceNotFound)
+        it "returns nil" do
+          expect(described_class.find(tag: :archived, form_id: form_id)).to be_nil
         end
       end
     end
 
     context "when the form id contains non-alpha-numeric chars" do
       let(:form_id) { "<id>" }
 
-      it "returns ResourceNotFound when the id contains non-alpha-numeric chars" do
-        expect {
-          described_class.find(tag:, form_id:)
-        }.to raise_error(ActiveResource::ResourceNotFound)
+      it "returns nil when the id contains non-alpha-numeric chars" do
+        expect(described_class.find(tag:, form_id:)).to be_nil
       end
     end
 
     context "when the form id is blank" do
       let(:form_id) { "" }
 
-      it "returns ResourceNotFound when the id is blank" do
-        expect {
-          described_class.find(tag:, form_id:)
-        }.to raise_error(ActiveResource::ResourceNotFound)
+      it "returns nil when the id is blank" do
+        expect(described_class.find(tag:, form_id:)).to be_nil
       end
     end
 
@@ -80,10 +76,8 @@
       let(:response_data) { nil }
       let(:status) { 404 }
 
-      it "raises an exception" do
-        expect {
-          described_class.find(tag:, form_id:)
-        }.to raise_error(ActiveResource::ResourceNotFound)
+      it "returns nil" do
+        expect(described_class.find(tag:, form_id:)).to be_nil
       end
     end
 
@@ -132,10 +126,8 @@
       expect(form_snapshot.pages).to all be_a Page
     end
 
-    it "raises an exception if the form does not exist" do
-      expect {
-        described_class.find_with_mode(form_id: "99", mode: Mode.new("preview-draft"))
-      }.to raise_error(ActiveResource::ResourceNotFound)
+    it "returns nil if the form does not exist" do
+      expect(described_class.find_with_mode(form_id: "99", mode: Mode.new("preview-draft"))).to be_nil
     end
 
     context "when mode is live" do
@@ -171,16 +163,12 @@
     end
 
     context "when validating the provided form id" do
-      it "returns ResourceNotFound when the id contains non-alpha-numeric chars" do
-        expect {
-          described_class.find_with_mode(form_id: "<id>", mode: Mode.new("preview-draft"))
-        }.to raise_error(ActiveResource::ResourceNotFound)
+      it "returns nil when the id contains non-alpha-numeric chars" do
+        expect(described_class.find_with_mode(form_id: "<id>", mode: Mode.new("preview-draft"))).to be_nil
       end
 
-      it "returns ResourceNotFound when the id is blank" do
-        expect {
-          described_class.find_with_mode(form_id: "", mode: Mode.new("preview-draft"))
-        }.to raise_error(ActiveResource::ResourceNotFound)
+      it "returns nil when the id is blank" do
+        expect(described_class.find_with_mode(form_id: "", mode: Mode.new("preview-draft"))).to be_nil
       end
 
       it "returns the form when the id is alphanumeric" do

spec/views/forms/archived/show.html.erb_spec.rb

@@ -12,7 +12,7 @@
   end
 
   it "has the correct title" do
-    expect(view.content_for(:title)).to eq "Form archived - Archived form"
+    expect(view.content_for(:title)).to eq "Sorry, this service is no longer available - Archived form"
   end
 
   it "has the correct heading" do

spec/views/forms/archived_welsh/show.html.erb_spec.rb

@@ -0,0 +1,30 @@
+require "rails_helper"
+
+describe "forms/archived_welsh/show.html.erb" do
+  let(:form) { build :form, name: "Archived Welsh form" }
+  let(:mode) { OpenStruct.new(preview_draft?: false, preview_archived?: false, preview_live?: false) }
+
+  before do
+    assign(:mode, mode)
+    allow(view).to receive(:form_path).and_return("/form/1/english_form")
+
+    render template: "forms/archived_welsh/show", locals: { form: }, status: :not_found
+  end
+
+  it "has the correct title" do
+    expect(view.content_for(:title)).to eq "#{t('forms.archived_welsh.show.heading')} - #{form.name}"
+  end
+
+  it "has the correct heading" do
+    expect(rendered).to have_css("h1", text: t("forms.archived_welsh.show.heading"))
+  end
+
+  it "displays the body text" do
+    expect(rendered).to have_text(I18n.t("forms.archived_welsh.show.welsh_version_archived"))
+  end
+
+  it "displays a link to the English form" do
+    expect(rendered).to have_text(I18n.t("forms.archived_welsh.show.view_english_form"))
+    expect(rendered).to have_link("Archived Welsh form", href: "/form/1/english_form")
+  end
+end