refactor(binary): обновление ключей конфигурации лимита памяти для двоичных данных

Author: johnnyshut

src/OneScript.BinaryData/BinaryDataConfigurationDefaults.cs

@@ -13,7 +13,7 @@ namespace OneScript.BinaryData
     public static class BinaryDataConfigurationDefaults
     {
         /// <summary>
-        /// Лимит по умолчанию (50 МБ), если в конфигурации не задан ключ binaryData.inMemoryMaxBytes.
+        /// Лимит по умолчанию (50 МБ), если в конфигурации не задан ключ binaryData.inMemoryMaxSize.
         /// </summary>
         public const int InMemoryMaxBytes = 1024 * 1024 * 50;
     }

src/OneScript.BinaryData/BinaryDataMemoryLimitConfiguration.cs

@@ -15,29 +15,77 @@ namespace OneScript.BinaryData
     /// </summary>
     public static class BinaryDataMemoryLimitConfiguration
     {
-        public const string InMemoryMaxBytesConfigKey = "binaryData.inMemoryMaxBytes";
+        public const string InMemoryMaxSizeConfigKey = "binaryData.inMemoryMaxSize";
 
         /// <summary>
         /// Возвращает лимит в байтах из строки конфигурации; при ошибке — <see cref="BinaryDataConfigurationDefaults.InMemoryMaxBytes"/> и сообщение через <paramref name="logWarning"/>.
+        /// Допускается целое число байт или значение с суффиксом k, m, g (512k, 50m, 1g).
         /// </summary>
         public static int ResolveFromConfigString(string rawValue, Action<string> logWarning)
         {
             if (string.IsNullOrWhiteSpace(rawValue))
                 return BinaryDataConfigurationDefaults.InMemoryMaxBytes;
 
-            if (!int.TryParse(rawValue.Trim(), NumberStyles.Integer, CultureInfo.InvariantCulture, out var bytes))
+            if (!TryParseByteSize(rawValue.Trim(), out var bytes))
             {
-                logWarning?.Invoke($"Invalid value for {InMemoryMaxBytesConfigKey}: {rawValue}");
+                logWarning?.Invoke($"Invalid value for {InMemoryMaxSizeConfigKey}: {rawValue}");
                 return BinaryDataConfigurationDefaults.InMemoryMaxBytes;
             }
 
             if (bytes <= 0 || bytes == int.MaxValue)
             {
-                logWarning?.Invoke($"Value for {InMemoryMaxBytesConfigKey} must be between 1 and {int.MaxValue - 1}: {bytes}");
+                logWarning?.Invoke($"Value for {InMemoryMaxSizeConfigKey} must be between 1 and {int.MaxValue - 1}: {bytes}");
                 return BinaryDataConfigurationDefaults.InMemoryMaxBytes;
             }
 
             return bytes;
         }
+
+        private static bool TryParseByteSize(string value, out int bytes)
+        {
+            bytes = 0;
+
+            if (value.Length == 0)
+                return false;
+
+            var suffix = value[value.Length - 1];
+            long multiplier = 1;
+            var numberPart = value;
+
+            switch (suffix)
+            {
+                case 'k':
+                case 'K':
+                    multiplier = 1024L;
+                    numberPart = value.Substring(0, value.Length - 1).TrimEnd();
+                    break;
+                case 'm':
+                case 'M':
+                    multiplier = 1024L * 1024L;
+                    numberPart = value.Substring(0, value.Length - 1).TrimEnd();
+                    break;
+                case 'g':
+                case 'G':
+                    multiplier = 1024L * 1024L * 1024L;
+                    numberPart = value.Substring(0, value.Length - 1).TrimEnd();
+                    break;
+            }
+
+            if (numberPart.Length == 0)
+                return false;
+
+            if (!long.TryParse(numberPart, NumberStyles.Integer, CultureInfo.InvariantCulture, out var number))
+                return false;
+
+            if (number <= 0)
+                return false;
+
+            var result = number * multiplier;
+            if (result <= 0 || result >= int.MaxValue)
+                return false;
+
+            bytes = (int)result;
+            return true;
+        }
     }
 }

src/OneScript.StandardLibrary/EngineBuilderExtensions.cs

