Merge pull request #7 from Relewise/feat/minor-refactorings-export

feat: minor changes to integration/extension

Author: mzanoni

Relewise.Integrations.Umbraco.sln.DotSettings

@@ -1,5 +1,6 @@
 <wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=dataset/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=recommender/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Relewise/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Trackable/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Umbraco/@EntryIndexedValue">True</s:Boolean></wpf:ResourceDictionary>

src/Integrations.Umbraco/App_Plugins/Relewise.Dashboard/dashboard.html

@@ -3,7 +3,7 @@ <h2>Relewise</h2>
     <umb-box>
         <umb-box-content>
             <p>
-                Welcome to the Relewise dashboard - Here you can perform export functions get all your content exported into Relewise.<br />
+                Welcome to the Relewise dashboard - here you can perform export functions to get all your content exported into Relewise.<br />
                 It's also possible to see the settings for Relewise directly here.
             </p>
             <div class="button-box">
@@ -24,11 +24,11 @@ <h3>Settings</h3>
     <umb-box>
         <umb-box-content>
             <p>
-                These are the settings registered with for Relewise.
+                These are the settings registered with Relewise.
             </p>
 
             <p class="error" ng-if="vm.configurationError">
-                No options has been configured. Please check your call to the 'services.AddRelewise(options => { /* options goes here */ })'-method.
+                No options have been configured. Please check your call to the 'services.AddRelewise(options => { /* options goes here */ })'-method in 'Startup.cs'.
             </p>
             <div ng-if="vm.configuration !== null">
                 Tracked content types are: <strong>{{vm.configuration.trackedContentTypes.join(', ')}}</strong><br />

src/Integrations.Umbraco/Controllers/DashboardApiController.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Diagnostics.CodeAnalysis;
 using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
@@ -92,12 +93,14 @@ public IActionResult Configuration()
 
         return Ok(new
         {
-            TrackedContentTypes = _configuration.TrackedContentTypes,
-            ExportedContentTypes = _configuration.ExportedContentTypes,
+            _configuration.TrackedContentTypes,
+            _configuration.ExportedContentTypes,
             Named = named
         });
     }
 
