Merge branch 'release/4.3.0'

This update provides backend functionality and bug fixes to improve performance and reliability, with a particular emphasis on importing and saving large topic graphs.

New Functionality
- `ContentTypeDescriptor`s (a9ea634) and `AttributeDescriptor`s (b0c5a5e) are now updated dynamically when saved, and thus configuration changes are now available immediately without requiring an application restart (fb3366e).
- The byline (`LastModifiedBy`) and dateline (`LastModified`) are now only persisted to the underlying topic repository if any other attributes (d8d41b7) or relationships (8caa148) have changed (d8d41b7).
- _Arbitrary attributes_ (i.e., attributes not defined in the `ContentTypeDescriptor`) can now be programmatically added (c3c01ef), modified, or deleted (2151a08) via the OnTopic Library (8b7dffe).
- Empty databases can now be connected to without throwing exceptions, thus allowing a reference schema can be `Import()`ed via the **OnTopic Data Transfer** library using the **OnTopic Editor** (695664d).
- `TopicRepository.Save()` will now loop back and save any topics with previously unresolved (i.e., unsaved) references (including relationships or `DerivedTopic`) (913b68d).
- `UpdateRelationships` now synchronizes relationships, instead of just inserting them. It accepts an optional `@DeleteUnmatched` argument which can be disabled to append new relationships, instead of also deleting unmatched relationships (cbba817).

Bug Fixes
- Fixed a bug where topics from the previous relationship were saved to each subsequent relationship for a topic (27d9bfe).
- Fixed a bug where attributes that had been reconfigured away from `IsIndexedAttribute`, but not otherwise changed, would be orphaned (7a61005) deleted (d64d242) on `Save()`.
- Fixed a bug where an off-target exception would be thrown if `SqlTopicRepository.Load(string topicKey)` wasn't able to identify a matching topic (c97dcb3).
- Fixed a bug where unsaved relationships (6da3fa4) and derived topics (a3b6da1) were saving `-1` to the database if they referenced unsaved topics.

Performance
- Reduced execution time of `UpdateTopic` by 50% through optimization of queries (fae0e8d).
- `SqlTopicRepository.Save()` will only save topics which have actually changed; this greatly increases the performance of recursive saves when merging large topic graphs (afa1e9b).

API Changes
- Introduced `AttributeValuesDataTable` (313fe71) and `TopicListDataTable` (7a37dc9) to encapsulate the corresponding user-defined, table-valued types in SQL, and extended `SqlCommand.AddParameter()` to support them (0cd2506).
- Introduced `TopicNotFoundException` (2300e69), which derives from `TopicRepositoryException` and is used in `ITopicRepository.Load()`.
- Introduced `TopicRepositoryBase.GetContentTypeDescriptor()` convenience method (408d01a) for loading a `ContentTypeDescriptor`—either from the database, or from the local topic graph.
- Introduced `TopicRepositoryBase.GetAttributes()` method for retrieving extended or indexed attributes, optionally filtered by `IsDirty` (120c55e).
- Introduced `Topic.GetTopicByUniqueKey()` (867b110) and `Topic.GetRootTopic()` (0bddfb0) extension methods to `OnTopic.Queryable` namespace (d18984d).
- Introduced `Topic.IsNew` property for tracking whether a topic is new, or if it has been persisted to the database (1678523, f046179).
- Introduced a `NamedTopicCollection.IsDirty` property (4762694), `RelatedTopicCollection.IsDirty()` (2adef58), and `AttributeValueCollection.IsDirty()` (d3b49ff) for tracking if any relationships or attributes have changed (afa1e9b).
- Removed legacy `SqlTopicRepository.CreateRelationshipsXml()` private helper function, as that functionality is no longer used (7bea7d3).

General
- Migrated to C# 8.0's new block-level `using` statement, in favor of placing explicit `Dispose()` calls in `finally` blocks (f85aab2)
- Migrated to GitVersion's `ContinuousDeployment` mode for all branches except `master` to simplify version incrementing on feature branches (b4105f3).

Maintenance
- Various dependency updates (20374cd, dcf4eaf) and code cleanup (718aea5) tasks.

Author: JeremyCaney

