feat: show alert while editing v2 library content [FC-0062] #35700

navinkarkera · 2024-10-22T15:33:14Z

Description

Adds warning alert in edit modal for library v2 content in both legacy and new mfe editors.

Legacy

FAL-3877-recording.mp4

New MFE editors:

vokoscreenNG-2024-10-23_12-30-33.mp4

For openedx/frontend-app-authoring#1340

Supporting information

Depends on feat: direct link to single block in library [FC-0062] frontend-app-authoring#1392
Private-ref: FAL-3877

Testing instructions

Follow instructions in openedx/frontend-app-authoring#1392

Deadline

Today

openedx-webhooks · 2024-10-22T15:33:18Z

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.

bradenmacdonald · 2024-10-22T19:04:15Z

I think this PR will need to be re-worked. We don't need any UI changes on the platform side; we just need it to pass some parameter like ?showLibraryWarning in the URL when opening the MFE editor for any block that has an upstream set.

Then, in the MFE editor code in frontend-app-authoring, we can display the warning when that query string is present.

ChrisChV

Looks good 👍

I tested this: I followed the testing instructions
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.

Some blocks hide modal-header div to insert custom-tabs, so injecting alert inside modal-header does not work. Injecting it before this header works for all cases.

navinkarkera · 2024-10-23T07:04:21Z

@bradenmacdonald @ChrisChV Updated this and frontend PR to display warning in both legacy and new editors when editing content imported from library.

Edit: The warning is not displayed for new xblocks that are added via library content option. Currently, the mfe editor is opened as soon as the new block is imported and there we cannot see the alert. I think we should not display editor as soon as new block is imported.

Update: This commit: 7afe528 makes it such that new editors are not displayed by default on importing blocks from library.

ChrisChV

Looks good 👍

bradenmacdonald · 2024-10-23T14:53:05Z

I think we should not display editor as soon as new block is imported.

Update: This commit: 7afe528 makes it such that new editors are not displayed by default on importing blocks from library.

Thank you, that was a very annoying bug.

kdmccormick

I locally rebased & tested this. The margins/padding feel a little wonky, but functionally, it's great!

I have some refactoring requests, which I'll leave in a separate review. Don't worry about them for today-- we can apply them in a follow-up after the Sumac cut.

bradenmacdonald · 2024-10-23T15:18:35Z

@kdmccormick Hmm, it should look nicer than that - see video at openedx/frontend-app-authoring#1392 Maybe your CSS is not updated?
BTW that PR should merge before this one, but it looks like they're both ready.

navinkarkera · 2024-10-23T15:18:55Z

@kdmccormick It looks like the scss changes has not been applied in the image. Can you try hard reload and/or run npm run watch in cms shell.

ChrisChV · 2024-10-23T15:28:10Z

Update: I think it's ready to merge, I enabled the auto-merge.

kdmccormick · 2024-10-23T15:32:05Z

Yup, my CSS was just outdated 👍🏻

kdmccormick · 2024-10-23T15:36:28Z

@ChrisChV Can you make sure your squashed commit is a single cohesive message with a ticket link, minus the intermediate style:, fix:, etc. commit messages?

For example, like 4158a44 or d25e651

EDIT: I did it myself

ChrisChV · 2024-10-23T16:14:32Z

Can you make sure your squashed commit is a single cohesive message with a ticket link, minus the intermediate style:, fix:, etc. commit messages?

Sure, thanks for the suggestion!

edx-pipeline-bot · 2024-10-23T17:22:30Z

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-23T17:39:31Z

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

edx-pipeline-bot · 2024-10-23T17:39:31Z

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

edx-pipeline-bot · 2024-10-23T18:04:34Z

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-23T18:24:01Z

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

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

navinkarkera mentioned this pull request Oct 22, 2024

feat: direct link to single block in library [FC-0062] openedx/frontend-app-authoring#1392

Merged

navinkarkera marked this pull request as ready for review October 22, 2024 15:34

navinkarkera force-pushed the navin/upstream-warning-alert branch 2 times, most recently from 20c34d6 to 53bb6c3 Compare October 22, 2024 16:41

