[ODS-4799] Introduce resource POST/Retry order in dependency endpoint

Application/EdFi.Ods.Api/Models/GraphML/GraphMLEdge.cs

@@ -3,19 +3,71 @@
 // 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;
+using EdFi.Ods.Common.Models.Domain;
+using QuickGraph;
+
 namespace EdFi.Ods.Api.Models.GraphML
 {
     // ReSharper disable once InconsistentNaming
-    public class GraphMLEdge
+    public class GraphMLEdge : IEquatable<GraphMLEdge>, IEdge<GraphMLNode>
     {
-        public GraphMLEdge(string source, string target)
+        public GraphMLEdge(GraphMLNode source, GraphMLNode target)
         {
             Source = source;
             Target = target;
         }
 
-        public string Source { get; }
+        public GraphMLEdge(GraphMLNode source, GraphMLNode target, AssociationView edgeAssociationView)
+            : this(source, target)
+        {
+            AssociationView = edgeAssociationView;
+        }
+
+        public AssociationView AssociationView { get; }
+
+        public GraphMLNode Source { get; }
+
+        public GraphMLNode Target { get; }
+
+        #region Equality members
+        public bool Equals(GraphMLEdge other)
+        {
+            if (other is null)
+            {
+                return false;
+            }
+
+            if (ReferenceEquals(this, other))
+            {
+                return true;
+            }
+
+            return Source.Id == other.Source.Id && Target.Id == other.Target.Id;
+        }
+
+        public override bool Equals(object obj)
+        {
+            if (obj is null)
+            {
+                return false;
+            }
+
+            if (ReferenceEquals(this, obj))
+            {
+                return true;
+            }
+
+            if (obj.GetType() != GetType())
+            {
+                return false;
+            }
+
+            return Equals((GraphMLEdge)obj);
+        }
 
-        public string Target { get; }
+        public override int GetHashCode() => HashCode.Combine(Source, Target);
+
+        #endregion
     }
 }

Application/EdFi.Ods.Api/Models/GraphML/GraphMLNode.cs

@@ -3,11 +3,99 @@
 // 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;
+
 namespace EdFi.Ods.Api.Models.GraphML
 {
     // ReSharper disable once InconsistentNaming
-    public class GraphMLNode
+    public class GraphMLNode : IEquatable<GraphMLNode>, IComparable<GraphMLNode>, IComparable
     {
+        public GraphMLNode() { }
+
+        public GraphMLNode(string id)
+        {
+            Id = id;
+        }
+
         public string Id { get; set; }
+
+        public override string ToString() => Id;
+
+        #region Equality members
+
+        public bool Equals(GraphMLNode other)
+        {
+            if (other is null)
+            {
+                return false;
+            }
+
+            if (ReferenceEquals(this, other))
+            {
+                return true;
+            }
+
+            return Id == other.Id;
+        }
+
+        public override bool Equals(object obj)
+        {
+            if (obj is null)
+            {
+                return false;
+            }
+
+            if (ReferenceEquals(this, obj))
+            {
+                return true;
+            }
+
+            if (obj.GetType() != GetType())
+            {
+                return false;
+            }
+
+            return Equals((GraphMLNode)obj);
+        }
+
+        public override int GetHashCode() => (Id != null
+            ? Id.GetHashCode()
+            : 0);
+
+        #endregion
+
+        #region Comparable members
+        public int CompareTo(GraphMLNode other)
+        {
+            if (ReferenceEquals(this, other))
+            {
+                return 0;
+            }
+
+            if (other is null)
+            {
+                return 1;
+            }
+
+            return string.Compare(Id, other.Id, StringComparison.OrdinalIgnoreCase);
+        }
+
+        public int CompareTo(object obj)
+        {
+            if (obj is null)
+            {
+                return 1;
+            }
+
+            if (ReferenceEquals(this, obj))
+            {
+                return 0;
+            }
+
+            return obj is GraphMLNode other
+                ? CompareTo(other)
+                : throw new ArgumentException($"Object must be of type {nameof(GraphMLNode)}");
+        }
+        #endregion
     }
 }

Application/EdFi.Ods.Api/Security/Authorization/PersonResourceGraphAuthorizationTransformer.cs

@@ -6,7 +6,6 @@
 using System.Linq;
 using EdFi.Ods.Common.Conventions;
 using EdFi.Ods.Common.Exceptions;
-using EdFi.Ods.Common.Extensions;
 using EdFi.Ods.Common.Models.Domain;
 using EdFi.Ods.Common.Models.Graphs;
 using EdFi.Ods.Common.Models.Resource;
