4507 pray and pay api

[v-anne]

This is the PR for #4507, adding the API and frontend for the pray-and-pay project. It follows up on #4386 and #4498.

[v-anne]

@albertisfu @mlissner I think a rough version of the API endpoint is done. Apologies for any errors, I mostly followed DocketAlertViewSet and made some changes when I thought appropriate.

[mlissner]

Very cool. Thanks @v-anne. I'll put it on Alberto's backlog for review.

[v-anne]

Sorry about that @ERosendo. I didn't catch that issue in my local testing.

I suspect it was caused by the following line in de_list.html:

class="btn btn-default btn-xs prayer-button {% if not prayer_eligible %}disabled{% endif %}"

[ERosendo]

Sorry about that @ERosendo. I didn't catch that issue in my local testing.

Don't worry @v-anne

@mlissner check out this GIF showing the button's functionality with htmx. This refactor addresses the issues highlighted in #4519 (comment).

Let me know your thoughts.

[v-anne]

I like your changes to it. It's easier to see which documents a user has requested. The only suggestion I have is to more clearly disable the button (perhaps by making it unclickable) for documents that users haven't previously requested once their quota is exhausted.

This is referring to Attachment 5 and Document 2 in your gif.

Also, do the different states of the button have corresponding mouseover text?

[ERosendo]

Also, do the different states of the button have corresponding mouseover text?

Yes @v-anne. Here are screenshots:

[v-anne]

This looks great!

Just want to note a bug I found when testing locally: when trying to toggle a button that is currently untoggled, the mouseover reads "You have reached your daily request limit" even if I haven't exhausted the quota.

I can't figure out what's wrong with this code, but for some reason the if statement never trips the "Click to request this document" case.

    <button type="submit"
            class="btn btn-xs {% if prayer_exists %}btn-primary{% else %}btn-default{% endif %}"
            data-document-id="{{ document_id }}"
            title="{% if prayer_exists %}Click to remove your request.{% elif not prayer_eligible %}You have reached your daily request limit.{% else %}Click to request this document.{% endif %}"
            >

Edit: never mind, I think it's a limitation of not refreshing the page between each interaction with a button. I think that's fine.

[v-anne]

One last thing -- I think it would be helpful to have an explanation on top_prayers.html that explains to users how all of this works. I'm open to adding that in a subsequent PR with any API documentation (if needed), assuming the feature will gradually be rolled out to users.

[mlissner]

I finally caught up here. I haven't looked at the code, but if everybody's happy and it's behind a waffle, let's merge. @ERosendo or @albertisfu, one of you want to go for it?

I think this feature needs a lot of explanation to users before we launch it, both on the top-prayers page, and on the docket pages themselves, but let's get this merged and then we can play with that with some feedback from others.

[ERosendo]

@mlissner @v-anne Here's a little enhancement to the button:

@mlissner I created the flag using the admin panel. I'll add one last commit and then merge this PR

[mlissner]

I revered this PR in #4582 to fix #4581. No idea what was going on, but reverting fixed it. Let's see if we can figure that out, get a fix, and then do another PR.

[v-anne]

That's disappointing, but we'll figure it out.

Mike, do you know if this PR also created issues with the RECAP extension? On PACER I no longer see the button to save a document to CourtListener.

[ERosendo]

Sorry @v-anne :( .

@mlissner I found the issue. In commit 09a9dd7, I added HTMX by updating the footer-scripts section of one of the templates we use on the docket page. However, I overlooked that this template extends from another HTML file that already includes scripts. As a result, my code overwrote the scripts section of the parent template, causing the issue described in #4581.

To avoid this conflict, we should simply include the pay_and_pray.js file directly in the parent template, which is the file named docket_tabs.html.

[mlissner]

I thought it would be something like that, thanks.

I don't think this would also affect the extension, but we could open a new issue if needed for that.