get rid of domDebug (#577)

* get rid of domDebug

* changeset

* fix log message

Author: seanmcguire12

Diff for: .changeset/shiny-windows-attack.md

@@ -0,0 +1,5 @@
+---
+"@browserbasehq/stagehand": patch
+---
+
+remove debugDom

Diff for: lib/StagehandPage.ts

@@ -149,10 +149,12 @@ export class StagehandPage {
     this.intPage = newStagehandPage.page;
 
     if (this.stagehand.debugDom) {
-      await this.intPage.evaluate(
-        (debugDom) => (window.showChunks = debugDom),
-        this.stagehand.debugDom,
-      );
+      this.stagehand.log({
+        category: "deprecation",
+        message:
+          "Warning: debugDom is not supported in this version of Stagehand",
+        level: 1,
+      });
     }
     await this.intPage.waitForLoadState("domcontentloaded");
     await this._waitForSettledDom();
@@ -268,10 +270,12 @@ export class StagehandPage {
               await this._refreshPageFromAPI();
             } else {
               if (stagehand.debugDom) {
-                await target.evaluate(
-                  (debugDom) => (window.showChunks = debugDom),
-                  stagehand.debugDom,
-                );
+                this.stagehand.log({
+                  category: "deprecation",
+                  message:
+                    "Warning: debugDom is not supported in this version of Stagehand",
+                  level: 1,
+                });
               }
               await target.waitForLoadState("domcontentloaded");
               await this._waitForSettledDom();
@@ -400,48 +404,6 @@ export class StagehandPage {
     }
   }
 
-  public async startDomDebug() {
-    if (this.stagehand.debugDom) {
-      try {
-        await this.page
-          .evaluate(() => {
-            if (typeof window.debugDom === "function") {
-              window.debugDom();
-            } else {
-              this.stagehand.log({
-                category: "dom",
-                message: "debugDom is not defined",
-                level: 1,
-              });
-            }
-          })
-          .catch(() => {});
-      } catch (e) {
-        this.stagehand.log({
-          category: "dom",
-          message: "Error in startDomDebug",
-          level: 1,
-          auxiliary: {
-            error: {
-              value: e.message,
-              type: "string",
-            },
-            trace: {
-              value: e.stack,
-              type: "string",
-            },
-          },
-        });
-      }
-    }
-  }
-
-  public async cleanupDomDebug() {
-    if (this.stagehand.debugDom) {
-      await this.page.evaluate(() => window.cleanupDebug()).catch(() => {});
-    }
-  }
-
   async act(
     actionOrOptions: string | ActOptions | ObserveResult,
   ): Promise<ActResult> {

Diff for: lib/dom/debug.ts

@@ -15,8 +15,6 @@ declare global {
       outputString: string;
       selectorMap: Record<number, string[]>;
     }>;
-    debugDom: () => Promise<void>;
-    cleanupDebug: () => void;
     createStagehandContainer: (obj: Window | HTMLElement) => StagehandContainer;
     waitForDomSettle: () => Promise<void>;
     __playwright?: unknown;

Diff for: lib/dom/global.d.ts

@@ -1,3 +1,2 @@
 export * from "./process";
 export * from "./utils";
-export * from "./debug";

Diff for: lib/dom/index.ts

@@ -605,7 +605,6 @@ export class StagehandActHandler {
   }): Promise<{ success: boolean; message: string; action: string }> {
     try {
       await this.stagehandPage._waitForSettledDom(domSettleTimeoutMs);
-      await this.stagehandPage.startDomDebug();
 
       if (timeoutMs && startTime) {
         const elapsedTime = Date.now() - startTime;
@@ -696,8 +695,6 @@ export class StagehandActHandler {
         },
       });
 
-      await this.stagehandPage.cleanupDomDebug();
-
       if (!response) {
         if (chunksSeen.length + 1 < chunks.length) {
           chunksSeen.push(chunk);

Diff for: lib/handlers/actHandler.ts

@@ -164,7 +164,6 @@ export class StagehandExtractHandler {
 
   private async extractPageText(): Promise<{ page_text?: string }> {
     await this.stagehandPage._waitForSettledDom();
-    await this.stagehandPage.startDomDebug();
 
     const originalDOM = await this.stagehandPage.page.evaluate(() =>
       window.storeDOM(undefined),
@@ -202,8 +201,6 @@ export class StagehandExtractHandler {
       containerDims.width,
     );
 
-    await this.stagehandPage.cleanupDomDebug();
-
     const result = { page_text: formattedText };
     return pageTextSchema.parse(result);
   }
@@ -239,7 +236,6 @@ export class StagehandExtractHandler {
 
     // **1:** Wait for the DOM to settle and start DOM debugging
     await this.stagehandPage._waitForSettledDom(domSettleTimeoutMs);
-    await this.stagehandPage.startDomDebug();
 
     const targetXpath = selector?.replace(/^xpath=/, "") ?? "";
 
@@ -364,9 +360,6 @@ export class StagehandExtractHandler {
       ...output
     } = extractionResponse;
 
-    // Clean up debug
-    await this.stagehandPage.cleanupDomDebug();
-
     // **11:** Handle the extraction response and log the results
     this.logger({
       category: "extraction",
@@ -439,7 +432,6 @@ export class StagehandExtractHandler {
     // **1:** Wait for the DOM to settle and start DOM debugging
     // This ensures the page is stable before extracting any data.
     await this.stagehandPage._waitForSettledDom(domSettleTimeoutMs);
-    await this.stagehandPage.startDomDebug();
 
     // **2:** Call processDom() to handle chunk-based extraction
     // processDom determines which chunk of the page to process next.
@@ -496,8 +488,6 @@ export class StagehandExtractHandler {
       ...output
     } = extractionResponse;
 
-    await this.stagehandPage.cleanupDomDebug();
-
     this.logger({
       category: "extraction",
       message: "received extraction response",

Diff for: lib/handlers/extractHandler.ts

@@ -185,7 +185,6 @@ export class StagehandObserveHandler {
         };
       }),
     );
-    await this.stagehandPage.cleanupDomDebug();
 
     this.logger({
       category: "observation",

Diff for: lib/handlers/observeHandler.ts

@@ -13,6 +13,7 @@ export interface ConstructorParams {
   apiKey?: string;
   projectId?: string;
   verbose?: 0 | 1 | 2;
+  /** @deprecated Dom Debugging is no longer supported in this version of Stagehand. */
   debugDom?: boolean;
   llmProvider?: LLMProvider;
   /** @deprecated Please use `localBrowserLaunchOptions` instead. That will override this. */