feat: dependency detection error reporting

Author: dominykas

README.md

@@ -126,7 +126,16 @@ const result = {
         // will contain a list of unique versions for each dependency found in the dependency tree
         "versions": {
             "dependency-A": ["0.0.10", "1.2.5"],
-            "dependency-B": ["0.5.3", "1.0.0"]
+            "dependency-B": ["0.5.3", "1.0.0"],
+            "dependency-C": ["7.8.9"]
+        },
+        
+        // will contain a list of errors that were encountered while resolving dependency support information
+        "errors": {
+            "dependency-C": {
+                // the `message` will always be either a string or `null`
+                "message": "Failed to download some information or something"
+            }       
         }       
     }
 }

lib/deps.js

@@ -6,6 +6,7 @@ const Path = require('path');
 const Tmp = require('tmp');
 
 const Package = require('./package');
+const Utils = require('./utils');
 
 const internals = {};
 
@@ -106,16 +107,27 @@ exports.detect = async ({ packageJson, loadFile }, options) => {
     const versions = await internals.resolve({ packageJson, lockfile }, options);
 
     const support = [];
+    const errors = {};
+    let hasErrors = false;
 
     for (const packageName of Object.keys(versions).sort()) {
         try {
             const { result } = await Package.detect({ packageName });
             support.push(result);
         }
         catch (err) {
-            console.warn(`Failed to detect support for ${packageName}: ${err && err.message}`);
+            hasErrors = true;
+            errors[packageName] = {
+                message: Utils.getErrorMessage(err)
+            };
         }
     }
 
-    return { support, versions };
+    const result = { support, versions };
+
+    if (hasErrors) {
+        result.errors = errors;
+    }
+
+    return result;
 };

lib/utils.js

@@ -4,5 +4,21 @@ const SimpleGit = require('simple-git/promise');
 
 /* $lab:coverage:off$ */
 // this is wrapped primarily to be able to stub it
-exports.simpleGit = (...args) => SimpleGit(...args);
+exports.simpleGit = (...args) => {
+
+    return SimpleGit(...args);
+};
 /* $lab:coverage:on$ */
+
+exports.getErrorMessage = (error) => {
+
+    if (typeof error === 'string') {
+        return error;
+    }
+
+    if (error && error.message) {
+        return error.message;
+    }
+
+    return null;
+};

test/fixtures/deps-test/packuments/ci-info.json renamed to test/fixtures/packuments/ci-info.json

@@ -948,15 +948,17 @@ describe('detect-node-support', () => {
                     .returns('9cef39d21ad229dea4b10295f55b0d9a83800b23\tHEAD\n');
 
                 Nock('https://registry.npmjs.org')
+                    .persist()
                     .get('/is-ci')
-                    .reply(200, Fs.readFileSync(Path.join(__dirname, 'fixtures', 'deps-test', 'packuments', 'is-ci.json')))
+                    .reply(200, Fs.readFileSync(Path.join(__dirname, 'fixtures', 'packuments', 'is-ci.json')))
                     .get('/ci-info')
-                    .reply(200, Fs.readFileSync(Path.join(__dirname, 'fixtures', 'deps-test', 'packuments', 'ci-info.json')))
+                    .reply(200, Fs.readFileSync(Path.join(__dirname, 'fixtures', 'packuments', 'ci-info.json')))
                     .get('/debug')
-                    .reply(200, Fs.readFileSync(Path.join(__dirname, 'fixtures', 'deps-test', 'packuments', 'debug.json')))
+                    .reply(200, Fs.readFileSync(Path.join(__dirname, 'fixtures', 'packuments', 'debug.json')))
                     .get('/ms')
-                    .reply(200, Fs.readFileSync(Path.join(__dirname, 'fixtures', 'deps-test', 'packuments', 'ms.json')))
-                    .persist();
+                    .reply(200, Fs.readFileSync(Path.join(__dirname, 'fixtures', 'packuments', 'ms.json')))
+                    .get('/rimraf')
+                    .reply(200, Fs.readFileSync(Path.join(__dirname, 'fixtures', 'packuments', 'rimraf.json')));
 
                 Nock('https://raw.githubusercontent.com')
                     .get('/watson/is-ci/HEAD/package.json')
@@ -974,6 +976,8 @@ describe('detect-node-support', () => {
                     .get('/zeit/ms/HEAD/package.json')
                     .reply(200, JSON.stringify({ name: 'ms', version: '2.1.2' }))
                     .get('/zeit/ms/HEAD/.travis.yml')
+                    .reply(404)
+                    .get('/isaacs/rimraf/HEAD/package.json')
                     .reply(404);
             });
 
@@ -1272,6 +1276,52 @@ describe('detect-node-support', () => {
                     }
                 });
             });
+
+            it('rethrows lock file parsing errors', async () => {
+
+                const path = await internals.prepareFixture({
+                    packageJson: JSON.parse(Fs.readFileSync(Path.join(__dirname, 'fixtures', 'deps-test', 'package.json')).toString()),
+                    packageLockJson: 'testing-single-version.yml'
+                });
+
+                await expect(NodeSupport.detect({ path }, { deps: true })).to.reject('Unexpected token l in JSON at position 0');
+            });
+
+            it('handles failures to load packages', async () => {
+
+                Sinon.stub(console, 'warn');
+
+                const path = await internals.prepareFixture({
+                    packageJson: {
+                        name: '@pkgjs/detect-node-support-deps-test',
+                        version: '0.0.0-development',
+                        dependencies: {
+                            rimraf: '1.x'
+                        }
+                    }
+                });
+
+                const result = await NodeSupport.detect({ path }, { deps: true });
+
+                internals.assertCommit(result);
+
+                expect(result).to.equal({
+                    name: '@pkgjs/detect-node-support-deps-test',
+                    version: '0.0.0-development',
+                    timestamp: 1580673602000,
+                    dependencies: {
+                        support: [],
+                        versions: {
+                            rimraf: ['1.0.9']
+                        },
+                        errors: {
+                            rimraf: {
+                                message: 'git://github.com/isaacs/rimraf.git does not contain a package.json'
+                            }
+                        }
+                    }
+                });
+            });
         });
     });
 });

test/fixtures/deps-test/packuments/debug.json renamed to test/fixtures/packuments/debug.json

@@ -0,0 +1,38 @@
+'use strict';
+
+const Utils = require('../lib/utils');
+
+const { describe, it } = exports.lab = require('@hapi/lab').script();
+const { expect } = require('@hapi/code');
+
+describe('Utils', () => {
+
+    describe('getErrorMessage()', () => {
+
+        it('returns error message when present', () => {
+
+            expect(Utils.getErrorMessage(new Error('Test error'))).to.equal('Test error');
+        });
+
+        it('returns the string', () => {
+
+            expect(Utils.getErrorMessage('Test error')).to.equal('Test error');
+        });
+
+        it('null for an object without a message', () => {
+
+            expect(Utils.getErrorMessage({})).to.equal(null);
+        });
+
+        it('null for null', () => {
+
+            expect(Utils.getErrorMessage(null)).to.equal(null);
+        });
+
+
+        it('null for undefined', () => {
+
+            expect(Utils.getErrorMessage()).to.equal(null);
+        });
+    });
+});