Merge pull request #5500 from nhsuk/handle_nil_pds_patient_lookups_gracefully

Gracefully handle nil values from NHS::PDS patient lookups

Author: TheOneFromNorway

app/jobs/patient_update_from_pds_job.rb

@@ -19,6 +19,7 @@ def perform(patient, search_results = [])
     return unless unique_nhs_number
 
     pds_patient = PDS::Patient.find(unique_nhs_number)
+    return unless pds_patient
 
     if pds_patient.nhs_number != patient.nhs_number
       if (

app/lib/mavis_cli/pds/get.rb

@@ -1,4 +1,4 @@
-#frozen_string_literal: true
+# frozen_string_literal: true
 
 module MavisCLI
   module PDS
@@ -12,12 +12,16 @@ def call(nhs_number:)
 
         response = NHS::PDS.get_patient(nhs_number)
 
-        puts response.status unless response.status == 200
-        puts response.env.url
-        puts ""
-        puts(response.headers.map { "#{_1}: #{_2}" })
-        puts ""
-        puts JSON.pretty_generate(response.body)
+        if response.nil?
+          puts "Response from NHS::PDS is `nil`"
+        else
+          puts response.status unless response.status == 200
+          puts response.env.url
+          puts ""
+          puts(response.headers.map { "#{_1}: #{_2}" })
+          puts ""
+          puts JSON.pretty_generate(response.body)
+        end
       end
     end
   end

app/lib/mavis_cli/pds/search.rb

@@ -68,12 +68,16 @@ def call(
 
         response = NHS::PDS.search_patients(query)
 
-        puts response.status unless response.status == 200
-        puts response.env.url
-        puts ""
-        puts(response.headers.map { "#{_1}: #{_2}" })
-        puts ""
-        puts JSON.pretty_generate(response.body)
+        if response.nil?
+          puts "Response from NHS::PDS is `nil`"
+        else
+          puts response.status unless response.status == 200
+          puts response.env.url
+          puts ""
+          puts(response.headers.map { "#{_1}: #{_2}" })
+          puts ""
+          puts JSON.pretty_generate(response.body)
+        end
       end
     end
   end

app/models/pds/patient.rb

@@ -13,6 +13,8 @@ class PDS::Patient
   class << self
     def find(nhs_number)
       response = NHS::PDS.get_patient(nhs_number)
+      return unless response
+
       from_pds_fhir_response(response.body)
     end
 
@@ -33,8 +35,10 @@ def search(
         "_fuzzy-match" => fuzzy
       }.compact_blank
 
-      results = NHS::PDS.search_patients(query).body
+      response = NHS::PDS.search_patients(query)
+      return unless response
 
+      results = response.body
       return if results["total"].zero?
 
       from_pds_fhir_response(results["entry"].first["resource"])

spec/lib/nhs/pds_spec.rb

@@ -4,6 +4,14 @@
   describe "#get_patient" do
     subject(:get_patient) { described_class.get_patient("9000000009") }
 
+    context "with pds.enabled is false" do
+      before { Settings.pds.enabled = false }
+
+      after { Settings.reload! }
+
+      it { should be_nil }
+    end
+
     context "with a successful response" do
       before do
         stub_request(
@@ -90,6 +98,14 @@
       )
     end
 
+    context "with pds.enabled is false" do
+      before { Settings.pds.enabled = false }
+
+      after { Settings.reload! }
+
+      it { should be_nil }
+    end
+
     context "with a successful response" do
       before do
         stub_request(

spec/models/pds/patient_spec.rb

@@ -8,30 +8,40 @@
       file_fixture("pds/get-patient-response-deceased.json").read
     end
 
-    before do
-      allow(NHS::PDS).to receive(:get_patient).and_return(
-        instance_double(
-          Faraday::Response,
-          status: 200,
-          body: JSON.parse(json_response)
-        )
-      )
-    end
+    context "with pds.enabled is false" do
+      before { Settings.pds.enabled = false }
 
-    it "calls get_patient on PDS library" do
-      find
-      expect(NHS::PDS).to have_received(:get_patient).with("9000000009")
+      after { Settings.reload! }
+
+      it { should be_nil }
     end
 
-    it "parses the patient information" do
-      expect(find).to have_attributes(
-        nhs_number: "9000000009",
-        family_name: "Smith",
-        date_of_birth: Date.new(2010, 10, 22),
-        date_of_death: Date.new(2010, 10, 22),
-        restricted: true,
-        gp_ods_code: "Y12345"
-      )
+    context "when the patient exists" do
+      before do
+        allow(NHS::PDS).to receive(:get_patient).and_return(
+          instance_double(
+            Faraday::Response,
+            status: 200,
+            body: JSON.parse(json_response)
+          )
+        )
+      end
+
+      it "calls get_patient on PDS library" do
+        find
+        expect(NHS::PDS).to have_received(:get_patient).with("9000000009")
+      end
+
+      it "parses the patient information" do
+        expect(find).to have_attributes(
+          nhs_number: "9000000009",
+          family_name: "Smith",
+          date_of_birth: Date.new(2010, 10, 22),
+          date_of_death: Date.new(2010, 10, 22),
+          restricted: true,
+          gp_ods_code: "Y12345"
+        )
+      end
     end
   end
 
@@ -49,38 +59,48 @@
       file_fixture("pds/search-patients-response.json").read
     end
 
-    before do
-      allow(NHS::PDS).to receive(:search_patients).and_return(
-        instance_double(
-          Faraday::Response,
-          status: 200,
-          body: JSON.parse(json_response)
-        )
-      )
-    end
+    context "with pds.enabled is false" do
+      before { Settings.pds.enabled = false }
 
-    it "calls find on PDS library" do
-      search
-      expect(NHS::PDS).to have_received(:search_patients).with(
-        {
-          "_history" => true,
-          "address-postalcode" => "SW11 1AA",
-          "birthdate" => "eq2020-01-01",
-          "family" => "Smith",
-          "given" => "John"
-        }
-      )
+      after { Settings.reload! }
+
+      it { should be_nil }
     end
 
-    it "parses the patient information" do
-      expect(search).to have_attributes(
-        nhs_number: "9449306168",
-        family_name: "LAWMAN",
-        date_of_birth: Date.new(1939, 1, 9),
-        date_of_death: nil,
-        restricted: false,
-        gp_ods_code: "H81109"
-      )
+    context "when the patient exists" do
+      before do
+        allow(NHS::PDS).to receive(:search_patients).and_return(
+          instance_double(
+            Faraday::Response,
+            status: 200,
+            body: JSON.parse(json_response)
+          )
+        )
+      end
+
+      it "calls find on PDS library" do
+        search
+        expect(NHS::PDS).to have_received(:search_patients).with(
+          {
+            "_history" => true,
+            "address-postalcode" => "SW11 1AA",
+            "birthdate" => "eq2020-01-01",
+            "family" => "Smith",
+            "given" => "John"
+          }
+        )
+      end
+
+      it "parses the patient information" do
+        expect(search).to have_attributes(
+          nhs_number: "9449306168",
+          family_name: "LAWMAN",
+          date_of_birth: Date.new(1939, 1, 9),
+          date_of_death: nil,
+          restricted: false,
+          gp_ods_code: "H81109"
+        )
+      end
     end
   end
 end