AO3-6308 fix user suspension end time

[Cesium-Ice]

Pull Request Checklist

• Have you read "How to write the perfect pull request"?
• Have you read the contributing guidelines?
• Have you added tests for any changed functionality?
• Have you added the Jira issue number
  as the first thing in your pull request title (e.g. AO3-1234 Fix thing)
• Do you have fewer than 5 pull requests already open? If not, please wait
  until they are reviewed and merged before creating new pull requests.

Issue

https://otwarchive.atlassian.net/browse/AO3-6308

Purpose

What does this PR do?
Fix incorrect time for the end of a user's suspension

Testing Instructions

How can the Archive's QA team verify that this is working as you intended?

If you have a Jira account with access, please update or comment on the issue
with any new or missing testing instructions instead.

References

Are there other relevant issues/pull requests/mailing list discussions?

Credit

What name and pronouns should we use to credit you in the Archive of Our Own's Release Notes?
Cesium-Ice, they/them

If you have a Jira account, please include the same name in the "Full name"
field on your Jira profile, so we can assign you the issues you're working on.

Please note that if you do not fill in this section, we will use your GitHub account name and
they/them pronouns.

[brianjaustin]

It could be helpful to extend any tests we have that involve this function to include one where the date changes because of the threshold. I think we already have some unit tests for banning, but maybe not in an application_controller_spec.rb

[brianjaustin]

We're trying to avoid HTML in translation strings when possible; could you update the string here to use a variable (like "%{abuse_link}") and the link_to method? The code in https://github.com/otwcode/otwarchive/blob/master/app/controllers/users/passwords_controller.rb#L11 does something similar

[Cesium-Ice]

I've edited line 441 to be like so

flash[:error] = t(".users.status.suspension_notice", suspended_until: localized_suspension_end, contact_abuse_link: view_context.link_to(t(".contact_abuse"), new_abuse_report_path)).html_safe

and added the following to en.yml:

status:
      ban_notice: Your account has been banned. You are not permitted to add or edit archive content. Please %{contact_abuse_link} for more information.
      suspension_notice: Your account has been suspended until %{suspended_until}. You may not add or edit content until your suspension has been resolved. Please %{contact_abuse_link} for more information.

[Cesium-Ice]

However I still get missing translations and unused key errors, so something is wrong with the link between the controller and the translation file. Do you know what I'm doing wrong?

[brianjaustin]

It looks like the test is expecting the following absolute/fully-qualified keys

+--------+----------------------------------------------------+--------------------------------------------------------+
| Locale | Key                                                | Value in other locales or source                       |
+--------+----------------------------------------------------+--------------------------------------------------------+
|   en   | application.check_user_not_suspended.contact_abuse | app/controllers/application_controller.rb:423          |
|   en   | application.check_user_status.contact_abuse        | app/controllers/application_controller.rb:401 (1 more) |
+--------+----------------------------------------------------+--------------------------------------------------------+

If you wanted to use a key like

otwarchive/config/locales/controllers/en.yml

Line 93 in ea83a19

contact_abuse: contact Policy & Abuse

, it would need to be absolute (users.passwords.create.contact_abuse) -- although I would recommend extracting that key to a common location if it's used in multiple controllers

[weeklies]

It would be helpful to add a test?

[Bilka2]

I would be nice to have the key end in _html so that the html_safe call isn't needed:

Suggested change

	flash[:error] = t("users.status.suspension_notice", suspended_until: localized_suspension_end, contact_abuse_link: view_context.link_to(t("users.contact_abuse"), new_abuse_report_path)).html_safe
	flash[:error] = t("users.status.suspension_notice_html", suspended_until: localized_suspension_end, contact_abuse_link: view_context.link_to(t("users.contact_abuse"), new_abuse_report_path))

This also needs a change in the locale file. Same applies to the other t() calls.

[Bilka2]

Update: This change was done in 61a4f52 with some other work. So you should merge the master branch into your branch to get the updated locale key and locale files.

Actions identified by weeklies and Bilka2

[Bilka2]

Please add a test, thank you!

[Cesium-Ice]

Please add a test, thank you!

Is there already a _spec file defined that tests things in application_controller.rb? I can't seem to find one.

[Cesium-Ice]

If I edit the file user_manager.rb and change the function suspend_user like so

def suspend_user
    user.suspended = true
    user.suspended_until = suspension_length.to_i.days.from_now
    suspension_end = user.suspended_until
    # Unban threshold is 6:51pm, 12 hours after the unsuspend_users rake task located in schedule.rb is run at 6:51am
    unban_theshold = DateTime.new(suspension_end.year, suspension_end.month, suspension_end.day, 18, 51, 0, "+00:00") 
    # If the stated suspension end date is after the unban threshold we need to advance a day 
    user.suspended_until = DateTime.new(suspension_end.year, suspension_end.month, suspension_end.day, 0, 0, 0, "+00:00").next_day(1) if suspension_end > unban_theshold
    user.save!
    log_action(ArchiveConfig.ACTION_SUSPEND, enddate: user.suspended_until)
    successes << "User has been temporarily suspended."
  end

then I know how to test this change, but did you want the fix to the user suspension end time to be a thing that is only shown to users?

[Bilka2]

The fix should only be in the message for the user, as it is right now.

You can test the user message by making a cucumber scenario where a suspended user logs in and tries to access the "new work" page. They should get redirected to their dashboard and see the flash message about being suspended. It will probably be helpful to have a known current date and time in the test by using a step like Given it is currently 2015-09-21 09:40 AM. I'd put this test into a new file in features/users for user suspensions and bans.

[Bilka2]

Thank you very much!

[Bilka2]

Apologies for coming back to this after already approving, but I had some discussion with the Translation team:

It would be nice if reset_blocked_html would continue to use a different locale key for the policy and abuse link text than the status texts. That allows translators to translate the link differently in context, since the sentence in reset_blocked is different than the one used in suspension_notice_html and ban_notice_html.

Suggested change

	flash[:error] = t(".reset_blocked_html", contact_abuse_link: view_context.link_to(t("users.contact_abuse"), new_abuse_report_path))
	flash[:error] = t(".reset_blocked_html", contact_abuse_link: view_context.link_to(t(".contact_abuse"), new_abuse_report_path))

[Cesium-Ice]

done

[Bilka2]

Thank you for bearing with me!

I left some more code suggestions, but they're completely optional because they only change the formatting of the dates. So I already flipped the PR label to ready to merge.