[ODS-5418] Remove DescriptorIds from descriptor resource payloads (#868)

Co-authored-by: Geoffrey McElhanon <[email protected]>
Ed-Fi-Alliance-OSS · Nov 9, 2023 · 9f01dce · 9f01dce
1 parent b72f5bd
commit 9f01dce
Show file tree

Hide file tree

Showing 61 changed files with 2,139 additions and 13,472 deletions.
diff --git a/Application/EdFi.Ods.Api/Container/Modules/ApplicationModule.cs b/Application/EdFi.Ods.Api/Container/Modules/ApplicationModule.cs
@@ -40,6 +40,7 @@
 using EdFi.Ods.Common.IO;
 using EdFi.Ods.Common.Logging;
 using EdFi.Ods.Common.Models;
+using EdFi.Ods.Common.Models.Definitions.Transformers;
 using EdFi.Ods.Common.Models.Domain;
 using EdFi.Ods.Common.Models.Resource;
 using EdFi.Ods.Common.Providers;
@@ -114,6 +115,11 @@ protected override void Load(ContainerBuilder builder)
                 .As<IDomainModelProvider>()
                 .SingleInstance();
 
+            // Domain model transformers
+            builder.RegisterType<PriorDescriptorIdRemover>()
+                .As<IDomainModelDefinitionsTransformer>()
+                .SingleInstance();
+
             // Schemas
             builder.Register(c => c.Resolve<IDomainModelProvider>().GetDomainModel().Schemas.ToArray())
                 .As<Schema[]>()

diff --git a/Application/EdFi.Ods.Common/Extensions/ResourceExtensions.cs b/Application/EdFi.Ods.Common/Extensions/ResourceExtensions.cs
@@ -99,7 +99,9 @@ public static IEnumerable<ResourceProperty> NonReferencedProperties(this Resourc
                                     .ToHashSet();
 
             return resourceClassBase.AllProperties
-                                    .Where(p => (p.IsUnified() && p.IsLocallyDefined && !p.PropertyType.IsNullable) || !propertiesOfReferences.Contains(p.PropertyName));
+                .Where(p => (p.IsUnified() && p.IsLocallyDefined && !p.PropertyType.IsNullable)
+                    || !propertiesOfReferences.Contains(p.PropertyName))
+                .Where(p => !p.JsonIgnore);
         }
 
         /// <summary>

diff --git a/...els/IDomainModelDefinitionsTransformer.cs → ...ers/IDomainModelDefinitionsTransformer.cs b/...els/IDomainModelDefinitionsTransformer.cs → ...ers/IDomainModelDefinitionsTransformer.cs
@@ -4,9 +4,8 @@
 // See the LICENSE and NOTICES files in the project root for more information.
 
 using System.Collections.Generic;
-using EdFi.Ods.Common.Models.Definitions;
 
-namespace EdFi.Ods.Common.Models
+namespace EdFi.Ods.Common.Models.Definitions.Transformers
 {
     public interface IDomainModelDefinitionsTransformer
     {

diff --git a/Application/EdFi.Ods.Common/Models/Definitions/Transformers/PriorDescriptorIdRemover.cs b/Application/EdFi.Ods.Common/Models/Definitions/Transformers/PriorDescriptorIdRemover.cs
@@ -0,0 +1,40 @@
+// SPDX-License-Identifier: Apache-2.0
+// Licensed to the Ed-Fi Alliance under one or more agreements.
+// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0.
+// See the LICENSE and NOTICES files in the project root for more information.
+
+using System.Collections.Generic;
+using System.Linq;
+using EdFi.Ods.Common.Conventions;
+using EdFi.Ods.Common.Models.Domain;
+
+namespace EdFi.Ods.Common.Models.Definitions.Transformers;
+
+/// <summary>
+/// Implements a transformer that removes the PriorDescriptorId property from the edfi.Descriptor entity's definition
+/// to prevent any artifacts from being generated or rendered for it. This class should be removed once the property
+/// has been removed from the source ApiModel.json file generated by MetaEd.
+/// </summary>
+public class PriorDescriptorIdRemover : IDomainModelDefinitionsTransformer
+{
+    public IEnumerable<DomainModelDefinitions> TransformDefinitions(IEnumerable<DomainModelDefinitions> definitions)
+    {
+        foreach (DomainModelDefinitions domainModelDefinitions in definitions)
+        {
+            // Look for the edfi.Descriptor entity definition
+            var entityDefinition = domainModelDefinitions.EntityDefinitions?.FirstOrDefault(
+                ed => new FullName(ed.Schema, ed.Name) == EdFiConventions.DescriptorFullName);
+
+            if (entityDefinition != null)
+            {
+                // Remove the PriorDescriptorId property
+                entityDefinition.LocallyDefinedProperties =
+                    entityDefinition.LocallyDefinedProperties
+                        .Where(p => p.PropertyName != "PriorDescriptorId")
+                        .ToArray();
+            }
+
+            yield return domainModelDefinitions;
+        }
+    }
+}
diff --git a/Application/EdFi.Ods.Common/Models/Domain/DomainModelProvider.cs b/Application/EdFi.Ods.Common/Models/Domain/DomainModelProvider.cs
@@ -7,6 +7,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using EdFi.Ods.Common.Models.Definitions;
+using EdFi.Ods.Common.Models.Definitions.Transformers;
 
 namespace EdFi.Ods.Common.Models.Domain
 {

diff --git a/Application/EdFi.Ods.Common/Models/Resource/ResourceProperty.cs b/Application/EdFi.Ods.Common/Models/Resource/ResourceProperty.cs
@@ -73,6 +73,9 @@ public ResourceProperty(ResourceMemberBase containingMember, ResourceClassBase r
                     && entityProperty.Entity.IsPersonEntity()
                     && UniqueIdConventions.IsUniqueId(entityProperty.PropertyName, entityProperty.Entity.Name));
 
+            // Concrete DescriptorId properties should not be exposed over JSON or API metadata
+            JsonIgnore = entityProperty.Entity.IsDescriptorEntity && entityProperty.IsIdentifying;
+
             IsLocallyDefined = entityProperty.IsLocallyDefined;
             IsServerAssigned = entityProperty.IsServerAssigned;
 
@@ -276,6 +279,12 @@ private bool IsUsiWithTransformedResourcePropertyName(EntityProperty property)
                     && property.DefiningProperty.Entity.IsPersonEntity();
         }
 
+        /// <summary>
+        /// Indicates whether the property should be excluded from the JSON representation of the resource
+        /// and corresponding Open API metadata.
+        /// </summary>
+        public bool JsonIgnore { get; }
+
         /// <inheritdoc cref="ResourceMemberBase.JsonPath" />
         public override string JsonPath
         {

diff --git a/Application/EdFi.Ods.Tests/EdFi.Ods.Common/Conventions/ExtensionsConventionsTests.cs b/Application/EdFi.Ods.Tests/EdFi.Ods.Common/Conventions/ExtensionsConventionsTests.cs
@@ -10,6 +10,7 @@
 using EdFi.Ods.Common;
 using EdFi.Ods.Common.Conventions;
 using EdFi.Ods.Common.Models;
+using EdFi.Ods.Common.Models.Definitions.Transformers;
 using EdFi.Ods.Common.Models.Domain;
 using EdFi.Ods.Tests.TestExtension;
 using EdFi.TestFixture;

diff --git a/Application/EdFi.Ods.Tests/EdFi.Ods.Common/Models/Domain/DomainModelTests.cs b/Application/EdFi.Ods.Tests/EdFi.Ods.Common/Models/Domain/DomainModelTests.cs
@@ -8,6 +8,7 @@
 using System.Linq;
 using EdFi.Ods.Common.Models;
 using EdFi.Ods.Common.Models.Definitions;
+using EdFi.Ods.Common.Models.Definitions.Transformers;
 using EdFi.Ods.Common.Models.Domain;
 using EdFi.Ods.Tests.TestExtension;
 using EdFi.TestFixture;

diff --git a/Application/EdFi.Ods.Tests/EdFi.Ods.Common/Models/Resource/FilterContextTests.cs b/Application/EdFi.Ods.Tests/EdFi.Ods.Common/Models/Resource/FilterContextTests.cs
@@ -14,6 +14,7 @@
 using EdFi.Ods.Common.Extensions;
 using EdFi.Ods.Common.Models;
 using EdFi.Ods.Common.Models.Definitions;
+using EdFi.Ods.Common.Models.Definitions.Transformers;
 using EdFi.Ods.Common.Models.Domain;
 using EdFi.Ods.Common.Models.Resource;
 using EdFi.TestFixture;

diff --git a/...Fi.Ods.Tests/EdFi.Ods.Common/Models/Resource/ProfileResourceMembersFilterProviderTests.cs b/...Fi.Ods.Tests/EdFi.Ods.Common/Models/Resource/ProfileResourceMembersFilterProviderTests.cs
@@ -11,6 +11,7 @@
 using System.Xml.Linq;
 using EdFi.Ods.Common.Models;
 using EdFi.Ods.Common.Models.Definitions;
+using EdFi.Ods.Common.Models.Definitions.Transformers;
 using EdFi.Ods.Common.Models.Domain;
 using EdFi.Ods.Common.Models.Resource;
 using EdFi.Ods.Common.Models.Validation;

diff --git a/Application/EdFi.Ods.Tests/EdFi.Ods.Common/Models/Resource/ProfileResourceModelTests.cs b/Application/EdFi.Ods.Tests/EdFi.Ods.Common/Models/Resource/ProfileResourceModelTests.cs
@@ -11,6 +11,7 @@
 using System.Xml.Linq;
 using EdFi.Ods.Common.Models;
 using EdFi.Ods.Common.Models.Definitions;
+using EdFi.Ods.Common.Models.Definitions.Transformers;
 using EdFi.Ods.Common.Models.Domain;
 using EdFi.Ods.Common.Models.Resource;
 using EdFi.Ods.Common.Models.Validation;

diff --git a/Application/EdFi.Ods.Tests/EdFi.Ods.Common/Models/Resource/ResourceTests.cs b/Application/EdFi.Ods.Tests/EdFi.Ods.Common/Models/Resource/ResourceTests.cs
@@ -10,6 +10,7 @@
 using EdFi.Ods.Common.Conventions;
 using EdFi.Ods.Common.Models;
 using EdFi.Ods.Common.Models.Definitions;
+using EdFi.Ods.Common.Models.Definitions.Transformers;
 using EdFi.Ods.Common.Models.Domain;
 using EdFi.Ods.Common.Models.Resource;
 using EdFi.TestFixture;

diff --git a/Application/EdFi.Ods.Tests/EdFi.Ods.Common/SchemaNameMapProviderTests.cs b/Application/EdFi.Ods.Tests/EdFi.Ods.Common/SchemaNameMapProviderTests.cs
@@ -7,6 +7,7 @@
 using EdFi.Ods.Common;
 using EdFi.Ods.Common.Models;
 using EdFi.Ods.Common.Models.Definitions;
+using EdFi.Ods.Common.Models.Definitions.Transformers;
 using EdFi.Ods.Common.Models.Domain;
 using EdFi.Ods.Tests._Extensions;
 using EdFi.TestFixture;

diff --git a/Application/Test.Common/DomainModelDefinitionsProviderHelper.cs b/Application/Test.Common/DomainModelDefinitionsProviderHelper.cs
@@ -9,6 +9,7 @@
 using EdFi.Ods.Common;
 using EdFi.Ods.Common.Models;
 using EdFi.Ods.Common.Models.Definitions;
+using EdFi.Ods.Common.Models.Definitions.Transformers;
 using EdFi.Ods.Common.Models.Domain;
 using EdFi.Ods.Common.Models.Resource;
 using EdFi.Ods.Features.OpenApiMetadata.Dtos;

diff --git a/...s.Verify.Extensions.Sample.1.0.0_Std_4.0.0_Models_Entities_Entities.generated.approved.cs b/...s.Verify.Extensions.Sample.1.0.0_Std_4.0.0_Models_Entities_Entities.generated.approved.cs
@@ -77,11 +77,6 @@ string IDescriptor.Namespace
             get { return Namespace; }
             set { Namespace = value; }
         }
-        int? IDescriptor.PriorDescriptorId
-        {
-            get { return PriorDescriptorId; }
-            set { PriorDescriptorId = value; }
-        }
         string IDescriptor.ShortDescription
         {
             get { return ShortDescription; }
@@ -2060,11 +2055,6 @@ string IDescriptor.Namespace
             get { return Namespace; }
             set { Namespace = value; }
         }
-        int? IDescriptor.PriorDescriptorId
-        {
-            get { return PriorDescriptorId; }
-            set { PriorDescriptorId = value; }
-        }
         string IDescriptor.ShortDescription
         {
             get { return ShortDescription; }
@@ -2244,11 +2234,6 @@ string IDescriptor.Namespace
             get { return Namespace; }
             set { Namespace = value; }
         }
-        int? IDescriptor.PriorDescriptorId
-        {
-            get { return PriorDescriptorId; }
-            set { PriorDescriptorId = value; }
-        }
         string IDescriptor.ShortDescription
         {
             get { return ShortDescription; }

diff --git a/...xtensions.Sample.1.0.0_Std_4.0.0_Models_Interfaces_EntityInterfaces.generated.approved.cs b/...xtensions.Sample.1.0.0_Std_4.0.0_Models_Interfaces_EntityInterfaces.generated.approved.cs
@@ -43,7 +43,6 @@ public ArtMediumDescriptorMappingContract(
             bool isEffectiveBeginDateSupported,
             bool isEffectiveEndDateSupported,
             bool isNamespaceSupported,
-            bool isPriorDescriptorIdSupported,
             bool isShortDescriptionSupported
             )
         {
@@ -52,7 +51,6 @@ bool isShortDescriptionSupported
             IsEffectiveBeginDateSupported = isEffectiveBeginDateSupported;
             IsEffectiveEndDateSupported = isEffectiveEndDateSupported;
             IsNamespaceSupported = isNamespaceSupported;
-            IsPriorDescriptorIdSupported = isPriorDescriptorIdSupported;
             IsShortDescriptionSupported = isShortDescriptionSupported;
         }
 
@@ -61,7 +59,6 @@ bool isShortDescriptionSupported
         public bool IsEffectiveBeginDateSupported { get; }
         public bool IsEffectiveEndDateSupported { get; }
         public bool IsNamespaceSupported { get; }
-        public bool IsPriorDescriptorIdSupported { get; }
         public bool IsShortDescriptionSupported { get; }
 
         bool IMappingContract.IsMemberSupported(string memberName)
@@ -78,8 +75,6 @@ bool IMappingContract.IsMemberSupported(string memberName)
                     return IsEffectiveEndDateSupported;
                 case "Namespace":
                     return IsNamespaceSupported;
-                case "PriorDescriptorId":
-                    return IsPriorDescriptorIdSupported;
                 case "ShortDescription":
                     return IsShortDescriptionSupported;
                 default:
@@ -575,7 +570,6 @@ public FavoriteBookCategoryDescriptorMappingContract(
             bool isEffectiveBeginDateSupported,
             bool isEffectiveEndDateSupported,
             bool isNamespaceSupported,
-            bool isPriorDescriptorIdSupported,
             bool isShortDescriptionSupported
             )
         {
@@ -584,7 +578,6 @@ bool isShortDescriptionSupported
             IsEffectiveBeginDateSupported = isEffectiveBeginDateSupported;
             IsEffectiveEndDateSupported = isEffectiveEndDateSupported;
             IsNamespaceSupported = isNamespaceSupported;
-            IsPriorDescriptorIdSupported = isPriorDescriptorIdSupported;
             IsShortDescriptionSupported = isShortDescriptionSupported;
         }
 
@@ -593,7 +586,6 @@ bool isShortDescriptionSupported
         public bool IsEffectiveBeginDateSupported { get; }
         public bool IsEffectiveEndDateSupported { get; }
         public bool IsNamespaceSupported { get; }
-        public bool IsPriorDescriptorIdSupported { get; }
         public bool IsShortDescriptionSupported { get; }
 
         bool IMappingContract.IsMemberSupported(string memberName)
@@ -610,8 +602,6 @@ bool IMappingContract.IsMemberSupported(string memberName)
                     return IsEffectiveEndDateSupported;
                 case "Namespace":
                     return IsNamespaceSupported;
-                case "PriorDescriptorId":
-                    return IsPriorDescriptorIdSupported;
                 case "ShortDescription":
                     return IsShortDescriptionSupported;
                 default:
@@ -651,7 +641,6 @@ public MembershipTypeDescriptorMappingContract(
             bool isEffectiveBeginDateSupported,
             bool isEffectiveEndDateSupported,
             bool isNamespaceSupported,
-            bool isPriorDescriptorIdSupported,
             bool isShortDescriptionSupported
             )
         {
@@ -660,7 +649,6 @@ bool isShortDescriptionSupported
             IsEffectiveBeginDateSupported = isEffectiveBeginDateSupported;
             IsEffectiveEndDateSupported = isEffectiveEndDateSupported;
             IsNamespaceSupported = isNamespaceSupported;
-            IsPriorDescriptorIdSupported = isPriorDescriptorIdSupported;
             IsShortDescriptionSupported = isShortDescriptionSupported;
         }
 
@@ -669,7 +657,6 @@ bool isShortDescriptionSupported
         public bool IsEffectiveBeginDateSupported { get; }
         public bool IsEffectiveEndDateSupported { get; }
         public bool IsNamespaceSupported { get; }
-        public bool IsPriorDescriptorIdSupported { get; }
         public bool IsShortDescriptionSupported { get; }
 
         bool IMappingContract.IsMemberSupported(string memberName)
@@ -686,8 +673,6 @@ bool IMappingContract.IsMemberSupported(string memberName)
                     return IsEffectiveEndDateSupported;
                 case "Namespace":
                     return IsNamespaceSupported;
-                case "PriorDescriptorId":
-                    return IsPriorDescriptorIdSupported;
                 case "ShortDescription":
                     return IsShortDescriptionSupported;
                 default: