node-abi 2.18.0 → 2.19.3

package/.github/workflows/update-abi.yml

@@ -0,0 +1,41 @@
+name: Auto-update ABI JSON file
+on:
+  schedule:
+    - cron: '0 0 * * *'
+jobs:
+  autoupdate:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-node@v1
+      with:
+        node-version: '12.x'
+    - name: Get npm cache directory
+      id: npm-cache
+      run: |
+        echo "::set-output name=dir::$(npm config get cache)"
+    - uses: actions/cache@v1
+      with:
+        path: ${{ steps.npm-cache.outputs.dir }}
+        key: ${{ runner.os }}-node-${{ hashFiles('**/package.json') }}
+        restore-keys: |
+          ${{ runner.os }}-node-
+    - run: npm install --no-package-lock
+    - name: Update ABI registry
+      run: npm run update-abi-registry
+    - name: Commit Changes to ABI registry
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: |
+        echo "machine github.com login $GITHUB_ACTOR password $GITHUB_TOKEN" > ~/.netrc
+        chmod 600 ~/.netrc
+        git add abi_registry.json
+        if test -n "$(git status -s)"; then
+          git config user.name "GitHub Actions"
+          git config user.email "github-actions@users.noreply.github.com"
+          git diff --cached
+          git commit -m "feat: update ABI registry"
+          git push origin HEAD:$GITHUB_REF
+        else
+          echo No update needed
+        fi

package/abi_registry.json

@@ -0,0 +1,99 @@
+[
+  {
+    "runtime": "node",
+    "target": "11.0.0",
+    "lts": false,
+    "future": false,
+    "abi": "67"
+  },
+  {
+    "runtime": "node",
+    "target": "12.0.0",
+    "lts": [
+      "2019-10-21",
+      "2020-11-30"
+    ],
+    "future": false,
+    "abi": "72"
+  },
+  {
+    "runtime": "node",
+    "target": "13.0.0",
+    "lts": false,
+    "future": false,
+    "abi": "79"
+  },
+  {
+    "runtime": "node",
+    "target": "14.0.0",
+    "lts": [
+      "2020-10-27",
+      "2021-10-19"
+    ],
+    "future": false,
+    "abi": "83"
+  },
+  {
+    "runtime": "node",
+    "target": "15.0.0",
+    "lts": false,
+    "future": false,
+    "abi": "88"
+  },
+  {
+    "abi": "70",
+    "future": false,
+    "lts": false,
+    "runtime": "electron",
+    "target": "5.0.0-beta.9"
+  },
+  {
+    "abi": "73",
+    "future": false,
+    "lts": false,
+    "runtime": "electron",
+    "target": "6.0.0-beta.1"
+  },
+  {
+    "abi": "75",
+    "future": false,
+    "lts": false,
+    "runtime": "electron",
+    "target": "7.0.0-beta.1"
+  },
+  {
+    "abi": "76",
+    "future": false,
+    "lts": false,
+    "runtime": "electron",
+    "target": "8.0.0-beta.1"
+  },
+  {
+    "abi": "80",
+    "future": false,
+    "lts": false,
+    "runtime": "electron",
+    "target": "9.0.0-beta.2"
+  },
+  {
+    "abi": "82",
+    "future": false,
+    "lts": false,
+    "runtime": "electron",
+    "target": "10.0.0-beta.1"
+  },
+  {
+    "abi": "85",
+    "future": false,
+    "lts": false,
+    "runtime": "electron",
+    "target": "11.0.0-beta.11"
+  },
+  {
+    "abi": "87",
+    "future": true,
+    "lts": false,
+    "runtime": "electron",
+    "target": "12.0.0-nightly.20201013"
+  }
+]

package/index.js

@@ -43,11 +43,65 @@ function getTarget (abi, runtime) {
     .map(function (t) {
       return t.target
     })
-  if (match.length) return match[0]
+  if (match.length) {
+    var betaSeparatorIndex = match[0].indexOf("-")
+    return betaSeparatorIndex > -1
+      ? match[0].substring(0, betaSeparatorIndex)
+      : match[0]
+  }
 
   throw new Error('Could not detect target for abi ' + abi + ' and runtime ' + runtime)
 }
 