@@ -16,15 +16,15 @@ namespace OneScript.StandardLibrary
     public static class EngineBuilderExtensions
     {
         /// <summary>
-        /// Регистрирует лимит памяти для «ДвоичныеДанные» из конфигурации движка (ключ <see cref="BinaryDataMemoryLimitConfiguration.InMemoryMaxBytesConfigKey"/>).
+        /// Регистрирует лимит памяти для «ДвоичныеДанные» из конфигурации движка (ключ <see cref="BinaryDataMemoryLimitConfiguration.InMemoryMaxSizeConfigKey"/>).
         /// Вызывайте после <c>SetDefaultOptions</c> из <c>ScriptEngine.Hosting.EngineBuilderExtensions</c>.
         /// </summary>
         public static IEngineBuilder RegisterBinaryDataMemoryLimitFromConfig(this IEngineBuilder builder)
         {
             builder.Services.RegisterSingleton<IBinaryDataMemoryLimit>(sp =>
             {
                 var cfg = sp.Resolve<KeyValueConfig>();
-                var raw = cfg[BinaryDataMemoryLimitConfiguration.InMemoryMaxBytesConfigKey];
+                var raw = cfg[BinaryDataMemoryLimitConfiguration.InMemoryMaxSizeConfigKey];
                 var bytes = BinaryDataMemoryLimitConfiguration.ResolveFromConfigString(raw, SystemLogger.Write);
                 return new BinaryDataMemoryLimit(bytes);
             });

src/ScriptEngine.HostedScript/oscript.cfg

@@ -21,6 +21,7 @@ lib.system = ../lib
 
 #systemlanguage = ru
 
-# Порог в байтах: пока размер двоичных данных в памяти не превышает это значение, данные держатся в RAM;
-# при большем размере используется временный файл. По умолчанию 52428800 (50 МБ).
-#binaryData.inMemoryMaxBytes=52428800
+# Порог: пока размер двоичных данных в памяти не превышает это значение, данные держатся в RAM;
+# при большем размере используется временный файл. По умолчанию 50m (52428800 байт).
+# Значение — целое число байт или с суффиксом k, m, g (512k, 50m, 1g).
+#binaryData.inMemoryMaxSize=50m

src/Tests/OneScript.StandardLibrary.Tests/BinaryDataMemoryLimitConfigurationTests.cs

@@ -0,0 +1,62 @@
+/*----------------------------------------------------------
+This Source Code Form is subject to the terms of the
+Mozilla Public License, v.2.0. If a copy of the MPL
+was not distributed with this file, You can obtain one
+at http://mozilla.org/MPL/2.0/.
+----------------------------------------------------------*/
+
+using System.Collections.Generic;
+using FluentAssertions;
+using OneScript.BinaryData;
+using Xunit;
+
+namespace OneScript.StandardLibrary.Tests
+{
+    public class BinaryDataMemoryLimitConfigurationTests
+    {
+        [Theory]
+        [InlineData("52428800", 52428800)]
+        [InlineData("512k", 512 * 1024)]
+        [InlineData("512K", 512 * 1024)]
+        [InlineData("50m", 50 * 1024 * 1024)]
+        [InlineData("50M", 50 * 1024 * 1024)]
+        [InlineData("1g", 1024 * 1024 * 1024)]
+        [InlineData("1G", 1024 * 1024 * 1024)]
+        public void ResolvesByteSizeWithOptionalSuffix(string rawValue, int expectedBytes)
+        {
+            var warnings = new List<string>();
+
+            var bytes = BinaryDataMemoryLimitConfiguration.ResolveFromConfigString(rawValue, warnings.Add);
+
+            bytes.Should().Be(expectedBytes);
+            warnings.Should().BeEmpty();
+        }
+
+        [Theory]
+        [InlineData(null)]
+        [InlineData("")]
+        [InlineData("   ")]
+        public void UsesDefaultWhenValueIsMissing(string rawValue)
+        {
+            var bytes = BinaryDataMemoryLimitConfiguration.ResolveFromConfigString(rawValue, _ => { });
+
+            bytes.Should().Be(BinaryDataConfigurationDefaults.InMemoryMaxBytes);
+        }
+
+        [Theory]
+        [InlineData("512x")]
+        [InlineData("m512")]
+        [InlineData("0")]
+        [InlineData("-1")]
+        [InlineData("2g")]
+        public void UsesDefaultForInvalidValue(string rawValue)
+        {
+            var warnings = new List<string>();
+
+            var bytes = BinaryDataMemoryLimitConfiguration.ResolveFromConfigString(rawValue, warnings.Add);
+
+            bytes.Should().Be(BinaryDataConfigurationDefaults.InMemoryMaxBytes);
+            warnings.Should().NotBeEmpty();
+        }
+    }
+}

src/Tests/OneScript.StandardLibrary.Tests/OneScript.StandardLibrary.Tests.csproj

@@ -23,6 +23,7 @@
     </ItemGroup>
 
     <ItemGroup>
+      <ProjectReference Include="..\..\OneScript.BinaryData\OneScript.BinaryData.csproj" />
       <ProjectReference Include="..\..\OneScript.StandardLibrary\OneScript.StandardLibrary.csproj" />
     </ItemGroup>