Summary:

Review UI for JSON files

Review Request #10716 — Created Sept. 13, 2019 and updated Dec. 3, 2019, 11 p.m.

Information
Owner:	nicolelisa
Repository:	Review Board
Branch:	master
Bugs:
Depends On:
Reviewers
Groups:	reviewboard, students
People:

Description

Create a prettified JSON rendered version and a custom Review UI for JSON files.

Testing Done

Commits

Summary	Author
json ui functionality created: squashed commits	nicolelisa
add testing to jsonui.py	nicolelisa

Screenshots

Issues

Description	From	Last Updated
Can you upload screenshots of your review UI in the normal rendered JSON view, as well as in the diff …	amalik2	Sept. 14, 2019, 5:26 p.m.
F401 'logging' imported but unused	reviewbot	Sept. 13, 2019, 2:45 p.m.
F401 'reviewboard.diffviewer.chunk_generator.RawDiffChunkGenerator' imported but unused	reviewbot	Sept. 13, 2019, 2:45 p.m.
E501 line too long (92 > 79 characters)	reviewbot	Sept. 13, 2019, 2:46 p.m.
This should go in your Review UI.	brennie	Sept. 13, 2019, 2:54 p.m.
F821 undefined name 'force_bytes'	reviewbot	Sept. 13, 2019, 2:48 p.m.
F821 undefined name 'force_bytes'	reviewbot	Sept. 13, 2019, 2:48 p.m.
F821 undefined name 'force_bytes'	reviewbot	Sept. 13, 2019, 2:48 p.m.
F821 undefined name 'force_bytes'	reviewbot	Sept. 13, 2019, 2:48 p.m.
W292 no newline at end of file	reviewbot	Sept. 13, 2019, 2:49 p.m.
This commented import should either be removed or uncommented	amalik2	Sept. 14, 2019, 5:33 p.m.
You should handle invalid JSON being parsed. If the user uploads a JSON file that json.dumps is unable to process, …	amalik2	Sept. 21, 2019, 3:31 p.m.
E501 line too long (80 > 79 characters)	reviewbot	Sept. 13, 2019, 3:01 p.m.
Make sure to delete this file once you're finished testing.	amalik2	Sept. 14, 2019, 5:32 p.m.
Make sure to revert all changes in this file once Christian's PR with the same changes is merged	amalik2	Sept. 14, 2019, 5:32 p.m.
Can you upload an image of where this CSS rule is used, and how the UI differs when it isn't …	amalik2	Sept. 14, 2019, 5:33 p.m.
E303 too many blank lines (3)	reviewbot	Sept. 29, 2019, 12:13 p.m.
E127 continuation line over-indented for visual indent	reviewbot	Sept. 29, 2019, 12:13 p.m.
E116 unexpected indentation (comment)	reviewbot	Sept. 29, 2019, 12:14 p.m.
E501 line too long (147 > 79 characters)	reviewbot	Oct. 12, 2019, 6:32 p.m.
E501 line too long (138 > 79 characters)	reviewbot	Oct. 12, 2019, 6:32 p.m.
E501 line too long (80 > 79 characters)	reviewbot	Oct. 12, 2019, 6:35 p.m.
E126 continuation line over-indented for hanging indent	reviewbot	Oct. 12, 2019, 6:35 p.m.

flake8 failed.

JSHint passed.

flake8

reviewboard/reviews/ui/jsonui.py (Diff revision 1)
Show all issues
```
F401 'logging' imported but unused
```

reviewboard/reviews/ui/jsonui.py (Diff revision 1)

Show all issues

F401 'reviewboard.diffviewer.chunk_generator.RawDiffChunkGenerator' imported but unused

