Summary

Add a setting for controlling whether to confirm a Ship It! review.

Review Request #14409 — Created April 29, 2025 and submitted May 5, 2025, 4:31 p.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-7.1.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

With the modern location for the Ship It action (in the Review menu),
it's much harder to accidentally post a Ship It review. This makes the
confirmation prompt less important than it once was.

We now have a setting for controlling whether to prompt for
confirmation. This is managed in My Account -> Settings.

The confirmation dialog itself now uses an Ink modal dialog, with some
additional text to help guide users. It also includes a "Do not ask
again" checkbox, which will turn off the confirmation setting as well.
This is a sort of prototype for a suppression dialog that we may want in
Ink.

The setting is managed through the User Session resource, which now
accepts a HTTP PUT with a settings:json JSON Merge Patch of settings.
RB.UserSession provides an endpoint for this as well. These currently
only accept this new confirm_ship_it setting, and they're marked as
for internal use only, but it provides a path for more dynamic settings
down the road.

Testing Done

Python and JavaScript unit tests passed.

Tested the Ship It flow with confirmation turned on and off.

Tested the "Do not ask again" checkbox in the confirmation dialog,
verifying that it turned off the confirmation setting.

Commits

Summary	ID
Add a setting for controlling whether to confirm a Ship It! review. With the modern location for the Ship It action (in the Review menu), it's much harder to accidentally post a Ship It review. This makes the confirmation prompt less important than it once was. We now have a setting for controlling whether to prompt for confirmation. This is managed in My Account -> Settings. The confirmation dialog itself now uses an Ink modal dialog, with some additional text to help guide users. It also includes a "Do not ask again" checkbox, which will turn off the confirmation setting as well. This is a sort of prototype for a suppression dialog that we may want in Ink. The setting is managed through the User Session resource, which now accepts a HTTP PUT with a `settings:json` JSON Merge Patch of settings. `RB.UserSession` provides an endpoint for this as well. These currently only accept this new `confirm_ship_it` setting, and they're marked as for internal use only, but it provides a path for more dynamic settings down the road.	2c03cc3ba8e0fe231e320cbe120a75a1804668f3

Summary

Add a setting for controlling whether to confirm a Ship It! review.

With the modern location for the Ship It action (in the Review menu), it's much harder to accidentally post a Ship It review. This makes the confirmation prompt less important than it once was. We now have a setting for controlling whether to prompt for confirmation. This is managed in My Account -> Settings. The confirmation dialog itself now uses an Ink modal dialog, with some additional text to help guide users. It also includes a "Do not ask again" checkbox, which will turn off the confirmation setting as well. This is a sort of prototype for a suppression dialog that we may want in Ink. The setting is managed through the User Session resource, which now accepts a HTTP PUT with a `settings:json` JSON Merge Patch of settings. `RB.UserSession` provides an endpoint for this as well. These currently only accept this new `confirm_ship_it` setting, and they're marked as for internal use only, but it provides a path for more dynamic settings down the road.

2c03cc3ba8e0fe231e320cbe120a75a1804668f3

Files

Issues

Description	From	Last Updated
Unrelated, but shouldn't this be an icon instead of a blue square?	david	May 4, 2025, 2:49 a.m.
'djblets.util.decorators.augment_method_from' imported but unused Column: 1 Error code: F401	reviewbot	April 29, 2025, 2:26 a.m.
'djblets.util.json_utils.JSONPatchError' imported but unused Column: 1 Error code: F401	reviewbot	April 29, 2025, 2:26 a.m.
Can you type this?	maubin	May 1, 2025, 2 a.m.
Missing documentation and typing.	maubin	May 1, 2025, 2:05 a.m.
We can use user here instead of request.user.	maubin	May 1, 2025, 2:05 a.m.
Can you type this as a Mapping?	david	May 4, 2025, 2:49 a.m.
Since setters are just documented like methods, this needs an "Args" section.	david	May 4, 2025, 2:50 a.m.
Here too.	david	May 4, 2025, 2:50 a.m.

flake8 failed.

JSHint passed.

flake8

reviewboard/webapi/resources/session.py (Diff revision 1)

The issue has been resolved. Show all issues

'djblets.util.decorators.augment_method_from' imported but unused

Column: 1
Error code: F401

