After payment, need to delete the shopping cart in session and cookies (#568)

* After payment, need to delete the shopping cart in session and cookies

* Fix error CS1574: XML comment has cref attribute 'ShoppingCartPersistenceBase' that could not be resolved

* Update src/Libraries/OrchardCore.Commerce.Abstractions/Abstractions/IShoppingCartPersistence.cs

Co-authored-by: Sára El-Saig <sara.el-saig@lombiq.com>

* Update test/OrchardCore.Commerce.Tests/Fakes/FakeCartStorage.cs

Co-authored-by: Sára El-Saig <sara.el-saig@lombiq.com>

* After Review

* Update src/Modules/OrchardCore.Commerce/Services/ShoppingCartPersistenceBase.cs

* Update src/Libraries/OrchardCore.Commerce.Abstractions/Abstractions/IShoppingCartPersistence.cs

---------

Co-authored-by: Sára El-Saig <sara.el-saig@lombiq.com>

Author: infofromca

…Abstractions/IShoppingCartPersistence.cs …Abstractions/IShoppingCartPersistence.cssrc/Modules/OrchardCore.Commerce/Abstractions/IShoppingCartPersistence.cs renamed to src/Libraries/OrchardCore.Commerce.Abstractions/Abstractions/IShoppingCartPersistence.cs src/Modules/OrchardCore.Commerce/Abstractions/IShoppingCartPersistence.cs renamed to src/Libraries/OrchardCore.Commerce.Abstractions/Abstractions/IShoppingCartPersistence.cs

@@ -1,5 +1,4 @@
 using OrchardCore.Commerce.Abstractions.Models;
-using OrchardCore.Commerce.Services;
 using System.Threading.Tasks;
 
 namespace OrchardCore.Commerce.Abstractions;
@@ -8,8 +7,8 @@ namespace OrchardCore.Commerce.Abstractions;
 /// Service that provides a way to retain shopping cart information.
 /// </summary>
 /// <remarks><para>
-/// When deriving a custom implementation, please inherit from <see cref="ShoppingCartPersistenceBase"/> to retain event
-/// handling and dependency injection scope level caching.
+/// When deriving a custom implementation, please inherit from <c>ShoppingCartPersistenceBase</c> in the
+/// <c>OrchardCore.Commerce</c> project to retain event handling and dependency injection scope level caching.
 /// </para></remarks>
 public interface IShoppingCartPersistence
 {
@@ -22,9 +21,17 @@ public interface IShoppingCartPersistence
     Task<ShoppingCart> RetrieveAsync(string shoppingCartId);
 
     /// <summary>
-    /// Saves a shopping cart by a given ID.
+    /// Saves the provided <see cref="ShoppingCart"/> <paramref name="items"/>.
     /// </summary>
     Task StoreAsync(ShoppingCart items);
+
+    /// <summary>
+    /// Remove a <see cref="ShoppingCart"/> identified by <paramref name="shoppingCartId"/>.
+    /// </summary>
+    /// <param name="shoppingCartId">
+    /// The name used to identify the shopping cart. <see langword="null"/> refers to the default shopping cart.
+    /// </param>
+    Task RemoveAsync(string shoppingCartId);
 }
 
 public static class ShoppingCartPersistenceExtensions

src/Modules/OrchardCore.Commerce.Payment/Services/PaymentService.cs

@@ -5,6 +5,7 @@
 using Microsoft.AspNetCore.Identity;
 using Microsoft.AspNetCore.Mvc.Localization;
 using Microsoft.Extensions.Logging;
+using OrchardCore.Commerce.Abstractions;
 using OrchardCore.Commerce.Abstractions.Abstractions;
 using OrchardCore.Commerce.Abstractions.Constants;
 using OrchardCore.Commerce.Abstractions.Models;
@@ -33,6 +34,7 @@ namespace OrchardCore.Commerce.Payment.Services;
 
 public class PaymentService : IPaymentService
 {
+    private readonly IShoppingCartPersistence _shoppingCartPersistence;
     private readonly IFieldsOnlyDisplayManager _fieldsOnlyDisplayManager;
     private readonly IContentManager _contentManager;
     private readonly IShoppingCartHelpers _shoppingCartHelpers;
@@ -51,6 +53,7 @@ public class PaymentService : IPaymentService
     // We need all of them.
 #pragma warning disable S107 // Methods should not have too many parameters
     public PaymentService(
+        IShoppingCartPersistence shoppingCartPersistence,
         IFieldsOnlyDisplayManager fieldsOnlyDisplayManager,
         IOrchardServices<PaymentService> services,
         IShoppingCartHelpers shoppingCartHelpers,
@@ -64,6 +67,7 @@ public PaymentService(
         IMoneyService moneyService)
 #pragma warning restore S107 // Methods should not have too many parameters
     {
+        _shoppingCartPersistence = shoppingCartPersistence;
         _fieldsOnlyDisplayManager = fieldsOnlyDisplayManager;
         _contentManager = services.ContentManager.Value;
         _shoppingCartHelpers = shoppingCartHelpers;
@@ -177,11 +181,7 @@ public async Task FinalModificationOfOrderAsync(ContentItem order, string? shopp
         await _orderEvents.AwaitEachAsync(orderEvent =>
             orderEvent.FinalizeAsync(order, shoppingCartId, paymentProviderName));
 
-        await _shoppingCartHelpers.UpdateAsync(shoppingCartId, cart =>
-        {
-            cart.Items?.Clear();
-            return Task.CompletedTask;
-        });
+        await _shoppingCartPersistence.RemoveAsync(shoppingCartId);
 
         if (!string.IsNullOrEmpty(paymentProviderName))
         {

src/Modules/OrchardCore.Commerce/Services/SessionShoppingCartPersistence.cs

@@ -45,4 +45,19 @@ protected override async Task<bool> StoreInnerAsync(string key, ShoppingCart ite
 
         return true;
     }
+
+    protected override Task<bool> RemoveInnerAsync(string key)
+    {
+        try
+        {
+            Session.Clear();
+            _httpContextAccessor.HttpContext?.Response.Cookies.Delete(key);
+        }
+        catch
+        {
+            return Task.FromResult(false);
+        }
+
+        return Task.FromResult(true);
+    }
 }

src/Modules/OrchardCore.Commerce/Services/ShoppingCartPersistenceBase.cs

@@ -49,6 +49,16 @@ public async Task StoreAsync(ShoppingCart items)
         }
     }
 
+    public async Task RemoveAsync(string shoppingCartId)
+    {
+        var key = GetCacheId(shoppingCartId);
+
+        if (await RemoveInnerAsync(key))
+        {
+            _scopeCache.Remove(key, out _);
+        }
+    }
+
     /// <summary>
     /// Retrieves the items using the <see cref="ShoppingCartPersistenceBase"/>-specific <paramref name="key"/>.
     /// </summary>
@@ -68,6 +78,12 @@ public async Task StoreAsync(ShoppingCart items)
     /// </returns>
     protected abstract Task<bool> StoreInnerAsync(string key, ShoppingCart items);
 
+    /// <summary>
+    /// Remove the items using the <see cref="ShoppingCartPersistenceBase"/>-specific <paramref name="key"/>.
+    /// </summary>
+    /// <param name="key">A prefix and (if set) the shopping cart ID combined.</param>
+    /// <returns>A value indicating whether the removal was successful.</returns>
+    protected abstract Task<bool> RemoveInnerAsync(string key);
     protected string GetCacheId(string shoppingCartId) =>
         string.IsNullOrEmpty(shoppingCartId) ? ShoppingCartPrefix : $"{ShoppingCartPrefix}_{shoppingCartId}";
 }

test/OrchardCore.Commerce.Tests/Fakes/FakeCartStorage.cs

@@ -30,4 +30,10 @@ public Task StoreAsync(ShoppingCart items)
         _carts[items.Id ?? string.Empty] = new ShoppingCart(items.Items);
         return Task.CompletedTask;
     }
+
+    public Task RemoveAsync(string shoppingCartId)
+    {
+        _carts.Remove(shoppingCartId);
+        return Task.CompletedTask;
+    }
 }