Story #90, #91 Email Bug Fixes | User and Technical Documentation - cseseniordesign/reservations GitHub Wiki

End User Documentation

Dev Testing Instructions

  1. Make sure you are on the most recent version of the dev-email-bug-fixes branch.
  2. Start your dev environment and go to the /home/ route before logging in. The page should redirect you to the login instead of throwing an error.
  3. Log into development 2 and go to the Admin -> Users page. Search for users with the first name "Email". Change the email of the Email Tester user who has the huskers email to your huskers email.
  4. Go to line 155 in routes/admin/emails.rb and change the email to your email so that you get the email to notify you of the invalid emails.
  5. Go to the Admin -> Emails page and click compose.
  6. Send a test email to all users. You should get an email sent to your email for the Email Tester user and you should get a second email showing the invalid email tester user. Don't worry about actually sending emails to all users there is testing logic in place to only send emails to users whos username contains "emailtest".
  7. Ensure there are no errors in the console throughout your testing and that the page is still responsive on all screen sizes.

Technical Documentation

README.md

  • Added instructions for discovering and killing extra automated email processes.

config.ru

  • Uncommented logic to start automated emails.

routes/admin/emails.rb

  • Added logic to make sure that all emails that are being sent to have ascii characters. If some are found with nonascii characters then they are skipped and compiled to be sent to the admins so they know who has invalid emails.

routes/home.rb

  • Added a check to make sure the user is not null to prevent a bug when loading the home page when not logged in.

views/admin/send_email.rb

  • Increased the length of the subject input.