snyk 1.1245.0 → 1.1246.0

package/dist/cli/245.index.js

@@ -11391,7 +11391,7 @@ exports.readJSON = readJSON;
 "use strict";
 
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.DEFAULT_ERROR_MESSAGES = exports.NETWORK_ERRORS = exports.ErrorCodes = exports.DCIGNORE_DRAFTS = exports.IGNORE_FILES_NAMES = exports.IGNORES_DEFAULT = exports.REQUEST_RETRY_DELAY = exports.MAX_RETRY_ATTEMPTS = exports.POLLING_INTERVAL = exports.UPLOAD_CONCURRENCY = exports.MAX_UPLOAD_ATTEMPTS = exports.CACHE_KEY = exports.EXCLUDED_NAMES = exports.DOTSNYK_FILENAME = exports.DCIGNORE_FILENAME = exports.GITIGNORE_FILENAME = exports.GIT_FILENAME = exports.ENCODE_TYPE = exports.HASH_ALGORITHM = exports.MAX_FILE_SIZE = exports.MAX_PAYLOAD = void 0;
+exports.DEFAULT_ERROR_MESSAGES = exports.NETWORK_ERRORS = exports.ErrorCodes = exports.DCIGNORE_DRAFTS = exports.IGNORE_FILES_NAMES = exports.IGNORES_DEFAULT = exports.ORG_ID_REGEXP = exports.REQUEST_RETRY_DELAY = exports.MAX_RETRY_ATTEMPTS = exports.POLLING_INTERVAL = exports.UPLOAD_CONCURRENCY = exports.MAX_UPLOAD_ATTEMPTS = exports.CACHE_KEY = exports.EXCLUDED_NAMES = exports.DOTSNYK_FILENAME = exports.DCIGNORE_FILENAME = exports.GITIGNORE_FILENAME = exports.GIT_FILENAME = exports.ENCODE_TYPE = exports.HASH_ALGORITHM = exports.MAX_FILE_SIZE = exports.MAX_PAYLOAD = void 0;
 const dcignore_1 = __webpack_require__(55086);
 exports.MAX_PAYLOAD = 4 * 1024 * 1024;
 exports.MAX_FILE_SIZE = 1024 * 1024;
@@ -11408,6 +11408,7 @@ exports.UPLOAD_CONCURRENCY = 2;
 exports.POLLING_INTERVAL = 500;
 exports.MAX_RETRY_ATTEMPTS = 10; // Request retries on network errors
 exports.REQUEST_RETRY_DELAY = 5 * 1000; // delay between retries in milliseconds
