fix: Not failing when cannot extract package from hintpath. Skipping and logging

Author: eavichay

lib/index.js

@@ -5,6 +5,7 @@ var Dependecy = require('./dependency');
 var findFolder = require('./find-folder');
 var path = require('path');
 var parseNuspec = require('./nuspec-parser');
+var debug = require('debug')('snyk');
 
 function determineManifestType (filename) {
   switch (true) {
@@ -65,6 +66,7 @@ module.exports = {
       var installedPackages = [];
       switch (manifestType) {
         case 'project.json': {
+          debug('Trying to parse project.json manifest');
           var rawDependencies = JSON.parse(fileContent).dependencies;
           if (rawDependencies) {
             for (var name in rawDependencies) {
@@ -80,6 +82,7 @@ module.exports = {
           break;
         }
         case 'packages.config': {
+          debug('Trying to parse packages.config manifest');
           parseXML(fileContent, function scanPackagesConfig(err, result) {
             if (err) {
               reject(err);
@@ -99,17 +102,24 @@ module.exports = {
           break;
         }
         case '.csproj': {
+          debug('Trying to parse .csproj manifest');
           parseXML(fileContent, function scanCsprojContent(err, result) {
             if (err) {
               reject(err);
             } else {
               (result.Project.ItemGroup || []).forEach(function (itemGroup) {
                 (itemGroup.Reference || []).forEach(function (referenceItem) {
                   if (referenceItem.HintPath) {
-                    var installedDependency =
-                      Dependecy.from.csprojEntry(referenceItem);
-                    if (installedDependency.name.indexOf('System.') !== 0) {
-                      installedPackages.push(installedDependency);
+                    try {
+                      var installedDependency =
+                        Dependecy.from.csprojEntry(referenceItem);
+                      if (installedDependency.name.indexOf('System.') !== 0) {
+                        installedPackages.push(installedDependency);
+                      }
+                    }
+                    catch (err) {
+                      debug('Could not parse package name. Skipping');
+                      // gracefully continue
                     }
                   }
                 });
@@ -121,6 +131,7 @@ module.exports = {
         }
       }
     }).then(function scanInstalled(installedPackages) {
+      debug('Located ' + installedPackages.length + ' packages in manifest');
       function injectPath(dep) {
         dep.path = path.resolve(
           packagesFolder,
@@ -130,8 +141,10 @@ module.exports = {
       installedPackages.forEach(function (entry) {
         injectPath(entry);
         flattendPackageList[entry.name] = entry;
+        debug('Entry: ' + entry.name + ' -> ' + entry.path);
       });
       try {
+        debug('Trying to read installed packaged folder: ' + packagesFolder);
         fs.readdirSync(packagesFolder)
         .filter(function (name) {
           return name.slice(0, 7).toLowerCase() !== 'system.'
@@ -144,6 +157,8 @@ module.exports = {
           flattendPackageList[dep.name] = flattendPackageList[dep.name] || dep;
         });
       } catch (error) {
+        debug('Could not complete installed packages folder scanning');
+        debug(error);
         // could not read installed packages folder,
         // continue only with manifest list
       }
@@ -154,20 +169,24 @@ module.exports = {
       flattendPackageList = sorted;
     }).then(function fetchNugetInformationFromPackages() {
       // initiate collecting information from .nuget files on installed packages
+      debug('Trying to analyze .nuspec files');
       var nuspecParserChain = [];
       for (var name in flattendPackageList) {
         var dep = flattendPackageList[name];
+        debug('...' + name);
         nuspecParserChain.push(parseNuspec(dep));
       }
       return Promise.all(nuspecParserChain);
     }).then(function processNugetInformation(nuspecResolutionChain) {
       nuspecResolutionChain.forEach(function (resolution) {
         if (!resolution) return; // jscs:ignore
+        debug('.nuspec analyzed for ' + resolution.name);
         nuspecResolutions[resolution.name] = resolution;
       });
     }).then(function buildDependencyTree() {
       // .nuget parsing is complete, returned as array of promise resolutions
       // now the flat list should be rebuilt as a tree
+      debug('Building dependency tree');
       function buildTree(node, requiredChildren, repository) {
         var resolutionName = node.name + '@' + node.version;
         node.from = node.from.concat(resolutionName);

package.json

@@ -25,6 +25,7 @@
   },
   "homepage": "https://github.com/snyk/snyk-nuget-plugin#readme",
   "dependencies": {
+    "debug": "^3.1.0",
     "es6-promise": "^4.1.1",
     "xml2js": "^0.4.17",
     "zip": "^1.2.0"

test/stubs/dummy_project_1/dummy_project_1/WebApplication1.csproj

@@ -46,6 +46,10 @@
     <WarningLevel>4</WarningLevel>
   </PropertyGroup>
   <ItemGroup>
+    <Reference Include="Invalid.Package">
+      <Private>True</Private>
+      <HintPath>..\someInvalidFolder\Invalid.Package\Package.dll</HintPath>
+    </Reference>
     <Reference Include="Antlr3.Runtime">
       <Private>True</Private>
       <HintPath>..\packages\Antlr.3.4.1.9004\lib\Antlr3.Runtime.dll</HintPath>