fix: Fix LTI based duplicate email users

[arslanashraf7]

What are the relevant tickets?

https://github.com/mitodl/hq/issues/8853

Description (What does it do?)

• Update the user registration pipeline to handle the duplicate email error when the user was initially created via LTI
• Uses the same retry logic that is already being used for username collision fixing
• Uses feat: add LTI tools for LTI APIs in edX edx-api-client#133 to call the staff token authenticated LTI user fix API
• If the LTI duplicate email is fixed by the edX API in feat: Add LTI utilities app (Bad user fix) open-edx-plugins#652, the user registration will be retired

Screenshots (if appropriate):

• Desktop screenshots
• Mobile width screenshots

How can this be tested?

Pre-Reqs

• This will be tested along with feat: Add LTI utilities app (Bad user fix) open-edx-plugins#652 and feat: add LTI tools for LTI APIs in edX edx-api-client#133
• You will need a working MITx Online/edX integration

Testing Steps

• You need to create a scenario where a user is stuck in a duplicate email error, and you can create that scenario by creating a user manually in edX or see testing steps in feat: Add LTI utilities app (Bad user fix) open-edx-plugins#652
• It would be ideal to create multiple users in Open edX with email IDs that you will need to use in MITx Online registration as well:
  • A user that was created via Canvas in Open edX
  • Another user that was created manually in open edX
• Try registering your user in MITx Online with the same emails as you used in the above steps
• Notice that the user that you created in edX via Canvas should automatically get fixed, and the enrollment should start working, a proper social auth should be present in edX social auth entries for this user, and the sync should be successful overall. Also, check that the old user that you created via LTI gets their email changed to something@lti_example.com and the user is moved to the retirement pipeline. The previous social auth entry should be deleted if existed
• Notice that the other user that you created without an LTI user stays in the same dup-email error state

Additional Context

This is part of a Multi PR fix and you will need to set up all three to test this end-to-end with mitodl/open-edx-plugins#652, mitodl/edx-api-client#133

[github-actions]

OpenAPI Changes

Show/hide ## Changes for v0.yaml:

## Changes for v0.yaml:


## Changes for v1.yaml:


## Changes for v2.yaml:

Unexpected changes? Ensure your branch is up-to-date with main (consider rebasing).

[arslanashraf7]

This will be replaced by an actual pin once mitodl/edx-api-client#133 is merged and released.

[rhysyngsun]

One comment on the order of operations

[rhysyngsun]

I think this should go earlier before the username collision handling so we can ideally still try to use the original username

[rhysyngsun]

This has the potential to loop infinitely if the API responds with a 200 response but for some reason the next request still fails with the same error, we should set a flag here that we're retrying and if we hit this block again it should stop trying to create the user.

[arslanashraf7]

This and the operation order change have been incorporated in 4152ba6.

[rhysyngsun]

Unable to run this locally due to this error with the dependency definition:

40.49   - Installing edx-api-client (1.13.0 624c7fe)
41.37
41.37     | Failed to clone https://github.com/mitodl/edx-api-client at '624c7fe864d7f2df487ef6a0d670881ead44e113', verify ref exists on remote.
41.37     |
41.37     | Note: This error arises from interacting with the specified vcs source and is likely not a Poetry issue.
41.37     | This issue could be caused by any of the following;
41.37     |
41.37     | - there are network issues in this environment
41.37     | - the revision (624c7fe864d7f2df487ef6a0d670881ead44e113) you have specified
41.37     |     - was misspelled
41.37     |     - is invalid (must be a sha or symref)
41.37     |     - is not present on remote
41.37     |
41.37     | You can also run your poetry command with -v to see more information.

I tried running poetry lock which usually fixes this kind of thing. I see that the github actions python tests are hitting it too so it's not just my environment.

[arslanashraf7]

Unable to run this locally due to this error with the dependency definition:

I tried running poetry lock which usually fixes this kind of thing. I see that the github actions python tests are hitting it too so it's not just my environment.

I squashed commits in mitodl/edx-api-client#133 and the commit id mismatched, This should be fixed as well.