Switch JSON formatting from 'jsonc-parser' to 'js-beautify' #233
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 2 commits
August 15, 2018 17:28
Switched to 'js-beautify' from 'jsonc-parser'
Huachao
reviewed
Aug 16, 2018
package.json
Outdated
| @@ -558,6 +558,7 @@ | |||
| "highlight.js": "^9.6.0", | |||
| "httpsnippet": "^1.16.5", | |||
| "iconv-lite": "^0.4.15", | |||
| "js-beautify": "^1.7.5", | |||
| "jsonc-parser": "^1.0.3", | |||
There was a problem hiding this comment.
Remove this package in dependencies
|
Done! |
deanchen
suggested changes
Aug 16, 2018
src/utils/responseFormatUtility.ts
Outdated
|
|
||
| export class ResponseFormatUtility { | ||
| public static formatBody(body: string, contentType: string, suppressValidation: boolean): string { | ||
| if (contentType) { | ||
| if (MimeUtility.isJSON(contentType)) { | ||
| if (ResponseFormatUtility.IsJsonString(body)) { | ||
| const edits = JSONFormat(body, undefined, { tabSize: 2, insertSpaces: true, eol: EOL }); | ||
| body = applyEdits(body, edits); | ||
| body = beautify(body, { indent_size: 4 }); |
There was a problem hiding this comment.
Why did you increase the indent_size from 2 to 4 here?
Huachao
approved these changes
Aug 17, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The existing responseFormatUtility.ts makes use of 'jsonc-parser' to format incoming JSON. The speed doesn't vary much based on size of JSON, but it does vary depending on the number of "edits" that need to be made. When the current implementation tries to format JSON with many objects and sub objects, 30+ seconds can go by (and the waiting spinner stalls). 'pretty-data' uses JSON.stringify(JSON.parse)) which is quick, but will break some invalid JSON where a key is listed twice. I have found that 'js-beautify' is quick and acceptable.
I used this link to test, it is both a large JSON payload and one that is slow to format using 'jsonc-parser' (I gave up waiting), returned in seconds with 'js-beautify': http://www.vizgr.org/historical-events/search.php?format=json&begin_date=-3000000&end_date=20151231&lang=en