Merge pull request #1690 from FirelyTeam/bugfix/1681-client-handle-prefer-operation-outcome-resource-in-response

FhirClient: handle prefer operation outcome in resource response

Author: marcovisserFurore

src/Hl7.Fhir.Core.Tests/Rest/FhirClientTests.cs

@@ -38,14 +38,17 @@ public class FhirClientTests
         //public static Uri testEndpoint = new Uri("http://fhirtest.uhn.ca/baseDstu3");
         //public static Uri testEndpoint = new Uri("http://localhost:49911/fhir");
         //public static Uri testEndpoint = new Uri("http://sqlonfhir-stu3.azurewebsites.net/fhir");
-        public static Uri testEndpoint = new Uri("https://vonk.fire.ly/r3");
+        public static Uri testEndpoint = new Uri("https://server.fire.ly/r3");
 
         //public static Uri _endpointSupportingSearchUsingPost = new Uri("http://localhost:49911/fhir"); 
         public static Uri _endpointSupportingSearchUsingPost = new Uri("http://localhost:4080");
         //public static Uri _endpointSupportingSearchUsingPost = new Uri("https://vonk.fire.ly/r3");
 
         public static Uri TerminologyEndpoint = new Uri("https://stu3.ontoserver.csiro.au/fhir");
 
+        private static string patientId = "pat1" + ModelInfo.Version;
+        private static string locationId = "loc1" + ModelInfo.Version;
+
 #if !NETCOREAPP2_1
         [ClassInitialize]
         public static void ClassInitialize(TestContext testContext)
@@ -87,7 +90,7 @@ private static void CreateItems()
                         Family = "Donald",
                     }
                 },
-                Id = "pat1",
+                Id = patientId,
                 Identifier = new List<Identifier>()
                 {
                     new Identifier()
@@ -104,7 +107,7 @@ private static void CreateItems()
                 {
                     City = "Den Burg"
                 },
-                Id = "1"
+                Id = locationId
             };
 
             // Create the patient
@@ -281,7 +284,7 @@ private void testReadWithFormat(BaseFhirClient client)
         public void ReadWrongResourceType()
         {
             LegacyFhirClient client = new LegacyFhirClient(testEndpoint);
-            var loc = client.Read<Patient>("Location/1");
+            var loc = client.Read<Patient>("Location/" + locationId);
         }
 
         [TestMethod, TestCategory("FhirClient"), TestCategory("IntegrationTest")]
@@ -294,7 +297,7 @@ public void ReadWrongResourceTypeHttpClient()
 
         private void testReadWrongResourceType(BaseFhirClient client)
         {
-            var loc = client.Read<Patient>("Location/1");
+            var loc = client.Read<Patient>("Location/" + locationId);
         }
 
         [TestMethod, TestCategory("FhirClient"), TestCategory("IntegrationTest")]
@@ -315,14 +318,14 @@ public void ReadHttpClient()
 
         private void testReadClient(BaseFhirClient client)
         {
-            var loc = client.Read<Location>("Location/1");
+            var loc = client.Read<Location>("Location/" + locationId);
             Assert.IsNotNull(loc);
             Assert.AreEqual("Den Burg", loc.Address.City);
 
-            Assert.AreEqual("1", loc.Id);
+            Assert.AreEqual(locationId, loc.Id);
             Assert.IsNotNull(loc.Meta.VersionId);
 
-            var loc2 = client.Read<Location>(ResourceIdentity.Build("Location", "1", loc.Meta.VersionId));
+            var loc2 = client.Read<Location>(ResourceIdentity.Build("Location", locationId, loc.Meta.VersionId));
             Assert.IsNotNull(loc2);
             Assert.AreEqual(loc2.Id, loc.Id);
             Assert.AreEqual(loc2.Meta.VersionId, loc.Meta.VersionId);
@@ -338,7 +341,7 @@ private void testReadClient(BaseFhirClient client)
                 Assert.AreEqual("404", client.LastResult.Status);
             }
 
