Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add open managed group type #669

Merged
merged 8 commits into from
Mar 12, 2024

Conversation

Ian2012
Copy link
Contributor

@Ian2012 Ian2012 commented Nov 7, 2023

Settings

EDX_PLATFORM_REPOSITORY: https://github.com/openedx/edx-platform.git
EDX_PLATFORM_VERSION: master

TUTOR_GROVE_LMS_ENV_FEATURES: |
  ENABLE_TEAMS: True

TUTOR_GROVE_MFE_LMS_COMMON_SETTINGS: |
  MFE_CONFIG["ENABLE_OPEN_MANAGED_TEAM_TYPE"] = True

Description

This PR adds support for the new open managed group type. Ref: https://openedx.atlassian.net/wiki/spaces/COMM/pages/3885760525/Open+Managed+Group+Type

Screenshots

image

Dependencies:

Depends on: openedx/edx-platform#33672

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 7, 2023
@openedx-webhooks
Copy link

openedx-webhooks commented Nov 7, 2023

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.

Copy link

codecov bot commented Nov 7, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.30%. Comparing base (3c661e1) to head (80454ee).
Report is 20 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #669      +/-   ##
==========================================
+ Coverage   90.94%   91.30%   +0.36%     
==========================================
  Files         520      561      +41     
  Lines        9157     9767     +610     
  Branches     1920     2081     +161     
==========================================
+ Hits         8328     8918     +590     
- Misses        797      816      +19     
- Partials       32       33       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Ian2012 Ian2012 marked this pull request as ready for review November 7, 2023 17:48
@Ian2012 Ian2012 changed the title POC] feat: add open managed group type [POC] feat: add open managed group type Nov 7, 2023
@mphilbrick211 mphilbrick211 added the waiting for eng review PR is ready for review. Review and merge it, or suggest changes. label Nov 7, 2023
@mphilbrick211 mphilbrick211 requested a review from a team November 7, 2023 22:39
@mphilbrick211
Copy link

Hi @openedx/teaching-and-learning! This is ready for your review. Thanks!

@jristau1984 jristau1984 added the jira:2u We want an issue in the 2U Jira instance label Nov 8, 2023
@openedx-webhooks
Copy link

I've created issue TNL-11193 in the private 2U Jira.

Copy link
Member

@felipemontoya felipemontoya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we reorder the list so that "Open Managed" is between "Open" and "Public Managed"?
I think it makes sense since it creates a progression from fully open to fully private.

src/pages-and-resources/teams/messages.js Outdated Show resolved Hide resolved
src/pages-and-resources/teams/messages.js Outdated Show resolved Hide resolved
Copy link
Contributor

@sundasnoreen12 sundasnoreen12 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR LGTM

Copy link
Member

@felipemontoya felipemontoya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed again. I think this is good.
This should be merged after edx-platform/pull/33672, right?

@Ian2012
Copy link
Contributor Author

Ian2012 commented Nov 16, 2023

Yes, it should. Waiting on review there

@Ian2012 Ian2012 changed the title [POC] feat: add open managed group type feat: add open managed group type Nov 16, 2023
@felipemontoya
Copy link
Member

@Ian2012 sorry to come up so late with this request but to be extra safe when merging this. Could you please leave this feature behind a feature flag?

CC @mariajgrimaldi in case you are taking over this feature.

@mariajgrimaldi
Copy link
Member

mariajgrimaldi commented Feb 14, 2024

Hi there @felipemontoya, that's precisely what I did in this PR: #801, but I'll cherry-pick the changes here since they're needed. Thank you.

@mariajgrimaldi
Copy link
Member

@felipemontoya: done! Could you review this again? Thanks!

@mariajgrimaldi
Copy link
Member

I can't update the cover letter, so I leave here the updated testing instructions:

  1. Follow the instructions in the PR feat: add open managed group type #669.
  2. Check the team options. The Open Managed team should be off as default.
  3. Now, turn on the new team option by adding this to your LMS configuration:
    MFE_CONFIG_OVERRIDES = {
      "course-authoring": {
          "ENABLE_OPEN_MANAGED_TEAM_TYPE": True,
      }
    }

@mphilbrick211 mphilbrick211 removed the waiting for eng review PR is ready for review. Review and merge it, or suggest changes. label Feb 21, 2024
Copy link
Member

@felipemontoya felipemontoya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for moving this behind a flag @mariajgrimaldi.

I re-tested this today. The code is working on a tutor based environment together with the changes of the platform that were merged on PR 33672.

I think this is ready to be merged.

  • it has product approval
  • it has a core committer approval and 2 approvals by the 2u team.
  • tests are running and passing
  • the feature includes it's own tests
  • the feature is behind a flag that is switched off by default. This won't impact edx.org's operation in any way.

@felipemontoya
Copy link
Member

@arbrandes or @brian-smith-tcril could one of you help us get the green button pushed? There is no backstage catalog file so I don't know who to flag as the maintainer.

@arbrandes
Copy link
Contributor

@felipemontoya, I'll be glad to, but my first question is: has this received product approval, yet?

Tagging @jmakowski1123 preemptively.

@arbrandes arbrandes self-requested a review February 27, 2024 15:12
@open-craft-grove
Copy link

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

@felipemontoya
Copy link
Member

Great! sandboxes are working.

I don't know how to access that sandbox as an instructor user, and also I don't know how to make sure that the settings are complete, but overall I love sandboxes.

@open-craft-grove
Copy link

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

@arbrandes
Copy link
Contributor

@felipemontoya, custom settings are at the top of the PR description. There's docs at https://gitlab.com/opencraft/dev/grove/-/blob/main/docs/user-guides/automated-pr-sandbox.md and at https://gitlab.com/opencraft/dev/tutor-contrib-grove.

I'll send you access details off-band.

@mariajgrimaldi
Copy link
Member

Fixed branch conflicts just now.

@open-craft-grove
Copy link

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

@mariajgrimaldi
Copy link
Member

I'll be fixing the failing tests soon; thanks for the patience.

@open-craft-grove
Copy link

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

@open-craft-grove
Copy link

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

@mariajgrimaldi
Copy link
Member

Hello @arbrandes! This is ready for review if you have the time. Thanks!

@arbrandes
Copy link
Contributor

@mariajgrimaldi, in the sandbox, I can't configure Teams as instructed in the the backend PR. Any idea why that might be? A missing configuration item, perhaps?

@mariajgrimaldi
Copy link
Member

@arbrandes: I'll look into it!

@mariajgrimaldi
Copy link
Member

@arbrandes: could you share the access details for the sandox? Thanks!

Copy link
Contributor

@arbrandes arbrandes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works great! Just one nit.


test('returns false if the group is invalid', () => {
getConfig.mockReturnValue({ ENABLE_OPEN_MANAGED_TEAM_TYPE: true });
expect(isGroupTypeEnabled('')).toBe(false);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd feel safer if you made this an actual bogus value. Like:

Suggested change
expect(isGroupTypeEnabled('')).toBe(false);
expect(isGroupTypeEnabled('FOO')).toBe(false);

@mariajgrimaldi
Copy link
Member

@arbrandes: done! Thank you

@open-craft-grove
Copy link

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

@arbrandes arbrandes merged commit 7f5687f into openedx:master Mar 12, 2024
6 checks passed
@openedx-webhooks
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
create-sandbox open-craft-grove should create a sandbox environment from this PR jira:2u We want an issue in the 2U Jira instance open-source-contribution PR author is not from Axim or 2U
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

10 participants