@@ -36,15 +35,13 @@ private void ApplyStaffTransformation(BidirectionalGraph<Resource, AssociationVi
             var staffResource =
                 resources.FirstOrDefault(x => x.FullName == new FullName(EdFiConventions.PhysicalSchemaName, "Staff"));
 
-            var staffEdOrgEmployAssoc =
-                resources.FirstOrDefault(
-                    x => x.FullName == new FullName(
-                        EdFiConventions.PhysicalSchemaName, "StaffEducationOrganizationEmploymentAssociation"));
+            var staffEdOrgEmployAssoc = resources.FirstOrDefault(
+                x => x.FullName
+                    == new FullName(EdFiConventions.PhysicalSchemaName, "StaffEducationOrganizationEmploymentAssociation"));
 
-            var staffEdOrgAssignAssoc =
-                resources.FirstOrDefault(
-                    x => x.FullName == new FullName(
-                        EdFiConventions.PhysicalSchemaName, "StaffEducationOrganizationAssignmentAssociation"));
+            var staffEdOrgAssignAssoc = resources.FirstOrDefault(
+                x => x.FullName
+                    == new FullName(EdFiConventions.PhysicalSchemaName, "StaffEducationOrganizationAssignmentAssociation"));
 
             // No staff entity in the graph, nothing to do.
             if (staffResource == null)
@@ -78,18 +75,16 @@ private void ApplyStaffTransformation(BidirectionalGraph<Resource, AssociationVi
 
                 resourceGraph.AddEdge(
                     new AssociationViewEdge(
-                        staffEdOrgAssignAssoc, directStaffDependency.Target, directStaffDependency.AssociationView));
+                        staffEdOrgAssignAssoc,
+                        directStaffDependency.Target,
+                        directStaffDependency.AssociationView));
 
                 resourceGraph.AddEdge(
                     new AssociationViewEdge(
-                        staffEdOrgEmployAssoc, directStaffDependency.Target, directStaffDependency.AssociationView));
+                        staffEdOrgEmployAssoc,
+                        directStaffDependency.Target,
+                        directStaffDependency.AssociationView));
             }
-
-            // Add StaffEducationOrganizationAssignmentAssociations/#POSTRetry node for Staff resource
-            AddPostRetryVertexForResource(resourceGraph, staffEdOrgAssignAssoc, staffResource);
-
-            // Add StaffEducationOrganizationEmploymentAssociations/#POSTRetry node for Staff resource
-            AddPostRetryVertexForResource(resourceGraph, staffEdOrgEmployAssoc, staffResource);
         }
 
         private static void ApplyStudentTransformation(BidirectionalGraph<Resource, AssociationViewEdge> resourceGraph)
@@ -131,21 +126,18 @@ private static void ApplyStudentTransformation(BidirectionalGraph<Resource, Asso
 
                 resourceGraph.AddEdge(
                     new AssociationViewEdge(
-                        studentSchoolAssociationResource, directStudentDependency.Target,
+                        studentSchoolAssociationResource,
+                        directStudentDependency.Target,
                         directStudentDependency.AssociationView));
             }
-
-            // Add a StudentSchoolAssociation/#POSTRetry node for Student resource
-            AddPostRetryVertexForResource(resourceGraph, studentSchoolAssociationResource, studentResource);
         }
 
         private void ApplyContactTransformation(BidirectionalGraph<Resource, AssociationViewEdge> resourceGraph)
         {
             var resources = resourceGraph.Vertices.ToList();
 
             var contactResource = resources.FirstOrDefault(
-                x =>
-                    x.FullName == new FullName(EdFiConventions.PhysicalSchemaName, "Contact")
+                x => x.FullName == new FullName(EdFiConventions.PhysicalSchemaName, "Contact")
                     || x.FullName == new FullName(EdFiConventions.PhysicalSchemaName, "Parent"));
 
             // No entity named Parent or Contact in the graph, nothing to do.
@@ -190,13 +182,11 @@ private void ApplyContactTransformation(BidirectionalGraph<Resource, Association
 
                 resourceGraph.AddEdge(
                     new AssociationViewEdge(
-                        studentContactAssociationResource, directContactDependency.Target,
+                        studentContactAssociationResource,
+                        directContactDependency.Target,
                         directContactDependency.AssociationView));
             }
-
-            // Add a StudentContactAssociationResource/#POSTRetry node for Contact resource
-            AddPostRetryVertexForResource(resourceGraph, studentContactAssociationResource, contactResource);
-
+
             string LogAndThrowException()
             {
                 string message =
@@ -210,18 +200,5 @@ string LogAndThrowException()
                     message: message);
             }
         }
-
-        private static void AddPostRetryVertexForResource(BidirectionalGraph<Resource, AssociationViewEdge> resourceGraph, Resource postRetrySource,
-            Resource postRetryTarget)
-        {
-            var postRetryVertex = new Resource(postRetrySource.Name);
-            postRetryVertex.IsPostRetryResource = true;
-
-            postRetryVertex.PostRetryOriginalSchemaUriSegment =
-                postRetrySource.SchemaUriSegment();
-
-            resourceGraph.AddVertex(postRetryVertex);
-            resourceGraph.AddEdge(new AssociationViewEdge(postRetryVertex, postRetryTarget, null));
-        }
     }
