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: creating new enterprise group members endpoint #2270

Open
wants to merge 19 commits into
base: master
Choose a base branch
from

Conversation

kiram15
Copy link
Contributor

@kiram15 kiram15 commented Oct 23, 2024

Adding in an endpoint for the data table that is created in this ticket. We will be fetching info about the user (email, date_joined, name) from the enterprise_customer_user, and then fetching the total number of enrollments associated with that enterprise user.

Jira

Members are automatically sorted on full_name, then first_name, then last_name (see example).
Screenshot 2024-11-12 at 4 03 22 PM

Testing:
The link is http://localhost:18000/enterprise/api/v1/enterprise-customer-members/{enterprise-uuid}
Check that each row has an enterprise_customer_user dict with info like first/last name and an enrollment count

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)
    • Trigger the 'Upgrade one Python dependency' action against master in edx-platform with new version number to generate version bump PR
    • 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.

@kiram15 kiram15 requested a review from a team October 29, 2024 20:06
@kiram15 kiram15 changed the title [DRAFT] feat: creating new enterprise group members endpoint Oct 29, 2024
Copy link
Contributor

@katrinan029 katrinan029 left a comment

Choose a reason for hiding this comment

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

Looks good so far! I think we're just missing the sorting piece since we want the members table to be alphabetized per the design specs. https://www.figma.com/design/eMWRd2jVa4Jqc6y7qrUfaa/Groups-Phase-2?node-id=1193-6018&t=PancQEnrxtpLLI1J-1

CHANGELOG.rst Show resolved Hide resolved
tests/test_enterprise/api/test_views.py Outdated Show resolved Hide resolved
tests/test_enterprise/api/test_views.py Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants