Use references in URLs

This changing the routing and URLs to use the application form reference rather than the ID. This change allows the assessors to navigate directly to an application if it's no longer visible in the case management list, since the IDs are an internal identifier and not presented anywhere.
DFE-Digital · Nov 8, 2023 · 8b6946b · 8b6946b
1 parent c5b6905
commit 8b6946b
Show file tree

Hide file tree

Showing 95 changed files with 312 additions and 313 deletions.
diff --git a/app/controllers/assessor_interface/assessment_recommendation_award_controller.rb b/app/controllers/assessor_interface/assessment_recommendation_award_controller.rb
@@ -121,7 +121,11 @@ def assessment
       @assessment ||=
         Assessment
           .includes(:application_form)
-          .where(application_form_id: params[:application_form_id])
+          .where(
+            application_form: {
+              reference: params[:application_form_reference],
+            },
+          )
           .find(params[:assessment_id])
     end
 

diff --git a/app/controllers/assessor_interface/assessment_recommendation_decline_controller.rb b/app/controllers/assessor_interface/assessment_recommendation_decline_controller.rb
@@ -94,7 +94,11 @@ def assessment
       @assessment ||=
         Assessment
           .includes(:application_form)
-          .where(application_form_id: params[:application_form_id])
+          .where(
+            application_form: {
+              reference: params[:application_form_reference],
+            },
+          )
           .find(params[:assessment_id])
     end
 

diff --git a/app/controllers/assessor_interface/assessment_recommendation_review_controller.rb b/app/controllers/assessor_interface/assessment_recommendation_review_controller.rb
@@ -34,7 +34,11 @@ def assessment
       @assessment ||=
         Assessment
           .includes(:application_form)
-          .where(application_form_id: params[:application_form_id])
+          .where(
+            application_form: {
+              reference: params[:application_form_reference],
+            },
+          )
           .find(params[:assessment_id])
     end
 

diff --git a/app/controllers/assessor_interface/assessment_recommendation_verify_controller.rb b/app/controllers/assessor_interface/assessment_recommendation_verify_controller.rb
@@ -220,7 +220,11 @@ def assessment
       @assessment ||=
         Assessment
           .includes(:application_form)
-          .where(application_form_id: params[:application_form_id])
+          .where(
+            application_form: {
+              reference: params[:application_form_reference],
+            },
+          )
           .find(params[:assessment_id])
     end
 

diff --git a/app/controllers/assessor_interface/assessments_controller.rb b/app/controllers/assessor_interface/assessments_controller.rb
@@ -54,7 +54,11 @@ def assessment
       @assessment ||=
         Assessment
           .includes(:application_form)
-          .where(application_form_id: params[:application_form_id])
+          .where(
+            application_form: {
+              reference: params[:application_form_reference],
+            },
+          )
           .find(params[:id])
     end
 

diff --git a/app/controllers/assessor_interface/assessor_assignments_controller.rb b/app/controllers/assessor_interface/assessor_assignments_controller.rb
@@ -30,7 +30,8 @@ def create
     private
 
     def application_form
-      @application_form ||= ApplicationForm.find(params[:application_form_id])
+      @application_form ||=
+        ApplicationForm.find_by!(reference: params[:application_form_reference])
     end
 
     def assessor_params

diff --git a/app/controllers/assessor_interface/further_information_requests_controller.rb b/app/controllers/assessor_interface/further_information_requests_controller.rb
@@ -105,7 +105,7 @@ def application_form
       @application_form ||=
         ApplicationForm.includes(
           assessment: :further_information_requests,
-        ).find(params[:application_form_id])
+        ).find_by(reference: params[:application_form_reference])
     end
 
     def view_object

diff --git a/app/controllers/assessor_interface/notes_controller.rb b/app/controllers/assessor_interface/notes_controller.rb
@@ -27,7 +27,8 @@ def create
     private
 
     def application_form
