fix: use djangoapps app_name suffix in pii_check Makefile target#38667
fix: use djangoapps app_name suffix in pii_check Makefile target#38667Chessing234 wants to merge 1 commit into
Conversation
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>
|
Thanks for the pull request, @Chessing234! This repository is currently maintained by 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 approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo 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:
🔘 Submit a signed contributor agreement (CLA)
If you've signed an agreement in the past, you may need to re-sign. Once you've signed the CLA, please allow 1 business day for it to be processed. 🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere 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:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
Summary
Fixes
make pii_checkscanning zero Django models for both CMS and LMS.Fixes #38646
Bug
make pii_checkappeared to run but did not inspect CMS/LMS models because the--app_namefilter matched no installed apps.Root cause
code_annotationsfilters apps withapp.name.endswith(app_name). The Makefile passed--app_name cmsand--app_name lms, but installed apps are named likecms.djangoapps.contentstoreandlms.djangoapps.courseware, which do not end with the barecms/lmssuffix.Why this fix is correct
Use
--app_name cms.djangoappsand--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
cms.djangoapps.contentstore.endswith(cms.djangoapps) is truelms.djangoapps.courseware.endswith(lms.djangoapps) is truemake pii_checknow reports non-zero model counts (requires full dev env)Made with Cursor