Refactor IfEnvEmptySetDefault to a static method

src/AgileConfig.Server.Apisite/Controllers/ConfigController.cs

@@ -45,7 +45,7 @@ public async Task<IActionResult> Add([FromBody] ConfigVM model, [FromQuery] stri
         {
             ArgumentNullException.ThrowIfNull(model);
 
-            _configService.IfEnvEmptySetDefault(ref env);
+            ISettingService.IfEnvEmptySetDefault(ref env);
 
             var app = await _appService.GetAsync(model.AppId);
             if (app == null)
@@ -106,7 +106,7 @@ public async Task<IActionResult> AddRange([FromBody] List<ConfigVM> model, [From
                 throw new ArgumentNullException("model");
             }
 
-            _configService.IfEnvEmptySetDefault(ref env);
+            ISettingService.IfEnvEmptySetDefault(ref env);
 
             var configs = await _configService.GetByAppIdAsync(model.First().AppId, env);
 
@@ -177,7 +177,7 @@ public async Task<IActionResult> Edit([FromBody] ConfigVM model, [FromQuery] str
                 throw new ArgumentNullException("model");
             }
 
-            _configService.IfEnvEmptySetDefault(ref env);
+            ISettingService.IfEnvEmptySetDefault(ref env);
 
             var config = await _configService.GetAsync(model.Id, env);
             if (config == null)
@@ -272,7 +272,7 @@ private bool IsOnlyUpdateDescription(Config newConfig, Config oldConfig)
         [HttpGet]
         public async Task<IActionResult> All(string env)
         {
-            _configService.IfEnvEmptySetDefault(ref env);
+            ISettingService.IfEnvEmptySetDefault(ref env);
 
             var configs = await _configService.GetAllConfigsAsync(env);
 
@@ -307,7 +307,7 @@ public async Task<IActionResult> Search(string appId, string group, string key,
                 throw new ArgumentException("pageIndex can not less then 1 .");
             }
 
-            _configService.IfEnvEmptySetDefault(ref env);
+            ISettingService.IfEnvEmptySetDefault(ref env);
 
             var configs = await _configService.Search(appId, group, key, env);
             configs = configs.Where(c => c.Status == ConfigStatus.Enabled).ToList();
@@ -361,7 +361,7 @@ public async Task<IActionResult> Get(string id, string env)
                 throw new ArgumentNullException("id");
             }
 
-            _configService.IfEnvEmptySetDefault(ref env);
+            ISettingService.IfEnvEmptySetDefault(ref env);
 
             var config = await _configService.GetAsync(id, env);
 
@@ -383,7 +383,7 @@ public async Task<IActionResult> Delete(string id, string env)
                 throw new ArgumentNullException("id");
             }
 
-            _configService.IfEnvEmptySetDefault(ref env);
+            ISettingService.IfEnvEmptySetDefault(ref env);
 
             var config = await _configService.GetAsync(id, env);
             if (config == null)
@@ -428,7 +428,7 @@ public async Task<IActionResult> DeleteSome([FromBody] List<string> ids, string
                 throw new ArgumentNullException("ids");
             }
 
-            _configService.IfEnvEmptySetDefault(ref env);
+            ISettingService.IfEnvEmptySetDefault(ref env);
 
             List<Config> deleteConfigs = new List<Config>();
 
@@ -481,7 +481,7 @@ public async Task<IActionResult> Rollback(string publishTimelineId, string env)
                 throw new ArgumentNullException("publishTimelineId");
             }
 
-            _configService.IfEnvEmptySetDefault(ref env);
+            ISettingService.IfEnvEmptySetDefault(ref env);
 
             var result = await _configService.RollbackAsync(publishTimelineId, env);
 
@@ -506,7 +506,7 @@ public async Task<IActionResult> ConfigPublishedHistory(string configId, string
                 throw new ArgumentNullException("configId");
             }
 
-            _configService.IfEnvEmptySetDefault(ref env);
+            ISettingService.IfEnvEmptySetDefault(ref env);
 
             var configPublishedHistory = await _configService.GetConfigPublishedHistory(configId, env);
             var result = new List<object>();
@@ -549,7 +549,7 @@ public async Task<IActionResult> Publish([FromBody] PublishLogVM model, string e
                 throw new ArgumentNullException("appId");
             }
 
-            _configService.IfEnvEmptySetDefault(ref env);
+            ISettingService.IfEnvEmptySetDefault(ref env);
 
             var appId = model.AppId;
             var userId = await this.GetCurrentUserId(_userService);
@@ -631,7 +631,7 @@ public async Task<IActionResult> ExportJson(string appId, string env)
                 throw new ArgumentNullException("appId");
             }
 
