Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: updating sso orchestrator self service api endpoints #1912

Merged

Conversation

alex-sheehan-edx
Copy link
Contributor

  1. make sure creates a rolled back when the orchestrator responds immediately with a failure
  2. allow the oauth complete endpoint to accept failures
  3. unlock configs that have failed configuration

Merge checklist:

  • Any new requirements are in the right place (do not manually modify the requirements/*.txt files)
    • base.in if needed in production but edx-platform doesn't install it
    • test-master.in if edx-platform pins it, with a matching version
    • make upgrade && make requirements have been run to regenerate requirements
  • make static has been run to update webpack bundling if any static content was updated
  • ./manage.py makemigrations has been run
    • Checkout the Database Migration Confluence page for helpful tips on creating migrations.
    • Note: This must be run if you modified any models.
      • It may or may not make a migration depending on exactly what you modified, but it should still be run.
    • This should be run from either a venv with all the lms/edx-enterprise requirements installed or if you checked out edx-enterprise into the src directory used by lms, you can run this command through an lms shell.
      • It would be ./manage.py lms makemigrations in the shell.
  • Version bumped
  • Changelog record added
  • Translations updated (see docs/internationalization.rst but also this isn't blocking for merge atm)

Post merge:

  • Tag pushed and a new version released
    • Note: Assets will be added automatically. You just need to provide a tag (should match your version number) and title and description.
  • After versioned build finishes in GitHub Actions, verify version has been pushed to PyPI
    • Each step in the release build has a condition flag that checks if the rest of the steps are done and if so will deploy to PyPi.
      (so basically once your build finishes, after maybe a minute you should see the new version in PyPi automatically (on refresh))
  • PR created in edx-platform to upgrade dependencies (including edx-enterprise)
    • This must be done after the version is visible in PyPi as make upgrade in edx-platform will look for the latest version in PyPi.
    • Note: the edx-enterprise constraint in edx-platform must also be bumped to the latest version in PyPi.

)
sso_configuration_record.errored_at = localized_utcnow()
sso_configuration_record.save()
return Response(status=HTTP_200_OK)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are we returning 200 success for an error state?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Discussed, our system isn't failing here it's properly receiving the cancellation request from the orchestrator. I also don't want to blow up the orchestrator by returning a 400+ status code when our system did what it's supposed to

@alex-sheehan-edx alex-sheehan-edx force-pushed the asheehan-edx/updates-to-sso-self-service-api branch 3 times, most recently from 31e267b to 5473301 Compare October 13, 2023 16:17
@alex-sheehan-edx alex-sheehan-edx force-pushed the asheehan-edx/updates-to-sso-self-service-api branch from 5473301 to da5ddc2 Compare October 13, 2023 16:22
@alex-sheehan-edx alex-sheehan-edx merged commit 214aad4 into master Oct 13, 2023
7 checks passed
@alex-sheehan-edx alex-sheehan-edx deleted the asheehan-edx/updates-to-sso-self-service-api branch October 13, 2023 17:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants