feat: added organization dropdown in studio #30975

Ian2012 · 2022-09-12T13:55:05Z

Description

This PR adds a dropdown to select the organization. The dropdown will only be activated for users with CourseCreator permission to specific organizations in Studio.

Use cases:

When FEATURES['ENABLE_CREATOR_GROUP'] = True and the user has CourseCreator permission granted, a dropdown will appear with all specific organizations allowed. In case of all_organizations setting is enabled, all organizations will appear in the dropdown.

In case the user is staff, he can create organizations it will work as before:

Testing instructions

Enable course creator group in studio.
Create a student account and give it CourseCreator permission only for some organizations.
Login as this user and try to create a new course.

Result:

openedx-webhooks · 2022-09-12T13:55:09Z

Thanks for the pull request, @Ian2012! 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.

natabene · 2022-09-19T15:47:34Z

@Ian2012 Thank you for the contribution. Is this ready for our review?

Ian2012 · 2022-09-19T16:18:20Z

@natabene I was waiting for feedback from the community. Do you know someone that maybe interested or has knowledge of the CourseCreator permission?

cc @MaferMazu @mariajgrimaldi

natabene · 2022-09-19T16:24:22Z

@Ian2012 I am not aware.

mariajgrimaldi · 2022-09-20T13:42:01Z

Hello @natabene!
I can review this one. But I have a question: since it changes in some way the user experience, should we include a product review? Or this minimal change doesn't need it? It's unclear to me how this is handled.

jfay1 · 2022-10-05T21:49:48Z

Hi, Jon here from the UX team. I'm unable to test, but based on the screenshot this looks like a nice improvement.

Ian2012 · 2022-10-05T21:55:31Z

Hi @jfay1, thanks for the reply

Would you mind explaining why you were unable to test it?

Are you facing some error?

jfay1 · 2022-10-05T23:35:06Z

Hi @Ian2012, no errors but I'm wondering if I need to test on a certain site? Sometimes I'm sent a test link on stage etc.

I'm not sure how to get to the screen in step 2 but I do have permission to create courses in studio. When I create a new course I see the old field, but that's what I would expect.

santiagosuarezedunext · 2022-10-07T18:03:56Z

Hey @jmakowski1123 what do you think of this feature.
I think that currently it is very annoying to have to know the name of the organization, there is a lot of room for error and this could be solved
Do you think anything could be improved?

MaferMazu · 2022-10-07T23:36:57Z

@Ian2012 I think this is a good improvement; you should try to fix the test to have a proper review.

mariajgrimaldi · 2022-10-10T18:35:36Z

Hello. I can review this one if we're clear from the product side.

jmakowski1123 · 2022-10-10T23:05:58Z

Hey @jmakowski1123 what do you think of this feature. I think that currently it is very annoying to have to know the name of the organization, there is a lot of room for error and this could be solved Do you think anything could be improved?

@santiagosuarezedunext It seems to be a useful feature in terms of fixing a known pain point. What does the behavior look like if there are multiple organizations listed in the dropdown? Do they display alphabetically? Is a user able to scroll through the full list of enabled organizations, as well as start typing an organization and be offered a dropdown of selections based on what he/she typed?

Ian2012 · 2022-10-10T23:17:53Z

Hi @jmakowski1123,

What does the behavior look like if there are multiple organizations listed in the dropdown?

The organizations will be sorted by id (creation date).

Is a user able to scroll through the full list of enabled organizations, as well as start typing an organization and be offered a dropdown of selections based on what he/she typed?

No, the dropdown was added because it worked like that before (with the option to type in) but users don't really know which organizations they have access.

Staff users and users with permission to create organizations still have the old input (type and get suggestions)

mariajgrimaldi · 2022-10-20T20:53:22Z

cms/djangoapps/contentstore/views/course.py

Suggested change

if user.count() == 0:

return []

elif user[0].all_organizations:

# User is defined to be unique, can assume a single entry.

return Organization.objects.all().values_list('short_name', flat=True)

else:

return user[0].organizations.all().values_list('short_name', flat=True)

if not user:

organizations = []

elif user[0].all_organizations:

organizations = Organization.objects.all().values_list('short_name', flat=True)

else:

organizations = user[0].organizations.all().values_list('short_name', flat=True)

return organizations

Also, I believe some testing would be beneficial. You could add tests to test_organizations, extend the existing ones or create a new test suite.

The test related to CourseCreators have been modified because this is the main functionality that is affected by those changes

what I see is that you're only testing get_allowed_organizations

More test have been added to can_create_courses. This permission is only validation on the frontend, because this permission is checked once a request is made to create a course or library in the backend

mariajgrimaldi · 2022-10-20T21:13:26Z

cms/static/sass/views/_course-create.scss

is new-library-org missing here?

In fact, I need to verify if this change is applied correctly but I don't know how to compile those SCSS files. Do you know who can give me a hand with the styles?

If you're using tutor you could try this from the docs and then inspect the browser. You could do a before and after and post it under this comment

Thanks, you were right:

