edx-enterprise
edx-enterprise copied to clipboard
feat: create cea for invite only courses before checkout
Description
This allows enterprise learners whose enterprise catalog contains private "invitation only" courses to enroll without having to be explicitly invited.
This adds a new flag to the EnterpriseCustomer
models called allow_enrollment_in_invite_only_courses
. Once this is enabled, the enrollment POST request will check if the course is "invite-only" and create a CourseEnrollmentAllowed
object in the platform if required.
Testing instructions
The following instruction assume you are using the devstack setup for testing.
- In a working edx-enterprise setup, add a course which is "invite-only" to the catalog, or change an existing course in the catalog to "Invitation Only". This can be done by going to the "Advanced Settings" in Studio and setting the "Invitation Only" field to
true
. - Get the enrollment_url of the course - Usually something like this
http://localhost:18000/enterprise/<enterprise-id>/course/<course-key>/enroll/?catalog=<catalog-id>&utm_medium=enterprise&utm_source=test-enterprise
. This should be obtainable from the enterprise API{{base_url}}/enterprise/api/v1/enterprise_catalogs/{{catalog_id}}/
- On the page, try to enroll for the course - this should do the necessary redirects, but show the an error message in the course page. Something like "You need to be enrolled to see this course content".
- Checkout the PR branch
- Install the PR branch
make lms-shell && pip install -e /edx/src/edx-enterprise
- Apply the migrations
python manage.py lms migrate
- Go to the Enterprise Customer admin page
- Check the checkbox for Allow Enrollment in Invite Only Courses
- Now visit the enrollment URL as a different user and perform enrollment. The enrollment should happen and the learner should have access to the course content.
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 - [x]
./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.
- It would be
- [ ] 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.
- This must be done after the version is visible in PyPi as
Thanks for the pull request, @tecoholic! Please note that it may take us up to several weeks or months to complete a review and merge your PR.
Feel free to add as much of the following information to the ticket as you can:
- supporting documentation
- Open edX discussion forum threads
- timeline information ("this must be merged by XX date", and why that is)
- partner information ("this is a course on edx.org")
- any other information that can help Product understand the context for the PR
All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.
Please let us know once your PR is ready for our review and all tests are green.
Hi @tecoholic! Is this ready for review?
@mphilbrick211 Yes. It is. However, I am considering creating a issue/proposal collecting a couple of other related PRs and submitted them all together for a someone on the project team to take a look. So, we can take it a bit slow if needed.
@mphilbrick211 Yes. It is. However, I am considering creating a issue/proposal collecting a couple of other related PRs and submitted them all together for a someone on the project team to take a look. So, we can take it a bit slow if needed.
Gotcha. Sounds good. I'll check back in, or just ping me when you're all set!
@mphilbrick211 when we have an indication of timing of the review, we need to ask @tecoholic to rebase the branch.
Hi @openedx/enterprise-titans! Would someone be able to please review/merge this for us?
CC: @tecoholic
Hi @tecoholic! Looks like some branch conflicts have popped up - would you mind having a look?
Hi @openedx/enterprise-titans! Just checking in to see if someone is able to review/merge this for us? If so, we'll resolve the branch conflicts to proceed. Thanks!
Hi @openedx/enterprise-titans! Just checking in to see if someone is able to review/merge this for us? If so, we'll resolve the branch conflicts to proceed. Thanks!
Checking in on this @openedx/enterprise-titans
@openedx/enterprise-titans The PR has been rebased on master and the DB migration updated to the latest version. Kindly review.
cc: @e0d
Hi @openedx/2u-titans! If you're still reviewing pull requests, would you please be able to review / merge this for us? Thanks!