reviewboard/reviews/ui/jsonui.py (Diff revision 1)
Show all issues
```
E501 line too long (92 > 79 characters)
```
reviewboard/reviews/ui/text.py (Diff revision 1)
Show all issues
```
F821 undefined name 'force_bytes'
```
reviewboard/reviews/ui/text.py (Diff revision 1)
Show all issues
```
F821 undefined name 'force_bytes'
```
reviewboard/reviews/ui/text.py (Diff revision 1)
Show all issues
```
F821 undefined name 'force_bytes'
```
reviewboard/reviews/ui/text.py (Diff revision 1)
Show all issues
```
F821 undefined name 'force_bytes'
```
reviewboard/reviews/ui/text.py (Diff revision 1)
Show all issues
```
W292 no newline at end of file
```

reviewboard/reviews/ui/text.py (Diff revision 1)
Show all issues
```
This should go in your Review UI.
```

Commits:

	Summary	Author
-	add test json data	nicolelisa
-	modified json file	nicolelisa
-	jsonui file created	nicolelisa
-	create json specific page	nicolelisa
-	Add JsonLexer	nicolelisa
-	Add prettified version of JSON files to rendered	nicolelisa
+	add test json data	nicolelisa
+	modified json file	nicolelisa
+	jsonui file created	nicolelisa
+	create json specific page	nicolelisa
+	Add JsonLexer	nicolelisa
+	Add prettified version of JSON files to rendered	nicolelisa
+	fix reviewbot changes and move supported mimetype	nicolelisa

Diff:

Revision 2 (+292 -58)

Show changes

	reviewboard/staticbundles.py
	reviewboard/reviews/ui/__init__.py
	reviewboard/reviews/ui/jsonui.py
	reviewboard/reviews/ui/test.json
	reviewboard/reviews/ui/text.py
	reviewboard/static/rb/css/pages/text-review-ui.less
	reviewboard/static/rb/js/views/jsonReviewableView.es6.js

Checks run (1 failed, 1 succeeded)

flake8 failed.

JSHint passed.

flake8

reviewboard/reviews/ui/jsonui.py (Diff revision 2)
Show all issues
```
E501 line too long (80 > 79 characters)
```

Show all issues

Can you upload screenshots of your review UI in the normal rendered JSON view, as well as in the diff viewer?

nicolelisa Sept. 14, 2019, 5:26 p.m.

Sure. I'm not sure the best way to upload them but here are some dropbox links:

https://www.dropbox.com/s/q0ecf3jqtipn0nm/Screen%20Shot%202019-09-14%20at%206.22.35%20PM.png?dl=0
https://www.dropbox.com/s/qn4yz42rkpntfpj/Screen%20Shot%202019-09-14%20at%206.22.56%20PM.png?dl=0
https://www.dropbox.com/s/pcwxrzvqfppwn08/Screen%20Shot%202019-09-14%20at%206.23.27%20PM.png?dl=0

Note that one of them has an issue with whitespace, which should be a fairly easy fix next week.

reviewboard/reviews/ui/jsonui.py (Diff revision 2)

Show all issues

This commented import should either be removed or uncommented

nicolelisa Sept. 14, 2019, 5:44 p.m.

Uncommenting it gives an error with the Review bot, but I kept it there as a TODO since the markdown version has it.

reviewboard/reviews/ui/jsonui.py (Diff revision 2)

Show all issues

You should handle invalid JSON being parsed. If the user uploads a JSON file that json.dumps is unable to process, it would be best to display an error message to the user indicating that their JSON is invalid. In the markdown UI file, the try/catch in the generate_render() function handled this purpose. You should follow that same pattern, and wrap your code with a try/catch block. In the catch clause, you can yield the error message, and that error message will be visible in the render view when a parsing error occurs.

nicolelisa Sept. 14, 2019, 5:44 p.m.

Sounds good! Will put this on my list for next week.

reviewboard/reviews/ui/test.json (Diff revision 2)
Show all issues
```
Make sure to delete this file once you're finished testing.
```
1. nicolelisa Sept. 14, 2019, 5:44 p.m.
  Made a note of this.

reviewboard/reviews/ui/text.py (Diff revision 2)

Show all issues

Make sure to revert all changes in this file once Christian's PR with the same changes is merged

nicolelisa Sept. 14, 2019, 5:44 p.m.
```
Made a note of this.
```

