Skip to content

fix: do not render plugins with invalid configurations - #129

Open
cpruijsen wants to merge 1 commit into
openedx:masterfrom
cpruijsen:fix/issue-68
Open

cpruijsen wants to merge 1 commit into
openedx:masterfrom
cpruijsen:fix/issue-68

Conversation

@cpruijsen

Copy link
Copy Markdown

A plugin config missing priority still renders, but every plugin in the slot loses its configured
order. One incomplete entry silently reorders the whole slot, and the app looks wrong rather than
reporting anything.

validatePlugin in src/plugins/data/utils.jsx logged an error for a missing op and then carried on
returning a truthy value, so an invalid config was reported and kept. It now returns false for a
config whose op is not one of PLUGIN_OPERATIONS, so the entry is dropped rather than sorted with an
undefined priority.

The operation check is against the actual set of valid operations rather than a truthiness test, since
an op that is present but not a real operation has the same effect as a missing one.

The docstring said the function throws; it logs and returns, which is what callers depend on, so it now
says that.

Tests cover a missing op, an invalid one, and that a valid slot still orders by priority.

Fixes #68

Plugin changes whose config failed validation (e.g. an Insert widget
missing its priority) were still applied to the slot. The missing
priority produced NaN in the ordering comparator, which Array.sort
treats as equal, scrambling the order of every widget in the slot.

validatePlugin now returns false for invalid configs and organizePlugins
skips the change entirely: the misconfigured plugin is not rendered,
operations targeting it become no-ops, and the logged error still
indicates the misconfiguration. This also prevents invalid plugin
operations from throwing a TypeError during validation.
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Sep 14, 2026
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @cpruijsen!

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

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.

Bug: Plugin configuration missing priority value will still render Plugin, but disrupts ordering

2 participants