Skip to content

fix: sidebar unitid undefined #1743

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

Conversation

wgu-jesse-stewart
Copy link
Contributor

@wgu-jesse-stewart wgu-jesse-stewart commented Jun 27, 2025

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.

Sidebar-unitID-undefined.mp4

@openedx-webhooks
Copy link

Thanks for the pull request, @wgu-jesse-stewart!

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

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.


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 Jun 27, 2025
@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions Jun 27, 2025
Copy link

@Copilot Copilot AI left a 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 pull request fixes a bug where the active unit ID is null when viewing a locked unit by adding defensive checks in the handleUnitClick and checkBlockCompletion functions.

  • Added a guard clause to return immediately in checkBlockCompletion if unitId is falsy.
  • Updated handleUnitClick to verify both active and target sequences to prevent subsequent null pointer errors.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
src/courseware/data/thunks.js Adds a null-check for unitId in checkBlockCompletion to avoid running side-effect methods when unitId is undefined.
src/courseware/course/sidebar/sidebars/course-outline/hooks.js Refactors the findSequenceByUnitId helper and adds checks in handleUnitClick to ensure both active and target sequences exist before dispatching actions.

@wgu-jesse-stewart wgu-jesse-stewart changed the title Fix/sidebar unitid undefined fix:sidebar unitid undefined Jun 27, 2025
@wgu-jesse-stewart wgu-jesse-stewart changed the title fix:sidebar unitid undefined fix: sidebar unitid undefined Jun 27, 2025
@wgu-jesse-stewart wgu-jesse-stewart added waiting for eng review PR is ready for review. Review and merge it, or suggest changes. create-sandbox open-craft-grove should create a sandbox environment from this PR labels Jun 27, 2025
@open-craft-grove
Copy link

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

@wgu-jesse-stewart
Copy link
Contributor Author

@wgu-jesse-stewart wgu-jesse-stewart moved this from Needs Triage to Ready for Review in Contributions Jul 14, 2025
@github-project-automation github-project-automation bot moved this from Ready for Review to Done in Contributions Jul 15, 2025
@openedx-webhooks openedx-webhooks removed the waiting for eng review PR is ready for review. Review and merge it, or suggest changes. label Jul 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
create-sandbox open-craft-grove should create a sandbox environment from this PR open-source-contribution PR author is not from Axim or 2U
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Learner App - Sidebar unitid undefined TypeError
3 participants