feat: add component sidebar manage tab [FC-0062] #1275

rpenido · 2024-09-11T21:46:55Z

Description

This PR adds the Manage tab in the Component Sidebar.

More information

Part of:

Component Sidebar: Manage tab #1190

Depends on:

feat: return publishing information on get component endpoint [FC-0062] edx-platform#35476

Testing Instructions

Checkout this branch and feat: return publishing information on get component endpoint [FC-0062] edx-platform#35476
Create a new library and add a component to it
Click on the component and check the draft status on the Manage tab
Publish the library
Go back to the company and check the published status on the Manag tab

Private ref: FAL-3802

openedx-webhooks · 2024-09-11T21:46:59Z

Thanks for the pull request, @rpenido!

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.

codecov · 2024-09-12T12:01:54Z

Codecov Report

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

Project coverage is 92.34%. Comparing base (121ced4) to head (8206fc3).
Report is 5 commits behind head on master.

Files with missing lines	Patch %	Lines
src/library-authoring/data/api.ts	83.33%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #1275   +/-   ##
=======================================
  Coverage   92.33%   92.34%           
=======================================
  Files        1020     1023    +3     
  Lines       18838    18875   +37     
  Branches     3956     3964    +8     
=======================================
+ Hits        17395    17431   +36     
- Misses       1377     1378    +1     
  Partials       66       66

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

pomegranited

👍 This is working beautifully :) Thank you for making the StatusWidget a common component, and for fixing up those comments ❤️

I've requested some more tests, but once they're added, this is ready for CC review.

I tested this on my dev stack using the PR test instructions.
I read through the code
I checked for accessibility issues by using my keyboard
Includes documentation -- code comments
User-facing strings are extracted for translation

pomegranited · 2024-09-13T00:17:20Z

src/library-authoring/component-info/ComponentManagement.tsx

+      />
+      {[true, 'true'].includes(getConfig().ENABLE_TAGGING_TAXONOMY_PAGES)
+        && (
+        <Collapsible


Could you add a test that enables tagging to verify this code path? It's enough to just check for the presence + absence of "Tags" title, until we get that feature implemented.

Would be great if you could check for the Collections title too

pomegranited · 2024-09-13T00:23:14Z

src/library-authoring/component-info/ComponentManagement.test.tsx

+    expect(await screen.findByText('Draft')).toBeInTheDocument();
+    expect(screen.queryByText('Draft(Never Published)')).not.toBeInTheDocument();
+    expect(screen.queryByText('Draft saved on June 20, 2024 at 13:54 UTC.)')).not.toBeInTheDocument();
+  });


Could you add a test for the component published state too?

Done: 98ebc92

pomegranited · 2024-09-13T01:06:21Z

src/library-authoring/component-info/ComponentManagement.tsx

+        )}
+        className="border-0"
+      >
+        Collections placeholder


Is showing the component's Collections out of scope here? Thanks to your suggestions, we should have data available once edx-platform#35469 merges.

I will create a follow up tasks to handle the collections.

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

rpenido force-pushed the rpenido/fal-3802-component-sidebar-manage-tab branch 3 times, most recently from 6208ded to e1e97c6 Compare September 12, 2024 11:51

rpenido force-pushed the rpenido/fal-3802-component-sidebar-manage-tab branch 3 times, most recently from 3f1b358 to fac77e7 Compare September 12, 2024 13:52

rpenido mentioned this pull request Sep 12, 2024

feat: return publishing information on get component endpoint [FC-0062] openedx/edx-platform#35476

Merged

feat: add component sidebar manage tab

aa337c9

rpenido force-pushed the rpenido/fal-3802-component-sidebar-manage-tab branch from fac77e7 to aa337c9 Compare September 12, 2024 21:08

pomegranited approved these changes Sep 13, 2024

View reviewed changes

pomegranited reviewed Sep 13, 2024

View reviewed changes

rpenido mentioned this pull request Sep 13, 2024

feat: expose create_by field in PublishableEntityMixin [FC-0062] openedx/openedx-learning#227

Merged

rpenido added 2 commits September 13, 2024 16:33

Merge branch 'master' into rpenido/fal-3802-component-sidebar-manage-tab

fa81f31

test: fix mock typing

99428bc

rpenido force-pushed the rpenido/fal-3802-component-sidebar-manage-tab branch from 1101155 to 99428bc Compare September 14, 2024 03:43

rpenido added 2 commits September 14, 2024 01:40

test: fix tests

98ebc92

Merge branch 'master' into rpenido/fal-3802-component-sidebar-manage-tab

8206fc3

rpenido marked this pull request as ready for review September 16, 2024 14:54

rpenido requested a review from a team as a code owner September 16, 2024 14:54

rpenido requested a review from ChrisChV September 16, 2024 15:20

rpenido changed the title ~~feat: add component sidebar manage tab~~ feat: add component sidebar manage tab [FC-0062] Sep 16, 2024

ChrisChV approved these changes Sep 16, 2024

View reviewed changes

ChrisChV merged commit dd7e4d4 into openedx:master Sep 16, 2024
7 checks passed

ChrisChV deleted the rpenido/fal-3802-component-sidebar-manage-tab branch September 16, 2024 19:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add component sidebar manage tab [FC-0062] #1275

feat: add component sidebar manage tab [FC-0062] #1275

rpenido commented Sep 11, 2024 •

edited

Loading

openedx-webhooks commented Sep 11, 2024 •

edited

Loading

codecov bot commented Sep 12, 2024 •

edited

Loading

pomegranited left a comment

pomegranited Sep 13, 2024

pomegranited Sep 13, 2024

rpenido Sep 14, 2024

pomegranited Sep 13, 2024

rpenido Sep 14, 2024

feat: add component sidebar manage tab [FC-0062] #1275

feat: add component sidebar manage tab [FC-0062] #1275

Conversation

rpenido commented Sep 11, 2024 • edited Loading

Description

More information

Testing Instructions

openedx-webhooks commented Sep 11, 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?

codecov bot commented Sep 12, 2024 • edited Loading

Codecov Report

pomegranited left a comment

Choose a reason for hiding this comment

pomegranited Sep 13, 2024

Choose a reason for hiding this comment

pomegranited Sep 13, 2024

Choose a reason for hiding this comment

rpenido Sep 14, 2024

Choose a reason for hiding this comment

pomegranited Sep 13, 2024

Choose a reason for hiding this comment

rpenido Sep 14, 2024

Choose a reason for hiding this comment

rpenido commented Sep 11, 2024 •

edited

Loading

openedx-webhooks commented Sep 11, 2024 •

edited

Loading

codecov bot commented Sep 12, 2024 •

edited

Loading