reviewboard/webapi/resources/session.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'djblets.util.json_utils.JSONPatchError' imported but unused

Column: 1
Error code: F401
```

Change Summary:

Removed unused imports.

Commits:

	Summary	ID
	Add a setting for controlling whether to confirm a Ship It! review. With the modern location for the Ship It action (in the Review menu), it's much harder to accidentally post a Ship It review. This makes the confirmation prompt less important than it once was. We now have a setting for controlling whether to prompt for confirmation. This is managed in My Account -> Settings. The confirmation dialog itself now uses an Ink modal dialog, with some additional text to help guide users. It also includes a "Do not ask again" checkbox, which will turn off the confirmation setting as well. This is a sort of prototype for a suppression dialog that we may want in Ink. The setting is managed through the User Session resource, which now accepts a HTTP PUT with a `settings:json` JSON Merge Patch of settings. `RB.UserSession` provides an endpoint for this as well. These currently only accept this new `confirm_ship_it` setting, and they're marked as for internal use only, but it provides a path for more dynamic settings down the road.	91f08a03d214d5242cb431edf2b67d2db0904d96
	Add a setting for controlling whether to confirm a Ship It! review. With the modern location for the Ship It action (in the Review menu), it's much harder to accidentally post a Ship It review. This makes the confirmation prompt less important than it once was. We now have a setting for controlling whether to prompt for confirmation. This is managed in My Account -> Settings. The confirmation dialog itself now uses an Ink modal dialog, with some additional text to help guide users. It also includes a "Do not ask again" checkbox, which will turn off the confirmation setting as well. This is a sort of prototype for a suppression dialog that we may want in Ink. The setting is managed through the User Session resource, which now accepts a HTTP PUT with a `settings:json` JSON Merge Patch of settings. `RB.UserSession` provides an endpoint for this as well. These currently only accept this new `confirm_ship_it` setting, and they're marked as for internal use only, but it provides a path for more dynamic settings down the road.	47136820c01e7d063fc0d318c92191804d035a15

Diff:

Revision 2 (+1256 -170)

Show changes

	reviewboard/accounts/models.py
	reviewboard/accounts/forms/pages.py
	reviewboard/accounts/templatetags/accounts.py
	reviewboard/static/rb/js/common/models/userSessionModel.ts
	reviewboard/static/rb/js/reviews/views/reviewablePageView.ts
	reviewboard/static/rb/js/reviews/views/tests/reviewablePageViewTests.ts
	reviewboard/templates/js/tests_base.html
	reviewboard/webapi/resources/session.py
	1 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

reviewboard/webapi/resources/session.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Can you type this?
```
reviewboard/webapi/resources/session.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Missing documentation and typing.
```
reviewboard/webapi/resources/session.py (Diff revision 2)
The issue has been resolved. Show all issues
```
We can use user here instead of request.user.
```

Change Summary:


Added missing typing and docs.
Added some missing unit test updates.
Updated to use the local user instead of request.user everywhere in serialize_object().

Commits:

	Summary	ID
	Add a setting for controlling whether to confirm a Ship It! review. With the modern location for the Ship It action (in the Review menu), it's much harder to accidentally post a Ship It review. This makes the confirmation prompt less important than it once was. We now have a setting for controlling whether to prompt for confirmation. This is managed in My Account -> Settings. The confirmation dialog itself now uses an Ink modal dialog, with some additional text to help guide users. It also includes a "Do not ask again" checkbox, which will turn off the confirmation setting as well. This is a sort of prototype for a suppression dialog that we may want in Ink. The setting is managed through the User Session resource, which now accepts a HTTP PUT with a `settings:json` JSON Merge Patch of settings. `RB.UserSession` provides an endpoint for this as well. These currently only accept this new `confirm_ship_it` setting, and they're marked as for internal use only, but it provides a path for more dynamic settings down the road.	47136820c01e7d063fc0d318c92191804d035a15
	Add a setting for controlling whether to confirm a Ship It! review. With the modern location for the Ship It action (in the Review menu), it's much harder to accidentally post a Ship It review. This makes the confirmation prompt less important than it once was. We now have a setting for controlling whether to prompt for confirmation. This is managed in My Account -> Settings. The confirmation dialog itself now uses an Ink modal dialog, with some additional text to help guide users. It also includes a "Do not ask again" checkbox, which will turn off the confirmation setting as well. This is a sort of prototype for a suppression dialog that we may want in Ink. The setting is managed through the User Session resource, which now accepts a HTTP PUT with a `settings:json` JSON Merge Patch of settings. `RB.UserSession` provides an endpoint for this as well. These currently only accept this new `confirm_ship_it` setting, and they're marked as for internal use only, but it provides a path for more dynamic settings down the road.	7dce65f66f8cbb2fe820baf638abc8efdbc1ee73

Diff:

Revision 3 (+1332 -176)

Show changes

	reviewboard/accounts/models.py
	reviewboard/accounts/forms/pages.py
	reviewboard/accounts/templatetags/accounts.py
	reviewboard/accounts/tests/test_template_tags.py
	reviewboard/static/rb/js/common/models/userSessionModel.ts
	reviewboard/static/rb/js/reviews/views/reviewablePageView.ts
	reviewboard/static/rb/js/reviews/views/tests/reviewablePageViewTests.ts
	reviewboard/templates/js/tests_base.html
	2 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Settings page (Revision 1)

The issue has been dropped. Show all issues

Unrelated, but shouldn't this be an icon instead of a blue square?

chipx86 May 4, 2025, 2:51 a.m.

It was just a local issue. You can ignore this.

reviewboard/accounts/forms/pages.py (Diff revision 3)
The issue has been resolved. Show all issues
```
Can you type this as a Mapping?
```
reviewboard/accounts/models.py (Diff revision 3)
The issue has been resolved. Show all issues
```
Since setters are just documented like methods, this needs an "Args" section.
```
reviewboard/accounts/models.py (Diff revision 3)
The issue has been resolved. Show all issues
```
Here too.
```

Change Summary:


Fixed a serialization issue when saving the setting from JavaScript, which affected new settings.
Fixed some documentation
Added missing typing.

Commits:

	Summary	ID
	Add a setting for controlling whether to confirm a Ship It! review. With the modern location for the Ship It action (in the Review menu), it's much harder to accidentally post a Ship It review. This makes the confirmation prompt less important than it once was. We now have a setting for controlling whether to prompt for confirmation. This is managed in My Account -> Settings. The confirmation dialog itself now uses an Ink modal dialog, with some additional text to help guide users. It also includes a "Do not ask again" checkbox, which will turn off the confirmation setting as well. This is a sort of prototype for a suppression dialog that we may want in Ink. The setting is managed through the User Session resource, which now accepts a HTTP PUT with a `settings:json` JSON Merge Patch of settings. `RB.UserSession` provides an endpoint for this as well. These currently only accept this new `confirm_ship_it` setting, and they're marked as for internal use only, but it provides a path for more dynamic settings down the road.	7dce65f66f8cbb2fe820baf638abc8efdbc1ee73
	Add a setting for controlling whether to confirm a Ship It! review. With the modern location for the Ship It action (in the Review menu), it's much harder to accidentally post a Ship It review. This makes the confirmation prompt less important than it once was. We now have a setting for controlling whether to prompt for confirmation. This is managed in My Account -> Settings. The confirmation dialog itself now uses an Ink modal dialog, with some additional text to help guide users. It also includes a "Do not ask again" checkbox, which will turn off the confirmation setting as well. This is a sort of prototype for a suppression dialog that we may want in Ink. The setting is managed through the User Session resource, which now accepts a HTTP PUT with a `settings:json` JSON Merge Patch of settings. `RB.UserSession` provides an endpoint for this as well. These currently only accept this new `confirm_ship_it` setting, and they're marked as for internal use only, but it provides a path for more dynamic settings down the road.	2c03cc3ba8e0fe231e320cbe120a75a1804668f3

Diff:

Revision 4 (+1368 -176)

Show changes

	reviewboard/accounts/models.py
	reviewboard/accounts/forms/pages.py
	reviewboard/accounts/templatetags/accounts.py
	reviewboard/accounts/tests/test_template_tags.py
	reviewboard/static/rb/js/common/models/userSessionModel.ts
	reviewboard/static/rb/js/reviews/views/reviewablePageView.ts
	reviewboard/static/rb/js/reviews/views/tests/reviewablePageViewTests.ts
	reviewboard/templates/js/tests_base.html
	2 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-7.1.x (9b137c5)