-
Notifications
You must be signed in to change notification settings - Fork 270
fix: sidebar unitid undefined #1762
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
base: master
Are you sure you want to change the base?
fix: sidebar unitid undefined #1762
Conversation
Thanks for the pull request, @wgu-jesse-stewart! 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:
🔘 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. 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:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR fixes a bug where activeUnitId
is null when viewing a locked unit, causing null pointer errors in tracking events and completion checks. The fix adds defensive programming to prevent these errors when navigating from locked units.
- Adds null checks in
checkBlockCompletion
function to handle undefinedunitId
- Updates
handleUnitClick
to safely handle nullactiveUnitId
in sequence lookups and completion checks - Prevents tracking events and completion checks from running when unit data is unavailable
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
File | Description |
---|---|
src/courseware/data/thunks.js | Adds early return in checkBlockCompletion when unitId is null/undefined |
src/courseware/course/sidebar/sidebars/course-outline/hooks.js | Adds defensive checks in handleUnitClick for null unit IDs and sequences |
Comments suppressed due to low confidence (1)
src/courseware/course/sidebar/sidebars/course-outline/hooks.js:77
- [nitpick] The parameter name 'searchUnitId' is inconsistent with the original 'activeUnitId' usage. Consider using 'unitId' for consistency.
const findSequenceByUnitId = (searchUnitId) => {
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1762 +/- ##
==========================================
+ Coverage 90.46% 90.49% +0.03%
==========================================
Files 344 344
Lines 5812 5820 +8
Branches 1360 1405 +45
==========================================
+ Hits 5258 5267 +9
+ Misses 537 536 -1
Partials 17 17 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Sandbox deployment failed 💥 |
Sandbox deployment failed 💥 |
Sandbox deployment successful 🚀 |
Fixes #1747
This bug is due to activeUnitId being null when viewing a locked unit. The fix was to add some defensiveness to the handleUnitClick and checkBlockCompletion functions.
This prevents sendTrackEvent, sendTrackingLogEvent, checkBlockCompletion from running when navigating from a locked unit. If those methods need to run, even when the unit is locked, then we need to add some more logic to handle that state without throwing a null pointer error.
459990789-b3f44230-e957-4c8f-b608-15b185d5e4d0.mp4