Merge pull request #17776 from calixteman/bug1883609

[Annotations] Widget annotations must be in front of the other ones (bug 1883609)

src/core/annotation.js

@@ -4964,4 +4964,5 @@ export {
   getQuadPoints,
   MarkupAnnotation,
   PopupAnnotation,
+  WidgetAnnotation,
 };

src/core/document.js

@@ -30,7 +30,11 @@ import {
   Util,
   warn,
 } from "../shared/util.js";
-import { AnnotationFactory, PopupAnnotation } from "./annotation.js";
+import {
+  AnnotationFactory,
+  PopupAnnotation,
+  WidgetAnnotation,
+} from "./annotation.js";
 import {
   collectActions,
   getInheritableProperty,
@@ -766,19 +770,26 @@ class Page {
         }
 
         const sortedAnnotations = [];
-        let popupAnnotations;
+        let popupAnnotations, widgetAnnotations;
         // Ensure that PopupAnnotations are handled last, since they depend on
         // their parent Annotation in the display layer; fixes issue 11362.
         for (const annotation of await Promise.all(annotationPromises)) {
           if (!annotation) {
             continue;
           }
+          if (annotation instanceof WidgetAnnotation) {
+            (widgetAnnotations ||= []).push(annotation);
+            continue;
+          }
           if (annotation instanceof PopupAnnotation) {
             (popupAnnotations ||= []).push(annotation);
             continue;
           }
           sortedAnnotations.push(annotation);
         }
+        if (widgetAnnotations) {
+          sortedAnnotations.push(...widgetAnnotations);
+        }
         if (popupAnnotations) {
           sortedAnnotations.push(...popupAnnotations);
         }

test/integration/annotation_spec.mjs

@@ -58,6 +58,35 @@ describe("Annotation highlight", () => {
       );
     });
   });
+
+  describe("Check that widget annotations are in front of highlight ones", () => {
+    let pages;
+
+    beforeAll(async () => {
+      pages = await loadAndWait("bug1883609.pdf", "[data-annotation-id='23R']");
+    });
+
+    afterAll(async () => {
+      await closePages(pages);
+    });
+
+    it("must click on widget annotations", async () => {
+      await Promise.all(
+        pages.map(async ([browserName, page]) => {
+          for (const i of [23, 22, 14]) {
+            await page.click(`[data-annotation-id='${i}R']`);
+            await page.waitForFunction(
+              id =>
+                document.activeElement ===
+                document.querySelector(`#pdfjs_internal_id_${id}R`),
+              {},
+              i
+            );
+          }
+        })
+      );
+    });
+  });
 });
 
 describe("Checkbox annotation", () => {

test/pdfs/.gitignore

@@ -633,3 +633,4 @@
 !issue17671.pdf
 !bug1868759.pdf
 !issue17730.pdf
+!bug1883609.pdf