Skip to content

feat: handle duplicate children in container pages [FC-0112]#2584

Merged
ChrisChV merged 9 commits intoopenedx:masterfrom
open-craft:navin/fal-4270/duplicate-selection
Nov 3, 2025
Merged

feat: handle duplicate children in container pages [FC-0112]#2584
ChrisChV merged 9 commits intoopenedx:masterfrom
open-craft:navin/fal-4270/duplicate-selection

Conversation

@navinkarkera
Copy link
Copy Markdown
Contributor

@navinkarkera navinkarkera commented Oct 30, 2025

Description

If we have duplicate container or component in parent page in library, clicking on one of them selects both and removing any one from the parent blocks removes all instances.
This PR handles duplicates by including index/order_number of each child component in the url and using it to exclude a single instance and update parent structure.

Useful information to include:

  • Which user roles will this change impact? "Course Author"
image image

Supporting information

Testing instructions

  • Add same child item under any unit/subsection/section
  • Verify that you can select one element and remove it while maintaining the correct order.

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 Oct 30, 2025
@openedx-webhooks
Copy link
Copy Markdown

openedx-webhooks commented Oct 30, 2025

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.

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.

@codecov
Copy link
Copy Markdown

codecov Bot commented Oct 30, 2025

Codecov Report

❌ Patch coverage is 98.13084% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 94.81%. Comparing base (36c9eba) to head (5d929ae).
⚠️ Report is 2 commits behind head on master.

Files with missing lines Patch % Lines
.../library-authoring/components/ComponentRemover.tsx 96.42% 1 Missing ⚠️
src/library-authoring/data/apiHooks.ts 91.66% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff            @@
##           master    #2584    +/-   ##
========================================
  Coverage   94.81%   94.81%            
========================================
  Files        1225     1225            
  Lines       27481    27514    +33     
  Branches     6187     6037   -150     
========================================
+ Hits        26056    26088    +32     
- Misses       1367     1368     +1     
  Partials       58       58            

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

@navinkarkera navinkarkera force-pushed the navin/fal-4270/duplicate-selection branch from 0b97bc8 to 7a536e9 Compare October 30, 2025 11:21
@navinkarkera navinkarkera marked this pull request as ready for review October 30, 2025 14:04
@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Oct 30, 2025
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Oct 30, 2025
Comment on lines +61 to +65

afterEach(() => {
jest.clearAllMocks();
axiosMock.restore();
});
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
afterEach(() => {
jest.clearAllMocks();
axiosMock.restore();
});

This is not necessary - initializeMocks() already calls clearAllMocks() for you, and it re-creates the axiosMock each time.

Comment thread src/library-authoring/data/api.ts Outdated
* Fetch a library container's children's metadata.
*/
export async function getLibraryContainerChildren(
export async function getLibraryContainerChildren<T>(
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Instead of T can you call this ChildType or something more obvious, and make it default to LibraryBlockMetadata[] | Container[] ?

Suggested change
export async function getLibraryContainerChildren<T>(
export async function getLibraryContainerChildren<ChildType = LibraryBlockMetadata | Container>(

Same with useContainerChildren - just looking at the hook it's not obvious what the T type parameter is for, and it should have a sensible default type.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

That looks better. Thanks!

@navinkarkera navinkarkera force-pushed the navin/fal-4270/duplicate-selection branch from 0229f95 to b97b548 Compare October 31, 2025 05:55
@navinkarkera navinkarkera changed the title feat: handle duplicate children in container pages feat: handle duplicate children in container pages [FC-0112] Oct 31, 2025
@navinkarkera navinkarkera force-pushed the navin/fal-4270/duplicate-selection branch from b97b548 to 4af212b Compare October 31, 2025 06:04
Copy link
Copy Markdown
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

Copy link
Copy Markdown
Contributor

@ChrisChV ChrisChV left a comment

Choose a reason for hiding this comment

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

@navinkarkera Looks good! I commented on some nits

Comment thread src/library-authoring/containers/ContainerRemover.test.tsx Outdated
Comment thread src/library-authoring/containers/ContainerRemover.test.tsx Outdated
Comment thread src/library-authoring/containers/ContainerRemover.test.tsx
Comment thread src/library-authoring/containers/ContainerRemover.test.tsx Outdated
Comment thread src/library-authoring/units/LibraryUnitPage.test.tsx Outdated
@navinkarkera navinkarkera force-pushed the navin/fal-4270/duplicate-selection branch from 4af212b to 5d929ae Compare November 3, 2025 07:13
@navinkarkera
Copy link
Copy Markdown
Contributor Author

@ChrisChV This is ready to be merged.

@ChrisChV ChrisChV merged commit 75ae9d5 into openedx:master Nov 3, 2025
7 checks passed
@github-project-automation github-project-automation Bot moved this from Ready for Review to Done in Contributions Nov 3, 2025
@ChrisChV ChrisChV deleted the navin/fal-4270/duplicate-selection branch November 3, 2025 14:59
navinkarkera added a commit to open-craft/frontend-app-authoring that referenced this pull request Nov 5, 2025
…#2584)

If we have duplicate container or component in parent page in library, clicking on one of them selects both and removing any one from the parent blocks removes all instances.
This PR handles duplicates by including index/order_number of each child component in the url and using it to exclude a single instance and update parent structure.

(cherry picked from commit 75ae9d5)
ChrisChV pushed a commit that referenced this pull request Nov 5, 2025
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

Archived in project

Development

Successfully merging this pull request may close these issues.

6 participants