mirror of
https://github.com/zen-browser/pdf.js.git
synced 2025-07-08 01:10:08 +02:00
This replaces our custom `PromiseCapability`-class with the new native `Promise.withResolvers()` functionality, which does *almost* the same thing[1]; please see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/withResolvers The only difference is that `PromiseCapability` also had a `settled`-getter, which was however not widely used and the call-sites can either be removed or re-factored to avoid it. In particular: - In `src/display/api.js` we can tweak the `PDFObjects`-class to use a "special" initial data-value and just compare against that, in order to replace the `settled`-state. - In `web/app.js` we change the only case to manually track the `settled`-state, which should hopefully be OK given how this is being used. - In `web/pdf_outline_viewer.js` we can remove the `settled`-checks, since the code should work just fine without it. The only thing that could potentially happen is that we try to `resolve` a Promise multiple times, which is however *not* a problem since the value of a Promise cannot be changed once fulfilled or rejected. - In `web/pdf_viewer.js` we can remove the `settled`-checks, since the code should work fine without them: - For the `_onePageRenderedCapability` case the `settled`-check is used in a `EventBus`-listener which is *removed* on its first (valid) invocation. - For the `_pagesCapability` case the `settled`-check is used in a print-related helper that works just fine with "only" the other checks. - In `test/unit/api_spec.js` we can change the few relevant cases to manually track the `settled`-state, since this is both simple and *test-only* code. --- [1] In browsers/environments that lack native support, note [the compatibility data](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/withResolvers#browser_compatibility), it'll be polyfilled via the `core-js` library (but only in `legacy` builds).
148 lines
3.9 KiB
JavaScript
148 lines
3.9 KiB
JavaScript
/* Copyright 2023 Mozilla Foundation
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
import {
|
|
AbortException,
|
|
AnnotationEditorParamsType,
|
|
AnnotationEditorType,
|
|
AnnotationMode,
|
|
CMapCompressionType,
|
|
createValidAbsoluteUrl,
|
|
FeatureTest,
|
|
ImageKind,
|
|
InvalidPDFException,
|
|
isNodeJS,
|
|
MissingPDFException,
|
|
normalizeUnicode,
|
|
OPS,
|
|
PasswordResponses,
|
|
PermissionFlag,
|
|
shadow,
|
|
UnexpectedResponseException,
|
|
Util,
|
|
VerbosityLevel,
|
|
} from "../../src/shared/util.js";
|
|
import {
|
|
build,
|
|
getDocument,
|
|
PDFDataRangeTransport,
|
|
PDFWorker,
|
|
version,
|
|
} from "../../src/display/api.js";
|
|
import {
|
|
DOMSVGFactory,
|
|
fetchData,
|
|
getFilenameFromUrl,
|
|
getPdfFilenameFromUrl,
|
|
getXfaPageViewport,
|
|
isDataScheme,
|
|
isPdfFile,
|
|
noContextMenu,
|
|
PDFDateString,
|
|
PixelsPerInch,
|
|
RenderingCancelledException,
|
|
setLayerDimensions,
|
|
} from "../../src/display/display_utils.js";
|
|
import {
|
|
renderTextLayer,
|
|
updateTextLayer,
|
|
} from "../../src/display/text_layer.js";
|
|
import { AnnotationEditorLayer } from "../../src/display/editor/annotation_editor_layer.js";
|
|
import { AnnotationEditorUIManager } from "../../src/display/editor/tools.js";
|
|
import { AnnotationLayer } from "../../src/display/annotation_layer.js";
|
|
import { ColorPicker } from "../../src/display/editor/color_picker.js";
|
|
import { DrawLayer } from "../../src/display/draw_layer.js";
|
|
import { GlobalWorkerOptions } from "../../src/display/worker_options.js";
|
|
import { Outliner } from "../../src/display/editor/outliner.js";
|
|
import { XfaLayer } from "../../src/display/xfa_layer.js";
|
|
|
|
const expectedAPI = Object.freeze({
|
|
AbortException,
|
|
AnnotationEditorLayer,
|
|
AnnotationEditorParamsType,
|
|
AnnotationEditorType,
|
|
AnnotationEditorUIManager,
|
|
AnnotationLayer,
|
|
AnnotationMode,
|
|
build,
|
|
CMapCompressionType,
|
|
ColorPicker,
|
|
createValidAbsoluteUrl,
|
|
DOMSVGFactory,
|
|
DrawLayer,
|
|
FeatureTest,
|
|
fetchData,
|
|
getDocument,
|
|
getFilenameFromUrl,
|
|
getPdfFilenameFromUrl,
|
|
getXfaPageViewport,
|
|
GlobalWorkerOptions,
|
|
ImageKind,
|
|
InvalidPDFException,
|
|
isDataScheme,
|
|
isPdfFile,
|
|
MissingPDFException,
|
|
noContextMenu,
|
|
normalizeUnicode,
|
|
OPS,
|
|
Outliner,
|
|
PasswordResponses,
|
|
PDFDataRangeTransport,
|
|
PDFDateString,
|
|
PDFWorker,
|
|
PermissionFlag,
|
|
PixelsPerInch,
|
|
RenderingCancelledException,
|
|
renderTextLayer,
|
|
setLayerDimensions,
|
|
shadow,
|
|
UnexpectedResponseException,
|
|
updateTextLayer,
|
|
Util,
|
|
VerbosityLevel,
|
|
version,
|
|
XfaLayer,
|
|
});
|
|
|
|
describe("pdfjs_api", function () {
|
|
it("checks that the *official* PDF.js API exposes the expected functionality", async function () {
|
|
// eslint-disable-next-line no-unsanitized/method
|
|
const pdfjsAPI = await import(
|
|
typeof PDFJSDev !== "undefined" && PDFJSDev.test("LIB")
|
|
? "../../pdf.js"
|
|
: "../../src/pdf.js"
|
|
);
|
|
|
|
// The imported Object contains an (automatically) inserted Symbol,
|
|
// hence we copy the data to allow using a simple comparison below.
|
|
expect({ ...pdfjsAPI }).toEqual(expectedAPI);
|
|
});
|
|
});
|
|
|
|
describe("web_pdfjsLib", function () {
|
|
it("checks that the viewer re-exports the expected API functionality", async function () {
|
|
if (isNodeJS) {
|
|
pending("loadScript is not supported in Node.js.");
|
|
}
|
|
const apiPath = "../../build/generic/build/pdf.mjs";
|
|
await import(apiPath);
|
|
|
|
const webPdfjsLib = await import("../../web/pdfjs.js");
|
|
|
|
expect(Object.keys(webPdfjsLib).sort()).toEqual(
|
|
Object.keys(expectedAPI).sort()
|
|
);
|
|
});
|
|
});
|