Feat/axios nodejs #232

r3dsm0k3 · 2020-03-29T18:30:19Z

Changes

Adds nodejs-axios code generation.

Tests ✅

Fixes postmanlabs/postman-app-support#3822 ✅

Currently there is no async await style code generation. However, adding it is very trivial.

I've tested for node-axios. Since axios also works on browser, it can also be used on the browser with minimal changes (I guess formdata file reading might need to change, but cant be very certain since I didnt test it myself)

I could not update the author in the package.json since there is a test to make sure it is Postman labs.

fdterr · 2020-03-30T15:59:57Z

Oh I'm excited about this

fjufju · 2020-04-30T12:33:05Z

any updates? I want this so muh :)
Can we ask someone from the team for a review?

shreys7 · 2020-05-05T09:04:20Z

@r3dsm0k3 can you rebase your branch with the latest develop from postman-code-generators?

shreys7 · 2020-05-05T09:52:34Z

Also, can you post some example snippets here? for GET, POST, etc.

r3dsm0k3 · 2020-05-06T15:57:17Z

Sure, based on the tests;

✓ should generate snippet for basicCollection request: Request Headers

const axios = require('axios');

const config = {
  'method': 'get',
  'url': 'https://postman-echo.com/headers',
  'headers': {         
    'my-sample-header': 'Lorem ipsum dolor sit amet',
    'not-disabled-header': 'ENABLED'
  }
}
axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

✓ should generate snippet for basicCollection request: POST json with raw

const axios = require('axios');
const data = JSON.stringify({
  query: "{\n    body{\n        graphql\n    }\n}",
  variables: {"variable_key":"variable_value"}
})
const config = {
  'method': 'post',
  'url': 'http://postman-echo.com/post',
  'headers': {         
    'Content-Type': 'application/json'
  },
  data : data
}
axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

✓ should generate snippet for basicCollection request: DELETE Request

const axios = require('axios');
const FormData = require('form-data')
const data = new FormData();
data.append("pl", "\'a\'");
data.append("qu", "\"b\"");
data.append("sa", "d");
data.append("Special", "!@#$%&*()^_+=`~");
data.append("more", ",./\';[]}{\":?><|\\\\");

const config = {
  'method': 'post',
  'url': 'https://postman-echo.com/post',
  'headers': {
    ...data.getHeaders()
  },
  data : data
}
axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

✓ should generate snippet for formdataCollection request: POST multipart/form-data with text parameters

const axios = require('axios');
const FormData = require('form-data')
const data = new FormData();

const config = {
  'method': 'post',
  'url': 'https://postman-echo.com/post',
  'headers': {
    ...data.getHeaders()
  },
  data : data
}
axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

shreys7 · 2020-05-07T10:34:16Z

Tests failing

r3dsm0k3 · 2020-05-07T16:24:55Z

@shreys7 I see that all of the axios related tests are passing it is failing at completely unrelated places, although there's no change in those related libraries (same as upstream). Is there anything I'm missing here?

someshkoli · 2020-05-12T21:26:33Z

@shreys7 these blocks are due to #246.

someshkoli · 2020-05-13T16:25:50Z

@shreys7 I've tested this version locally and generated snippets are perfect. Tests are failing due to #246 else everything seems alright. Here's a ss of failed request. All other requests are failing due to same parameter. The the data parameter is unique for delete request.

I think the x-amzn... parameter has to be changed from all the variants in order to tests to get passed.

shreys7 · 2020-05-13T16:36:13Z

I did check for snippet generation before. By review, I meant to review the code used to generate the snippets. The code should be in alignment with other languages' code, proper linting, correct code generated for options, etc.
One obvious mistake that I can see is the option ES6_enabled is not taken into consideration while generating code, even though it is exposed in the list of options. Can you do a thorough review of code once and point out such errors? @someshkoli

someshkoli · 2020-05-13T16:42:56Z

Okay sure got it ✌️

someshkoli · 2020-05-14T16:21:03Z

@shreys7 reviewed code thoroughly. All requests are generating according to the options provided. Also I've suggested some changes below.

someshkoli · 2020-05-15T22:32:31Z

codegens/nodejs-axios/README.md

+    * `requestTimeout` : Integer denoting time after which the request will bail out in milli-seconds
+    * `trimRequestBody` : Trim request body fields
+    * `followRedirect` : Boolean denoting whether to redirect a request
+    * `AsyncAwait_enabled` : Boolean denoting whether to generate snippet with async await coding style (WIP)


You can remove async await option from the readme as its not supported by the code generator

someshkoli · 2020-05-15T22:33:13Z

codegens/nodejs-axios/README.md

