Skip to content

Commit 129e6e9

Browse files
weekliesweeklies
authored
AO3-6712 Allow invites to be resent and index invitee_email (otwcode#4791)
* AO3-6712 Revert AO3-6666 This reverts commit 7e15f32. * AO3-6712 Add invitee email index to invitations * AO3-6712 Make sure button has hover style and i18n * AO3-6712 Normalize * AO3-6712 Fix a mistake * AO3-6712 Fix step that was looking for value instead of label text
1 parent 25865ac commit 129e6e9

18 files changed

+274
-47
lines changed

‎app/controllers/invite_requests_controller.rb

+27-4
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,40 @@ def index
1111
# GET /invite_requests/1
1212
def show
1313
@invite_request = InviteRequest.find_by(email: params[:email])
14-
@position_in_queue = @invite_request.position if @invite_request.present?
15-
unless (request.xml_http_request?) || @invite_request
16-
flash[:error] = "You can search for the email address you signed up with below. If you can't find it, your invitation may have already been emailed to that address; please check your email spam folder as your spam filters may have placed it there."
17-
redirect_to status_invite_requests_path and return
14+
15+
if @invite_request.present?
16+
@position_in_queue = @invite_request.position
17+
else
18+
@invitation = Invitation.unredeemed.from_queue.find_by(invitee_email: params[:email])
1819
end
20+
1921
respond_to do |format|
2022
format.html
2123
format.js
2224
end
2325
end
2426

27+
def resend
28+
@invitation = Invitation.unredeemed.from_queue.find_by(invitee_email: params[:email])
29+
30+
if @invitation.nil?
31+
flash[:error] = t("invite_requests.resend.not_found")
32+
elsif !@invitation.can_resend?
33+
flash[:error] = t("invite_requests.resend.not_yet",
34+
count: ArchiveConfig.HOURS_BEFORE_RESEND_INVITATION)
35+
else
36+
@invitation.send_and_set_date(resend: true)
37+
38+
if @invitation.errors.any?
39+
flash[:error] = @invitation.errors.full_messages.first
40+
else
41+
flash[:notice] = t("invite_requests.resend.success", email: @invitation.invitee_email)
42+
end
43+
end
44+
45+
redirect_to status_invite_requests_path
46+
end
47+
2548
# POST /invite_requests
2649
def create
2750
unless AdminSetting.current.invite_from_queue_enabled?

‎app/models/invitation.rb

+33-21
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,10 @@ def recipient_is_not_registered
1919
scope :unsent, -> { where(invitee_email: nil, redeemed_at: nil) }
2020
scope :unredeemed, -> { where('invitee_email IS NOT NULL and redeemed_at IS NULL') }
2121
scope :redeemed, -> { where('redeemed_at IS NOT NULL') }
22+
scope :from_queue, -> { where(external_author: nil).where(creator_type: [nil, "Admin"]) }
2223

2324
before_validation :generate_token, on: :create
24-
after_save :send_and_set_date
25+
after_save :send_and_set_date, if: :saved_change_to_invitee_email?
2526
after_save :adjust_user_invite_status
2627

2728
#Create a certain number of invitations for all valid users
@@ -58,30 +59,41 @@ def mark_as_redeemed(user=nil)
5859
save
5960
end
6061

61-
private
62+
def send_and_set_date(resend: false)
63+
return if invitee_email.blank?
6264

63-
def generate_token
64-
self.token = Digest::SHA1.hexdigest([Time.now, rand].join)
65+
if self.external_author
66+
archivist = self.external_author.external_creatorships.collect(&:archivist).collect(&:login).uniq.join(", ")
67+
# send invite synchronously for now -- this should now work delayed but just to be safe
68+
UserMailer.invitation_to_claim(self.id, archivist).deliver_now
69+
else
70+
# send invitations actively sent by a user synchronously to avoid delays
71+
UserMailer.invitation(self.id).deliver_now
72+
end
73+
74+
# Skip callbacks within after_save by using update_column to avoid a callback loop
75+
if resend
76+
attrs = { resent_at: Time.current }
77+
# This applies to old invites when AO3-6094 wasn't fixed.
78+
attrs[:sent_at] = self.created_at if self.sent_at.nil?
79+
self.update_columns(attrs)
80+
else
81+
self.update_column(:sent_at, Time.current)
82+
end
83+
rescue StandardError => e
84+
errors.add(:base, :notification_could_not_be_sent, error: e.message)
6585
end
6686

67-
def send_and_set_date
68-
if self.saved_change_to_invitee_email? && !self.invitee_email.blank?
69-
begin
70-
if self.external_author
71-
archivist = self.external_author.external_creatorships.collect(&:archivist).collect(&:login).uniq.join(", ")
72-
# send invite synchronously for now -- this should now work delayed but just to be safe
73-
UserMailer.invitation_to_claim(self.id, archivist).deliver_now
74-
else
75-
# send invitations actively sent by a user synchronously to avoid delays
76-
UserMailer.invitation(self.id).deliver_now
77-
end
87+
def can_resend?
88+
# created_at fallback is a vestige of the already fixed AO3-6094.
89+
checked_date = self.resent_at || self.sent_at || self.created_at
90+
checked_date < ArchiveConfig.HOURS_BEFORE_RESEND_INVITATION.hours.ago
91+
end
7892

79-
# Skip callbacks within after_save by using update_column to avoid a callback loop
80-
self.update_column(:sent_at, Time.now)
81-
rescue Exception => exception
82-
errors.add(:base, "Notification email could not be sent: #{exception.message}")
83-
end
84-
end
93+
private
94+
95+
def generate_token
96+
self.token = Digest::SHA1.hexdigest([Time.current, rand].join)
8597
end
8698

8799
#Update the user's out_of_invites status

‎app/views/invitations/_invitation.html.erb

+2
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@
2424
<dd><%= invitation.created_at %></dd>
2525
<dt>Sent at</dt>
2626
<dd><%= invitation.sent_at %></dd>
27+
<dt>Last resent at</dt>
28+
<dd><%= invitation.resent_at %></dd>
2729
<dt>Redeemed at</dt>
2830
<dd><%= invitation.redeemed_at %></dd>
2931
</dl>

‎app/views/invite_requests/_invitation.html.erb

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<!--Descriptive page name, messages and instructions-->
2+
<h2 class="heading" id="invite-heading">
3+
<%= t(".title", email: invitation.invitee_email) %>
4+
</h2>
5+
<!--/descriptions-->
6+
7+
<!--main content-->
8+
<p>
9+
<% status = invitation.resent_at ? "resent" : "not_resent" %>
10+
<%= t(".info.#{status}",
11+
sent_at: l((invitation.sent_at || invitation.created_at).to_date),
12+
resent_at: invitation.resent_at ? l(invitation.resent_at.to_date) : nil) %>
13+
</p>
14+
15+
<p>
16+
<% if invitation.can_resend? %>
17+
<%# i18n-tasks-use t("invite_requests.invitation.after_cooldown_period.not_resent")
18+
i18n-tasks-use t("invite_requests.invitation.after_cooldown_period.resent_html")-%>
19+
<% status = invitation.resent_at ? "resent_html" : "not_resent" %>
20+
<%= t(".after_cooldown_period.#{status}",
21+
count: ArchiveConfig.HOURS_BEFORE_RESEND_INVITATION,
22+
contact_support_link: link_to(t(".contact_support"), new_feedback_report_path)) %>
23+
<%= button_to t(".resend_button"), resend_invite_requests_path(email: invitation.invitee_email) %>
24+
<% else %>
25+
<%= t(".before_cooldown_period", count: ArchiveConfig.HOURS_BEFORE_RESEND_INVITATION) %>
26+
<% end %>
27+
</p>
28+
<!--/content-->

‎app/views/invite_requests/_no_invitation.html.erb

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<p class="notice">
2+
<%= t(".email_not_found") %>
3+
</p>

‎app/views/invite_requests/show.html.erb

+8-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
1-
<%= render "invite_request", invite_request: @invite_request %>
1+
<% if @invite_request %>
2+
<%= render "invite_request", invite_request: @invite_request %>
3+
<% elsif @invitation %>
4+
<%= render "invitation", invitation: @invitation %>
5+
<% else %>
6+
<%= render "no_invitation" %>
7+
<% end %>
28

39
<p>
4-
<%= ts("To check on the status of your invitation, go to the %{status_page} and enter your email in the space provided!", status_page: link_to("Invitation Request Status page", status_invite_requests_path)).html_safe %>
10+
<%= t(".instructions_html", status_link: link_to("Invitation Request Status page", status_invite_requests_path)) %>
511
</p>

‎app/views/invite_requests/show.js.erb

+10-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
<% if @invite_request %>
22
$j("#invite-status").html("<%= escape_javascript(render "invite_requests/invite_request", invite_request: @invite_request) %>");
3+
<% elsif @invitation %>
4+
$j("#invite-status").html("<%= escape_javascript(render "invitation", invitation: @invitation) %>");
5+
6+
<%# Correct heading size for JavaScript display %>
7+
$j(document).ready(function(){
8+
$j('#invite-heading').replaceWith(function () {
9+
return '<h3 class="heading">' + $j(this).html() + "</h3>";
10+
});
11+
})
312
<% else %>
4-
$j("#invite-status").html("<p>Sorry, we can't find the email address you entered. If you had used it to join our invitation queue, it's possible that your invitation may have already been emailed to you; please check your spam folder, as your spam filters may have placed it there.</p>");
13+
$j("#invite-status").html("<%= escape_javascript(render "no_invitation") %>");
514
<% end %>

‎app/views/invite_requests/status.html.erb

+6-4
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
<!--Descriptive page name, messages and instructions-->
22
<h2 class="heading">
3-
<%= ts("Invitation Request Status") %>
3+
<%= t(".heading") %>
44
</h2>
55

66
<p>
7-
<%= ts("There are currently %{count} people on the waiting list.", count: InviteRequest.count) %>
7+
<%= t(".waiting_list", count: InviteRequest.count) %>
88
<% if AdminSetting.current.invite_from_queue_enabled? %>
9-
<%= ts("We are sending out %{invites} invitations per day.", invites: AdminSetting.current.invite_from_queue_number) %>
9+
<%= t(".send_rate", invites: AdminSetting.current.invite_from_queue_number) %>
1010
<% end %>
1111
</p>
1212
<!--/descriptions-->
@@ -17,7 +17,9 @@
1717
<p>
1818
<%= label_tag :email %>
1919
<%= text_field_tag :email %>
20-
<%= submit_tag ts("Look me up") %>
20+
<span class="submit actions">
21+
<%= submit_tag t(".search") %>
22+
</span>
2123
</p>
2224
</fieldset>
2325
<% end %>

‎config/config.yml

+2
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,8 @@ DELIMITER_FOR_OUTPUT: ', '
8181
INVITE_FROM_QUEUE_ENABLED: true
8282
INVITE_FROM_QUEUE_NUMBER: 10
8383
INVITE_FROM_QUEUE_FREQUENCY: 7
84+
85+
HOURS_BEFORE_RESEND_INVITATION: 24
8486
# this is whether or not people without invitations can create accounts
8587
ACCOUNT_CREATION_ENABLED: false
8688
DAYS_TO_PURGE_UNACTIVATED: 7

‎config/locales/controllers/en.yml

+4
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,10 @@ en:
105105
invite_requests:
106106
index:
107107
page_title: Invitation Requests
108+
resend:
109+
not_found: Could not find an invitation associated with that email.
110+
not_yet: You cannot resend an invitation that was sent in the last %{count} hours.
111+
success: Invitation resent to %{email}.
108112
kudos:
109113
create:
110114
success: Thank you for leaving kudos!

‎config/locales/models/en.yml

+5
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,11 @@ en:
105105
attributes:
106106
user_defined_tags_count:
107107
at_most: must not add up to more than %{count}. You have entered %{value} of these tags, so you must remove %{diff} of them.
108+
invitation:
109+
attributes:
110+
base:
111+
format: "%{message}"
112+
notification_could_not_be_sent: 'Notification email could not be sent: %{error}'
108113
kudo:
109114
attributes:
110115
commentable:

‎config/locales/views/en.yml

+28
Original file line numberDiff line numberDiff line change
@@ -1400,10 +1400,38 @@ en:
14001400
waiting_list_count:
14011401
one: There is currently %{count} person on the waiting list.
14021402
other: There are currently %{count} people on the waiting list.
1403+
invitation:
1404+
after_cooldown_period:
1405+
not_resent:
1406+
one: Because your invitation was sent more than an hour ago, you can have your invitation resent.
1407+
other: Because your invitation was sent more than %{count} hours ago, you can have your invitation resent.
1408+
resent_html:
1409+
one: Because your invitation was resent more than an hour ago, you can have your invitation resent again, or you may want to %{contact_support_link}.
1410+
other: Because your invitation was resent more than %{count} hours ago, you can have your invitation resent again, or you may want to %{contact_support_link}.
1411+
before_cooldown_period:
1412+
one: If it has been more than an hour since you should have received your invitation, but you have not received it after checking your spam folder, you can visit this page to resend the invitation.
1413+
other: If it has been more than %{count} hours since you should have received your invitation, but you have not received it after checking your spam folder, you can visit this page to resend the invitation.
1414+
contact_support: contact Support
1415+
info:
1416+
not_resent: Your invitation was emailed to this address on %{sent_at}. If you can't find it, please check your email spam folder as your spam filters may have placed it there.
1417+
resent: Your invitation was emailed to this address on %{sent_at} and resent on %{resent_at}. If you can't find it, please check your email spam folder as your spam filters may have placed it there.
1418+
resend_button: Resend Invitation
1419+
title: Invitation Status for %{email}
14031420
invite_request:
14041421
date: 'At our current rate, you should receive an invitation on or around: %{date}.'
14051422
position_html: You are currently number %{position} on our waiting list!
14061423
title: Invitation Status for %{email}
1424+
no_invitation:
1425+
email_not_found: Sorry, we can't find the email address you entered.
1426+
show:
1427+
instructions_html: To check on the status of your invitation, go to the %{status_link} and enter your email in the space provided.
1428+
status:
1429+
heading: Invitation Request Status
1430+
search: Look me up
1431+
send_rate: We are sending out %{invites} invitations per day.
1432+
waiting_list:
1433+
one: There is currently %{count} person on the waiting list.
1434+
other: There are currently %{count} people on the waiting list.
14071435
kudos:
14081436
guest_header:
14091437
one: "%{count} guest has also left kudos"

‎config/routes.rb

+1
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@
8080
collection do
8181
get :manage
8282
get :status
83+
post :resend
8384
end
8485
end
8586

‎db/migrate/20231027172035_add_resent_at_to_invitations.rb

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
class AddResentAtToInvitations < ActiveRecord::Migration[6.1]
2+
uses_departure! if Rails.env.staging? || Rails.env.production?
3+
4+
def change
5+
add_column :invitations, :resent_at, :datetime
6+
end
7+
end

‎db/migrate/20240415202120_add_index_to_invitations.rb

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
class AddIndexToInvitations < ActiveRecord::Migration[6.1]
2+
uses_departure! if Rails.env.staging? || Rails.env.production?
3+
4+
def change
5+
add_index :invitations, :invitee_email
6+
end
7+
end

‎features/other_a/invite_queue.feature

+28-2
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Feature: Invite queue management
5757
# check your place in the queue - invalid address
5858
When I check how long "[email protected]" will have to wait in the invite request queue
5959
Then I should see "Invitation Request Status"
60-
And I should see "If you can't find it, your invitation may have already been emailed to that address; please check your email spam folder as your spam filters may have placed it there."
60+
And I should see "Sorry, we can't find the email address you entered."
6161
And I should not see "You are currently number"
6262

6363
# check your place in the queue - correct address
@@ -98,7 +98,7 @@ Feature: Invite queue management
9898
Then 1 email should be delivered to test@archiveofourown.org
9999
When I check how long "[email protected]" will have to wait in the invite request queue
100100
Then I should see "Invitation Request Status"
101-
And I should see "If you can't find it, your invitation may have already been emailed to that address;"
101+
And I should see "If you can't find it, please check your email spam folder as your spam filters may have placed it there."
102102

103103
# invite can be used
104104
When I am logged in as an admin
@@ -155,3 +155,29 @@ Feature: Invite queue management
155155
And I fill in "invite_request_email" with "[email protected]"
156156
And I press "Add me to the list"
157157
Then I should see "Email is already being used by an account holder."
158+
159+
Scenario: Users can resend their invitation after enough time has passed
160+
Given account creation is enabled
161+
And the invitation queue is enabled
162+
And account creation requires an invitation
163+
And the invite_from_queue_at is yesterday
164+
And an invitation request for "[email protected]"
165+
When the scheduled check_invite_queue job is run
166+
Then 1 email should be delivered to invitee@example.org
167+
168+
When I check how long "[email protected]" will have to wait in the invite request queue
169+
Then I should see "Invitation Request Status"
170+
And I should see "If you can't find it, please check your email spam folder as your spam filters may have placed it there."
171+
And I should not see "Because your invitation was sent more than 24 hours ago, you can have your invitation resent."
172+
And I should not see "Resend Invitation"
173+
174+
When all emails have been delivered
175+
And it is currently 25 hours from now
176+
And I check how long "[email protected]" will have to wait in the invite request queue
177+
Then I should see "Invitation Request Status"
178+
And I should see "If you can't find it, please check your email spam folder as your spam filters may have placed it there."
179+
And I should see "Because your invitation was sent more than 24 hours ago, you can have your invitation resent."
180+
And I should see "Resend Invitation"
181+
182+
When I press "Resend Invitation"
183+
Then 1 email should be delivered to invitee@example.org

0 commit comments

Comments
 (0)