Support requireReason

See naugtur/npm-audit-resolver#23
ronjouch · Jun 29, 2022 · 5050606 · 5050606
1 parent 957724e
commit 5050606
Show file tree

Hide file tree

Showing 7 changed files with 140 additions and 0 deletions.
diff --git a/auditFile/fileHandle.js b/auditFile/fileHandle.js
@@ -50,6 +50,18 @@ function readAndValidate (pathOverride) {
   if (!versions[version]) {
     throw Error(`Unrecognized ${FILE.FILENAME} content version ${version}`)
   }
+  if (data.version > 0 && data.requireReason && data.requireReason !== "false") {
+    versions[version].schema.properties.decisions.additionalProperties.required.push('reason')
+    versions[version].schema.properties.decisions.additionalProperties.properties.reason.minLength = 1
+    if (data.requireReason !== true && data.requireReason !== "true") {
+      try {
+        new RegExp(data.requireReason)
+        versions[version].schema.properties.decisions.additionalProperties.properties.reason.pattern = data.requireReason
+      } catch (err) {
+        throw Error(`audit-resolve "requireReason" must be a boolean or a valid regex. Got ${data.requireReason}`)
+      }
+    }
+  }
   validate(versions[version].schema, data)
   return data
 }

diff --git a/test/auditFile/schemas.js b/test/auditFile/schemas.js
@@ -4,6 +4,22 @@ const auditFile = require('../../auditFile/fileHandle')
 
 auditFile.load(path.resolve(__dirname, './v1ok.json'))
 
+auditFile.load(path.resolve(__dirname, './v1reasonOk.json'))
+
+auditFile.load(path.resolve(__dirname, './v1reasonOkRegex.json'))
+
+assert.throws(() => {
+  auditFile.load(path.resolve(__dirname, './v1reasonKoEmptyString.json'))
+})
+
+assert.throws(() => {
+  auditFile.load(path.resolve(__dirname, './v1reasonKoLacking.json'))
+})
+
+assert.throws(() => {
+  auditFile.load(path.resolve(__dirname, './v1reasonKoRegex.json'))
+})
+
 assert.throws(() => {
   auditFile.load(path.resolve(__dirname, './v1wrong.json'))
 })

diff --git a/test/auditFile/v1reasonKoEmptyString.json b/test/auditFile/v1reasonKoEmptyString.json
@@ -0,0 +1,16 @@
+{
+    "version": 1,
+    "requireReason": true,
+    "decisions": {
+        "123|unnecessary>lodash": {
+            "decision": "none",
+            "madeAt": 1552676146555,
+            "reason": "package was removed"
+        },
+        "123|other": {
+            "decision": "postpone",
+            "madeAt": 1552676146555,
+            "reason": ""
+        }
+    }
+}
diff --git a/test/auditFile/v1reasonKoLacking.json b/test/auditFile/v1reasonKoLacking.json
@@ -0,0 +1,15 @@
+{
+    "version": 1,
+    "requireReason": true,
+    "decisions": {
+        "123|unnecessary>lodash": {
+            "decision": "none",
+            "madeAt": 1552676146555,
+            "reason": "package was removed"
+        },
+        "123|other": {
+            "decision": "postpone",
+            "madeAt": 1552676146555
+        }
+    }
+}
diff --git a/test/auditFile/v1reasonKoRegex.json b/test/auditFile/v1reasonKoRegex.json
@@ -0,0 +1,27 @@
+{
+    "version": 1,
+    "requireReason": "^.+. I promise.$",
+    "decisions": {
+        "123|lodash": {
+            "decision": "fix",
+            "madeAt": 1552676146555,
+            "reason": "I did the thing. I promise."
+        },
+        "123|unnecessary>lodash": {
+            "decision": "none",
+            "madeAt": 1552676146555,
+            "reason": "package was removed. I promise."
+        },
+        "123|other": {
+            "decision": "postpone",
+            "madeAt": 1552676146555,
+            "reason": "Imcareless. I promise."
+        },
+        "123|somethingelse": {
+            "decision": "ignore",
+            "madeAt": 1552676146555,
+            "expiresAt": 2552676146555,
+            "reason": "tomorrow is a better day"
+        }
+    }
+}
diff --git a/test/auditFile/v1reasonOk.json b/test/auditFile/v1reasonOk.json
@@ -0,0 +1,27 @@
+{
+    "version": 1,
+    "requireReason": true,
+    "decisions": {
+        "123|lodash": {
+            "decision": "fix",
+            "madeAt": 1552676146555,
+            "reason": "I did the thing"
+        },
+        "123|unnecessary>lodash": {
+            "decision": "none",
+            "madeAt": 1552676146555,
+            "reason": "package was removed"
+        },
+        "123|other": {
+            "decision": "postpone",
+            "madeAt": 1552676146555,
+            "reason": "Imcareless"
+        },
+        "123|somethingelse": {
+            "decision": "ignore",
+            "madeAt": 1552676146555,
+            "expiresAt": 2552676146555,
+            "reason": "tomorrow is a better day"
+        }
+    }
+}
diff --git a/test/auditFile/v1reasonOkRegex.json b/test/auditFile/v1reasonOkRegex.json
@@ -0,0 +1,27 @@
+{
+    "version": 1,
+    "requireReason": "^.+. I promise.$",
+    "decisions": {
+        "123|lodash": {
+            "decision": "fix",
+            "madeAt": 1552676146555,
+            "reason": "I did the thing. I promise."
+        },
+        "123|unnecessary>lodash": {
+            "decision": "none",
+            "madeAt": 1552676146555,
+            "reason": "package was removed. I promise."
+        },
+        "123|other": {
+            "decision": "postpone",
+            "madeAt": 1552676146555,
+            "reason": "Imcareless. I promise."
+        },
+        "123|somethingelse": {
+            "decision": "ignore",
+            "madeAt": 1552676146555,
+            "expiresAt": 2552676146555,
+            "reason": "tomorrow is a better day. I promise."
+        }
+    }
+}