-            _configService.IfEnvEmptySetDefault(ref env);
+            ISettingService.IfEnvEmptySetDefault(ref env);
 
             var configs = await _configService.GetByAppIdAsync(appId, env);
 
@@ -659,7 +659,7 @@ public async Task<IActionResult> WaitPublishStatus(string appId, string env)
                 throw new ArgumentNullException("appId");
             }
 
-            _configService.IfEnvEmptySetDefault(ref env);
+            ISettingService.IfEnvEmptySetDefault(ref env);
 
             var configs = await _configService.Search(appId, "", "", env);
             configs = configs.Where(x => x.Status == ConfigStatus.Enabled && x.EditStatus != EditStatus.Commit)
@@ -693,7 +693,7 @@ public async Task<IActionResult> PublishHistory(string appId, string env)
                 throw new ArgumentNullException("appId");
             }
 
-            _configService.IfEnvEmptySetDefault(ref env);
+            ISettingService.IfEnvEmptySetDefault(ref env);
 
             var history = await _configService.GetPublishDetailListAsync(appId, env);
 
@@ -724,7 +724,7 @@ public async Task<IActionResult> CancelEdit(string configId, string env)
                 throw new ArgumentNullException("configId");
             }
 
-            env = _configService.IfEnvEmptySetDefault(ref env);
+            ISettingService.IfEnvEmptySetDefault(ref env);
 
             var result = await _configService.CancelEdit(new List<string>() { configId }, env);
 
@@ -747,7 +747,7 @@ public async Task<IActionResult> CancelSomeEdit([FromBody] List<string> ids, str
                 throw new ArgumentNullException("ids");
             }
 
-            _configService.IfEnvEmptySetDefault(ref env);
+            ISettingService.IfEnvEmptySetDefault(ref env);
 
             var result = await _configService.CancelEdit(ids, env);
 
@@ -809,7 +809,7 @@ public async Task<IActionResult> GetKvList(string appId, string env)
                 throw new ArgumentNullException("appId");
             }
 
-            _configService.IfEnvEmptySetDefault(ref env);
+            ISettingService.IfEnvEmptySetDefault(ref env);
 
             var configs = await _configService.GetByAppIdAsync(appId, env);
             // text 格式展示的时候不需要删除的配置
@@ -840,7 +840,7 @@ public async Task<IActionResult> GetJson(string appId, string env)
                 throw new ArgumentNullException("appId");
             }
 
-            _configService.IfEnvEmptySetDefault(ref env);
+            ISettingService.IfEnvEmptySetDefault(ref env);
 
             var configs = await _configService.GetByAppIdAsync(appId, env);
             // json 格式展示的时候不需要删除的配置

src/AgileConfig.Server.Apisite/Controllers/api/AppController.cs

