feat: [FC-0070] rendering library content in unit page #1475

ihor-romaniuk · 2024-11-06T11:40:02Z

🚨 Dependencies:

Settings

EDX_PLATFORM_REPOSITORY: https://github.com/raccoongang/edx-platform.git
EDX_PLATFORM_VERSION: romaniuk/children-container-for-rendering-library

TUTOR_GROVE_NEW_MFES:
  authoring:
    port: 18000
    repository: https://github.com/raccoongang/frontend-app-course-authoring.git
    version: romaniuk/children-container-for-rendering-library

TUTOR_GROVE_WAFFLE_FLAGS:
  - name: contentstore.new_studio_mfe.use_new_unit_page
    everyone: true

TUTOR_GROVE_MFE_LMS_COMMON_SETTINGS:
  MFE_CONFIG:
    ENABLE_UNIT_PAGE: true

Description

This PR introduces functionality to display Library Content within the new Unit page interface.

The feature enables opening a Library Content page within the Unit page’s new interface. This page displays the xBlocks from the specified library and provides basic configuration options for the library.

Unit_Library_Content.mov

Related Pull Requests

feat: [FC-0070] rendering library content in unit page edx-platform#35785 - events to trigger click on View button and styles

Testing instructions

Create a new course.
Create several units.
Open the course unit page.
Add a Library xBlock to the unit.
Click the “View” button on the Library xBlock.

openedx-webhooks · 2024-11-06T11:40:07Z

Thanks for the pull request, @ihor-romaniuk!

What's next?

Please work through the following steps to get your changes 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.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/2u-tnl. Tag them in a comment and let them know that your changes are ready for review.

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.

bradenmacdonald · 2024-11-06T19:13:10Z

Just to be clear: this is v1 library content, right? And the old "randomized content block"?

We have #1462 #1463 #1464 scheduled to implement V2 on the MFE unit page.

codecov · 2024-11-25T10:58:08Z

Codecov Report

Attention: Patch coverage is 97.50000% with 2 lines in your changes missing coverage. Please review.

Project coverage is 92.92%. Comparing base (55fe87a) to head (f0c3e23).
Report is 4 commits behind head on master.

Files with missing lines	Patch %	Lines
src/course-unit/breadcrumbs/Breadcrumbs.tsx	95.83%	1 Missing ⚠️
src/course-unit/hooks.jsx	94.11%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff            @@
##           master    #1475    +/-   ##
========================================
  Coverage   92.91%   92.92%            
========================================
  Files        1065     1072     +7     
  Lines       20979    21097   +118     
  Branches     4537     4580    +43     
========================================
+ Hits        19493    19604   +111     
- Misses       1419     1420     +1     
- Partials       67       73     +6

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

open-craft-grove · 2024-11-25T13:37:38Z

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

ihor-romaniuk · 2024-11-25T15:37:14Z

@bradenmacdonald Yes, you are right. This is v1 library content.

src/course-unit/CourseUnit.jsx

src/course-unit/CourseUnit.test.jsx

src/course-unit/breadcrumbs/Breadcrumbs.jsx

src/course-unit/utils.test.ts

src/course-unit/utils.ts

open-craft-grove · 2024-11-26T17:21:38Z

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

bradenmacdonald

I haven't had time to review this yet, sorry. Will try to take a look tomorrow.

bradenmacdonald · 2024-11-26T23:58:49Z

src/course-unit/breadcrumbs/Breadcrumbs.tsx

