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.

Sign up for GitHub

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

Jump to bottom

feat: add marked_authorized flag to SSO config #1951

Merged
merged 1 commit into from
Dec 5, 2023
Merged

feat: add marked_authorized flag to SSO config #1951

merged 1 commit into from
Dec 5, 2023

Conversation

marlonkeating
Copy link
Contributor

@marlonkeating marlonkeating commented Nov 28, 2023 •
edited
Loading

Jira Ticket

TODO

  • Error "Field 'marked_authorized' doesn't have a default value"
  • Bump version

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.

alex-sheehan-edx
alex-sheehan-edx reviewed Nov 28, 2023
View reviewed changes
Copy link
Contributor

@alex-sheehan-edx alex-sheehan-edx left a comment

Choose a reason for hiding this comment

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

You're going to want to backfill the data for existing records since this is null and blank false. Otherwise looks good to me :)

alex-sheehan-edx
alex-sheehan-edx reviewed Nov 28, 2023
View reviewed changes
enterprise/models.py Outdated
null=False,
default=False,
help_text=_(
"If the edX Service Provider metadata was authorized from the Identity Provider side."
Copy link
Contributor

Choose a reason for hiding this comment

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

maybe make a comment that it's the admin indicating the service provider metadata was uploaded- it's come back to bite us in the past when the admin mindlessly checks the box and doesn't actually do the thing we're asking and we don't want to confuse any devs/ecs that the actions been done... more so that they TOLD us it was done lol

alex-sheehan-edx
alex-sheehan-edx reviewed Dec 4, 2023
View reviewed changes
enterprise/migrations/0197_auto_20231130_2239.py
migrations.AlterField(
model_name='enterprisecustomerssoconfiguration',
name='marked_authorized',
field=models.BooleanField(default=False, help_text='Whether admin has indicated the service provider metadata was uploaded.'),
Copy link
Contributor

Choose a reason for hiding this comment

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

huh I would have thought you needed to specify the blank/null values in the migration... I guess that's an ORM level thing and not a DB level thing? 🤔 I should really know this 😂

Copy link
Contributor

Choose a reason for hiding this comment

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

uhh scratch that.. you do it need it... what is this migration doing?

Copy link
Contributor

@alex-sheehan-edx alex-sheehan-edx Dec 4, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

I see this is setting the default value- I think this can go on the original migration file? 0195 I think this is a relic of the spelling change on the help text that we looked at earlier? When we removed the other file, we removed the setting of blank/null to false (from the looks of it?) I'd make sure those values are getting set in your final migration file

@marlonkeating marlonkeating marked this pull request as ready for review December 5, 2023 23:09
alex-sheehan-edx
alex-sheehan-edx approved these changes Dec 5, 2023
View reviewed changes
Copy link
Contributor

@alex-sheehan-edx alex-sheehan-edx left a comment

Choose a reason for hiding this comment

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

tested locally, looks great

@alex-sheehan-edx
Copy link
Contributor

of course don't forget version bump/change log etc

@marlonkeating marlonkeating merged commit 908ea59 into master Dec 5, 2023
9 checks passed
@marlonkeating marlonkeating deleted the mkeating/ENT-7990 branch December 5, 2023 23:43
@marlonkeating marlonkeating mentioned this pull request Dec 6, 2023
Merged
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alex-sheehan-edx alex-sheehan-edx alex-sheehan-edx approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@marlonkeating @alex-sheehan-edx