reviewboard/static/rb/css/pages/text-review-ui.less (Diff revision 2)

Show all issues

Can you upload an image of where this CSS rule is used, and how the UI differs when it isn't set?

nicolelisa Sept. 14, 2019, 5:44 p.m.

This is in the above screenshots. The screenshot has it removed, but when it is added, the diff files stop working,
so I'm figuring out a way to differentiate them in CSS to prevent this.

Commits:

	Summary	Author
-	add test json data	nicolelisa
-	modified json file	nicolelisa
-	jsonui file created	nicolelisa
-	create json specific page	nicolelisa
-	Add JsonLexer	nicolelisa
-	Add prettified version of JSON files to rendered	nicolelisa
-	fix reviewbot changes and move supported mimetype	nicolelisa
+	add test json data	nicolelisa
+	modified json file	nicolelisa
+	jsonui file created	nicolelisa
+	create json specific page	nicolelisa
+	Add JsonLexer	nicolelisa
+	Add prettified version of JSON files to rendered	nicolelisa
+	fix reviewbot changes and move supported mimetype	nicolelisa
+	make changes as per Adil's recommendations	nicolelisa

Diff:

Revision 3 (+292 -70)

Show changes

	reviewboard/staticbundles.py
	reviewboard/reviews/ui/__init__.py
	reviewboard/reviews/ui/jsonui.py
	reviewboard/reviews/ui/test.json
	reviewboard/reviews/ui/text.py
	reviewboard/static/rb/js/views/jsonReviewableView.es6.js

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Commits:

	Summary	Author
-	add test json data	nicolelisa
-	modified json file	nicolelisa
-	jsonui file created	nicolelisa
-	create json specific page	nicolelisa
-	Add JsonLexer	nicolelisa
-	Add prettified version of JSON files to rendered	nicolelisa
-	fix reviewbot changes and move supported mimetype	nicolelisa
-	make changes as per Adil's recommendations	nicolelisa
+	add test json data	nicolelisa
+	modified json file	nicolelisa
+	jsonui file created	nicolelisa
+	create json specific page	nicolelisa
+	Add JsonLexer	nicolelisa
+	Add prettified version of JSON files to rendered	nicolelisa
+	fix reviewbot changes and move supported mimetype	nicolelisa
+	Add error handling and make review suggestions	nicolelisa

Diff:

Revision 4 (+277 -67)

Show changes

	reviewboard/staticbundles.py
	reviewboard/reviews/ui/__init__.py
	reviewboard/reviews/ui/jsonui.py
	reviewboard/reviews/ui/test.json
	reviewboard/reviews/ui/text.py
	reviewboard/static/rb/js/views/jsonReviewableView.es6.js

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Commits:

	Summary	Author
-	add test json data	nicolelisa
-	modified json file	nicolelisa
-	jsonui file created	nicolelisa
-	create json specific page	nicolelisa
-	Add JsonLexer	nicolelisa
-	Add prettified version of JSON files to rendered	nicolelisa
-	fix reviewbot changes and move supported mimetype	nicolelisa
-	Add error handling and make review suggestions	nicolelisa
+	add test json data	nicolelisa
+	modified json file	nicolelisa
+	jsonui file created	nicolelisa
+	create json specific page	nicolelisa
+	Add JsonLexer	nicolelisa
+	Add prettified version of JSON files to rendered	nicolelisa
+	fix reviewbot changes and move supported mimetype	nicolelisa
+	Add error handling and make review suggestions	nicolelisa
+	mirrored checkbox structure	nicolelisa

Diff:

Revision 5 (+415 -83)

Show changes

	reviewboard/staticbundles.py
	reviewboard/reviews/ui/__init__.py
	reviewboard/reviews/ui/jsonui.py
	reviewboard/reviews/ui/test.json
	reviewboard/reviews/ui/text.py
	reviewboard/static/rb/css/pages/text-review-ui.less
	reviewboard/static/rb/js/models/jsonBasedReviewableModel.js
	reviewboard/static/rb/js/views/jsonReviewableView.es6.js

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Commits:

	Summary	Author
