Allow github context in configValidator and overrideValidator (#584)

sshrestha02 · Sudhansu Shrestha · web-flow · commit 6c297f2fdb1f · 2024-02-05T17:28:20.000-05:00
* 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 &lt;sudhansushrestha@sudhansus-mbp.lan&gt;
diff --git a/.gitignore b/.gitignore
@@ -136,3 +136,6 @@ yarn.lock
 # aws sam stuff
 .aws-sam
 samconfig.toml
+
+# test file to be ignored
+test.log
diff --git a/lib/deploymentConfig.js b/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 }
           }
         }
diff --git a/lib/mergeArrayBy.js b/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)
         }
       }
diff --git a/lib/mergeDeep.js b/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
             })
diff --git a/lib/settings.js b/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)
       }
diff --git a/test/unit/lib/mergeDeep.test.js b/test/unit/lib/mergeDeep.test.js

Original file line number	Diff line number	Diff line change
`@@ -23,15 +23,15 @@ class DeploymentConfig {`
`23`	`23`	`if (this.isIterable(overridevalidators)) {`
`24`	`24`	`for (const validator of overridevalidators) {`
`25`	`25`	`// eslint-disable-next-line no-new-func`
`26`		`- const f = new Function('baseconfig', 'overrideconfig', validator.script)`
	`26`	`+ const f = new Function('baseconfig', 'overrideconfig', 'githubContext', validator.script)`
`27`	`27`	`this.overridevalidators[validator.plugin] = { canOverride: f, error: validator.error }`
`28`	`28`	`}`
`29`	`29`	`}`
`30`	`30`	`const configvalidators = this.config.configvalidators`
`31`	`31`	`if (this.isIterable(configvalidators)) {`
`32`	`32`	`for (const validator of configvalidators) {`
`33`	`33`	`// eslint-disable-next-line no-new-func`
`34`		`- const f = new Function('baseconfig', validator.script)`
	`34`	`+ const f = new Function('baseconfig', 'githubContext', validator.script)`
`35`	`35`	`this.configvalidators[validator.plugin] = { isValid: f, error: validator.error }`
`36`	`36`	`}`
`37`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,26 +11,26 @@ function findMatchingIndex (properties, sourceItem, target) {`
`11`	`11`	`}`
`12`	`12`	`}`
`13`	`13`
`14`		`-function mergeBy (key, configvalidator, overridevalidator, properties, target, source, options) {`
	`14`	`+function mergeBy (key, configvalidator, overridevalidator, properties, target, source, options, githubContext) {`
`15`	`15`	`const destination = target.slice()`
`16`	`16`	`source.forEach(sourceItem => {`
`17`	`17`	`const matchingIndex = findMatchingIndex(properties, sourceItem, target)`
`18`	`18`	`if (matchingIndex > -1) {`
`19`	`19`	`if (overridevalidator) {`
`20`		`- if (!overridevalidator.canOverride(target[matchingIndex], sourceItem)) {`
	`20`	`+ if (!overridevalidator.canOverride(target[matchingIndex], sourceItem, githubContext)) {`
`21`	`21`	`throw new Error(overridevalidator.error)`
`22`	`22`	`}`
`23`	`23`	`}`
`24`	`24`	`destination[matchingIndex] = merge(target[matchingIndex], sourceItem, options)`
`25`	`25`	`if (configvalidator) {`
`26`		`- if (!configvalidator.isValid(destination[matchingIndex])) {`
	`26`	`+ if (!configvalidator.isValid(destination[matchingIndex], githubContext)) {`
`27`	`27`	`throw new Error(configvalidator.error)`
`28`	`28`	`}`
`29`	`29`	`}`
`30`	`30`	`} else {`
`31`	`31`	`destination.push(sourceItem)`
`32`	`32`	`if (configvalidator) {`
`33`		`- if (!configvalidator.isValid(sourceItem)) {`
	`33`	`+ if (!configvalidator.isValid(sourceItem, githubContext)) {`
`34`	`34`	`throw new Error(configvalidator.error)`
`35`	`35`	`}`
`36`	`36`	`}`
Original file line number	Diff line number	Diff line change
`@@ -77,19 +77,20 @@ class Settings {`
`77`	`77`	`if (this.isIterable(overridevalidators)) {`
`78`	`78`	`for (const validator of overridevalidators) {`
`79`	`79`	`// eslint-disable-next-line no-new-func`
`80`		`- const f = new Function('baseconfig', 'overrideconfig', validator.script)`
	`80`	`+ const f = new Function('baseconfig', 'overrideconfig', 'githubContext', validator.script)`
`81`	`81`	`this.overridevalidators[validator.plugin] = { canOverride: f, error: validator.error }`
`82`	`82`	`}`
`83`	`83`	`}`
`84`	`84`	`const configvalidators = config.configvalidators`
`85`	`85`	`if (this.isIterable(configvalidators)) {`
`86`	`86`	`for (const validator of configvalidators) {`
	`87`	+ this.log.debug(`Logging each script: ${typeof validator.script}`)
`87`	`88`	`// eslint-disable-next-line no-new-func`
`88`		`- const f = new Function('baseconfig', validator.script)`
	`89`	`+ const f = new Function('baseconfig', 'githubContext', validator.script)`
`89`	`90`	`this.configvalidators[validator.plugin] = { isValid: f, error: validator.error }`
`90`	`91`	`}`
`91`	`92`	`}`
`92`		`- this.mergeDeep = new MergeDeep(this.log, [], this.configvalidators, this.overridevalidators)`
	`93`	`+ this.mergeDeep = new MergeDeep(this.log, this.github, [], this.configvalidators, this.overridevalidators)`
`93`	`94`	`}`
`94`	`95`
`95`	`96`	`// Create a check in the Admin repo for safe-settings.`
`@@ -411,15 +412,15 @@ ${this.results.reduce((x, y) => {`
`411`	`412`	`const configValidator = this.configvalidators[section]`
`412`	`413`	`if (configValidator) {`
`413`	`414`	this.log.debug(`Calling configvalidator for key ${section} `)
`414`		`- if (!configValidator.isValid(overrideConfig)) {`
	`415`	`+ if (!configValidator.isValid(overrideConfig, this.github)) {`
`415`	`416`	this.log.error(`Error in calling configvalidator for key ${section} ${configValidator.error}`)
`416`	`417`	`throw new Error(configValidator.error)`
`417`	`418`	`}`
`418`	`419`	`}`
`419`	`420`	`const overridevalidator = this.overridevalidators[section]`
`420`	`421`	`if (overridevalidator) {`
`421`	`422`	this.log.debug(`Calling overridevalidator for key ${section} `)
`422`		`- if (!overridevalidator.canOverride(baseConfig, overrideConfig)) {`
	`423`	`+ if (!overridevalidator.canOverride(baseConfig, overrideConfig, this.github)) {`
`423`	`424`	this.log.error(`Error in calling overridevalidator for key ${section} ${overridevalidator.error}`)
`424`	`425`	`throw new Error(overridevalidator.error)`
`425`	`426`	`}`