Summary

Centralize the templates used for review request page entries.

Review Request #9038 — Created June 27, 2017 and submitted July 7, 2017, 5:43 p.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-3.0.x

Bugs

Depends On

Commit

988be7b...

Reviewers

Groups

reviewboard

People

Description

Entries on the review request page (reviews, changes, and the initial
status updates) now share the same base templates, with information
provided by the entry classes on the Python side.

The base template provides the general structure used for boxes on the
review request page, handling anchors, avatars, labels, the header,
banners, and container for the main content. The specific entries
subclass this, filling out the necessary blocks to set the CSS classes,
header title, entry content, labels, etc. that are needed.

Avatars are based on a new avatar_user attribute on entries. If set,
and if avatars are enabled, that user's avatar will be rendered.
Templates can also provide custom images to use here.

There's now only a single JavaScript template for constructing the
model/view for each entry. The data and options are provided by new
methods on the entry classes on the Python side, as are the names of the
model/view JavaScript classes to use.

These changes make it easier to maintain entries, and will lead to
extension-provided entries for the review request page.

Testing Done

Tested that reviews, replies, changes (with and without status updates),
and the initial status updates entries all looked correct and all had
complete functionality (replying, collapsing, revoking Ship Its, etc. all
worked).

Tested with avatars enabled and disabled.

Issues

Description	From	Last Updated
Please use either "status_area" or "status_updates_area" to be consistent with the naming throughout the rest of the code.	david	July 7, 2017, 5:42 p.m.
Please call this "box-status-updates"	david	June 28, 2017, 3:14 p.m.
Col: 2 Expected a string and instead saw %.	reviewbot	June 27, 2017, 4:32 p.m.
Col: 4 Expected ':' and instead saw 'load'.	reviewbot	June 27, 2017, 4:32 p.m.
Col: 9 Expected a JSON value.	reviewbot	June 27, 2017, 4:32 p.m.
Col: 9 Expected '}' and instead saw 'djblets_js'.	reviewbot	June 27, 2017, 4:32 p.m.
Col: 9 Unrecoverable syntax error. (7% scanned).	reviewbot	June 27, 2017, 4:32 p.m.
Please use either "status_area" or "status_updates_area" to be consistent with the naming throughout the rest of the code.	david	June 28, 2017, 3:14 p.m.
Please use either "status_area" or "status_updates_area" to be consistent with the naming throughout the rest of the code.	david	June 28, 2017, 3:14 p.m.
Col: 2 Expected a string and instead saw %.	reviewbot	June 28, 2017, 3:18 p.m.
Col: 4 Expected ':' and instead saw 'load'.	reviewbot	June 28, 2017, 3:18 p.m.
Col: 9 Expected a JSON value.	reviewbot	June 28, 2017, 3:18 p.m.
Col: 9 Expected '}' and instead saw 'djblets_js'.	reviewbot	June 28, 2017, 3:18 p.m.
Col: 9 Unrecoverable syntax error. (7% scanned).	reviewbot	June 28, 2017, 3:18 p.m.

flake8 passed.

JSHint failed.

JSHint

reviewboard/templates/reviews/boxes/entry.js (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 2
 Expected a string and instead saw %.
```
reviewboard/templates/reviews/boxes/entry.js (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 4
 Expected ':' and instead saw 'load'.
```
reviewboard/templates/reviews/boxes/entry.js (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 9
 Expected a JSON value.
```
reviewboard/templates/reviews/boxes/entry.js (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 9
 Expected '}' and instead saw 'djblets_js'.
```
reviewboard/templates/reviews/boxes/entry.js (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 9
 Unrecoverable syntax error. (7% scanned).
```

reviewboard/templates/reviews/base_entry.html (Diff revision 1)

The issue has been dropped. Show all issues

Please use either "status_area" or "status_updates_area" to be consistent with the naming throughout the rest of the code.

chipx86 June 28, 2017, 3:14 p.m.

This isn't about status updates. This is the box-statuses section of the entry box where the Ship It and the Fix It labels are, along with avatars. It predates the status updates work.

david June 28, 2017, 3:23 p.m.
```
My bad.
```

chipx86 June 28, 2017, 3:23 p.m.

No worries, very easy to confuse the two. We might want to rename the thing on the side.

reviewboard/templates/reviews/base_entry.html (Diff revision 1)
The issue has been dropped. Show all issues
```
Please call this "box-status-updates"
```

reviewboard/templates/reviews/review_detail.html (Diff revision 1)

The issue has been dropped. Show all issues

Please use either "status_area" or "status_updates_area" to be consistent with the naming throughout the rest of the code.

reviewboard/templates/reviews/review_detail.html (Diff revision 1)

The issue has been dropped. Show all issues

Please use either "status_area" or "status_updates_area" to be consistent with the naming throughout the rest of the code.

Change Summary:


StatusUpdatesEntryMixin now inherits from DiffCommentsSerializerMixin and ReviewSerializerMixin and provides a common version of get_js_model_data.
JavaScript model data for reviews and diff comments is now only serialized if there's something to serialize (no more empty entries).

Commit:

41260af4df16fd1246da79c3c6c06f3d14938dec

988be7b39d2b0a85a810c5e3134c9d1fa9528b37

Diff:

Revision 2 (+382 -255)

Show changes

	docs/manual/extending/extensions/hooks/template-hook.rst
	reviewboard/changedescs/templatetags/__init__.py
	reviewboard/changedescs/templatetags/changedescs.py
	reviewboard/reviews/detail.py
	reviewboard/templates/reviews/base_entry.html
	reviewboard/templates/reviews/review_detail.html
	reviewboard/templates/reviews/boxes/change.html
	reviewboard/templates/reviews/boxes/change.js
	5 more

Checks run (1 failed, 1 succeeded)

flake8 passed.

JSHint failed.

JSHint

reviewboard/templates/reviews/boxes/entry.js (Diff revision 2)
The issue has been dropped. Show all issues
```
Col: 2
 Expected a string and instead saw %.
```
reviewboard/templates/reviews/boxes/entry.js (Diff revision 2)
The issue has been dropped. Show all issues
```
Col: 4
 Expected ':' and instead saw 'load'.
```
reviewboard/templates/reviews/boxes/entry.js (Diff revision 2)
The issue has been dropped. Show all issues
```
Col: 9
 Expected a JSON value.
```
reviewboard/templates/reviews/boxes/entry.js (Diff revision 2)
The issue has been dropped. Show all issues
```
Col: 9
 Expected '}' and instead saw 'djblets_js'.
```
reviewboard/templates/reviews/boxes/entry.js (Diff revision 2)
The issue has been dropped. Show all issues
```
Col: 9
 Unrecoverable syntax error. (7% scanned).
```

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-3.0.x (dfa1389)