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: remove error ReferenceError: JavascriptLoader is not defined in Zoom Image Tool #35661

Closed
wants to merge 2 commits into from

Conversation

jignaciopm
Copy link
Contributor

Description

This PR uses a workaround to load the script jquery.loupeAndLightbox.js, which waits for the script to be completely loaded in the browser before running any reference to its utilities.

Useful information to include:

LMS In Firefox:
Captura de pantalla de 2024-10-16 23-10-56

CMS in Firefox:
Captura de pantalla de 2024-10-16 23-27-39

LMS in Chrome:
Captura de pantalla de 2024-10-16 23-09-26

CMS in Chrome:
Captura de pantalla de 2024-10-16 23-09-21

Supporting information

[DEPR] HTML Block: The Zooming Image Tool template is broken: #31436

Testing instructions

  1. Fire up a devstack, open the demo course in Studio and add a Text block to any unit.
  2. Select the Zooming Image Tool template and publish the unit; there's no need to edit the contents.
  3. Test the resulting tool in Studio itself: the zoom should work as expected.
  4. Open the unit in the LMS. Clicking on the image will open the utility that allows you to view the magnified image in a loupe.

Deadline

None

Other information

None

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

Thanks for the pull request, @jignaciopm!

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.

@mphilbrick211 mphilbrick211 added needs test run Author's first PR to this repository, awaiting test authorization from Axim and removed needs test run Author's first PR to this repository, awaiting test authorization from Axim labels Oct 21, 2024
@felipemontoya
Copy link
Member

Hello @arbrandes and @feanil I'm tagging you as the reporter and assignee of #31436.
@jignaciopm is available for any doubts you might have.

Copy link
Contributor

@arbrandes arbrandes left a comment

Choose a reason for hiding this comment

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

Thanks for the PR! It indeed fixes the loading of the loupe script.

However, the version in the default content is broken, and there's no way to fix it except by hosting a version of the script somewhere ourselves. Which brings us back around to the question: should we be supporting something like this officially?

My personal opinion is that unless we're ready to make the default content work properly by including a version of the loupe script with the HTML block, we should just remove this template. I'm going to confirm this with Product.

let script = document.createElement("script");
script.type = "text/javascript";

if (script.readyState) { // IE
Copy link
Contributor

Choose a reason for hiding this comment

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

We no longer support IE, so this conditional can be removed in favor of script.onload.

let script = document.createElement("script");
script.type = "text/javascript";

if (script.readyState) { // IE
Copy link
Contributor

Choose a reason for hiding this comment

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

Same as above. We can do with only script.onload, now.

});
}

loadScript("https://studio.edx.org/c4x/edX/DemoX/asset/jquery.loupeAndLightbox.js", callback);
Copy link
Contributor

Choose a reason for hiding this comment

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

The problem here is that this version of the loupe is broken when you use it on a full-width, desktop LMS. The positioning is off:

image

There's no way to fix it except by modifying the source of the script. And here lies the major problem I have with this template: by default it depends on a script that's hosted by edx.org, and a buggy one at that.

@feanil
Copy link
Contributor

feanil commented Dec 12, 2024

@jignaciopm thanks for the PR it prompted much discussion and led to #36012 which should resolve the issue and be a bit easier to maintain going forward.

@feanil feanil closed this Dec 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

[Test failure] <N/A>: Zooming Tool is not working in the LMS
7 participants