Merge pull request #900 from DFE-Digital/feat/234320/unified-contentf…

…ul-retrieval

feat: unified Contentful retrieval

src/Dfe.PlanTech.Application/Content/Queries/GetContentSupportPageQuery.cs

@@ -0,0 +1,34 @@
+using Dfe.PlanTech.Application.Caching.Interfaces;
+using Dfe.PlanTech.Application.Exceptions;
+using Dfe.PlanTech.Application.Persistence.Interfaces;
+using Dfe.PlanTech.Application.Persistence.Models;
+using Dfe.PlanTech.Domain.Content.Models.ContentSupport;
+using Dfe.PlanTech.Domain.Content.Queries;
+using Dfe.PlanTech.Infrastructure.Application.Models;
+using Microsoft.Extensions.Logging;
+
+namespace Dfe.PlanTech.Application.Content.Queries;
+public record GetContentSupportPageQuery(
+    ICmsCache Cache,
+    IContentRepository Repository,
+    ILogger<GetContentSupportPageQuery> Logger) : IGetContentSupportPageQuery
+{
+    public async Task<ContentSupportPage?> GetContentSupportPage(string slug, CancellationToken cancellationToken = default)
+    {
+        try
+        {
+            var pages = await Cache.GetOrCreateAsync($"ContentSupportPage:{slug}", () => Repository.GetEntities<ContentSupportPage>(CreateGetEntityOptions(slug), cancellationToken)) ?? [];
+
+            var page = pages.FirstOrDefault();
+
+            return page;
+        }
+        catch (Exception ex)
+        {
+            Logger.LogError(ex, "Error fetching content support page {slug} from Contentful", slug);
+            throw new ContentfulDataUnavailableException($"Could not retrieve content support page with slug {slug}", ex);
+        }
+    }
+
+    private GetEntitiesOptions CreateGetEntityOptions(string slug) => new(10, [new ContentQueryEquals() { Field = "fields.Slug", Value = slug }]);
+}

src/Dfe.PlanTech.Application/Helpers/QueryServiceSetup.cs

@@ -1,6 +1,7 @@
 using System.Reflection;
 using Dfe.PlanTech.Application.Content.Queries;
 using Dfe.PlanTech.Domain.Content.Interfaces;
+using Dfe.PlanTech.Domain.Content.Queries;
 using Dfe.PlanTech.Domain.Persistence.Interfaces;
 using Microsoft.Extensions.DependencyInjection;
 
@@ -26,6 +27,7 @@ public static IServiceCollection AddCQRSServices(this IServiceCollection service
         }
 
         services.AddScoped<IGetPageQuery, GetPageQuery>();
+        services.AddScoped<IGetContentSupportPageQuery, GetContentSupportPageQuery>();
 
         return services;
     }

src/Dfe.PlanTech.Web/Models/Content/IContentSupportPage.cs → src/Dfe.PlanTech.Domain/Content/Interfaces/IContentSupportPage.cs

@@ -1,6 +1,6 @@
-using Dfe.PlanTech.Domain.Content.Interfaces;
+using Dfe.PlanTech.Domain.Content.Models.ContentSupport;
 
-namespace Dfe.PlanTech.Web.Models.Content;
+namespace Dfe.PlanTech.Domain.Content.Interfaces;
 
 public interface IContentSupportPage<TContent> : IContentSupportPage
 where TContent : class