@@ -249,7 +249,7 @@ public async Task<IActionResult> Delete(string id)
         [HttpPost("publish")]
         public async Task<IActionResult> Publish(string appId, string env)
         {
-            _configService.IfEnvEmptySetDefault(ref env);
+            ISettingService.IfEnvEmptySetDefault(ref env);
 
             var ctrl = new Controllers.ConfigController(
                 _configService,
@@ -289,7 +289,7 @@ public async Task<ActionResult<IEnumerable<ApiPublishTimelineVM>>> PublishHistor
         {
             ArgumentNullException.ThrowIfNullOrEmpty(appId);
 
-            _configService.IfEnvEmptySetDefault(ref env);
+            ISettingService.IfEnvEmptySetDefault(ref env);
 
             var history = await _configService.GetPublishTimelineHistoryAsync(appId, env);
 
@@ -319,7 +319,7 @@ public async Task<ActionResult<IEnumerable<ApiPublishTimelineVM>>> PublishHistor
         [HttpPost("rollback")]
         public async Task<IActionResult> Rollback(string historyId, string env)
         {
-            _configService.IfEnvEmptySetDefault(ref env);
+            ISettingService.IfEnvEmptySetDefault(ref env);
 
             var ctrl = new Controllers.ConfigController(
                 _configService,

src/AgileConfig.Server.Apisite/Controllers/api/ConfigController.cs

@@ -56,7 +56,7 @@ public async Task<ActionResult<List<ApiConfigVM>>> GetAppConfig(string appId, [F
         {
             ArgumentNullException.ThrowIfNullOrEmpty(appId);
 
-            _configService.IfEnvEmptySetDefault(ref env);
+            ISettingService.IfEnvEmptySetDefault(ref env);
 
             var app = await _appService.GetAsync(appId);
             if (!app.Enabled)
@@ -110,7 +110,7 @@ public async Task<ActionResult<List<ApiConfigVM>>> GetConfigs(string appId, stri
         {
             ArgumentNullException.ThrowIfNullOrEmpty(appId);
 
-            _configService.IfEnvEmptySetDefault(ref env);
+            ISettingService.IfEnvEmptySetDefault(ref env);
 
             var configs = await _configService.GetByAppIdAsync(appId, env);
 
@@ -140,7 +140,7 @@ public async Task<ActionResult<ApiConfigVM>> GetConfig(string id, string env)
         {
             ArgumentNullException.ThrowIfNullOrEmpty(id);
 
-            _configService.IfEnvEmptySetDefault(ref env);
+            ISettingService.IfEnvEmptySetDefault(ref env);
 
             var config = await _configService.GetAsync(id, env);
             if (config == null || config.Status == ConfigStatus.Deleted)
@@ -193,7 +193,7 @@ public async Task<IActionResult> Add([FromBody] ApiConfigVM model, string env)
                 );
             ctrl.ControllerContext.HttpContext = HttpContext;
 
-            _configService.IfEnvEmptySetDefault(ref env);
+            ISettingService.IfEnvEmptySetDefault(ref env);
 
             var result = (await ctrl.Add(new ConfigVM()
             {
@@ -250,7 +250,7 @@ public async Task<IActionResult> Edit(string id, [FromBody] ApiConfigVM model, s
                 );
             ctrl.ControllerContext.HttpContext = HttpContext;
 
-            _configService.IfEnvEmptySetDefault(ref env);
+            ISettingService.IfEnvEmptySetDefault(ref env);
 
             model.Id = id;
             var result = (await ctrl.Edit(new ConfigVM()
@@ -296,7 +296,7 @@ public async Task<IActionResult> Delete(string id, string env)
                 );
             ctrl.ControllerContext.HttpContext = HttpContext;
 
-            _configService.IfEnvEmptySetDefault(ref env);
+            ISettingService.IfEnvEmptySetDefault(ref env);
 
             var result = (await ctrl.Delete(id, env)) as JsonResult;
 

src/AgileConfig.Server.Apisite/Filters/PremissionCheckAttribute.cs

@@ -21,7 +21,7 @@ private static string GetEnvFromArgs(IDictionary<string, object> args, IConfigSe
             var env = "";
             if (envArg == null)
             {
-                configService.IfEnvEmptySetDefault(ref env);
+                ISettingService.IfEnvEmptySetDefault(ref env);
             }
             else
             {

src/AgileConfig.Server.Apisite/Websocket/MessageHandlers/MessageHandler.cs

@@ -66,7 +66,7 @@ public async Task Handle(string message, HttpRequest request, WebsocketClient cl
             var appId = request.Headers["appid"];
             appId = HttpUtility.UrlDecode(appId);
             var env = request.Headers["env"].ToString();
-            _configService.IfEnvEmptySetDefault(ref env);
+            ISettingService.IfEnvEmptySetDefault(ref env);
             var md5 = await _configService.AppPublishedConfigsMd5CacheWithInheritanced(appId, env);
             await SendMessage(client.Client, JsonConvert.SerializeObject(new WebsocketAction()
             {

src/AgileConfig.Server.Apisite/Websocket/MessageHandlers/OldMessageHandler.cs

@@ -45,7 +45,7 @@ public async Task Handle(string message, HttpRequest request, WebsocketClient cl
             //如果是ping，回复本地数据的md5版本 
             var appId = request.Headers["appid"];
             var env = request.Headers["env"].ToString();
-            env = _configService.IfEnvEmptySetDefault(ref env);
+            env = ISettingService.IfEnvEmptySetDefault(ref env);
             var md5 = await _configService.AppPublishedConfigsMd5CacheWithInheritanced(appId, env);
             await SendMessage(client.Client, $"V:{md5}");
         }

src/AgileConfig.Server.IService/IConfigService.cs

@@ -7,13 +7,6 @@ namespace AgileConfig.Server.IService
 {
     public interface IConfigService: IDisposable
     {
-        /// <summary>
-        /// 如果环境为空，返回默认环境，默认环境为数据库设置的环境列表的第一个
-        /// </summary>
-        /// <param name="env"></param>
-        /// <returns></returns>
-        string IfEnvEmptySetDefault(ref string env);
-
         /// <summary>
         /// 发布当前待发布的配置项,如果传ids那么就是只发布这些项目，如果不传ids，那么就是全部发布
         /// </summary>

src/AgileConfig.Server.IService/ISettingService.cs

@@ -5,10 +5,27 @@
 
 namespace AgileConfig.Server.IService
 {
-    public interface ISettingService: IDisposable
+    public interface ISettingService : IDisposable
     {
         static string[] EnvironmentList { get; set; }
 
+        static string IfEnvEmptySetDefault(ref string env)
+        {
+            if (!string.IsNullOrEmpty(env))
+            {
+                return env;
+            }
+
+            if (EnvironmentList == null || EnvironmentList.Length == 0)
+            {
+                throw new ArgumentNullException(nameof(EnvironmentList));
+            }
+
+            env = EnvironmentList[0];
+
+            return env;
+        }
+
         Task<Setting> GetAsync(string id);
         Task<bool> AddAsync(Setting setting);
 

src/AgileConfig.Server.Service/ConfigService.cs

@@ -47,22 +47,6 @@ public ConfigService(IMemoryCache memoryCache,
             _publishTimelineRepositoryAccsssor = publishTimelineRepositoryAccessor;
         }
 
-        public string IfEnvEmptySetDefault(ref string env)
-        {
-            if (!string.IsNullOrEmpty(env))
-            {
-                return env;
-            }
-
-            var envList = ISettingService.EnvironmentList;
-            if (envList == null || envList.Length == 0)
-            {
-                return "";
-            }
-
-            return envList[0];
-        }
-
         public async Task<bool> AddAsync(Config config, string env)
         {
             if (config.Value == null)

test/AgileConfig.Server.ServiceTests/ISettingServiceTests.cs

@@ -0,0 +1,51 @@
+using AgileConfig.Server.IService;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+
+namespace AgileConfig.Server.ServiceTests
+{
+    [TestClass]
+    public class ISettingServiceTests
+    {
+        [TestMethod]
+        public void IfEnvEmptySetDefaultTest()
+        {
+            // Arrange
+            string env = "test";
+            ISettingService.EnvironmentList = new string[] { "test", "prod" };
+
+            // Act
+            ISettingService.IfEnvEmptySetDefault(ref env);
+
+            // Assert
+            Assert.AreEqual("test", env);
+        }
+
+        [TestMethod]
+        public void IfEnvEmptySetDefault_envEmpty_shouldReturn_defaul()
+        {
+            // Arrange
+            string env = "";
+            ISettingService.EnvironmentList = new string[] { "test", "prod" };
+
+            // Act
+            ISettingService.IfEnvEmptySetDefault(ref env);
+
+            // Assert
+            Assert.AreEqual("test", env);
+        }
+
+        [TestMethod]
+        public void IfEnvEmptySetDefault_envNull_shouldReturn_defaul()
+        {
+            // Arrange
+            string env = null;
+            ISettingService.EnvironmentList = new string[] { "test", "prod" };
+
+            // Act
+            ISettingService.IfEnvEmptySetDefault(ref env);
+
+            // Assert
+            Assert.AreEqual("test", env);
+        }
+    }
+}