+        {ancestorXblocks.map(({ children, title, isLast }, index) => (
+          <li
+            className="d-flex"
+            key={title}


Is title unique? If not, then maybe use {index} as the key ?

Replaced with key={`${title}-${index}`}

open-craft-grove · 2024-11-27T08:35:01Z

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

bradenmacdonald · 2024-11-27T21:31:27Z

When the unit iframe is small, and I click "+ Legacy Library", the iframe doesn't fit the editor modal that opens:

It's actually impossible to use because the buttons aren't accessible.

bradenmacdonald · 2024-11-27T21:38:05Z

Related Pull Requests
openedx/edx-platform#35785 - events to trigger click on View button and styles

^ This PR is actually a dependency and should be listed under "Dependencies" please :)

bradenmacdonald · 2024-11-27T21:44:52Z

src/course-unit/CourseUnit.jsx

-              <Breadcrumbs />
+              <Breadcrumbs
+                courseId={courseId}
+                sequenceId={sequenceId}


What on earth is a "sequence ID"? I think the variable / URL parameter sequenceId is very unclear, and poorly documented. Can we rename it to something more clear? Is it "parent ID"? "Parent Unit ID"? Or something else?

I know it was already in the code here, but I think it's a problem and we can fix it now.

It's also very weird that it comes after the ID of the child container in the URL, but it may be too late to change that.

Completely agree with you, and I tried to rename sequenceId to parentUnitId with minimal code impact.

bradenmacdonald · 2024-11-27T22:53:00Z

src/course-unit/header-navigations/HeaderNavigations.jsx

+          variant="outline-primary"
+          onClick={handleEdit}
+        >
+          {intl.formatMessage(messages.editButton)}


This edit button is not working for me. Nothing happens when I click it.

The edit functionality will be realized in pull request #1445 and then adopted to that page in pull request #1492 (if needed).

src/course-unit/header-navigations/messages.ts

src/course-unit/CourseUnit.jsx

src/course-unit/hooks.jsx

src/generic/configure-modal/messages.js

open-craft-grove · 2024-11-28T04:15:13Z

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

ihor-romaniuk · 2024-11-28T08:21:42Z

When the unit iframe is small, and I click "+ Legacy Library", the iframe doesn't fit the editor modal that opens:

Also related to edit functionality that will be realized in pull request #1445 and then adopted to that page in pull request #1492 (if needed).

open-craft-grove · 2024-11-28T09:35:37Z

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

bradenmacdonald

LGTM. Thanks.

src/course-unit/utils.ts

bradenmacdonald · 2024-11-28T17:22:32Z

src/setupTest.js

+  ACCOUNT_PROFILE_URL: process.env.ACCOUNT_PROFILE_URL || null,
+  ACCOUNT_SETTINGS_URL: process.env.ACCOUNT_SETTINGS_URL || null,
+  IGNORED_ERROR_REGEX: process.env.IGNORED_ERROR_REGEX || null,
+  MFE_CONFIG_API_URL: process.env.MFE_CONFIG_API_URL || null,


I'm not sure why these lines are included in this PR? Are they required for some of the new tests?

These configurations fix existing warnings in unit page tests.

open-craft-grove · 2024-12-02T16:35:12Z

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 6, 2024

ihor-romaniuk mentioned this pull request Nov 6, 2024

feat: [FC-0070] rendering library content in unit page openedx/edx-platform#35785

Open

ihor-romaniuk force-pushed the romaniuk/children-container-for-rendering-library branch from 9c96a31 to 89a6473 Compare November 6, 2024 13:52

ihor-romaniuk added the FC Relates to an Axim Funded Contribution project label Nov 7, 2024

This was referenced Nov 12, 2024

feat: [FC-0070] add events and style for rendering Split xblock in chromeless template openedx/edx-platform#35813

Draft

feat: [FC-0070] rendering split test content in unit page #1492

Draft

ihor-romaniuk force-pushed the romaniuk/children-container-for-rendering-library branch 2 times, most recently from 26c3235 to f836c6c Compare November 25, 2024 10:18

ihor-romaniuk marked this pull request as ready for review November 25, 2024 10:18

ihor-romaniuk requested a review from a team as a code owner November 25, 2024 10:18

ihor-romaniuk requested review from arbrandes, PKulkoRaccoonGang and bradenmacdonald November 25, 2024 10:20

ihor-romaniuk force-pushed the romaniuk/children-container-for-rendering-library branch from f836c6c to b53e28f Compare November 25, 2024 10:47

ihor-romaniuk force-pushed the romaniuk/children-container-for-rendering-library branch 2 times, most recently from 09c33b0 to f45ad06 Compare November 25, 2024 13:24

ihor-romaniuk added the create-sandbox open-craft-grove should create a sandbox environment from this PR label Nov 25, 2024

PKulkoRaccoonGang suggested changes Nov 26, 2024

View reviewed changes

ihor-romaniuk force-pushed the romaniuk/children-container-for-rendering-library branch from f45ad06 to 70f93f2 Compare November 26, 2024 17:07

bradenmacdonald reviewed Nov 27, 2024

View reviewed changes

ihor-romaniuk force-pushed the romaniuk/children-container-for-rendering-library branch 2 times, most recently from 2af7492 to c54f263 Compare November 28, 2024 08:54

bradenmacdonald approved these changes Nov 28, 2024

View reviewed changes

feat: [FC-0070] rendering library content in unit page

f0c3e23

ihor-romaniuk force-pushed the romaniuk/children-container-for-rendering-library branch from c54f263 to f0c3e23 Compare December 2, 2024 15:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: [FC-0070] rendering library content in unit page #1475

feat: [FC-0070] rendering library content in unit page #1475

ihor-romaniuk commented Nov 6, 2024 •

edited

Loading

openedx-webhooks commented Nov 6, 2024 •

edited

Loading

bradenmacdonald commented Nov 6, 2024

codecov bot commented Nov 25, 2024 •

edited

Loading

open-craft-grove commented Nov 25, 2024

ihor-romaniuk commented Nov 25, 2024

open-craft-grove commented Nov 26, 2024

bradenmacdonald left a comment

bradenmacdonald Nov 26, 2024

ihor-romaniuk Nov 28, 2024

open-craft-grove commented Nov 27, 2024

bradenmacdonald commented Nov 27, 2024 •

edited

Loading

bradenmacdonald commented Nov 27, 2024

bradenmacdonald Nov 27, 2024

ihor-romaniuk Nov 28, 2024

bradenmacdonald Nov 27, 2024

ihor-romaniuk Nov 28, 2024

open-craft-grove commented Nov 28, 2024

ihor-romaniuk commented Nov 28, 2024

open-craft-grove commented Nov 28, 2024

bradenmacdonald left a comment

bradenmacdonald Nov 28, 2024

ihor-romaniuk Dec 2, 2024

open-craft-grove commented Dec 2, 2024

feat: [FC-0070] rendering library content in unit page #1475

Are you sure you want to change the base?

feat: [FC-0070] rendering library content in unit page #1475

Conversation

ihor-romaniuk commented Nov 6, 2024 • edited Loading

Description

Related Pull Requests

Testing instructions

openedx-webhooks commented Nov 6, 2024 • edited Loading

What's next?

🔘 Get product approval

🔘 Provide context

🔘 Get a green build

🔘 Let us know that your PR is ready for review:

Who will review my changes?

Where can I find more information?

When can I expect my changes to be merged?

bradenmacdonald commented Nov 6, 2024

codecov bot commented Nov 25, 2024 • edited Loading

Codecov Report

open-craft-grove commented Nov 25, 2024

ihor-romaniuk commented Nov 25, 2024

open-craft-grove commented Nov 26, 2024

bradenmacdonald left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

open-craft-grove commented Nov 27, 2024

bradenmacdonald commented Nov 27, 2024 • edited Loading

bradenmacdonald commented Nov 27, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

open-craft-grove commented Nov 28, 2024

ihor-romaniuk commented Nov 28, 2024

open-craft-grove commented Nov 28, 2024

bradenmacdonald left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

open-craft-grove commented Dec 2, 2024

ihor-romaniuk commented Nov 6, 2024 •

edited

Loading

openedx-webhooks commented Nov 6, 2024 •

edited

Loading

codecov bot commented Nov 25, 2024 •

edited

Loading

bradenmacdonald commented Nov 27, 2024 •

edited

Loading