V18/wip elements

Directory.Build.props

@@ -1,6 +1,6 @@
 <Project>
     <PropertyGroup>
-		<VersionPrefix>17.0.0</VersionPrefix>
+		<VersionPrefix>18.0.0</VersionPrefix>
 		<Authors>Kevin Jump</Authors>
 		<Company>Jumoo</Company>
 

Directory.Packages.props

@@ -12,25 +12,25 @@
   </ItemGroup>
   <!-- umbraco libraries for packages -->
   <ItemGroup>
-    <PackageVersion Include="Umbraco.Cms.Core" Version="18.0.0-beta1" />
-    <PackageVersion Include="Umbraco.Cms.Web.Website" Version="18.0.0-beta1" />
-    <PackageVersion Include="Umbraco.Cms.Api.Management" Version="18.0.0-beta1" />
+    <PackageVersion Include="Umbraco.Cms.Core" Version="18.0.0-rc2" />
+    <PackageVersion Include="Umbraco.Cms.Web.Website" Version="18.0.0-rc2" />
+    <PackageVersion Include="Umbraco.Cms.Api.Management" Version="18.0.0-rc2" />
   </ItemGroup>
   <!-- source link -->
   <ItemGroup>
-    <PackageVersion Include="Microsoft.SourceLink.GitHub" Version="10.0.201" />
+    <PackageVersion Include="Microsoft.SourceLink.GitHub" Version="10.0.300" />
   </ItemGroup>
   <!-- testing -->
   <ItemGroup>
-    <PackageVersion Include="Umbraco.Cms.Tests" Version="18.0.0-beta1" />
-    <PackageVersion Include="Umbraco.Cms.Tests.Integration" Version="18.0.0-beta1" />
-    <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="18.5.1" />
+    <PackageVersion Include="Umbraco.Cms.Tests" Version="18.0.0-rc2" />
+    <PackageVersion Include="Umbraco.Cms.Tests.Integration" Version="18.0.0-rc2" />
+    <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="18.6.0" />
     <PackageVersion Include="NUnit3TestAdapter" Version="6.2.0" />
-    <PackageVersion Include="coverlet.collector" Version="8.0.1" />
+    <PackageVersion Include="coverlet.collector" Version="10.0.1" />
   </ItemGroup>
   <!-- command line -->
   <ItemGroup>
-    <PackageVersion Include="NJsonSchema" Version="11.5.2" />
+    <PackageVersion Include="NJsonSchema" Version="11.6.1" />
     <PackageVersion Include="CommandLineParser" Version="2.9.1" />
   </ItemGroup>
 </Project>

uSync.AutoTemplates/AutoTemplateComposer.cs

@@ -1,4 +1,6 @@
-using Umbraco.Cms.Core.Composing;
+using System.Linq;
+
+using Umbraco.Cms.Core.Composing;
 using Umbraco.Cms.Core.DependencyInjection;
 
 namespace uSync.AutoTemplates;
@@ -7,6 +9,8 @@ public class AutoTemplateComposer : IComposer
 {
     public void Compose(IUmbracoBuilder builder)
     {
-        builder.AdduSyncAutoTemplates();
+        // only load when the backoffice is enabled. 
+        if (builder.Services.Any(s => s.ServiceType == typeof(IBackOfficeEnabledMarker)))
+            builder.AdduSyncAutoTemplates();
     }
 }

uSync.AutoTemplates/packages.lock.json