-	add test json data	nicolelisa
-	modified json file	nicolelisa
-	jsonui file created	nicolelisa
-	create json specific page	nicolelisa
-	Add JsonLexer	nicolelisa
-	Add prettified version of JSON files to rendered	nicolelisa
-	fix reviewbot changes and move supported mimetype	nicolelisa
-	Add error handling and make review suggestions	nicolelisa
-	mirrored checkbox structure	nicolelisa
+	add test json data	nicolelisa
+	modified json file	nicolelisa
+	jsonui file created	nicolelisa
+	create json specific page	nicolelisa
+	Add JsonLexer	nicolelisa
+	Add prettified version of JSON files to rendered	nicolelisa
+	fix reviewbot changes and move supported mimetype	nicolelisa
+	Add error handling and make review suggestions	nicolelisa
+	mirrored checkbox structure	nicolelisa

Diff:

Revision 6 (+531 -83)

Show changes

	reviewboard/staticbundles.py
	reviewboard/reviews/ui/__init__.py
	reviewboard/reviews/ui/jsonui.py
	reviewboard/reviews/ui/test.json
	reviewboard/reviews/ui/text.py
	reviewboard/scmtools/testdata/hg_repo/.hg/wcache/checkisexec
	reviewboard/scmtools/testdata/hg_repo/.hg/wcache/checknoexec
	reviewboard/static/rb/css/pages/text-review-ui.less
	3 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Summary:

-	Review UI for JSON files - WIP
+	WIP: Review UI for JSON files

Commits:

	Summary	Author
-	add test json data	nicolelisa
-	modified json file	nicolelisa
-	jsonui file created	nicolelisa
-	create json specific page	nicolelisa
-	Add JsonLexer	nicolelisa
-	Add prettified version of JSON files to rendered	nicolelisa
-	fix reviewbot changes and move supported mimetype	nicolelisa
-	Add error handling and make review suggestions	nicolelisa
-	mirrored checkbox structure	nicolelisa
+	add test json data	nicolelisa
+	modified json file	nicolelisa
+	jsonui file created	nicolelisa
+	create json specific page	nicolelisa
+	Add JsonLexer	nicolelisa
+	Add prettified version of JSON files to rendered	nicolelisa
+	fix reviewbot changes and move supported mimetype	nicolelisa
+	Add error handling and make review suggestions	nicolelisa
+	mirrored checkbox structure	nicolelisa
+	json testing	nicolelisa

Diff:

Revision 7 (+873 -87)

Show changes

	reviewboard/staticbundles.py
	reviewboard/reviews/tests/test_json_review_ui.py
	reviewboard/reviews/ui/__init__.py
	reviewboard/reviews/ui/jsonui.py
	reviewboard/reviews/ui/test.json
	reviewboard/reviews/ui/text.py
	reviewboard/static/rb/css/pages/text-review-ui.less
	reviewboard/static/rb/js/models/jsonBasedReviewableModel.es6.js
	2 more

Checks run (1 failed, 1 succeeded)

flake8 failed.

JSHint passed.

flake8

reviewboard/reviews/tests/test_json_review_ui.py (Diff revision 7)
Show all issues
```
E303 too many blank lines (3)
```
reviewboard/reviews/tests/test_json_review_ui.py (Diff revision 7)
Show all issues
```
E127 continuation line over-indented for visual indent
```
reviewboard/reviews/ui/jsonui.py (Diff revision 7)
Show all issues
```
E116 unexpected indentation (comment)
```

Commits:

	Summary	Author
