Lazy Loading Topic Repository

.gitignore

@@ -199,4 +199,7 @@ ModelManifest.xml
 .vs
 
 # Custom
-ConnectionStrings.config
+ConnectionStrings.config
+docs/
+.idea/
+*.DS_Store

OnTopic.AspNetCore.Mvc.Host/Program.cs

@@ -14,22 +14,30 @@
 /*==============================================================================================================================
 | CONFIGURE SERVICES
 \-----------------------------------------------------------------------------------------------------------------------------*/
-var builder = WebApplication.CreateBuilder(args);
+var builder = WebApplication.CreateBuilder(args);
 
 /*------------------------------------------------------------------------------------------------------------------------------
 | Configure: Cookie Policy
 \-----------------------------------------------------------------------------------------------------------------------------*/
 builder.Services.Configure<CookiePolicyOptions>(options => {
  // This lambda determines whether user consent for non-essential cookies is needed for a given request.
- options.CheckConsentNeeded = context => true;
+ options.CheckConsentNeeded = context => true;
  options.MinimumSameSitePolicy = SameSiteMode.None;
 });
 
 /*------------------------------------------------------------------------------------------------------------------------------
-| Configure: Output Caching
+| Configure: Response Caching
 \-----------------------------------------------------------------------------------------------------------------------------*/
 builder.Services.AddResponseCaching();
 
+/*------------------------------------------------------------------------------------------------------------------------------
+| Configure: Output Caching
+>-------------------------------------------------------------------------------------------------------------------------------
+| Required for MapTopicSitemap()'s default caching policy to take effect; without this, the sitemap still renders correctly on
+| every request via the dedicated SqlSitemapTopicRepository, but it isn't cached.
+\-----------------------------------------------------------------------------------------------------------------------------*/
+builder.Services.AddOutputCache();
+
 /*------------------------------------------------------------------------------------------------------------------------------
 | Configure: MVC
 \-----------------------------------------------------------------------------------------------------------------------------*/
@@ -53,7 +61,7 @@
 /*==============================================================================================================================
 | CONFIGURE APPLICATION
 \-----------------------------------------------------------------------------------------------------------------------------*/
-var app = builder.Build();
+var app = builder.Build();
 
 /*------------------------------------------------------------------------------------------------------------------------------
 | Configure: Error Pages
@@ -74,6 +82,7 @@
 app.UseRouting();
 app.UseCors("default");
 app.UseResponseCaching();
+app.UseOutputCache();
 
 /*------------------------------------------------------------------------------------------------------------------------------
 | Configure: MVC

OnTopic.AspNetCore.Mvc.Host/SampleActivator.cs

@@ -36,6 +36,7 @@ public class SampleActivator : IControllerActivator, IViewComponentActivator {
  private readonly ITypeLookupService _typeLookupService;
  private readonly ITopicMappingService _topicMappingService;
  private readonly ITopicRepository _topicRepository;
+ private readonly ISitemapTopicRepository _sitemapTopicRepository;
  private DateTime _cacheLastUpdated = DateTime.UtcNow;
 
  /*============================================================================================================================
@@ -64,17 +65,17 @@ public SampleActivator(string connectionString) {
  /*--------------------------------------------------------------------------------------------------------------------------
  | Initialize Topic Repository
  \-------------------------------------------------------------------------------------------------------------------------*/
- var sqlTopicRepository = new SqlTopicRepository(connectionString);
- var cachedTopicRepository = new CachedTopicRepository(sqlTopicRepository);
- _ = new PageTopicViewModel();
+ var sqlTopicRepository = new SqlTopicRepository(connectionString);
+ var cachedTopicRepository = new CachedTopicRepository(sqlTopicRepository);
+ _ = new PageTopicViewModel();
 
  /*--------------------------------------------------------------------------------------------------------------------------
  | Preload repository
  \-------------------------------------------------------------------------------------------------------------------------*/
