Skip to content

refactor: remove unused team-members/library/permissions-by-role API and hooks#169

Draft
dcoa wants to merge 1 commit into
openedx:masterfrom
eduNEXT:dcoa/rm-unused-api
Draft

refactor: remove unused team-members/library/permissions-by-role API and hooks#169
dcoa wants to merge 1 commit into
openedx:masterfrom
eduNEXT:dcoa/rm-unused-api

Conversation

@dcoa

@dcoa dcoa commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

Summary

Deletes dead data-layer code that's no longer referenced after the team/roles views were reworked: three API functions, three React Query hooks, their tests, and the now-orphaned types.

What's removed & why

  • authz-module/data/api.ts: getTeamMembers, getLibrary, getPermissionsByRole, plus their response/param types (GetTeamMembersResponse, PermissionsByRole). Also drops the now-unused getStudioApiUrl and LibraryMetadata/TeamMember imports.
  • authz-module/data/hooks.ts: useTeamMembers, usePermissionsByRole, useLibrary and their query keys; simplifies the onSettled cache invalidation in useAssignTeamMembersRole/useRevokeUserRoles (no more per-scope teamMembers/permissionsByRole invalidation); routes the scopes query key through authzQueryKeys.scopes(params).
  • data/utils.ts: removes the orphaned getStudioApiUrl.
  • types.ts: removes the unused TeamMember and LibraryMetadata interfaces.
  • Tests: removes the suites covering the deleted functions/hooks (data/api.test.tsx, data/hooks.test.tsx).

Depends on:

ContextType which is introduced in #164

Quality gate will fail until dependency is merged

AI use acknowledgement

Supported by Claude Code

@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @dcoa!

This repository is currently maintained by @openedx/committers-frontend.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Update the status of your PR

Your PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate.


Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Jun 25, 2026
@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Jun 25, 2026
@codecov

codecov Bot commented Jun 25, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.44%. Comparing base (e3d90d8) to head (364fd14).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #169   +/-   ##
=======================================
  Coverage   97.44%   97.44%           
=======================================
  Files          66       66           
  Lines        1525     1488   -37     
  Branches      386      358   -28     
=======================================
- Hits         1486     1450   -36     
+ Misses         39       38    -1     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@mphilbrick211 mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Jun 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Status: Waiting on Author

Development

Successfully merging this pull request may close these issues.

3 participants