-            var loc3 = client.Read<Location>(ResourceIdentity.Build("Location", "1", loc.Meta.VersionId));
+            var loc3 = client.Read<Location>(ResourceIdentity.Build("Location", locationId, loc.Meta.VersionId));
             Assert.IsNotNull(loc3);
             var jsonSer = new FhirJsonSerializer();
             Assert.AreEqual(jsonSer.SerializeToString(loc),
@@ -370,11 +373,11 @@ public void ReadRelativeHttpClient()
 
         private void testReadRelative(BaseFhirClient client)
         {
-            var loc = client.Read<Location>(new Uri("Location/1", UriKind.Relative));
+            var loc = client.Read<Location>(new Uri("Location/" + locationId, UriKind.Relative));
             Assert.IsNotNull(loc);
             Assert.AreEqual("Den Burg", loc.Address.City);
 
-            var ri = ResourceIdentity.Build(testEndpoint, "Location", "1");
+            var ri = ResourceIdentity.Build(testEndpoint, "Location", locationId);
             loc = client.Read<Location>(ri);
             Assert.IsNotNull(loc);
             Assert.AreEqual("Den Burg", loc.Address.City);
@@ -399,11 +402,11 @@ public void ReadRelativeAsyncHttpClient()
 
         private void testRelativeAsyncClient(BaseFhirClient client)
         {
-            var loc = client.ReadAsync<Location>(new Uri("Location/1", UriKind.Relative)).Result;
+            var loc = client.ReadAsync<Location>(new Uri("Location/" + locationId, UriKind.Relative)).Result;
             Assert.IsNotNull(loc);
             Assert.AreEqual("Den Burg", loc.Address.City);
 
-            var ri = ResourceIdentity.Build(testEndpoint, "Location", "1");
+            var ri = ResourceIdentity.Build(testEndpoint, "Location", locationId);
             loc = client.ReadAsync<Location>(ri).Result;
             Assert.IsNotNull(loc);
             Assert.AreEqual("Den Burg", loc.Address.City);
@@ -732,7 +735,7 @@ private static void testCreateAndFullRepresentation(BaseFhirClient client)
         {
             client.Settings.PreferredReturn = Prefer.ReturnRepresentation;       // which is also the default
 
-            var pat = client.Read<Patient>("Patient/pat1");
+            var pat = client.Read<Patient>("Patient/" + patientId);
             ResourceIdentity ri = pat.ResourceIdentity().WithBase(client.Endpoint);
             pat.Id = null;
             pat.Identifier.Clear();
@@ -793,7 +796,7 @@ private void testCreateEditDelete(BaseFhirClient client)
         {
             // client.CompressRequestBody = true;
 
-            var pat = client.Read<Patient>("Patient/pat1");
+            var pat = client.Read<Patient>("Patient/" + patientId);
             pat.Id = null;
             pat.Identifier.Clear();
             pat.Identifier.Add(new Identifier("http://hl7.org/test/2", "99999"));
@@ -1322,7 +1325,7 @@ public void CallsCallbacks()
                 status = e.RawResponse.StatusCode;
             };
 
-            var pat = client.Read<Patient>("Patient/pat1");
+            var pat = client.Read<Patient>("Patient/" + patientId);
             Assert.IsTrue(calledBefore);
             Assert.IsNotNull(status);
             Assert.IsNotNull(body);
@@ -1366,7 +1369,7 @@ public void CallsCallbacksHttpClient()
                     status = e.RawResponse.StatusCode;
                 };
 
-                var pat = client.Read<Patient>("Patient/pat1");
+                var pat = client.Read<Patient>("Patient/" + patientId);
                 Assert.IsTrue(calledBefore);
                 Assert.IsNotNull(status);
                 Assert.IsNotNull(body);
@@ -1494,7 +1497,7 @@ public void TestRefreshHttpClient()
 
         private static void clientReadRefresh(BaseFhirClient client)
         {
-            var result = client.Read<Patient>("Patient/pat1");
+            var result = client.Read<Patient>("Patient/" + patientId);
 
             var orig = result.Name[0].FamilyElement.Value;
 
@@ -1763,6 +1766,24 @@ public void TestCreatingBinaryResourceHttpClient()
             }
         }
 
+        /// <summary>
+        /// Test for showing issue https://github.com/FirelyTeam/firely-net-sdk/issues/1681
+        /// </summary>
+        [TestMethod, TestCategory("IntegrationTest"), TestCategory("FhirClient")]
+        public void TestPreferOperationOutcome()
+        {
+            FhirClient client = new FhirClient(testEndpoint);
+            client.Settings.PreferredReturn = Prefer.OperationOutcome;
+
+            var pat = new Patient()
+            {
+                Name = new List<HumanName> { new HumanName().WithGiven("testy").AndFamily("McTestFace") }
+            };
+
+            var oo = client.Create<Patient>(pat);
+            Assert.IsNotNull(client.LastResult.Outcome);
+        }
+
         [Ignore]
         [TestMethod, TestCategory("IntegrationTest"), TestCategory("FhirClient")]
         public void TestOperationEverything()
@@ -1840,7 +1861,7 @@ public void TestMultipleMessageHandlersInFhirClient()
             };
 
             using var client = new FhirClient(testEndpoint, settings: FhirClientSettings.CreateDefault(), testDegatingHandler);
-            var loc = client.Read<Location>("Location/1");
+            var loc = client.Read<Location>("Location/" + locationId);
             Assert.IsNotNull(testDegatingHandler.LastRequest);
             Assert.IsNotNull(testMessageHandler.LastResponse);
         }

src/Hl7.Fhir.Core/Rest/TypedEntryResponseToBundle.cs

@@ -62,6 +62,13 @@ public static Bundle.EntryComponent ToBundleEntry(this TypedEntryResponse entry,
                         {
                             result.Resource = new BaseFhirParser(parserSettings).Parse<Resource>(entry.TypedElement);
 
+                            //if the response is an operation outcome, add it to response.outcome. This is necessary for when a client uses return=OperationOutcome as a prefer header.
+                            // see also issue #1681
+                            if (result.Resource is OperationOutcome)
+                            {
+                                result.Response.Outcome = result.Resource;
+                            }
+
                             if (result.Response.Location != null)
                                 result.Resource.ResourceBase = new ResourceIdentity(result.Response.Location).BaseUri;
                         }