Send email when a new collaborator has been added to the project.

[Mariatta]

• send the email to the newly added collaborator
• send the email to other owners
• email not sent to the person who added the collaborator

Fixes #1000

[di]

Eventually we're going to be sending an invitation to the new collaborator instead of just a notification, so we might want to break that up into a separate email. That would allow us to make the notification to the new contributor slightly more personal, like:

You have been added as a {{ role }} to the PyPI project {{ project }} by {{ submitter }}.

Congratulations!

[di]

As is, this will send the email to all the owners with all of their emails in theTO: field. While this is probably not a big deal for most people, generally we try to keep user's email addresses private unless they make them public. I think we could modify send_email to allow us to BCC multiple recipients instead, so the person receiving the email would just see their own address.

[di]

We can reduce some of the memory required to do this by moving the .user part into the DB with a join:

owners = (
    request.db.query(Role)
    .join(User)
    .filter(Role.role_name == 'Owner', Role.project == project)
)
owner_emails = [owner.email for owner in owners]

That way we just Users back from our query, not Roles.

[di]

I've been taking care to keep these emails at a fixed 80-character limit, which requires a bit of crafting of the template.

For this, we probably want to start out with the same "greeting" every time rather than the username as well.

So maybe something like:

A new collaborator has been added to a project you own on PyPI:

  Username: {{ username }}
  Role: {{ role }}
  Collaborator for: {{ project }}
  Added by: {{ submitter }}

If this was a mistake, you can reply to this email directly to communicate with
the PyPI administrators.

[di]

I think I would prefer if this more closely mimicked the arguments that Message takes, so something like:

def send_email(task, request, body, subject, recipients=None, bcc=None)

(FYI, changing the order here might require updates elsewhere where we're passing this positional arguments)

And then since the default arguments for Message are already None, we can call it like:

message = Message(
    body=body,
    recipients=recipients,
    bcc=bcc,
    sender=...,
    subject=subject,
)

[Mariatta]

Ok it makes sense to do it that way. Thanks.
That'll be quite a big change, since this is being called everywhere as positional argument.
I will prepare a separate PR just to update recipients into keyword only argument in send_email method.

[di]

This needs the same "you can reply to the admins" message.

[di]

This is a nitpick, but could you make the indentation here consistent? (e.g. like the call to send_collaborator_added_email above)

[di]

Sorry, I gave you a bad example query before. This should be:

owners = (
    request.db.query(User)
    .join(Role.user)
    .filter(Role.role_name == 'Owner', Role.project == project)
)

[brainwane]

@Mariatta looks like tests are failing -- take a look?

[Mariatta]

Thanks! The tests are passing now. Please re-review when you have the chance.

[lgh2]

Hi @Mariatta! I tested this PR and it looks like the emails are being sent to the new collaborator, but not to the other owners.

[Mariatta]

Thanks @lgh2! With the latest commit (ca04e7c) the other owners should receive the email notification now.

[di]

Thanks @Mariatta!

[Mariatta]

Thanks for the patience in reviewing this :)