feat: Created CompositeEvaluator for composite rules

Author: Marco Franceschi

src/rules-engine/evaluators/composite-evaluator.ts

@@ -0,0 +1,17 @@
+import { JsonRule, Result, Rule, RuleFinding } from '../types'
+import { RuleEvaluator } from './rule-evaluator'
+
+export default class CompositeEvaluator implements RuleEvaluator<JsonRule> {
+  canEvaluate(rule: Rule): boolean {
+    return 'relatedRules' in rule
+  }
+
+  async evaluateSingleResource(rule: Rule): Promise<RuleFinding> {
+    return {
+      id: rule.id,
+      result: Result.SKIPPED,
+      typename: 'composite',
+      rule,
+    } as RuleFinding
+  }
+}

src/rules-engine/evaluators/manual-evaluator.ts

@@ -3,7 +3,12 @@ import { RuleEvaluator } from './rule-evaluator'
 
 export default class ManualEvaluator implements RuleEvaluator<JsonRule> {
   canEvaluate(rule: Rule): boolean {
-    return !('gql' in rule) && !('conditions' in rule) && !('resource' in rule)
+    return (
+      !('gql' in rule) &&
+      !('conditions' in rule) &&
+      !('resource' in rule) &&
+      !('relatedRules' in rule)
+    )
   }
 
   async evaluateSingleResource(rule: Rule): Promise<RuleFinding> {

src/rules-engine/index.ts

@@ -6,6 +6,7 @@ import JsonEvaluator from './evaluators/json-evaluator'
 import ManualEvaluator from './evaluators/manual-evaluator'
 import JsEvaluator from './evaluators/js-evaluator'
 import { RuleEvaluator } from './evaluators/rule-evaluator'
+import CompositeEvaluator from './evaluators/composite-evaluator'
 import { Engine, ResourceData, Rule, RuleFinding } from './types'
 import { Entity } from '../types'
 
@@ -14,6 +15,7 @@ export default class RulesProvider implements Engine {
     new JsonEvaluator(),
     new JsEvaluator(),
     new ManualEvaluator(),
+    new CompositeEvaluator(),
   ]
 
   private readonly typenameToFieldMap: { [typeName: string]: string }
@@ -310,6 +312,12 @@ export default class RulesProvider implements Engine {
       return res
     }
 
+    if (isEmpty(data) && evaluator instanceof CompositeEvaluator) {
+      // Returned Composite Rule Response
+      res.push(await evaluator.evaluateSingleResource(rule))
+      return res
+    }
+
     if (!evaluator) {
       return []
     }

src/rules-engine/types.ts

@@ -50,6 +50,7 @@ export interface Rule {
   severity: Severity
   gql: string
   resource: string
+  relatedRules?: string[]
 }
 export interface RuleFinding {
   id: string