Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: allow LTI blocks to be loaded in a Library v2 context [FC-0076] #36265

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

pomegranited
Copy link
Contributor

@pomegranited pomegranited commented Feb 18, 2025

Description

Fixes errors thrown when previewing/editing (built-in) LTI blocks in a Libraries v2 context.

These fixes allow Library Authors to store LTI blocks in their content libraries.

Supporting information

Part of: openedx/frontend-app-authoring#1514
Private-ref: FAL-4032

Testing instructions

To verify the issues fixed here:

  1. Ensure that lti and word_cloud are in the list of LIBRARY_SUPPORTED_BLOCKS configured for your Authoring MFE.
  2. Import the Open edX Demo course into your tutor dev stack: tutor dev do importdemocourse
  3. Navigate to the Open edX Demo course and locate an LTI block, e.g Codeboard.io LTI or the Code Grading Assignment via Jupyter LTI.
  4. Copy the LTI block to your staging clipboard.
  5. Go back to the Authoring MFE home page, and create a new content library.
  6. Paste the copied LTI component into your library.
  7. Click on the LTI card to display its Preview in the sidebar, and/or click Expand to view it in a modal.
  8. Click "Edit Component" to edit the LTI block.

To test this fix:

  1. Run this branch in your CMS.
  2. Repeat the verification steps above while watching the CMS logs.
  3. Ensure the LTI Preview displays without errors in the CMS logs.
    See Other information below for notes on the authentication errors shown.
  4. Ensure that you can edit and save changes to the library LTI block from within the library context.
  5. Repeat these steps with a Word Cloud block to ensure these changes haven't broken anything there.

Deadline

None

Other information

  1. Authentication for LTI blocks lives in the course under Advanced Settings > LTI Passports, and there's no place for it in the libraries (yet). Fixing this issue is outside the scope of this ticket.

So for LTI blocks like Codeboard.io where "Open in New Page" is set to False, you will see an error like this:
image

And for LTI blocks like the Jupyter example where "Open in New Page" is set to True, you won't see the authentication issue until you click "View resource in a new window"
image

image
2. Some of the buttons in the library block editors for LTI + Word Cloud do not work. Fixing this will have to come in another PR -- I was unable to work out why these buttons aren't hooked up with backbone on load.

  • clear/reset setting: image
  • add setting to list: image

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Feb 18, 2025
@openedx-webhooks
Copy link

openedx-webhooks commented Feb 18, 2025

Thanks for the pull request, @pomegranited!

This repository is currently maintained by @openedx/wg-maintenance-edx-platform.

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.

@pomegranited pomegranited force-pushed the jill/fal-4032-lti-library-context branch from 71997fc to 1b5def8 Compare February 18, 2025 06:03
@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Feb 19, 2025
so that they fit better in the preview sidebar and expanded iframe views
and generalize it so it can be used by LTI and WordCloud blocks
@pomegranited pomegranited force-pushed the jill/fal-4032-lti-library-context branch from 6d2bafc to 57ce36c Compare February 20, 2025 06:41
@pomegranited pomegranited marked this pull request as ready for review February 28, 2025 03:47
@pomegranited pomegranited requested a review from rpenido February 28, 2025 04:05
Copy link
Contributor

@rpenido rpenido left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍
Thank you for your work, @pomegranited!
This is working great!

  • I tested this using the instructions from the PR
  • I read through the code
  • I checked for accessibility issues
  • Includes documentation

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
Status: Waiting on Author
Development

Successfully merging this pull request may close these issues.

5 participants