добавил правила в кастомные

Author: cottonBlanket

vtb.backend/SqlAnalyzer.Api/Controllers/Algorithm/SqlAnalyzeRuleController.cs

@@ -17,27 +17,39 @@ public SqlAnalyzeRuleController(ISqlAnalyzeRuleService service)
         _service = service;
     }
 
+    /// <summary>
+    /// Ищет все кастомные правила для аналища SQL
+    /// </summary>
     [HttpGet("find")]
     public async Task<IReadOnlyCollection<SqlAnalyzeRuleDto>> Find([FromQuery] int? skip, [FromQuery] int? take, [FromQuery] IReadOnlyCollection<Guid>? ids)
     {
         var result = await _service.Find(ids, skip, take);
         return result;
     }
 
+    /// <summary>
+    /// Создает новое кастомное правило для анализа SQL
+    /// </summary>
     [HttpPost]
     public async Task<IActionResult> Create([FromBody] [Required] SqlAnalyzeRuleCreateDto dto)
     {
         var id = await _service.Create(dto);
         return Ok(new SimpleDto<Guid>(id));
     }
 
+    /// <summary>
+    /// Обновляет кастомное правило
+    /// </summary>
     [HttpPatch]
     public async Task<ActionResult> Update([FromBody] [Required] SqlAnalyzeRuleUpdateDto dto)
     {
         await _service.Update(dto);
         return NoContent();
     }
 
+    /// <summary>
+    /// Удаляет кастомное правило
+    /// </summary>
     [HttpDelete("{id:guid}")]
     public async Task<ActionResult> Delete([FromRoute] Guid id)
     {

vtb.backend/SqlAnalyzer.Api/Controllers/QueryAnalysis/QueryAnalysisController.cs

@@ -69,7 +69,10 @@ public async Task<ActionResult<QueryDto>> Get([FromRoute] Guid queryId)
     }
 
     /// <summary>
