Summary

Allow users to opt-out of their own updates.

Review Request #6429 — Created Oct. 10, 2014 and submitted Oct. 19, 2014, 1:17 p.m.

Information

Owner

brennie

Repository

Review Board

Branch

master

Bugs

Depends On

Commit

f616d56...

Reviewers

Groups

reviewboard, students

People

Description

Add should_send_own_updates field to Profile model. This field
determines whether or not the user should receive email updates about
their own activity, such as submitting review requests, reviewing
requests, or replying to review requests. The default value for this
field is True.

Add an evolution, profile_should_send_own_updates, to add the same
field to the Profile model. This evolution sets the value for the
field to the default: True.

Add should_send_own_updates field to the Profile settings dialog.
This field is tied to the should_send_own_updates field on the
Profile model.

Add should_send_own_updates method to the User model. This method is
patched on like the other methods in accounts/models.py.

The send_review_email removes the user sending the email from the
set of recipients if they have their should_send_own_updates field
set to False unless they are one of the people assigned to the
people field of the review request.

Testing Done

Ran evolution successfully.

Unit tests pass.

Tested with local development server. With should_send_own_updates
set to False, when a review request is created, that user only
receives an email if they are assigned as a reviewer (in the people
field, not the groups field).

Files

Issues

Description	From	Last Updated
Col: 80 E501 line too long (81 > 79 characters)	reviewbot	Oct. 10, 2014, 1:21 p.m.
The first function is named _should_send_email() and is about receiving emails. It might be unnecessary, but I think _receive_own_updates() should …	AS asalahli	Oct. 15, 2014, 9:35 p.m.
a user*	dkus	Oct. 15, 2014, 9:35 p.m.
One thing that I'd like to make sure doesn't break is a user assigning a review request to themselves. In …	david	Oct. 19, 2014, 10:16 a.m.

Tool: Pyflakes
Processed Files:
    reviewboard/notifications/email.py
    reviewboard/accounts/evolutions/__init__.py
    reviewboard/accounts/models.py
    reviewboard/accounts/forms/pages.py
    reviewboard/accounts/evolutions/profile_receive_own_updates.py



Tool: PEP8 Style Checker
Processed Files:
    reviewboard/notifications/email.py
    reviewboard/accounts/evolutions/__init__.py
    reviewboard/accounts/models.py
    reviewboard/accounts/forms/pages.py
    reviewboard/accounts/evolutions/profile_receive_own_updates.py

reviewboard/accounts/evolutions/profile_receive_own_updates.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Col: 80
 E501 line too long (81 > 79 characters)
