Feat/index reusable types (#26)

* feat(Azure): update packages and nugets to Xperience 29.3.3 * feat(Indexing-reusable-items): docs * feat(Indexing-reusable-items): update to XbyK v29.4.2 * feat(repository): add end line, images to gitattributes * feat(Indexing-reusable-items): reusable content type info * fix(tests): indexd item model extensions test apply channel check * fix(admin/client): path item selection description * feat(Indexing-reusable-items): admin * feat(Indexing-reusable-items): images * feat(Indexing-reusable-items): examples * fix(AzureSearch): formating * fix(AzureSearch): redundand using * feat(Indexing-reusable-items): DefaultAzureSearchClient correctly index reusable items
Kentico · Sep 24, 2024 · cf79502 · cf79502
1 parent 49e1244
commit cf79502
Show file tree

Hide file tree

Showing 69 changed files with 4,738 additions and 4,548 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,3 @@
+* text eol=crlf
+*.png binary
+*.jpg binary
diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -7,11 +7,11 @@
   </PropertyGroup>
   <ItemGroup>
     <PackageVersion Include="Azure.Search.Documents" Version="11.6.0-beta.2" />
-    <PackageVersion Include="Kentico.Xperience.Admin" Version="29.0.0" />
-    <PackageVersion Include="Kentico.Xperience.WebApp" Version="29.0.0" />
-    <PackageVersion Include="kentico.xperience.azurestorage" Version="29.0.0" />
-    <PackageVersion Include="kentico.xperience.imageprocessing" Version="29.0.0" />
-    <PackageVersion Include="Kentico.Xperience.Core.Tests" Version="29.0.0" />
+    <PackageVersion Include="Kentico.Xperience.Admin" Version="29.4.2" />
+    <PackageVersion Include="Kentico.Xperience.WebApp" Version="29.4.2" />
+    <PackageVersion Include="kentico.xperience.azurestorage" Version="29.4.2" />
+    <PackageVersion Include="kentico.xperience.imageprocessing" Version="29.4.2" />
+    <PackageVersion Include="Kentico.Xperience.Core.Tests" Version="29.4.2" />
     <PackageVersion Include="Microsoft.SourceLink.GitHub" Version="8.0.0" />
     <PackageVersion Include="SonarAnalyzer.CSharp" Version="9.20.0.85982" />
 

diff --git a/docs/Custom-index-strategy.md b/docs/Custom-index-strategy.md
@@ -55,7 +55,7 @@ public class ExampleSearchIndexingStrategy : BaseAzureSearchIndexingStrategy<Sim
                     return null;
                 }
 