+    [SuppressMessage("ReSharper", "MemberCanBePrivate.Local")]
+    [SuppressMessage("ReSharper", "UnusedAutoPropertyAccessor.Local")]
     private class NamedOptionsViewObject
     {
         public NamedOptionsViewObject(string name, ClientOptionsViewObject tracker, ClientOptionsViewObject recommender, ClientOptionsViewObject searcher)
@@ -115,6 +118,8 @@ public NamedOptionsViewObject(string name, ClientOptionsViewObject tracker, Clie
         public ClientOptionsViewObject Searcher { get; }
     }
 
+    [SuppressMessage("ReSharper", "MemberCanBePrivate.Local")]
+    [SuppressMessage("ReSharper", "UnusedAutoPropertyAccessor.Local")]
     private class ClientOptionsViewObject
     {
         public ClientOptionsViewObject(RelewiseClientOptions options)

src/Integrations.Umbraco/NotificationHandlers/RelewiseContentDeletedNotificationNotificationHandler.cs

@@ -1,25 +1,33 @@
 using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
 using Relewise.Client;
 using Relewise.Client.DataTypes;
 using Relewise.Client.Requests.Filters;
+using Relewise.Integrations.Umbraco.Services;
 using Umbraco.Cms.Core.Events;
 using Umbraco.Cms.Core.Notifications;
 
 namespace Relewise.Integrations.Umbraco.NotificationHandlers;
 
-internal class RelewiseContentDeletedNotificationNotificationHandler : INotificationHandler<ContentDeletedNotification>
+internal class RelewiseContentDeletedNotificationNotificationHandler : INotificationAsyncHandler<ContentDeletedNotification>
 {
+    private readonly IExportContentService _exportContentService;
     private readonly RelewiseUmbracoConfiguration _configuration;
-    private readonly ITracker _tracker;
 
-    public RelewiseContentDeletedNotificationNotificationHandler(RelewiseUmbracoConfiguration configuration, ITracker tracker)
+    public RelewiseContentDeletedNotificationNotificationHandler(IExportContentService exportContentService, RelewiseUmbracoConfiguration configuration)
     {
+        _exportContentService = exportContentService;
         _configuration = configuration;
-        _tracker = tracker;
     }
 
-    public void Handle(ContentDeletedNotification notification)
+    public async Task HandleAsync(ContentDeletedNotification notification, CancellationToken cancellationToken)
     {
+        ITracker? tracker = _exportContentService.GetTrackerOrNull();
+
+        if (tracker == null)
+            return;
+
         string[] ids = notification.DeletedEntities
             .Where(x => _configuration.CanMap(x))
             .Select(x => x.Id.ToString())
@@ -28,10 +36,12 @@ public void Handle(ContentDeletedNotification notification)
         if (ids.Length == 0)
             return;
 
-        _tracker.Track(new ContentAdministrativeAction(
+        var action = new ContentAdministrativeAction(
             Language.Undefined,
             Currency.Undefined,
             new FilterCollection(new ContentIdFilter(ids)),
-            ContentAdministrativeAction.UpdateKind.PermanentlyDelete));
+            ContentAdministrativeAction.UpdateKind.PermanentlyDelete);
+
+        await tracker.TrackAsync(action, cancellationToken);
     }
 }

src/Integrations.Umbraco/NotificationHandlers/RelewiseContentMovedNotificationHandler.cs

@@ -1,27 +1,35 @@
 using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
 using Relewise.Client;
 using Relewise.Client.DataTypes;
 using Relewise.Client.Requests.Filters;
+using Relewise.Integrations.Umbraco.Services;
 using Umbraco.Cms.Core.Events;
 using Umbraco.Cms.Core.Notifications;
 
 namespace Relewise.Integrations.Umbraco.NotificationHandlers;
 
-internal class RelewiseContentMovedNotificationHandler : INotificationHandler<ContentMovedNotification>
+internal class RelewiseContentMovedNotificationHandler : INotificationAsyncHandler<ContentMovedNotification>
 {
     private const int TrashCanId = -1;
 
+    private readonly IExportContentService _exportContentService;
     private readonly RelewiseUmbracoConfiguration _configuration;
-    private readonly ITracker _tracker;
 
-    public RelewiseContentMovedNotificationHandler(RelewiseUmbracoConfiguration configuration, ITracker tracker)
+    public RelewiseContentMovedNotificationHandler(IExportContentService exportContentService, RelewiseUmbracoConfiguration configuration)
     {
+        _exportContentService = exportContentService;
         _configuration = configuration;
-        _tracker = tracker;
     }
 
-    public void Handle(ContentMovedNotification notification)
+    public async Task HandleAsync(ContentMovedNotification notification, CancellationToken cancellationToken)
     {
+        ITracker? tracker = _exportContentService.GetTrackerOrNull();
+
+        if (tracker == null)
+            return;
+
         string[] ids = notification.MoveInfoCollection
             .Where(x => _configuration.CanMap(x.Entity) && x.NewParentId == TrashCanId)
             .Select(x => x.Entity.Id.ToString())
@@ -30,10 +38,12 @@ public void Handle(ContentMovedNotification notification)
         if (ids.Length == 0)
             return;
 
-        _tracker.Track(new ContentAdministrativeAction(
+        var action = new ContentAdministrativeAction(
             Language.Undefined,
             Currency.Undefined,
             new FilterCollection(new ContentIdFilter(ids)),
-            ContentAdministrativeAction.UpdateKind.DisableInRecommendations));
+            ContentAdministrativeAction.UpdateKind.DisableInRecommendations);
+
+        await tracker.TrackAsync(action, cancellationToken);
     }
 }

src/Integrations.Umbraco/NotificationHandlers/RelewiseContentPublishedNotificationHandler.cs

@@ -1,12 +1,13 @@
 using System.Linq;
 using System.Threading;
+using System.Threading.Tasks;
 using Relewise.Integrations.Umbraco.Services;
 using Umbraco.Cms.Core.Events;
 using Umbraco.Cms.Core.Notifications;
 
 namespace Relewise.Integrations.Umbraco.NotificationHandlers;
 
-internal class RelewiseContentPublishedNotificationHandler : INotificationHandler<ContentPublishedNotification>
+internal class RelewiseContentPublishedNotificationHandler : INotificationAsyncHandler<ContentPublishedNotification>
 {
     private readonly IExportContentService _exportContentService;
 
@@ -15,8 +16,8 @@ public RelewiseContentPublishedNotificationHandler(IExportContentService exportC
         _exportContentService = exportContentService;
     }
 
-    public void Handle(ContentPublishedNotification notification)
+    public async Task HandleAsync(ContentPublishedNotification notification, CancellationToken cancellationToken)
     {
-        _exportContentService.Export(new ExportContent(notification.PublishedEntities.ToArray()), CancellationToken.None);
+        await _exportContentService.Export(new ExportContent(notification.PublishedEntities.ToArray()), cancellationToken);
     }
 }

src/Integrations.Umbraco/NotificationHandlers/RelewiseContentUnpublishedNotificationHandler.cs

@@ -1,26 +1,34 @@
 using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
 using Relewise.Client;
 using Relewise.Client.DataTypes;
 using Relewise.Client.Requests.Filters;
+using Relewise.Integrations.Umbraco.Services;
 using Umbraco.Cms.Core.Events;
 using Umbraco.Cms.Core.Notifications;
 using Language = Relewise.Client.DataTypes.Language;
 
 namespace Relewise.Integrations.Umbraco.NotificationHandlers;
 
-internal class RelewiseContentUnpublishedNotificationHandler : INotificationHandler<ContentUnpublishedNotification>
+internal class RelewiseContentUnpublishedNotificationHandler : INotificationAsyncHandler<ContentUnpublishedNotification>
 {
+    private readonly IExportContentService _exportContentService;
     private readonly RelewiseUmbracoConfiguration _configuration;
-    private readonly ITracker _tracker;
 
-    public RelewiseContentUnpublishedNotificationHandler(RelewiseUmbracoConfiguration configuration, ITracker tracker)
+    public RelewiseContentUnpublishedNotificationHandler(IExportContentService exportContentService, RelewiseUmbracoConfiguration configuration)
     {
+        _exportContentService = exportContentService;
         _configuration = configuration;
-        _tracker = tracker;
     }
 
-    public void Handle(ContentUnpublishedNotification notification)
+    public async Task HandleAsync(ContentUnpublishedNotification notification, CancellationToken cancellationToken)
     {
+        ITracker? tracker = _exportContentService.GetTrackerOrNull();
+
+        if (tracker == null)
+            return;
+
         string[] ids = notification.UnpublishedEntities
             .Where(x => _configuration.CanMap(x))
             .Select(x => x.Id.ToString())
@@ -29,10 +37,12 @@ public void Handle(ContentUnpublishedNotification notification)
         if (ids.Length == 0)
             return;
 
-        _tracker.Track(new ContentAdministrativeAction(
+        var action = new ContentAdministrativeAction(
             Language.Undefined,
             Currency.Undefined,
             new FilterCollection(new ContentIdFilter(ids)),
-            ContentAdministrativeAction.UpdateKind.DisableInRecommendations));
+            ContentAdministrativeAction.UpdateKind.DisableInRecommendations);
+
+        await tracker.TrackAsync(action, cancellationToken);
     }
 }

src/Integrations.Umbraco/Services/ContentMapper.cs

@@ -27,7 +27,7 @@ public ContentMapper(RelewiseUmbracoConfiguration configuration, IUmbracoContext
         _provider = provider;
     }
 
-    public async Task<MapContentResult> Map(MapContent content)
+    public async Task<MapContentResult> Map(MapContent content, CancellationToken token)
     {
         if (!_configuration.CanMap(content.PublishedContent.ContentType.Alias))
             return MapContentResult.Failed;
@@ -50,7 +50,7 @@ public async Task<MapContentResult> Map(MapContent content)
             CategoryPaths = GetCategoryPaths(content, culturesToPublish)
         });
 
-        await AutoMapOrUseMapper(content, culturesToPublish, contentUpdate, content.Token);
+        await AutoMapOrUseMapper(content, culturesToPublish, contentUpdate, token);
 
         return new MapContentResult(contentUpdate);
     }