-	add test json data	nicolelisa
-	modified json file	nicolelisa
-	jsonui file created	nicolelisa
-	create json specific page	nicolelisa
-	Add JsonLexer	nicolelisa
-	Add prettified version of JSON files to rendered	nicolelisa
-	fix reviewbot changes and move supported mimetype	nicolelisa
-	Add error handling and make review suggestions	nicolelisa
-	mirrored checkbox structure	nicolelisa
-	json testing	nicolelisa
+	add test json data	nicolelisa
+	modified json file	nicolelisa
+	jsonui file created	nicolelisa
+	create json specific page	nicolelisa
+	Add JsonLexer	nicolelisa
+	Add prettified version of JSON files to rendered	nicolelisa
+	fix reviewbot changes and move supported mimetype	nicolelisa
+	Add error handling and make review suggestions	nicolelisa
+	mirrored checkbox structure	nicolelisa
+	json testing	nicolelisa

Diff:

Revision 8 (+869 -87)

Show changes

	reviewboard/staticbundles.py
	reviewboard/reviews/tests/test_json_review_ui.py
	reviewboard/reviews/ui/__init__.py
	reviewboard/reviews/ui/jsonui.py
	reviewboard/reviews/ui/test.json
	reviewboard/reviews/ui/text.py
	reviewboard/static/rb/css/pages/text-review-ui.less
	reviewboard/static/rb/js/models/jsonBasedReviewableModel.es6.js
	2 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Commits:

	Summary	Author
-	add test json data	nicolelisa
-	modified json file	nicolelisa
-	jsonui file created	nicolelisa
-	create json specific page	nicolelisa
-	Add JsonLexer	nicolelisa
-	Add prettified version of JSON files to rendered	nicolelisa
-	fix reviewbot changes and move supported mimetype	nicolelisa
-	Add error handling and make review suggestions	nicolelisa
-	mirrored checkbox structure	nicolelisa
-	json testing	nicolelisa
+	add test json data	nicolelisa
+	modified json file	nicolelisa
+	jsonui file created	nicolelisa
+	create json specific page	nicolelisa
+	Add JsonLexer	nicolelisa
+	Add prettified version of JSON files to rendered	nicolelisa
+	fix reviewbot changes and move supported mimetype	nicolelisa
+	Add error handling and make review suggestions	nicolelisa
+	mirrored checkbox structure	nicolelisa
+	json testing	nicolelisa

Diff:

Revision 9 (+881 -87)

Show changes

	reviewboard/staticbundles.py
	reviewboard/reviews/tests/test_json_review_ui.py
	reviewboard/reviews/ui/__init__.py
	reviewboard/reviews/ui/jsonui.py
	reviewboard/reviews/ui/test.json
	reviewboard/reviews/ui/text.py
	reviewboard/static/rb/css/pages/text-review-ui.less
	reviewboard/static/rb/js/models/jsonBasedReviewableModel.es6.js
	2 more

Checks run (1 failed, 1 succeeded)

flake8 failed.

JSHint passed.

flake8

reviewboard/reviews/tests/test_json_review_ui.py (Diff revision 9)
Show all issues
```
E501 line too long (147 > 79 characters)
```
reviewboard/reviews/tests/test_json_review_ui.py (Diff revision 9)
Show all issues
```
E501 line too long (138 > 79 characters)
```

Commits:

	Summary	Author
-	add test json data	nicolelisa
-	modified json file	nicolelisa
-	jsonui file created	nicolelisa
-	create json specific page	nicolelisa
-	Add JsonLexer	nicolelisa
-	Add prettified version of JSON files to rendered	nicolelisa
-	fix reviewbot changes and move supported mimetype	nicolelisa
-	Add error handling and make review suggestions	nicolelisa
-	mirrored checkbox structure	nicolelisa
-	json testing	nicolelisa
+	add test json data	nicolelisa
+	modified json file	nicolelisa
+	jsonui file created	nicolelisa
+	create json specific page	nicolelisa
+	Add JsonLexer	nicolelisa
+	Add prettified version of JSON files to rendered	nicolelisa
+	fix reviewbot changes and move supported mimetype	nicolelisa
+	Add error handling and make review suggestions	nicolelisa
+	mirrored checkbox structure	nicolelisa
+	json testing	nicolelisa
+	add testing and fix issues with <pre> tag	nicolelisa
+	fix issues found by reviewbot	nicolelisa

Diff:

Revision 10 (+1043 -157)