mariajgrimaldi · 2022-10-31T17:11:00Z

I've tested the following in my local environment:

ENABLE_CREATOR_GROUP disabled
Instructor with permission to all organizations
Instructor with permission to just one organization

Technically, this is working like a charm—also, thanks @Ian2012, for considering my suggestions. Given this is under product review, I won't leave my approval yet.

Ian2012 · 2022-11-16T14:49:20Z

@mariajgrimaldi Is there anything that we can do to push this forward?

mariajgrimaldi · 2022-11-17T11:24:05Z

@Ian2012: we need to wait for the product review.

Is there anything we could do in the meantime? @jmakowski1123

mphilbrick211 · 2023-02-01T17:06:43Z

@Ian2012 can you rebase with the master branch? so we can merge. Also @mphilbrick211, thanks for the ping! This PR still has the product review label, should we remove it?

@mariajgrimaldi - we're planning to leave those labels on just in case for some reason we need to go back to this PR (or any PR that was marked for Product review. Thank you for checking!

mariajgrimaldi · 2023-02-01T17:08:46Z

@mphilbrick211 good! -just checking- this can be merged, right -from the product view-?

mphilbrick211 · 2023-02-01T17:34:15Z

@mphilbrick211 good! -just checking- this can be merged, right -from the product view-?

@mariajgrimaldi Looks like it per @cablaa77's comment above!

mphilbrick211 · 2023-02-07T19:46:29Z

@mariajgrimaldi just checking in to see if this can be merged?

mariajgrimaldi · 2023-02-07T19:48:23Z

@mphilbrick211: the branch is still out-of-date, once @Ian2012 updates it, I'll merge this :)

mariajgrimaldi

I'll be merging this tomorrow :)

Co-authored-by: Maria Grimaldi <maria.grimaldi@edunext.co>

openedx-webhooks · 2023-02-08T14:48:21Z

@Ian2012 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

edx-pipeline-bot · 2023-02-08T15:47:22Z

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

edx-pipeline-bot · 2023-02-08T16:13:29Z

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

connorhaugh · 2023-02-13T19:15:17Z

Hi @Ian2012 @mariajgrimaldi our authors on edx.org are running into a 500 error attempting to load the v1 library page as:

File "/edx/app/edxapp/edx-platform/cms/djangoapps/contentstore/views/course.py", line 622, in library_listing return render_to_response('index.html', data)
…
File "/tmp/mako_cms/17d4a5cdf1015f510e44357b40e03bbb/index.html.py", line 242, in render_content
for org in allowed_organizations:
TypeError: 'Undefined' object is not iterable

The course home page is loading fine, so I presume this has to do with the fact that library_listing_return does not specify an allowed_organizations value?

Can you confirm this behavior with V1 libraries is working as expected, and is a peculiarity of our deployment? It might be, as
/home/#libraries-tab works for me in our staging environment, but not on production.

mariajgrimaldi · 2023-02-13T19:17:42Z

@connorhaugh I'll check this right away.

BTW, you tagged the wrong Maria 😅

mariajgrimaldi · 2023-02-13T19:21:31Z

@Ian2012 can you give us a hand, please? thanks

Ian2012 · 2023-02-13T19:51:38Z

Hi @connorhaugh,

The issue is caused because in the context of the library_listing view the new variables are not added to the context and use the same template:

  'allowed_organizations': get_allowed_organizations(request.user),
  'can_create_organizations': user_can_create_organizations(request.user),

@connorhaugh can you revert the commit or should I open a new PR with the fix?

Also, this issue is triggered only when this waffle flag is enabled:

### contentstore.split_library_on_studio_dashboard
SPLIT_LIBRARY_ON_DASHBOARD = WaffleFlag(
    f'{CONTENTSTORE_NAMESPACE}.split_library_on_studio_dashboard',
    __name__,
    CONTENTSTORE_LOG_PREFIX,
)

Ian2012 · 2023-02-13T19:55:06Z

@connorhaugh Temporarily, you can disable this waffle flag: contentstore.split_library_on_studio_dashboard

mariajgrimaldi · 2023-02-13T19:57:16Z

Thank you, Cristhian.

@connorhaugh: that flag is turned off by default, so it wasn't included as one of our test cases. Please, let us know how to proceed.

connorhaugh · 2023-02-13T20:28:51Z

Based on what I have heard from our support team, a fix forward is acceptable. Thanks so much your prompt response @Ian2012 @mariajgrimaldi, and all of your help. Let me know if there is anything I can do to help! Seems like the fix is rather straightforward.

We have that waffle flag (split_library_on_studio_dashboard) on on our production env, but not our staging env.

connorhaugh · 2023-02-13T20:29:25Z

I will review #31752 promptly.

mariajgrimaldi · 2023-02-13T21:31:04Z

thank you! @connorhaugh @Ian2012

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Sep 12, 2022

Ian2012 mentioned this pull request Sep 12, 2022

Organization dropdown maple eduNEXT/ednx-saas-themes#10

Closed