-                result.Title = page?.ArticleTitle ?? "";
+                result.Title = page?.ArticleTitle ?? string.Empty;
             }
             else
             {
@@ -78,22 +78,22 @@ Some properties of the `IIndexEventItemModel` are added to the indexed data by d
 public class BaseAzureSearchModel : IAzureSearchModel
 {
     [SearchableField(IsSortable = true, IsFilterable = true, IsFacetable = true)]
-    public string? Url { get; set; } = "";
+    public string? Url { get; set; } = string.Empty;
 
     [SearchableField(IsFacetable = true, IsFilterable = true)]
-    public string ContentTypeName { get; set; } = "";
+    public string ContentTypeName { get; set; } = string.Empty;
 
     [SearchableField(IsSortable = true, IsFacetable = true, IsFilterable = true)]
-    public string LanguageName { get; set; } = "";
+    public string LanguageName { get; set; } = string.Empty;
 
     [SimpleField(IsKey = false)]
-    public string ItemGuid { get; set; } = "";
+    public string ItemGuid { get; set; } = string.Empty;
 
     [SimpleField(IsKey = true)]
-    public string ObjectID { get; set; } = "";
+    public string ObjectID { get; set; } = string.Empty;
 
     [SimpleField(IsKey = false)]
-    public string Name { get; set; } = "";
+    public string Name { get; set; } = string.Empty;
 }
 ```
 

diff --git a/docs/Managing-Indexes.md b/docs/Managing-Indexes.md
@@ -12,16 +12,24 @@ Fill out the search index form, populating the fields with your custom values.
 
 ![Administration search edit form](/images/xperience-administration-search-index-edit-form.jpg)
 
-- Rebuild Hook - for validating a request rebuild of the search index from an external source (ex: API request)
-- Indexed Languages - the index will only include content in the selected languages
-- Channel Name - the index will only be triggered by web page item creation or modication in the selected website channel
+- Index Name - the name of the displayed index.
+
+- Included Reusable Content Types - these are the reusable content types that will be processed by your custom indexing strategy.
+If no option is selected, no items will be processed.
+
+- Indexed Languages - the index will only include content in the selected languages.
+
+- Channel Name - the index will only be triggered by web page item creation or modification in the selected website channel.
+
 - Indexing Strategy - the indexing strategy specified in code during dependency registration of a custom indexing strategies.
   - If you want the default strategy to appear here, register it explicitly in `IServiceCollection.AddKenticoAzureSearch()` method
 
+- Rebuild Hook - for validating a request rebuild of the search index from an external source (ex: API request).
+
 Now, configure the web page paths and content types that the search index depends on by clicking the Add New Path button
 or clicking an existing path in the table at the top of the index configuration form.
 
-![Administration search index list](/images/xperience-administration-search-index-edit-form-paths-edit.jpg)
+![Administration search edit paths form](/images/xperience-administration-search-index-edit-form-paths-edit.jpg)
 
 - Included Path - can be an exact relative path of a web page item, (ex: `/path/to/my/page`), or a wildcard path (ex: `/parent-path/%`)
   - To determine a web page path, select the web page in the website channel page tree, then view the "Current URL" in the Content tab of the web page. The path will be the relative path excluding the domain

diff --git a/docs/Scraping-web-page-content.md b/docs/Scraping-web-page-content.md
@@ -47,7 +47,7 @@ public class WebCrawlerService
                 ex,
                 $"Tree Path: {page.SystemFields.WebPageItemTreePath}");
         }
-        return "";
+        return string.Empty;
     }
 
     public async Task<string> CrawlPage(string url)
@@ -65,7 +65,7 @@ public class WebCrawlerService
                 ex,
                 $"Url: {url}");
         }
-        return "";
+        return string.Empty;
     }
 }
 ```
@@ -126,8 +126,8 @@ public class WebScraperHtmlSanitizer
         textContent = HTMLHelper.RegexHtmlToTextWhiteSpace.Replace(textContent, " ");
         textContent = textContent.Trim();
 
-        string title = doc.Head?.QuerySelector("title")?.TextContent ?? "";
-        string description = doc.Head?.QuerySelector("meta[name='description']")?.GetAttribute("content") ?? "";
+        string title = doc.Head?.QuerySelector("title")?.TextContent ?? string.Empty;
+        string description = doc.Head?.QuerySelector("meta[name='description']")?.GetAttribute("content") ?? string.Empty;
 
         return string.Join(
             " ",

diff --git a/docs/Search-index-querying.md b/docs/Search-index-querying.md
@@ -71,8 +71,8 @@ Map Retrieved SearchModel data to a more simple `SearchResultModel`
 ```csharp
 public class SearchResultModel
 {
-    public string Title { get; set; } = "";
-    public string Url { get; set; } = "";
+    public string Title { get; set; } = string.Empty;
+    public string Url { get; set; } = string.Empty;
 }
 ```
 

diff --git a/docs/Semantic-ranking.md b/docs/Semantic-ranking.md
@@ -77,7 +77,7 @@ public class SemanticRankingSearchStrategy : BaseAzureSearchIndexingStrategy<Dan
                     return null;
                 }
 
-                result.Title = page?.CafeTitle ?? "";
+                result.Title = page?.CafeTitle ?? string.Empty;
                 string rawContent = await webCrawler.CrawlWebPage(page!);
                 result.Content = htmlSanitizer.SanitizeHtmlDocument(rawContent);
             }
@@ -95,7 +95,7 @@ public class SemanticRankingSearchStrategy : BaseAzureSearchIndexingStrategy<Dan
                     return null;
                 }
 
-                result.Title = page?.ArticleTitle ?? "";
+                result.Title = page?.ArticleTitle ?? string.Empty;
                 string rawContent = await webCrawler.CrawlWebPage(page!);
                 result.Content = htmlSanitizer.SanitizeHtmlDocument(rawContent);
             }

diff --git a/docs/Using-OData-geo-spatial-functions.md b/docs/Using-OData-geo-spatial-functions.md
@@ -54,8 +54,8 @@ public class GeoLocationSearchStrategy : BaseAzureSearchIndexingStrategy<GeoLoca
                     return null;
                 }
 
