Merge pull request #2886 from FirelyTeam/feature/1814-remove-all-non-…

…inheritable-extensions-from-base Remove all non-inheritable extensions from the base profile before snapshotting
FirelyTeam · Oct 23, 2024 · bbf6526 · bbf6526
2 parents a4230b7 + 16c9577
commit bbf6526
Show file tree

Hide file tree

Showing 8 changed files with 122 additions and 129 deletions.
diff --git a/...n/Snapshot/SnapshotGeneratorExtensions.cs → ...n/Snapshot/SnapshotGeneratorExtensions.cs b/...n/Snapshot/SnapshotGeneratorExtensions.cs → ...n/Snapshot/SnapshotGeneratorExtensions.cs
@@ -7,7 +7,7 @@
  */
 
 using Hl7.Fhir.Model;
-using Hl7.Fhir.Support;
+using Hl7.Fhir.Rest;
 using Hl7.Fhir.Utility;
 using System;
 using System.Collections.Generic;
@@ -19,7 +19,7 @@ namespace Hl7.Fhir.Specification.Snapshot
     // This extension indicates snapshot elements with associated differential constraints in the profile.
     // Note: extensions are persisted to XML/JSON, whereas annotations are ephemeral (in-memory only)
 
-    /// <summary>Helper methods for the <see cref="SnapshotGenerator"/> class to generate and inspect custom extensions.</summary>
+    /// <summary>Helper methods for the SnapshotGenerator class to generate and inspect custom extensions.</summary>
     public static class SnapshotGeneratorExtensions
     {
         /// <summary>The canonical url of the extension definition that marks snapshot elements with associated differential constraints.</summary>
@@ -54,6 +54,7 @@ public static void RemoveConstrainedByDiffExtension(this IExtendable element)
         }
 
         /// <summary>Recursively removes all instances of the <see cref="CONSTRAINED_BY_DIFF_EXT"/> extension from the specified element definition and all it's child objects.</summary>
+        [Obsolete("Use RemoveAllNonInheritableExtensions(this Element element) instead.")]
         public static void RemoveAllConstrainedByDiffExtensions(this Element element)
         {
             if (element == null) { throw Error.ArgumentNull(nameof(element)); }
@@ -65,6 +66,7 @@ public static void RemoveAllConstrainedByDiffExtensions(this Element element)
         }
 
         /// <summary>Recursively removes all instances of the <see cref="CONSTRAINED_BY_DIFF_EXT"/> extension from all the elements and their respective child objects.</summary>
+        [Obsolete("Use RemoveAllNonInheritableExtensions(this IEnumerable<T> elements) instead.")]
         public static void RemoveAllConstrainedByDiffExtensions<T>(this IEnumerable<T> elements) where T : Element
         {
             if (elements == null) { throw Error.ArgumentNull(nameof(elements)); }
@@ -74,6 +76,47 @@ public static void RemoveAllConstrainedByDiffExtensions<T>(this IEnumerable<T> e
             }
         }
 
+
+        internal static void RemoveAllNonInheritableExtensions(this Element element)
+        {
+            if (element == null) { throw Error.ArgumentNull(nameof(element)); }
+            element.RemoveNonInheritableExtensions();
+            foreach (var child in element.Children.OfType<Element>())
+            {
+                child.RemoveAllNonInheritableExtensions();
+            }
+        }
+
+        internal static void RemoveNonInheritableExtensions(this IExtendable element)
+        {
+            if (element == null) { throw Error.ArgumentNull(nameof(element)); }
+            foreach (var ext in _nonInheritableExtensions)
+            {
+                element.RemoveExtension(ext);
+            }
+        }
+
+        private static readonly List<string> _nonInheritableExtensions = [
+         ResourceIdentity.CORE_BASE_URL + "elementdefinition-isCommonBinding",
+         ResourceIdentity.CORE_BASE_URL + "structuredefinition-fmm",
+         ResourceIdentity.CORE_BASE_URL + "structuredefinition-fmm-no-warnings",
+         ResourceIdentity.CORE_BASE_URL + "structuredefinition-hierarchy",
+         ResourceIdentity.CORE_BASE_URL + "structuredefinition-interface",
+         ResourceIdentity.CORE_BASE_URL + "structuredefinition-normative-version",
+         ResourceIdentity.CORE_BASE_URL + "structuredefinition-applicable-version",
+         ResourceIdentity.CORE_BASE_URL + "structuredefinition-category",
+         ResourceIdentity.CORE_BASE_URL + "structuredefinition-codegen-super",
+         ResourceIdentity.CORE_BASE_URL + "structuredefinition-security-category",
+         ResourceIdentity.CORE_BASE_URL + "structuredefinition-standards-status",
+         ResourceIdentity.CORE_BASE_URL + "structuredefinition-summary",
+         ResourceIdentity.CORE_BASE_URL + "structuredefinition-wg",
+         ResourceIdentity.CORE_BASE_URL + "replaces",
+         ResourceIdentity.CORE_BASE_URL + "resource-approvalDate",
+         ResourceIdentity.CORE_BASE_URL + "resource-effectivePeriod",
+         ResourceIdentity.CORE_BASE_URL + "resource-lastReviewDate",
+         CONSTRAINED_BY_DIFF_EXT //this is our own extension to define differences compared to the base, this can't be inherited from the base profile
+        ];
+
         // ========== For internal use only ==========
         // [WMR 20170209] OBSOLETE
 #if false

