Display Container Publish status and confirm before publish #2186

pomegranited · 2025-06-17T21:52:12Z

Description

Updates the Container sidebar to display:

A confirmation step before publishing the container.
Text + a full hierarchy to better demonstrate what will be published when the container is published.

Content Library Authors are affected by this change.

Supporting information

Part of:

Depends on:

Private-ref: FAL-4178

Screenshots

New Usage tab

New "Confirm Publish" area

Testing instructions

Create a content library
Add a section and view its Usage tab: should see the section by itself since it has no children yet.
Repeat ^ for subsection, unit, and component.
Add the subsection to the section: note that the Usage tab hierarchy updates to show the child. (see designs)
Repeat ^ for subsection and unit.
Add multiple children to the parent containers: check that the hierarchy shows a child count instead of their titles.
Publish changes to each container type -- ensure the "confirm publish" step correctly reflects the container's hierarchy and the containers' publish status. (see designs)

Other notes

More backend work is needed to publish containers properly: Publishing containers currently only publishes one level of children, and there's also work that needs to be done to propagating the published_date back up through the parent containers.
I was unable to show the parent container name in the publish confirmation message.
If the full hierarchy API is deemed to not be performant enough, commits 72cc747 + 6363d70 can be omitted.

Settings

EDX_PLATFORM_REPOSITORY: https://github.com/open-craft/edx-platform.git
EDX_PLATFORM_VERSION: chris/FAL-4180-sections-subsections-publish

OPENEDX_EXTRA_PIP_REQUIREMENTS:
- dnspython
- git+https://github.com/openedx/openedx-learning.git@refs/pull/333/head#egg=openedx-learning

so we can use it in both containers and section-subsection

openedx-webhooks · 2025-06-17T21:52:16Z

Thanks for the pull request, @pomegranited!

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.

src/library-authoring/generic/status-widget/StatusWidget.scss

pomegranited · 2025-06-18T23:04:07Z

src/library-authoring/generic/status-widget/StatusWidget.scss

