Allow github context in configValidator and overrideValidator (#584)

* init

* remove fdic refs in package log

* remove test.log

* update gitignore to include test.log

* fix all mergeDeep tests

* revert validator.test.js to main-enterprise

* revert public true flag to false

* fix formatting for pr

---------

Co-authored-by: Sudhansu Shrestha <[email protected]>

.gitignore

@@ -136,3 +136,6 @@ yarn.lock
 # aws sam stuff
 .aws-sam
 samconfig.toml
+
+# test file to be ignored
+test.log

lib/deploymentConfig.js

@@ -23,15 +23,15 @@ class DeploymentConfig {
         if (this.isIterable(overridevalidators)) {
           for (const validator of overridevalidators) {
             // eslint-disable-next-line no-new-func
-            const f = new Function('baseconfig', 'overrideconfig', validator.script)
+            const f = new Function('baseconfig', 'overrideconfig', 'githubContext', validator.script)
             this.overridevalidators[validator.plugin] = { canOverride: f, error: validator.error }
           }
         }
         const configvalidators = this.config.configvalidators
         if (this.isIterable(configvalidators)) {
           for (const validator of configvalidators) {
             // eslint-disable-next-line no-new-func
-            const f = new Function('baseconfig', validator.script)
+            const f = new Function('baseconfig', 'githubContext', validator.script)
             this.configvalidators[validator.plugin] = { isValid: f, error: validator.error }
           }
         }

lib/mergeArrayBy.js

@@ -11,26 +11,26 @@ function findMatchingIndex (properties, sourceItem, target) {
   }
 }
 
-function mergeBy (key, configvalidator, overridevalidator, properties, target, source, options) {
+function mergeBy (key, configvalidator, overridevalidator, properties, target, source, options, githubContext) {
   const destination = target.slice()
   source.forEach(sourceItem => {
     const matchingIndex = findMatchingIndex(properties, sourceItem, target)
     if (matchingIndex > -1) {
       if (overridevalidator) {
-        if (!overridevalidator.canOverride(target[matchingIndex], sourceItem)) {
+        if (!overridevalidator.canOverride(target[matchingIndex], sourceItem, githubContext)) {
           throw new Error(overridevalidator.error)
         }
       }
       destination[matchingIndex] = merge(target[matchingIndex], sourceItem, options)
       if (configvalidator) {
-        if (!configvalidator.isValid(destination[matchingIndex])) {
+        if (!configvalidator.isValid(destination[matchingIndex], githubContext)) {
           throw new Error(configvalidator.error)
         }
       }
     } else {
       destination.push(sourceItem)
       if (configvalidator) {
-        if (!configvalidator.isValid(sourceItem)) {
+        if (!configvalidator.isValid(sourceItem, githubContext)) {
           throw new Error(configvalidator.error)
         }
       }

lib/mergeDeep.js

@@ -6,8 +6,9 @@ const NAME_USERNAME_PROPERTY = item => NAME_FIELDS.find(prop => Object.prototype
 const GET_NAME_USERNAME_PROPERTY = item => { if (NAME_USERNAME_PROPERTY(item)) return item[NAME_USERNAME_PROPERTY(item)] }
 
 class MergeDeep {
-  constructor (log, ignorableFields, configvalidators = {}, overridevalidators = {}) {
+  constructor (log, github, ignorableFields, configvalidators = {}, overridevalidators = {}) {
     this.log = log
+    this.github = github
     this.ignorableFields = ignorableFields
     this.configvalidators = DeploymentConfig.configvalidators
     this.overridevalidators = DeploymentConfig.overridevalidators
@@ -269,7 +270,7 @@ class MergeDeep {
     }
     if (this.overridevalidators[key]) {
       // this.log.debug(`Calling overridevalidator for key ${key} `)
-      if (!this.overridevalidators[key].canOverride(baseconfig, overrideconfig)) {
+      if (!this.overridevalidators[key].canOverride(baseconfig, overrideconfig, this.github)) {
         this.log.error(`Error in calling overridevalidator for key ${key} ${this.overridevalidators[key].error}`)
         throw new Error(this.overridevalidators[key].error)
       }
@@ -279,7 +280,7 @@ class MergeDeep {
   validateConfig (key, baseconfig) {
     if (this.configvalidators[key]) {
       // this.log.debug(`Calling configvalidator for key ${key} `)
-      if (!this.configvalidators[key].isValid(baseconfig)) {
+      if (!this.configvalidators[key].isValid(baseconfig, this.github)) {
         this.log.error(`Error in calling configvalidator for key ${key} ${this.configvalidators[key].error}`)
         throw new Error(this.configvalidators[key].error)
       }
@@ -311,7 +312,7 @@ class MergeDeep {
           // Deep merge Array so that if the same element is there in source and target,
           // override the target with source otherwise include both source and target elements
           if (Array.isArray(source[key]) && Array.isArray(target[key])) {
-            const combined = mergeBy(key, this.configvalidators[key], this.overridevalidators[key], NAME_FIELDS, target[key], source[key])
+            const combined = mergeBy(key, this.configvalidators[key], this.overridevalidators[key], NAME_FIELDS, target[key], source[key], this.github)
             Object.assign(target, {
               [key]: combined
             })

lib/settings.js

@@ -77,19 +77,20 @@ class Settings {
     if (this.isIterable(overridevalidators)) {
       for (const validator of overridevalidators) {
         // eslint-disable-next-line no-new-func
-        const f = new Function('baseconfig', 'overrideconfig', validator.script)
+        const f = new Function('baseconfig', 'overrideconfig', 'githubContext', validator.script)
         this.overridevalidators[validator.plugin] = { canOverride: f, error: validator.error }
       }
     }
     const configvalidators = config.configvalidators
     if (this.isIterable(configvalidators)) {
       for (const validator of configvalidators) {
+        this.log.debug(`Logging each script: ${typeof validator.script}`)
         // eslint-disable-next-line no-new-func
-        const f = new Function('baseconfig', validator.script)
+        const f = new Function('baseconfig', 'githubContext', validator.script)
         this.configvalidators[validator.plugin] = { isValid: f, error: validator.error }
       }
     }
-    this.mergeDeep = new MergeDeep(this.log, [], this.configvalidators, this.overridevalidators)
+    this.mergeDeep = new MergeDeep(this.log, this.github, [], this.configvalidators, this.overridevalidators)
   }
 
   // Create a check in the Admin repo for safe-settings.
@@ -411,15 +412,15 @@ ${this.results.reduce((x, y) => {
     const configValidator = this.configvalidators[section]
     if (configValidator) {
       this.log.debug(`Calling configvalidator for key ${section} `)
-      if (!configValidator.isValid(overrideConfig)) {
+      if (!configValidator.isValid(overrideConfig, this.github)) {
         this.log.error(`Error in calling configvalidator for key ${section} ${configValidator.error}`)
         throw new Error(configValidator.error)
       }
     }
     const overridevalidator = this.overridevalidators[section]
     if (overridevalidator) {
       this.log.debug(`Calling overridevalidator for key ${section} `)
-      if (!overridevalidator.canOverride(baseConfig, overrideConfig)) {
+      if (!overridevalidator.canOverride(baseConfig, overrideConfig, this.github)) {
         this.log.error(`Error in calling overridevalidator for key ${section} ${overridevalidator.error}`)
         throw new Error(overridevalidator.error)
       }