diff --git a/src/Hl7.Fhir.Conformance/CompatibilitySuppressions.xml b/src/Hl7.Fhir.Conformance/CompatibilitySuppressions.xml
@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- https://learn.microsoft.com/en-us/dotnet/fundamentals/package-validation/diagnostic-ids -->
+<Suppressions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+  <Suppression>
+    <DiagnosticId>CP0001</DiagnosticId>
+    <Target>T:Hl7.Fhir.Specification.Snapshot.SnapshotGeneratorExtensions</Target>
+    <Left>lib/net8.0/Hl7.Fhir.Conformance.dll</Left>
+    <Right>lib/net8.0/Hl7.Fhir.Conformance.dll</Right>
+    <IsBaselineSuppression>true</IsBaselineSuppression>
+  </Suppression>
+  <Suppression>
+    <DiagnosticId>CP0001</DiagnosticId>
+    <Target>T:Hl7.Fhir.Specification.Snapshot.SnapshotGeneratorExtensions</Target>
+    <Left>lib/netstandard2.0/Hl7.Fhir.Conformance.dll</Left>
+    <Right>lib/netstandard2.0/Hl7.Fhir.Conformance.dll</Right>
+    <IsBaselineSuppression>true</IsBaselineSuppression>
+  </Suppression>
+</Suppressions>
diff --git a/src/Hl7.Fhir.Conformance/Specification/Snapshot/SnapshotGenerator.cs b/src/Hl7.Fhir.Conformance/Specification/Snapshot/SnapshotGenerator.cs
@@ -465,7 +465,7 @@ private async Tasks.Task<List<ElementDefinition>> generate(StructureDefinition s
 
                 // [WMR 20170208] Moved to *AFTER* ensureBaseComponents - emits annotations...
                 // [WMR 20160915] Derived profiles should never inherit the ChangedByDiff extension from the base structure
-                snapshot.Element.RemoveAllConstrainedByDiffExtensions();
+                snapshot.RemoveAllNonInheritableExtensions();
                 snapshot.Element.RemoveAllConstrainedByDiffAnnotations();
 
                 // Notify observers
@@ -1487,7 +1487,7 @@ private static bool copyChildren(ElementDefinitionNavigator nav, ElementDefiniti
                     var elem = elems[pos];
 
                     // [WMR 20160826] Never inherit Changed extension from base profile!
-                    elem.RemoveAllConstrainedByDiffExtensions();
+                    elem.RemoveAllNonInheritableExtensions();
                     elem.RemoveAllConstrainedByDiffAnnotations();
 
                     // [WMR 20160902] Initialize empty ElementDefinition.Base components if necessary

diff --git a/src/Hl7.Fhir.STU3/CompatibilitySuppressions.xml b/src/Hl7.Fhir.STU3/CompatibilitySuppressions.xml
@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- https://learn.microsoft.com/en-us/dotnet/fundamentals/package-validation/diagnostic-ids -->
+<Suppressions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+  <Suppression>
+    <DiagnosticId>CP0001</DiagnosticId>
+    <Target>T:Hl7.Fhir.Specification.Snapshot.SnapshotGeneratorExtensions</Target>
+    <Left>lib/net8.0/Hl7.Fhir.STU3.dll</Left>
+    <Right>lib/net8.0/Hl7.Fhir.STU3.dll</Right>
+    <IsBaselineSuppression>true</IsBaselineSuppression>
+  </Suppression>
+  <Suppression>
+    <DiagnosticId>CP0001</DiagnosticId>
+    <Target>T:Hl7.Fhir.Specification.Snapshot.SnapshotGeneratorExtensions</Target>
+    <Left>lib/netstandard2.0/Hl7.Fhir.STU3.dll</Left>
+    <Right>lib/netstandard2.0/Hl7.Fhir.STU3.dll</Right>
+    <IsBaselineSuppression>true</IsBaselineSuppression>
+  </Suppression>
+</Suppressions>
diff --git a/src/Hl7.Fhir.STU3/Specification/Snapshot/SnapshotGenerator.cs b/src/Hl7.Fhir.STU3/Specification/Snapshot/SnapshotGenerator.cs
@@ -399,7 +399,8 @@ private async Tasks.Task<List<ElementDefinition>> generate(StructureDefinition s
 
                 // [WMR 20170208] Moved to *AFTER* ensureBaseComponents - emits annotations...
                 // [WMR 20160915] Derived profiles should never inherit the ChangedByDiff extension from the base structure
-                snapshot.Element.RemoveAllConstrainedByDiffExtensions();
+                // Also remove core extensions that are not supposed to be inherited by derived profiles
+                snapshot.RemoveAllNonInheritableExtensions();
                 snapshot.Element.RemoveAllConstrainedByDiffAnnotations();
 
                 // Notify observers
@@ -1309,7 +1310,7 @@ private static bool copyChildren(ElementDefinitionNavigator nav, ElementDefiniti
                     var elem = elems[pos];
 
                     // [WMR 20160826] Never inherit Changed extension from base profile!
-                    elem.RemoveAllConstrainedByDiffExtensions();
+                    elem.RemoveAllNonInheritableExtensions();
                     elem.RemoveAllConstrainedByDiffAnnotations();
 
                     // [WMR 20160902] Initialize empty ElementDefinition.Base components if necessary

diff --git a/src/Hl7.Fhir.STU3/Specification/Snapshot/SnapshotGeneratorExtensions.cs b/src/Hl7.Fhir.STU3/Specification/Snapshot/SnapshotGeneratorExtensions.cs
diff --git a/src/Hl7.Fhir.Specification.STU3.Tests/Snapshot/SnapshotGeneratorTest.cs b/src/Hl7.Fhir.Specification.STU3.Tests/Snapshot/SnapshotGeneratorTest.cs
@@ -21,8 +21,8 @@
 using Hl7.Fhir.Support;
 using Hl7.Fhir.Utility;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
-using System;
 using NSubstitute;
+using System;
 using System.Collections.Generic;
 using System.Diagnostics;
 using System.IO;
@@ -2433,8 +2433,8 @@ private static bool isAlmostExactly(ElementDefinition elem, ElementDefinition ba
             }
 
             // Also ignore any Changed extensions on base and diff
-            elemClone.RemoveAllConstrainedByDiffExtensions();
-            baseClone.RemoveAllConstrainedByDiffExtensions();
+            elemClone.RemoveAllNonInheritableExtensions();
+            baseClone.RemoveAllNonInheritableExtensions();
             elemClone.RemoveAllConstrainedByDiffAnnotations();
             baseClone.RemoveAllConstrainedByDiffAnnotations();
 

diff --git a/src/Hl7.Fhir.Specification.Shared.Tests/Snapshot/SnapshotGeneratorTest.cs b/src/Hl7.Fhir.Specification.Shared.Tests/Snapshot/SnapshotGeneratorTest.cs
@@ -2562,8 +2562,8 @@ private static bool isAlmostExactly(ElementDefinition elem, ElementDefinition ba
             }
 
             // Also ignore any Changed extensions on base and diff
-            elemClone.RemoveAllConstrainedByDiffExtensions();
-            baseClone.RemoveAllConstrainedByDiffExtensions();
+            elemClone.RemoveAllNonInheritableExtensions();
+            baseClone.RemoveAllNonInheritableExtensions();
             elemClone.RemoveAllConstrainedByDiffAnnotations();
             baseClone.RemoveAllConstrainedByDiffAnnotations();
 
@@ -10155,6 +10155,37 @@ private StructureDefinition createVeryNestedExtension()
         }
 
 
+        [TestMethod]
+        public void RemoveNonInhertitableSnapshotsTest()
+        {
+            var profile = new StructureDefinition
+            {
+                Url = "http://fire.ly/StructureDefinition/example",
+                Snapshot = new()
+                {
+                    Element = new() {
+                        new("Example")
+                        {
+                            Binding = new()
+                            {
+                                Strength = BindingStrength.Required,
+                                ValueSet = "http://fire.ly/ValueSet/example"
+                            }
+                        },
+                    }
+                }
+            };
+
+            profile.Snapshot.Element[0].AddExtension(ResourceIdentity.CORE_BASE_URL + "structuredefinition-hierarchy", new FhirString("foo"));
+            profile.Snapshot.Element[0].Binding.AddExtension(ResourceIdentity.CORE_BASE_URL + "elementdefinition-isCommonBinding", new FhirBoolean(true));
+
+            profile.Snapshot.RemoveAllNonInheritableExtensions();
+
+            profile.Snapshot.Element[0].Extension.Should().BeEmpty();
+            profile.Snapshot.Element[0].Binding.Extension.Should().BeEmpty();
+        }
+
+
         [TestMethod]
         public async Tasks.Task TestNewR5Elements()
         {