Skip to content

feat: pass pluginProps to wrapper #118

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.

Sign up for GitHub

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

Jump to bottom
Open
rpenido wants to merge 2 commits into
base: master
Choose a base branch
from
Open

feat: pass pluginProps to wrapper #118

rpenido wants to merge 2 commits into from
+61 −9

Conversation

@rpenido
Copy link

@rpenido rpenido commented Jan 19, 2026 •
edited
Loading

Description

In this PR, we add support to read the pluginProps using the PLUGIN_OPERATIONS.Wrap operation. This gives us more flexibility while using plugins, allowing the wrapper component to receive context from the PluginSlot.

There is a practical use here: openedx/frontend-plugin-aspects#115

Additional Information

Testing Instructions

Private ref: FAL-4299

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jan 19, 2026
@openedx-webhooks
Copy link

openedx-webhooks commented Jan 19, 2026

Thanks for the pull request, @rpenido!

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

1 similar comment
@openedx-webhooks
Copy link

openedx-webhooks commented Jan 19, 2026

Thanks for the pull request, @rpenido!

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

@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions Jan 19, 2026
@codecov
Copy link

codecov bot commented Jan 19, 2026 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.91%. Comparing base (b81f409) to head (15bb3db).

Additional details and impacted files 
@@           Coverage Diff           @@
##           master     #118   +/-   ##
=======================================
  Coverage   95.91%   95.91%           
=======================================
  Files          10       10           
  Lines         245      245           
  Branches       75       75           
=======================================
  Hits          235      235           
  Misses          9        9           
  Partials        1        1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@mphilbrick211 mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Jan 20, 2026
@rpenido rpenido force-pushed the rpenido/pass-pluginProps-to-wrapper branch 4 times, most recently from 674cdbc to 797e0df Compare January 21, 2026 22:13
@rpenido rpenido force-pushed the rpenido/pass-pluginProps-to-wrapper branch from 797e0df to ab13fc4 Compare January 22, 2026 19:56
@rpenido rpenido mentioned this pull request Jan 22, 2026
Draft
7 tasks
arbrandes
arbrandes requested changes Jan 23, 2026
View reviewed changes
Copy link
Contributor

@arbrandes arbrandes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks eminently reasonable, but I'm concerned about backward compatibility. Do you mind adding unit tests that verify that not having any pluginProps specified both in the slot itself and in the user-provided wrapper won't break anything?

src/plugins/data/utils.test.jsx
describe('when provided with a single wrapper in an array', () => {
it('should wrap the provided component', () => {
const wrappedComponent = wrapComponent(mockRenderWidget, [makeMockElementWrapper()]);
const wrappedComponent = wrapComponent(mockRenderWidget, [makeMockElementWrapper()], { prop1: 'prop1' });
Copy link
Contributor

@arbrandes arbrandes Jan 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please add a test where a component gets wrapped specifically without any pluginProps?

Copy link
Author

@rpenido rpenido Jan 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the review @arbrandes!

Done: 15bb3db

README.rst
.. code-block::
const wrapWidget = ({ component, idx }) => (
const wrapWidget = ({ component, idx, pluginProps }) => (
Copy link
Contributor

@arbrandes arbrandes Jan 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was wrong before the PR, but do you mind fixing it? idx is not referenced at all by createElement.

Copy link
Author

@rpenido rpenido Jan 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if I got it..
The idx is being used as key here:

frontend-plugin-framework/src/plugins/data/utils.jsx

Line 91 in b81f409

(component, wrapper, idx) => React.createElement(wrapper, { component, key: idx }),

src/plugins/PluginSlot.test.jsx
}

function PluginSlotWrapper({ slotOptions, children }) {
function PluginSlotWrapper({ slotOptions, children, pluginProps }) {
Copy link
Contributor

@arbrandes arbrandes Jan 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this file, please create a new set of tests for when there are no pluginProps specified.

Copy link
Author

@rpenido rpenido Jan 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done: 15bb3db

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@arbrandes arbrandes arbrandes requested changes

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

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

Projects

Contributions
Status: Waiting on Author

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@rpenido @openedx-webhooks @arbrandes