feat: container library-course sync diff prevew [FC-0097]

[navinkarkera]

Description

Container sync preview implemented as describe in #2176

screencast.mp4

Limitations:

• No easy way to distinguish containers that have only their name updated vs changes in their children. The version is updated in following cases, on container name change, on children order change and addition or deletion of a child component.

Useful information to include:

• Which user roles will this change impact? Author.

Supporting information

• Section/subsection sync dialog #2176
• Depends on refactor: course container children api openedx-platform#37375
• Private-ref: https://tasks.opencraft.com/browse/FAL-4246

Testing instructions

• Checkout edx-platform and this PR.
• Create sections, subsections, units and some components in a library in hierarchy.
• Imported them into a course.
• Update some components, units, subsections in library. Try different things, like adding, deleting, updating etc. and publish the library.
• Verify the preview diff in course.

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]

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:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

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]

Codecov Report

❌ Patch coverage is 97.08333% with 7 lines in your changes missing coverage. Please review.
✅ Project coverage is 94.65%. Comparing base (39e5f89) to head (0984882).
⚠️ Report is 2 commits behind head on master.

Files with missing lines	Patch %	Lines
src/container-comparison/data/api.mock.ts	77.41%	7 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2464      +/-   ##
==========================================
+ Coverage   94.64%   94.65%   +0.01%     
==========================================
  Files        1188     1195       +7     
  Lines       26237    26441     +204     
  Branches     5690     5742      +52     
==========================================
+ Hits        24832    25028     +196     
- Misses       1346     1354       +8     
  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.

[sdaitzman]

@navinkarkera thank you, this looks amazing!! I'm so excited about this progress. I'm adding a few minor notes on #2176 based on this PR, all of which can be tracked as minor followup issues if they are more than trivial

[rpenido]

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

I left one comment about a string translation.

[ChrisChV]

@navinkarkera

I found this issue:

• Import a section in a course
• Rename the section in the library, publish.
• Click on sync button. The new title doesn't appear in the "After" block

The same if the breadcrumbs for subsection and units:

@navinkarkera let me know how complex it is to solve that issue? (No more than 30 minutes to solve)

[navinkarkera]

@ChrisChV This would require more than 30 minutes to resolve since we'll need to fetch new and old names (currently, we only fetch children data).

[ChrisChV]

This would require more than 30 minutes to resolve since we'll need to fetch new and old names (currently, we only fetch children data).

Sure. I will merge it to continue with the AC testing. I will create a follow-up ticket to address this bug. Thanks!

[bradenmacdonald]

I'm testing out oxlint and it raised a valid warning about this code:

  ⚠ typescript-eslint(no-non-null-asserted-optional-chain):
Optional chain expressions can return undefined by design: using a non-null assertion is unsafe and wrong.

     ╭─[src/container-comparison/utils.ts:128:49]
 127 │   addedA.forEach((addedRow) => {
 128 │     updatedA.splice(mapB.get(addedRow.id)?.index!, 0, { ...addedRow, state: 'added' });
     ·                                          ┬      ┬
     ·                                          │      ╰── non-null assertion made after optional chain
     ·                                          ╰── optional chain used
 129 │   });
     ╰────
  help: Remove the non-null assertion.