feat: create section and subsection in library #2013

navinkarkera · 2025-05-21T11:12:45Z

Description

Adds create section and subsection buttons in sidebar.

Useful information to include:

Which edX user roles will this change impact? Common user roles are "Course Author"

Supporting information

Related to: Create new top-level section/subsection (Browse Page - Library Home) #1967
Private-ref: https://tasks.opencraft.com/browse/FAL-4170

Testing instructions

Use New button in library authoring page.
Verify that new section, subsection and unit buttons work.
Verify that the above buttons work as expected in collections as well, i.e., after creating container, it should be linked with the collection.

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.

openedx-webhooks · 2025-05-21T11:12:50Z

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.

codecov · 2025-05-21T15:35:24Z

Codecov Report

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

Project coverage is 93.95%. Comparing base (65605bf) to head (54ada1b).
Report is 2 commits behind head on master.

Files with missing lines	Patch %	Lines
src/library-authoring/add-content/AddContent.tsx	91.66%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2013      +/-   ##
==========================================
- Coverage   93.96%   93.95%   -0.01%     
==========================================
  Files        1155     1155              
  Lines       24128    24169      +41     
  Branches     5115     5242     +127     
==========================================
+ Hits        22671    22709      +38     
+ Misses       1389     1383       -6     
- Partials       68       77       +9

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

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 just added some nits.

rpenido · 2025-05-22T12:41:49Z

