auto delete interviews on withdrawal (WD-7721)

[nathanclairmonte]

Done

• Added Google Calendar API class
  • Class taken from the interview scheduler repo
  • Added a delete_event_from_interview_calendar() function which as you might guess deletes an interview from the interview calendar (the interview calendar is the shared calendar on which all interviews are scheduled)
  • Also added sendUpdates="all" to the delete request itself. This ensures a notification is sent to all attendees of the meeting telling them that it was canceled. The old parameter for this was sendNotifications (a boolean), but that has since been deprecated.
• Updated the email sent to the hiring lead when a candidate withdraws. Before, it explicitly told them to look for any pending interviews and delete them, but now this isn't necessary anymore since it will happen automatically.
• Created a new template for the email that will be sent to each interviewer letting them know that their interview was canceled because the candidate withdrew their application.
• Added debug mode functionality to the main /templates/application/withdrawal.html template (which is displayed once the candidate withdrawal is confirmed) to display the emails that would have been sent to the interviewers if not in debug mode.
• Implemented the actual interview auto-deletion flow:
  • When the candidate clicks on the confirmation link they received in their email to confirm their withdrawal, the application_withdrawal() (line 465 in /webapp/application.py) function is called.
  • Inside this function, we pull all the scheduled interviews for the current application from the Harvest API and filter for the ones with a status of scheduled (the other options for this status are complete and awaiting_feedback, both of which indicate that the interview has already happened and thus does not need to be deleted).
  • We loop through this list of scheduled interviews, grab the interviewer info and their timezone, format the interview date/time to match the interviewers timezone (so that the email they receive shows the correct time for them), delete the interview, and then create the email to alert the interviewer of the cancelation.
  • Each cancelation interview is saved in an array so that we can display them all in debug mode.
  • UPDATE: We are now also pulling the interviews with a status of awaiting_feedback so that we can alert those interviewers that a scorecard submission is no longer necessary. These interview events are not deleted however, as they will have already passed.

QA

Prep

• Add SERVICE_ACCOUNT_EMAIL and SERVICE_ACCOUNT_PRIVATE_KEY to .env.local (for Google Calendar API)
• Create a test candidate on GH for the "Dev - test 1" job. Make sure to input your email address (or one you have access to) since it will be needed to set the candidate's availabilities
• Move the test candidate to the "Early Stage Interviews" stage.
• Add yourself as a default interviewer for this candidate.
• Input candidate availabilities via email specifically. I.e. click "Request Availability", send the email, fill out the form received in email.
• Wait for main interview-scheduler cronjob to run (it runs every 4 hours) or run the test-scheduler cronjob, then an interview should be scheduled.
  • NB: I also have a local script that can schedule these interviews the same way the interview-scheduler does, so if you aren't getting one scheduled when it runs (this can happen sometimes if it just doesn't find one to schedule) or if it's just taking too long, let me know and I can manually schedule a test interview for you.
• Make sure the interview actually shows up in GH, otherwise it won't show up in the scheduled interviews returned from the Harvest API.
• Once there is a scheduled interview in GH, you can move on to the steps below to run the site and test the deletion process.

Testing the auto-deletion flow

• Check out this feature branch
• Run the site with dotrun
• View the site locally in your web browser at: http://localhost:8002/
• Navigate to the test candidate's candidate page (you can get the candidate page URL from the https://harvest.greenhouse.io/v1/applications/{{application_id}} endpoint on the Harvest API)
• Click the withdraw button, enter the email you put as the candidate's email, select any reason and click submit
• On the subsequent page, you should see a debug message along with the withdrawal confirmation email that would have been sent to the candidate. Click that link to confirm the withdrawal.
• This should reject the candidate on GH, delete any upcoming interviews, and then render the /templates/application/withdrawal.html template, which should have the email(s) that would've been sent to the interviewer(s).

(btw, let me know if this is too long! I tried to be as like thorough as possible with the QA steps)

Issue / Card

WD-7721

Screenshots

[if relevant, include a screenshot]

[webteam-app]

Demo starting at https://canonical-com-1188.demos.haus

[codecov[bot]]

Codecov Report

Attention: Patch coverage is 93.84615% with 8 lines in your changes are missing coverage. Please review.

Project coverage is 71.45%. Comparing base (b62710c) to head (5824420). Report is 38 commits behind head on main.

Files	Patch %	Lines
webapp/application.py	85.18%	4 Missing :warning:
webapp/google_calendar.py	91.66%	2 Missing :warning:
tests/test_application.py	97.87%	1 Missing :warning:
tests/test_google_calendar.py	96.87%	1 Missing :warning:

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #1188 +/- ## ========================================== + Coverage 66.55% 71.45% +4.90% ========================================== Files 10 12 +2 Lines 891 1023 +132 ========================================== + Hits 593 731 +138 + Misses 298 292 -6 ``` | [Flag](https://app.codecov.io/gh/canonical/canonical.com/pull/1188/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=canonical) | Coverage Δ | | |---|---|---| | [python](https://app.codecov.io/gh/canonical/canonical.com/pull/1188/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=canonical) | `71.45% <93.84%> (+4.90%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=canonical#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

[carkod]

Just a note that we usually follow on Sites, would be nice not to have all those commits that are not useful like "Fix lint", "Cleanup print statements", they don't provide any value to the Git history. But I can see the PR is becoming too large to pick out those commits, just so you know in the future, you could do a git commit --amend to put it in the previous commit. Thanks

[nathanclairmonte]

@carkod Thank you for the info and suggestions! I wasn't aware of this git command, will utilise it in future.

I've also addressed the import organization in google_calendar.py and the commented-out line in _withdrawal_notification-email.html.

Thanks again 🙏