fix: avoid throw for invalid cases when not needed

Author: H4ad

benchmarks/bench-inc.js

@@ -0,0 +1,28 @@
+'use strict'
+
+const Benchmark = require('benchmark')
+const invalidVersions = require('../test/fixtures/invalid-versions')
+const inc = require('../functions/inc')
+const validVersions = require('../test/fixtures/valid-versions')
+const suite = new Benchmark.Suite()
+
+const cases = validVersions.map(invalid => invalid[0])
+const invalidCases = invalidVersions.map(invalid => invalid[0])
+
+for (const test of cases) {
+  suite.add(`inc(${test})`, function () {
+    inc(test, 'release')
+  })
+}
+
+for (const test of invalidCases) {
+  suite.add(`invalid inc(${test})`, function () {
+    inc(test, 'release')
+  })
+}
+
+suite
+  .on('cycle', function (event) {
+    console.log(String(event.target))
+  })
+  .run({ async: false })

benchmarks/bench-parse.js

@@ -2,11 +2,12 @@
 
 const Benchmark = require('benchmark')
 const parse = require('../functions/parse')
-const { MAX_SAFE_INTEGER } = require('../internal/constants')
+const validVersions = require('../test/fixtures/valid-versions')
+const invalidVersions = require('../test/fixtures/invalid-versions')
 const suite = new Benchmark.Suite()
 