Ian2012 force-pushed the cag/organization-dropdown branch from 5bd8267 to 5fe5ab7 Compare October 10, 2022 18:01

Ian2012 force-pushed the cag/organization-dropdown branch 2 times, most recently from 578bd57 to cabea10 Compare October 10, 2022 20:40

mariajgrimaldi self-requested a review October 20, 2022 20:46

mariajgrimaldi reviewed Oct 20, 2022

View reviewed changes

mariajgrimaldi self-assigned this Oct 20, 2022

Ian2012 force-pushed the cag/organization-dropdown branch from 837feff to 4ce0fab Compare October 27, 2022 18:59

jmakowski1123 added the product review PR requires product review before merging label Oct 27, 2022

Alec4r mentioned this pull request Nov 15, 2022

DS-302 | feat(BC-14): organization dropdown on course creation eduNEXT/edunext-platform#693

Merged

Ian2012 force-pushed the cag/organization-dropdown branch from 4ce0fab to 7c32305 Compare November 17, 2022 21:29

openedx-webhooks removed the product review PR requires product review before merging label Nov 17, 2022

mariajgrimaldi approved these changes Feb 7, 2023

View reviewed changes

Ian2012 and others added 7 commits February 7, 2023 16:20

feat: organization dropdown on course creation

26ef787

test: added tests for dropdown course creation

1a89d22

feat: added organization dropdown in studio for libraries

b106bc0

fix: fixed css for organization dropdown in studio

9d03efc

refactor: refactored get_organizations, fixed styles

d68e3b2

test: test user_can_create_organizations

2beb61d

fix: address code suggestions

c8efb16

Co-authored-by: Maria Grimaldi <maria.grimaldi@edunext.co>

Ian2012 force-pushed the cag/organization-dropdown branch from 8c0253b to c8efb16 Compare February 7, 2023 21:20

mariajgrimaldi merged commit 3427a9a into openedx:master Feb 8, 2023

Ian2012 mentioned this pull request Feb 13, 2023

fix: add missing variables to library_listing context #31752

Merged

JuanDavidBuitrago mentioned this pull request Jul 21, 2023

feat(BC-14): added organization dropdown in studio (DS-603) eduNEXT/edunext-platform#770

Merged

antoviaque mentioned this pull request Feb 20, 2024

Better QA on PRs openedx/wg-governance#117

Open

-    if user.count() == 0:
-        return []
-    elif user[0].all_organizations:
-        # User is defined to be unique, can assume a single entry.
-        return Organization.objects.all().values_list('short_name', flat=True)
-    else:
-        return user[0].organizations.all().values_list('short_name', flat=True)
+    if not user:
+        organizations = []
+    elif user[0].all_organizations:
+        organizations = Organization.objects.all().values_list('short_name', flat=True)
+    else:
+        organizations =  user[0].organizations.all().values_list('short_name', flat=True)
+    return organizations

feat: added organization dropdown in studio #30975

feat: added organization dropdown in studio #30975

Uh oh!

Conversation

Ian2012 commented Sep 12, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Testing instructions

Uh oh!

openedx-webhooks commented Sep 12, 2022

Uh oh!

natabene commented Sep 19, 2022

Uh oh!

Ian2012 commented Sep 19, 2022

Uh oh!

natabene commented Sep 19, 2022

Uh oh!

mariajgrimaldi commented Sep 20, 2022

Uh oh!

jfay1 commented Oct 5, 2022

Uh oh!

Ian2012 commented Oct 5, 2022

Uh oh!

jfay1 commented Oct 5, 2022

Uh oh!

santiagosuarezedunext commented Oct 7, 2022

Uh oh!

MaferMazu commented Oct 7, 2022

Uh oh!

mariajgrimaldi commented Oct 10, 2022

Uh oh!

jmakowski1123 commented Oct 10, 2022

Uh oh!

Ian2012 commented Oct 10, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mariajgrimaldi commented Oct 31, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Ian2012 commented Nov 16, 2022

Uh oh!

mariajgrimaldi commented Nov 17, 2022

Uh oh!

mphilbrick211 commented Feb 1, 2023

Uh oh!

mariajgrimaldi commented Feb 1, 2023

Uh oh!

mphilbrick211 commented Feb 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mphilbrick211 commented Feb 7, 2023

Uh oh!

mariajgrimaldi commented Feb 7, 2023

Uh oh!

mariajgrimaldi left a comment

Choose a reason for hiding this comment

Uh oh!

openedx-webhooks commented Feb 8, 2023

Uh oh!

edx-pipeline-bot commented Feb 8, 2023

Uh oh!

edx-pipeline-bot commented Feb 8, 2023

Uh oh!

Ian2012 commented Sep 12, 2022 •

edited

Loading

mariajgrimaldi commented Oct 31, 2022 •

edited

Loading

mphilbrick211 commented Feb 1, 2023 •

edited

Loading

connorhaugh commented Feb 13, 2023 •

edited

Loading

mariajgrimaldi commented Feb 13, 2023 •

edited

Loading