deps: add [email protected]

Author: wraithgar

lib/index.js

@@ -1,15 +1,81 @@
-const semver = require('semver')
+const process = require('node:process')
+const satisfies = require('semver/functions/satisfies')
+const validRange = require('semver/ranges/valid')
 
-const checkEngine = (target, npmVer, nodeVer, force = false) => {
+/*
+
+interface DevEngines {
+  cpu?: DevEngineDependency | DevEngineDependency[];
+  libc?: DevEngineDependency | DevEngineDependency[];
+  os?: DevEngineDependency | DevEngineDependency[];
+  packageManager?: DevEngineDependency | DevEngineDependency[];
+  runtime?: DevEngineDependency | DevEngineDependency[];
+}
+
+interface DevEngineDependency {
+  name: string;
+  version?: string;
+  onFail?: 'ignore' | 'warn' | 'error' | 'download';
+  download?: {
+    url: string;
+    algorithm?: string;
+    digest?: string;
+  }
+}
+
+*/
+
+const envNames = ['packageManager', 'runtime', 'cpu', 'libc', 'os']
+
+// Returns an object with the last failing entry of any given wanted entry, null if no failures
+function checkDev (wanted = {}, current = {}, opts = {}) {
+  const failures = {}
+  for (const env of envNames) {
+    let wantedEnv = wanted[env]
+    if (wantedEnv) {
+      const currentEnv = current[env]
+      if (!Array.isArray(wantedEnv)) {
+        wantedEnv = [wantedEnv]
+      }
+      // In case of failure we return the last entry to fail so we walk backwards and return the first failure
+      for (let i = wantedEnv.length - 1; i > -1; i--) {
+        const w = wantedEnv[i]
+        if (!currentEnv) {
+          failures[env] = w
+          break
+        }
+        if (w.name !== currentEnv.name) {
+          failures[env] = w
+          break
+        }
+        if (validRange(w.version)) {
+          if (!satisfies(currentEnv.version, w.version, opts.semver)) {
+            failures[env] = w
+            break
+          }
+        } else if (currentEnv.version !== w.version) {
+          failures[env] = w
+          break
+        }
+      }
+    }
+  }
+  if (Object.keys(failures).length) {
+    return failures
+  }
+  return null
+}
+
+function checkEngine (target, npmVer, nodeVer, force = false) {
   const nodev = force ? null : nodeVer
   const eng = target.engines
   const opt = { includePrerelease: true }
   if (!eng) {
     return
   }
 
-  const nodeFail = nodev && eng.node && !semver.satisfies(nodev, eng.node, opt)
-  const npmFail = npmVer && eng.npm && !semver.satisfies(npmVer, eng.npm, opt)
+  const nodeFail = nodev && eng.node && !satisfies(nodev, eng.node, opt)
+  const npmFail = npmVer && eng.npm && !satisfies(npmVer, eng.npm, opt)
   if (nodeFail || npmFail) {
     throw Object.assign(new Error('Unsupported engine'), {
       pkgid: target._id,
@@ -20,9 +86,11 @@ const checkEngine = (target, npmVer, nodeVer, force = false) => {
   }
 }
 
-const isMusl = (file) => file.includes('libc.musl-') || file.includes('ld-musl-')
+function isMusl (file) {
+  return file.includes('libc.musl-') || file.includes('ld-musl-')
+}
 
-const checkPlatform = (target, force = false, environment = {}) => {
+function checkPlatform (target, force = false, environment = {}) {
   if (force) {
     return
   }
@@ -69,7 +137,7 @@ const checkPlatform = (target, force = false, environment = {}) => {
   }
 }
 
-const checkList = (value, list) => {
+function checkList (value, list) {
   if (typeof list === 'string') {
     list = [list]
   }
@@ -96,6 +164,10 @@ const checkList = (value, list) => {
 }
 
 module.exports = {
+  // Used by npm-pick-manifest, "npm install -g npm", and arborist build-ideal-tree/reify
   checkEngine,
+  // used by arborist build-ideal-tree/reify
   checkPlatform,
+  // used by npm install for devEngines
+  checkDev,
 }

package.json

@@ -13,6 +13,7 @@
   },
   "type": "commonjs",
   "dependencies": {
+    "proc-log": "^4.2.0",
     "semver": "^7.1.1"
   },
   "devDependencies": {

test/check-dev.js

@@ -0,0 +1,50 @@
+const t = require('tap')
+const { checkDev } = require('..')
+
+t.test('empty params', async t => {
+  t.equal(checkDev(), null)
+})
+
+t.test('tests all the right fields', async t => {
+  for (const env of ['packageManager', 'runtime', 'cpu', 'libc', 'os']) {
+    t.test(`field - ${env}`, async t => {
+      t.test('current name does not match, wanted has extra attribute', async t => {
+        const wanted = { name: `test-${env}-wanted`, extra: `test-${env}-extra` }
+        const current = { name: `test-${env}-current` }
+        t.same(checkDev({ [env]: wanted }, { [env]: current }), { [env]: wanted })
+      })
+      t.test('current is not given', async t => {
+        const wanted = { name: `test-${env}-wanted` }
+        t.same(checkDev({ [env]: wanted }), { [env]: wanted })
+      })
+      t.test('non-semver version is not the same', async t => {
+        const wanted = { name: `test-name`, version: 'test-version-wanted' }
+        const current = { name: `test-name`, version: 'test-version-current' }
+        t.same(checkDev({ [env]: wanted }, { [env]: current }), { [env]: wanted })
+      })
+      t.test('non-semver version is the same', async t => {
+        const wanted = { name: `test-name`, version: 'test-version' }
+        const current = { name: `test-name`, version: 'test-version' }
+        t.same(checkDev({ [env]: wanted }, { [env]: current }), null)
+      })
+      t.test('semver version is not in range', async t => {
+        const wanted = { name: `test-name`, version: '^1.0.0' }
+        const current = { name: `test-name`, version: '2.0.0' }
+        t.same(checkDev({ [env]: wanted }, { [env]: current }), { [env]: wanted })
+      })
+      t.test('semver version is in range', async t => {
+        const wanted = { name: `test-name`, version: '^1.0.0' }
+        const current = { name: `test-name`, version: '1.0.0' }
+        t.same(checkDev({ [env]: wanted }, { [env]: current }), null)
+      })
+      t.test('returns the last failure', async t => {
+        const wanted = [
+          { name: `test-name`, version: 'test-version-one' },
+          { name: `test-name`, version: 'test-version-two' },
+        ]
+        const current = { name: `test-name`, version: 'test-version-three' }
+        t.same(checkDev({ [env]: wanted }, { [env]: current }), { [env]: wanted[1] })
+      })
+    })
+  }
+})