Show changes

	reviewboard/staticbundles.py
	reviewboard/reviews/tests/test_json_review_ui.py
	reviewboard/reviews/ui/__init__.py
	reviewboard/reviews/ui/jsonui.py
	reviewboard/reviews/ui/test.json
	reviewboard/static/rb/css/pages/text-review-ui.less
	reviewboard/static/rb/js/models/jsonBasedReviewableModel.es6.js
	reviewboard/static/rb/js/views/jsonRenderOptionsView.es6.js
	1 more

Checks run (1 failed, 1 succeeded)

flake8 failed.

JSHint passed.

flake8

reviewboard/reviews/ui/jsonui.py (Diff revision 10)
Show all issues
```
E501 line too long (80 > 79 characters)
```
reviewboard/reviews/ui/jsonui.py (Diff revision 10)
Show all issues
```
E126 continuation line over-indented for hanging indent
```

Commits:

	Summary	Author
-	add test json data	nicolelisa
-	modified json file	nicolelisa
-	jsonui file created	nicolelisa
-	create json specific page	nicolelisa
-	Add JsonLexer	nicolelisa
-	Add prettified version of JSON files to rendered	nicolelisa
-	fix reviewbot changes and move supported mimetype	nicolelisa
-	Add error handling and make review suggestions	nicolelisa
-	mirrored checkbox structure	nicolelisa
-	json testing	nicolelisa
-	add testing and fix issues with <pre> tag	nicolelisa
-	fix issues found by reviewbot	nicolelisa
+	add test json data	nicolelisa
+	modified json file	nicolelisa
+	jsonui file created	nicolelisa
+	create json specific page	nicolelisa
+	Add JsonLexer	nicolelisa
+	Add prettified version of JSON files to rendered	nicolelisa
+	fix reviewbot changes and move supported mimetype	nicolelisa
+	Add error handling and make review suggestions	nicolelisa
+	mirrored checkbox structure	nicolelisa
+	json testing	nicolelisa
+	add testing and fix issues with <pre> tag	nicolelisa
+	fix issues found by reviewbot	nicolelisa

Diff:

Revision 11 (+1045 -161)

Show changes

	reviewboard/staticbundles.py
	reviewboard/reviews/tests/test_json_review_ui.py
	reviewboard/reviews/ui/__init__.py
	reviewboard/reviews/ui/jsonui.py
	reviewboard/reviews/ui/test.json
	reviewboard/static/rb/css/pages/text-review-ui.less
	reviewboard/static/rb/js/models/jsonBasedReviewableModel.es6.js
	reviewboard/static/rb/js/views/jsonRenderOptionsView.es6.js
	1 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Commits:

	Summary	Author
-	add test json data	nicolelisa
-	modified json file	nicolelisa
-	jsonui file created	nicolelisa
-	create json specific page	nicolelisa
-	Add JsonLexer	nicolelisa
-	Add prettified version of JSON files to rendered	nicolelisa
-	fix reviewbot changes and move supported mimetype	nicolelisa
-	Add error handling and make review suggestions	nicolelisa
-	mirrored checkbox structure	nicolelisa
-	json testing	nicolelisa
-	add testing and fix issues with <pre> tag	nicolelisa
-	fix issues found by reviewbot	nicolelisa
+	json ui functionality created: squashed commits	nicolelisa
+	add testing to jsonui.py	nicolelisa

Diff:

Revision 12 (+536)

Show changes

	reviewboard/staticbundles.py
	reviewboard/reviews/tests/test_json_review_ui.py
	reviewboard/reviews/ui/__init__.py
	reviewboard/reviews/ui/jsonui.py
	reviewboard/static/rb/js/views/jsonReviewableView.es6.js

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Summary:

-	WIP: Review UI for JSON files
+	Review UI for JSON files

Description:

~		modified json file
	~	Create a prettified JSON rendered version and a custom Review UI for JSON files.
-		jsonui file created
-		create json specific page
-		Add JsonLexer
-		Add prettified version of JSON files to rendered
-
-		Currently an issue with diff for file attachments.