fix: send vnd.api+json for rest API calls with body

snyk-labs · Nov 2, 2022 · 0b2b27c · 0b2b27c
1 parent 507fc86
commit 0b2b27c
Show file tree

Hide file tree

Showing 3 changed files with 73 additions and 2 deletions.
diff --git a/package.json b/package.json
@@ -48,7 +48,7 @@
   },
   "devDependencies": {
     "@types/jest": "^25.1.1",
-    "@types/lodash": "^4.14.149",
+    "@types/lodash": "4.14.186",
     "@types/node": "^12.12.26",
     "@typescript-eslint/eslint-plugin": "^2.18.0",
     "@typescript-eslint/parser": "^2.18.0",

diff --git a/src/lib/request/request.ts b/src/lib/request/request.ts
@@ -41,7 +41,10 @@ const makeSnykRequest = async (
       ? userAgentPrefix + '/'
       : userAgentPrefix;
   const requestHeaders: Record<string, any> = {
-    'Content-Type': 'application/json',
+    'Content-Type':
+      request.useRESTApi && request.body
+        ? 'application/vnd.api+json'
+        : 'application/json',
     Authorization: 'token ' + snykToken,
     'User-Agent': `${topParentModuleName}${userAgentPrefixChecked}tech-services/snyk-request-manager/1.0`,
   };
@@ -68,6 +71,9 @@ const makeSnykRequest = async (
       case 'PUT':
         res = await apiClient.put(request.url, request.body);
         break;
+      case 'PATCH':
+        res = await apiClient.patch(request.url, request.body);
+        break;
       case 'DELETE':
         res = await apiClient.delete(request.url);
         break;

diff --git a/test/lib/request/rest-request.test.ts b/test/lib/request/rest-request.test.ts
@@ -3,6 +3,8 @@ import * as fs from 'fs';
 import * as nock from 'nock';
 import * as _ from 'lodash';
 import * as path from 'path';
+import axios from 'axios';
+
 import {
   NotFoundError,
   ApiError,
@@ -43,6 +45,15 @@ beforeEach(() => {
         default:
       }
     })
+    .patch(/^(?!.*xyz).*$/)
+    .reply(200, (uri, requestBody) => {
+      switch (uri) {
+        case '/rest/':
+          return requestBody;
+          break;
+        default:
+      }
+    })
     .get(/^(?!.*xyz).*$/)
     .reply(200, (uri) => {
       switch (uri) {
@@ -65,10 +76,12 @@ beforeEach(() => {
 
 afterEach(() => {
   process.env = OLD_ENV;
+  jest.restoreAllMocks();
 });
 
 describe('Test Snyk Utils make request properly', () => {
   it('Test GET command on /', async () => {
+    const axiosSpy = jest.spyOn(axios, 'create');
     const response = await makeSnykRequest(
       { verb: 'GET', url: '/', useRESTApi: true },
       'token123',
@@ -79,8 +92,21 @@ describe('Test Snyk Utils make request properly', () => {
         .toString(),
     );
     expect(response.data).toEqual(fixturesJSON);
+    expect(axiosSpy).toHaveBeenCalledWith({
+      baseURL: 'https://api.snyk.io/rest/',
+      headers: {
+        Authorization: 'token token123',
+        'Content-Type': 'application/json',
+        'User-Agent': 'tech-services/snyk-request-manager/1.0',
+      },
+      responseType: 'json',
+      timeout: 30000,
+      transitional: { clarifyTimeoutError: true },
+    });
   });
   it('Test POST command on /', async () => {
+    const axiosSpy = jest.spyOn(axios, 'create');
+
     const bodyToSend = {
       testbody: {},
     };
@@ -94,6 +120,45 @@ describe('Test Snyk Utils make request properly', () => {
       'token123',
     );
     expect(response.data).toEqual(bodyToSend);
+    expect(axiosSpy).toHaveBeenCalledWith({
+      baseURL: 'https://api.snyk.io/rest/',
+      headers: {
+        Authorization: 'token token123',
+        'Content-Type': 'application/vnd.api+json',
+        'User-Agent': 'tech-services/snyk-request-manager/1.0',
+      },
+      responseType: 'json',
+      timeout: 30000,
+      transitional: { clarifyTimeoutError: true },
+    });
+  });
+  it('Test PATCH command on /', async () => {
+    const axiosSpy = jest.spyOn(axios, 'create');
+
+    const bodyToSend = {
+      testbody: {},
+    };
+    const response = await makeSnykRequest(
+      {
+        verb: 'PATCH',
+        url: '/',
+        body: JSON.stringify(bodyToSend),
+        useRESTApi: true,
+      },
+      'token123',
+    );
+    expect(response.data).toEqual(bodyToSend);
+    expect(axiosSpy).toHaveBeenCalledWith({
+      baseURL: 'https://api.snyk.io/rest/',
+      headers: {
+        Authorization: 'token token123',
+        'Content-Type': 'application/vnd.api+json',
+        'User-Agent': 'tech-services/snyk-request-manager/1.0',
+      },
+      responseType: 'json',
+      timeout: 30000,
+      transitional: { clarifyTimeoutError: true },
+    });
   });
 });