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

[api-minor] Re-factor how Node.js packages/polyfills are loaded (issue 17245) #18051

Merged
merged 2 commits into from
May 14, 2024

Commits on May 6, 2024

  1. [api-minor] Re-factor how Node.js packages/polyfills are loaded (issu…

    …e 17245)
    
    *Please note:* This removes top level await from the GENERIC builds of the PDF.js library.
    
    Despite top level await being supported in all modern browsers/environments, note [the MDN compatibility data](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await#browser_compatibility), it seems that many frameworks and build-tools unfortunately have trouble with it.
    Hence, in order to reduce the influx of support requests regarding top level await it thus seems that we'll have to try and fix this.
    
    Given that top level await is only needed for Node.js environments, to load packages/polyfills, we re-factor things to limit the asynchronicity to that environment.
    The "best" solution, with the least likelihood of causing future problems, would probably be to await the load of Node.js packages/polyfills e.g. at the top of the `getDocument`-function. Unfortunately that doesn't work though, since that's a *synchronous* function that we cannot change without breaking "the world".
    
    Hence we instead await the load of Node.js packages/polyfills together with the `PDFWorker` initialization, since that's the *first point* of asynchronicity during initialization/loading of a PDF document. The reason that this works is that the Node.js packages/polyfills are only needed during fetching of the PDF document respectively during rendering, neither of which can happen *until* the worker has been initialized.
    Hopefully this won't cause any future problems, since looking at the history of the PDF.js project I don't believe that we've (thus far) ever needed a Node.js dependency at an earlier point.
    This new pattern for accessing Node.js packages/polyfills will also require some care during development *and* importantly reviewing, to ensure that no new top level await is added in the main code-base.
    Snuffleupagus committed May 6, 2024
    Configuration menu
    Copy the full SHA
    2643570 View commit details
    Browse the repository at this point in the history

Commits on May 7, 2024

  1. [api-minor] Remove the, now unused, pdfjsLibPromise global

    This global was only introduced to work-around problems caused by the GENERIC PDF.js build using top level await. Since that was removed in the previous commit, this global is now dead code.
    Snuffleupagus committed May 7, 2024
    Configuration menu
    Copy the full SHA
    9418ed1 View commit details
    Browse the repository at this point in the history