Summary

Add context parameter to actions JS data methods.

Review Request #13107 — Created June 14, 2023 and submitted June 26, 2023, 2:41 p.m.

Information

Owner

david

Repository

Review Board

Branch

release-6.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

It turns out that it will be useful to allow the get_js_*_data for
actions to have access to the rendering context. This change does that
by introducing some new template tags that call the methods with the
context.

This also allows improving the implementation of the menu view a bit,
removing non-rendering actions from the data sent to the JS model,
preventing some warnings about unknown IDs from popping up in the case
that an extension has hidden a menu-item action.

Testing Done


Implemented a custom action that used the context parameter.
Used HideActionHook to hide a menu item action and saw that I was no

  longer getting warnings in the JS console.
Ran js-tests.

Commits

Summary	ID
Add context parameter to actions JS data methods. It turns out that it will be useful to allow the `get_js_*_data` for actions to have access to the rendering context. This change does that by introducing some new template tags that call the methods with the context. This also allows improving the implementation of the menu view a bit, removing non-rendering actions from the data sent to the JS model, preventing some warnings about unknown IDs from popping up in the case that an extension has hidden a menu-item action. Testing Done: - Implemented a custom action that used the context parameter. - Used `HideActionHook` to hide a menu item action and saw that I was no longer getting warnings in the JS console. - Ran js-tests.	f66baf5442821c071264a66cb56a4bbc49804137

Summary

Add context parameter to actions JS data methods.

It turns out that it will be useful to allow the `get_js_*_data` for actions to have access to the rendering context. This change does that by introducing some new template tags that call the methods with the context. This also allows improving the implementation of the menu view a bit, removing non-rendering actions from the data sent to the JS model, preventing some warnings about unknown IDs from popping up in the case that an extension has hidden a menu-item action. Testing Done: - Implemented a custom action that used the context parameter. - Used `HideActionHook` to hide a menu item action and saw that I was no longer getting warnings in the JS console. - Ran js-tests.

f66baf5442821c071264a66cb56a4bbc49804137

Issues

Description	From	Last Updated
I think the description is meant to say get_js__data instead of get__model_data.	maubin	June 21, 2023, 2:43 p.m.
line break before binary operator Column: 9 Error code: W503	reviewbot	June 15, 2023, 8:44 a.m.
Expected a string and instead saw %. Column: 2 Error code: W095	reviewbot	June 14, 2023, 3:32 p.m.
Expected ':' and instead saw 'load'. Column: 4 Error code: E021	reviewbot	June 14, 2023, 3:32 p.m.
Expected a JSON value. Column: 9 Error code: E003	reviewbot	June 14, 2023, 3:32 p.m.
Expected '}' and instead saw 'actions'. Column: 9 Error code: E021	reviewbot	June 14, 2023, 3:32 p.m.
Unrecoverable syntax error. (10% scanned). Column: 9 Error code: E041	reviewbot	June 14, 2023, 3:32 p.m.
Should say "Render ths JS view data for an action"	maubin	June 21, 2023, 2:43 p.m.
Expected ':' and instead saw 'load'. Column: 4 Error code: E021	reviewbot	June 15, 2023, 8:44 a.m.
Expected a JSON value. Column: 9 Error code: E003	reviewbot	June 15, 2023, 8:44 a.m.
Expected a string and instead saw %. Column: 2 Error code: W095	reviewbot	June 15, 2023, 8:44 a.m.
Expected '}' and instead saw 'actions'. Column: 9 Error code: E021	reviewbot	June 15, 2023, 8:44 a.m.
Unrecoverable syntax error. (10% scanned). Column: 9 Error code: E041	reviewbot	June 15, 2023, 8:44 a.m.
blank line at end of file Column: 1 Error code: W391	reviewbot	June 23, 2023, 9:14 a.m.
Expected a string and instead saw %. Column: 2 Error code: W095	reviewbot	June 21, 2023, 2:44 p.m.
Expected ':' and instead saw 'load'. Column: 4 Error code: E021	reviewbot	June 21, 2023, 2:44 p.m.
Expected a JSON value. Column: 9 Error code: E003	reviewbot	June 21, 2023, 2:44 p.m.
Expected '}' and instead saw 'actions'. Column: 9 Error code: E021	reviewbot	June 21, 2023, 2:44 p.m.
Unrecoverable syntax error. (10% scanned). Column: 9 Error code: E041	reviewbot	June 21, 2023, 2:44 p.m.

flake8 failed.

JSHint failed.

flake8

reviewboard/actions/templatetags/actions.py (Diff revision 1)
The issue has been dropped. Show all issues
```
line break before binary operator

Column: 9
Error code: W503
```

JSHint

reviewboard/templates/actions/action.js (Diff revision 1)
The issue has been dropped. Show all issues
```
Expected a string and instead saw %.

Column: 2
Error code: W095
```
reviewboard/templates/actions/action.js (Diff revision 1)
The issue has been dropped. Show all issues
```
Expected ':' and instead saw 'load'.

Column: 4
Error code: E021
```
reviewboard/templates/actions/action.js (Diff revision 1)
The issue has been dropped. Show all issues
```
Expected a JSON value.

Column: 9
Error code: E003
```
reviewboard/templates/actions/action.js (Diff revision 1)
The issue has been dropped. Show all issues
```
Expected '}' and instead saw 'actions'.

Column: 9
Error code: E021
```
reviewboard/templates/actions/action.js (Diff revision 1)
The issue has been dropped. Show all issues
```
Unrecoverable syntax error. (10% scanned).

Column: 9
Error code: E041
```

