4486 email pray and pay #4498

v-anne · 2024-09-26T14:38:47Z

This PR is to add email alerts to freelawproject/foresight#65, the pray and pay project. It follows up on #4386, which implemented much of the logic for the backend in terms of the Prayer model.

The logic for the email alerts is as follows:
When a document is confirmed to be available on CourtListener, the backend will identify whether any users had requested purchase of that document, and if so, will send all of them an email together informing them of its availability using BCC. The Prayer model will be updated to confirm that the document is now available, which will remove the document from the publicly available display of open requests.

for more information, see https://pre-commit.ci

v-anne · 2024-09-26T20:18:53Z

@mlissner @albertisfu

Some progress has been made on the email functionality. I looked at cl/alerts/management/commands/cl_send_alerts.py to see how emails are implemented in other parts of CourtListener. I do have some questions:

Could you confirm that I have correctly implemented how to extract the url link to the file?
Should I include text similar to the following from alert_email.txt?


 - View this item on our site: https://www.courtlistener.com{{result.absolute_url}}
{% if result.download_url %} - Download original from the court: {{result.download_url}}
{% endif %}{% if result.local_path %} - Download the original from our backup: https://storage.courtlistener.com/{{ result.local_path }}{% endif %}{% endfor %}

mlissner · 2024-09-26T21:14:51Z

Everything looks basically right to me, but I'll let Alberto take a more careful look.

- Added email test assertions.

albertisfu · 2024-09-27T21:09:16Z

@v-anne I've applied some tweaks to the PR so that email sending works properly.

One of the changes is to use email bulk sending, allowing us to send one email per recipient instead of using BCC. I think this is better due to AWS restrictions of 50 recipients when using the BCC or CC fields:
https://docs.aws.amazon.com/ses/latest/dg/quotas.html

This way, even if we have more than 50 users who need to be notified after a prayer is granted, all of them can receive the message.

I also added tests to confirm that email sending works properly.

@mlissner I think the only thing left to confirm is whether the email template is complete or if it requires some tweaks. Currently, the emails look as follows:

Text version:

CourtListener.com
*****************
-------------------------------------------------------
We have news regarding your alerts at CourtListener.com
-------------------------------------------------------

A document you requested to be purchased is now available on CourtListener.
-------------------------------------------------------

 - View this item on our site: https://www.courtlistener.com/docket/121/1/hoffman-v-mason-yu/


************************
This alert brought to you by the 501(c)(3) non-profit Free Law Project
 - Blog: https://free.law
 - BlueSky: https://bsky.app/profile/free.law
 - X: https://x.com/freelawproject
 - Donate: https://donate.free.law/forms/supportflp
 - Become a Member: https://donate.free.law/forms/membership

Please donate to support our work.

HTML version:

There are some CI actions failing related to authentication. I believe it can be something temporary. I'll retry them later.

mlissner · 2024-09-27T21:30:37Z

I made a little template that cribs from the alert email:

https://docs.google.com/document/d/1jGjdZPueFXRHILqgI3Pp606EzrEaxvNTkcLdWNJdHTs/edit?usp=sharing

I think it should be pretty easy, but some parts of it might be tricky and it probably isn't worth spending a ton of time on all of it. So consider it a notion, but hopefully one that gives some direction!

Thank you both!

v-anne · 2024-09-27T22:13:25Z

@mlissner, I left some comments on your Google doc.

for more information, see https://pre-commit.ci

…ourtlistener into 4486-email-pray-and-pay fixed

v-anne · 2024-09-30T02:37:04Z

I added three things as you suggested in the Google Doc:

price of the document
date requested
how many people were waiting for it.

Despite our initial hesitance about the date requested component, I decided to include it. I think limiting the query for dates to the QuerySet described below makes this relatively efficient and is a minor use of resources. If you disagree, I'm happy to remove it.

