snyk 1.812.0 → 1.816.0

package/README.md

@@ -168,7 +168,7 @@ snyk --help
 
 See the [full Snyk CLI help](./help/cli-commands).
 
-## Authorization
+## Authenticating Snyk CLI
 
 Snyk CLI depends on [Snyk.io](https://snyk.io) APIs. Connect your Snyk CLI with [Snyk.io](https://snyk.io) by running:
 
@@ -176,6 +176,12 @@ Snyk CLI depends on [Snyk.io](https://snyk.io) APIs. Connect your Snyk CLI with
 snyk auth
 ```
 
+## Setting up language support
+
+Depending on your project's language, you might need to setup your language environment before using Snyk.
+
+See our [Language Support documentation](https://support.snyk.io/hc/en-us/articles/360020352437-Language-support-summary).
+
 ## Scanning your project
 
 If you are already in a folder with a supported project, start by running:

package/dist/cli/293.index.js

@@ -1910,23 +1910,49 @@ function extractReportingDescriptor(results) {
         if (tool[issue.id]) {
             return;
         }
+        // custom rules may not have some of these fields so we check them first
+        const fullDescriptionText = issue.subType
+            ? `${upperFirst(issue.severity)} severity - ${issue.subType}`
+            : `${upperFirst(issue.severity)} severity`;
+        const issueText = issue.iacDescription.issue
+            ? `The issue is... \n${issue.iacDescription.issue}\n\n`
+            : '';
+        const issueMarkdown = issue.iacDescription.issue
+            ? `**The issue is...** \n${issue.iacDescription.issue}\n\n`
+            : '';
+        const impactText = issue.iacDescription.impact
+            ? ` The impact of this is... \n ${issue.iacDescription.impact}\n\n`
+            : '';
+        const impactMarkdown = issue.iacDescription.impact
+            ? ` **The impact of this is...** \n ${issue.iacDescription.impact}\n\n`
+            : '';
+        const resolveText = issue.iacDescription.resolve
+            ? ` You can resolve this by... \n${issue.iacDescription.resolve}`
+            : '';
+        const resolveMarkdown = issue.iacDescription.resolve
+            ? ` **You can resolve this by...** \n${issue.iacDescription.resolve}`
+            : '';
+        const tags = ['security'];
+        if (issue.subType) {
+            tags.push(issue.subType);
+        }
         tool[issue.id] = {
             id: issue.id,
             shortDescription: {
                 text: `${upperFirst(issue.severity)} severity - ${issue.title}`,
             },
             fullDescription: {
-                text: `${upperFirst(issue.severity)} severity - ${issue.subType}`,
+                text: fullDescriptionText,
             },
             help: {
-                text: `The issue is... \n${issue.iacDescription.issue}\n\n The impact of this is... \n ${issue.iacDescription.impact}\n\n You can resolve this by... \n${issue.iacDescription.resolve}`.replace(/^\s+/g, ''),
-                markdown: `**The issue is...** \n${issue.iacDescription.issue}\n\n **The impact of this is...** \n ${issue.iacDescription.impact}\n\n **You can resolve this by...** \n${issue.iacDescription.resolve}`.replace(/^\s+/g, ''),
+                text: `${issueText}${impactText}${resolveText}`.replace(/^\s+/g, ''),
+                markdown: `${issueMarkdown}${impactMarkdown}${resolveMarkdown}`.replace(/^\s+/g, ''),
             },
             defaultConfiguration: {
                 level: getIssueLevel(issue.severity),
             },
             properties: {
-                tags: ['security', `${issue.subType}`],
+                tags,
                 documentation: issue.documentation,
             },
         };
@@ -1937,10 +1963,14 @@ exports.extractReportingDescriptor = extractReportingDescriptor;
 function mapIacTestResponseToSarifResults(issues) {
     return issues.map(({ targetPath, issue }) => {
         const hasLineNumber = issue.lineNumber && issue.lineNumber >= 0;
+        // custom rules may not have some of these fields so we check them first
+        const affectingText = issue.subType
+            ? ` affecting the ${issue.subType}`
+            : '';
         return {
             ruleId: issue.id,
             message: {
-                text: `This line contains a potential ${issue.severity} severity misconfiguration affecting the ${issue.subType}`,
+                text: `This line contains a potential ${issue.severity} severity misconfiguration${affectingText}`,
             },
             locations: [
                 {
@@ -4043,7 +4073,9 @@ exports.getExtraProjectCount = getExtraProjectCount;
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.getMultiPluginResult = void 0;
 const cloneDeep = __webpack_require__(83465);
-const path = __webpack_require__(85622);
+const pathLib = __webpack_require__(85622);
+const sortBy = __webpack_require__(58254);
+const groupBy = __webpack_require__(20276);
 const cliInterface = __webpack_require__(65266);
 const chalk_1 = __webpack_require__(32589);
 const theme_1 = __webpack_require__(86988);
@@ -4053,14 +4085,21 @@ const get_single_plugin_result_1 = __webpack_require__(8598);
 const convert_single_splugin_res_to_multi_custom_1 = __webpack_require__(99695);
 const convert_multi_plugin_res_to_multi_custom_1 = __webpack_require__(23110);
 const errors_1 = __webpack_require__(55191);
+const yarn_workspaces_parser_1 = __webpack_require__(27326);
 const debug = debugModule('snyk-test');
 async function getMultiPluginResult(root, options, targetFiles) {
+    var _a;
     const allResults = [];
     const failedResults = [];
-    for (const targetFile of targetFiles) {
+    // process any yarn workspaces first
+    // the files need to be proceeded together as they provide context to each other
+    const { scannedProjects, unprocessedFiles, } = await processYarnWorkspacesProjects(root, options, targetFiles);
+    allResults.push(...scannedProjects);
+    // process the rest 1 by 1 sent to relevant plugins
+    for (const targetFile of unprocessedFiles) {
         const optionsClone = cloneDeep(options);
-        optionsClone.file = path.relative(root, targetFile);
-        optionsClone.packageManager = detect_1.detectPackageManagerFromFile(path.basename(targetFile));
+        optionsClone.file = pathLib.relative(root, targetFile);
+        optionsClone.packageManager = detect_1.detectPackageManagerFromFile(pathLib.basename(targetFile));
         try {
             const inspectRes = await get_single_plugin_result_1.getSinglePluginResult(root, optionsClone, optionsClone.file);
             let resultWithScannedProjects;
@@ -4077,14 +4116,15 @@ async function getMultiPluginResult(root, options, targetFiles) {
             options.projectNames = resultWithScannedProjects.scannedProjects.map((scannedProject) => { var _a; return (_a = scannedProject === null || scannedProject === void 0 ? void 0 : scannedProject.depTree) === null || _a === void 0 ? void 0 : _a.name; });
             allResults.push(...pluginResultWithCustomScannedProjects.scannedProjects);
         }
-        catch (err) {
+        catch (error) {
+            const errMessage = (_a = error.message) !== null && _a !== void 0 ? _a : 'Something went wrong getting dependencies';
             // TODO: propagate this all the way back and include in --json output
             failedResults.push({
                 targetFile,
-                error: err,
-                errMessage: err.message || 'Something went wrong getting dependencies',
+                error,
+                errMessage: errMessage,
             });
-            debug(chalk_1.default.bold.red(`\n${theme_1.icon.ISSUE} Failed to get dependencies for ${targetFile}\nERROR: ${err.message}\n`));
+            debug(chalk_1.default.bold.red(`\n${theme_1.icon.ISSUE} Failed to get dependencies for ${targetFile}\nERROR: ${errMessage}\n`));
         }
     }
     if (!allResults.length) {
@@ -4099,6 +4139,44 @@ async function getMultiPluginResult(root, options, targetFiles) {
     };
 }
 exports.getMultiPluginResult = getMultiPluginResult;
+async function processYarnWorkspacesProjects(root, options, targetFiles) {
+    try {
+        const { scannedProjects } = await yarn_workspaces_parser_1.processYarnWorkspaces(root, {
+            strictOutOfSync: options.strictOutOfSync,
+            dev: options.dev,
+        }, targetFiles);
+        const unprocessedFiles = filterOutProcessedWorkspaces(scannedProjects, targetFiles);
+        return { scannedProjects, unprocessedFiles };
+    }
+    catch (e) {
+        debug('Error during detecting or processing Yarn Workspaces: ', e);
+        return { scannedProjects: [], unprocessedFiles: targetFiles };
+    }
+}
+function filterOutProcessedWorkspaces(scannedProjects, allTargetFiles) {
+    const mapped = allTargetFiles.map((p) => ({ path: p, ...pathLib.parse(p) }));
+    const sorted = sortBy(mapped, 'dir');
+    const targetFilesByDirectory = groupBy(sorted, 'dir');
+    const scanned = scannedProjects.map((p) => p.targetFile);
+    const targetFiles = [];
+    for (const directory of Object.keys(targetFilesByDirectory)) {
+        for (const targetFile of targetFilesByDirectory[directory]) {
+            const { base, path } = targetFile;
+            // any non yarn workspace files should be scanned
+            if (!['package.json', 'yarn.lock'].includes(base)) {
+                targetFiles.push(path);
+                continue;
+            }
+            // check if Node manifest has already been processed a part or a workspace
+            const packageJsonFileName = pathLib.join(directory, 'package.json');
+            const alreadyScanned = scanned.some((f) => packageJsonFileName.endsWith(f));
+            if (!alreadyScanned) {
+                targetFiles.push(path);
+            }
+        }
+    }
+    return targetFiles;
+}
 
 
 /***/ }),
@@ -4370,25 +4448,24 @@ Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.packageJsonBelongsToWorkspace = exports.getWorkspacesMap = exports.processYarnWorkspaces = void 0;
 const baseDebug = __webpack_require__(15158);
 const pathUtil = __webpack_require__(85622);
-// import * as _ from 'lodash';
 const sortBy = __webpack_require__(58254);
 const groupBy = __webpack_require__(20276);
 const micromatch = __webpack_require__(70850);
 const debug = baseDebug('snyk-yarn-workspaces');
 const lockFileParser = __webpack_require__(423);
-const errors_1 = __webpack_require__(55191);
 const get_file_contents_1 = __webpack_require__(84210);
+const errors_1 = __webpack_require__(55191);
 async function processYarnWorkspaces(root, settings, targetFiles) {
     // the order of yarnTargetFiles folders is important
     // must have the root level most folders at the top
     const mappedAndFiltered = targetFiles
         .map((p) => ({ path: p, ...pathUtil.parse(p) }))
-        .filter((res) => ['package.json'].includes(res.base));
+        .filter((res) => ['package.json', 'yarn.lock'].includes(res.base));
     const sorted = sortBy(mappedAndFiltered, 'dir');
     const grouped = groupBy(sorted, 'dir');
     const yarnTargetFiles = grouped;
     debug(`Processing potential Yarn workspaces (${targetFiles.length})`);
-    if (Object.keys(yarnTargetFiles).length === 0) {
+    if (settings.yarnWorkspaces && Object.keys(yarnTargetFiles).length === 0) {
         throw errors_1.NoSupportedManifestsFoundError([root]);
     }
     let yarnWorkspacesMap = {};
@@ -4403,6 +4480,7 @@ async function processYarnWorkspaces(root, settings, targetFiles) {
     let rootWorkspaceManifestContent = {};
     // the folders must be ordered highest first
     for (const directory of Object.keys(yarnTargetFiles)) {
+        debug(`Processing ${directory} as a potential Yarn workspace`);
         let isYarnWorkspacePackage = false;
         let isRootPackageJson = false;
         const packageJsonFileName = pathUtil.join(directory, 'package.json');
@@ -4425,7 +4503,11 @@ async function processYarnWorkspaces(root, settings, targetFiles) {
                 rootWorkspaceManifestContent = JSON.parse(packageJson.content);
             }
         }
-        if (isYarnWorkspacePackage || isRootPackageJson) {
+        if (!(isYarnWorkspacePackage || isRootPackageJson)) {
+            debug(`${packageJsonFileName} is not part of any detected workspace, skipping`);
+            continue;
+        }
+        try {
             const rootDir = isYarnWorkspacePackage
                 ? pathUtil.dirname(yarnWorkspacesFilesMap[packageJsonFileName].root)
                 : pathUtil.dirname(packageJsonFileName);
@@ -4452,8 +4534,11 @@ async function processYarnWorkspaces(root, settings, targetFiles) {
             };
             result.scannedProjects.push(project);
         }
-        else {
-            debug(`${packageJsonFileName} is not part of any detected workspace, skipping`);
+        catch (e) {
+            if (settings.yarnWorkspaces) {
+                throw e;
+            }
+            debug(`Error process workspace: ${packageJsonFileName}. ERROR: ${e}`);
         }
     }
     if (!result.scannedProjects.length) {
@@ -6536,7 +6621,7 @@ async function assembleLocalPayloads(root, options) {
             }
             debug('getDepsFromPlugin returned failed results, cannot run test/monitor', failedResults);
             if (options['fail-fast']) {
-                throw new errors_1.FailedToRunTestError('Your test request could not be completed. Please email support@snyk.io');
+                throw new errors_1.FailedToRunTestError(errors_1.errorMessageWithRetry('Your test request could not be completed.'));
             }
         }
         analytics.add('pluginName', deps.plugin.name);