Open-source eCommerce platform for C# and ASP.NET Core 10 with MongoDB. Build multi-store shops and multi-vendor marketplaces with B2B/B2C, REST API, plugins, Vue 3 and Docker.
C# aspnet-corecsharpdockerdotnetecommerceecommerce-platformmongodbmulti-storemulti-vendornosqlonline-shopshoppingcart
Refactor and centralize plugin path management
KrzysztofPajakc7e39bf965bb
diff --git a/src/Core/Grand.Data/DataSettingsManager.cs b/src/Core/Grand.Data/DataSettingsManager.csindex 6591eda68..91940cfc5 100644--- a/src/Core/Grand.Data/DataSettingsManager.cs+++ b/src/Core/Grand.Data/DataSettingsManager.cs@@ -1,5 +1,4 @@-using Grand.SharedKernel.Extensions;-using System.Text.Json;+using System.Text.Json;namespace Grand.Data;@@ -26,10 +25,7 @@ public sealed class DataSettingsManager{lock (_lock){- if (_instance == null)- {- _instance = new DataSettingsManager(settingsPath);- }+ _instance ??= new DataSettingsManager(settingsPath);}}}diff --git a/src/Core/Grand.Infrastructure/Plugins/PluginExtensions.cs b/src/Core/Grand.Infrastructure/Plugins/PluginExtensions.csindex 774a4e29f..207bfecb8 100644--- a/src/Core/Grand.Infrastructure/Plugins/PluginExtensions.cs+++ b/src/Core/Grand.Infrastructure/Plugins/PluginExtensions.cs@@ -3,6 +3,33 @@ using System.Text.Json;namespace Grand.Infrastructure.Plugins;++public sealed class PluginPaths+{+ private static PluginPaths _instance;+ private static readonly object _lock = new();+ public static PluginPaths Instance => _instance ?? throw new InvalidOperationException("PluginPaths has not been initialized. Call Initialize first.");+ private readonly string _pluginPath;++ public string InstalledPluginsFile => _pluginPath;++ public static void Initialize(string settingsPath)+ {+ if (_instance == null)+ {+ lock (_lock)+ {+ _instance ??= new PluginPaths(settingsPath);+ }+ }+ }++ private PluginPaths(string pluginPath)+ {+ _pluginPath = pluginPath;+ }+}+public static class PluginExtensions{public static bool OnlyInstalledPlugins(Type type)@@ -19,8 +46,7 @@ public static class PluginExtensionsvar text = File.ReadAllText(filePath);return string.IsNullOrEmpty(text) ? new List<string>() : JsonSerializer.Deserialize<List<string>>(text);}-- public static async Task SaveInstalledPluginsFile(IList<string> pluginSystemNames, string filePath)+ private static async Task SaveInstalledPluginsFile(IList<string> pluginSystemNames, string filePath){//serializevar result = JsonSerializer.Serialize(pluginSystemNames, new JsonSerializerOptions { WriteIndented = true });@@ -38,7 +64,7 @@ public static class PluginExtensionsif (string.IsNullOrEmpty(systemName))throw new ArgumentNullException(nameof(systemName));- var filePath = CommonPath.InstalledPluginsFilePath;+ var filePath = PluginPaths.Instance.InstalledPluginsFile;if (!File.Exists(filePath))await using (File.Create(filePath)){@@ -65,7 +91,7 @@ public static class PluginExtensionsif (string.IsNullOrEmpty(systemName))throw new ArgumentNullException(nameof(systemName));- var filePath = CommonPath.InstalledPluginsFilePath;+ var filePath = PluginPaths.Instance.InstalledPluginsFile;if (!File.Exists(filePath))await using (File.Create(filePath)){diff --git a/src/Core/Grand.Infrastructure/Plugins/PluginManager.cs b/src/Core/Grand.Infrastructure/Plugins/PluginManager.csindex 048a3da36..f3bde103e 100644--- a/src/Core/Grand.Infrastructure/Plugins/PluginManager.cs+++ b/src/Core/Grand.Infrastructure/Plugins/PluginManager.cs@@ -68,7 +68,7 @@ public static class PluginManagervar installedPluginSystemNames =!string.IsNullOrEmpty(_config.InstalledPlugins)? _config.InstalledPlugins.Split(",").Select(x => x.Trim())- : PluginExtensions.ParseInstalledPluginsFile(CommonPath.InstalledPluginsFilePath);+ : PluginExtensions.ParseInstalledPluginsFile(PluginPaths.Instance.InstalledPluginsFile);_logger.LogInformation("Creating shadow copy folder and querying for dlls");Directory.CreateDirectory(_pluginFolder.FullName);@@ -206,7 +206,7 @@ public static class PluginManager/// </summary>public static void ClearPlugins(){- var filePath = CommonPath.InstalledPluginsFilePath;+ var filePath = PluginPaths.Instance.InstalledPluginsFile;if (File.Exists(filePath))File.Delete(filePath);}diff --git a/src/Core/Grand.Infrastructure/StartupBase.cs b/src/Core/Grand.Infrastructure/StartupBase.csindex b3f5d9281..7659621fa 100644--- a/src/Core/Grand.Infrastructure/StartupBase.cs+++ b/src/Core/Grand.Infrastructure/StartupBase.cs@@ -210,6 +210,9 @@ public static class StartupBasevar settingsPath = Path.Combine(hostingEnvironment.ContentRootPath, CommonPath.AppData, configuration["Directory"] ?? "", CommonPath.SettingsFile);DataSettingsManager.Initialize(settingsPath);++ var pluginPaths= Path.Combine(hostingEnvironment.ContentRootPath, CommonPath.AppData, configuration["Directory"] ?? "", CommonPath.InstalledPluginsFile);+ PluginPaths.Initialize(pluginPaths);services.AddTransient<ValidationFilter>();var mvcCoreBuilder = services.AddMvcCore(options =>diff --git a/src/Core/Grand.SharedKernel/Extensions/CommonPath.cs b/src/Core/Grand.SharedKernel/Extensions/CommonPath.csindex 900e58cf1..30ae7dde0 100644--- a/src/Core/Grand.SharedKernel/Extensions/CommonPath.cs+++ b/src/Core/Grand.SharedKernel/Extensions/CommonPath.cs@@ -12,18 +12,13 @@ public static class CommonPathpublic static string SettingsFile = "Settings.cfg";+ public static string InstalledPluginsFile = "InstalledPlugins.cfg";+/// <summary>/// Extra parameter to path/// </summary>public static string Param { get; set; } = "";- /// <summary>- /// Maps a installled plugins path to a physical disk path.- /// </summary>- /// <returns>The physical path.</returns>- public static string InstalledPluginsFilePath =>- Path.Combine(BaseDirectory, AppData, Param, "InstalledPlugins.cfg");-/// <summary>/// Gets or sets application base path/// </summary>diff --git a/src/Tests/Grand.Infrastructure.Tests/Plugins/BasePluginTests.cs b/src/Tests/Grand.Infrastructure.Tests/Plugins/BasePluginTests.csindex 3017f0686..35129f526 100644--- a/src/Tests/Grand.Infrastructure.Tests/Plugins/BasePluginTests.cs+++ b/src/Tests/Grand.Infrastructure.Tests/Plugins/BasePluginTests.cs@@ -1,5 +1,6 @@using Grand.Infrastructure.Plugins;using Grand.SharedKernel.Extensions;+using Microsoft.Extensions.Hosting.Internal;using Microsoft.VisualStudio.TestTools.UnitTesting;using TestContext = NUnit.Framework.TestContext;@@ -13,9 +14,11 @@ public class BasePluginTests[TestInitialize]public void Init(){- CommonPath.BaseDirectory = TestContext.CurrentContext.TestDirectory;- if (File.Exists(CommonPath.InstalledPluginsFilePath))- File.Delete(CommonPath.InstalledPluginsFilePath);+ var pluginPaths = Path.Combine(TestContext.CurrentContext.TestDirectory, CommonPath.AppData, CommonPath.InstalledPluginsFile);+ PluginPaths.Initialize(pluginPaths);++ if (File.Exists(PluginPaths.Instance.InstalledPluginsFile))+ File.Delete(PluginPaths.Instance.InstalledPluginsFile);sampleBasePlugin = new SampleBasePlugin();}@@ -30,7 +33,7 @@ public class BasePluginTestspublic async Task InstallTest(){await sampleBasePlugin.Install();- var plugins = PluginExtensions.ParseInstalledPluginsFile(CommonPath.InstalledPluginsFilePath);+ var plugins = PluginExtensions.ParseInstalledPluginsFile(PluginPaths.Instance.InstalledPluginsFile);Assert.IsNotNull(plugins);Assert.AreEqual("SamplePlugin", plugins.FirstOrDefault());}@@ -40,7 +43,7 @@ public class BasePluginTests{await sampleBasePlugin.Install();await sampleBasePlugin.Uninstall();- var plugins = PluginExtensions.ParseInstalledPluginsFile(CommonPath.InstalledPluginsFilePath);+ var plugins = PluginExtensions.ParseInstalledPluginsFile(PluginPaths.Instance.InstalledPluginsFile);Assert.AreEqual(0, plugins.Count);}@@ -48,7 +51,7 @@ public class BasePluginTestspublic async Task UninstallTest(){await sampleBasePlugin.Uninstall();- var plugins = PluginExtensions.ParseInstalledPluginsFile(CommonPath.InstalledPluginsFilePath);+ var plugins = PluginExtensions.ParseInstalledPluginsFile(PluginPaths.Instance.InstalledPluginsFile);Assert.AreEqual(0, plugins.Count);}}\ No newline at end of filediff --git a/src/Tests/Grand.Infrastructure.Tests/Plugins/PluginExtensionsTests.cs b/src/Tests/Grand.Infrastructure.Tests/Plugins/PluginExtensionsTests.csindex be5981772..de903c61f 100644--- a/src/Tests/Grand.Infrastructure.Tests/Plugins/PluginExtensionsTests.cs+++ b/src/Tests/Grand.Infrastructure.Tests/Plugins/PluginExtensionsTests.cs@@ -8,28 +8,43 @@ namespace Grand.Infrastructure.Tests.Plugins;[TestClass]public class PluginExtensionsTests{- private readonly SampleBasePlugin sampleBasePlugin;-public PluginExtensionsTests(){- CommonPath.BaseDirectory = TestContext.CurrentContext.TestDirectory;- sampleBasePlugin = new SampleBasePlugin();++ var pluginPaths = Path.Combine(TestContext.CurrentContext.TestDirectory, CommonPath.AppData, CommonPath.InstalledPluginsFile);+ PluginPaths.Initialize(pluginPaths);+ PluginManager.ClearPlugins();}[TestMethod]public async Task ParseInstalledPluginsFileTest(){+ var sampleBasePlugin = new SampleBasePlugin();await sampleBasePlugin.Install();- var plugins = PluginExtensions.ParseInstalledPluginsFile(CommonPath.InstalledPluginsFilePath);+ var plugins = PluginExtensions.ParseInstalledPluginsFile(PluginPaths.Instance.InstalledPluginsFile);Assert.IsNotNull(plugins);}[TestMethod]- public async Task SaveInstalledPluginsFileTest()+ public async Task MarkPluginAsInstalledTest()+ {+ //Act+ await PluginExtensions.MarkPluginAsInstalled("plugin1");+ //Assert+ var plugins = PluginExtensions.ParseInstalledPluginsFile(PluginPaths.Instance.InstalledPluginsFile);+ Assert.AreEqual(1, plugins.Count);+ }++ [TestMethod]+ public async Task MarkPluginAsUninstalled(){- await PluginExtensions.SaveInstalledPluginsFile(new List<string> { "plugin1", "plugin2" },- CommonPath.InstalledPluginsFilePath);- var plugins = PluginExtensions.ParseInstalledPluginsFile(CommonPath.InstalledPluginsFilePath);- Assert.AreEqual(2, plugins.Count);+ //Arrange+ await PluginExtensions.MarkPluginAsInstalled("plugin1");+ await PluginExtensions.MarkPluginAsInstalled("plugin2");+ //Act+ await PluginExtensions.MarkPluginAsUninstalled("plugin1");+ //Assert+ var plugins = PluginExtensions.ParseInstalledPluginsFile(PluginPaths.Instance.InstalledPluginsFile);+ Assert.AreEqual(1, plugins.Count);}}\ No newline at end of file