Updated ITopicRepository.Load() to use uniqueKey instead of topicKey

In a previous commit, we created a new function, `GetTopicIDByUniqueKey`, which allows a `TopicID` to be looked up based on its `UniqueKey` instead of its `TopicKey` (ea97f91). This effectively replaces the legacy `GetTopicID`, which would lookup the _first instance_ of a topic which had a given `Key`. Since multiple topics can have the same `Key`, however, this was error prone.

As a result, `GetTopicIDByUniqueKey` requires that a fully qualified `UniqueKey` (e.g., from `Topic.GetUniqueKey()`) be passed along, instead of simply a `Topic.Key`. As a result, this was not implemented on `ITopicRepository.Load(topicKey)` as that would be a breaking change; any call passing a single topic key would fail, unless that topic key happened to be in the root.

For this major release, we're finally updating this to use `GetTopicIDByUniqueKey`. To avoid confusion, the parameter name is also being updated from `topicKey` to `uniqueKey` to help disambiguate _which_ key is appropriate here.

Author: JeremyCaney

OnTopic.AspNetCore.Mvc/Components/MenuViewComponentBase{T}.cs

@@ -79,7 +79,7 @@ IHierarchicalTopicMappingService<T> hierarchicalTopicMappingService
       var                       configuredRoot                  = CurrentTopic.Attributes.GetValue("NavigationRoot", true);
 
       if (!String.IsNullOrEmpty(configuredRoot)) {
-        navigationRootTopic = TopicRepository.Load(configuredRoot);
+        navigationRootTopic = TopicRepository.Load("Root:" + configuredRoot);
       }
       if (navigationRootTopic is null) {
         navigationRootTopic = HierarchicalTopicMappingService.GetHierarchicalRoot(CurrentTopic, 2, "Web");

OnTopic.Data.Caching/CachedTopicRepository.cs

@@ -96,13 +96,13 @@ public CachedTopicRepository(ITopicRepository dataProvider) : base() {
     }
 
     /// <inheritdoc />
-    public override Topic? Load(string? topicKey = null, bool isRecursive = true) {
+    public override Topic? Load(string? uniqueKey = null, bool isRecursive = true) {
 
       /*------------------------------------------------------------------------------------------------------------------------
       | Lookup by TopicKey
       \-----------------------------------------------------------------------------------------------------------------------*/
-      if (topicKey is not null && topicKey.Length is not 0) {
-        return _cache.GetByUniqueKey(topicKey);
+      if (uniqueKey is not null && uniqueKey.Length is not 0) {
+        return _cache.GetByUniqueKey(uniqueKey);
       }
 
       /*------------------------------------------------------------------------------------------------------------------------

OnTopic.Data.Sql/SqlTopicRepository.cs

@@ -64,23 +64,23 @@ public SqlTopicRepository(string connectionString) : base() {
     | METHOD: LOAD
     \-------------------------------------------------------------------------------------------------------------------------*/
     /// <inheritdoc />
-    public override Topic Load(string? topicKey = null, bool isRecursive = true) {
+    public override Topic Load(string? uniqueKey = null, bool isRecursive = true) {
 
       /*------------------------------------------------------------------------------------------------------------------------
       | Handle empty topic
       >-------------------------------------------------------------------------------------------------------------------------
       | If the topicKey is null, or does not contain a topic key, then assume the caller wants to return all data; in that case
       | call Load() with the special integer value of -1, which will load all topics from the root.
       \-----------------------------------------------------------------------------------------------------------------------*/
-      if (String.IsNullOrEmpty(topicKey)) {
+      if (String.IsNullOrEmpty(uniqueKey)) {
         return Load(-1, isRecursive);
       }
 
       /*------------------------------------------------------------------------------------------------------------------------
       | Establish database connection
       \-----------------------------------------------------------------------------------------------------------------------*/
       using var connection      = new SqlConnection(_connectionString);
-      using var command         = new SqlCommand("GetTopicID", connection);
+      using var command         = new SqlCommand("GetTopicIDByUniqueKey", connection);
 
       var topicId               = -1;
 
@@ -89,7 +89,7 @@ public override Topic Load(string? topicKey = null, bool isRecursive = true) {
       /*------------------------------------------------------------------------------------------------------------------------
       | Establish query parameters
       \-----------------------------------------------------------------------------------------------------------------------*/
-      command.AddParameter("TopicKey", topicKey);
+      command.AddParameter("UniqueKey", uniqueKey);
       command.AddOutputParameter();
 
       /*------------------------------------------------------------------------------------------------------------------------
@@ -115,7 +115,7 @@ public override Topic Load(string? topicKey = null, bool isRecursive = true) {
       | Validate results
       \-----------------------------------------------------------------------------------------------------------------------*/
       if (topicId < 0) {
-        throw new TopicNotFoundException(topicKey);
+        throw new TopicNotFoundException(uniqueKey);
       }
 
       /*------------------------------------------------------------------------------------------------------------------------

OnTopic.TestDoubles/DummyTopicRepository.cs

@@ -33,7 +33,7 @@ public DummyTopicRepository() : base() { }
     public override Topic? Load(int topicId, bool isRecursive = true) => null;
 
     /// <inheritdoc />
-    public override Topic? Load(string? topicKey = null, bool isRecursive = true) => null;
+    public override Topic? Load(string? uniqueKey = null, bool isRecursive = true) => null;
 
     /// <inheritdoc />
     public override Topic? Load(int topicId, DateTime version) => throw new NotImplementedException();

OnTopic.TestDoubles/StubTopicRepository.cs

@@ -53,14 +53,14 @@ public StubTopicRepository() : base() {
       (topicId < 0)? _cache :_cache.FindFirst(t => t.Id.Equals(topicId));
 
     /// <inheritdoc />
-    public override Topic? Load(string? topicKey = null, bool isRecursive = true) {
+    public override Topic? Load(string? uniqueKey = null, bool isRecursive = true) {
 
       /*------------------------------------------------------------------------------------------------------------------------
       | Lookup by TopicKey
       \-----------------------------------------------------------------------------------------------------------------------*/
-      if (topicKey is not null && topicKey.Length > 0) {
-        topicKey = topicKey.Contains(":") ? topicKey : "Root:" + topicKey;
-        return _cache.FindFirst(t => t.GetUniqueKey().Equals(topicKey, StringComparison.OrdinalIgnoreCase));
+      if (uniqueKey is not null && uniqueKey.Length > 0) {
+        uniqueKey = uniqueKey.Contains(":") ? uniqueKey : "Root:" + uniqueKey;
+        return _cache.FindFirst(t => t.GetUniqueKey().Equals(uniqueKey, StringComparison.OrdinalIgnoreCase));
       }
 
       /*------------------------------------------------------------------------------------------------------------------------

OnTopic/Mapping/Hierarchical/HierarchicalTopicMappingService{T}.cs

@@ -74,7 +74,7 @@ ITopicMappingService topicMappingService
     | GET HIERARCHICAL ROOT
     \-------------------------------------------------------------------------------------------------------------------------*/
     /// <inheritdoc />
-    public Topic? GetHierarchicalRoot(Topic? currentTopic, int fromRoot = 2, string defaultRoot = "Web") {
+    public Topic? GetHierarchicalRoot(Topic? currentTopic, int fromRoot = 2, string defaultRoot = "Root:Web") {
 
       /*------------------------------------------------------------------------------------------------------------------------
       | Establish variables

OnTopic/Repositories/ITopicRepository.cs

@@ -60,10 +60,10 @@ public interface ITopicRepository {
     /// <summary>
     ///   Loads a topic (and, optionally, all of its descendants) based on the specified key name.
     /// </summary>
-    /// <param name="topicKey">The topic key.</param>
+    /// <param name="uniqueKey">The fully-qualified unique topic key.</param>
     /// <param name="isRecursive">Determines whether or not to recurse through and load a topic's children.</param>
     /// <returns>A topic object.</returns>
-    Topic? Load(string? topicKey = null, bool isRecursive = true);
+    Topic? Load(string? uniqueKey = null, bool isRecursive = true);
 
     /// <summary>
     ///   Loads a specific version of a topic based on its version.

OnTopic/Repositories/TopicRepositoryBase.cs

@@ -224,7 +224,7 @@ protected virtual ContentTypeDescriptorCollection SetContentTypeDescriptors(Cont
     public abstract Topic? Load(int topicId, bool isRecursive = true);
 
     /// <inheritdoc />
-    public abstract Topic? Load(string? topicKey = null, bool isRecursive = true);
+    public abstract Topic? Load(string? uniqueKey = null, bool isRecursive = true);
 
     /// <inheritdoc />
     public abstract Topic? Load(int topicId, DateTime version);