Commits:

	Summary	ID
	Add context parameter to actions JS data methods. It turns out that it will be useful to allow the `get_*_model_data` for actions to have access to the rendering context. This change does that by introducing some new template tags that call the methods with the context. This also allows improving the implementation of the menu view a bit, removing non-rendering actions from the data sent to the JS model, preventing some warnings about unknown IDs from popping up in the case that an extension has hidden a menu-item action. Testing Done: - Implemented a custom action that used the context parameter. - Used `HideActionHook` to hide a menu item action and saw that I was no longer getting warnings in the JS console. - Ran js-tests.	2028a02f8c6884e1f8ca9d279356aec5d28d6293
	Add context parameter to actions JS data methods. It turns out that it will be useful to allow the `get_*_model_data` for actions to have access to the rendering context. This change does that by introducing some new template tags that call the methods with the context. This also allows improving the implementation of the menu view a bit, removing non-rendering actions from the data sent to the JS model, preventing some warnings about unknown IDs from popping up in the case that an extension has hidden a menu-item action. Testing Done: - Implemented a custom action that used the context parameter. - Used `HideActionHook` to hide a menu item action and saw that I was no longer getting warnings in the JS console. - Ran js-tests.	b1c43b809d0f0f3238b9d3243723b8f51816bd11

Diff:

Revision 2 (+180 -18)

Show changes

	reviewboard/actions/base.py
	reviewboard/actions/templatetags/actions.py
	reviewboard/templates/actions/action.js

Checks run (1 failed, 1 succeeded)

flake8 passed.

JSHint failed.

JSHint

reviewboard/templates/actions/action.js (Diff revision 2)
The issue has been dropped. Show all issues
```
Expected ':' and instead saw 'load'.

Column: 4
Error code: E021
```
reviewboard/templates/actions/action.js (Diff revision 2)
The issue has been dropped. Show all issues
```
Expected a JSON value.

Column: 9
Error code: E003
```
reviewboard/templates/actions/action.js (Diff revision 2)
The issue has been dropped. Show all issues
```
Expected a string and instead saw %.

Column: 2
Error code: W095
```
reviewboard/templates/actions/action.js (Diff revision 2)
The issue has been dropped. Show all issues
```
Expected '}' and instead saw 'actions'.

Column: 9
Error code: E021
```
reviewboard/templates/actions/action.js (Diff revision 2)
The issue has been dropped. Show all issues
```
Unrecoverable syntax error. (10% scanned).

Column: 9
Error code: E041
```

The issue has been resolved. Show all issues

I think the description is meant to say get_js_*_data instead of get_*_model_data.

reviewboard/actions/templatetags/actions.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Should say "Render ths JS view data for an action"
```

Description:

~		It turns out that it will be useful to allow the `get_*_model_data` for
	~	It turns out that it will be useful to allow the `get_js_*_data` for
		actions to have access to the rendering context. This change does that
		by introducing some new template tags that call the methods with the
		context.

		This also allows improving the implementation of the menu view a bit,
		removing non-rendering actions from the data sent to the JS model,
		preventing some warnings about unknown IDs from popping up in the case
		that an extension has hidden a menu-item action.

Commits:

	Summary	ID
	Add context parameter to actions JS data methods. It turns out that it will be useful to allow the `get_*_model_data` for actions to have access to the rendering context. This change does that by introducing some new template tags that call the methods with the context. This also allows improving the implementation of the menu view a bit, removing non-rendering actions from the data sent to the JS model, preventing some warnings about unknown IDs from popping up in the case that an extension has hidden a menu-item action. Testing Done: - Implemented a custom action that used the context parameter. - Used `HideActionHook` to hide a menu item action and saw that I was no longer getting warnings in the JS console. - Ran js-tests.	b1c43b809d0f0f3238b9d3243723b8f51816bd11
	Add context parameter to actions JS data methods. It turns out that it will be useful to allow the `get_js_*_data` for actions to have access to the rendering context. This change does that by introducing some new template tags that call the methods with the context. This also allows improving the implementation of the menu view a bit, removing non-rendering actions from the data sent to the JS model, preventing some warnings about unknown IDs from popping up in the case that an extension has hidden a menu-item action. Testing Done: - Implemented a custom action that used the context parameter. - Used `HideActionHook` to hide a menu item action and saw that I was no longer getting warnings in the JS console. - Ran js-tests.	f66baf5442821c071264a66cb56a4bbc49804137

Diff:

Revision 3 (+188 -18)

Show changes

	reviewboard/actions/base.py
	reviewboard/actions/templatetags/actions.py
	reviewboard/templates/actions/action.js

Checks run (2 failed)

flake8 failed.

JSHint failed.

flake8

reviewboard/actions/templatetags/actions.py (Diff revision 3)
The issue has been dropped. Show all issues
```
blank line at end of file

Column: 1
Error code: W391
```

JSHint

reviewboard/templates/actions/action.js (Diff revision 3)
The issue has been dropped. Show all issues
```
Expected a string and instead saw %.

Column: 2
Error code: W095
```
reviewboard/templates/actions/action.js (Diff revision 3)
The issue has been dropped. Show all issues
```
Expected ':' and instead saw 'load'.

Column: 4
Error code: E021
```
reviewboard/templates/actions/action.js (Diff revision 3)
The issue has been dropped. Show all issues
```
Expected a JSON value.

Column: 9
Error code: E003
```
reviewboard/templates/actions/action.js (Diff revision 3)
The issue has been dropped. Show all issues
```
Expected '}' and instead saw 'actions'.

Column: 9
Error code: E021
```
reviewboard/templates/actions/action.js (Diff revision 3)
The issue has been dropped. Show all issues
```
Unrecoverable syntax error. (10% scanned).

Column: 9
Error code: E041
```

Ship it!

```
Ship It!
```

Status: Closed (submitted)

Change Summary:

Pushed to release-6.x (4280e6b)