Version 3.1.0

.github/workflows/deploy-application.yml

@@ -24,6 +24,7 @@ on:
           - all
           - web
           - good-job
+          - sidekiq
         default: all
   workflow_call:
     inputs:
@@ -82,7 +83,9 @@ jobs:
           "application_group=" + .codedeploy_deployment_group_name.value,
           "cluster_name=" + .ecs_variables.value.cluster_name,
           "good_job_service=" + .ecs_variables.value.good_job.service_name,
-          "good_job_task_definition=" + .ecs_variables.value.good_job.task_definition.arn
+          "good_job_task_definition=" + .ecs_variables.value.good_job.task_definition.arn,
+          "sidekiq_service=" + .ecs_variables.value.sidekiq.service_name,
+          "sidekiq_task_definition=" + .ecs_variables.value.sidekiq.task_definition.arn
           ' > ${{ runner.temp }}/DEPLOYMENT_ENVS
       - name: Upload Artifact
         uses: actions/upload-artifact@v4
@@ -166,3 +169,47 @@ jobs:
             exit 1
           fi
           echo "Deployment successful"
+
+  create-sidekiq-deployment:
+    name: Create sidekiq deployment
+    runs-on: ubuntu-latest
+    needs: prepare-deployment
+    if: inputs.server_types == 'sidekiq' || inputs.server_types == 'all'
+    permissions:
+      id-token: write
+    steps:
+      - name: Download Artifact
+        uses: actions/download-artifact@v5
+        with:
+          name: DEPLOYMENT_ENVS-${{ inputs.environment }}
+          path: ${{ runner.temp }}
+      - name: Configure AWS Credentials
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          role-to-assume: ${{ env.aws-role }}
+          aws-region: eu-west-2
+      - name: Trigger ECS Deployment
+        run: |
+          set -e
+          source ${{ runner.temp }}/DEPLOYMENT_ENVS
+          DEPLOYMENT_ID=$(aws ecs update-service --cluster $cluster_name --service $sidekiq_service \
+          --task-definition $sidekiq_task_definition --force-new-deployment \
+          --query 'service.deployments[?rolloutState==`IN_PROGRESS`].[id][0]' --output text)
+          echo "Deployment started: $DEPLOYMENT_ID"
+          echo "deployment_id=$DEPLOYMENT_ID" >> $GITHUB_ENV
+      - name: Wait for deployment to complete
+        run: |
+          set -e
+          source ${{ runner.temp }}/DEPLOYMENT_ENVS
+          DEPLOYMENT_STATE=IN_PROGRESS
+          while [ "$DEPLOYMENT_STATE" == "IN_PROGRESS" ]; do
+            echo "Waiting for deployment to complete..."
+            sleep 30
+            DEPLOYMENT_STATE="$(aws ecs describe-services --cluster $cluster_name --services $sidekiq_service \
+            --query "services[0].deployments[?id == \`$deployment_id\`].[rolloutState][0]" --output text)"
+          done
+          if [ "$DEPLOYMENT_STATE" != "COMPLETED" ]; then
+            echo "Deployment failed with state: $DEPLOYMENT_STATE"
+            exit 1
+          fi
+          echo "Deployment successful"

.github/workflows/deploy.yml

@@ -41,6 +41,7 @@ on:
           - all
           - web
           - good-job
+          - sidekiq
           - none
         default: all
 

Gemfile

@@ -60,6 +60,8 @@ gem "ruby-progressbar"
 gem "rubyzip"
 gem "sentry-rails"
 gem "sentry-ruby"
+gem "sidekiq"
+gem "sidekiq-throttled"
 gem "splunk-sdk-ruby"
 gem "table_tennis"
 gem "tzinfo-data", platforms: %i[mingw mswin x64_mingw jruby]

Gemfile.lock

@@ -521,6 +521,9 @@ GEM
       erb
       psych (>= 4.0.0)
     redcarpet (3.6.1)
+    redis-client (0.25.2)
+      connection_pool
+    redis-prescription (2.6.0)
     regexp_parser (2.11.2)
     reline (0.6.2)
       io-console (~> 0.5)
@@ -572,14 +575,14 @@ GEM
     rubocop-capybara (2.22.1)
       lint_roller (~> 1.1)
       rubocop (~> 1.72, >= 1.72.1)
-    rubocop-govuk (5.1.19)
+    rubocop-govuk (5.1.20)
       rubocop (= 1.79.2)
       rubocop-ast (= 1.46.0)
       rubocop-capybara (= 2.22.1)
-      rubocop-rails (= 2.32.0)
+      rubocop-rails (= 2.33.3)
       rubocop-rake (= 0.7.1)
       rubocop-rspec (= 3.6.0)
-    rubocop-rails (2.32.0)
+    rubocop-rails (2.33.3)
       activesupport (>= 4.2.0)
       lint_roller (~> 1.1)
       rack (>= 1.1)
@@ -615,6 +618,16 @@ GEM
       concurrent-ruby (~> 1.0, >= 1.0.2)
     shoulda-matchers (6.5.0)
       activesupport (>= 5.2.0)
+    sidekiq (8.0.7)
+      connection_pool (>= 2.5.0)
+      json (>= 2.9.0)
+      logger (>= 1.6.2)
+      rack (>= 3.1.0)
+      redis-client (>= 0.23.2)
+    sidekiq-throttled (2.0.0)
+      concurrent-ruby (>= 1.2.0)
+      redis-prescription (~> 2.2)
+      sidekiq (>= 8.0)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -682,7 +695,7 @@ GEM
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     uk_postcode (2.1.8)
-    unicode-display_width (3.1.4)
+    unicode-display_width (3.1.5)
       unicode-emoji (~> 4.0, >= 4.0.4)
     unicode-emoji (4.0.4)
     uri (1.0.3)
@@ -810,6 +823,8 @@ DEPENDENCIES
   sentry-rails
   sentry-ruby
   shoulda-matchers
+  sidekiq
+  sidekiq-throttled
   simplecov
   solargraph
   solargraph-rails

README.md

@@ -337,10 +337,8 @@ See the [releasing documentation](docs/releasing.md) for more information.
 
 ## Rake tasks
 
-- `access_log:for_patient[id]`
-- `access_log:for_user[id]`
-- `subteams:create[ods_code,name,email,phone]`
-- `users:create[email,password,given_name,family_name,team_ods_code]`
+- `feature_flags:seed`
+- `smoke:seed`
 - `vaccines:seed[type]`
 
 See the [Rake tasks documentation](docs/rake-tasks.md) for more information.

app/components/app_patient_programmes_table_component.rb

@@ -73,15 +73,7 @@ def build_rows(programme:, academic_year:, vaccination_records:)
   end
 
   def build_row_for_programme(programme:, academic_year:)
-    cached_vaccination_status =
-      @patient.vaccination_status(programme:, academic_year:)
-
-    vaccination_status = {
-      status: cached_vaccination_status.status.to_sym,
-      latest_session_status:
-        cached_vaccination_status.latest_session_status.to_sym,
-      status_changed_at: cached_vaccination_status.status_changed_at
-    }
+    vaccination_status = patient.vaccination_status(programme:, academic_year:)
 
     [
       name_for_programme(programme:, academic_year:),
@@ -115,14 +107,13 @@ def name_for_programme(programme:, academic_year:)
   end
 
   def status_for_programme(vaccination_status:, programme:, academic_year:)
-    status = vaccination_status[:status]
-    if status == :none_yet &&
+    if vaccination_status.none_yet? &&
          eligibility_start_in_future?(programme:, academic_year:)
       return "-"
     end
 
-    label = I18n.t(status, scope: "status.programme.label")
-    colour = I18n.t(status, scope: "status.programme.colour")
+    label = I18n.t(vaccination_status.status, scope: "status.programme.label")
+    colour = I18n.t(vaccination_status.status, scope: "status.programme.colour")
     tag.strong(label, class: "nhsuk-tag nhsuk-tag--#{colour}")
   end
 
@@ -143,40 +134,42 @@ def calculate_earliest_academic_year(programme:, academic_year:)
   end
 
   def notes_for_programme(vaccination_status:, programme:, academic_year:)
-    case vaccination_status[:status]
-    when :vaccinated
+    if vaccination_status.vaccinated?
       notes_for_status(vaccination_status:)
-    when :could_not_vaccinate
+    elsif vaccination_status.could_not_vaccinate?
       could_not_vaccinate_notes(vaccination_status:)
-    when :none_yet
+    else
       no_outcome_yet_notes(vaccination_status:, programme:, academic_year:)
     end
   end
 
   def notes_for_status(vaccination_status:)
     latest_session_status =
-      vaccination_status[:latest_session_status].to_s.humanize
-    date = vaccination_status[:status_changed_at].to_date.to_fs(:long)
+      vaccination_status.latest_session_status.to_s.humanize
+    date = vaccination_status.status_changed_at.to_date.to_fs(:long)
     "#{latest_session_status} on #{date}"
   end
 
   def could_not_vaccinate_notes(vaccination_status:)
-    if vaccination_status[:latest_session_status] == :had_contraindications
+    if vaccination_status.latest_session_status_had_contraindications?
       latest_triage =
         @patient
           .triages
           .includes(:performed_by)
-          .find_by(created_at: vaccination_status[:status_changed_at])
+          .find_by(created_at: vaccination_status.status_changed_at)
 
-      nurse = latest_triage.performed_by
-      "#{nurse.full_name} decided that #{patient.full_name} could not be vaccinated"
+      if latest_triage
+        "#{latest_triage.performed_by.full_name} decided that #{patient.full_name} could not be vaccinated"
+      else
+        "#{patient.full_name} could not be vaccinated"
+      end
     else
       notes_for_status(vaccination_status:)
     end
   end
 
   def no_outcome_yet_notes(vaccination_status:, programme:, academic_year:)
-    if vaccination_status[:latest_session_status] == :none_yet
+    if vaccination_status.latest_session_status_none_yet?
       eligibility_notes(programme:, academic_year:)
     else
       notes_for_status(vaccination_status:)
@@ -231,9 +224,8 @@ def multi_dose?(vaccination_record:)
   def status_for_administered_record(vaccination_record:)
     if vaccination_record.administered?
       status_for_programme(
-        vaccination_status: {
-          status: :vaccinated
-        },
+        vaccination_status:
+          Patient::VaccinationStatus.new(status: "vaccinated"),
         programme: nil,
         academic_year: nil
       )

app/jobs/commit_patient_changesets_job.rb

@@ -32,7 +32,7 @@ def perform(import)
 
   def import_patients_and_parents(changesets, import)
     patients = changesets.map(&:patient)
-    parents = changesets.flat_map(&:parents)
+    parents = changesets.flat_map(&:parents).uniq
     relationships =
       changesets
         .flat_map(&:parent_relationships)

app/jobs/concerns/nhs_api_concurrency_concern.rb → app/jobs/concerns/immunisations_api_throttling_concern.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module NHSAPIConcurrencyConcern
+module ImmunisationsAPIThrottlingConcern
   extend ActiveSupport::Concern
 
   include GoodJob::ActiveJobExtensions::Concurrency

app/jobs/concerns/pds_api_throttling_concern.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module PDSAPIThrottlingConcern
+  extend ActiveSupport::Concern
+
+  include Sidekiq::Job
+  include Sidekiq::Throttled::Job
+
+  included do
+    self.queue_adapter = :sidekiq unless Rails.env.test?
+
+    sidekiq_throttle_as :pds
+
+    retry_on Faraday::ServerError, wait: :polynomially_longer
+  end
+end

app/jobs/consent_form_matching_job.rb

@@ -1,10 +1,7 @@
 # frozen_string_literal: true
 
 class ConsentFormMatchingJob < ApplicationJob
-  def self.concurrent_jobs_per_second = 5
-  def self.concurrency_key = :pds
-
-  include NHSAPIConcurrencyConcern
+  include PDSAPIThrottlingConcern
 
   queue_as :consents
 

app/jobs/enqueue_update_patients_from_pds_job.rb

@@ -16,6 +16,6 @@ def perform
         .or(scope.where("updated_from_pds_at < ?", 12.hours.ago))
         .order("updated_from_pds_at ASC NULLS FIRST")
 
-    UpdatePatientsFromPDS.call(patients, priority: 50, queue: :pds)
+    UpdatePatientsFromPDS.call(patients, queue: :pds)
   end
 end

app/jobs/patient_nhs_number_lookup_job.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
 
 class PatientNHSNumberLookupJob < ApplicationJob
-  def self.concurrent_jobs_per_second = 5
-  def self.concurrency_key = :pds
+  include PDSAPIThrottlingConcern
 
-  include NHSAPIConcurrencyConcern
-
-  queue_as :imports
+  queue_as :pds
 
   def perform(patient)
     return if patient.nhs_number.present? && !patient.invalidated?

app/jobs/patient_update_from_pds_job.rb

@@ -1,10 +1,7 @@
 # frozen_string_literal: true
 
 class PatientUpdateFromPDSJob < ApplicationJob
-  def self.concurrent_jobs_per_second = 5
-  def self.concurrency_key = :pds
-
-  include NHSAPIConcurrencyConcern
+  include PDSAPIThrottlingConcern
 
   queue_as :pds