+    options = {
+        indentType: 'Space',
+        indentCount: 2,
+        ES6_enabled: true


Same for es_6 enable option

rather than removing the option, it would be great to have that as an option and add support for it in the code.

someshkoli · 2020-05-15T22:34:13Z

codegens/nodejs-axios/lib/axios.js

+  snippet += indentString + 'console.log(error);\n';
+  snippet += '});\n';
+
+  // if(options.AsyncAwait_enabled === true) {


Please remove these unwanted commented code

someshkoli · 2020-05-15T22:34:38Z

codegens/nodejs-axios/lib/axios.js

+      default: false,
+      description: 'Remove white space and additional lines that may affect the server\'s response'
+    }
+    // ,


Remove unwanted commented code

someshkoli · 2020-05-15T22:40:37Z

codegens/nodejs-axios/lib/axios.js

+ * @param {String} options.indentCount - number of spaces or tabs for indentation.
+ * @param {Boolean} options.followRedirect - whether to enable followredirect
+ * @param {Boolean} options.trimRequestBody - whether to trim fields in request body or not
+ * @param {Boolean} options.AsyncAwait_enabled : whether to enable async await pattern


Remove AsyncAwait_enabled option as it is not there in the code generator

someshkoli · 2020-05-15T22:43:40Z

codegens/nodejs-axios/test/newman/newman.test.js

+
+  runNewmanTest(convert, options, testConfig);
+
+  describe('Convert for request incorporating ES6 features', function () {


Since your variant does not have this option you can remove this test

Same comment, add the support for ES6 syntax

shreys7 · 2020-05-18T09:05:44Z

@r3dsm0k3 Can you address the changes as suggested by @someshkoli ?

r3dsm0k3 · 2020-05-18T09:20:59Z

Yeah sure.

shreys7 · 2020-05-20T07:04:12Z

Any updates @r3dsm0k3 ?

r3dsm0k3 · 2020-05-20T09:04:38Z

Hey guys, I'm quite occupied these days. unfortunately, I'll only be able to spend time on the weekend. Feel free to take a stab at it if you feel like. Cheers.

someshkoli · 2020-05-20T19:27:38Z

@shreys7 shall I take over this ?

r3dsm0k3 · 2020-05-20T20:57:47Z

@someshkoli I've given you access to my repo (check your invitation). If you push to the same branch, it should update the PR automatically. Thanks for the effort 👍

someshkoli · 2020-05-20T20:59:04Z

@someshkoli I've given you access to my repo (check your invitation). If you push to the same branch, it should update the PR automatically. Thanks for the effort 👍

Okay cool ✌️

shreys7 · 2020-05-21T11:58:53Z

sure @someshkoli. Feel free to make the changes. Also, I have fixed the CI, changes up on latest develop. You can rebase with the latest develop, and the CI should pass.

someshkoli · 2020-05-21T11:59:39Z

Great. Will make these changes and puch today ✌️✌️

…nerators into feat/axios-nodejs pulls fix for ci fails

someshkoli · 2020-05-21T16:13:07Z

@shreys7 can you please check why Single/multiple file upload via form-data request is failing. I'm unable to figure out if its due to ci or due to codegenerator. Rest its done

shreys7 · 2020-05-22T05:36:44Z

Can you add transfer-encoding to the list of headers to delete in newmanTestUtil file? This should solve the CI failure if the snippet generated is correct
https://github.com/postmanlabs/postman-code-generators/blob/develop/test/codegen/newman/newmanTestUtil.js

someshkoli · 2020-05-22T14:15:59Z

again failed due to csharp @shreys7

shreys7

I have added some review comments. The comments are mostly about adding proper indentations, semicolons, sanitization of strings, etc. Tell me if you face any queries regarding the comments 🙂

shreys7 · 2020-05-22T16:09:30Z

codegens/nodejs-axios/lib/axios.js

+  }
+  snippet += varDeclare + ' config = {\n';
+  snippet += configArray.join(',\n') + '\n';
+  snippet += '}\n';


need a semicolon and a new line after the closing bracket.

shreys7 · 2020-05-22T16:11:38Z

codegens/nodejs-axios/lib/axios.js

+                                    options.ES6_enabled);
+  snippet += dataSnippet+'\n';
+
+  configArray.push(indentString + `'method': '${request.method.toLowerCase()}'`);


no need of adding single quotes around the method, url and headers key. just add

{ method: 'post', url: 'example.com', headers: {...} }

shreys7 · 2020-05-22T16:14:08Z

codegens/nodejs-axios/lib/util.js