-      @application_form ||= ApplicationForm.find(params[:application_form_id])
+      @application_form ||=
+        ApplicationForm.find_by!(reference: params[:application_form_reference])
     end
 
     def author

diff --git a/app/controllers/assessor_interface/professional_standing_requests_controller.rb b/app/controllers/assessor_interface/professional_standing_requests_controller.rb
@@ -198,8 +198,8 @@ def professional_standing_request
           assessment: :application_form,
         ).find_by(
           assessment_id: params[:assessment_id],
-          assessment: {
-            application_form_id: params[:application_form_id],
+          application_form: {
+            reference: params[:application_form_reference],
           },
         )
     end

diff --git a/app/controllers/assessor_interface/qualification_requests_controller.rb b/app/controllers/assessor_interface/qualification_requests_controller.rb
@@ -86,8 +86,8 @@ def qualification_requests
           .includes(:qualification)
           .where(
             assessment_id: params[:assessment_id],
-            assessment: {
-              application_form_id: params[:application_form_id],
+            application_form: {
+              reference: params[:application_form_reference],
             },
           )
           .order("qualifications.start_date": :desc)

diff --git a/app/controllers/assessor_interface/reference_requests_controller.rb b/app/controllers/assessor_interface/reference_requests_controller.rb
@@ -90,8 +90,8 @@ def reference_requests
           .includes(:work_history)
           .where(
             assessment_id: params[:assessment_id],
-            assessment: {
-              application_form_id: params[:application_form_id],
+            application_form: {
+              reference: params[:application_form_reference],
             },
           )
           .order("work_histories.start_date": :desc)

diff --git a/app/controllers/assessor_interface/review_verifications_controller.rb b/app/controllers/assessor_interface/review_verifications_controller.rb
@@ -20,7 +20,11 @@ def assessment
       @assessment ||=
         Assessment
           .includes(:application_form)
-          .where(application_form_id: params[:application_form_id])
+          .where(
+            application_form: {
+              reference: params[:application_form_reference],
+            },
+          )
           .find(params[:assessment_id])
     end
   end

diff --git a/app/controllers/assessor_interface/reviewer_assignments_controller.rb b/app/controllers/assessor_interface/reviewer_assignments_controller.rb
@@ -30,7 +30,8 @@ def create
     private
 
     def application_form
-      @application_form ||= ApplicationForm.find(params[:application_form_id])
+      @application_form ||=
+        ApplicationForm.find_by!(reference: params[:application_form_reference])
     end
 
     def reviewer_params

diff --git a/app/controllers/assessor_interface/timeline_events_controller.rb b/app/controllers/assessor_interface/timeline_events_controller.rb
@@ -5,7 +5,8 @@ class TimelineEventsController < BaseController
     before_action :authorize_assessor
 
     def index
-      @application_form = ApplicationForm.find(params[:application_form_id])
+      @application_form =
+        ApplicationForm.find_by!(reference: params[:application_form_reference])
 
       @timeline_events =
         TimelineEvent

diff --git a/app/controllers/assessor_interface/work_histories_controller.rb b/app/controllers/assessor_interface/work_histories_controller.rb
@@ -36,7 +36,11 @@ def work_history
       @work_history ||=
         WorkHistory
           .includes(:application_form)
-          .where(application_form_id: params[:application_form_id])
+          .where(
+            application_form: {
+              reference: params[:application_form_reference],
+            },
+          )
           .find(params[:id])
     end
 

diff --git a/app/jobs/update_working_days_job.rb b/app/jobs/update_working_days_job.rb
@@ -68,7 +68,7 @@ def update_assessments_submission_to_recommendation
     Assessment
       .joins(:application_form)
       .includes(:application_form)
-      .where.not(application_forms: { submitted_at: nil })
+      .where.not(application_form: { submitted_at: nil })
       .where.not(recommended_at: nil)
       .find_each do |assessment|
         assessment.update!(
@@ -85,7 +85,7 @@ def update_assessments_submission_to_started
     Assessment
       .joins(:application_form)
       .includes(:application_form)
-      .where.not(application_forms: { submitted_at: nil })
+      .where.not(application_form: { submitted_at: nil })
       .where.not(started_at: nil)
       .find_each do |assessment|
         assessment.update!(

diff --git a/app/models/application_form.rb b/app/models/application_form.rb
@@ -221,6 +221,10 @@ class ApplicationForm < ApplicationRecord
 
   scope :remindable, -> { draft.where("created_at < ?", 5.months.ago) }
 
+  def to_param
+    reference
+  end
+
   def teaching_qualification
     qualifications.find(&:is_teaching_qualification?)
   end

diff --git a/app/view_objects/assessor_interface/application_forms_show_view_object.rb b/app/view_objects/assessor_interface/application_forms_show_view_object.rb
@@ -11,7 +11,7 @@ def application_form
       ApplicationForm
         .includes(assessment: :sections)
         .not_draft
-        .find(params[:id])
+        .find_by!(reference: params[:reference])
   end
 
   def duplicate_matches

diff --git a/app/view_objects/assessor_interface/assessment_section_view_object.rb b/app/view_objects/assessor_interface/assessment_section_view_object.rb
@@ -17,8 +17,8 @@ def assessment_section
         ).find_by!(
           id: params[:id],
           assessment_id: params[:assessment_id],
-          assessment: {
-            application_form_id: params[:application_form_id],
+          application_form: {
+            reference: params[:application_form_reference],
           },
         )
     end

diff --git a/app/view_objects/assessor_interface/further_information_request_view_object.rb b/app/view_objects/assessor_interface/further_information_request_view_object.rb
@@ -12,8 +12,8 @@ def further_information_request
         .received
         .where(
           assessment_id: params[:assessment_id],
-          assessment: {
-            application_form_id: params[:application_form_id],
+          application_form: {
+            reference: params[:application_form_reference],
           },
         )
         .find(params[:id])

diff --git a/config/routes.rb b/config/routes.rb
@@ -14,7 +14,10 @@
   namespace :assessor_interface, path: "/assessor" do
     root to: redirect("/assessor/applications")
 
-    resources :application_forms, path: "/applications", except: :new do
+    resources :application_forms,
+              path: "/applications",
+              except: :new,
+              param: :reference do
       collection do
         post "filters/apply", to: "application_forms#apply_filters"
         get "filters/clear", to: "application_forms#clear_filters"

diff --git a/spec/components/application_form_search_result_component_spec.rb b/spec/components/application_form_search_result_component_spec.rb
@@ -27,7 +27,9 @@
   describe "heading link" do
     subject(:href) { component.at_css("h2 > a")["href"] }
 
-    it { is_expected.to eq("/assessor/applications/#{application_form.id}") }
+    it do
+      is_expected.to eq("/assessor/applications/#{application_form.reference}")
+    end
   end
 
   describe "description list" do

diff --git a/spec/models/application_form_spec.rb b/spec/models/application_form_spec.rb
@@ -446,6 +446,11 @@
     expect(application_form.written_statement_document).to_not be_nil
   end
 
+  describe "#to_param" do
+    subject(:to_param) { application_form.to_param }
+    it { is_expected.to eq(application_form.reference) }
+  end
+
   describe "#created_under_new_regulations?" do
     subject(:created_under_new_regulations?) do
       application_form.created_under_new_regulations?

diff --git a/...oad/page_objects/assessor_interface/age_range_subjects_assessment_recommendation_award.rb b/...oad/page_objects/assessor_interface/age_range_subjects_assessment_recommendation_award.rb
@@ -3,7 +3,7 @@
 module PageObjects
   module AssessorInterface
     class AgeRangeSubjectsAssessmentRecommendationAward < SitePrism::Page
-      set_url "/assessor/applications/{application_form_id}/assessments/{assessment_id}" \
+      set_url "/assessor/applications/{reference}/assessments/{assessment_id}" \
                 "/recommendation/award/age-range-subjects"
 
       element :heading, "h1"

diff --git a/spec/support/autoload/page_objects/assessor_interface/application.rb b/spec/support/autoload/page_objects/assessor_interface/application.rb
@@ -3,7 +3,7 @@
 module PageObjects
   module AssessorInterface
     class Application < SitePrism::Page
-      set_url "/assessor/applications/{application_form_id}"
+      set_url "/assessor/applications/{reference}"
 
       element :back_link, "a", text: "Back"
 

diff --git a/spec/support/autoload/page_objects/assessor_interface/application_status.rb b/spec/support/autoload/page_objects/assessor_interface/application_status.rb
@@ -1,7 +1,7 @@
 module PageObjects
   module AssessorInterface
     class ApplicationStatus < SitePrism::Page
-      set_url "/assessor/applications/{application_form_id}/status"
+      set_url "/assessor/applications/{reference}/status"
 
       element :back_link, "a", text: "Back"
 

diff --git a/spec/support/autoload/page_objects/assessor_interface/assessment_recommendation_review.rb b/spec/support/autoload/page_objects/assessor_interface/assessment_recommendation_review.rb
@@ -3,7 +3,7 @@
 module PageObjects
   module AssessorInterface
     class AssessmentRecommendationReview < SitePrism::Page
-      set_url "/assessor/applications/{application_form_id}/assessments/{assessment_id}" \
+      set_url "/assessor/applications/{reference}/assessments/{assessment_id}" \
                 "/recommendation/review/edit"
 
       element :continue_button, ".govuk-button"

diff --git a/spec/support/autoload/page_objects/assessor_interface/assessment_section.rb b/spec/support/autoload/page_objects/assessor_interface/assessment_section.rb
@@ -1,7 +1,7 @@
 module PageObjects
   module AssessorInterface
     class AssessmentSection < SitePrism::Page
-      set_url "/assessor/applications/{application_form_id}/assessments/{assessment_id}/sections/{section_id}"
+      set_url "/assessor/applications/{reference}/assessments/{assessment_id}/sections/{section_id}"
 
       element :heading, "h1"
 

diff --git a/spec/support/autoload/page_objects/assessor_interface/assign_assessor.rb b/spec/support/autoload/page_objects/assessor_interface/assign_assessor.rb
@@ -1,7 +1,7 @@
 module PageObjects
   module AssessorInterface
     class AssignAssessor < SitePrism::Page
-      set_url "/assessor/applications/{application_form_id}/assign-assessor"
+      set_url "/assessor/applications/{reference}/assign-assessor"
 
       element :heading, "h1"
       sections :assessors, PageObjects::GovukRadioItem, ".govuk-radios__item"

diff --git a/spec/support/autoload/page_objects/assessor_interface/assign_reviewer.rb b/spec/support/autoload/page_objects/assessor_interface/assign_reviewer.rb
@@ -1,7 +1,7 @@
 module PageObjects
   module AssessorInterface
     class AssignReviewer < SitePrism::Page
-      set_url "/assessor/applications/{application_form_id}/assign-reviewer"
+      set_url "/assessor/applications/{reference}/assign-reviewer"
 
       element :heading, "h1"
       sections :reviewers, PageObjects::GovukRadioItem, ".govuk-radios__item"

diff --git a/spec/support/autoload/page_objects/assessor_interface/check_english_language_proficiency.rb b/spec/support/autoload/page_objects/assessor_interface/check_english_language_proficiency.rb
@@ -5,7 +5,7 @@ class EnglishLanguageProficiencyCard < SitePrism::Section
     end
 
     class CheckEnglishLanguageProficiency < AssessmentSection
-      set_url "/assessor/applications/{application_form_id}/assessments/{assessment_id}/sections/{section_id}"
+      set_url "/assessor/applications/{reference}/assessments/{assessment_id}/sections/{section_id}"
 
       sections :cards, EnglishLanguageProficiencyCard, ".govuk-summary-card"
 

diff --git a/spec/support/autoload/page_objects/assessor_interface/check_personal_information.rb b/spec/support/autoload/page_objects/assessor_interface/check_personal_information.rb
@@ -9,7 +9,7 @@ class PersonalInformationCard < SitePrism::Section
     end
 
     class CheckPersonalInformation < AssessmentSection
-      set_url "/assessor/applications/{application_form_id}/assessments/{assessment_id}/sections/{section_id}"
+      set_url "/assessor/applications/{reference}/assessments/{assessment_id}/sections/{section_id}"
 
       sections :cards, PersonalInformationCard, ".govuk-summary-card"
 

diff --git a/spec/support/autoload/page_objects/assessor_interface/check_professional_standing.rb b/spec/support/autoload/page_objects/assessor_interface/check_professional_standing.rb
@@ -7,7 +7,7 @@ class ProfessionalStandingCard < SitePrism::Section
     end
 
     class CheckProfessionalStanding < AssessmentSection
-      set_url "/assessor/applications/{application_form_id}/assessments/{assessment_id}/sections/{section_id}"
+      set_url "/assessor/applications/{reference}/assessments/{assessment_id}/sections/{section_id}"
 
       sections :cards, ProfessionalStandingCard, ".govuk-summary-card"
 

diff --git a/spec/support/autoload/page_objects/assessor_interface/check_qualifications.rb b/spec/support/autoload/page_objects/assessor_interface/check_qualifications.rb
@@ -7,7 +7,7 @@ class QualificationCard < SitePrism::Section
     end
 
     class CheckQualifications < AssessmentSection
-      set_url "/assessor/applications/{application_form_id}/assessments/{assessment_id}/sections/{section_id}"
+      set_url "/assessor/applications/{reference}/assessments/{assessment_id}/sections/{section_id}"
 
       sections :cards, QualificationCard, ".govuk-summary-card"
 

diff --git a/spec/support/autoload/page_objects/assessor_interface/check_work_history.rb b/spec/support/autoload/page_objects/assessor_interface/check_work_history.rb
@@ -7,7 +7,7 @@ class WorkHistoryCard < GovukSummaryCard
     end
 
     class CheckWorkHistory < AssessmentSection
-      set_url "/assessor/applications/{application_form_id}/assessments/{assessment_id}/sections/{section_id}"
+      set_url "/assessor/applications/{reference}/assessments/{assessment_id}/sections/{section_id}"
 
       sections :cards, WorkHistoryCard, ".govuk-summary-card"
 

diff --git a/spec/support/autoload/page_objects/assessor_interface/complete_assessment.rb b/spec/support/autoload/page_objects/assessor_interface/complete_assessment.rb
@@ -1,7 +1,7 @@
 module PageObjects
   module AssessorInterface
     class CompleteAssessment < SitePrism::Page
-      set_url "/assessor/applications/{application_form_id}/assessments/{assessment_id}/edit"
+      set_url "/assessor/applications/{reference}/assessments/{assessment_id}/edit"
 
       element :heading, "h1"
       sections :new_states, GovukRadioItem, ".govuk-radios__item"

diff --git a/spec/support/autoload/page_objects/assessor_interface/confirm_assessment_recommendation.rb b/spec/support/autoload/page_objects/assessor_interface/confirm_assessment_recommendation.rb
@@ -1,7 +1,7 @@
 module PageObjects
   module AssessorInterface
     class ConfirmAssessmentRecommendation < SitePrism::Page
-      set_url "/assessor/applications/{application_form_id}/assessments/{assessment_id}" \
+      set_url "/assessor/applications/{reference}/assessments/{assessment_id}" \
                 "/recommendation/{recommendation}/confirm"
 
       element :heading, "h1"