adds comments

elastic · Sep 30, 2024 · 448899b · 448899b
1 parent b943c49
commit 448899b
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 5 deletions.
diff --git a/..._engine/prebuilt_rules/logic/diff/calculation/algorithms/rule_type_diff_algorithm.test.ts b/..._engine/prebuilt_rules/logic/diff/calculation/algorithms/rule_type_diff_algorithm.test.ts
@@ -38,9 +38,10 @@ describe('ruleTypeDiffAlgorithm', () => {
   });
 
   it('returns current_version as merged output if current_version is different and there is no update - scenario ABA', () => {
+    // User can change rule type field between `query` and `saved_query` in the UI, no other rule types
     const mockVersions: ThreeVersionsOf<DiffableRuleTypes> = {
       base_version: 'query',
-      current_version: 'eql',
+      current_version: 'saved_query',
       target_version: 'query',
     };
 
@@ -57,10 +58,11 @@ describe('ruleTypeDiffAlgorithm', () => {
   });
 
   it('returns target_version as merged output if current_version is the same and there is an update - scenario AAB', () => {
+    // User can change rule type field between `query` and `saved_query` in the UI, no other rule types
     const mockVersions: ThreeVersionsOf<DiffableRuleTypes> = {
       base_version: 'query',
       current_version: 'query',
-      target_version: 'eql',
+      target_version: 'saved_query',
     };
 
     const result = ruleTypeDiffAlgorithm(mockVersions);
@@ -76,10 +78,11 @@ describe('ruleTypeDiffAlgorithm', () => {
   });
 
   it('returns current_version as merged output if current version is different but it matches the update - scenario ABB', () => {
+    // User can change rule type field between `query` and `saved_query` in the UI, no other rule types
     const mockVersions: ThreeVersionsOf<DiffableRuleTypes> = {
       base_version: 'query',
-      current_version: 'eql',
-      target_version: 'eql',
+      current_version: 'saved_query',
+      target_version: 'saved_query',
     };
 
     const result = ruleTypeDiffAlgorithm(mockVersions);
@@ -95,6 +98,8 @@ describe('ruleTypeDiffAlgorithm', () => {
   });
 
   it('returns current_version as merged output if all three versions are different - scenario ABC', () => {
+    // User can change rule type field between `query` and `saved_query` in the UI, no other rule types
+    // NOTE: This test case scenario is currently inaccessible via normal UI or API workflows, but the logic is covered just in case
     const mockVersions: ThreeVersionsOf<DiffableRuleTypes> = {
       base_version: 'query',
       current_version: 'eql',
@@ -136,10 +141,11 @@ describe('ruleTypeDiffAlgorithm', () => {
     });
 
     it('returns target_version as merged output if current_version and target_version are different - scenario -AB', () => {
+      // User can change rule type field between `query` and `saved_query` in the UI, no other rule types
       const mockVersions: ThreeVersionsOf<DiffableRuleTypes> = {
         base_version: MissingVersion,
         current_version: 'query',
-        target_version: 'eql',
+        target_version: 'saved_query',
       };
 
       const result = ruleTypeDiffAlgorithm(mockVersions);

diff --git a/...ction_engine/prebuilt_rules/logic/diff/calculation/algorithms/rule_type_diff_algorithm.ts b/...ction_engine/prebuilt_rules/logic/diff/calculation/algorithms/rule_type_diff_algorithm.ts
@@ -81,6 +81,7 @@ const mergeVersions = <TValue>({
     case ThreeWayDiffOutcome.CustomizedValueNoUpdate:
     case ThreeWayDiffOutcome.CustomizedValueSameUpdate:
     case ThreeWayDiffOutcome.StockValueCanUpdate:
+    // NOTE: This scenario is currently inaccessible via normal UI or API workflows, but the logic is covered just in case
     case ThreeWayDiffOutcome.CustomizedValueCanUpdate:
     // Scenario -AB is treated as scenario ABC:
     // https://github.com/elastic/kibana/pull/184889#discussion_r1636421293