open_prayers = Prayer.objects.filter(
            recap_document=instance, status=Prayer.WAITING
        ).select_related("user")

v-anne · 2024-09-30T14:07:41Z

@mlissner @albertisfu

I attempted adding the case name and court number to the alerts. I think the case name works but the court name doesn't. I couldn't quite figure out how {{ result.court_citation_string|nbsp|safe }} works in the alert_email.html file.

Otherwise, I think this is almost ready to merge, after one more review.

mlissner · 2024-09-30T17:47:23Z

You just have to follow the FK chain. So if you have a RECAPDocument, the full chain would be:

rd.docket_entry.docket.court.whatever_field

I think the correct field on Court is full_name, but I'm not sure. Want to try that?

- Added additional test assertions

albertisfu · 2024-09-30T18:03:04Z

I've tweaked the templates and email context to make them look more like the email template Mike shared.

Added additional test assertions.

Email subject remains as: A document you requested is now on CourtListener

*****************
CourtListener.com
*****************
-------------------------------------------------------
Your Wish Has Been Granted!
-------------------------------------------------------

The document you were waiting for is now available in RECAP.
-------------------------------------------------------

Velazquez-Watts v. Roberts (4:59-ms-57576)
Thirteenth circuit of the Zoo
~~~
View Docket: https://www.courtlistener.com/docket/342/velazquez-watts-v-roberts/?order_by=desc

Document Number: 6
Date Filed: Aug 16, 2015
Description: Dismissing Case
View Document: https://www.courtlistener.com/docket/342/1/velazquez-watts-v-roberts/
~~~
You requested it on Sep 30, 2024
2 people were also waiting for it.
Somebody paid $1.00 to make it available to all of us.

************************
This alert brought to you by the 501(c)(3) non-profit Free Law Project
 - Blog: https://free.law
 - BlueSky: https://bsky.app/profile/free.law
 - X: https://x.com/freelawproject
 - Donate: https://donate.free.law/forms/supportflp
 - Become a Member: https://donate.free.law/forms/membership

v-anne · 2024-09-30T18:21:12Z

I think this is good to go. Thank you for your work on this, Alberto!

mlissner

One quick comment from me, but Alberto, I leave it to you for full review.

cl/search/signals.py

mlissner · 2024-09-30T21:14:56Z

Thank you @v-anne for sticking with this big feature!

albertisfu

In addition to Mike's suggestion, I would also recommend moving prayer_email.html and prayer_email.txt to favorites/templates.

With those changes, I think this is good to go.

Thanks @v-anne

cl/search/signals.py

for more information, see https://pre-commit.ci

v-anne · 2024-09-30T23:03:23Z

Both of your comments have now been resolved.

albertisfu · 2024-09-30T23:24:25Z

Both of your comments have now been resolved.

Thanks LGTM!

mlissner

Very cool. Thank you both.

@v-anne, deployments are blocked atm, but this will go live some time tomorrow, I expect.

Onward to the last pieces!

v-anne and others added 8 commits September 23, 2024 18:39

starting email alerts system

22c7a7d

progress on email alerts

3ba7395

[pre-commit.ci] auto fixes from pre-commit.com hooks

cc33ab4

for more information, see https://pre-commit.ci

Merge branch 'main' into 4486-email-pray-and-pay

8c448c6

starting email template and fixing error in Prayer status

bbc971b

some work on templates

6175c81

Merge branch 'main' into 4486-email-pray-and-pay

31b6d51

minor changes to templates and signals.py

8deae7c

v-anne marked this pull request as ready for review September 26, 2024 20:13

v-anne marked this pull request as draft September 26, 2024 20:13

v-anne and others added 6 commits September 26, 2024 17:26

minor URL changes

3856a7d

removing dependency

056aa74

commenting out until Alberto can review

2dcf2d4

Merge branch 'main' into 4486-email-pray-and-pay

e64f097

Merge branch 'main' into 4486-email-pray-and-pay

