Merge pull request #5 from cloudgraphdev/feature/CG-1026

feat: RulesEngine Optimization

Author: tyler-dunkel

src/plugins/policyPack/index.ts

@@ -186,19 +186,18 @@ export default class PolicyPackPlugin extends Plugin {
   }
 
   // TODO: Generalize data processor moving storage module to SDK with its interfaces
-  private getDataProcessor({
-    entity,
-    provider,
-  }: {
-    entity: string
-    provider: string
+  private getDataProcessor(config: {
+    providerName: string
+    entityName: string
+    typenameToFieldMap?: { [tn: string]: string }
+    extraFields?: string[]
   }): DataProcessor {
-    const dataProcessorKey = `${provider}${entity}`
+    const dataProcessorKey = `${config.providerName}${config.entityName}`
     if (this.dataProcessors[dataProcessorKey]) {
       return this.dataProcessors[dataProcessorKey]
     }
 
-    const dataProcessor = new DgraphDataProcessor(provider, entity)
+    const dataProcessor = new DgraphDataProcessor(config)
     this.dataProcessors[dataProcessorKey] = dataProcessor
     return dataProcessor
   }
@@ -256,14 +255,17 @@ export default class PolicyPackPlugin extends Plugin {
         continue // eslint-disable-line no-continue
       }
 
-      // Initialize RulesEngine
-      const rulesEngine = new RulesEngine({
+      // Initialize Data Processor
+      const dataProcessor = this.getDataProcessor({
         providerName: this.provider.name,
         entityName: policyPackPlugin.entity,
         typenameToFieldMap: resourceTypeNamesToFieldsMap,
         extraFields: policyPackPlugin.extraFields,
       })
 
+      // Initialize RulesEngine
+      const rulesEngine = new RulesEngine(dataProcessor)
+
       this.policyPacksPlugins[policyPack] = {
         engine: rulesEngine,
         entity: policyPackPlugin.entity,
@@ -318,14 +320,8 @@ export default class PolicyPackPlugin extends Plugin {
           storageEngine,
         })
 
-        // Data Processor
-        const dataProcessor = this.getDataProcessor({
-          entity,
-          provider: this.provider.name,
-        })
-
         // Prepare mutations
-        const mutations = dataProcessor.prepareMutations(findings)
+        const mutations = engine.prepareMutations(findings, rules)
 
         // Save connections
         processConnectionsBetweenEntities({

src/rules-engine/data-processors/data-processor.ts

@@ -1,11 +1,28 @@
 import { Entity } from '../../types'
-import { RuleFinding } from '../types'
+import { Rule, RuleFinding } from '../types'
 
 export default interface DataProcessor {
+  readonly typenameToFieldMap: { [typeName: string]: string }
+
+  readonly extraFields: string[]
+
+  /**
+   * Returns an GraphQL schema build dynamically based on the provider and existing resources
+   * @returns new schemas and extensions for existing ones
+   */
+  getSchema: () => string[]
+
   /**
    * Transforms RuleFinding array into a mutation array for GraphQL
    * @param findings resulted findings during rules execution
    * @returns {Entity[]} Array of generated mutations
    */
-  prepareMutations: (findings: RuleFinding[]) => Entity[]
+  prepareFindingsMutations: (findings: RuleFinding[]) => Entity[]
+
+  /**
+   * Transforms Rules array into a mutation array for GraphQL
+   * @param rules rules metadata
+   * @returns {Entity[]} Array of generated mutations
+   */
+  prepareRulesMetadataMutations: (rules: Rule[]) => Entity[]
 }