src/generic/key-utils.ts

  Unit = 'unit',
  /**
-   * Vertical is the old name for Unit. Generally, **please avoid using this term entirely in any libraries code** or
+   * Chapter, Sequential and Vertical is the old name for Unit.


nit

Suggested change

* Chapter, Sequential and Vertical is the old name for Unit.

* Chapter, Sequential and Vertical are the old names for Section, Subsection and Unit.

rpenido · 2025-05-22T12:43:40Z

src/library-authoring/add-content/AddContent.test.tsx

    const unitId = 'lct:orf1:lib1:unit:test-1';
    renderWithUnit(unitId);

    expect(await screen.findByRole('button', { name: 'Text' })).toBeInTheDocument();
+    screen.debug();


Suggested change

screen.debug();

rpenido · 2025-05-22T13:03:49Z

src/library-authoring/create-container/messages.ts

+  createUnitModalNamePlaceholder: {
+    id: 'course-authoring.library-authoring.modals.create-unit.form.name.placeholder',
+    defaultMessage: 'Give a descriptive title',
+    description: 'Placeholder of the Name field of the Create Unit modal form',
+  },
+  createSubsectionModalNamePlaceholder: {
+    id: 'course-authoring.library-authoring.modals.create-subsection.form.name.placeholder',
+    defaultMessage: 'Give a descriptive title',
+    description: 'Placeholder of the Name field of the Create Subsection modal form',
+  },
+  createSectionModalNamePlaceholder: {
+    id: 'course-authoring.library-authoring.modals.create-section.form.name.placeholder',
+    defaultMessage: 'Give a descriptive title',
+    description: 'Placeholder of the Name field of the Create Section modal form',
+  },


What do you think about removing the common strings here?

Suggested change

createUnitModalNamePlaceholder: {

id: 'course-authoring.library-authoring.modals.create-unit.form.name.placeholder',

defaultMessage: 'Give a descriptive title',

description: 'Placeholder of the Name field of the Create Unit modal form',

},

createSubsectionModalNamePlaceholder: {

id: 'course-authoring.library-authoring.modals.create-subsection.form.name.placeholder',

defaultMessage: 'Give a descriptive title',

description: 'Placeholder of the Name field of the Create Subsection modal form',

},

createSectionModalNamePlaceholder: {

id: 'course-authoring.library-authoring.modals.create-section.form.name.placeholder',

defaultMessage: 'Give a descriptive title',

description: 'Placeholder of the Name field of the Create Section modal form',

},

createContainerModalNamePlaceholder: {

id: 'course-authoring.library-authoring.modals.create-container.form.name.placeholder',

defaultMessage: 'Give a descriptive title',

description: 'Placeholder of the Name field of the Create Container modal form',

},

rpenido · 2025-05-22T19:16:08Z

src/library-authoring/add-content/AddContent.tsx

+    if (insideSection) {
+      // Should only allow adding subsections
+      return [subsectionButtonData];


To fix coverage and not let us forget it later:

Suggested change

if (insideSection) {

// Should only allow adding subsections

return [subsectionButtonData];

// istanbul ignore if: not implemented

if (insideSection) {

// Should only allow adding subsections

throw new Error('Not implemented');

// return [subsectionButtonData];

rpenido · 2025-05-22T19:17:35Z

src/library-authoring/add-content/AddContent.tsx

+    if (insideSubsection) {
+      // Should only allow adding units
+      return [unitButtonData];


ditto

Suggested change

if (insideSubsection) {

// Should only allow adding units

return [unitButtonData];

// istanbul ignore if: not implemented

if (insideSubsection) {

// Should only allow adding units

throw new Error('Not implemented');

// return [unitButtonData];

rpenido · 2025-05-22T19:19:51Z

src/library-authoring/add-content/AddContent.tsx

  return (
    <>
-      {(collectionId || unitId) && componentPicker && (
+      {visibleContentTypes.map((contentType) => (
+        <AddContentButton contentType={contentType} onCreateContent={onCreateContent} />


nit: missing key

Suggested change

<AddContentButton contentType={contentType} onCreateContent={onCreateContent} />

<AddContentButton key={contentType} contentType={contentType} onCreateContent={onCreateContent} />

Nice refactor, btw! 👍

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 May 21, 2025

openedx-webhooks added this to Contributions May 21, 2025

github-project-automation bot moved this to Needs Triage in Contributions May 21, 2025

navinkarkera added 6 commits May 22, 2025 10:51

feat: create section and subsection in library

bc29104

chore: fix lint issues

d9a7445

test: add new section and subsection

e4f1930

chore: fix lint issues

f64fd97

refactor: add content component

d71ac11

docs: add docs to create container modal component

54ada1b

navinkarkera force-pushed the navin/fal-4170/create-section-subsection branch from c5cf00a to 54ada1b Compare May 22, 2025 06:37

navinkarkera marked this pull request as ready for review May 22, 2025 06:47

navinkarkera requested review from rpenido and ChrisChV May 22, 2025 06:48

rpenido approved these changes May 22, 2025

View reviewed changes

mphilbrick211 added the FC Relates to an Axim Funded Contribution project label May 22, 2025

mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions May 22, 2025

mphilbrick211 moved this from Waiting on Author to In Eng Review in Contributions May 22, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: create section and subsection in library #2013

feat: create section and subsection in library #2013

Uh oh!

navinkarkera commented May 21, 2025 •

edited

Loading

Uh oh!

openedx-webhooks commented May 21, 2025 •

edited

Loading

Uh oh!

codecov bot commented May 21, 2025 •

edited

Loading

Uh oh!

rpenido left a comment

Uh oh!

rpenido May 22, 2025

Uh oh!

rpenido May 22, 2025

Uh oh!

rpenido May 22, 2025

Uh oh!

rpenido May 22, 2025

Uh oh!

rpenido May 22, 2025

Uh oh!

rpenido May 22, 2025

Uh oh!

Uh oh!

	* Chapter, Sequential and Vertical is the old name for Unit.
	* Chapter, Sequential and Vertical are the old names for Section, Subsection and Unit.

	<AddContentButton contentType={contentType} onCreateContent={onCreateContent} />
	<AddContentButton key={contentType} contentType={contentType} onCreateContent={onCreateContent} />

feat: create section and subsection in library #2013

Are you sure you want to change the base?

feat: create section and subsection in library #2013

Uh oh!

Conversation

navinkarkera commented May 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Supporting information

Testing instructions

Other information

Uh oh!

openedx-webhooks commented May 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented May 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

rpenido left a comment

Choose a reason for hiding this comment

Uh oh!

rpenido May 22, 2025

Choose a reason for hiding this comment

Uh oh!

rpenido May 22, 2025

Choose a reason for hiding this comment

Uh oh!

rpenido May 22, 2025

Choose a reason for hiding this comment

Uh oh!

rpenido May 22, 2025

Choose a reason for hiding this comment

Uh oh!

rpenido May 22, 2025

Choose a reason for hiding this comment

Uh oh!

rpenido May 22, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

navinkarkera commented May 21, 2025 •

edited

Loading

openedx-webhooks commented May 21, 2025 •

edited

Loading

codecov bot commented May 21, 2025 •

edited

Loading