+exports.ORG_ID_REGEXP = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/;
 exports.IGNORES_DEFAULT = [`**/${exports.GIT_FILENAME}/**`];
 exports.IGNORE_FILES_NAMES = [exports.GITIGNORE_FILENAME, exports.DCIGNORE_FILENAME, exports.DOTSNYK_FILENAME];
 exports.DCIGNORE_DRAFTS = {
@@ -12014,17 +12015,17 @@ const httpUtils_1 = __webpack_require__(11294);
 // The trick to typecast union type alias
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function isSubsetErrorCode(code, messages) {
-    if (code in messages) {
-        return true;
-    }
-    return false;
+    return code in messages;
 }
-function generateError(errorCode, messages, apiName, error) {
+function generateError(errorCode, messages, apiName, errorMessage, jsonApiError) {
+    if (jsonApiError) {
+        return httpUtils_1.generateErrorWithDetail(jsonApiError, errorCode, apiName);
+    }
     if (!isSubsetErrorCode(errorCode, messages)) {
-        throw { errorCode, messages, apiName };
+        throw { statusCode: errorCode, statusText: errorMessage || 'unknown error occurred', apiName };
     }
     const statusCode = errorCode;
-    const statusText = error !== null && error !== void 0 ? error : messages[errorCode];
+    const statusText = errorMessage !== null && errorMessage !== void 0 ? errorMessage : messages[errorCode];
     return {
         type: 'error',
         error: {
@@ -12045,8 +12046,7 @@ const GENERIC_ERROR_MESSAGES = {
 async function compressAndEncode(payload) {
     // encode payload and compress;
     const deflate = util_1.promisify(zlib_1.gzip);
-    const compressedPayload = await deflate(Buffer.from(JSON.stringify(payload)).toString('base64'));
-    return compressedPayload;
+    return await deflate(Buffer.from(JSON.stringify(payload)).toString('base64'));
 }
 exports.compressAndEncode = compressAndEncode;
 function startSession(options) {
@@ -12123,7 +12123,7 @@ async function getFilters(baseURL, source, attempts = constants_1.MAX_RETRY_ATTE
     if (res.success) {
         return { type: 'success', value: res.body };
     }
-    return generateError(res.errorCode, GENERIC_ERROR_MESSAGES, apiName);
+    return generateError(res.errorCode, GENERIC_ERROR_MESSAGES, apiName, undefined, res.jsonApiError);
 }
 exports.getFilters = getFilters;
 function commonHttpHeaders(options) {
@@ -12167,7 +12167,7 @@ async function createBundle(options) {
     if (res.success) {
         return { type: 'success', value: res.body };
     }
-    return generateError(res.errorCode, CREATE_BUNDLE_ERROR_MESSAGES, 'createBundle');
+    return generateError(res.errorCode, CREATE_BUNDLE_ERROR_MESSAGES, 'createBundle', undefined, res.jsonApiError);
 }
 exports.createBundle = createBundle;
 const CHECK_BUNDLE_ERROR_MESSAGES = {
@@ -12193,7 +12193,7 @@ async function checkBundle(options) {
     });
     if (res.success)
         return { type: 'success', value: res.body };
-    return generateError(res.errorCode, CHECK_BUNDLE_ERROR_MESSAGES, 'checkBundle');
+    return generateError(res.errorCode, CHECK_BUNDLE_ERROR_MESSAGES, 'checkBundle', undefined, res.jsonApiError);
 }
 exports.checkBundle = checkBundle;
 const EXTEND_BUNDLE_ERROR_MESSAGES = {
@@ -12226,7 +12226,7 @@ async function extendBundle(options) {
     });
     if (res.success)
         return { type: 'success', value: res.body };
-    return generateError(res.errorCode, EXTEND_BUNDLE_ERROR_MESSAGES, 'extendBundle');
+    return generateError(res.errorCode, EXTEND_BUNDLE_ERROR_MESSAGES, 'extendBundle', undefined, res.jsonApiError);
 }
 exports.extendBundle = extendBundle;
 // eslint-disable-next-line no-shadow
@@ -12272,9 +12272,10 @@ async function getAnalysis(options) {
         },
     };
     const res = await needle_1.makeRequest(config);
-    if (res.success)
+    if (res.success) {
         return { type: 'success', value: res.body };
-    return generateError(res.errorCode, GET_ANALYSIS_ERROR_MESSAGES, 'getAnalysis');
+    }
+    return generateError(res.errorCode, GET_ANALYSIS_ERROR_MESSAGES, 'getAnalysis', undefined, res.jsonApiError);
 }
 exports.getAnalysis = getAnalysis;
 const REPORT_ERROR_MESSAGES = {
@@ -12321,7 +12322,7 @@ async function initReport(options) {
     const res = await needle_1.makeRequest(config);
     if (res.success)
         return { type: 'success', value: res.body.reportId };
-    return generateError(res.errorCode, REPORT_ERROR_MESSAGES, 'initReport');
+    return generateError(res.errorCode, REPORT_ERROR_MESSAGES, 'initReport', undefined, res.jsonApiError);
 }
 exports.initReport = initReport;
 /**
@@ -12346,7 +12347,7 @@ async function getReport(options) {
     const res = await needle_1.makeRequest(config);
     if (res.success)
         return { type: 'success', value: res.body };
-    return generateError(res.errorCode, REPORT_ERROR_MESSAGES, 'getReport', (_a = res.error) === null || _a === void 0 ? void 0 : _a.message);
+    return generateError(res.errorCode, REPORT_ERROR_MESSAGES, 'getReport', (_a = res.error) === null || _a === void 0 ? void 0 : _a.message, res.jsonApiError);
 }
 exports.getReport = getReport;
 /**
@@ -12377,7 +12378,7 @@ async function initScmReport(options) {
     const res = await needle_1.makeRequest(config);
     if (res.success)
         return { type: 'success', value: res.body.testId };
-    return generateError(res.errorCode, REPORT_ERROR_MESSAGES, 'initReport');
+    return generateError(res.errorCode, REPORT_ERROR_MESSAGES, 'initReport', undefined, res.jsonApiError);
 }
 exports.initScmReport = initScmReport;
 /**
@@ -12402,7 +12403,7 @@ async function getScmReport(options) {
     const res = await needle_1.makeRequest(config);
     if (res.success)
         return { type: 'success', value: res.body };
-    return generateError(res.errorCode, REPORT_ERROR_MESSAGES, 'getReport', (_a = res.error) === null || _a === void 0 ? void 0 : _a.message);
+    return generateError(res.errorCode, REPORT_ERROR_MESSAGES, 'getReport', (_a = res.error) === null || _a === void 0 ? void 0 : _a.message, res.jsonApiError);
 }
 exports.getScmReport = getScmReport;
 //# sourceMappingURL=http.js.map
@@ -12517,6 +12518,7 @@ const https_1 = __importDefault(__webpack_require__(95687));
 const url_1 = __webpack_require__(57310);
 const emitter_1 = __webpack_require__(37544);
 const constants_1 = __webpack_require__(65765);
+const httpUtils_1 = __webpack_require__(11294);
 const sleep = (duration) => new Promise(resolve => setTimeout(resolve, duration));
 const TIMEOUT_DEFAULT = 600000;
 const agentOptions = {
@@ -12529,7 +12531,7 @@ const agentOptions = {
     rejectUnauthorized: !global.ignoreUnknownCA,
 };
 async function makeRequest(payload, attempts = constants_1.MAX_RETRY_ATTEMPTS) {
-    var _a;
+    var _a, _b;
     let data;
     if (!payload.isJson && payload.body) {
         data = payload.body;
@@ -12564,6 +12566,7 @@ async function makeRequest(payload, attempts = constants_1.MAX_RETRY_ATTEMPTS) {
     do {
         let errorCode;
         let error;
+        let jsonApiError;
         let response;
         try {
             response = await needle_1.default(method, url, data, options);
@@ -12580,6 +12583,11 @@ async function makeRequest(payload, attempts = constants_1.MAX_RETRY_ATTEMPTS) {
         }
         // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access
         const errorMessage = (_a = response === null || response === void 0 ? void 0 : response.body) === null || _a === void 0 ? void 0 : _a.error;
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment,@typescript-eslint/no-unsafe-member-access
+        const errors = (_b = response === null || response === void 0 ? void 0 : response.body) === null || _b === void 0 ? void 0 : _b.errors;
+        if (httpUtils_1.isJsonApiErrors(errors)) {
+            jsonApiError = errors[0];
+        }
         if (errorMessage) {
             error = error !== null && error !== void 0 ? error : new Error(errorMessage);
         }
@@ -12599,7 +12607,7 @@ async function makeRequest(payload, attempts = constants_1.MAX_RETRY_ATTEMPTS) {
         }
         else {
             attempts = 0;
-            return { success: false, errorCode, error };
+            return { success: false, errorCode, error, jsonApiError };
         }
     } while (attempts > 0);
     return { success: false, errorCode: constants_1.ErrorCodes.serviceUnavailable, error: undefined };
@@ -12737,16 +12745,17 @@ exports.reportScm = reportScm;
 /***/ }),
 
 /***/ 11294:
-/***/ ((__unused_webpack_module, exports) => {
+/***/ ((__unused_webpack_module, exports, __webpack_require__) => {
 
 "use strict";
 
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.getURL = void 0;
+exports.generateErrorWithDetail = exports.isJsonApiErrors = exports.getURL = void 0;
+const constants_1 = __webpack_require__(65765);
 function getURL(baseURL, path, orgId) {
     if (routeToGateway(baseURL)) {
-        if (!orgId) {
-            throw new Error('Org is required for this operation');
+        if (!isValidOrg(orgId)) {
+            throw new Error('A valid Org id is required for this operation');
         }
         return `${baseURL}/hidden/orgs/${orgId}/code${path}`;
     }
@@ -12756,6 +12765,41 @@ exports.getURL = getURL;
 function routeToGateway(baseURL) {
     return baseURL.includes('snykgov.io');
 }
+function isValidOrg(orgId) {
+    return orgId !== undefined && constants_1.ORG_ID_REGEXP.test(orgId);
+}
+function isJsonApiErrors(input) {
+    if (!Array.isArray(input) || input.length < 1) {
+        return false;
+    }
+    for (const element of input) {
+        if (typeof element !== 'object' ||
+            !('status' in element) ||
+            !('code' in element) ||
+            !('title' in element) ||
+            !('detail' in element)) {
+            return false;
+        }
+    }
+    return true;
+}
+exports.isJsonApiErrors = isJsonApiErrors;
+function generateErrorWithDetail(error, statusCode, apiName) {
+    var _a;
+    const errorLink = (_a = error.links) === null || _a === void 0 ? void 0 : _a.about;
+    const detail = `${error.title}${error.detail ? `: ${error.detail}` : ''}${errorLink ? ` (more info: ${errorLink})` : ``}`;
+    const statusText = error.title;
+    return {
+        type: 'error',
+        error: {
+            apiName,
+            statusCode: statusCode,
+            statusText,
+            detail,
+        },
+    };
+}
+exports.generateErrorWithDetail = generateErrorWithDetail;
 //# sourceMappingURL=httpUtils.js.map
 
 /***/ }),