-}
+}

Application/EdFi.Ods.Common/Extensions/ResourceExtensions.cs

@@ -187,7 +187,7 @@ public static bool IsDerivedFrom(
         public static string SchemaUriSegment(this Resource resource) => resource
                                                                         .ResourceModel?.SchemaNameMapProvider
                                                                        ?.GetSchemaMapByPhysicalName(resource.FullName.Schema)
-                                                                        .UriSegment ?? resource.PostRetryOriginalSchemaUriSegment;
+                                                                        .UriSegment;
 
         /// <summary>
         /// Check if resource is abstract.

Application/EdFi.Ods.Common/Models/Graphs/IResourceLoadGraphFactory.cs

@@ -16,6 +16,6 @@ public interface IResourceLoadGraphFactory
         /// Creates a new graph containing the Ed-Fi model's resources, performing any defined graph transformations.
         /// </summary>
         /// <returns>A new graph instance.</returns>
-        BidirectionalGraph<Resource.Resource, AssociationViewEdge> CreateResourceLoadGraph(bool includePostRetryNodes = true);
+        BidirectionalGraph<Resource.Resource, AssociationViewEdge> CreateResourceLoadGraph();
     }
 }

Application/EdFi.Ods.Common/Models/Graphs/ResourceLoadGraphFactory.cs

@@ -24,17 +24,17 @@ public ResourceLoadGraphFactory(IResourceModelProvider resourceModelProvider,
             _resourceModelProvider = resourceModelProvider;
             _graphTransformers = graphTransformers;
         }
-        
-        public BidirectionalGraph<Resource.Resource, AssociationViewEdge> CreateResourceLoadGraph(bool includePostRetryNodes)
+
+        public BidirectionalGraph<Resource.Resource, AssociationViewEdge> CreateResourceLoadGraph()
         {
             var resourceModel = _resourceModelProvider.GetResourceModel();
-            
+
             var resourceGraph = new BidirectionalGraph<Resource.Resource, AssociationViewEdge>();
 
             var resources = resourceModel.GetAllResources()
                 .Where(r => !r.IsAbstract() && !r.FullName.IsEdFiSchoolYearType()) 
                 .ToArray();
-            
+
             resourceGraph.AddVertexRange(resources);
 
             var edges = resources
@@ -59,7 +59,7 @@ public ResourceLoadGraphFactory(IResourceModelProvider resourceModelProvider,
 
                 // Eliminate redundant edges
                 .Distinct(AssociationViewEdge.Comparer);
-            
+
             resourceGraph.AddEdgeRange(edges.Where(e => !e.Source.FullName.IsEdFiSchoolYearType()));
 
             // Apply predefined graph transformations
@@ -70,30 +70,10 @@ public ResourceLoadGraphFactory(IResourceModelProvider resourceModelProvider,
                     graphTransformer.Transform(resourceGraph);
                 }
             }
-
-            resourceGraph.BreakCycles(edge => edge.AssociationView?.IsSoftDependency ?? false);
-
-            if (!includePostRetryNodes)
-            {
-                RemovePostRetryNodes();
-            }
-
-            return resourceGraph;
 
-            void RemovePostRetryNodes()
-            {
-                var postRetryVertices = resourceGraph.Vertices.Where(v => v.IsPostRetryResource).ToList();
+            resourceGraph.BreakCycles(edge => edge.AssociationView.IsSoftDependency);
 
-                foreach(var postRetryVertex in postRetryVertices)
-                {
-                    var outEdges = resourceGraph.OutEdges(postRetryVertex).ToList();
-                    foreach (var edge in outEdges)
-                    {
-                        resourceGraph.RemoveEdge(edge);
-                    }
-                    resourceGraph.RemoveVertex(postRetryVertex);
-                }
-            }
+            return resourceGraph;
         }
     }
 
@@ -140,7 +120,7 @@ public static IEnumerable<AssociationViewEdge> CreateEdges(Reference reference)
             }
         }
 
-        public override string ToString() => AssociationView.Association.ToString();
+        public override string ToString() => $"({Source.FullName}) --> ({Target.FullName})";
 
         private sealed class AssociationViewEdgeEqualityComparer : IEqualityComparer<AssociationViewEdge>
         {

Application/EdFi.Ods.Common/Models/Resource/Resource.cs

@@ -74,10 +74,6 @@ public Resource(string name)
         }
 
         public bool IsEdFiCore { get; set; }
-
-        public bool IsPostRetryResource { get; set; }
-
-        public string PostRetryOriginalSchemaUriSegment { get; set; }
 
         /// <summary>
         /// Gets the root <see cref="Resource" /> class for the current resource.