@@ -4,9 +4,9 @@
     "net10.0": {
       "Umbraco.Cms.Core": {
         "type": "Direct",
-        "requested": "[18.0.0-beta2, )",
-        "resolved": "18.0.0-beta2",
-        "contentHash": "Qp9B8+Zq+sA2UVuQQ4k6QIVGmiadii5t1uwaiPng1SObLz9anaz6hdcDVX7ihctGBK1lxuGofSm9fk7OK3Uhfw==",
+        "requested": "[18.0.0-rc2, )",
+        "resolved": "18.0.0-rc2",
+        "contentHash": "aJU2hB4I3eJSNPCzx7HbnF9+GuHFSUINo4qlXuywE1Tk/1ctfTvCYqewGbPU3uJEgSAvOm6OD/j94zTlg9b1OA==",
         "dependencies": {
           "Microsoft.Extensions.Caching.Abstractions": "10.0.7",
           "Microsoft.Extensions.Caching.Memory": "10.0.7",

uSync.BackOffice/BackOfficeConstants.cs

@@ -93,6 +93,11 @@ public static class Priorites
         /// </summary>
         public const int Macros = USYNC_RESERVED_LOWER + 70;
 
+        /// <summary>
+        ///  Elements Priority.
+        /// </summary>
+        public const int Elements = USYNC_RESERVED_LOWER + 190;
+
         /// <summary>
         /// Media priority
         /// </summary>
@@ -259,5 +264,11 @@ public static class Handlers
         public const string WebhookHandler = "WebhookHandler";
 
 
+        /// <summary>
+        ///  Handler for Element (Library) items 
+        /// </summary>
+        public const string ElementHandler = "ElementHandler";
+
+
     }
 }

uSync.BackOffice/Cache/CacheLifecycleManager.cs

@@ -26,6 +26,9 @@ public class CacheLifecycleManager :
     INotificationAsyncHandler<ContentSavingNotification>,
     INotificationAsyncHandler<ContentDeletingNotification>,
     INotificationAsyncHandler<ContentMovingNotification>,
+    INotificationAsyncHandler<ElementSavingNotification>,
+    INotificationAsyncHandler<ElementDeletingNotification>,
+    INotificationAsyncHandler<ElementMovingNotification>,
     INotificationAsyncHandler<MediaSavingNotification>,
     INotificationAsyncHandler<MediaSavedNotification>,
     INotificationAsyncHandler<MediaDeletedNotification>
@@ -95,6 +98,22 @@ public CacheLifecycleManager(
     /// </summary>
     public Task HandleAsync(ContentMovingNotification notification, CancellationToken c) => ClearOnEvents();
 
+    /// <summary>
+    ///  clear the cache on the Umbraco Element Saving notification
+    /// </summary>
+    public Task HandleAsync(ElementSavingNotification notification, CancellationToken c) => ClearOnEvents();
+
+    /// <summary>
+    ///  clear the cache on the Umbraco Element Deleting notification
+    /// </summary> 
+    public Task HandleAsync(ElementDeletingNotification notification, CancellationToken c) => ClearOnEvents();
+
+    /// <summary>
+    ///  clear the cache on the Element Moving notification 
+    /// </summary>
+    public Task HandleAsync(ElementMovingNotification notification, CancellationToken c) => ClearOnEvents();
+
+
     /// <summary>
     ///  Clear the cache on the Umbraco Media Saving notification 
     /// </summary>

uSync.BackOffice/Extensions/uSyncActionExtensions.cs

@@ -137,7 +137,9 @@ public static void UpdateActions<TObject>(this List<uSyncAction> actions, Guid k
     public static bool RequiresSave<TObject>(this SyncAttempt<TObject> attempt)
         => attempt.Success && attempt.Change > Core.ChangeType.NoChange && !attempt.Saved && attempt.Item != null;
 
-
+    /// <summary>
+    ///  return the uSyncAction as an ActionView (used in the controllers)
+    /// </summary>
     public static uSyncActionView AsActionView(this uSyncAction action)
     {
         var msg = string.IsNullOrWhiteSpace(action.Message) is false

uSync.BackOffice/HealthChecks/SyncFolderIntegrityChecks.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.IO;
+using System.Linq;
 using System.Threading.Tasks;
 using System.Xml.Linq;
 
@@ -20,8 +21,10 @@ namespace uSync.BackOffice.HealthChecks;
     Group = "uSync")]
 public class SyncFolderIntegrityChecks : HealthCheck
 {
-    private readonly ISyncConfigService _configService;
-    private readonly ISyncFileService _fileService;
+    private readonly ISyncConfigService? _configService;
+    private readonly ISyncFileService? _fileService;
+
+    public SyncFolderIntegrityChecks() { }
 
     /// <summary>
     ///  Constructor 
@@ -41,6 +44,9 @@ public override HealthCheckStatus ExecuteAction(HealthCheckAction action)
     /// <inheritdoc/>
     public override Task<IEnumerable<HealthCheckStatus>> GetStatusAsync()
     {
+        if (_configService is null || _fileService is null) 
+            return Task.FromResult(Enumerable.Empty<HealthCheckStatus>());
+
         var items = new List<HealthCheckStatus>
         {
             CheckuSyncFolder(),
@@ -52,6 +58,9 @@ public override Task<IEnumerable<HealthCheckStatus>> GetStatusAsync()
 
     private HealthCheckStatus CheckuSyncFolder()
     {
+        if (_configService is null || _fileService is null)
+            return new HealthCheckStatus("Unable to check uSync folder integrity");
+
         var root = _fileService.GetAbsPath(_configService.GetWorkingFolder());
 
         if (_fileService.DirectoryExists(root) is false)
@@ -85,6 +94,8 @@ private HealthCheckStatus CheckuSyncFolder()
 
     private List<string> CheckFolder(string folder)
     {
+        if (_fileService is null) return [];
+
         var _keys = new Dictionary<Guid, string>();
 
         var clashes = new List<string>();
@@ -128,6 +139,9 @@ private List<string> CheckFolder(string folder)
 
     private HealthCheckStatus CheckConfigFolderValidity()
     {
+        if (_configService is null || _fileService is null)
+            return new HealthCheckStatus("Unable to check uSync folder integrity");
+
         var root = _fileService.GetAbsPath(_configService.GetWorkingFolder());
 
         if (_fileService.DirectoryExists(root) is false)

uSync.BackOffice/Services/ISyncVersionFileService.cs

@@ -2,8 +2,20 @@
 
 namespace uSync.BackOffice.Services;
 
+/// <summary>
+///  Controls the version file we write to disk on syncs (used to warn if sync is old)
+/// </summary>
 public interface ISyncVersionFileService
 {
+    /// <summary>
+    ///  get the Sync file version information for a folder. 
+    /// </summary>
     Task<SyncFileVersionCheckResult> GetSyncFileInfo(string folder);
+
+    /// <summary>
+    ///  write the version information to disk. 
+    /// </summary>
+    /// <param name="folder"></param>
+    /// <returns></returns>
     Task WriteVersionFileAsync(string folder);
 }

uSync.BackOffice/Services/SyncActionService.cs

@@ -13,7 +13,6 @@
 using uSync.BackOffice.Configuration;
 using uSync.BackOffice.Extensions;
 using uSync.BackOffice.Models;
-using uSync.BackOffice.SyncHandlers;
 using uSync.BackOffice.SyncHandlers.Models;
 
 namespace uSync.BackOffice.Services;

uSync.BackOffice/Services/SyncVersionFileService.cs

@@ -119,9 +119,23 @@ private bool HmacValuesMatch(XElement node)
     }
 }
 
+/// <summary>
+///  results of a check of the version file 
+/// </summary>
 public class SyncFileVersionCheckResult
 {
+    /// <summary>
+    ///  the sync on disk is current to the current format we are writing. 
+    /// </summary>
     public bool IsCurrent { get; set; }
+
+    /// <summary>
+    ///  the version we are writing to disk
+    /// </summary>
     public string? FormatVersion { get; set; }
+
+    /// <summary>
+    ///  the hmac value for the folders matches. (reserved)
+    /// </summary>
     public bool HmacMatch { get; set; }
 }

uSync.BackOffice/SyncHandlers/Handlers/ContentHandler.cs

@@ -30,7 +30,7 @@ namespace uSync.BackOffice.SyncHandlers.Handlers;
 /// </summary>
 [SyncHandler(uSyncConstants.Handlers.ContentHandler, "Content", "Content", uSyncConstants.Priorites.Content
     , Icon = "icon-document", IsTwoPass = true, EntityType = UdiEntityType.Document)]
-public class ContentHandler : ContentHandlerBase<IContent>, ISyncHandler,
+public class ContentHandler : PublishableContentHandlerBase<IContent>, ISyncHandler,
 
     INotificationAsyncHandler<SavedNotification<IContent>>,
     INotificationAsyncHandler<DeletedNotification<IContent>>,
@@ -77,34 +77,10 @@ public ContentHandler(
     protected override Task<bool> HasChildrenAsync(IContent item)
         => Task.FromResult(_contentService.HasChildren(item.Id));
 
-    /// <summary>
-    ///  Get child items 
-    /// </summary>
-    /// <remarks>
-    ///  The core method works for all services, (using entities) - but if we look up
-    ///  the actual type for content and media, we save ourselves an extra lookup later on
-    ///  and this speeds up the itteration by quite a bit (onle less db trip per item).
-    /// </remarks>
-    protected override Task<IEnumerable<IEntity>> GetChildItemsAsync(IEntity? parent)
-    {
-        return uSyncTaskHelper.FromResultOf<IEnumerable<IEntity>>(() =>
-        {
-            if (parent is null) return _contentService.GetRootContent();
-
-            var items = new List<IContent>();
-            const int pageSize = 5000;
-            var page = 0;
-            var total = long.MaxValue;
-            while (page * pageSize < total)
-            {
-                items.AddRange(_contentService.GetPagedChildren(parent.Id, page++, pageSize, out total));
-            }
-            return items;
-
-        });
-    }
+    protected override IEnumerable<IEntity> GetRootItems()
+        => _contentService.GetRootContent();
 
-    /// <summary>
+     /// <summary>
     ///  Handle the publish events for content
     /// </summary>
     /// <remarks>
@@ -143,22 +119,4 @@ public async Task HandleAsync(ContentUnpublishedNotification notification, Cance
             await ProcessItem(notification, item, handlerFolders);
         }
     }
-
-    private async Task ProcessItem(EnumerableObjectNotification<IContent> notification, IContent item, string[] handlerFolders)
-    {
-        try
-        {
-            var attempts = await ExportAsync(item, handlerFolders, DefaultConfig);
-            foreach (var attempt in attempts.Where(x => x.Success))
-            {
-                if (attempt.FileName is null) continue;
-                await this.CleanUpAsync(item, attempt.FileName, handlerFolders.Last());
-            }
-        }
-        catch (Exception ex)
-        {
-            logger.LogWarning(ex, "Failed to create uSync export file");
-            notification.Messages.Add(new EventMessage("uSync", $"Failed to create export file : {ex.Message}", EventMessageType.Warning));
-        }
-    }
 }

uSync.BackOffice/SyncHandlers/Handlers/ContentHandlerBase.cs

@@ -18,6 +18,8 @@
 using uSync.Core;
 using uSync.Core.Serialization;
 
+using uSyncCoreConstants = uSync.Core.uSyncConstants;
+
 namespace uSync.BackOffice.SyncHandlers.Handlers;
 
 /// <summary>
@@ -103,8 +105,9 @@ protected override async Task<bool> ShouldImportAsync(XElement node, HandlerSett
     private static bool ShouldImportTrashedItem(XElement node, HandlerSettings config)
     {
         // unless the setting is explicit we don't import trashed items. 
-        var trashed = node.Element("Info")?.Element("Trashed").ValueOrDefault(false);
-        if (trashed.GetValueOrDefault(false) && !config.GetSetting("ImportTrashed", false)) return false;
+        var isTrashed = node.IsTrashed();
+        if (isTrashed && !config.GetSetting(uSyncCoreConstants.DefaultSettings.ImportTrashed,
+            uSyncCoreConstants.DefaultSettings.ImportTrashed_Default)) return false;
 
         return true;
     }
@@ -116,7 +119,7 @@ private bool ImportPaths(XElement node, HandlerSettings config)
 
         if (include.Length > 0)
         {
-            var path = node.Element("Info")?.Element("Path").ValueOrDefault(string.Empty);
+            var path = node.GetPath();
             if (!string.IsNullOrWhiteSpace(path) && !include.Any(x => path.InvariantStartsWith(x)))
             {
                 if (logger.IsEnabled(LogLevel.Debug))
@@ -130,7 +133,7 @@ private bool ImportPaths(XElement node, HandlerSettings config)
             .Split([','], StringSplitOptions.RemoveEmptyEntries);
         if (exclude.Length > 0)
         {
-            var path = node.Element("Info")?.Element("Path").ValueOrDefault(string.Empty);
+            var path = node.GetPath();
             if (!string.IsNullOrWhiteSpace(path) && exclude.Any(x => path.InvariantStartsWith(x)))
             {
                 if (logger.IsEnabled(LogLevel.Debug))
@@ -183,8 +186,8 @@ protected override async Task<bool> ShouldExportAsync(XElement node, HandlerSett
         if (!await base.ShouldExportAsync(node, config)) return false;
 
         // We export trashed items by default, (but we don't import them by default)
-        var trashed = node.Element("Info")?.Element("Trashed").ValueOrDefault(false);
-        if (trashed.GetValueOrDefault(false) && !config.GetSetting<bool>("ExportTrashed", true)) return false;
+        var isTrashed = node.IsTrashed();
+        if (isTrashed && !config.GetSetting<bool>("ExportTrashed", true)) return false;
 
         if (config.GetSetting("RulesOnExport", false))
         {