@@ -10,7 +10,7 @@ public interface IContentSupportPage<TContent> : IContentSupportPage
 
 public interface IContentSupportPage : IContentComponent, IHasSlug
 {
-    Heading Heading { get; }
+    CSHeading Heading { get; }
     bool IsSitemap { get; }
     bool HasCitation { get; }
     bool HasBackToTop { get; }

src/Dfe.PlanTech.Domain/Content/Interfaces/IGetContentSupportPageQuery.cs

@@ -0,0 +1,17 @@
+using Dfe.PlanTech.Domain.Content.Models.ContentSupport;
+
+namespace Dfe.PlanTech.Domain.Content.Queries;
+
+/// <summary>
+/// Retrieves a page from contentful
+/// </summary>
+public interface IGetContentSupportPageQuery
+{
+    /// <summary>
+    /// Fetches content support page from <see chref="IContentRepository"/> by slug
+    /// </summary>
+    /// <param name="slug">Slug for the C&S Page</param>
+    /// <returns>ContentSupportPage matching slug</returns>
+    Task<ContentSupportPage?> GetContentSupportPage(string slug, CancellationToken cancellationToken = default);
+
+}

src/Dfe.PlanTech.Domain/Content/Models/ContentSupport/CSBodyText.cs

@@ -0,0 +1,6 @@
+using System.Diagnostics.CodeAnalysis;
+
+namespace Dfe.PlanTech.Domain.Content.Models.ContentSupport;
+
+[ExcludeFromCodeCoverage]
+public class CSBodyText : Target;

src/Dfe.PlanTech.Domain/Content/Models/ContentSupport/CSHeading.cs

@@ -0,0 +1,6 @@
+using System.Diagnostics.CodeAnalysis;
+
+namespace Dfe.PlanTech.Domain.Content.Models.ContentSupport;
+
+[ExcludeFromCodeCoverage]
+public class CSHeading : ContentBase;

src/Dfe.PlanTech.Web/Models/Content/ContentBase.cs → src/Dfe.PlanTech.Domain/Content/Models/ContentSupport/ContentBase.cs

@@ -1,8 +1,7 @@
 using System.Diagnostics.CodeAnalysis;
 using Dfe.PlanTech.Domain.Content.Interfaces;
-using Dfe.PlanTech.Domain.Content.Models;
 
-namespace Dfe.PlanTech.Web.Models.Content;
+namespace Dfe.PlanTech.Domain.Content.Models.ContentSupport;
 
 [ExcludeFromCodeCoverage]
 public class ContentBase : Contentful.Core.Models.Entry<ContentBase>, IContentComponent, IHasSlug
@@ -12,4 +11,5 @@ public class ContentBase : Contentful.Core.Models.Entry<ContentBase>, IContentCo
     public string? Title { get; set; }
     public string? Subtitle { get; set; }
     public SystemDetails Sys { get; set; } = null!;
+    public Data Data { get; set; } = null!;
 }

src/Dfe.PlanTech.Web/Models/Content/ContentItem.cs → src/Dfe.PlanTech.Domain/Content/Models/ContentSupport/ContentItem.cs

@@ -1,11 +1,12 @@
 using System.Diagnostics.CodeAnalysis;
 using Contentful.Core.Models;
 
-namespace Dfe.PlanTech.Web.Models.Content;
+namespace Dfe.PlanTech.Domain.Content.Models.ContentSupport;
 
 [ExcludeFromCodeCoverage]
 public class ContentItem : ContentItemBase
 {
     public string Value { get; set; } = null!;
     public List<Mark> Marks { get; set; } = [];
+    public Data Data { get; set; } = null!;
 }

src/Dfe.PlanTech.Web/Models/Content/ContentItemBase.cs → src/Dfe.PlanTech.Domain/Content/Models/ContentSupport/ContentItemBase.cs

@@ -1,6 +1,6 @@
 using System.Diagnostics.CodeAnalysis;
 
-namespace Dfe.PlanTech.Web.Models.Content;
+namespace Dfe.PlanTech.Domain.Content.Models.ContentSupport;
 
 [ExcludeFromCodeCoverage]
 public class ContentItemBase : ContentBase

src/Dfe.PlanTech.Web/Models/Content/ContentSupportPage.cs → src/Dfe.PlanTech.Domain/Content/Models/ContentSupport/ContentSupportPage.cs

@@ -1,12 +1,13 @@
 using System.Diagnostics.CodeAnalysis;
+using Dfe.PlanTech.Domain.Content.Interfaces;
 
-namespace Dfe.PlanTech.Web.Models.Content;
+namespace Dfe.PlanTech.Domain.Content.Models.ContentSupport;
 
 [ExcludeFromCodeCoverage]
