Add email notification on project/release removal

[MVrachev]

Until now, when there are multiple contributors on a single
the project, if one of them deletes a release or the whole
project the other contributors don't get any notification,
which is problematic.

Connected with issue #5714

Signed-off-by: Martin Vrachev [email protected]

[di]

Hi @MVrachev, is this still a WIP? I don't see any changes here that actually use these new templates.

[MVrachev]

I consciously split the implementation of the issue #5714 into multiple pull requests.

Here I wanted to discuss with you the text in the templates themselves because it's my first time using Jinjra2.

There will be another pull request which will use those templates.

[di]

Thanks for the explanation. Let's keep everything in one pull request, the maintainers have limited bandwidth and it's easier for us to review a single feature-complete PR.

If you have any questions about the implementation, feel free to ask in #5714.

[MVrachev]

@di I have updated my pull request with the code using it.
I tested it for both package removal and package release removal.

[MVrachev]

I will fix the issues with the CI these days and you can have a look again.

[MVrachev]

@di I updated the unit tests in the pr.

The tests I touched are not failing but some others do, but it seems they are failing in the master branch too.

I think the pr is ready for a review. It's complete.

[ewdurbin]

Hi @MVrachev! Thanks for your contribution.

Overall I think this looks great. The main theme is avoiding the word "package" in the code and templates in favor of "project" to maintain consistency with our terminology. I didn't point out every instance to keep from overwhelming the review.

[MVrachev]

I addressed your feedback @ewdurbin.

I was wondering what word should I use when there is a deletion of a particular release file in a project.
Should I call it removed_package because according to https://pypi.org/help/#packages:

A "file", also known as a "package", on PyPI is something that you can download and install. Because of different hardware, operating systems, and file formats, a release may have several files (packages), like an archive containing source code or a binary wheel.

[ewdurbin]

I addressed your feedback @ewdurbin.

I was wondering what word should I use when there is a deletion of a particular release file in a project.
Should I call it removed_package because according to https://pypi.org/help/#packages:

A "file", also known as a "package", on PyPI is something that you can download and install. Because of different hardware, operating systems, and file formats, a release may have several files (packages), like an archive containing source code or a binary wheel.

Thanks for those changes @MVrachev!

This question actually does stir up the fact that we're only notifying if a Project or Release as whole is removed.

If notification for single file removal is added (which is probably a good idea), I'd suggest that we use something along the lines of:

send_removed_release_file_email or send_removed_file_email. At the verbose extreme... send_removed_project_release_file_email works... as it follows the whole "chain" down (Projects hold Releases, Releases hold Files).

I'm mostly sticking to the names that we use within the codebase/schema; see Project, Release, and File.

Overall, package is just kind of a messy term. If anything this nudges me to consider working to shore up that FAQ entry :)

[MVrachev]

Are there other changes required you want me to do @ewdurbin ?
If not, can we merge this because I want to continue my work on issue #5714 and add email notifications when:

• Send a email notification to all collaborators when a file from a version is deleted.
• Send a email notification to all collaborators when new version of the package is uploaded.

[ewdurbin]

It looks like there are some issues with test coverage and linting, once those are resolved this is good to go, thanks @MVrachev

[MVrachev]

@ewdurbin you were right.
Sorry that I didn't looked at that in the first place before asking for a review.

I have added multiple new unit tests in order to increase the code coverage and during that process I found some small bugs and problems.

I think it requires a new look at the new changes. I made a new commit with them.

[MVrachev]

I have changed the role of the submitter to "owner" for send_removed_project_email and send_removed_project_release_email and now Travis CI blocks because of the lack of translations.

What I am suppose to do?

[MVrachev]

I fixed the translations issues.
I don't plan any new changes on that pr, but I think that maybe it's a good idea for a new review because of some recent changes.

[ewdurbin]

Thank you @MVrachev!

[monperrus]

Hi all,
I'd like to receive emails for each release, but it's unclear what else I should add in pyproject.toml

[project]
name = "crawler-user-agents"

authors = [
  { name="Martin Monperrus", email="[email protected]" },
]

Any help would be appreciated, thanks!

[di]

Hi, emails are sent to user accounts on PyPI, not addresses listed in project metadata. Hope that helps!

[monperrus]

Thanks @di for the clarification.

Are emails sent for removals only? Or can they also be sent for normal releases? (NPM does this and it's super useful)

[di]

See #13234.

[monperrus]

thanks.