Merge pull request #6 from Relewise/feat/parse-token

brianhdk · web-flow · commit c8125a3b94c4 · 2022-06-13T12:57:09.000+02:00
Feat: improve exporting
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -25,4 +25,4 @@ jobs:
     - name: Push
       run: dotnet nuget push Relewise.Integrations.Umbraco.${VERSION}.nupkg --source https://api.nuget.org/v3/index.json --api-key ${NUGET_TOKEN}
       env:
-        NUGET_TOKEN: ${{ secrets.NUGET_RELEWISE_UMBRACO_TOKEN }}
+        NUGET_TOKEN: ${{ secrets.NUGET_TOKEN }}
diff --git a/samples/UmbracoV9/App_Plugins/Relewise.Dashboard/dashboard.controller.js b/samples/UmbracoV9/App_Plugins/Relewise.Dashboard/dashboard.controller.js
@@ -18,6 +18,26 @@
         });
     }
 
+    vm.exportContentPermanentlyDelete = function () {
+        const confirmed = confirm("Are you sure, you want to perform an full export and remove deleted content items?");
+        if (!confirmed) {
+            return;
+        }
+
+        vm.exportLoading = true;
+        vm.errorMessage = "";
+        vm.success = "";
+        relewiseDashboardResources.exportContentWithDelete().then(() => {
+            vm.exportLoading = false;
+            vm.success = "Content was successfully exported to Relewise";
+            vm.errorMessage = "";
+        }, () => {
+            vm.exportLoading = false;
+            vm.success = "";
+            vm.errorMessage = "Unexpected error while exporting data happened";
+        });
+    }
+
     function init() {
         relewiseDashboardResources.getConfiguration().then((response) => {
             if (response.status === 200) {
diff --git a/samples/UmbracoV9/App_Plugins/Relewise.Dashboard/dashboard.html b/samples/UmbracoV9/App_Plugins/Relewise.Dashboard/dashboard.html
@@ -2,14 +2,17 @@
     <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 />
                 It's also possible to see the settings for Relewise directly here.
             </p>
-            <div>
+            <div class="button-box">
                 <button class="btn btn-primary" ng-click="vm.exportContent()" ng-disabled="vm.exportLoading">
-                    Full content export
+                    Export content
+                </button>
+
+                <button class="btn btn-danger" ng-click="vm.exportContentPermanentlyDelete()" ng-disabled="vm.exportLoading">
+                    Export content and remove old data
                 </button>
             </div>
             <div class="error mt-10" ng-if="vm.errorMessage">{{vm.errorMessage}}</div>
diff --git a/samples/UmbracoV9/App_Plugins/Relewise.Dashboard/relewise.resources.js b/samples/UmbracoV9/App_Plugins/Relewise.Dashboard/relewise.resources.js
@@ -5,6 +5,9 @@
                 exportContent: function () {
                     return $http.post("/umbraco/backoffice/Relewise/DashboardApi/ContentExport");
                 },
+                exportContentWithDelete: function () {
+                    return $http.post("/umbraco/backoffice/Relewise/DashboardApi/ContentExport?permanentlyDelete=true");
+                },
                 getConfiguration: function () {
                     return $http.get("/umbraco/backoffice/Relewise/DashboardApi/Configuration");
                 }
diff --git a/samples/UmbracoV9/App_Plugins/Relewise.Dashboard/styles.css b/samples/UmbracoV9/App_Plugins/Relewise.Dashboard/styles.css
@@ -29,3 +29,8 @@ h5 {
 .pl-20 {
     padding-left: 20px;
 }
+
+.button-box {
+    display: flex;
+    justify-content: space-between;
+}
diff --git a/samples/UmbracoV9/Startup.cs b/samples/UmbracoV9/Startup.cs
@@ -1,5 +1,6 @@
 using System;
 using System.Linq;
+using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Hosting;
@@ -111,7 +112,7 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
 
     public class BlogMapper : IContentTypeMapping
     {
-        public Task<ContentUpdate> Map(ContentMappingContext context)
+        public Task<ContentUpdate> Map(ContentMappingContext context, CancellationToken token)
         {
             context.ContentUpdate.Content.Data["Title"] = context.PublishedContent.GetProperty("title").GetValue<string>(context.CulturesToPublish.First());
 
diff --git a/src/Integrations.Umbraco/App_Plugins/Relewise.Dashboard/dashboard.controller.js b/src/Integrations.Umbraco/App_Plugins/Relewise.Dashboard/dashboard.controller.js
@@ -18,6 +18,26 @@
         });
     }
 
+    vm.exportContentPermanentlyDelete = function () {
+        const confirmed = confirm("Are you sure, you want to perform an full export and remove deleted content items?");
+        if (!confirmed) {
+            return;
+        }
+
+        vm.exportLoading = true;
+        vm.errorMessage = "";
+        vm.success = "";
+        relewiseDashboardResources.exportContentWithDelete().then(() => {
+            vm.exportLoading = false;
+            vm.success = "Content was successfully exported to Relewise";
+            vm.errorMessage = "";
+        }, () => {
+            vm.exportLoading = false;
+            vm.success = "";
+            vm.errorMessage = "Unexpected error while exporting data happened";
+        });
+    }
+
     function init() {
         relewiseDashboardResources.getConfiguration().then((response) => {
             if (response.status === 200) {
diff --git a/src/Integrations.Umbraco/App_Plugins/Relewise.Dashboard/dashboard.html b/src/Integrations.Umbraco/App_Plugins/Relewise.Dashboard/dashboard.html
@@ -2,14 +2,17 @@
     <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 />
                 It's also possible to see the settings for Relewise directly here.
             </p>
-            <div>
+            <div class="button-box">
                 <button class="btn btn-primary" ng-click="vm.exportContent()" ng-disabled="vm.exportLoading">
-                    Full content export
+                    Export content
+                </button>
+
+                <button class="btn btn-danger" ng-click="vm.exportContentPermanentlyDelete()" ng-disabled="vm.exportLoading">
+                    Export content and remove old data
                 </button>
             </div>
             <div class="error mt-10" ng-if="vm.errorMessage">{{vm.errorMessage}}</div>
diff --git a/src/Integrations.Umbraco/App_Plugins/Relewise.Dashboard/relewise.resources.js b/src/Integrations.Umbraco/App_Plugins/Relewise.Dashboard/relewise.resources.js
@@ -5,6 +5,9 @@
                 exportContent: function () {
                     return $http.post("/umbraco/backoffice/Relewise/DashboardApi/ContentExport");
                 },
+                exportContentWithDelete: function () {
+                    return $http.post("/umbraco/backoffice/Relewise/DashboardApi/ContentExport?permanentlyDelete=true");
+                },
                 getConfiguration: function () {
                     return $http.get("/umbraco/backoffice/Relewise/DashboardApi/Configuration");
                 }
diff --git a/src/Integrations.Umbraco/App_Plugins/Relewise.Dashboard/styles.css b/src/Integrations.Umbraco/App_Plugins/Relewise.Dashboard/styles.css
@@ -29,3 +29,8 @@ h5 {
 .pl-20 {
     padding-left: 20px;
 }
+
+.button-box {
+    display: flex;
+    justify-content: space-between;
+}
diff --git a/src/Integrations.Umbraco/Controllers/DashboardApiController.cs b/src/Integrations.Umbraco/Controllers/DashboardApiController.cs
@@ -42,12 +42,13 @@ public DashboardApiController(IExportContentService exportContent, IServiceProvi
     /// <summary>
     /// Performs a full content export
     /// </summary>
+    /// <param name="permanentlyDelete"></param>
     /// <param name="token"></param>
     /// <returns></returns>
     [HttpPost]
-    public async Task<IActionResult> ContentExport(CancellationToken token)
+    public async Task<IActionResult> ContentExport([FromQuery] bool permanentlyDelete, CancellationToken token)
     {
-        await _exportContent.ExportAll(new ExportAllContent(), token);
+        await _exportContent.ExportAll(new ExportAllContent(permanentlyDelete), token);
 
         return Ok();
     }
diff --git a/src/Integrations.Umbraco/IContentTypeMapping.cs b/src/Integrations.Umbraco/IContentTypeMapping.cs
@@ -1,4 +1,5 @@
-﻿using System.Threading.Tasks;
+﻿using System.Threading;
+using System.Threading.Tasks;
 using Relewise.Client.DataTypes;
 
 namespace Relewise.Integrations.Umbraco;
@@ -12,6 +13,7 @@ public interface IContentTypeMapping
     /// Handles mapping a PublishedContent to a ContentUpdate. Context provides the shared handling of Content Id's and ensure the feed versioning is correct
     /// </summary>
     /// <param name="context"></param>
+    /// <param name="token"></param>
     /// <returns></returns>
-    public Task<ContentUpdate> Map(ContentMappingContext context);
+    public Task<ContentUpdate> Map(ContentMappingContext context, CancellationToken token);
 }
diff --git a/src/Integrations.Umbraco/Services/ContentMapper.cs b/src/Integrations.Umbraco/Services/ContentMapper.cs
@@ -2,6 +2,8 @@
 using System.Collections.Generic;
 using System.Diagnostics.CodeAnalysis;
 using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
 using Relewise.Client.DataTypes;
 using Umbraco.Cms.Core;
 using Umbraco.Cms.Core.Models.PublishedContent;
@@ -25,7 +27,7 @@ public ContentMapper(RelewiseUmbracoConfiguration configuration, IUmbracoContext
         _provider = provider;
     }
 
-    public MapContentResult Map(MapContent content)
+    public async Task<MapContentResult> Map(MapContent content)
     {
         if (!_configuration.CanMap(content.PublishedContent.ContentType.Alias))
             return MapContentResult.Failed;
@@ -48,16 +50,18 @@ public MapContentResult Map(MapContent content)
             CategoryPaths = GetCategoryPaths(content, culturesToPublish)
         });
 
-        AutoMapOrUseMapper(content, culturesToPublish, contentUpdate);
+        await AutoMapOrUseMapper(content, culturesToPublish, contentUpdate, content.Token);
 
         return new MapContentResult(contentUpdate);
     }
 
-    private void AutoMapOrUseMapper(MapContent content, List<string> culturesToPublish, ContentUpdate contentUpdate)
+    private async Task AutoMapOrUseMapper(MapContent content, List<string> culturesToPublish, ContentUpdate contentUpdate, CancellationToken token)
     {
         if (TryGetMapper(content, out IContentTypeMapping? mapping))
         {
-            mapping.Map(new ContentMappingContext(content.PublishedContent, contentUpdate, culturesToPublish, _provider));
+            contentUpdate = await mapping.Map(new ContentMappingContext(content.PublishedContent, contentUpdate, culturesToPublish, _provider), token);
+            if (contentUpdate == null)
+                throw new InvalidOperationException("Content update can not be null when returned from a ContentTypeMapping");
         }
         else
         {
diff --git a/src/Integrations.Umbraco/Services/ExportAllContent.cs b/src/Integrations.Umbraco/Services/ExportAllContent.cs
@@ -5,4 +5,14 @@
 /// </summary>
 public class ExportAllContent
 {
+    /// <inheritdoc cref="ExportAllContent" />
+    public ExportAllContent(bool permanentlyDelete)
+    {
+        PermanentlyDelete = permanentlyDelete;
+    }
+
+    /// <summary>
+    /// Permanently deletes content from Relewise if not part of the export
+    /// </summary>
+    public bool PermanentlyDelete { get; }
 }
diff --git a/src/Integrations.Umbraco/Services/ExportContentService.cs b/src/Integrations.Umbraco/Services/ExportContentService.cs
@@ -55,13 +55,15 @@ public async Task<ExportContentResult> Export(ExportContent exportContent, Cance
             return new ExportContentResult();
         }
 
-        ContentUpdate[] contentUpdates = exportContent.Contents
-            .Select(x => _contentMapper.Map(new MapContent(contentCache.GetById(x.Id), exportContent.Version)))
-            .Where(x => x.Successful)
-            .Select(x => x.ContentUpdate!)
-            .ToArray();
-        // ReSharper disable once CoVariantArrayConversion
-        await tracker.TrackAsync(token, contentUpdates);
+        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))))
+        {
+            MapContentResult result = await map;
+            if (result.Successful)
+                contentUpdates.Add(result.ContentUpdate!);
+        }
+
+        await tracker.TrackAsync(contentUpdates, token);
 
         await tracker.TrackAsync(new ContentAdministrativeAction(
             Language.Undefined,
@@ -100,7 +102,7 @@ await tracker.TrackAsync(new ContentAdministrativeAction(
                 Language.Undefined,
                 Currency.Undefined,
                 new FilterCollection(new ContentDataFilter(Constants.VersionKey, new EqualsCondition(version, negated: true), filterOutIfKeyIsNotFound: false)),
-                ContentAdministrativeAction.UpdateKind.PermanentlyDelete), 
+                exportAllContent.PermanentlyDelete ? ContentAdministrativeAction.UpdateKind.PermanentlyDelete : ContentAdministrativeAction.UpdateKind.DisableInRecommendations), 
                 token);
         }
 
diff --git a/src/Integrations.Umbraco/Services/IContentMapper.cs b/src/Integrations.Umbraco/Services/IContentMapper.cs
@@ -1,6 +1,8 @@
-﻿namespace Relewise.Integrations.Umbraco.Services;
+﻿using System.Threading.Tasks;
+
+namespace Relewise.Integrations.Umbraco.Services;
 
 internal interface IContentMapper
 {
-    MapContentResult Map(MapContent content);
+    Task<MapContentResult> Map(MapContent content);
 }
diff --git a/src/Integrations.Umbraco/Services/MapContent.cs b/src/Integrations.Umbraco/Services/MapContent.cs
@@ -1,15 +1,18 @@
-﻿using Umbraco.Cms.Core.Models.PublishedContent;
+﻿using System.Threading;
+using Umbraco.Cms.Core.Models.PublishedContent;
 
 namespace Relewise.Integrations.Umbraco.Services;
 
 internal class MapContent
 {
-    public MapContent(IPublishedContent publishedContent, long version)
+    public MapContent(IPublishedContent publishedContent, long version, CancellationToken token)
     {
         PublishedContent = publishedContent;
         Version = version;
+        Token = token;
     }
 
     public IPublishedContent PublishedContent { get; }
     public long Version { get; }
+    public CancellationToken Token { get; }
 }

Original file line number	Diff line number	Diff line change
`@@ -29,3 +29,8 @@ h5 {`
`29`	`29`	`.pl-20 {`
`30`	`30`	`padding-left: 20px;`
`31`	`31`	`}`
	`32`	`+`
	`33`	`+.button-box {`
	`34`	`+ display: flex;`
	`35`	`+ justify-content: space-between;`
	`36`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`using System;`
`2`	`2`	`using System.Linq;`
	`3`	`+using System.Threading;`
`3`	`4`	`using System.Threading.Tasks;`
`4`	`5`	`using Microsoft.AspNetCore.Builder;`
`5`	`6`	`using Microsoft.AspNetCore.Hosting;`
`@@ -111,7 +112,7 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)`
`111`	`112`
`112`	`113`	`public class BlogMapper : IContentTypeMapping`
`113`	`114`	`{`
`114`		`- public Task<ContentUpdate> Map(ContentMappingContext context)`
	`115`	`+ public Task<ContentUpdate> Map(ContentMappingContext context, CancellationToken token)`
`115`	`116`	`{`
`116`	`117`	`context.ContentUpdate.Content.Data["Title"] = context.PublishedContent.GetProperty("title").GetValue<string>(context.CulturesToPublish.First());`
`117`	`118`