Added admin-only bulk enrollment form #178

gsidebo · 2019-04-24T15:57:13Z

Pre-Flight checklist

Screenshots and design review for any changes that affect layout or styling
- Desktop screenshots
- Tag @Ferdi or @pdpinch for review
Migrations
- Migration is backwards-compatible with current production code
Testing
- Code is tested
- Changes have been manually tested

What are the relevant tickets?

Closes #112

What's this PR do?

Adds the bulk enrollment form for admin use
Fixes the email debugger page
Adds a very basic listing page for ecommerce admin pages (/ecommerce/admin/)

How should this be manually tested?

Create some 100% off coupons. It involves a lot of different objects, so here's a gist to help with that if you want it.
Create a CSV file with one email address per line. Ensure that those email addresses will end up in your mailbox, e.g.: myactualemail+1@mit.edu, myactualemail+2@mit.edu, ...
Navigate to /ecommerce/admin/enroll/, select your CSV file, choose one of your coupons in the dropdown, and click the enroll button.

Where should the reviewer start?

Probably static/js/containers/pages/admin/BulkEnrollmentPage.js

Any background context you want to provide?

The wireframe calls for a separate dropdown for program/course/course run, but a CouponEligibility object is all we need to map a coupon to those objects. We didn't need the separate dropdown
I included a dummy url/view for handling the URL that a user is sent to when they click the "Enroll" button in the email. Actual enrollment handling will be done in a different issue
I made some minor refactoring changes to the mail API. It was not very friendly for sending a message to a set of recipients with the same context in each message

Screenshots (if appropriate)

gsidebo · 2019-04-24T15:57:30Z

@pdpinch Screenshots ^^^

codecov-io · 2019-04-24T16:05:51Z

Codecov Report

Merging #178 into master will increase coverage by 0.59%.
The diff coverage is 93.05%.

@@            Coverage Diff             @@
##           master     #178      +/-   ##
==========================================
+ Coverage   92.69%   93.28%   +0.59%     
==========================================
  Files         134      142       +8     
  Lines        3845     4143     +298     
  Branches      222      232      +10     
==========================================
+ Hits         3564     3865     +301     
+ Misses        240      235       -5     
- Partials       41       43       +2

Impacted Files	Coverage Δ
static/js/lib/urls.js	`100% <ø> (ø)`	⬆️
mitxpro/urls.py	`80% <ø> (ø)`	⬆️
ecommerce/urls.py	`100% <ø> (ø)`	⬆️
ecommerce/api.py	`99.25% <100%> (+0.04%)`	⬆️
.../containers/pages/admin/BulkEnrollmentPage_test.js	`100% <100%> (ø)`
mail/constants.py	`100% <100%> (ø)`
static/js/constants.js	`100% <100%> (ø)`	⬆️
static/js/containers/pages/CheckoutPage_test.js	`100% <100%> (ø)`	⬆️
mail/forms.py	`100% <100%> (+100%)`	⬆️
mitxpro/test_utils.py	`100% <100%> (ø)`	⬆️
... and 33 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 601276d...9ba33e0. Read the comment docs.

mbertrand

I think this is meant to be used for Coupons related to CouponPaymentVersion objects with coupon_type='single-use'. There should be n number of these Coupon objects equal to CouponPaymentVersion.num_coupon_codes, each with its own unique code. Each user should get sent a different coupon code, no two users should get the same code. So there will also need to be a check that there are at least as many coupon codes as there are emails in the csv file.

There is a form you can use to create these coupons here: /ecommerce/admin/coupons

mbertrand · 2019-04-24T17:28:19Z

Also heads up that there may be some changes to what's allowed to be a product (maybe just Program and CourseRun, instead of Program and Course - formerly it was all 3), will be determined tomorrow.

mbertrand · 2019-04-24T17:36:55Z

Might be good to also track which coupon is sent to which user. I've got a DataConsentUser model in PR #163 that includes a foreign key to Coupon, maybe that could be split up into two models, DataConsentUser and CouponUser? Or just renamed to something more generic.

Ferdi · 2019-04-24T17:39:38Z

Might be good to also track which coupon is sent to which user.
I think that would be useful /cc @rhysyngsun