-const cases = ['1.2.1', '1.2.2-4', '1.2.3-pre']
-const invalidCases = [`${MAX_SAFE_INTEGER}0.0.0`, 'hello, world', 'xyz']
+const cases = validVersions.map(invalid => invalid[0])
+const invalidCases = invalidVersions.map(invalid => invalid[0])
 
 for (const test of cases) {
   suite.add(`parse(${test})`, function () {

benchmarks/bench-valid.js

@@ -0,0 +1,28 @@
+'use strict'
+
+const Benchmark = require('benchmark')
+const invalidVersions = require('../test/fixtures/invalid-versions')
+const valid = require('../functions/valid')
+const validVersions = require('../test/fixtures/valid-versions')
+const suite = new Benchmark.Suite()
+
+const cases = validVersions.map(invalid => invalid[0])
+const invalidCases = invalidVersions.map(invalid => invalid[0])
+
+for (const test of cases) {
+  suite.add(`valid(${test})`, function () {
+    valid(test)
+  })
+}
+
+for (const test of invalidCases) {
+  suite.add(`invalid valid(${test})`, function () {
+    valid(test)
+  })
+}
+
+suite
+  .on('cycle', function (event) {
+    console.log(String(event.target))
+  })
+  .run({ async: false })

classes/semver.js

@@ -6,8 +6,17 @@ const { safeRe: re, t } = require('../internal/re')
 
 const parseOptions = require('../internal/parse-options')
 const { compareIdentifiers } = require('../internal/identifiers')
+
+function handleErrorOnSemver (semver, errorMessage, throwErrors) {
+  if (throwErrors) {
+    throw new TypeError(errorMessage)
+  } else {
+    semver.errorMessage = errorMessage
+  }
+}
+
 class SemVer {
-  constructor (version, options) {
+  constructor (version, options, throwErrors = true) {
     options = parseOptions(options)
 
     if (version instanceof SemVer) {
@@ -18,13 +27,11 @@ class SemVer {
         version = version.version
       }
     } else if (typeof version !== 'string') {
-      throw new TypeError(`Invalid version. Must be a string. Got type "${typeof version}".`)
+      return handleErrorOnSemver(this, `Invalid version. Must be a string. Got type "${typeof version}".`, throwErrors)
     }
 
     if (version.length > MAX_LENGTH) {
-      throw new TypeError(
-        `version is longer than ${MAX_LENGTH} characters`
-      )
+      return handleErrorOnSemver(this, `version is longer than ${MAX_LENGTH} characters`, throwErrors)
     }
 
     debug('SemVer', version, options)
@@ -37,7 +44,7 @@ class SemVer {
     const m = version.trim().match(options.loose ? re[t.LOOSE] : re[t.FULL])
 
     if (!m) {
-      throw new TypeError(`Invalid Version: ${version}`)
+      return handleErrorOnSemver(this, `Invalid Version: ${version}`, throwErrors)
     }
 
     this.raw = version
@@ -48,15 +55,15 @@ class SemVer {
     this.patch = +m[3]
 
     if (this.major > MAX_SAFE_INTEGER || this.major < 0) {
-      throw new TypeError('Invalid major version')
+      return handleErrorOnSemver(this, 'Invalid major version', throwErrors)
     }
 
     if (this.minor > MAX_SAFE_INTEGER || this.minor < 0) {
-      throw new TypeError('Invalid minor version')
+      return handleErrorOnSemver(this, 'Invalid minor version', throwErrors)
     }
 
     if (this.patch > MAX_SAFE_INTEGER || this.patch < 0) {
-      throw new TypeError('Invalid patch version')
+      return handleErrorOnSemver(this, 'Invalid patch version', throwErrors)
     }
 
     // numberify any prerelease numeric ids

functions/inc.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const SemVer = require('../classes/semver')
+const parse = require('./parse')
 
 const inc = (version, release, options, identifier, identifierBase) => {
   if (typeof (options) === 'string') {
@@ -9,11 +10,14 @@ const inc = (version, release, options, identifier, identifierBase) => {
     options = undefined
   }
 
+  const parsed = parse(version instanceof SemVer ? version.version : version, options)
+
+  if (parsed === null) {
+    return null
+  }
+
   try {
-    return new SemVer(
-      version instanceof SemVer ? version.version : version,
-      options
-    ).inc(release, identifier, identifierBase).version
+    return parsed.inc(release, identifier, identifierBase).version
   } catch (er) {
     return null
   }

functions/parse.js

@@ -5,6 +5,7 @@ const parse = (version, options, throwErrors = false) => {
   if (version instanceof SemVer) {
     return version
   }
+
   try {
     return new SemVer(version, options)
   } catch (er) {

test/classes/semver.js

@@ -97,6 +97,19 @@ test('invalid version numbers', (t) => {
   t.end()
 })
 
+test('invalid version numbers without throw', (t) => {
+  ['1.2.3.4', 'NOT VALID', 1.2, null, 'Infinity.NaN.Infinity'].forEach((v) => {
+    const parsed = new SemVer(v, undefined, false)
+
+    t.strictSame(parsed.errorMessage, typeof v === 'string'
+      ? `Invalid Version: ${v}`
+      : `Invalid version. Must be a string. Got type "${typeof v}".`
+    )
+  })
+
+  t.end()
+})
+
 test('incrementing', t => {
   t.plan(increments.length)
   increments.forEach(([

test/functions/inc.js

@@ -8,7 +8,7 @@ const increments = require('../fixtures/increments.js')
 test('increment versions test', (t) => {
   increments.forEach(([pre, what, wanted, options, id, base]) => {
     const found = inc(pre, what, options, id, base)
-    const cmd = `inc(${pre}, ${what}, ${id}, ${base})`
+    const cmd = `inc(${pre}, ${what}, ${options}, ${id}, ${base})`
     t.equal(found, wanted, `${cmd} === ${wanted}`)
 
     const parsed = parse(pre, options)
@@ -45,3 +45,16 @@ test('increment versions test', (t) => {
 
   t.end()
 })
+
+test('special increment version test', (t) => {
+  [
+    ['1.2.3', 'prepatch', '1.2.4-foo.1', 'foo', '1', undefined],
+    ['1.2.3', 'prepatch', '1.2.4-foo.1', {}, 'foo', '1'],
+  ].forEach(([pre, what, wanted, options, id, base]) => {
+    const found = inc(pre, what, options, id, base)
+    const cmd = `inc(${pre}, ${what}, ${options}, ${id}, ${base})`
+    t.equal(found, wanted, `${cmd} === ${wanted}`)
+  })
+
+  t.end()
+})