-                result.Title = page?.CafeTitle ?? "";
-                result.Location = page?.CafeLocation ?? "";
+                result.Title = page?.CafeTitle ?? string.Empty;
+                result.Location = page?.CafeLocation ?? string.Empty;
 
                 //We can use this value later to sort by distance from the user accessing our search page.
                 //Example for this scenario is shown in DancingGoatSearchService.GeoSearch
@@ -144,9 +144,9 @@ Map Retrieved SearchModel data to a more simple `GeoLocationSearchResult`
 ```csharp
 public class GeoLocationSearchResult
 {
-    public string Title { get; set; } = "";
-    public string Url { get; set; } = "";
-    public string Location { get; set; } = "";
+    public string Title { get; set; } = string.Empty;
+    public string Url { get; set; } = string.Empty;
+    public string Location { get; set; } = string.Empty;
 }
 ```
 

diff --git a/examples/DancingGoat/Search/DancingGoatSearchStartupExtensions.cs b/examples/DancingGoat/Search/DancingGoatSearchStartupExtensions.cs
@@ -15,6 +15,7 @@ public static IServiceCollection AddKenticoAzureSearchServices(this IServiceColl
             builder.RegisterStrategy<DancingGoatSimpleSearchStrategy, DancingGoatSimpleSearchModel>(nameof(DancingGoatSimpleSearchStrategy));
             builder.RegisterStrategy<GeoLocationSearchStrategy, GeoLocationSearchModel>(nameof(GeoLocationSearchStrategy));
             builder.RegisterStrategy<CustomItemsReindexingSearchStrategy, DancingGoatSearchModel>(nameof(CustomItemsReindexingSearchStrategy));
+            builder.RegisterStrategy<ReusableContentItemsIndexingStrategy, DancingGoatSearchModel>(nameof(ReusableContentItemsIndexingStrategy));
         }, configuration);
 
         services.AddTransient<DancingGoatSearchService>();

diff --git a/examples/DancingGoat/Search/Models/DancingGoatSearchResult.cs b/examples/DancingGoat/Search/Models/DancingGoatSearchResult.cs
@@ -2,6 +2,6 @@
 
 public class DancingGoatSearchResult
 {
-    public string Title { get; set; } = "";
-    public string Url { get; set; } = "";
+    public string Title { get; set; } = string.Empty;
+    public string Url { get; set; } = string.Empty;
 }
diff --git a/examples/DancingGoat/Search/Models/GeoLocationSearchResult.cs b/examples/DancingGoat/Search/Models/GeoLocationSearchResult.cs
@@ -2,7 +2,7 @@
 
 public class GeoLocationSearchResult
 {
-    public string Title { get; set; } = "";
-    public string Url { get; set; } = "";
-    public string Location { get; set; } = "";
+    public string Title { get; set; } = string.Empty;
+    public string Url { get; set; } = string.Empty;
+    public string Location { get; set; } = string.Empty;
 }
diff --git a/examples/DancingGoat/Search/Services/WebCrawlerService.cs b/examples/DancingGoat/Search/Services/WebCrawlerService.cs
@@ -44,7 +44,7 @@ public async Task<string> CrawlWebPage(IWebPageFieldsSource page)
                 ex,
                 $"Tree Path: {page.SystemFields.WebPageItemTreePath}");
         }
-        return "";
+        return string.Empty;
     }
 
     public async Task<string> CrawlPage(string url)
@@ -62,6 +62,6 @@ public async Task<string> CrawlPage(string url)
                 ex,
                 $"Url: {url}");
         }
-        return "";
+        return string.Empty;
     }
 }
