feat: 🎸 Add custom error which outputs the package name too

Closes: lirantal#9
emimuresan · Oct 12, 2019 · 0904df3 · 0904df3
1 parent 76a5b3c
commit 0904df3
Show file tree

Hide file tree

Showing 7 changed files with 73 additions and 3 deletions.
diff --git a/packages/lockfile-lint-api/__tests__/validators.host.test.js b/packages/lockfile-lint-api/__tests__/validators.host.test.js
@@ -1,4 +1,5 @@
 const ValidatorHost = require('../src/validators/ValidateHost')
+const PackageError = require('../src/common/PackageError')
 
 describe('Validator: Host', () => {
   it('validator should throw an error when provided a string', () => {
@@ -142,4 +143,15 @@ describe('Validator: Host', () => {
       ]
     })
   })
+
+  it('validator should throw a descriptive error when one is encounterd in a package', () => {
+    const mockedPackages = {
+      '@babel/code-frame': {
+        resolved: 'debug-4.1.1.tgz#3b72260255109c6b589cee050f1d516139664791'
+      }
+    }
+    const validator = new ValidatorHost({packages: mockedPackages})
+
+    expect(() => validator.validate(['npm'])).toThrow(PackageError)
+  })
 })
diff --git a/packages/lockfile-lint-api/__tests__/validators.https.test.js b/packages/lockfile-lint-api/__tests__/validators.https.test.js
@@ -1,4 +1,5 @@
 const ValidatorHTTPS = require('../src/validators/ValidateHttps')
+const PackageError = require('../src/common/PackageError')
 
 describe('Validator: HTTPS', () => {
   it('validator should throw an error when provided a string', () => {
@@ -58,4 +59,15 @@ describe('Validator: HTTPS', () => {
       errors: []
     })
   })
+
+  it('validator should throw a descriptive error when one is encounterd in a package', () => {
+    const mockedPackages = {
+      '@babel/code-frame': {
+        resolved: 'debug-4.1.1.tgz#3b72260255109c6b589cee050f1d516139664791'
+      }
+    }
+    const validator = new ValidatorHTTPS({packages: mockedPackages})
+
+    expect(() => validator.validate(['npm'])).toThrow(PackageError)
+  })
 })
diff --git a/packages/lockfile-lint-api/__tests__/validators.scheme.test.js b/packages/lockfile-lint-api/__tests__/validators.scheme.test.js
@@ -1,4 +1,5 @@
 const ValidatorScheme = require('../src/validators/ValidateScheme')
+const PackageError = require('../src/common/PackageError')
 
 describe('Validator: Protocol', () => {
   it('validator should throw an error when provided a string', () => {
@@ -58,4 +59,15 @@ describe('Validator: Protocol', () => {
       errors: []
     })
   })
+
+  it('validator should throw a descriptive error when one is encounterd in a package', () => {
+    const mockedPackages = {
+      '@babel/code-frame': {
+        resolved: 'debug-4.1.1.tgz#3b72260255109c6b589cee050f1d516139664791'
+      }
+    }
+    const validator = new ValidatorScheme({packages: mockedPackages})
+
+    expect(() => validator.validate(['npm'])).toThrow(PackageError)
+  })
 })
diff --git a/packages/lockfile-lint-api/src/common/PackageError.js b/packages/lockfile-lint-api/src/common/PackageError.js
@@ -0,0 +1,15 @@
+'use strict'
+
+module.exports = class PackageError extends Error {
+  /**
+   * constructor
+   * @param {string} packageName - the name of the package where the error occured
+   * @param {string} error - the original error object
+   */
+  constructor (packageName = '', error = {}) {
+    super()
+    this.name = error.name || 'Error'
+    this.message = `Encountered error ${error.message} in package: "${packageName}"`
+    this.stack = error.stack
+  }
+}
diff --git a/packages/lockfile-lint-api/src/validators/ValidateHost.js b/packages/lockfile-lint-api/src/validators/ValidateHost.js
@@ -1,6 +1,7 @@
 'use strict'
 
 const {URL} = require('url')
+const PackageError = require('../common/PackageError')
 
 const REGISTRY = {
   npm: 'registry.npmjs.org',
@@ -28,7 +29,12 @@ module.exports = class ValidateHost {
     }
 
     for (const [packageName, packageMetadata] of Object.entries(this.packages)) {
-      const packageResolvedURL = new URL(packageMetadata.resolved)
+      let packageResolvedURL = {}
+      try {
+        packageResolvedURL = new URL(packageMetadata.resolved)
+      } catch (error) {
+        throw new PackageError(packageName, error)
+      }
 
       const allowedHosts = hosts.map(hostValue => {
         // eslint-disable-next-line security/detect-object-injection

diff --git a/packages/lockfile-lint-api/src/validators/ValidateHttps.js b/packages/lockfile-lint-api/src/validators/ValidateHttps.js
@@ -1,6 +1,7 @@
 'use strict'
 
 const {URL} = require('url')
+const PackageError = require('../common/PackageError')
 
 const HTTPS_PROTOCOL = 'https:'
 
@@ -20,7 +21,12 @@ module.exports = class ValidateHttps {
     }
 
     for (const [packageName, packageMetadata] of Object.entries(this.packages)) {
-      const packageResolvedURL = new URL(packageMetadata.resolved)
+      let packageResolvedURL = {}
+      try {
+        packageResolvedURL = new URL(packageMetadata.resolved)
+      } catch (error) {
+        throw new PackageError(packageName, error)
+      }
 
       if (packageResolvedURL.protocol !== HTTPS_PROTOCOL) {
         validationResult.errors.push({

diff --git a/packages/lockfile-lint-api/src/validators/ValidateScheme.js b/packages/lockfile-lint-api/src/validators/ValidateScheme.js
@@ -1,6 +1,7 @@
 'use strict'
 
 const {URL} = require('url')
+const PackageError = require('../common/PackageError')
 
 module.exports = class ValidateProtocol {
   constructor ({packages} = {}) {
@@ -22,7 +23,13 @@ module.exports = class ValidateProtocol {
     }
 
     for (const [packageName, packageMetadata] of Object.entries(this.packages)) {
-      const packageResolvedURL = new URL(packageMetadata.resolved)
+      let packageResolvedURL = {}
+      try {
+        packageResolvedURL = new URL(packageMetadata.resolved)
+      } catch (error) {
+        throw new PackageError(packageName, error)
+      }
+
       if (schemes.indexOf(packageResolvedURL.protocol) === -1) {
         // throw new Error(`detected invalid origin for package: ${packageName}`)
         validationResult.errors.push({