[ODS-6067] Handle misconfigured profiles (#907)

Ed-Fi-Alliance-OSS · Jan 17, 2024 · 071d0b4 · 071d0b4
1 parent 3d92970
commit 071d0b4
Show file tree

Hide file tree

Showing 3 changed files with 459 additions and 1 deletion.
diff --git a/Application/EdFi.Ods.Features/Profiles/ProfileContentTypeContextMiddleware.cs b/Application/EdFi.Ods.Features/Profiles/ProfileContentTypeContextMiddleware.cs
@@ -35,6 +35,8 @@ public class ProfileContentTypeContextMiddleware
         "The profile usage segment in the profile-based '{0}' header was not recognized.";
     private const string NonExistingProfileFormat =
         "The profile specified by the content type in the '{0}' header is not supported by this host.";
+    private const string MisconfiguredProfileFormat =
+        "The profile specified by the content type in the '{0}' header is configured but invalid.";
 
     private const int ResourceNameFacet = 0;
     private const int ProfileNameFacet = 1;
@@ -153,9 +155,20 @@ await WriteResponse(
                     return (false, null);
                 }
 
-                // Validate that the Profile exists
+                // Validate that the Profile exists and is valid
                 string profileName = profileContentTypeFacets[ProfileNameFacet].Value;
 
+                if (_profileMetadataProvider.GetValidationResults().Any(x => x.Name.Equals(profileName, StringComparison.OrdinalIgnoreCase)))
+                {
+                    await WriteResponse(
+                        response,
+                        StatusCodes.Status406NotAcceptable,
+                        headerName,
+                        MisconfiguredProfileFormat);
+
+                    return (false, null);
+                }
+
                 if (!_profileMetadataProvider.ProfileDefinitionsByName.ContainsKey(profileName))
                 {
                     await WriteResponse(

diff --git a/Application/EdFi.Ods.Profiles.Test/Profiles.xml b/Application/EdFi.Ods.Profiles.Test/Profiles.xml
@@ -888,4 +888,24 @@
       </WriteContentType>
     </Resource>
   </Profile>
+
+  <!-- Misconfigured Profiles-->
+  <Profile name="Test-Profile-With-Unexisting-Resource">
+    <Resource name="Schools">
+      <ReadContentType memberSelection="IncludeAll" />
+      <WriteContentType memberSelection="IncludeAll" />
+    </Resource>
+  </Profile>
+
+  <Profile name="Test-Profile-With-Unexisting-Property">
+    <Resource name="School">
+      <ReadContentType memberSelection="IncludeOnly">
+        <Property name="NameOfInstitutions" />
+      </ReadContentType>
+      <WriteContentType memberSelection="IncludeOnly">
+        <Property name="ShortNameOfInstitutions" />
+      </WriteContentType>
+    </Resource>
+  </Profile>
+
 </Profiles>