-    /// Анализирует запрос алгоритмически + по флагу useLlm может выдать рекомендации от LLM и оптимизированный запрос
+    /// Анализирует запрос
+    /// 1 - системными правилами для sql и explain
+    /// 2 - по флагу useLlm может выдать проблемы и рекомендации от LLM а также сравнение двух запросов
+    /// 3 - по ruleIds может проверять запрос по кастомным правилам, если ruleIds не передали, будет проверять по всем правилам
     /// </summary>
     [HttpPost("{queryId:guid}/analyze")]
     public async Task<ActionResult<QueryAnalysisResultDto>> Analyze(

vtb.backend/SqlAnalyzer.Api/Program.cs

@@ -13,6 +13,7 @@
 using SqlAnalyzer.Api.Services.LlmClient.Interfaces;
 using SqlAnalyzer.Api.Services.QueryAnalysis;
 using SqlAnalyzer.Api.Services.QueryAnalysis.Interfaces;
+using SqlAnalyzer.Api.Services.RuleSeeder;
 using SqlAnalyzer.Api.Services.SubstituteValuesToSql.Interfaces;
 using SqlAnalyzerLib.LibExtensions;
 
@@ -102,6 +103,7 @@
 
     db.Database.SetCommandTimeout(TimeSpan.FromMinutes(5));
     await db.Database.MigrateAsync();
+    await CustomRuleSeeder.AddCustomRules(db);
 }
 
 app.UseCors(x => x

vtb.backend/SqlAnalyzer.Api/Services/RuleSeeder/CustomRuleSeeder.cs

@@ -0,0 +1,30 @@
+using System.Text.Json;
+using Microsoft.EntityFrameworkCore;
+using SqlAnalyzer.Api.Dal;
+using SqlAnalyzer.Api.Dal.Entities.Algorithm;
+
+namespace SqlAnalyzer.Api.Services.RuleSeeder;
+
+public static class CustomRuleSeeder
+{
+    private const string Path = "baseSqlRules.json";
+        
+    public static async Task AddCustomRules(DataContext db)
+    {
+        if (await db.SqlAnalyzeRules.CountAsync() > 0)
+        {
+            return;
+        }
+
+        var rules = JsonSerializer.Deserialize<IReadOnlyCollection<SqlAnalyzeRule>>(
+            await File.ReadAllTextAsync(Path),
+            new JsonSerializerOptions {PropertyNameCaseInsensitive = true}
+            
+            );
+        if (rules is not null && rules.Count > 0)
+        {
+            db.SqlAnalyzeRules.AddRange(rules);
+            await db.SaveChangesAsync();
+        }
+    }
+}

vtb.backend/SqlAnalyzer.Api/SqlAnalyzerLib/SqlStaticAnalysis/Constants/StaticRuleProblemsDescriptions.cs

@@ -9,7 +9,7 @@ public static class StaticRuleProblemsDescriptions
 
     public const string TypeMismatchUuidComparisonProblemDescription = "Найдено сравнение с UUID-форматной строкой без явного ::uuid.";
     public const string TypeMismatchDateComparisonProblemDescription = "Найдено сравнение с датой/временем в виде строки без явного типа.";
-    public const string TypeMismatchNumericComparisonProblemDescription = "Найдено сравнение колонки с численной строкой (например, col = '123').";
+    public const string TypeMismatchNumericComparisonProblemDescription = "Найдено сравнение колонки с численной строкой.";
 
     public const string LeadingWildcardLikeProblemDescription = "LIKE/ILIKE начинается с '%', обычный btree-индекс не поможет.";
     public const string SelectStarProblemDescription = "Использование SELECT * приводит к передаче лишних данных и неопределённости.";

vtb.backend/SqlAnalyzer.Api/SqlAnalyzerLib/SqlStaticAnalysis/Rules/FunctionOnColumnRule.cs

@@ -10,7 +10,7 @@ namespace SqlAnalyzerLib.SqlStaticAnalysis.Rules;
 /// Проверка наличия функций на индексируемых колонках (например, LOWER(col)).
 /// Ищет частые функции, которые делают выражение не sargable.
 /// </summary>
-public sealed class FunctionOnColumnRule : IStaticRule
+public sealed class FunctionOnColumnRule // : IStaticRule
 {
     /// <inheritdoc />
     public StaticRules Code => StaticRules.FunctionOnColumn;

vtb.backend/SqlAnalyzer.Api/SqlAnalyzerLib/SqlStaticAnalysis/Rules/LeadingWildcardLikeRule.cs

@@ -10,7 +10,7 @@ namespace SqlAnalyzerLib.SqlStaticAnalysis.Rules;
 /// Проверка LIKE/ILIKE с ведущим подстановочным знаком.
 /// Предлагает trigram/Gin индекс для подстрочных поисков.
 /// </summary>
-public sealed class LeadingWildcardLikeRule : IStaticRule
+public sealed class LeadingWildcardLikeRule // : IStaticRule
 {
     /// <inheritdoc />
     public StaticRules Code => StaticRules.LeadingWildcardLike;

vtb.backend/SqlAnalyzer.Api/SqlAnalyzerLib/SqlStaticAnalysis/Rules/NotInNullsRule.cs

@@ -9,7 +9,7 @@ namespace SqlAnalyzerLib.SqlStaticAnalysis.Rules;
 /// <summary>
 /// Проверка NOT IN — рекомендует NOT EXISTS для корректной работы с NULL и предотвращения неожиданных результатов.
 /// </summary>
-public sealed class NotInNullsRule : IStaticRule
+public sealed class NotInNullsRule //: IStaticRule
 {
     /// <inheritdoc />
     public StaticRules Code => StaticRules.NotInNulls;

vtb.backend/SqlAnalyzer.Api/SqlAnalyzerLib/SqlStaticAnalysis/Rules/OffsetPaginationRule.cs

@@ -9,7 +9,7 @@ namespace SqlAnalyzerLib.SqlStaticAnalysis.Rules;
 /// <summary>
 /// Проверка OFFSET (пагинация). Предупреждает об эффективности при больших смещениях.
 /// </summary>
-public sealed class OffsetPaginationRule : IStaticRule
+public sealed class OffsetPaginationRule //: IStaticRule
 {
     /// <inheritdoc />
     public StaticRules Code => StaticRules.OffsetPagination;

vtb.backend/SqlAnalyzer.Api/SqlAnalyzerLib/SqlStaticAnalysis/Rules/SelectStarRule.cs

@@ -9,7 +9,7 @@ namespace SqlAnalyzerLib.SqlStaticAnalysis.Rules;
 /// <summary>
 /// Проверка использования SELECT * — рекомендует выбирать явные колонки.
 /// </summary>
-public sealed class SelectStarRule : IStaticRule
+public sealed class SelectStarRule //: IStaticRule
 {
     /// <inheritdoc />
     public StaticRules Code => StaticRules.SelectStar;