+%draft-status {
+  background-color: #FDF3E9;
+  border-color: #F4B57B !important;
+  color: #00262B;


Should we add a design token color for these? see e.g https://github.com/openedx/paragon/blob/f154be3332d917db51fdb68bf9d20e891212f69a/styles/css/themes/light/variables.css#L640

Probably, yes. Shouldn't already existing paragon tokens be preferred? or is it normal for designs to contain new colors that are configured afterwards as design tokens?

…sh-container

codecov · 2025-06-19T18:34:35Z

Codecov Report

❌ Patch coverage is 97.26776% with 5 lines in your changes missing coverage. Please review.
✅ Project coverage is 94.49%. Comparing base (be82e96) to head (301b2fe).

Files with missing lines	Patch %	Lines
...ibrary-authoring/containers/ContainerHierarchy.tsx	96.72%	2 Missing ⚠️
...ry-authoring/containers/ContainerPublishStatus.tsx	97.61%	2 Missing ⚠️
src/library-authoring/data/api.ts	80.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2186      +/-   ##
==========================================
+ Coverage   94.47%   94.49%   +0.01%     
==========================================
  Files        1169     1172       +3     
  Lines       25141    25307     +166     
  Branches     5376     5542     +166     
==========================================
+ Hits        23753    23914     +161     
- Misses       1323     1328       +5     
  Partials       65       65

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

Had to convert generic/Loading.jsx to tsx to make this work.

…sh-container

which uses the container hierarchy API.

in "Confirm Publish" box. Refactors the ContainerPublishStatus component to use the container hierarchy API instead of the search engine. Plus fixes some styles.

open-craft-grove · 2025-07-02T14:52:47Z

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

DanielVZ96

Besides the already mentioned problem with only direct children being published, LGTM. I also left some comments but nothing critical.

src/library-authoring/containers/ContainerHierarchy.tsx

src/library-authoring/containers/ContainerPublishStatus.tsx

DanielVZ96 · 2025-07-02T15:49:28Z

src/library-authoring/generic/status-widget/StatusWidget.scss

+%draft-status {
+  background-color: #FDF3E9;
+  border-color: #F4B57B !important;
+  color: #00262B;


Probably, yes. Shouldn't already existing paragon tokens be preferred? or is it normal for designs to contain new colors that are configured afterwards as design tokens?

open-craft-grove · 2025-07-03T09:40:34Z

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

open-craft-grove · 2025-07-23T18:56:05Z

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

open-craft-grove · 2025-07-23T22:28:52Z

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

open-craft-grove · 2025-07-23T23:10:13Z

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

open-craft-grove · 2025-07-24T09:14:12Z

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

ChrisChV

Looks good! 👍

I tested this: I followed the testing instructions and I tested with different states
I read through the code and considered the security, stability and performance implications of the changes.
I tested that the UI can be used with a keyboard only (tab order, keyboard controls).
Includes tests for bugfixes and/or features added.
Includes documentation
Includes fixtures that create objects required for manual testing.

open-craft-grove · 2025-08-15T14:16:21Z

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

open-craft-grove · 2025-08-15T15:06:15Z

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

pomegranited added 2 commits June 18, 2025 07:06

refactor: move draftChipText message to containers

c4b90ae

so we can use it in both containers and section-subsection

refactor: make status widget styles extendable

caef8df

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 Jun 17, 2025

openedx-webhooks added this to Contributions Jun 17, 2025

github-project-automation bot moved this to Needs Triage in Contributions Jun 17, 2025

pomegranited added 2 commits June 19, 2025 03:20

feat: show container publish status and confirm publish box (text only)

583a30a

feat: add custom warning message to container publish box

1f096b7

pomegranited force-pushed the jill/FAL-4178-publish-container branch from feafb0c to 1f096b7 Compare June 18, 2025 19:44

pomegranited commented Jun 18, 2025

View reviewed changes

src/library-authoring/generic/status-widget/StatusWidget.scss Outdated Show resolved Hide resolved

pomegranited commented Jun 18, 2025

View reviewed changes

Merge remote-tracking branch 'origin/master' into jill/FAL-4178-publi…

7ab9e25

…sh-container

pomegranited force-pushed the jill/FAL-4178-publish-container branch from 8557399 to 7ab9e25 Compare June 19, 2025 18:24

chore: use import @src/... syntax for files modified here

2e52679

Had to convert generic/Loading.jsx to tsx to make this work.

mphilbrick211 moved this from Needs Triage to Product Review in Contributions Jun 20, 2025

mphilbrick211 moved this from Product Review to Waiting on Author in Contributions Jun 20, 2025

pomegranited added 3 commits June 28, 2025 22:15

Merge remote-tracking branch 'origin/master' into jill/FAL-4178-publi…

244d6af

…sh-container

feat: adds ContainerHierarchy component

72cc747

which uses the container hierarchy API.

test: fix invalidated query key count

96d9445

pomegranited mentioned this pull request Jun 29, 2025

perf: select related objects in container queries openedx/openedx-learning#333

Merged

feat: show container hierarchy with publish status

6363d70

in "Confirm Publish" box. Refactors the ContainerPublishStatus component to use the container hierarchy API instead of the search engine. Plus fixes some styles.

pomegranited mentioned this pull request Jul 1, 2025

feat: adds api to retrieve library block/container hierarchy [FC-0090] openedx/edx-platform#36813

Open

pomegranited marked this pull request as ready for review July 1, 2025 11:38

pomegranited requested a review from DanielVZ96 July 1, 2025 11:42

pomegranited added the create-sandbox open-craft-grove should create a sandbox environment from this PR label Jul 2, 2025

DanielVZ96 approved these changes Jul 2, 2025

View reviewed changes

bradenmacdonald added the FC Relates to an Axim Funded Contribution project label Jul 8, 2025

Merge branch 'master' into jill/FAL-4178-publish-container

0b76212

fix: invalidate item hierarchy on add/remove to/from container

299f37e

rpenido force-pushed the jill/FAL-4178-publish-container branch from e8ed50d to 299f37e Compare July 23, 2025 22:07

ChrisChV approved these changes Jul 24, 2025

View reviewed changes

bradenmacdonald mentioned this pull request Aug 7, 2025

Publish side effects: state summary edition openedx/openedx-learning#328

Draft

Merge branch 'master' into jill/FAL-4178-publish-container

b235683

rpenido force-pushed the jill/FAL-4178-publish-container branch from 73ebb24 to b235683 Compare August 15, 2025 13:29

test: fix test

301b2fe

Display Container Publish status and confirm before publish #2186

Are you sure you want to change the base?

Display Container Publish status and confirm before publish #2186

Conversation

pomegranited commented Jun 17, 2025 • edited by bradenmacdonald Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Supporting information

Screenshots

New Usage tab

New "Confirm Publish" area

Testing instructions

Other notes

Uh oh!

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

Uh oh!

Uh oh!

Uh oh!

pomegranited Jun 18, 2025

Choose a reason for hiding this comment

Uh oh!

DanielVZ96 Jul 2, 2025

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

open-craft-grove commented Jul 2, 2025

Uh oh!

DanielVZ96 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

DanielVZ96 Jul 2, 2025

Choose a reason for hiding this comment

Uh oh!

open-craft-grove commented Jul 3, 2025

Uh oh!

open-craft-grove commented Jul 23, 2025

Uh oh!

open-craft-grove commented Jul 23, 2025

Uh oh!

open-craft-grove commented Jul 23, 2025

Uh oh!

open-craft-grove commented Jul 24, 2025

Uh oh!

ChrisChV left a comment

Choose a reason for hiding this comment

Uh oh!

open-craft-grove commented Aug 15, 2025

Uh oh!

open-craft-grove commented Aug 15, 2025

Uh oh!

Uh oh!

pomegranited commented Jun 17, 2025 •

edited by bradenmacdonald

Loading

openedx-webhooks commented Jun 17, 2025 •

edited

Loading

codecov bot commented Jun 19, 2025 •

edited

Loading