- _topicRepository = cachedTopicRepository;
-_typeLookupService= new DynamicTopicViewModelLookupService();
-_topicMappingService= new TopicMappingService(_topicRepository, _typeLookupService);
-_ = _topicRepository.Load();
+ _topicRepository = cachedTopicRepository;
+_sitemapTopicRepository = new SqlSitemapTopicRepository(connectionString);
+_typeLookupService = new DynamicTopicViewModelLookupService();
+_topicMappingService= new TopicMappingService(_topicRepository, _typeLookupService);
 
  /*--------------------------------------------------------------------------------------------------------------------------
  | Establish hierarchical topic mapping service
@@ -100,20 +101,20 @@ public object Create(ControllerContext context) {
  /*--------------------------------------------------------------------------------------------------------------------------
  | Validate parameters
  \-------------------------------------------------------------------------------------------------------------------------*/
- Contract.Requires(context, nameof(context));
+ Contract.Requires(context, nameof(context));
 
  /*--------------------------------------------------------------------------------------------------------------------------
  | Determine controller type
  \-------------------------------------------------------------------------------------------------------------------------*/
- var type = context.ActionDescriptor.ControllerTypeInfo.AsType();
+ var type = context.ActionDescriptor.ControllerTypeInfo.AsType();
 
  /*--------------------------------------------------------------------------------------------------------------------------
  | Periodically update cache
  \-------------------------------------------------------------------------------------------------------------------------*/
  if (DateTime.UtcNow > _cacheLastUpdated.AddMinutes(1)) {
- var currentUpdate = DateTime.UtcNow;
- _topicRepository.Refresh(_topicRepository.Load()!, _cacheLastUpdated);
- _cacheLastUpdated = currentUpdate;
+ var currentUpdate = DateTime.UtcNow;
+ _topicRepository.Refresh(_topicRepository.Load().GetAwaiter().GetResult()!, _cacheLastUpdated).GetAwaiter().GetResult();
+ _cacheLastUpdated = currentUpdate;
  }
 
  /*--------------------------------------------------------------------------------------------------------------------------
@@ -125,7 +126,7 @@ public object Create(ControllerContext context) {
  nameof(ErrorController) =>
  new ErrorController(_topicRepository, _topicMappingService),
  nameof(SitemapController) =>
- new SitemapController(_topicRepository),
+ new SitemapController(_sitemapTopicRepository),
  nameof(RedirectController) =>
  new RedirectController(_topicRepository),
  _ => throw new InvalidOperationException($"Unknown controller {type.Name}")
@@ -142,12 +143,12 @@ public object Create(ViewComponentContext context) {
  /*--------------------------------------------------------------------------------------------------------------------------
  | Validate parameters
  \-------------------------------------------------------------------------------------------------------------------------*/
- Contract.Requires(context, nameof(context));
+ Contract.Requires(context, nameof(context));
 
  /*--------------------------------------------------------------------------------------------------------------------------
  | Determine view component type
  \-------------------------------------------------------------------------------------------------------------------------*/
- var type = context.ViewComponentDescriptor.TypeInfo.AsType();
+ var type = context.ViewComponentDescriptor.TypeInfo.AsType();
 
  /*--------------------------------------------------------------------------------------------------------------------------
  | Configure and return appropriate view component

OnTopic.AspNetCore.Mvc.IntegrationTests.Host/OnTopic.AspNetCore.Mvc.IntegrationTests.Host.csproj

@@ -8,6 +8,7 @@
 
  <ItemGroup>
  <ProjectReference Include="..\OnTopic.All\OnTopic.All.csproj" />
+ <ProjectReference Include="..\OnTopic.TestDoubles\OnTopic.TestDoubles.csproj" />
  <ProjectReference Include="..\OnTopic.ViewModels\OnTopic.ViewModels.csproj" />
  </ItemGroup>
 

OnTopic.AspNetCore.Mvc.IntegrationTests.Host/Repositories/StubTopicRepository.cs

@@ -33,99 +33,109 @@ public class StubTopicRepository : TopicRepository, ITopicRepository {
  /// Instantiates a new instance of the StubTopicRepository.
  /// </summary>
  /// <returns>A new instance of the StubTopicRepository.</returns>
- public StubTopicRepository() : base() {
- _cache = CreateFakeData();
+ public StubTopicRepository() {
+ _cache = CreateFakeData();
  Contract.Assume(_cache);
  }
 
  /*============================================================================================================================
  | METHOD: LOAD
  \---------------------------------------------------------------------------------------------------------------------------*/
  /// <inheritdoc />