```

Change Summary:: Update testing.
Testing Done:: ~
Unit tests pass.
~
Unit tests pass.
+
+
Tested with local development server. When the receive_own_updates
+ field is set to false, I do not receive emails about my own activity;
+ when it is true, I do receive email.

Change Summary:

Fix line too long error in evolution.

Commit:

a00294c4fdc9f8732828de5498e2a34cc31b7e1c

933d3533c99cfc11d1f0ea5c3c358eba26773fce

Diff:

Revision 2 (+41)

Show changes

	reviewboard/accounts/models.py
	reviewboard/accounts/evolutions/__init__.py
	reviewboard/accounts/evolutions/profile_receive_own_updates.py
	reviewboard/accounts/forms/pages.py
	reviewboard/notifications/email.py

Tool: Pyflakes
Processed Files:
    reviewboard/notifications/email.py
    reviewboard/accounts/evolutions/__init__.py
    reviewboard/accounts/models.py
    reviewboard/accounts/forms/pages.py
    reviewboard/accounts/evolutions/profile_receive_own_updates.py



Tool: PEP8 Style Checker
Processed Files:
    reviewboard/notifications/email.py
    reviewboard/accounts/evolutions/__init__.py
    reviewboard/accounts/models.py
    reviewboard/accounts/forms/pages.py
    reviewboard/accounts/evolutions/profile_receive_own_updates.py

Ship it!

I know i'm loving this feature, everything looks neet and tidy.

reviewboard/accounts/models.py (Diff revision 2)
The issue has been resolved. Show all issues
```
a user*
```

reviewboard/accounts/models.py (Diff revision 2)

The issue has been resolved. Show all issues

The first function is named _should_send_email() and is about receiving emails. It might be unnecessary, but I think _receive_own_updates() should be named in a similar fashion?

Change Summary:

Rename receive_own_updates -> should_send_own_updates. Fix typo in docstring.

Description:

~		Add `receive_own_updates` field to Profile model. This field
	~	Add `should_send_own_updates` field to Profile model. This field
		determines whether or not the user should receive email updates about
		their own activity, such as submitting review requests, reviewing
		requests, or replying to review requests. The default value for this
		field is `True`.

~		Add an evolution, `receive_own_updates`, to add the same field to the
~		Profile model. This evolution sets the value for the field to the
~		default: `True`.
	~	Add an evolution, `profile_should_send_own_updates`, to add the same
	~	field to the Profile model. This evolution sets the value for the
	~	field to the default: `True`.

~		Add `receive_own_updates` field to the Profile settings dialog. This
~		field is tied to the `receive_own_updates` field on the Profile model.
	~	Add `should_send_own_updates` field to the Profile settings dialog.
	~	This field is tied to the `should_send_own_updates` field on the
	+	Profile model.

~		Add `receive_own_updates` method to the User model. This method is
	~	Add `should_send_own_updates` method to the User model. This method is
		patched on like the other methods in `accounts/models.py`.

		The `send_review_email` removes the user sending the email from the
		set of recipients and to addresses if they have their
~		`receive_own_updates` field set to False.
	~	`should_send_own_updates` field set to False.

Testing Done:

	+	Ran evolution successfully.
	+
		Unit tests pass.

~		Tested with local development server. When the `receive_own_updates`
~		field is set to false, I do not receive emails about my own activity;
~		when it is true, I do receive email.
	~	Tested with local development server. When the
	~	`should_send_own_updates` field is set to False, I do not receive
	~	emails about my own activity; when it is true, I do receive email.

Commit:

933d3533c99cfc11d1f0ea5c3c358eba26773fce

f23949b839a2dd64944520635bb9de3d79b12743

Diff:

Revision 3 (+41)

Show changes

	reviewboard/accounts/models.py
	reviewboard/accounts/evolutions/__init__.py
	reviewboard/accounts/evolutions/profile_should_send_own_updates.py
	reviewboard/accounts/forms/pages.py
	reviewboard/notifications/email.py

Tool: Pyflakes
Processed Files:
    reviewboard/notifications/email.py
    reviewboard/accounts/evolutions/__init__.py
    reviewboard/accounts/evolutions/profile_should_send_own_updates.py
    reviewboard/accounts/models.py
    reviewboard/accounts/forms/pages.py



Tool: PEP8 Style Checker
Processed Files:
    reviewboard/notifications/email.py
    reviewboard/accounts/evolutions/__init__.py
    reviewboard/accounts/evolutions/profile_should_send_own_updates.py
    reviewboard/accounts/models.py
    reviewboard/accounts/forms/pages.py

reviewboard/notifications/email.py (Diff revision 3)

The issue has been resolved. Show all issues

One thing that I'd like to make sure doesn't break is a user assigning a review request to themselves. In that case, they should still be listed in the 'to' field.

Change Summary:

If a RR is assigned to the submitter, they still get an email.

Commit:

f23949b839a2dd64944520635bb9de3d79b12743

f616d56d42a4232a8c649a25c3eab1e8797c0e63

Diff:

Revision 4 (+46 -6)

Show changes

	reviewboard/accounts/models.py
	reviewboard/accounts/evolutions/__init__.py
	reviewboard/accounts/evolutions/profile_should_send_own_updates.py
	reviewboard/accounts/forms/pages.py
	reviewboard/notifications/email.py

Tool: Pyflakes
Processed Files:
    reviewboard/notifications/email.py
    reviewboard/accounts/evolutions/__init__.py
    reviewboard/accounts/evolutions/profile_should_send_own_updates.py
    reviewboard/accounts/models.py
    reviewboard/accounts/forms/pages.py



Tool: PEP8 Style Checker
Processed Files:
    reviewboard/notifications/email.py
    reviewboard/accounts/evolutions/__init__.py
    reviewboard/accounts/evolutions/profile_should_send_own_updates.py
    reviewboard/accounts/models.py
    reviewboard/accounts/forms/pages.py

Change Summary:: Update testing and description.
Description:: Add should_send_own_updates field to Profile model. This field
determines whether or not the user should receive email updates about
their own activity, such as submitting review requests, reviewing
requests, or replying to review requests. The default value for this
field is True.

Add an evolution, profile_should_send_own_updates, to add the same
field to the Profile model. This evolution sets the value for the
field to the default: True.

Add should_send_own_updates field to the Profile settings dialog.
This field is tied to the should_send_own_updates field on the
Profile model.

Add should_send_own_updates method to the User model. This method is
patched on like the other methods in accounts/models.py.

The send_review_email removes the user sending the email from the
~ set of recipients and to addresses if they have their
~ should_send_own_updates field set to False.
~ set of recipients if they have their should_send_own_updates field
~ set to False unless they are one of the people assigned to the
+ people field of the review request.
Testing Done:: Ran evolution successfully.

Unit tests pass.

~
Tested with local development server. When the
~ should_send_own_updates field is set to False, I do not receive
~ emails about my own activity; when it is true, I do receive email.
~
Tested with local development server. With should_send_own_updates
~ set to False, when a review request is created, that user only
~ receives an email if they are assigned as a reviewer (in the people
+ field, not the groups field).

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-2.0.x (baa89ce)