1
0
Fork 0
mirror of https://github.com/mozilla/pdf.js.git synced 2025-04-19 22:58:07 +02:00
pdf.js/src
Jonas Jenwald 2643570364 [api-minor] Re-factor how Node.js packages/polyfills are loaded (issue 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.
2024-05-06 23:20:03 +02:00
..
core Introduce helper functions for parsing /Matrix and /BBox arrays 2024-05-03 22:37:50 +02:00
display [api-minor] Re-factor how Node.js packages/polyfills are loaded (issue 17245) 2024-05-06 23:20:03 +02:00
images Vectorize the logo. 2012-10-29 14:08:52 -04:00
scripting_api Use the string value of the field when calling the Format callback (bug 1889122) 2024-04-09 22:52:11 +02:00
shared Simplify the way to pass the glyph drawing instructions from the worker to the main thread 2024-04-27 21:28:31 +02:00
interfaces.js Use ESLint to ensure that exports are sorted alphabetically 2021-01-09 20:37:51 +01:00
license_header.js Update the year in the license_header files 2023-01-18 22:28:18 +01:00
license_header_libre.js Update the year in the license_header files 2023-01-18 22:28:18 +01:00
pdf.image_decoders.js [api-minor] Remove the image-related error message prefixes 2024-04-20 12:51:45 +02:00
pdf.js [api-minor] Replace the PromiseCapability with Promise.withResolvers() 2024-04-01 11:42:37 +02:00
pdf.sandbox.external.js ESMify some modules for m-c (bug 1824610) 2023-03-27 12:01:31 +02:00
pdf.sandbox.js Use shorter arrow functions where possible 2024-01-21 10:13:12 +01:00
pdf.scripting.js Output pdf.scripting.js as a JavaScript module (PR 17055 follow-up) 2023-10-07 15:27:26 +02:00
pdf.worker.js Allow, optionally, using worker-modules during local development 2023-01-31 12:09:44 +01:00