Skip to content

fix: use djangoapps app_name suffix in pii_check Makefile target#38667

Open
Chessing234 wants to merge 1 commit into
openedx:masterfrom
Chessing234:fix/pii-check-app-name-suffix
Open

fix: use djangoapps app_name suffix in pii_check Makefile target#38667
Chessing234 wants to merge 1 commit into
openedx:masterfrom
Chessing234:fix/pii-check-app-name-suffix

Conversation

@Chessing234
Copy link
Copy Markdown

Summary

Fixes make pii_check scanning zero Django models for both CMS and LMS.

Fixes #38646

Bug

make pii_check appeared to run but did not inspect CMS/LMS models because the --app_name filter matched no installed apps.

Root cause

code_annotations filters apps with app.name.endswith(app_name). The Makefile passed --app_name cms and --app_name lms, but installed apps are named like cms.djangoapps.contentstore and lms.djangoapps.courseware, which do not end with the bare cms/lms suffix.

Why this fix is correct

Use --app_name cms.djangoapps and --app_name lms.djangoapps, which match the actual Django app namespace prefix used throughout edx-platform. This restores model discovery without widening the scan to unrelated third-party apps.

Test plan

  • Verified suffix logic: cms.djangoapps.contentstore.endswith(cms.djangoapps) is true
  • Verified suffix logic: lms.djangoapps.courseware.endswith(lms.djangoapps) is true
  • make pii_check now reports non-zero model counts (requires full dev env)

Made with Cursor

code_annotations filters apps with name.endswith(app_name). The bare
cms/lms suffix matched no installed apps, so make pii_check scanned zero
models despite reporting coverage.

Co-authored-by: Cursor <cursoragent@cursor.com>
@openedx-webhooks
Copy link
Copy Markdown

Thanks for the pull request, @Chessing234!

This repository is currently maintained by @openedx/wg-maintenance-openedx-platform.

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
🔘 Submit a signed contributor agreement (CLA)

⚠️ We ask all contributors to the Open edX project to submit a signed contributor agreement or indicate their institutional affiliation.
Please see the CONTRIBUTING file for more information.

If you've signed an agreement in the past, you may need to re-sign.
See The New Home of the Open edX Codebase for details.

Once you've signed the CLA, please allow 1 business day for it to be processed.
After this time, you can re-run the CLA check by adding a comment below that you have signed it.
If the CLA check continues to fail, you can tag the @openedx/cla-problems team in a comment for further assistance.

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

Details
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 the open-source-contribution PR author is not from Axim or 2U label May 27, 2026
@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions May 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Status: Needs Triage

Development

Successfully merging this pull request may close these issues.

pii_check may not really be checking

2 participants