GitVersion.yml

@@ -1,5 +1,7 @@
 assembly-versioning-scheme: MajorMinorPatch
-mode: ContinuousDelivery
-branches: {}
+mode: ContinuousDeployment
+branches:
+  master:
+    mode: ContinuousDelivery
 ignore:
-  sha: []
+  sha: []

OnTopic.AspNetCore.Mvc.Host/SampleActivator.cs

@@ -97,15 +97,13 @@ public object Create(ControllerContext context) {
       /*------------------------------------------------------------------------------------------------------------------------
       | Configure and return appropriate controller
       \-----------------------------------------------------------------------------------------------------------------------*/
-      if (type == typeof(TopicController)) {
-        return new TopicController(_topicRepository, _topicMappingService);
-      }
-      if (type == typeof(SitemapController)) {
-        return new SitemapController(_topicRepository);
-      }
-      else {
-        throw new Exception($"Unknown controller {type.Name}");
-      }
+      return type.Name switch {
+        nameof(TopicController) =>
+          new TopicController(_topicRepository, _topicMappingService),
+        nameof(SitemapController) =>
+          new SitemapController(_topicRepository),
+        _ => throw new Exception($"Unknown controller {type.Name}")
+      };
 
     }
 
@@ -123,15 +121,13 @@ public object Create(ViewComponentContext context) {
       /*------------------------------------------------------------------------------------------------------------------------
       | Configure and return appropriate view component
       \-----------------------------------------------------------------------------------------------------------------------*/
-      if (type == typeof(MenuViewComponent)) {
-        return new MenuViewComponent(_topicRepository, _hierarchicalMappingService);
-      }
-      else if (type == typeof(PageLevelNavigationViewComponent)) {
-        return new PageLevelNavigationViewComponent(_topicRepository, _hierarchicalMappingService);
-      }
-      else {
-        throw new Exception($"Unknown view component {type.Name}");
-      }
+      return type.Name switch {
+        nameof(MenuViewComponent) =>
+          new MenuViewComponent(_topicRepository, _hierarchicalMappingService),
+        nameof(PageLevelNavigationViewComponent) =>
+          new PageLevelNavigationViewComponent(_topicRepository, _hierarchicalMappingService),
+        _ => throw new Exception($"Unknown view component {type.Name}")
+      };
 
     }
 

OnTopic.AspNetCore.Mvc.Tests/OnTopic.AspNetCore.Mvc.Tests.csproj

@@ -6,7 +6,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.5.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.6.1" />
     <PackageReference Include="MSTest.TestAdapter" Version="2.1.1" />
     <PackageReference Include="MSTest.TestFramework" Version="2.1.1" />
   </ItemGroup>

OnTopic.AspNetCore.Mvc.Tests/TopicRepositoryExtensionsTest.cs

@@ -65,5 +65,27 @@ public void Load_ByRoute_ReturnsTopic() {
 
     }
 
+    /*==========================================================================================================================
+    | TEST: LOAD: BY ROUTE: RETURNS ROOT TOPIC
+    \-------------------------------------------------------------------------------------------------------------------------*/
+    /// <summary>
+    ///   Establishes route data and ensures that the root topic is correctly identified based on that route.
+    /// </summary>
+    [TestMethod]
+    public void Load_ByRoute_ReturnsRootTopic() {
+
+      var routes                = new RouteData();
+      var topic                 = _topicRepository.Load("Root");
+
+      routes.Values.Add("path", "Root/");
+
+      var currentTopic          = _topicRepository.Load(routes);
+
+      Assert.IsNotNull(currentTopic);
+      Assert.ReferenceEquals(topic, currentTopic);
+      Assert.AreEqual<string>("Root", currentTopic.Key);
+
+    }
+
   } //Class
 } //Namespace

OnTopic.AspNetCore.Mvc/Models/NavigationViewModel{T}.cs