- public override Topic? Load(int topicId, Topic? referenceTopic = null, bool isRecursive = true) {
+ public override Task<Topic?> Load(
+ int topicId,
+ Topic? referenceTopic = null,
+ TopicPayload payload = TopicPayload.None,
+ int depth = 0
+ ) {
 
  /*--------------------------------------------------------------------------------------------------------------------------
  | Lookup by TopicId
  \-------------------------------------------------------------------------------------------------------------------------*/
- var topic = _cache;
+ var topic  = (Topic?)_cache;
 
  if (topicId > 0) {
- topic = _cache.FindFirst(t => t.Id.Equals(topicId));
+ topic = _cache.FindFirst(t => t.Id.Equals(topicId));
  }
 
  /*--------------------------------------------------------------------------------------------------------------------------
  | Raise event
  \-------------------------------------------------------------------------------------------------------------------------*/
  if (topic != null) {
- OnTopicLoaded(new(topic, isRecursive));
+ OnTopicLoaded(new(topic, depth));
  }
 
  /*--------------------------------------------------------------------------------------------------------------------------
  | Return value
  \-------------------------------------------------------------------------------------------------------------------------*/
- return topic;
+ return Task.FromResult(topic);
 
  }
 
  /// <inheritdoc />
- public override Topic? Load(string uniqueKey, Topic? referenceTopic = null, bool isRecursive = true) {
+ public override Task<Topic?> Load(
+ string uniqueKey,
+ Topic? referenceTopic = null,
+ TopicPayload payload = TopicPayload.None,
+ int depth = 0
+ ) {
 
  /*--------------------------------------------------------------------------------------------------------------------------
  | Validate parameters
  \-------------------------------------------------------------------------------------------------------------------------*/
  if (String.IsNullOrEmpty(uniqueKey)) {
- return null;
+ return Task.FromResult<Topic?>(null);
  }
 
  /*--------------------------------------------------------------------------------------------------------------------------
  | Lookup by TopicKey
  \-------------------------------------------------------------------------------------------------------------------------*/
- var topic = _cache.GetByUniqueKey(uniqueKey);
+ var topic = _cache.GetByUniqueKey(uniqueKey);
 
  /*--------------------------------------------------------------------------------------------------------------------------
  | Raise event
  \-------------------------------------------------------------------------------------------------------------------------*/
  if (topic != null) {
- OnTopicLoaded(new(topic, isRecursive));
+ OnTopicLoaded(new(topic, depth));
  }
 
  /*--------------------------------------------------------------------------------------------------------------------------
  | Return topic
  \-------------------------------------------------------------------------------------------------------------------------*/
- return topic;
+ return Task.FromResult(topic);
 
  }
 
  /// <inheritdoc />
- public override Topic? Load(int topicId, DateTime version, Topic? referenceTopic = null) =>
+ public override Task<Topic?> Load(int topicId, DateTime version) =>
  throw new NotImplementedException();
 
  /*============================================================================================================================
  | METHOD: REFRESH
  \---------------------------------------------------------------------------------------------------------------------------*/
  /// <inheritdoc/>
- public override void Refresh(Topic referenceTopic, DateTime since) =>
+ public override Task Refresh(Topic referenceTopic, DateTime since) =>
  throw new NotImplementedException();
 
  /*============================================================================================================================
  | METHOD: SAVE
  \---------------------------------------------------------------------------------------------------------------------------*/
  /// <inheritdoc />
- protected override void SaveTopic([NotNull]Topic topic, DateTime version, bool persistRelationships) =>
+ protected override Task SaveTopic([NotNull]Topic topic, DateTime version, bool persistRelationships) =>
  throw new NotImplementedException();
 
  /*============================================================================================================================
  | METHOD: MOVE
  \---------------------------------------------------------------------------------------------------------------------------*/
  /// <inheritdoc />
- protected override void MoveTopic(Topic topic, Topic target, Topic? sibling = null) =>
+ protected override Task MoveTopic(Topic topic, Topic target, Topic? sibling = null) =>
  throw new NotImplementedException();
 
  /*============================================================================================================================
  | METHOD: DELETE
  \---------------------------------------------------------------------------------------------------------------------------*/
  /// <inheritdoc />
- protected override void DeleteTopic(Topic topic) =>
+ protected override Task DeleteTopic(Topic topic) =>
  throw new NotImplementedException();
 
  /*============================================================================================================================