Skip to content

feat: Add component to Unit [FC-0083] - #1784

Merged
ChrisChV merged 8 commits into
openedx:masterfrom
open-craft:chris/FAL-4058-add-component-to-unit
Apr 14, 2025
Merged

feat: Add component to Unit [FC-0083]#1784
ChrisChV merged 8 commits into
openedx:masterfrom
open-craft:chris/FAL-4058-add-component-to-unit

Conversation

@ChrisChV

@ChrisChV ChrisChV commented Apr 6, 2025

Copy link
Copy Markdown
Contributor

Description

  • Creation workflow in unit page.
  • Which edX user roles will this change impact? "Course Author".

image

Supporting information

Testing instructions

  • Go to the library home of a library.
  • Create a Unit.
  • Open the Unit page of the new unit.
  • Click on Add content button.
  • Create different blocks.
  • Verify that the blocks are created and appear on the unit page.

Other information

N/A

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

openedx-webhooks commented Apr 6, 2025

Copy link
Copy Markdown

Thanks for the pull request, @ChrisChV!

This repository is currently maintained by @openedx/2u-tnl.

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.

@ChrisChV
ChrisChV marked this pull request as draft April 6, 2025 16:14
@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Apr 6, 2025
@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Apr 7, 2025
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Apr 7, 2025
@ChrisChV
ChrisChV force-pushed the chris/FAL-4058-add-component-to-unit branch 2 times, most recently from c5db5e6 to 8835817 Compare April 9, 2025 01:11
@ChrisChV ChrisChV changed the title feat: Create new component within unit [FC-0083] feat: Add component to Unit [FC-0083] Apr 9, 2025
@ChrisChV
ChrisChV force-pushed the chris/FAL-4058-add-component-to-unit branch from 8835817 to ca6f216 Compare April 12, 2025 01:42
@ChrisChV
ChrisChV marked this pull request as ready for review April 12, 2025 02:10
@codecov

codecov Bot commented Apr 14, 2025

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 98.03922% with 1 line in your changes missing coverage. Please review.

Project coverage is 93.55%. Comparing base (a43027b) to head (5df64ae).
Report is 2 commits behind head on master.

Files with missing lines Patch % Lines
src/library-authoring/data/apiHooks.ts 88.88% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1784   +/-   ##
=======================================
  Coverage   93.54%   93.55%           
=======================================
  Files        1136     1136           
  Lines       23205    23241   +36     
  Branches     5000     5008    +8     
=======================================
+ Hits        21708    21742   +34     
- Misses       1421     1431   +10     
+ Partials       76       68    -8     

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

@bradenmacdonald bradenmacdonald left a comment

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.

Code looks good! Two minor optional suggestions. Merge whenever you're ready.

I didn't test this since it was already tested in open-craft#82.

addComponentsToCollectionMutation.mutateAsync([usageKey]).catch(() => {
showToast(intl.formatMessage(messages.errorAssociateComponentToCollectionMessage));
});
} else if (unitId) {

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
} else if (unitId) {
}
if (unitId) {

These don't necessarily have to be exclusive - you could perhaps create a component in a container in a collection.

*/
export async function addComponentsToContainer(containerId: string, componentIds: string[]) {
const client = getAuthenticatedHttpClient();
await client.post(

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.

Just suggesting a comment here to make things more clear, since I was a bit unsure about how this worked:

Suggested change
await client.post(
// POSTing to this URL will append children; PATCHing to it will replace the children.
await client.post(

@ChrisChV
ChrisChV enabled auto-merge (squash) April 14, 2025 22:18
@ChrisChV
ChrisChV merged commit a522c48 into openedx:master Apr 14, 2025
@github-project-automation github-project-automation Bot moved this from Waiting on Author to Done in Contributions Apr 14, 2025
@rpenido
rpenido deleted the chris/FAL-4058-add-component-to-unit branch April 15, 2025 18:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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.

4 participants