feat: create cea for invite only courses before checkout #1813

tecoholic · 2023-07-21T13:19:35Z

NOTE The PR has been moved to draft to rework the changes.

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
./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.

Internal Ref

openedx-webhooks · 2023-07-21T13:19:40Z

Thanks for the pull request, @tecoholic!

What's next?

Please work through the following steps to get your changes ready for engineering review:

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
- This process (including the steps you'll need to take) is documented here.
If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

Dependencies

This PR must be merged before / after / at the same time as ...
Blockers

This PR is waiting for OEP-1234 to be accepted.
Timeline information

This PR must be merged by XX date because ...
Partner information

This is for a course on edx.org.
Supporting documentation
Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Update the status of your PR

Your PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently unmaintained.

To get help with finding a technical reviewer, tag the community contributions project manager for this PR in a comment and let them know that your changes are ready for review:

On the right-hand side of the PR, find the Contributions project, click the caret in the top right corner to expand it, and check the "Primary PM" field for the name of your PM.
Find their GitHub handle here.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

The size and impact of the changes that it introduces
The need for product review
Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

mphilbrick211 · 2023-08-02T13:13:37Z

Hi @tecoholic! Is this ready for review?

tecoholic · 2023-08-02T13:17:26Z

@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 · 2023-08-02T15:12:14Z

@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!

Agrendalath

👍

I tested this: checked that the CEA is created
I read through the code
I checked for accessibility issues: n/a
Includes documentation: n/a
I made sure any change in configuration variables is reflected in the corresponding client's configuration-secure repository: n/a

enterprise/utils.py

Agrendalath · 2023-08-02T16:25:30Z

enterprise/utils.py

+    Arguments:
+        course_id (str): ID of the course to allow enrollment
+        email (str): email of the user whose enrollment should be allowed
+        enrollment_api_client (:class:`enterprise.api_client.lms.EnrollmentApiClient`): Enrollment API Client


Tiny nit: wouldn't it be better to move the typing directly to the arguments (line 2313)?

@Agrendalath Probably. But the file doesn't use inline types anywhere and instead uses types in docstrings. So I decided to just follow the convention.

@tecoholic, typing (in its current form) is a relatively recent feature in Python, so most people tend to forget about it. While following the convention is important, we should also be open to introducing apparent improvements. We are already gradually adding the typing to more and more repositories in Open edX. Examples: openedx/edx-platform#32591, openedx/opaque-keys#256.

This is not a blocker here, but something to be aware of.

@Agrendalath Alright, in that case, let this PR be the one to bring in the change. I have added the typing for the utility function introduced in this PR.

enterprise/views.py

e0d · 2023-08-16T20:37:37Z

@mphilbrick211 when we have an indication of timing of the review, we need to ask @tecoholic to rebase the branch.

mphilbrick211 · 2023-08-17T19:16:06Z

Hi @openedx/enterprise-titans! Would someone be able to please review/merge this for us?

CC: @tecoholic

mphilbrick211 · 2023-09-12T14:34:03Z

Hi @tecoholic! Looks like some branch conflicts have popped up - would you mind having a look?

mphilbrick211 · 2023-10-03T02:26:22Z

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!

mphilbrick211 · 2023-10-24T20:33:34Z

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

Co-authored-by: Piotr Surowiec <[email protected]>

This reverts commit b6b2f25.

… one

tecoholic · 2023-12-08T10:20:40Z

@openedx/enterprise-titans The PR has been rebased on master and the DB migration updated to the latest version. Kindly review.

cc: @e0d

mphilbrick211 · 2024-02-21T14:53:55Z

Hi @openedx/2u-titans! If you're still reviewing pull requests, would you please be able to review / merge this for us? Thanks!

* fix: respect allow_enrollment_in_invite_only_courses Fixes `enroll_learners_in_courses` endpoint (and `enroll_subsidy_users_in_courses` utility function) to respect enterprise customer's `allow_enrollment_in_invite_only_courses` flag. * fix: create CEA object when enrolling using a license flow (#18)

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jul 21, 2023

tecoholic changed the title ~~Tecoholic/create cea for invite only courses before checkout~~ feat: create cea for invite only courses before checkout Jul 21, 2023

tecoholic marked this pull request as ready for review July 24, 2023 13:12

mphilbrick211 added the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Jul 24, 2023

tecoholic mentioned this pull request Jul 24, 2023

feat: allow enrollment into 'invite-only' courses open-craft/edx-enterprise#7

Merged

e0d removed the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Jul 28, 2023

Agrendalath approved these changes Aug 2, 2023

View reviewed changes

tecoholic force-pushed the tecoholic/create-cea-for-invite-only-courses-before-checkout branch from 1295492 to 98e7508 Compare August 3, 2023 06:33

mphilbrick211 added the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Aug 7, 2023

e0d removed the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Aug 16, 2023

mphilbrick211 requested a review from a team August 17, 2023 19:16

0x29a mentioned this pull request Oct 30, 2023

feat: cherry-pick edx-enterprise customizations to Palm [BB-7878] open-craft/edx-enterprise#10

Merged

tecoholic force-pushed the tecoholic/create-cea-for-invite-only-courses-before-checkout branch from 2ffbb30 to 1ce437f Compare November 9, 2023 07:50

mphilbrick211 added needs test run Author's first PR to this repository, awaiting test authorization from Axim and removed needs test run Author's first PR to this repository, awaiting test authorization from Axim labels Nov 9, 2023

tecoholic force-pushed the tecoholic/create-cea-for-invite-only-courses-before-checkout branch from eca2b66 to 03dd9bb Compare November 14, 2023 13:09

tecoholic and others added 5 commits December 8, 2023 15:17

temp: add utility function to add CEA objects

e562426

feat: adds allow invite only enrollment flag

95162d5

feat: adds allow invite only enrollment flag

f9cb7c7

feat: create cea only when customer has invite-only enrollments enabled

a309ab0

fix: simplify the cea creation logic, update tests

d1dbd69

tecoholic and others added 10 commits December 8, 2023 15:17

fix: remove a stray empty line

6007f6b

feat: adds the invite-only flag to customer admin

aa51c9c

fix: typo in the fuction docstring

b691e53

Co-authored-by: Piotr Surowiec <[email protected]>

refactor: convert the user consent flow handler method to static

ca44643

fix: move migrations to avoid conflicts

920f16c

feat: add typing to the ensure cea utility method

73e9703

Revert "feat: add typing to the ensure cea utility method"

e9fafdd

This reverts commit b6b2f25.

refactor: rename the migration with a custom name instead of the auto…

db7aae4

… one

fix: remove typing that breaks causes import failures

f20fc1a

chore: move the DB migration to latest version

e6aab23

tecoholic force-pushed the tecoholic/create-cea-for-invite-only-courses-before-checkout branch from 03dd9bb to e6aab23 Compare December 8, 2023 10:02

0x29a mentioned this pull request Dec 30, 2023

feat: cherry-pick edx-enterprise customizations to Quince [BB-8368] open-craft/edx-enterprise#13

Merged

mphilbrick211 added the waiting for eng review PR is ready for review. Review and merge it, or suggest changes. label Feb 21, 2024

0x29a mentioned this pull request Apr 22, 2024

fix: create CEA object when enrolling using a license flow open-craft/edx-enterprise#18

Merged

mphilbrick211 removed the request for review from a team July 30, 2024 21:34

mphilbrick211 added needs reviewer assigned PR needs to be (re-)assigned a new reviewer and removed waiting for eng review PR is ready for review. Review and merge it, or suggest changes. labels Jul 30, 2024

tecoholic marked this pull request as draft August 16, 2024 09:39

tecoholic mentioned this pull request Aug 23, 2024

feat: allow enrolling learners on invitation only courses open-craft/edx-enterprise#20

Merged

mphilbrick211 removed the needs reviewer assigned PR needs to be (re-)assigned a new reviewer label Oct 24, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: create cea for invite only courses before checkout #1813

feat: create cea for invite only courses before checkout #1813

tecoholic commented Jul 21, 2023 •

edited

Loading

openedx-webhooks commented Jul 21, 2023 •

edited

Loading

mphilbrick211 commented Aug 2, 2023

tecoholic commented Aug 2, 2023

mphilbrick211 commented Aug 2, 2023

Agrendalath left a comment

Agrendalath Aug 2, 2023 •

edited

Loading

tecoholic Aug 3, 2023

Agrendalath Aug 3, 2023 •

edited

Loading

tecoholic Aug 3, 2023

e0d commented Aug 16, 2023

mphilbrick211 commented Aug 17, 2023

mphilbrick211 commented Sep 12, 2023

mphilbrick211 commented Oct 3, 2023

mphilbrick211 commented Oct 24, 2023

tecoholic commented Dec 8, 2023 •

edited

Loading

mphilbrick211 commented Feb 21, 2024

feat: create cea for invite only courses before checkout #1813

Are you sure you want to change the base?

feat: create cea for invite only courses before checkout #1813

Conversation

tecoholic commented Jul 21, 2023 • edited Loading

Description

Testing instructions

openedx-webhooks commented Jul 21, 2023 • edited Loading

What's next?

🔘 Get product approval

🔘 Provide context

🔘 Get a green build

🔘 Update the status of your PR

🔘 Let us know that your PR is ready for review:

Who will review my changes?

Where can I find more information?

When can I expect my changes to be merged?

mphilbrick211 commented Aug 2, 2023

tecoholic commented Aug 2, 2023

mphilbrick211 commented Aug 2, 2023

Agrendalath left a comment

Choose a reason for hiding this comment

Agrendalath Aug 2, 2023 • edited Loading

Choose a reason for hiding this comment

tecoholic Aug 3, 2023

Choose a reason for hiding this comment

Agrendalath Aug 3, 2023 • edited Loading

Choose a reason for hiding this comment

tecoholic Aug 3, 2023

Choose a reason for hiding this comment

e0d commented Aug 16, 2023

mphilbrick211 commented Aug 17, 2023

mphilbrick211 commented Sep 12, 2023

mphilbrick211 commented Oct 3, 2023

mphilbrick211 commented Oct 24, 2023

tecoholic commented Dec 8, 2023 • edited Loading

mphilbrick211 commented Feb 21, 2024

tecoholic commented Jul 21, 2023 •

edited

Loading

openedx-webhooks commented Jul 21, 2023 •

edited

Loading

Agrendalath Aug 2, 2023 •

edited

Loading

Agrendalath Aug 3, 2023 •

edited

Loading

tecoholic commented Dec 8, 2023 •

edited

Loading