diff --git a/examples/DancingGoat/Search/Strategies/CustomItemsReindexingSearchStrategy.cs b/examples/DancingGoat/Search/Strategies/CustomItemsReindexingSearchStrategy.cs
@@ -87,70 +87,67 @@ public override async Task<IAzureSearchModel> MapToAzureSearchModelOrNull(IIndex
 
         // IIndexEventItemModel could be a reusable content item or a web page item, so we use
         // pattern matching to get access to the web page item specific type and fields
-        if (item is IndexEventWebPageItemModel indexedPage)
+        if (item is not IndexEventWebPageItemModel indexedPage)
         {
-            if (string.Equals(item.ContentTypeName, CafePage.CONTENT_TYPE_NAME, StringComparison.OrdinalIgnoreCase))
+            return null;
+        }
+        if (string.Equals(item.ContentTypeName, CafePage.CONTENT_TYPE_NAME, StringComparison.OrdinalIgnoreCase))
+        {
+            // The implementation of GetPage<T>() is below
+            var page = await strategyHelper.GetPage<CafePage>(
+                indexedPage.ItemGuid,
+                indexedPage.WebsiteChannelName,
+                indexedPage.LanguageName,
+                CafePage.CONTENT_TYPE_NAME);
+
+            if (page is null)
             {
-                // The implementation of GetPage<T>() is below
-                var page = await strategyHelper.GetPage<CafePage>(
-                    indexedPage.ItemGuid,
-                    indexedPage.WebsiteChannelName,
-                    indexedPage.LanguageName,
-                    CafePage.CONTENT_TYPE_NAME);
-
-                if (page is null)
-                {
-                    return null;
-                }
-
-                result.Title = page?.CafeTitle ?? "";
-                string rawContent = await webCrawler.CrawlWebPage(page!);
-                result.Content = htmlSanitizer.SanitizeHtmlDocument(rawContent);
+                return null;
             }
-            else if (string.Equals(item.ContentTypeName, ArticlePage.CONTENT_TYPE_NAME, StringComparison.OrdinalIgnoreCase))
+
+            result.Title = page?.CafeTitle ?? string.Empty;
+            string rawContent = await webCrawler.CrawlWebPage(page!);
+            result.Content = htmlSanitizer.SanitizeHtmlDocument(rawContent);
+        }
+        else if (string.Equals(item.ContentTypeName, ArticlePage.CONTENT_TYPE_NAME, StringComparison.OrdinalIgnoreCase))
+        {
+            // The implementation of GetPage<T>() is below
+            var page = await strategyHelper.GetPage<ArticlePage>(
+                indexedPage.ItemGuid,
+                indexedPage.WebsiteChannelName,
+                indexedPage.LanguageName,
+                ArticlePage.CONTENT_TYPE_NAME);
+
+            if (page is null)
             {
-                // The implementation of GetPage<T>() is below
-                var page = await strategyHelper.GetPage<ArticlePage>(
-                    indexedPage.ItemGuid,
-                    indexedPage.WebsiteChannelName,
-                    indexedPage.LanguageName,
-                    ArticlePage.CONTENT_TYPE_NAME);
-
-                if (page is null)
-                {
-                    return null;
-                }
-
-                result.Title = page?.ArticleTitle ?? "";
-                string rawContent = await webCrawler.CrawlWebPage(page!);
-                result.Content = htmlSanitizer.SanitizeHtmlDocument(rawContent);
+                return null;
             }
-            else if (string.Equals(item.ContentTypeName, HomePage.CONTENT_TYPE_NAME, StringComparison.OrdinalIgnoreCase))
+
+            result.Title = page?.ArticleTitle ?? string.Empty;
+            string rawContent = await webCrawler.CrawlWebPage(page!);
+            result.Content = htmlSanitizer.SanitizeHtmlDocument(rawContent);
+        }
+        else if (string.Equals(item.ContentTypeName, HomePage.CONTENT_TYPE_NAME, StringComparison.OrdinalIgnoreCase))
+        {
+            var page = await strategyHelper.GetPage<HomePage>(
+                indexedPage.ItemGuid,
+                indexedPage.WebsiteChannelName,
+                indexedPage.LanguageName,
+                HomePage.CONTENT_TYPE_NAME);
+
+            if (page is null)
             {
-                var page = await strategyHelper.GetPage<HomePage>(
-                    indexedPage.ItemGuid,
-                    indexedPage.WebsiteChannelName,
-                    indexedPage.LanguageName,
-                    HomePage.CONTENT_TYPE_NAME);
-
-                if (page is null)
-                {
-                    return null;
-                }
-
-                if (page.HomePageBanner.IsNullOrEmpty())
-                {
-                    return null;
-                }
-
-                result.Title = page!.HomePageBanner.First().BannerHeaderText;
-                string rawContent = await webCrawler.CrawlWebPage(page!);
-                result.Content = htmlSanitizer.SanitizeHtmlDocument(rawContent);
+                return null;
             }
-            else
+
+            if (page.HomePageBanner.IsNullOrEmpty())
             {
                 return null;
             }
+
+            result.Title = page!.HomePageBanner.First().BannerHeaderText;
+            string rawContent = await webCrawler.CrawlWebPage(page!);
+            result.Content = htmlSanitizer.SanitizeHtmlDocument(rawContent);
         }
         else
         {