src/Integrations.Umbraco/Services/ExportContentService.cs

@@ -36,29 +36,28 @@ public ExportContentService(IContentMapper contentMapper, IUmbracoContextFactory
     public async Task<ExportContentResult> Export(ExportContent exportContent, CancellationToken token)
     {
         if (exportContent == null) throw new ArgumentNullException(nameof(exportContent));
+
         if (exportContent.Contents.Length == 0)
             return new ExportContentResult();
 
         using UmbracoContextReference umbracoContextReference = _umbracoContextFactory.EnsureUmbracoContext();
 
         IPublishedContentCache contentCache = umbracoContextReference.UmbracoContext.Content;
 
-        ITracker tracker;
-        try
-        {
-            var factory = _provider.GetRequiredService<IRelewiseClientFactory>();
-            tracker = factory.GetClient<ITracker>(Constants.NamedClientName);
-        }
-        catch
-        {
-            // tracker is not setup correctly so we just fail silently
+        ITracker? tracker = GetTrackerOrNull();
+
+        if (tracker == null)
             return new ExportContentResult();
-        }
 
         List<ContentUpdate> contentUpdates = new List<ContentUpdate>();
-        foreach (Task<MapContentResult> map in exportContent.Contents.Select(x => _contentMapper.Map(new MapContent(contentCache.GetById(x.Id), exportContent.Version, token))))
+
+        IEnumerable<Task<MapContentResult>> contentMapping = exportContent.Contents
+            .Select(x => _contentMapper.Map(new MapContent(contentCache.GetById(x.Id), exportContent.Version), token));
+
+        foreach (Task<MapContentResult> map in contentMapping)
         {
             MapContentResult result = await map;
+
             if (result.Successful)
                 contentUpdates.Add(result.ContentUpdate!);
         }
@@ -108,4 +107,19 @@ await tracker.TrackAsync(new ContentAdministrativeAction(
 
         return new ExportAllContentResult();
     }
+
+    public ITracker? GetTrackerOrNull()
+    {
+        try
+        {
+            var factory = _provider.GetRequiredService<IRelewiseClientFactory>();
+
+            return factory.GetClient<ITracker>(Constants.NamedClientName);
+        }
+        catch
+        {
+            // tracker is not setup correctly so we just fail silently
+            return null;
+        }
+    }
 }

src/Integrations.Umbraco/Services/IContentMapper.cs

@@ -1,8 +1,9 @@
-using System.Threading.Tasks;
+using System.Threading;
+using System.Threading.Tasks;
 
 namespace Relewise.Integrations.Umbraco.Services;
 
 internal interface IContentMapper
 {
-    Task<MapContentResult> Map(MapContent content);
+    Task<MapContentResult> Map(MapContent content, CancellationToken token);
 }