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: resolve react-pdf v7 worker configuration (fixes #330) #376

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

milad-emami
Copy link
Contributor

@milad-emami milad-emami commented Nov 30, 2024

This PR fixes the failed Renovate bot update (#330) which attempted to update react-pdf from v5 to v7 for security improvements.

Context

Renovate bot PR #330 failed due to breaking changes in react-pdf v7's worker configuration. This PR implements the necessary changes to support v7.

Changes

  • Updated react-pdf from v5 to v7
  • Fixed PDF worker configuration using unpkg CDN
  • Resolves build errors from Renovate bot PR

Technical Details

In react-pdf v7, the PDF worker can't be imported directly from react-pdf package anymore because:

  1. The worker file is no longer exported in the package.json exports field
  2. Direct import path react-pdf/dist/esm/pdf.worker.entry is not available in v7

Solution Options Considered:

  1. Local worker (pdfjs-dist)

    • Requires additional package installation
    • Works offline
    • Increases bundle size
  2. CDN approach (Selected)

    pdfjs.GlobalWorkerOptions.workerSrc = `//unpkg.com/pdfjs-dist@${pdfjs.version}/build/pdf.worker.min.js`;

    Benefits:

    • No additional package installation needed
    • Reduces bundle size
    • Worker version automatically matches pdfjs version
    • Reliable and fast through unpkg CDN

Dependencies

  • react-pdf: ^7.0.0

Related Issues

@openedx-webhooks
Copy link

Thanks for the pull request, @milad-emami!

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 @codewithemad. 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.

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

codecov bot commented Nov 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (e39533c) to head (0f54769).

Additional details and impacted files
@@            Coverage Diff            @@
##            master      #376   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          109       109           
  Lines         1086      1085    -1     
  Branches       165       165           
=========================================
- Hits          1086      1085    -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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: Ready for Review
Development

Successfully merging this pull request may close these issues.

2 participants