feat: add option to fetch support information

- add option to fetch support information from
  github repository when requested.

Signed-off-by: Michael Dawson <[email protected]>

Author: mhdawson

index.js

@@ -3,6 +3,7 @@ const path = require('path')
 const fs = require('fs')
 const normalizeUrl = require('normalize-url')
 const Ajv = require('ajv')
+const got = require('got')
 
 let ajv
 let compiledSchema
@@ -59,7 +60,23 @@ module.exports.sanitizePath = (basePath, inputPath, basePathOverride) => {
   return ret
 }
 
-module.exports.getSupportData = (pkg, pkgPath, preferCanonical, basePathOverride) => {
+async function resolveSupportInfo (supportInfo, fetchCanonical) {
+  supportInfo.resolved = false
+  if (fetchCanonical) {
+    const url = normalizeUrl(supportInfo.url
+      .replace('blob', '')
+      .replace('github.com', 'raw.githubusercontent.com'))
+    try {
+      const result = await got(url)
+      supportInfo.contents = result.body
+      supportInfo.resolved = true
+    } catch (e) {
+      supportInfo.error = e
+    }
+  }
+}
+
+module.exports.getSupportData = async (pkg, pkgPath, preferCanonical, basePathOverride, fetchCanonical) => {
   const supportInfo = { contents: 'unknown', url: '', resolved: true }
   if (pkg.support) {
     if ((pkg.support === true) || (typeof pkg.support === 'string')) {
@@ -68,14 +85,15 @@ module.exports.getSupportData = (pkg, pkgPath, preferCanonical, basePathOverride
       const localPath = path.join(pkgPath, supportInfoName)
       if (!preferCanonical && fs.existsSync(localPath)) {
         supportInfo.contents = fs.readFileSync(localPath)
+        supportInfo.resolved = true
       } else {
         supportInfo.url = module.exports.getRemoteSupportInfoUrl(pkg.repository, supportInfoName)
-        supportInfo.resolved = false
+        await resolveSupportInfo(supportInfo, fetchCanonical)
       }
     } else if (typeof pkg.support === 'object') {
       const supportInfoName = pkg.support.path ? pkg.support.path : module.exports.defaultPackageSupport
       supportInfo.url = module.exports.getRemoteSupportInfoUrl(pkg.support.repository, supportInfoName)
-      supportInfo.resolved = false
+      await resolveSupportInfo(supportInfo, fetchCanonical)
     }
   }
   return supportInfo

lib/cli/commands/show.js

@@ -3,13 +3,19 @@ const support = require('../../../index.js')
 
 // print out the information for a module and its
 // children
-function printModule (module, depth, argv) {
+async function printModule (module, depth, argv) {
   const pkg = module.package
   const moduleInfo = `${pkg.name}(${pkg.version})`
 
-  const supportInfo = support.getSupportData(pkg, module.path, argv.canonical, argv['base-path'])
+  const supportInfo = await support.getSupportData(pkg,
+    module.path,
+    argv.canonical,
+    argv['base-path'],
+    argv.fetch)
   if (supportInfo.resolved) {
     console.log(`${' '.repeat(2 * (depth + 1))}${moduleInfo} - ${supportInfo.contents}`)
+  } else if (supportInfo.error) {
+    console.log(`${' '.repeat(2 * (depth + 1))}${moduleInfo} - failed to fetch - ${supportInfo.url}`)
   } else {
     console.log(`${' '.repeat(2 * (depth + 1))}${moduleInfo} - ${supportInfo.url}`)
   }
@@ -31,7 +37,9 @@ module.exports = function (opts) {
       const Arborist = require('@npmcli/arborist')
       const arb = new Arborist()
       arb.loadActual().then(root => {
-        printModule(root, 0, argv)
+        printModule(root, 0, argv).then(() => {}, (e) => {
+          argv.log.error('show failed: ', e)
+        })
       })
     }
   }

lib/cli/commands/validate.js

@@ -25,7 +25,11 @@ module.exports = function (opts) {
 
       let supportData = userPackageJson.support
       if (supportData === true) {
-        supportData = support.getSupportData(userPackageJson, path.join(process.cwd()), argv.canonical, argv['base-path'])
+        supportData = await support.getSupportData(userPackageJson,
+          path.join(process.cwd()),
+          argv.canonical,
+          argv['base-path'],
+          false)
         if (supportData.resolved) {
           const supportDataJSON = JSON.parse(supportData.contents)
           try {

lib/cli/index.js

@@ -61,6 +61,11 @@ module.exports = (options = {}) => {
       type: 'boolean',
       group: 'preferences'
     })
+    .option('fetch', {
+      describe: 'Fetch canonical support info from remote repos when necessary',
+      type: 'boolean',
+      group: 'preferences'
+    })
     .option('base-path', {
       describe: 'Allow use of support info files up to base-path',
       type: 'string',

package.json

@@ -26,7 +26,7 @@
   "dependencies": {
     "@npmcli/arborist": "0.0.0-pre.19",
     "ajv": "^6.11.0",
-    "contains-path": "^1.0.0",
+    "got": "^11.1.3",
     "loggerr": "^3.0.0-0",
     "normalize-url": "^5.0.0",
     "yargs": "^15.0.2"

test/cli/show-separate-repo-fetch-missing/command

@@ -0,0 +1 @@
+show --fetch

test/cli/show-separate-repo-fetch-missing/expected

@@ -0,0 +1 @@
+  @pkgjs/support-separate-repo(0.0.1) - failed to fetch - https://github.com/pkgjs/support/blob/master/examples/does-not-exist.json

test/cli/show-separate-repo-fetch-missing/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@pkgjs/support-separate-repo",
+  "version": "0.0.1",
+  "support": {
+    "path": "./examples/does-not-exist.json",
+    "repository": {
+      "type": "git",
+      "url": "https://github.com/pkgjs/support.git"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pkgjs/support-separate-repo.git"
+  }
+}

test/cli/show-separate-repo-fetch/command

@@ -0,0 +1 @@
+show --fetch

test/cli/show-separate-repo-fetch/expected

@@ -0,0 +1,15 @@
+  @pkgjs/support-separate-repo(0.0.1) - {
+  "versions": [{
+    "version": "*",
+    "target": {
+      "node": "lts"
+    },
+    "response": {
+      "type": "best-effort"
+    },
+    "backing": {
+      "hobby": "https://github.com/pkgjs/support"
+    }
+  }]
+}
+