Skip to content

Conversation

navinkarkera
Copy link
Contributor

@navinkarkera navinkarkera commented Sep 30, 2025

Description

The Add components button in item bank children page was not working.

Supporting information

Testing instructions

Test Add components button in children view page of Problem/Item bank in course unit.

Other information

Include anything else that will help reviewers and consumers understand the change.

  • Does this change depend on other changes elsewhere?
  • Any special concerns or limitations? For example: deprecations, migrations, security, or accessibility.

Best Practices Checklist

We're trying to move away from some deprecated patterns in this codebase. Please
check if your PR meets these recommendations before asking for a review:

  • Any new files are using TypeScript (.ts, .tsx).
  • Deprecated propTypes, defaultProps, and injectIntl patterns are not used in any new or modified code.
  • Tests should use the helpers in src/testUtils.tsx (specifically initializeMocks)
  • Do not add new fields to the Redux state/store. Use React Context to share state among multiple components.
  • Use React Query to load data from REST APIs. See any apiHooks.ts in this repo for examples.
  • All new i18n messages in messages.ts files have a description for translators to use.
  • Imports avoid using ../. To import from parent folders, use @src, e.g. import { initializeMocks } from '@src/testUtils'; instead of from '../../../../testUtils'

@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Sep 30, 2025
@openedx-webhooks
Copy link

Thanks for the pull request, @navinkarkera!

This repository is currently maintained by @bradenmacdonald.

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.

Copy link

codecov bot commented Oct 2, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.67%. Comparing base (a975f3b) to head (c21591f).
⚠️ Report is 3 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2491   +/-   ##
=======================================
  Coverage   94.67%   94.67%           
=======================================
  Files        1203     1203           
  Lines       26799    26821   +22     
  Branches     5874     5875    +1     
=======================================
+ Hits        25372    25393   +21     
- Misses       1368     1369    +1     
  Partials       59       59           

☔ 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 added the FC Relates to an Axim Funded Contribution project label Oct 2, 2025
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Oct 2, 2025
@rpenido rpenido self-requested a review October 3, 2025 17:56
Copy link
Contributor

@rpenido rpenido left a comment

Choose a reason for hiding this comment

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

LGTM 👍
Thank you for your work, @navinkarkera !

  • I tested this using the instructions from the PR
  • I read through the code
  • I checked for accessibility issues
  • Includes documentation

Note: The iframe was not refreshed after adding an item.

Comment on lines 56 to 66
} & (
{
componentPickerMode?: 'single',
onComponentSelected?: ComponentSelectedEvent,
onChangeComponentSelection?: never,
onComponentSelected: ComponentSelectedEvent,
onChangeComponentSelection?: ComponentSelectionChangedEvent,
} | {
componentPickerMode: 'multiple'
onComponentSelected?: never,
componentPickerMode?: 'multiple'
onComponentSelected?: ComponentSelectedEvent,
onChangeComponentSelection?: ComponentSelectionChangedEvent,
}
);
Copy link
Contributor

Choose a reason for hiding this comment

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

This was to make the ComponentPicker type safe with the events, but if it's causing problems on the AddComponent code, we can simplify it and just add componentPickerMode, onComponentSelected and onChangeComponentSelection directly on the props type.

I think the suggestion is not getting it right, but the props can go before line 56 (} & () and we can get rid of all these props compositions.

Suggested change
} & (
{
componentPickerMode?: 'single',
onComponentSelected?: ComponentSelectedEvent,
onChangeComponentSelection?: never,
onComponentSelected: ComponentSelectedEvent,
onChangeComponentSelection?: ComponentSelectionChangedEvent,
} | {
componentPickerMode: 'multiple'
onComponentSelected?: never,
componentPickerMode?: 'multiple'
onComponentSelected?: ComponentSelectedEvent,
onChangeComponentSelection?: ComponentSelectionChangedEvent,
}
);
componentPickerMode?: 'single' | 'multiple',
onComponentSelected?: ComponentSelectedEvent,
onChangeComponentSelection?: ComponentSelectionChangedEvent,
}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@rpenido Makes sense. Updated.


export const messageTypes = {
refreshXBlock: 'refreshXBlock',
refreshIframe: 'refreshIframe',
Copy link
Contributor

@rpenido rpenido Oct 3, 2025

Choose a reason for hiding this comment

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

Are we calling this somewhere?

After adding a component, the iframe is not refreshing on my stack.

Adding it after the sendMessageToIframe(messageTypes.addSelectedComponentsToBank, { selectedComponents }); call didn't work.
Calling sendMessageToIframe(messageTypes.refreshXBlock, null); trigger a refresh, but some times it refresh before the component is fully added because of racing conditions.

Edit: My bad. The refresh worked after I ran tutor dev exec cms npm run build-dev.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core contributor PR author is a Core Contributor (who may or may not have write access to this repo). FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U
Projects
Status: Ready for Review
Development

Successfully merging this pull request may close these issues.

4 participants