ChrisChV approved these changes Oct 22, 2024

View reviewed changes

mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Oct 22, 2024

navinkarkera added 7 commits October 23, 2024 11:54

feat: show alert while editing v2 library content

c3f483a

refactor: upstream link and alert styling

6bfd9cd

fix: insert alert before modal-header

c9ec458

Some blocks hide modal-header div to insert custom-tabs, so injecting alert inside modal-header does not work. Injecting it before this header works for all cases.

fix: type hints

6b0a3f3

style: ignore javascript-jquery-insertion lint error

aad168c

test: fix upstream link test

1f0d756

feat: adds upstreamRef in mfe url for new editors to display alert

e8da227

navinkarkera force-pushed the navin/upstream-warning-alert branch from 53bb6c3 to e8da227 Compare October 23, 2024 06:24

fix: do not open editors on importing library content

7afe528

ChrisChV approved these changes Oct 23, 2024

View reviewed changes

kdmccormick approved these changes Oct 23, 2024

View reviewed changes

Merge branch 'master' into navin/upstream-warning-alert

99f1751

ChrisChV enabled auto-merge (squash) October 23, 2024 15:26

kdmccormick disabled auto-merge October 23, 2024 15:55

kdmccormick enabled auto-merge (squash) October 23, 2024 15:56

kdmccormick merged commit e2a9a37 into openedx:master Oct 23, 2024
48 checks passed

bradenmacdonald deleted the navin/upstream-warning-alert branch October 23, 2024 16:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: show alert while editing v2 library content [FC-0062] #35700

feat: show alert while editing v2 library content [FC-0062] #35700

navinkarkera commented Oct 22, 2024 •

edited

Loading

openedx-webhooks commented Oct 22, 2024 •

edited

Loading

bradenmacdonald commented Oct 22, 2024

ChrisChV left a comment

navinkarkera commented Oct 23, 2024 •

edited

Loading

ChrisChV left a comment

bradenmacdonald commented Oct 23, 2024

kdmccormick left a comment

bradenmacdonald commented Oct 23, 2024

navinkarkera commented Oct 23, 2024

ChrisChV commented Oct 23, 2024

kdmccormick commented Oct 23, 2024

kdmccormick commented Oct 23, 2024 •

edited

Loading

ChrisChV commented Oct 23, 2024

edx-pipeline-bot commented Oct 23, 2024

edx-pipeline-bot commented Oct 23, 2024

edx-pipeline-bot commented Oct 23, 2024

edx-pipeline-bot commented Oct 23, 2024

edx-pipeline-bot commented Oct 23, 2024

feat: show alert while editing v2 library content [FC-0062] #35700

feat: show alert while editing v2 library content [FC-0062] #35700

Conversation

navinkarkera commented Oct 22, 2024 • edited Loading

Description

Supporting information

Testing instructions

Deadline

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

bradenmacdonald commented Oct 22, 2024

ChrisChV left a comment

Choose a reason for hiding this comment

navinkarkera commented Oct 23, 2024 • edited Loading

ChrisChV left a comment

Choose a reason for hiding this comment

bradenmacdonald commented Oct 23, 2024

kdmccormick left a comment

Choose a reason for hiding this comment

bradenmacdonald commented Oct 23, 2024

navinkarkera commented Oct 23, 2024

ChrisChV commented Oct 23, 2024

kdmccormick commented Oct 23, 2024

kdmccormick commented Oct 23, 2024 • edited Loading

ChrisChV commented Oct 23, 2024

edx-pipeline-bot commented Oct 23, 2024

edx-pipeline-bot commented Oct 23, 2024

edx-pipeline-bot commented Oct 23, 2024

edx-pipeline-bot commented Oct 23, 2024

edx-pipeline-bot commented Oct 23, 2024

navinkarkera commented Oct 22, 2024 •

edited

Loading

openedx-webhooks commented Oct 22, 2024 •

edited

Loading

navinkarkera commented Oct 23, 2024 •

edited

Loading

kdmccormick commented Oct 23, 2024 •

edited

Loading