Bug 1966702 - Implement debugger breakpoints for CloseWatcher events r=nchevobbe,devtools-reviewers

Differential Revision: https://phabricator.services.mozilla.com/D250307

UltraBlame original commit: 6ae35aa82e39fbeffcc7c51e39fe912876d2114f

Author: marco-c

devtools/client/debugger/test/mochitest/browser_dbg-event-breakpoints.js

@@ -7,6 +7,7 @@
 add_task(async function () {
   await pushPref("dom.element.invokers.enabled", true);
   await pushPref("dom.events.textevent.enabled", true);
+  await pushPref("dom.closewatcher.enabled", true);
 
   const dbg = await initDebugger(
     "doc-event-breakpoints.html",
@@ -81,6 +82,19 @@ add_task(async function () {
   await assertPausedAtSourceAndLine(dbg, eventBreakpointsSource.id, 77);
   await resume(dbg);
 
+  info("Enable closewatcher cancel and close events");
+  await toggleEventBreakpoint(dbg, "CloseWatcher", "event.closewatcher.cancel");
+  await toggleEventBreakpoint(dbg, "CloseWatcher", "event.closewatcher.close");
+  invokeInTab("closeWatcherRequestClose");
+  info("Wait for pause in cancel event listener");
+  await waitForPaused(dbg);
+  await assertPausedAtSourceAndLine(dbg, eventBreakpointsSource.id, 116);
+  await resume(dbg);
+  info("And wait for pause in close event listener after resuming");
+  await waitForPaused(dbg);
+  await assertPausedAtSourceAndLine(dbg, eventBreakpointsSource.id, 120);
+  await resume(dbg);
+
   info("Enable beforetoggle and toggle events");
   await toggleEventBreakpoint(dbg, "Control", "event.control.beforetoggle");
   await toggleEventBreakpoint(dbg, "Control", "event.control.toggle");

devtools/client/debugger/test/mochitest/examples/event-breakpoints.js

@@ -106,3 +106,16 @@ document.getElementById("pointer-target").addEventListener("pointerrawupdate", o
 function onPointerRawUpdate() {
   console.log("pointerrawupdate");
 }
+
+const closewatcher = new CloseWatcher();
+function closeWatcherRequestClose() {
+  closewatcher.requestClose();
+}
+closewatcher.addEventListener("cancel", onCancel);
+function onCancel(event) {
+  console.log("cancel", event);
+}
+closewatcher.addEventListener("close", onClose);
+function onClose(event) {
+  console.log("close", event);
+}

devtools/server/actors/utils/event-breakpoints.js

@@ -57,6 +57,14 @@ function xhrEvent(groupID, eventType) {
   };
 }
 
+function closeWatcherEvent(groupID, eventType) {
+  return {
+    ...generalEvent(groupID, eventType),
+    message: `CloseWatcher '${eventType}' event`,
+    targetTypes: ["closewatcher"],
+  };
+}
+
 function webSocketEvent(groupID, eventType) {
   return {
     ...generalEvent(groupID, eventType),
@@ -132,6 +140,17 @@ const AVAILABLE_BREAKPOINTS = [
       generalEvent("clipboard", "beforepaste"),
     ],
   },
+  {
+    name: "CloseWatcher",
+    items: [
+      closeWatcherEvent("closewatcher", "cancel", () =>
+        Services.prefs.getBoolPref("dom.closewatcher.enabled")
+      ),
+      closeWatcherEvent("closewatcher", "close", () =>
+        Services.prefs.getBoolPref("dom.closewatcher.enabled")
+      ),
+    ],
+  },
   {
     name: "Control",
     items: [

dom/chrome-webidl/DebuggerNotification.webidl

@@ -48,6 +48,7 @@ enum EventCallbackDebuggerNotificationType {
   "xhr",
   "worker",
   "websocket",
+  "closewatcher",
 };
 
 // A notification that about the engine calling a DOM event handler.

dom/closewatcher/CloseWatcher.h

@@ -9,6 +9,7 @@
 
 #include "mozilla/DOMEventTargetHelper.h"
 #include "mozilla/dom/CloseWatcherBinding.h"
+#include "mozilla/dom/DebuggerNotificationBinding.h"
 
 namespace mozilla::dom {
 
@@ -18,6 +19,11 @@ class CloseWatcher : public DOMEventTargetHelper, public AbortFollower {
 
   nsIGlobalObject* GetParentObject() const { return GetOwnerGlobal(); }
 
+  mozilla::Maybe<EventCallbackDebuggerNotificationType>
+  GetDebuggerNotificationType() const override {
+    return mozilla::Some(EventCallbackDebuggerNotificationType::Closewatcher);
+  }
+
   JSObject* WrapObject(JSContext* aCx,
                        JS::Handle<JSObject*> aGivenProto) override;
 

tools/@types/generated/lib.gecko.dom.d.ts

@@ -3631,6 +3631,10 @@ interface SetHTMLOptions {
     sanitizer?: Sanitizer | SanitizerConfig | SanitizerPresets;
 }
 
+interface SetHTMLUnsafeOptions {
+    sanitizer?: Sanitizer | SanitizerConfig | SanitizerPresets;
+}
+
 interface ShadowRootInit {
     clonable?: boolean;
     delegatesFocus?: boolean;
@@ -7533,7 +7537,7 @@ declare var Document: {
     readonly KEYPRESS_EVENT_MODEL_CONFLATED: 2;
     isInstance: IsInstance<Document>;
     parseHTML(html: string, options?: SetHTMLOptions): Document;
-    parseHTMLUnsafe(html: TrustedHTML | string): Document;
+    parseHTMLUnsafe(html: TrustedHTML | string, options?: SetHTMLUnsafeOptions): Document;
 };
 
 interface DocumentFragment extends Node, NonElementParentNode, ParentNode {
@@ -7813,7 +7817,7 @@ interface Element extends Node, ARIAMixin, Animatable, ChildNode, GeometryUtils,
     setCapture(retargetToElement?: boolean): void;
     setCaptureAlways(retargetToElement?: boolean): void;
     setHTML(aInnerHTML: string, options?: SetHTMLOptions): void;
-    setHTMLUnsafe(html: TrustedHTML | string): void;
+    setHTMLUnsafe(html: TrustedHTML | string, options?: SetHTMLUnsafeOptions): void;
     setPointerCapture(pointerId: number): void;
     toggleAttribute(name: string, force?: boolean): boolean;
     webkitMatchesSelector(selector: string): boolean;
@@ -18844,7 +18848,8 @@ interface ShadowRoot extends DocumentFragment, DocumentOrShadowRoot {
     getHTML(options?: GetHTMLOptions): string;
     importNodeAndAppendChildAt(parentNode: Node, node: Node, deep?: boolean): Node;
     isUAWidget(): boolean;
-    setHTMLUnsafe(html: TrustedHTML | string): void;
+    setHTML(aInnerHTML: string, options?: SetHTMLOptions): void;
+    setHTMLUnsafe(html: TrustedHTML | string, options?: SetHTMLUnsafeOptions): void;
     setIsUAWidget(): void;
     addEventListener<K extends keyof ShadowRootEventMap>(type: K, listener: (this: ShadowRoot, ev: ShadowRootEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
     addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
@@ -25706,7 +25711,7 @@ type DistanceModelType = "exponential" | "inverse" | "linear";
 type EncodedAudioChunkType = "delta" | "key";
 type EncodedVideoChunkType = "delta" | "key";
 type EndingType = "native" | "transparent";
-type EventCallbackDebuggerNotificationType = "global" | "node" | "websocket" | "worker" | "xhr";
+type EventCallbackDebuggerNotificationType = "global" | "node" | "websocket" | "worker" | "xhr" | "closewatcher";
 type FetchState = "aborted" | "complete" | "errored" | "requesting" | "responding";
 type FileSystemHandleKind = "directory" | "file";
 type FileType = "directory" | "other" | "regular";