@@ -27,7 +27,40 @@ namespace OnTopic.AspNetCore.Mvc.Models {
   /// </remarks>
   public class NavigationViewModel<T> where T : class, INavigationTopicViewModel<T> {
 
+    /*==========================================================================================================================
+    | NAVIGATION ROOT
+    \-------------------------------------------------------------------------------------------------------------------------*/
+    /// <summary>
+    ///   Represents the root element in the navigation.
+    /// </summary>
+    /// <remarks>
+    ///   Since this implements <see cref="IHierarchicalTopicViewModel{T}"/>, it  may include multiple levels of children. By
+    ///   implementing it as a generic, each site or application can provide its own <see cref="INavigationTopicViewModel{T}"/>
+    ///   implementation, thus potentially extending the schema with properties relevant to that site's navigation. For example,
+    ///   a site may optionally add an <c>IconUrl</c> property if it wishes to assign unique icons to each link in the
+    ///   navigation.
+    /// </remarks>
     public T? NavigationRoot { get; set; }
+
+    /*==========================================================================================================================
+    | CURRENT KEY
+    \-------------------------------------------------------------------------------------------------------------------------*/
+    /// <summary>
+    ///   The <see cref="Topic.GetUniqueKey()"/> representing the path to the current <see cref="Topic"/>.
+    /// </summary>
+    /// <remarks>
+    ///   <para>
+    ///     In order to determine whether any given <see cref="INavigationTopicViewModel{T}.IsSelected(String)"/>, the views
+    ///     will need to know where in the hierarchy the user currently is. By storing this on the <see
+    ///     cref="NavigationViewModel{T}"/> used as the root view model for every navigation component, we ensure that the views
+    ///     always have access to this information.
+    ///   </para>
+    ///   <para>
+    ///     It's worth noting that while this <i>could</i> be stored on the <see cref="INavigationTopicViewModel{T}"/> itself,
+    ///     that would prevent those values from being cached. As such, it's preferrable to keep the navigation nodes stateless,
+    ///     and maintaining state exclusively in the <see cref="NavigationViewModel{T}"/> itself.
+    ///   </para>
+    /// </remarks>
     public string CurrentKey { get; set; } = default!;
 
   } //Class

OnTopic.AspNetCore.Mvc/OnTopic.AspNetCore.Mvc.csproj

@@ -39,11 +39,11 @@
 
   <ItemGroup>
     <FrameworkReference Include="Microsoft.AspNetCore.App" />
-    <PackageReference Include="GitVersionTask" Version="5.2.4">
+    <PackageReference Include="GitVersionTask" Version="5.3.3">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers" Version="2.9.8">
+    <PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers" Version="3.0.0">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
     </PackageReference>

OnTopic.Data.Caching/CachedTopicRepository.cs

@@ -102,7 +102,7 @@ public CachedTopicRepository(ITopicRepository dataProvider) : base() {
       | Lookup by TopicKey
       \-----------------------------------------------------------------------------------------------------------------------*/
       if (topicKey != null && !topicKey.Length.Equals(0)) {
-        return GetTopic(_cache, topicKey);
+        return _cache.GetByUniqueKey(topicKey);
       }
 
       /*------------------------------------------------------------------------------------------------------------------------
@@ -131,76 +131,6 @@ public CachedTopicRepository(ITopicRepository dataProvider) : base() {
 
     }
 
-    /*==========================================================================================================================
-    | METHOD: GET TOPIC
-    \-------------------------------------------------------------------------------------------------------------------------*/
-    /// <summary>
-    ///   Retrieves a topic object based on the specified partial or full (prefixed) topic key.
-    /// </summary>
-    /// <param name="sourceTopic">The root topic to search from.</param>
-    /// <param name="uniqueKey">
-    ///   The partial or full string value representing the key (or <see cref="Topic.GetUniqueKey"/>) for the topic.
-    /// </param>
-    /// <returns>The topic or null, if the topic is not found.</returns>
-    private Topic? GetTopic(Topic? sourceTopic, string uniqueKey) {
-
-      /*------------------------------------------------------------------------------------------------------------------------
-      | Validate input
-      \-----------------------------------------------------------------------------------------------------------------------*/
-      if (sourceTopic == null) return null;
-      if (String.IsNullOrWhiteSpace(uniqueKey)) return null;
-
-      /*------------------------------------------------------------------------------------------------------------------------
-      | Provide shortcut for local calls
-      \-----------------------------------------------------------------------------------------------------------------------*/
-      if (uniqueKey.IndexOf(":", StringComparison.InvariantCulture) < 0 && uniqueKey != "Root") {
-        if (sourceTopic.Children.Contains(uniqueKey)) {
-          return sourceTopic.Children[uniqueKey];
-        }
-        return null;
-      }
-
-      /*------------------------------------------------------------------------------------------------------------------------
-      | Provide implicit root
-      >-------------------------------------------------------------------------------------------------------------------------
-      | ###NOTE JJC080313: While a root topic is required by the data structure, it should be implicit from the perspective of
-      | the calling application.  A developer should be able to call GetTopic("Namespace:TopicPath") to get to a topic, without
-      | needing to be aware of the root.
-      \-----------------------------------------------------------------------------------------------------------------------*/
-      if (
-        !uniqueKey.StartsWith("Root:", StringComparison.OrdinalIgnoreCase) &&
-        !uniqueKey.Equals("Root", StringComparison.OrdinalIgnoreCase)
-        ) {
-        uniqueKey = "Root:" + uniqueKey;
-      }
-
-      /*------------------------------------------------------------------------------------------------------------------------
-      | Validate parameters
-      \-----------------------------------------------------------------------------------------------------------------------*/
-      if (!uniqueKey.StartsWith(sourceTopic.GetUniqueKey(), StringComparison.OrdinalIgnoreCase)) return null;
-      if (uniqueKey.Equals(sourceTopic.GetUniqueKey(), StringComparison.OrdinalIgnoreCase)) return sourceTopic;
-
-      /*------------------------------------------------------------------------------------------------------------------------
-      | Define variables
-      \-----------------------------------------------------------------------------------------------------------------------*/
-      var remainder             = uniqueKey.Substring(sourceTopic.GetUniqueKey().Length + 1);
-      var marker                = remainder.IndexOf(":", StringComparison.Ordinal);
-      var nextChild             = (marker < 0) ? remainder : remainder.Substring(0, marker);
-
-      /*------------------------------------------------------------------------------------------------------------------------
-      | Find topic
-      \-----------------------------------------------------------------------------------------------------------------------*/
-      if (!sourceTopic.Children.Contains(nextChild)) return null;
-
-      if (nextChild == remainder) return sourceTopic.Children[nextChild];
-
-      /*------------------------------------------------------------------------------------------------------------------------
-      | Return the topic
-      \-----------------------------------------------------------------------------------------------------------------------*/
-      return GetTopic(sourceTopic.Children[nextChild], uniqueKey);
-
-    }
-
     /*==========================================================================================================================
     | METHOD: SAVE
     \-------------------------------------------------------------------------------------------------------------------------*/
@@ -212,11 +142,6 @@ public override int Save(Topic topic, bool isRecursive = false, bool isDraft = f
     | METHOD: MOVE
     \-------------------------------------------------------------------------------------------------------------------------*/
     /// <inheritdoc />
-    [System.Diagnostics.CodeAnalysis.SuppressMessage(
-      "Microsoft.Contracts",
-      "TestAlwaysEvaluatingToAConstant",
-      Justification = "Sibling may be null from overloaded caller."
-      )]
     public override void Move(Topic topic, Topic target, Topic? sibling) => _dataProvider.Move(topic, target, sibling);
 
     /*==========================================================================================================================

OnTopic.Data.Caching/OnTopic.Data.Caching.csproj

@@ -39,11 +39,11 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="GitVersionTask" Version="5.2.4">
+    <PackageReference Include="GitVersionTask" Version="5.3.3">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers" Version="2.9.8">
+    <PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers" Version="3.0.0">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
     </PackageReference>

OnTopic.Data.Sql.Database/Functions/GetTopicID.sql

@@ -19,6 +19,7 @@ BEGIN
   -- DECLARE AND DEFINE VARIABLES
   ------------------------------------------------------------------------------------------------------------------------------
   DECLARE	@TopicID		INT
+  SET	@TopicID		= -1
 
   ------------------------------------------------------------------------------------------------------------------------------
   -- GET TOPIC ID BASED ON TOPIC KEY

OnTopic.Data.Sql.Database/Stored Procedures/DeleteTopic.sql

@@ -87,23 +87,23 @@ WHERE	RangeLeft
 --------------------------------------------------------------------------------------------------------------------------------
 DELETE	Attributes
 FROM	Attributes		Attributes
-INNER JOIN	@Topics                         Topics
-  ON	Topics.TopicId                  = Attributes.TopicID
+INNER JOIN	@Topics		Topics
+  ON	Topics.TopicId		= Attributes.TopicID
 
 DELETE	ExtendedAttributes
 FROM	ExtendedAttributes	ExtendedAttributes
-INNER JOIN	@Topics                         Topics
-  ON	Topics.TopicId                  = ExtendedAttributes.TopicID
+INNER JOIN	@Topics		Topics
+  ON	Topics.TopicId		= ExtendedAttributes.TopicID
 
 DELETE	Relationships
 FROM	Relationships		Relationships
-INNER JOIN	@Topics                         Topics
-  ON	Topics.TopicId                  = Relationships.Source_TopicID
+INNER JOIN	@Topics		Topics
+  ON	Topics.TopicId		= Relationships.Source_TopicID
 
 DELETE	Relationships
 FROM	Relationships		Relationships
-INNER JOIN	@Topics                         Topics
-  ON	Topics.TopicId                  = Relationships.Target_TopicID
+INNER JOIN	@Topics		Topics
+  ON	Topics.TopicId		= Relationships.Target_TopicID
 
 --------------------------------------------------------------------------------------------------------------------------------
 -- DELETE RANGE

OnTopic.Data.Sql.Database/Stored Procedures/UpdateRelationships.sql

@@ -7,26 +7,10 @@
 CREATE PROCEDURE [dbo].[UpdateRelationships]
 	@TopicID		INT	= -1,
 	@RelationshipKey	VARCHAR(255)	= 'related',
-	@RelatedTopics		TopicList	READONLY
+	@RelatedTopics		TopicList	READONLY,
+	@DeleteUnmatched	BIT	= 1
 AS
 
---------------------------------------------------------------------------------------------------------------------------------
--- DECLARE AND SET VARIABLES
-
-DECLARE	@Existing_TopicIDs	TopicList
-
---------------------------------------------------------------------------------------------------------------------------------
--- IDENTIFY EXISTING VALUES
---------------------------------------------------------------------------------------------------------------------------------
-INSERT
-INTO	@Existing_TopicIDs (
-	  TopicID
-	)
-SELECT	Target_TopicID
-FROM	Relationships
-WHERE	Source_TopicID		= @TopicID
-  AND	RelationshipKey		= @RelationshipKey
-
 --------------------------------------------------------------------------------------------------------------------------------
 -- INSERT NOVEL VALUES
 --------------------------------------------------------------------------------------------------------------------------------
@@ -36,13 +20,27 @@ INTO	Relationships (
 	  RelationshipKey,
 	  Target_TopicID
 	)
-SELECT	@TopicId,
+SELECT	@TopicID,
 	@RelationshipKey,
-	Target.TopicID
+	TopicID
 FROM	@RelatedTopics		Target
-FULL JOIN	@Existing_TopicIDs	Existing
-  ON	Existing.TopicID	= Target.TopicID
-WHERE	Existing.TopicID	is null
+LEFT JOIN	Relationships		Existing
+  ON	Target_TopicID		= TopicID
+  AND	Source_TopicID		= @TopicID
+WHERE	Target_TopicID		IS NULL
+
+--------------------------------------------------------------------------------------------------------------------------------
+-- DELETE UNMATCHED VALUES
+--------------------------------------------------------------------------------------------------------------------------------
+IF @DeleteUnmatched = 1
+  BEGIN
+    DELETE	EXISTING
+    FROM	@RelatedTopics		Relationships
+    RIGHT JOIN	Relationships		Existing
+      ON	Target_TopicID		= TopicID
+    WHERE	Source_TopicID		= @TopicID
+      AND	ISNULL(TopicID, '')	= ''
+  END
 
 --------------------------------------------------------------------------------------------------------------------------------
 -- RETURN TOPIC ID