-public class ContentSupportPage : ContentBase, IContentSupportPage<Entry>
+public class ContentSupportPage : ContentBase, IContentSupportPage<CSBodyText>
 {
-    public Heading Heading { get; init; } = null!;
-    public List<Entry> Content { get; init; } = [];
+    public CSHeading Heading { get; init; } = null!;
+    public List<CSBodyText> Content { get; init; } = [];
     public bool IsSitemap { get; init; }
     public bool HasCitation { get; init; }
     public bool HasBackToTop { get; init; }

src/Dfe.PlanTech.Web/Models/Content/ContentType.cs → src/Dfe.PlanTech.Domain/Content/Models/ContentSupport/ContentType.cs

@@ -1,6 +1,6 @@
 using System.Diagnostics.CodeAnalysis;
 
-namespace Dfe.PlanTech.Web.Models.Content;
+namespace Dfe.PlanTech.Domain.Content.Models.ContentSupport;
 
 [ExcludeFromCodeCoverage]
 public class ContentType

src/Dfe.PlanTech.Web/Models/Content/Data.cs → src/Dfe.PlanTech.Domain/Content/Models/ContentSupport/Data.cs

@@ -1,6 +1,6 @@
 using System.Diagnostics.CodeAnalysis;
 
-namespace Dfe.PlanTech.Web.Models.Content;
+namespace Dfe.PlanTech.Domain.Content.Models.ContentSupport;
 
 [ExcludeFromCodeCoverage]
 public class Data

src/Dfe.PlanTech.Web/Models/Content/Entry.cs → src/Dfe.PlanTech.Domain/Content/Models/ContentSupport/Entry.cs

@@ -1,6 +1,5 @@
 using System.Diagnostics.CodeAnalysis;
-
-namespace Dfe.PlanTech.Web.Models.Content;
+namespace Dfe.PlanTech.Domain.Content.Models.ContentSupport;
 
 [ExcludeFromCodeCoverage]
 public class Entry : ContentBase

src/Dfe.PlanTech.Web/Models/Content/Fields.cs → src/Dfe.PlanTech.Domain/Content/Models/ContentSupport/Fields.cs

@@ -1,6 +1,6 @@
 using System.Diagnostics.CodeAnalysis;
 
-namespace Dfe.PlanTech.Web.Models.Content;
+namespace Dfe.PlanTech.Domain.Content.Models.ContentSupport;
 
 [ExcludeFromCodeCoverage]
 public class Fields

src/Dfe.PlanTech.Web/Models/Content/FileDetails.cs → src/Dfe.PlanTech.Domain/Content/Models/ContentSupport/FileDetails.cs

@@ -1,6 +1,6 @@
 using System.Diagnostics.CodeAnalysis;
 
-namespace Dfe.PlanTech.Web.Models.Content;
+namespace Dfe.PlanTech.Domain.Content.Models.ContentSupport;
 
 [ExcludeFromCodeCoverage]
 public class FileDetails

src/Dfe.PlanTech.Web/Models/Content/Image.cs → src/Dfe.PlanTech.Domain/Content/Models/ContentSupport/Image.cs

@@ -1,6 +1,6 @@
 using System.Diagnostics.CodeAnalysis;
 
-namespace Dfe.PlanTech.Web.Models.Content;
+namespace Dfe.PlanTech.Domain.Content.Models.ContentSupport;
 
 [ExcludeFromCodeCoverage]
 public class Image

src/Dfe.PlanTech.Web/Models/Content/Mapped/CsContentItem.cs → src/Dfe.PlanTech.Domain/Content/Models/ContentSupport/Mapped/CsContentItem.cs

@@ -1,14 +1,16 @@
 using System.Diagnostics.CodeAnalysis;
+using Dfe.PlanTech.Domain.Content.Interfaces;
 
-namespace Dfe.PlanTech.Web.Models.Content.Mapped;
+namespace Dfe.PlanTech.Domain.Content.Models.ContentSupport.Mapped;
 
 [ExcludeFromCodeCoverage]
-public class CsContentItem
+public class CsContentItem : IContentComponent
 {
     public string InternalName { get; set; } = null!;
     public string Slug { get; set; } = null!;
     public string? Title { get; set; } = null;
     public string? Subtitle { get; set; } = null;
     public bool UseParentHero { get; set; }
 
+    public SystemDetails Sys { get; set; } = new SystemDetails();
 }

src/Dfe.PlanTech.Web/Models/Content/Mapped/CsPage.cs → src/Dfe.PlanTech.Domain/Content/Models/ContentSupport/Mapped/CsPage.cs

@@ -1,13 +1,13 @@
 using System.Diagnostics.CodeAnalysis;
-using Dfe.PlanTech.Domain.Content.Models;
+using Dfe.PlanTech.Domain.Content.Interfaces;
 
-namespace Dfe.PlanTech.Web.Models.Content.Mapped;
+namespace Dfe.PlanTech.Domain.Content.Models.ContentSupport.Mapped;
 
 [ExcludeFromCodeCoverage]
 public class CsPage : IContentSupportPage<CsContentItem>
 {
     public SystemDetails Sys { get; set; } = null!;
-    public Heading Heading { get; set; } = null!;
+    public CSHeading Heading { get; set; } = null!;
     public string Slug { get; set; } = null!;
     public bool IsSitemap { get; set; }
     public bool HasCitation { get; set; }

src/Dfe.PlanTech.Web/Models/Content/Mapped/Custom/CustomAccordion.cs → src/Dfe.PlanTech.Domain/Content/Models/ContentSupport/Mapped/Custom/CustomAccordion.cs

@@ -1,7 +1,7 @@
 using System.Diagnostics.CodeAnalysis;
-using Dfe.PlanTech.Web.Models.Content.Mapped.Types;
+using Dfe.PlanTech.Domain.Content.Models.ContentSupport.Mapped.Types;
 
-namespace Dfe.PlanTech.Web.Models.Content.Mapped.Custom;
+namespace Dfe.PlanTech.Domain.Content.Models.ContentSupport.Mapped.Custom;
 
 [ExcludeFromCodeCoverage]
 public class CustomAccordion : CustomComponent

src/Dfe.PlanTech.Web/Models/Content/Mapped/Custom/CustomAttachment.cs → src/Dfe.PlanTech.Domain/Content/Models/ContentSupport/Mapped/Custom/CustomAttachment.cs

@@ -1,7 +1,7 @@
 using System.Diagnostics.CodeAnalysis;
-using Dfe.PlanTech.Web.Models.Content.Mapped.Types;
+using Dfe.PlanTech.Domain.Content.Models.ContentSupport.Mapped.Types;
 
-namespace Dfe.PlanTech.Web.Models.Content.Mapped.Custom;
+namespace Dfe.PlanTech.Domain.Content.Models.ContentSupport.Mapped.Custom;
 
 [ExcludeFromCodeCoverage]
 public class CustomAttachment : CustomComponent

src/Dfe.PlanTech.Web/Models/Content/Mapped/Custom/CustomCard.cs → src/Dfe.PlanTech.Domain/Content/Models/ContentSupport/Mapped/Custom/CustomCard.cs

@@ -1,7 +1,7 @@
 using System.Diagnostics.CodeAnalysis;
-using Dfe.PlanTech.Web.Models.Content.Mapped.Types;
+using Dfe.PlanTech.Domain.Content.Models.ContentSupport.Mapped.Types;
 
-namespace Dfe.PlanTech.Web.Models.Content.Mapped.Custom;
+namespace Dfe.PlanTech.Domain.Content.Models.ContentSupport.Mapped.Custom;
 
 [ExcludeFromCodeCoverage]
 public class CustomCard : CustomComponent

src/Dfe.PlanTech.Web/Models/Content/Mapped/Custom/CustomComponent.cs → src/Dfe.PlanTech.Domain/Content/Models/ContentSupport/Mapped/Custom/CustomComponent.cs

@@ -1,7 +1,7 @@
 using System.Diagnostics.CodeAnalysis;
-using Dfe.PlanTech.Web.Models.Content.Mapped.Types;
+using Dfe.PlanTech.Domain.Content.Models.ContentSupport.Mapped.Types;
 
-namespace Dfe.PlanTech.Web.Models.Content.Mapped.Custom;
+namespace Dfe.PlanTech.Domain.Content.Models.ContentSupport.Mapped.Custom;
 
 [ExcludeFromCodeCoverage]
 public class CustomComponent : CsContentItem

src/Dfe.PlanTech.Web/Models/Content/Mapped/Custom/CustomGridContainer.cs → src/Dfe.PlanTech.Domain/Content/Models/ContentSupport/Mapped/Custom/CustomGridContainer.cs

@@ -1,7 +1,7 @@
 using System.Diagnostics.CodeAnalysis;
-using Dfe.PlanTech.Web.Models.Content.Mapped.Types;
+using Dfe.PlanTech.Domain.Content.Models.ContentSupport.Mapped.Types;
 
-namespace Dfe.PlanTech.Web.Models.Content.Mapped.Custom;
+namespace Dfe.PlanTech.Domain.Content.Models.ContentSupport.Mapped.Custom;
 
 [ExcludeFromCodeCoverage]
 public class CustomGridContainer : CustomComponent

src/Dfe.PlanTech.Domain/Content/Models/ContentSupport/Mapped/PageLink.cs

@@ -0,0 +1,8 @@
+namespace Dfe.PlanTech.Domain.Content.Models.ContentSupport.Mapped;
+public class PageLink
+{
+    public string? Title { get; set; } = null;
+    public string? Subtitle { get; set; } = null;
+    public required string Url { get; set; }
+    public required bool IsActive { get; set; }
+}

src/Dfe.PlanTech.Web/Models/Content/Mapped/RichTextContentItem.cs → src/Dfe.PlanTech.Domain/Content/Models/ContentSupport/Mapped/RichTextContentItem.cs

@@ -1,7 +1,7 @@
 using System.Diagnostics.CodeAnalysis;
-using Dfe.PlanTech.Web.Models.Content.Mapped.Types;
+using Dfe.PlanTech.Domain.Content.Models.ContentSupport.Mapped.Types;
 
-namespace Dfe.PlanTech.Web.Models.Content.Mapped;
+namespace Dfe.PlanTech.Domain.Content.Models.ContentSupport.Mapped;
 
 [ExcludeFromCodeCoverage]
 public class RichTextContentItem : CsContentItem

src/Dfe.PlanTech.Web/Models/Content/Mapped/Standard/CsText.cs → src/Dfe.PlanTech.Domain/Content/Models/ContentSupport/Mapped/Standard/CsText.cs

@@ -1,7 +1,7 @@
 using System.Diagnostics.CodeAnalysis;
-using Dfe.PlanTech.Web.Models.Content.Mapped.Types;
+using Dfe.PlanTech.Domain.Content.Models.ContentSupport.Mapped.Types;
 
-namespace Dfe.PlanTech.Web.Models.Content.Mapped.Standard;
+namespace Dfe.PlanTech.Domain.Content.Models.ContentSupport.Mapped.Standard;
 
 [ExcludeFromCodeCoverage]
 public class CsText : RichTextContentItem

src/Dfe.PlanTech.Web/Models/Content/Mapped/Standard/EmbeddedAsset.cs → src/Dfe.PlanTech.Domain/Content/Models/ContentSupport/Mapped/Standard/EmbeddedAsset.cs

@@ -1,7 +1,7 @@
 using System.Diagnostics.CodeAnalysis;
-using Dfe.PlanTech.Web.Models.Content.Mapped.Types;
+using Dfe.PlanTech.Domain.Content.Models.ContentSupport.Mapped.Types;
 
-namespace Dfe.PlanTech.Web.Models.Content.Mapped.Standard;
+namespace Dfe.PlanTech.Domain.Content.Models.ContentSupport.Mapped.Standard;
 
 [ExcludeFromCodeCoverage]
 public class EmbeddedAsset : RichTextContentItem

src/Dfe.PlanTech.Web/Models/Content/Mapped/Standard/EmbeddedEntry.cs → src/Dfe.PlanTech.Domain/Content/Models/ContentSupport/Mapped/Standard/EmbeddedEntry.cs

@@ -1,8 +1,8 @@
 using System.Diagnostics.CodeAnalysis;
-using Dfe.PlanTech.Web.Models.Content.Mapped.Custom;
-using Dfe.PlanTech.Web.Models.Content.Mapped.Types;
+using Dfe.PlanTech.Domain.Content.Models.ContentSupport.Mapped.Custom;
+using Dfe.PlanTech.Domain.Content.Models.ContentSupport.Mapped.Types;
 
-namespace Dfe.PlanTech.Web.Models.Content.Mapped.Standard;
+namespace Dfe.PlanTech.Domain.Content.Models.ContentSupport.Mapped.Standard;
 
 [ExcludeFromCodeCoverage]
 public class EmbeddedEntry : RichTextContentItem

src/Dfe.PlanTech.Web/Models/Content/Mapped/Standard/Hyperlink.cs → src/Dfe.PlanTech.Domain/Content/Models/ContentSupport/Mapped/Standard/Hyperlink.cs

@@ -1,7 +1,7 @@
 using System.Diagnostics.CodeAnalysis;
-using Dfe.PlanTech.Web.Models.Content.Mapped.Types;
+using Dfe.PlanTech.Domain.Content.Models.ContentSupport.Mapped.Types;
 
-namespace Dfe.PlanTech.Web.Models.Content.Mapped.Standard;
+namespace Dfe.PlanTech.Domain.Content.Models.ContentSupport.Mapped.Standard;
 
 [ExcludeFromCodeCoverage]
 public class Hyperlink : RichTextContentItem

src/Dfe.PlanTech.Domain/Content/Models/ContentSupport/Mapped/Types/AssetContentType.cs

@@ -0,0 +1,8 @@
+namespace Dfe.PlanTech.Domain.Content.Models.ContentSupport.Mapped.Types;
+
+public enum AssetContentType
+{
+    Unknown,
+    Image,
+    Video
+}

src/Dfe.PlanTech.Domain/Content/Models/ContentSupport/Mapped/Types/CustomComponentType.cs

@@ -0,0 +1,14 @@
+namespace Dfe.PlanTech.Domain.Content.Models.ContentSupport.Mapped.Types;
+
+public enum CustomComponentType
+{
+    Undefined,
+    Accordion,
+    Attachment,
+    Card,
+    GridContainer,
+    CSAccordion,
+    csCard,
+    AccordionSection,
+    csJumpLinkComponent
+}

src/Dfe.PlanTech.Web/Models/Content/Mapped/Types/RichTextNodeType.cs → src/Dfe.PlanTech.Domain/Content/Models/ContentSupport/Mapped/Types/RichTextNodeType.cs

@@ -1,4 +1,4 @@
-namespace Dfe.PlanTech.Web.Models.Content.Mapped.Types;
+namespace Dfe.PlanTech.Domain.Content.Models.ContentSupport.Mapped.Types;
 
 public enum RichTextNodeType
 {

src/Dfe.PlanTech.Web/Models/Content/Sys.cs → src/Dfe.PlanTech.Domain/Content/Models/ContentSupport/Sys.cs

@@ -1,11 +1,10 @@
 using System.Diagnostics.CodeAnalysis;
 
-namespace Dfe.PlanTech.Web.Models.Content;
+namespace Dfe.PlanTech.Domain.Content.Models.ContentSupport;
 
 [ExcludeFromCodeCoverage]
 public class Sys
 {
-    public string Id { get; set; } = null!;
     public ContentType? ContentType { get; set; } = null!;
     public DateTime? CreatedAt { get; init; }
     public DateTime? UpdatedAt { get; init; }