edx-platform icon indicating copy to clipboard operation
edx-platform copied to clipboard

fix: added keyword substitution support in edx_ace based bulk course emails

Open ziafazal opened this issue 3 years ago • 5 comments

This PR has changes to support keyword substitution in edx_ace based bulk course emails. This issue is reported here.

Testing Instructions.

  1. Login as a user having django admin access and enable bulk course email flag Screen Shot 2022-09-27 at 6 36 32 PM

  2. Login as course instructor or staff

  3. Open Email tab on instructor dashboard of any course

  4. Set Myself in Send To field, enter anything in Subject field. In Message field enter the text below and hit Send Mail button

Hey %%USER_FULLNAME%%

welcome in %%COURSE_DISPLAY_NAME%%
  1. You should receive email with %%USER_FULLNAME%% and %%COURSE_DISPLAY_NAME%% replaced with user's full name and the course display name.

ziafazal avatar Sep 27 '22 13:09 ziafazal

Should anything be added in the UI to show users that this capability exists?

I assume preview is difficult/impossible (it was when I previously worked on bulk email in 2013), but that would be a good consideration for extension to validate that the variables are properly entered

sarina avatar Oct 04 '22 15:10 sarina

Hi @ziafazal this feature is in a state of ownership limbo at 2U. Most recently my team worked on it but we will be transferring ownership to @jristau1984's team Infinity. My team also built a replacement for the front end which I don't think is fully supported in Open edX yet, and since we are transititioning ownership we don't have a current plan to address that. It might help to have a synchronous conversation about how to land this.

hurtstotouchfire avatar Oct 04 '22 15:10 hurtstotouchfire

@sarina thanks for reviewing. I have

  • added positive asserts in test
  • added some text and docs link in UI if instructors need to know more about message Keywords

ziafazal avatar Oct 05 '22 07:10 ziafazal

@ziafazal I want to be clear that I don't know this code area well and don't own it, so am not 100% confident to provide review. From my perspective it looks good (thanks for the updates) but I'd coordinate with @hurtstotouchfire to land it.

sarina avatar Oct 05 '22 14:10 sarina

📣 💥 Heads-up: You must either rebase onto master or merge master into your branch to keep passing required checks.

We added a new required check, "Tests Successful," that this PR does not yet run. Rebasing will get it started.

If you have any questions, please reach out to the Architecture team (either #architecture on Open edX Slack or #external-architecture on edX internal Slack).

nedbat avatar Oct 31 '22 19:10 nedbat

@hurtstotouchfire @jristau1984 There were a couple salient notes above:

  • This is transitioning
  • That a synchronous convo might be required to land this.

This looks valuable and straight-forward, but y'all are the most intensive users of this feature I believe. What are the best next steps?

e0d avatar Nov 15 '22 15:11 e0d

EdX Release Notice: This PR has been deployed to the staging environment in preparation for a release to production.

edx-pipeline-bot avatar Dec 07 '22 20:12 edx-pipeline-bot

EdX Release Notice: This PR has been deployed to the production environment.

edx-pipeline-bot avatar Dec 07 '22 20:12 edx-pipeline-bot