ab24b14

fix(favorites): Tweaks to email notifications for granted Prayers

0c92745

- Added email test assertions.

v-anne and others added 9 commits September 28, 2024 13:13

Merge branch 'main' into 4486-email-pray-and-pay

2e6778d

adding price of document and how many people were waiting

65967e7

[pre-commit.ci] auto fixes from pre-commit.com hooks

ff20e29

for more information, see https://pre-commit.ci

fix import of price function

53a87d8

adding date requested

48d171b

[pre-commit.ci] auto fixes from pre-commit.com hooks

f8a90bd

for more information, see https://pre-commit.ci

fixing date_created

500df2a

Merge branch '4486-email-pray-and-pay' of https://github.com/v-anne/c…

8ab532d

…ourtlistener into 4486-email-pray-and-pay fixed

fix

c213268

v-anne added 2 commits September 29, 2024 22:43

fixed issue with doc_price variable name

b823d22

adding case name and court to alerts

81213af

fix(favorites): Tweaks to prayer email templates

a1a5569

- Added additional test assertions

v-anne marked this pull request as ready for review September 30, 2024 18:20

mlissner reviewed Sep 30, 2024

View reviewed changes

cl/search/signals.py Outdated Show resolved Hide resolved

albertisfu self-requested a review September 30, 2024 22:45

albertisfu reviewed Sep 30, 2024

View reviewed changes

cl/search/signals.py Outdated Show resolved Hide resolved

v-anne and others added 4 commits September 30, 2024 19:00

creating send_prayer_emails() function

ffd77e4

[pre-commit.ci] auto fixes from pre-commit.com hooks

038a7b6

for more information, see https://pre-commit.ci

Merge branch 'main' into 4486-email-pray-and-pay

990c5e4

moving email templates to favorites app

89dd954

v-anne requested a review from mlissner September 30, 2024 23:04

mlissner approved these changes Sep 30, 2024

View reviewed changes

mlissner merged commit 1830fb0 into freelawproject:main Sep 30, 2024
9 checks passed

v-anne mentioned this pull request Oct 1, 2024

4507 pray and pay api #4519

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

4486 email pray and pay #4498

4486 email pray and pay #4498

v-anne commented Sep 26, 2024

v-anne commented Sep 26, 2024

mlissner commented Sep 26, 2024

albertisfu commented Sep 27, 2024 •

edited

Loading

mlissner commented Sep 27, 2024

v-anne commented Sep 27, 2024

v-anne commented Sep 30, 2024

v-anne commented Sep 30, 2024

mlissner commented Sep 30, 2024

albertisfu commented Sep 30, 2024

v-anne commented Sep 30, 2024

mlissner left a comment

mlissner commented Sep 30, 2024

albertisfu left a comment

v-anne commented Sep 30, 2024 •

edited

Loading

albertisfu commented Sep 30, 2024

mlissner left a comment

4486 email pray and pay #4498

4486 email pray and pay #4498

Conversation

v-anne commented Sep 26, 2024

v-anne commented Sep 26, 2024

mlissner commented Sep 26, 2024

albertisfu commented Sep 27, 2024 • edited Loading

mlissner commented Sep 27, 2024

v-anne commented Sep 27, 2024

v-anne commented Sep 30, 2024

v-anne commented Sep 30, 2024

mlissner commented Sep 30, 2024

albertisfu commented Sep 30, 2024

v-anne commented Sep 30, 2024

mlissner left a comment

Choose a reason for hiding this comment

mlissner commented Sep 30, 2024

albertisfu left a comment

Choose a reason for hiding this comment

v-anne commented Sep 30, 2024 • edited Loading

albertisfu commented Sep 30, 2024

mlissner left a comment

Choose a reason for hiding this comment

albertisfu commented Sep 27, 2024 •

edited

Loading

v-anne commented Sep 30, 2024 •

edited

Loading