gsidebo · 2019-04-24T18:05:58Z

@mbertrand Sounds good. Tracking the sending of coupons to users should be easy enough. I'll follow up with you about sending each user a different code

gsidebo · 2019-04-25T10:39:45Z

@mbertrand Ready for another look

mbertrand · 2019-04-25T11:54:29Z

ecommerce/api.py

+            .filter(coupon__enabled=True, coupon__payment=coupon_payment)
+            .distinct("product")
+        )
+        if product_coupons.count() != 1:


It's possible to have multiple CouponEligibility objects for the same coupon. I made my 100% off coupon apply to 3 products so I always get the message "In order to perform bulk enrollment, there must be 100%-off coupons applied to products. None were found."

Never mind, if a coupon has more than 1 product it shouldn't be listed

mbertrand · 2019-04-25T12:00:57Z

ecommerce/views.py

+            return Response(
+                status=status.HTTP_400_BAD_REQUEST,
+                data={
+                    "errors": [


This error is correctly returned when the csv file has more emails than there are coupons, but is not displayed on the page.

Yep, forgot about this one. Will fix

mbertrand · 2019-04-25T12:05:21Z

ecommerce/views.py

+
+        send_bulk_enroll_emails(emails, product_coupons)
+
+        return Response(


Response is returned but nothing on the page indicates success

Hmmm, looks like I messed up the success message after my most recent commit. Will fix

mbertrand · 2019-04-25T12:16:47Z

ecommerce/api.py

+        )
+        if product_coupons.count() != 1:
+            continue
+        yield coupon_payment, product_coupons[0].product


The dropdown list only shows one of the products that a coupon is valid for, there may be more than one. I made a coupon valid for 3 products, the dropdown showed one of those products but then different emails got sent different products that the coupon applied to:

This should probably be changed to show the coupon for every product that it is applicable to, and then emails should get sent for that particular product to all user emails if selected:

for product_coupon in product_coupons: yield coupon_payment, product_coupon.product

Though maybe no one will ever create a 100% off coupon that applies to multiple products (nothing on the coupon creation form prevents you from doing so however) - @pdpinch what do you think?

PS this is after I removed the if product_coupons.count() != 1 condition to see what would happen.

Our primary use case is where bulk enrollment apply to one product (program, course, or courserun). Can we limit the form to only coupons of that type?

Limiting the bulk enrollment to one product also will simplify the mailing: just one one email for each email address uploaded.

Yes, it already is here, so good as is @gsidebo!

I meant to be more explicit about that in the message and in the code comments. I'll add some clarification

ecommerce/mail_api.py

gsidebo · 2019-04-26T21:14:26Z

@mbertrand Ready for you again. I'll work on rebasing

gsidebo · 2019-04-26T21:15:35Z

@Ferdi @pdpinch Screenshots updated ^^^

ecommerce/views.py

gsidebo · 2019-04-29T15:38:34Z

@mbertrand I ended up just solving #188 and preventing repeated invites for the same product coupons in one shot. That's what made the most sense. Give it another try. You should see and error when num_coupon_codes is less than the # of emails, and when the available unsent product coupons are less than the # of emails.

I'll rebase after your review so I can squash the commits first

mbertrand

👍 works great

gsidebo added the Needs Review label Apr 24, 2019

mbertrand self-assigned this Apr 24, 2019

mbertrand requested changes Apr 24, 2019

View reviewed changes

mbertrand added Waiting on Author and removed Needs Review labels Apr 24, 2019

gsidebo added Needs Review and removed Waiting on Author labels Apr 25, 2019

gsidebo force-pushed the 112_bulk_enrollments_ui branch from 1059fa9 to a3e3370 Compare April 25, 2019 11:24

mbertrand requested changes Apr 25, 2019

View reviewed changes

mbertrand reviewed Apr 25, 2019

View reviewed changes

ecommerce/mail_api.py Show resolved Hide resolved

gsidebo force-pushed the 112_bulk_enrollments_ui branch 2 times, most recently from 1063be2 to 90ba824 Compare April 25, 2019 14:15

odlbot had a problem deploying to xpro-ci-pr-178 April 25, 2019 14:15 Failure

mbertrand added Waiting on Author and removed Needs Review labels Apr 25, 2019

gsidebo added Needs Review and removed Waiting on Author labels Apr 26, 2019

odlbot had a problem deploying to xpro-ci-pr-178 April 26, 2019 21:11 Failure

gsidebo mentioned this pull request Apr 26, 2019

Prevent bulk enrollment invitations that would exceed available coupon codes #188

Closed

mbertrand reviewed Apr 29, 2019

View reviewed changes

ecommerce/views.py Outdated Show resolved Hide resolved

odlbot had a problem deploying to xpro-ci-pr-178 April 29, 2019 15:36 Failure

gsidebo force-pushed the 112_bulk_enrollments_ui branch from cc1e29a to d9e6e51 Compare April 29, 2019 16:05

odlbot had a problem deploying to xpro-ci-pr-178 April 29, 2019 16:05 Failure

mbertrand approved these changes Apr 29, 2019

View reviewed changes

mbertrand added Waiting on Author and removed Needs Review labels Apr 29, 2019

Added admin-only bulk enrollment form

9ba33e0

gsidebo force-pushed the 112_bulk_enrollments_ui branch from d9e6e51 to 9ba33e0 Compare April 29, 2019 17:14

odlbot had a problem deploying to xpro-ci-pr-178 April 29, 2019 17:14 Failure

gsidebo merged commit f5143e2 into master Apr 29, 2019

gsidebo deleted the 112_bulk_enrollments_ui branch April 29, 2019 17:45

gsidebo mentioned this pull request Apr 29, 2019

Implement bulk enrollment view #196

Closed

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added admin-only bulk enrollment form #178

Added admin-only bulk enrollment form #178

gsidebo commented Apr 24, 2019 •

edited

Loading

gsidebo commented Apr 24, 2019

codecov-io commented Apr 24, 2019 •

edited

Loading

mbertrand left a comment

mbertrand commented Apr 24, 2019

mbertrand commented Apr 24, 2019

Ferdi commented Apr 24, 2019

gsidebo commented Apr 24, 2019

gsidebo commented Apr 25, 2019

mbertrand Apr 25, 2019 •

edited

Loading

mbertrand Apr 25, 2019

mbertrand Apr 25, 2019

gsidebo Apr 25, 2019

mbertrand Apr 25, 2019

gsidebo Apr 25, 2019

mbertrand Apr 25, 2019

mbertrand Apr 25, 2019 •

edited

Loading

pdpinch Apr 25, 2019

pdpinch Apr 25, 2019

mbertrand Apr 25, 2019

gsidebo Apr 25, 2019

gsidebo commented Apr 26, 2019

gsidebo commented Apr 26, 2019

gsidebo commented Apr 29, 2019 •

edited

Loading

mbertrand left a comment


		send_bulk_enroll_emails(emails, product_coupons)

		return Response(

Added admin-only bulk enrollment form #178

Added admin-only bulk enrollment form #178

Conversation

gsidebo commented Apr 24, 2019 • edited Loading

Pre-Flight checklist

What are the relevant tickets?

What's this PR do?

How should this be manually tested?

Where should the reviewer start?

Any background context you want to provide?

Screenshots (if appropriate)

gsidebo commented Apr 24, 2019

codecov-io commented Apr 24, 2019 • edited Loading

Codecov Report

mbertrand left a comment

Choose a reason for hiding this comment

mbertrand commented Apr 24, 2019

mbertrand commented Apr 24, 2019

Ferdi commented Apr 24, 2019

gsidebo commented Apr 24, 2019

gsidebo commented Apr 25, 2019

mbertrand Apr 25, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mbertrand Apr 25, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gsidebo commented Apr 26, 2019

gsidebo commented Apr 26, 2019

gsidebo commented Apr 29, 2019 • edited Loading

mbertrand left a comment

Choose a reason for hiding this comment

gsidebo commented Apr 24, 2019 •

edited

Loading

codecov-io commented Apr 24, 2019 •

edited

Loading

mbertrand Apr 25, 2019 •

edited

Loading

mbertrand Apr 25, 2019 •

edited

Loading

gsidebo commented Apr 29, 2019 •

edited

Loading