+function sortByTargetFn (a, b) {
+  var abiComp = Number(a.abi) - Number(b.abi)
+  if (abiComp !== 0) return abiComp
+  if (a.target < b.target) return -1
+  if (a.target > b.target) return 1
+  return 0
+}
+
+function loadGeneratedTargets () {
+  var registry = require('./abi_registry.json')
+  var targets = {
+    supported: [],
+    additional: [],
+    future: []
+  }
+
+  registry.forEach(function (item) {
+    var target = {
+      runtime: item.runtime,
+      target: item.target,
+      abi: item.abi
+    }
+    if (item.lts) {
+      var startDate = new Date(Date.parse(item.lts[0]))
+      var endDate = new Date(Date.parse(item.lts[1]))
+      var currentDate = new Date()
+      target.lts = startDate < currentDate && currentDate < endDate
+    } else {
+      target.lts = false
+    }
+
+    if (target.runtime === 'node-webkit') {
+      targets.additional.push(target)
+    } else if (item.future) {
+      targets.future.push(target)
+    } else {
+      targets.supported.push(target)
+    }
+  })
+
+  targets.supported.sort(sortByTargetFn)
+  targets.additional.sort(sortByTargetFn)
+  targets.future.sort(sortByTargetFn)
+
+  return targets
+}
+
+var generatedTargets = loadGeneratedTargets()
+
 var supportedTargets = [
   {runtime: 'node', target: '5.0.0', abi: '47', lts: false},
   {runtime: 'node', target: '6.0.0', abi: '48', lts: false},
@@ -55,10 +109,6 @@ var supportedTargets = [
   {runtime: 'node', target: '8.0.0', abi: '57', lts: false},
   {runtime: 'node', target: '9.0.0', abi: '59', lts: false},
   {runtime: 'node', target: '10.0.0', abi: '64', lts: new Date(2018, 10, 1) < new Date() && new Date() < new Date(2020, 4, 31)},
-  {runtime: 'node', target: '11.0.0', abi: '67', lts: false},
-  {runtime: 'node', target: '12.0.0', abi: '72', lts: new Date(2019, 9, 21) < new Date() && new Date() < new Date(2020, 9, 31)},
-  {runtime: 'node', target: '13.0.0', abi: '79', lts: false},
-  {runtime: 'node', target: '14.0.0', abi: '83', lts: false},
   {runtime: 'electron', target: '0.36.0', abi: '47', lts: false},
   {runtime: 'electron', target: '1.1.0', abi: '48', lts: false},
   {runtime: 'electron', target: '1.3.0', abi: '49', lts: false},
@@ -70,14 +120,11 @@ var supportedTargets = [
   {runtime: 'electron', target: '2.0.0', abi: '57', lts: false},
   {runtime: 'electron', target: '3.0.0', abi: '64', lts: false},
   {runtime: 'electron', target: '4.0.0', abi: '64', lts: false},
-  {runtime: 'electron', target: '4.0.4', abi: '69', lts: false},
-  {runtime: 'electron', target: '5.0.0', abi: '70', lts: false},
-  {runtime: 'electron', target: '6.0.0', abi: '73', lts: false},
-  {runtime: 'electron', target: '7.0.0', abi: '75', lts: false},
-  {runtime: 'electron', target: '8.0.0', abi: '76', lts: false},
-  {runtime: 'electron', target: '9.0.0', abi: '80', lts: false}
+  {runtime: 'electron', target: '4.0.4', abi: '69', lts: false}
 ]
 
+supportedTargets.push.apply(supportedTargets, generatedTargets.supported)
+
 var additionalTargets = [
   {runtime: 'node-webkit', target: '0.13.0', abi: '47', lts: false},
   {runtime: 'node-webkit', target: '0.15.0', abi: '48', lts: false},
@@ -86,6 +133,8 @@ var additionalTargets = [
   {runtime: 'node-webkit', target: '0.26.5', abi: '59', lts: false}
 ]
 
+additionalTargets.push.apply(additionalTargets, generatedTargets.additional)
+
 var deprecatedTargets = [
   {runtime: 'node', target: '0.2.0', abi: '1', lts: false},
   {runtime: 'node', target: '0.9.1', abi: '0x000A', lts: false},
@@ -104,9 +153,7 @@ var deprecatedTargets = [
   {runtime: 'electron', target: '0.33.0', abi: '46', lts: false}
 ]
 
-var futureTargets = [
-  {runtime: 'electron', target: '10.0.0-beta.1', abi: '82', lts: false}
-]
+var futureTargets = generatedTargets.future
 
 var allTargets = deprecatedTargets
   .concat(supportedTargets)

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "node-abi",
-  "version": "2.18.0",
+  "version": "2.19.3",
   "description": "Get the Node ABI for a given target and runtime, and vice versa.",
   "main": "index.js",
   "scripts": {
-    "test": "tape test/index.js",
     "semantic-release": "semantic-release",
-    "travis-deploy-once": "travis-deploy-once"
+    "test": "tape test/index.js",
+    "travis-deploy-once": "travis-deploy-once",
+    "update-abi-registry": "node --unhandled-rejections=strict scripts/update-abi-registry.js"
   },
   "repository": {
     "type": "git",
@@ -26,6 +27,7 @@
   },
   "homepage": "https://github.com/lgeiger/node-abi#readme",
   "devDependencies": {
+    "got": "^10.6.0",
     "semantic-release": "^15.8.0",
     "tape": "^4.6.3",
     "travis-deploy-once": "^5.0.1"

package/scripts/update-abi-registry.js

@@ -0,0 +1,113 @@
+const got = require('got')
+const path = require('path')
+const semver = require('semver')
+const { writeFile } = require('fs').promises
+
+async function getJSONFromCDN (urlPath) {
+  const response = await got(`https://cdn.jsdelivr.net/gh/${urlPath}`)
+  return JSON.parse(response.body)
+}
+
+async function fetchElectronReleases () {
+  return (await getJSONFromCDN('electron/releases/lite.json'))
+}
+
+async function fetchNodeVersions () {
+  const schedule = await getJSONFromCDN('nodejs/Release/schedule.json')
+  const versions = {}
+
+  for (const [majorVersion, metadata] of Object.entries(schedule)) {
+    if (majorVersion.startsWith('v0')) {
+      continue
+    }
+    const version = `${majorVersion.slice(1)}.0.0`
+    const lts = metadata.hasOwnProperty('lts') ? [metadata.lts, metadata.maintenance] : false
+    versions[version] = {
+      runtime: 'node',
+      target: version,
+      lts: lts,
+      future: new Date(Date.parse(metadata.start)) > new Date()
+    }
+  }
+
+  return versions
+}
+
+async function fetchAbiVersions () {
+  return (await getJSONFromCDN('nodejs/node/doc/abi_version_registry.json'))
+    .NODE_MODULE_VERSION
+    .filter(({ modules }) => modules > 66)
+}
+
+function electronReleasesToTargets (releases) {
+  const versions = releases.map(({ version }) => version)
+  const versionsByModules = releases
+    .filter(release => release.deps && Number(release.deps.modules) >= 70)
+    .map(({ version, deps: { modules } }) => ({
+      version,
+      modules,
+    }))
+    .reduce(
+      (acc, { modules, version }) => ({
+        ...acc,
+        [modules]: version,
+      }),
+      {}
+    )
+
+    return Object.entries(versionsByModules)
+      .map(
+        ([modules, version]) => ({
+          abi: modules,
+          future: !versions.find(
+            v => {
+              const major = version.split(".")[0]
+              return semver.satisfies(
+                v,
+                /^[0-9]/.test(major) ? `>= ${major}` : major
+              )
+            }
+          ),
+          lts: false,
+          runtime: 'electron',
+          target: version
+        })
+      )
+}
+
+function nodeVersionsToTargets (abiVersions, nodeVersions) {
+  return Object.values(
+    abiVersions
+      .filter(({ runtime }) => runtime === 'node')
+      .reduce(
+        (acc, abiVersion) => {
+          const { version: nodeVersion } = semver.coerce(abiVersion.versions)
+
+          return {
+            [nodeVersion]: {
+              ...nodeVersions[nodeVersion],
+              abi: abiVersion.modules.toString(),
+            },
+            ...acc,
+          };
+        },
+        {}
+      )
+  )
+}
+
+async function main () {
+  const nodeVersions = await fetchNodeVersions()
+  const abiVersions = await fetchAbiVersions()
+  const electronReleases = await fetchElectronReleases()
+  const electronTargets = electronReleasesToTargets(electronReleases)
+  const nodeTargets = nodeVersionsToTargets(abiVersions, nodeVersions)
+  const supportedTargets = [
+    ...nodeTargets,
+    ...electronTargets,
+  ]
+
+  await writeFile(path.resolve(__dirname, '..', 'abi_registry.json'), JSON.stringify(supportedTargets, null, 2))
+}
+
+main()

package/test/index.js

@@ -5,7 +5,7 @@ var getTarget = require('../index').getTarget
 var getNextTarget = require('../index')._getNextTarget
 var allTargets = require('../index').allTargets
 
-test('getNextTarget gets the next unsopported target', function (t) {
+test('getNextTarget gets the next unsupported target', function (t) {
   var mockTargets = [
     {runtime: 'node', target: '7.0.0', abi: '51', lts: false},
     {runtime: 'node', target: '8.0.0', abi: '57', lts: false},
@@ -26,6 +26,10 @@ test('getTarget calculates correct Node target', function (t) {
   t.equal(getTarget('47'), '5.0.0')
   t.equal(getTarget('48'), '6.0.0')
   t.equal(getTarget('51'), '7.0.0')
+  t.equal(getTarget('67'), '11.0.0')
+  t.equal(getTarget('72'), '12.0.0')
+  t.equal(getTarget('83'), '14.0.0')
+  t.equal(getTarget('88'), '15.0.0')
   t.end()
 })
 
@@ -35,6 +39,8 @@ test('getTarget calculates correct Electron target', function (t) {
   t.equal(getTarget('48', 'electron'), '1.1.0')
   t.equal(getTarget('49', 'electron'), '1.3.0')
   t.equal(getTarget('50', 'electron'), '1.4.0')
+  t.equal(getTarget('76', 'electron'), '8.0.0')
+  t.equal(getTarget('82', 'electron'), '10.0.0')
   t.end()
 })
 
@@ -53,6 +59,11 @@ test('getAbi calculates correct Node ABI', function (t) {
   t.equal(getAbi(null), process.versions.modules)
   t.throws(function () { getAbi('a.b.c') })
   t.throws(function () { getAbi(getNextTarget('node')) })
+  t.equal(getAbi('15.0.0'), '88')
+  t.equal(getAbi('14.0.0'), '83')
+  t.equal(getAbi('13.0.0'), '79')
+  t.equal(getAbi('12.0.0'), '72')
+  t.equal(getAbi('11.0.0'), '67')
   t.equal(getAbi('7.2.0'), '51')
   t.equal(getAbi('7.0.0'), '51')
   t.equal(getAbi('6.9.9'), '48')
@@ -89,6 +100,7 @@ test('getAbi calculates correct Electron ABI', function (t) {
   t.throws(function () { getAbi(undefined, 'electron') })
   t.throws(function () { getAbi(getNextTarget('electron'), 'electron') })
   t.equal(getAbi('10.0.0-beta.1', 'electron'), '82')
+  t.equal(getAbi('10.0.0', 'electron'), '82')
   t.equal(getAbi('9.0.0', 'electron'), '80')
   t.equal(getAbi('8.0.0', 'electron'), '76')
   t.equal(getAbi('7.0.0', 'electron'), '75')
@@ -155,8 +167,8 @@ test('allTargets are sorted', function (t) {
     return semver.compare(t1.target, t2.target)
   }
 
-  t.deepEqual(electron, electron.slice().sort(sort))
-  t.deepEqual(node, node.slice().sort(sort))
-  t.deepEqual(nodeWebkit, nodeWebkit.slice().sort(sort))
+  t.deepEqual(electron, electron.slice().sort(sort), 'electron targets are sorted')
+  t.deepEqual(node, node.slice().sort(sort), 'node targets are sorted')
+  t.deepEqual(nodeWebkit, nodeWebkit.slice().sort(sort), 'node-webkit targets are sorted')
   t.end()
 })