+    return '';
+  }
+  (trim) && (inputString = inputString.trim());
+  return inputString.replace(/\\/g, '\\\\').replace(/'/g, '\\\'').replace(/\n/g, '\\n').replace(/"/g, '\\"');


there's no need to sanitize both single as well as double quotes. The need for sanitization is that when you receive a single quote inside a single quoted string, it needs to be escaped. For example
'ab\'cd'. But if we have a single quoted string, we can place double quotes inside it, e.g. 'ab"cd'. Thus, we only need to escape a single one from both.

shreys7 · 2020-05-22T16:15:25Z

codegens/nodejs-axios/lib/parseRequest.js

+ */
+function parseFormData (body, trim, ES6_enabled) {
+  var varDeclare = ES6_enabled ? 'const' : 'var',
+    bodySnippet = varDeclare + ' FormData = require(\'form-data\')\n';


need a semicolon at the end of the require('form-data') statement

shreys7 · 2020-05-22T16:15:51Z

codegens/nodejs-axios/lib/parseRequest.js

+  // check if there's file
+  const fileArray = body.filter(function (item) { return !item.disabled && item.type === 'file'; });
+  if (fileArray.length > 0) {
+    bodySnippet += varDeclare + ' fs = require(\'fs\')\n';


need a semicolon at the end of the require('fs') statement

shreys7 · 2020-05-22T16:17:32Z

codegens/nodejs-axios/lib/axios.js

+  // https://github.com/axios/axios/issues/789#issuecomment-577177492
+  if (!_.isEmpty(body) && body.formdata ) {
+    // we can assume that data object is filled up
+    headers.push(`\n${indentString}...data.getHeaders()`);


We don't really need to add a \n before the ...data.getHeaders(). I guess headers.join(,\n) will take care of it 🤔

This is the snippet generated when request has some headers, and this formdata header is also added. The indentation looks weird, can you check on it once?

'headers': { 'my-sample-header': 'Lorem ipsum dolor sit amet', 'TEST': '@#$%^&*()', 'more': ',./\';[]}{\":?><|\\\\', ...data.getHeaders() }

shreys7 · 2020-05-22T16:20:21Z

codegens/nodejs-axios/lib/axios.js

+
+  body = request.body && request.body.toJSON();
+
+  dataSnippet = parseRequest.parseBody(body, 


only add the body if it is non empty object, and the mode that it states has non empty data

shreys7 · 2020-05-22T16:20:55Z

codegens/nodejs-axios/lib/parseRequest.js

+ */
+function parseURLEncodedBody (body, trim, ES6_enabled) {
+  var varDeclare = ES6_enabled ? 'const' : 'var',
+    bodySnippet = varDeclare + ' qs = require(\'qs\')\n',


need a semicolon after the require('qs') statement

shreys7 · 2020-05-22T16:25:28Z

codegens/nodejs-axios/lib/parseRequest.js

+  }
+  bodySnippet = varDeclare + ' data = JSON.stringify({\n';
+  bodySnippet += `${indentString}query: "${sanitize(query, trim)}",\n`;
+  bodySnippet += `${indentString}variables: ${JSON.stringify(graphqlVariables)}\n})`;


need a semicolon at the end of line

- adds ; where necessary - removes \n where not required - removes double quote sanitization - adds \n where necessary

codegens/nodejs-axios/lib/axios.js

shreys7 · 2020-05-23T17:46:14Z

codegens/nodejs-axios/lib/parseRequest.js

+      bodySnippet += `JSON.stringify(${JSON.stringify(jsonBody)});\n`;
+    }
+    catch (error) {
+      bodySnippet += `"${sanitize(body.toString(), trim)}";\n`;


In the sanitize function, we escape single quotes only. If the body here contains a double quote, it won't get escaped, resulting in a wrong snippet generated. e.g. "this is a sample "body preview". Look at the sanitize functions of other snippets to see how we handle the sanitization of quotes.

test/codegen/newman/fixtures/formdataFileCollection.json

shreys7 · 2020-05-25T19:24:48Z

Merging this PR. Thanks a lot for the contribution @r3dsm0k3 @someshkoli 🙏😄

fjufju · 2020-05-26T05:14:28Z

@shreys7 this now available when making docs in postman? Thank you!

fjufju mentioned this pull request Apr 30, 2020

[WIP] Adds nodejs-axios codegen support #236

Closed

shreys7 self-requested a review May 5, 2020 09:04

emanuelet mentioned this pull request May 6, 2020

[WIP] Adds nodejs-axios codegen #245

Closed

ajith and others added 2 commits May 6, 2020 17:43

feat(nodejs-axios): Added nodejs axios code generation

f2d40e8

updates readme

9cdcaad

r3dsm0k3 force-pushed the feat/axios-nodejs branch from df45da4 to 9cdcaad Compare May 6, 2020 15:44

better formatting for the header object in the generated snippet

acf7c92

reverts unrelated changes.

68bbf2e

someshkoli suggested changes May 15, 2020

View reviewed changes

someshkoli added 3 commits May 21, 2020 20:44

Removes unwanted commented code and additional options

a54e54e

Merge branch 'develop' of https://github.com/r3dsm0k3/postman-code-ge…

d12d44e

…nerators into feat/axios-nodejs pulls fix for ci fails

Adds ES6_ENABLE option to nodejs-axios codegen

607c245

Adds transfer-encoding to headers to delete

9897296

shreys7 requested changes May 22, 2020

View reviewed changes

Snippet sanitization

93ff66f

- adds ; where necessary - removes \n where not required - removes double quote sanitization - adds \n where necessary

shreys7 reviewed May 23, 2020

View reviewed changes

codegens/nodejs-axios/lib/axios.js Outdated Show resolved Hide resolved

Snippet Sanitization

79127b6

shreys7 reviewed May 23, 2020

View reviewed changes

someshkoli added 2 commits May 23, 2020 23:51

Snippet sanitization(1)

2e3ad20

Snippet sanitization(2)

7f3561e

shreys7 reviewed May 24, 2020

View reviewed changes

test/codegen/newman/fixtures/formdataFileCollection.json Outdated Show resolved Hide resolved

r3dsm0k3 added 2 commits May 25, 2020 15:03

reverts the collection to the develop branch

593a716

adds dummy file to the ignore list

53c4964

shreys7 approved these changes May 25, 2020

View reviewed changes

shreys7 merged commit 31e5c35 into postmanlabs:develop May 25, 2020

Misiu mentioned this pull request May 26, 2020

[WIP]: Axios code generator #226

Closed

This was referenced Mar 15, 2020

[Snyk] Upgrade chalk from 2.1.0 to 2.4.2 #211

Closed

[Snyk] Upgrade chalk from 2.1.0 to 2.4.2 #271

Closed

r3dsm0k3 deleted the feat/axios-nodejs branch June 29, 2020 07:39

snyk-bot mentioned this pull request Jun 30, 2020

[Snyk] Upgrade chalk from 2.1.0 to 2.4.2 #295

Merged

snyk-bot mentioned this pull request Oct 10, 2020

[Snyk] Upgrade chalk from 2.1.0 to 2.4.2 #359

Closed

snyk-bot mentioned this pull request Jan 12, 2022

[Snyk] Fix for 2 vulnerabilities #564

Closed


		runNewmanTest(convert, options, testConfig);

		describe('Convert for request incorporating ES6 features', function () {


		body = request.body && request.body.toJSON();

		dataSnippet = parseRequest.parseBody(body,

Feat/axios nodejs #232

Feat/axios nodejs #232

Conversation

r3dsm0k3 commented Mar 29, 2020

Changes

fdterr commented Mar 30, 2020

fjufju commented Apr 30, 2020

shreys7 commented May 5, 2020

shreys7 commented May 5, 2020

r3dsm0k3 commented May 6, 2020 • edited Loading

shreys7 commented May 7, 2020

r3dsm0k3 commented May 7, 2020

someshkoli commented May 12, 2020

someshkoli commented May 13, 2020 • edited Loading

shreys7 commented May 13, 2020 • edited Loading

someshkoli commented May 13, 2020

someshkoli commented May 14, 2020 • edited Loading

someshkoli May 15, 2020 • edited Loading

Choose a reason for hiding this comment

someshkoli May 15, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shreys7 commented May 18, 2020

r3dsm0k3 commented May 18, 2020

shreys7 commented May 20, 2020

r3dsm0k3 commented May 20, 2020

someshkoli commented May 20, 2020

r3dsm0k3 commented May 20, 2020

someshkoli commented May 20, 2020 • edited Loading

shreys7 commented May 21, 2020

someshkoli commented May 21, 2020

someshkoli commented May 21, 2020

shreys7 commented May 22, 2020 • edited Loading

someshkoli commented May 22, 2020 • edited Loading

shreys7 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shreys7 commented May 25, 2020

fjufju commented May 26, 2020

r3dsm0k3 commented May 6, 2020 •

edited

Loading

someshkoli commented May 13, 2020 •

edited

Loading

shreys7 commented May 13, 2020 •

edited

Loading

someshkoli commented May 14, 2020 •

edited

Loading

someshkoli May 15, 2020 •

edited

Loading

someshkoli May 15, 2020 •

edited

Loading

someshkoli commented May 20, 2020 •

edited

Loading

shreys7 commented May 22, 2020 •

edited

Loading

someshkoli commented May 22, 2020 •

edited

Loading