Merge pull request #6507 from NHSDigital/only-sync-when-relevant-fields-change

Reraise "Only sync with Imms API if a relevant field has been updated"

Author: jf-x-dev

app/lib/fhir_mapper/vaccination_record.rb

@@ -18,6 +18,9 @@ def initialize(vaccination_record)
       @vaccination_record = vaccination_record
     end
 
+    # If you add or remove fields here, update SYNCED_FIELDS in
+    # VaccinationRecord::NHSImmunisationsAPISync so that changes to those fields
+    # correctly trigger or stop triggering a sync to the NHS Immunisations API.
     def fhir_record
       immunisation = FHIR::Immunization.new(id: nhs_immunisations_api_id)
 

app/models/vaccination_record/nhs_immunisations_api_sync.rb

@@ -3,6 +3,34 @@
 module VaccinationRecord::NHSImmunisationsAPISync
   extend ActiveSupport::Concern
 
+  # Fields whose changes trigger a sync. Keep in sync with:
+  #   - FHIRMapper::VaccinationRecord#fhir_record (fields that affect the FHIR payload)
+  #   - #should_be_in_nhs_immunisations_api? (fields that affect eligibility)
+  SYNCED_FIELDS = %w[
+    uuid
+    source
+    outcome
+    performed_at_date
+    performed_at_time
+    created_at
+    batch_number
+    batch_expiry
+    delivery_site
+    delivery_method
+    performed_ods_code
+    dose_sequence
+    programme_type
+    full_dose
+    vaccine_id
+    patient_id
+    location_id
+    performed_by_user_id
+    performed_by_given_name
+    performed_by_family_name
+    discarded_at
+    notify_parents
+  ].freeze
+
   included do
     scope :with_correct_source_for_nhs_immunisations_api,
           -> do
@@ -97,10 +125,7 @@ def api_integration_cutoff_date
   end
 
   def changes_need_to_be_synced_to_nhs_immunisations_api?
-    changes.present? && !nhs_immunisations_api_etag_changed? &&
-      !nhs_immunisations_api_sync_pending_at_changed? &&
-      !nhs_immunisations_api_synced_at_changed? &&
-      !nhs_immunisations_api_id_changed?
+    (changes.keys & SYNCED_FIELDS).any?
   end
 
   def touch_nhs_immunisations_api_sync_pending_at

spec/models/vaccination_record/nhs_immunisations_api_sync_spec.rb

@@ -218,6 +218,10 @@
   describe "#sync_status" do
     subject(:sync_status) { vaccination_record.sync_status }
 
+    let(:vaccination_record) do
+      create(:vaccination_record, outcome:, programme:, session:)
+    end
+
     before { Flipper.enable(:imms_api_sync_job, programme) }
 
     context "when patient has no NHS number" do
@@ -607,4 +611,82 @@
       it { should be false }
     end
   end
+
+  describe "#changes_need_to_be_synced_to_nhs_immunisations_api?" do
+    subject do
+      vaccination_record.changes_need_to_be_synced_to_nhs_immunisations_api?
+    end
+
+    let(:vaccination_record) do
+      create(:vaccination_record, programme:, session:)
+    end
+
+    context "when no attributes have changed" do
+      it { should be false }
+    end
+
+    context "when a FHIR content field changes" do
+      before { vaccination_record.batch_number = "NEWBATCH" }
+
+      it { should be true }
+    end
+
+    context "when outcome changes" do
+      before { vaccination_record.outcome = :refused }
+
+      it { should be true }
+    end
+
+    context "when notify_parents changes" do
+      before { vaccination_record.notify_parents = false }
+
+      it { should be true }
+    end
+
+    context "when discarded_at changes" do
+      before { vaccination_record.discarded_at = Time.current }
+
+      it { should be true }
+    end
+
+    context "when only notes change" do
+      before { vaccination_record.notes = "Some new note" }
+
+      it { should be false }
+    end
+
+    context "when only protocol changes" do
+      before { vaccination_record.protocol = :psd }
+
+      it { should be false }
+    end
+
+    context "when only nhs_immunisations_api_etag changes" do
+      before { vaccination_record.nhs_immunisations_api_etag = "2" }
+
+      it { should be false }
+    end
+
+    context "when only nhs_immunisations_api_sync_pending_at changes" do
+      before do
+        vaccination_record.nhs_immunisations_api_sync_pending_at = Time.current
+      end
+
+      it { should be false }
+    end
+
+    context "when only nhs_immunisations_api_synced_at changes" do
+      before do
+        vaccination_record.nhs_immunisations_api_synced_at = Time.current
+      end
+
+      it { should be false }
+    end
+
+    context "when only nhs_immunisations_api_id changes" do
+      before { vaccination_record.nhs_immunisations_api_id = SecureRandom.uuid }
+
+      it { should be false }
+    end
+  end
 end

spec/models/vaccination_record_spec.rb

@@ -466,77 +466,6 @@
     end
   end
 
-  describe "#changes_need_to_be_synced_to_nhs_immunisations_api?" do
-    subject do
-      vaccination_record.send(
-        :changes_need_to_be_synced_to_nhs_immunisations_api?
-      )
-    end
-
-    let(:vaccination_record) { create(:vaccination_record) }
-
-    context "when the update doesn't change any attributes" do
-      it { should be(false) }
-    end
-
-    context "when regular fields have been changed" do
-      before { vaccination_record.notes = "Updated notes" }
-
-      it { should be(true) }
-    end
-
-    context "when only nhs_immunisations_api_etag has been changed" do
-      before { vaccination_record.nhs_immunisations_api_etag = "new-etag" }
-
-      it { should be(false) }
-    end
-
-    context "when only nhs_immunisations_api_sync_pending_at has been changed" do
-      before do
-        vaccination_record.nhs_immunisations_api_sync_pending_at = Time.current
-      end
-
-      it { should be(false) }
-    end
-
-    context "when only nhs_immunisations_api_synced_at has been changed" do
-      before do
-        vaccination_record.nhs_immunisations_api_synced_at = Time.current
-      end
-
-      it { should be(false) }
-    end
-
-    context "when only nhs_immunisations_api_id has been changed" do
-      before { vaccination_record.nhs_immunisations_api_id = "new-id" }
-
-      it { should be(false) }
-    end
-
-    context "when both regular fields and nhs_immunisations_api fields have been changed" do
-      before do
-        vaccination_record.assign_attributes(
-          notes: "Updated notes",
-          nhs_immunisations_api_etag: "new-etag"
-        )
-      end
-
-      it { should be(false) }
-    end
-
-    context "when a regular field and multiple nhs_immunisations_api fields have been changed" do
-      before do
-        vaccination_record.assign_attributes(
-          outcome: :refused,
-          nhs_immunisations_api_etag: "new-etag",
-          nhs_immunisations_api_sync_pending_at: Time.current
-        )
-      end
-
-      it { should be(false) }
-    end
-  end
-
   describe "#for_academic_year" do
     before { vaccination_record.save! }