feat: adds Library Content button to Studio Unit page [FC-0062] #35670

navinkarkera · 2024-10-18T06:56:16Z

Built on top of: open-craft#699 and #35636

Depends on

refactor: picker component to only post message with block info [FC-0062] frontend-app-authoring#1401
refactor: remove parentLocator and next button from component picker [FC-0062] frontend-app-authoring#1412

First iteration

vokoscreenNG-2024-10-18_17-57-00.mp4

Second iteration

vokoscreenNG-2024-10-21_11-16-03.mp4

Test instructions:

Check out this branch
Run tutor dev exec lms openedx-assets build --env=dev to rebuild JS files
Check out refactor: picker component to only post message with block info [FC-0062] frontend-app-authoring#1401 in authoring MFE
Disable browser cache and view the unit page

openedx-webhooks · 2024-10-18T06:56:19Z

Thanks for the pull request, @navinkarkera!

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/wg-maintenance-edx-platform. 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.

navinkarkera · 2024-10-18T12:35:54Z

cms/static/js/views/pages/container.js

+                placeholderElement.remove();
+            });
+        },
+
        duplicateComponent: function(xblockElement) {
            // A placeholder element is created in the correct location for the duplicate xblock
            // and then onNewXBlock will replace it with a rendering of the xblock. Note that


This file has many duplicate functions like deleteXBlock, duplicateXBlock, showMoveXBlockModal etc.

openedx/core/djangoapps/content_staging/api.py

kdmccormick · 2024-10-18T16:59:43Z

cms/djangoapps/contentstore/views/block.py

+                :library_content_key: the key of the library content to add. (Incompatible with
+                     all other fields except parent_locator)


Having this POST arg will be nice, so that we don't have to follow up the request with a PUT 👍🏻

@kdmccormick Yes, called upstream sync after creating the block in a single call, simplified the js part. bc27ba3

iframes the Authoring MFE's Library Content Picker

Removes need to call a follow up PUT request

navinkarkera

It seems like upstream sync will only support blocks that were published. Currently the component picker shows all components including drafts that were never published.

navinkarkera · 2024-10-19T11:36:23Z

cms/static/js/views/pages/container.js

@@ -224,7 +225,7 @@ function($, _, Backbone, gettext, BasePage,
        },

        initializePasteButton() {
-            if (this.options.canEdit && !self.options.isIframeEmbed) {
+            if (this.options.canEdit && !this.options.isIframeEmbed) {


Fixes a typo/bug introduced in #35587

navinkarkera · 2024-10-19T11:36:30Z

cms/static/js/views/pages/container.js

@@ -241,7 +242,7 @@ function($, _, Backbone, gettext, BasePage,
        refreshPasteButton(data) {
            // Do not perform any changes on paste button since they are not
            // rendered on Library or LibraryContent pages
-            if (!this.isLibraryPage && !this.isLibraryContentPage && !self.options.isIframeEmbed) {
+            if (!this.isLibraryPage && !this.isLibraryContentPage && !this.options.isIframeEmbed) {


Fixes a typo/bug introduced in #35587

bradenmacdonald · 2024-10-19T18:04:12Z

It seems like upstream sync will only support blocks that were published. Currently the component picker shows all components including drafts that were never published.

We have a separate story for that which @ChrisChV is working on: openedx/frontend-app-authoring#1354 / https://tasks.opencraft.com/browse/FAL-3881

bradenmacdonald · 2024-10-19T18:05:34Z

I also have a draft "published" filter but it turns out to need some backend changes to implement and I haven't had time. CC @ChrisChV . openedx/frontend-app-authoring#1406

bradenmacdonald

Nice! It's working well. Here are some minor things I've noted that we should clean up:

cms/djangoapps/contentstore/utils.py

cms/djangoapps/contentstore/views/component.py

cms/djangoapps/contentstore/xblock_storage_handlers/view_handlers.py

cms/static/js/views/components/add_library_content.js

bradenmacdonald · 2024-10-19T18:50:14Z

cms/static/js/views/components/add_library_content.js

+         * Adds the action buttons to the modal.
+         */
+        addActionButtons: function() {
+            this.addActionButton('cancel', gettext('Cancel'));


This can be fixed in a fast-follow PR (because I'm eager to get this into testing ASAP), but it's not a great UX that the "Next" button is sometimes hidden until you scroll, and the Next + Cancel buttons are in totally different places. I think they need to either be both inside the modal or both in the legy UI actions bar.

Actually, do we even need a Next button? Selecting a course should directly take to next page since we only have one item to select in the first slide.

Removed next button and updated it to go to component selection on library selection.

vokoscreenNG-2024-10-21_11-16-03.mp4

Makes sense to me!

bradenmacdonald · 2024-10-19T19:59:18Z

@navinkarkera Oh, actually one more important thing: can you make sure this new button is only ~~enabled~~ visible if libraries_v2_enabled()?

navinkarkera · 2024-10-21T05:49:33Z

@bradenmacdonald Thanks for the suggestions, updated and addressed all your comments.

bradenmacdonald

Great work @navinkarkera ! I tested this with the latest course-authoring PR and it's working well. Ready to merge.

edx-pipeline-bot · 2024-10-21T18:44:37Z

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

edx-pipeline-bot · 2024-10-21T19:03:47Z

2U Release Notice: This PR has been deployed to the edX production environment.

edx-pipeline-bot · 2024-10-21T19:03:47Z

2U Release Notice: This PR has been deployed to the edX production environment.

edx-pipeline-bot · 2024-10-21T19:31:14Z

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

edx-pipeline-bot · 2024-10-21T19:53:03Z

2U Release Notice: This PR has been deployed to the edX production environment.

edx-pipeline-bot · 2024-10-21T19:53:03Z

2U Release Notice: This PR has been deployed to the edX production environment.

…5670) Requires that v2 libraries are enabled.

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

navinkarkera force-pushed the navin/jill/rpenido/fal-3876-add-libary-content-to-a-course branch from b6a8793 to 643bce7 Compare October 18, 2024 07:01

navinkarkera mentioned this pull request Oct 18, 2024

refactor: picker component to only post message with block info [FC-0062] openedx/frontend-app-authoring#1401

Merged

navinkarkera commented Oct 18, 2024

View reviewed changes

kdmccormick reviewed Oct 18, 2024

View reviewed changes

rpenido and others added 6 commits October 19, 2024 15:47

feat: add library content to a course

926d75e

feat: adds Library Content button

b38cfb2

iframes the Authoring MFE's Library Content Picker

refactor: library component picker modal

38d6ea6

feat: add component and refresh block on selection

6fbf75b

fix: remove unused code

3ca4afd

refactor: sync with upstream after creation

bc27ba3

Removes need to call a follow up PUT request

navinkarkera force-pushed the navin/jill/rpenido/fal-3876-add-libary-content-to-a-course branch from ddd1307 to bc27ba3 Compare October 19, 2024 10:18

navinkarkera added 3 commits October 19, 2024 16:06

fixup! fix: remove unused code

d6e0852

chore: fix lint issues

c631a35

fix: incorrect use of self

0da35c1

navinkarkera commented Oct 19, 2024

View reviewed changes

This was referenced Oct 19, 2024

feat: adds Library Content button to Studio Unit page open-craft/edx-platform#699

Closed

feat: add library-v2 #35636

Closed

bradenmacdonald reviewed Oct 19, 2024

View reviewed changes

bradenmacdonald mentioned this pull request Oct 20, 2024

"Bare Bones" UI for Problem Bank [FC-0062] #35679

Merged

4 tasks

navinkarkera added 3 commits October 21, 2024 10:42

feat: hide library_v2 block if not enabled

d7a627c

refactor: remove parent locator from mfe url

58abdfc

fix: iframe message handler

6957789

navinkarkera requested a review from bradenmacdonald October 21, 2024 05:48

navinkarkera marked this pull request as ready for review October 21, 2024 05:48

navinkarkera mentioned this pull request Oct 21, 2024

refactor: remove parentLocator and next button from component picker [FC-0062] openedx/frontend-app-authoring#1412

Merged

navinkarkera changed the title ~~feat: adds Library Content button to Studio Unit page~~ feat: adds Library Content button to Studio Unit page [FC-0062] Oct 21, 2024

bradenmacdonald approved these changes Oct 21, 2024

View reviewed changes

bradenmacdonald merged commit 7e8fb43 into openedx:master Oct 21, 2024
49 checks passed

bradenmacdonald deleted the navin/jill/rpenido/fal-3876-add-libary-content-to-a-course branch October 21, 2024 17:32

Ian2012 pushed a commit to eduNEXT/edx-platform that referenced this pull request Oct 22, 2024

feat: adds Library Content (v2) button to Studio Unit page (openedx#3…

78fd819

…5670) Requires that v2 libraries are enabled.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: adds Library Content button to Studio Unit page [FC-0062] #35670

feat: adds Library Content button to Studio Unit page [FC-0062] #35670

navinkarkera commented Oct 18, 2024 •

edited

Loading

openedx-webhooks commented Oct 18, 2024 •

edited

Loading

navinkarkera Oct 18, 2024

kdmccormick Oct 18, 2024

navinkarkera Oct 19, 2024

navinkarkera left a comment

navinkarkera Oct 19, 2024

navinkarkera Oct 19, 2024

bradenmacdonald commented Oct 19, 2024

bradenmacdonald commented Oct 19, 2024

bradenmacdonald left a comment

bradenmacdonald Oct 19, 2024 •

edited

Loading

navinkarkera Oct 21, 2024

navinkarkera Oct 21, 2024

bradenmacdonald Oct 21, 2024

bradenmacdonald commented Oct 19, 2024 •

edited

Loading

navinkarkera commented Oct 21, 2024

bradenmacdonald left a comment

edx-pipeline-bot commented Oct 21, 2024

edx-pipeline-bot commented Oct 21, 2024

edx-pipeline-bot commented Oct 21, 2024

edx-pipeline-bot commented Oct 21, 2024

edx-pipeline-bot commented Oct 21, 2024

edx-pipeline-bot commented Oct 21, 2024

		:library_content_key: the key of the library content to add. (Incompatible with
		all other fields except parent_locator)

feat: adds Library Content button to Studio Unit page [FC-0062] #35670

feat: adds Library Content button to Studio Unit page [FC-0062] #35670

Conversation

navinkarkera commented Oct 18, 2024 • edited Loading

openedx-webhooks commented Oct 18, 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?

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

navinkarkera left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bradenmacdonald commented Oct 19, 2024

bradenmacdonald commented Oct 19, 2024

bradenmacdonald left a comment

Choose a reason for hiding this comment

bradenmacdonald Oct 19, 2024 • edited Loading

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

bradenmacdonald commented Oct 19, 2024 • edited Loading

navinkarkera commented Oct 21, 2024

bradenmacdonald left a comment

Choose a reason for hiding this comment

edx-pipeline-bot commented Oct 21, 2024

edx-pipeline-bot commented Oct 21, 2024

edx-pipeline-bot commented Oct 21, 2024

edx-pipeline-bot commented Oct 21, 2024

edx-pipeline-bot commented Oct 21, 2024

edx-pipeline-bot commented Oct 21, 2024

navinkarkera commented Oct 18, 2024 •

edited

Loading

openedx-webhooks commented Oct 18, 2024 •

edited

Loading

bradenmacdonald Oct 19, 2024 •

edited

Loading

bradenmacdonald commented Oct 19, 2024 •

edited

Loading