fix stagehand.history (#753)

Author: seanmcguire12

.changeset/metal-clowns-cheat.md

@@ -0,0 +1,5 @@
+---
+"@browserbasehq/stagehand-lib": patch
+---
+
+fix `stagehand.history`

lib/StagehandPage.ts

@@ -6,7 +6,6 @@ import { Page, defaultExtractSchema } from "../types/page";
 import {
   ExtractOptions,
   ExtractResult,
-  HistoryEntry,
   ObserveOptions,
   ObserveResult,
 } from "../types/stagehand";
@@ -46,11 +45,6 @@ export class StagehandPage {
   private userProvidedInstructions?: string;
   private waitForCaptchaSolves: boolean;
   private initialized: boolean = false;
-  private _history: Array<HistoryEntry> = [];
-
-  public get history(): ReadonlyArray<HistoryEntry> {
-    return Object.freeze([...this._history]);
-  }
 
   constructor(
     page: PlaywrightPage,
@@ -338,13 +332,15 @@ ${scriptContent} \
 
           // Handle goto specially
           if (prop === "goto") {
+            const rawGoto: typeof target.goto =
+              Object.getPrototypeOf(target).goto.bind(target);
             return async (url: string, options: GotoOptions) => {
               this.intContext.setActivePage(this);
               const result = this.api
                 ? await this.api.goto(url, options)
-                : await target.goto(url, options);
+                : await rawGoto(url, options);
 
-              this.addToHistory("navigate", { url, options }, result);
+              this.stagehand.addToHistory("navigate", { url, options }, result);
 
               if (this.waitForCaptchaSolves) {
                 try {
@@ -498,24 +494,6 @@ ${scriptContent} \
     }
   }
 
-  public addToHistory(
-    method: HistoryEntry["method"],
-    parameters:
-      | ActOptions
-      | ExtractOptions<z.AnyZodObject>
-      | ObserveOptions
-      | { url: string; options: GotoOptions }
-      | string,
-    result?: unknown,
-  ): void {
-    this._history.push({
-      method,
-      parameters,
-      result: result ?? null,
-      timestamp: new Date().toISOString(),
-    });
-  }
-
   async act(
     actionOrOptions: string | ActOptions | ObserveResult,
   ): Promise<ActResult> {
@@ -536,7 +514,7 @@ ${scriptContent} \
           if (this.api) {
             const result = await this.api.act(observeResult);
             await this._refreshPageFromAPI();
-            this.addToHistory("act", observeResult, result);
+            this.stagehand.addToHistory("act", observeResult, result);
             return result;
           }
 
@@ -568,7 +546,7 @@ ${scriptContent} \
       if (this.api) {
         const result = await this.api.act(actionOrOptions);
         await this._refreshPageFromAPI();
-        this.addToHistory("act", actionOrOptions, result);
+        this.stagehand.addToHistory("act", actionOrOptions, result);
         return result;
       }
 
@@ -603,8 +581,7 @@ ${scriptContent} \
         llmClient,
         requestId,
       );
-
-      this.addToHistory("act", actionOrOptions, result);
+      this.stagehand.addToHistory("act", actionOrOptions, result);
       return result;
     } catch (err: unknown) {
       if (err instanceof StagehandError || err instanceof StagehandAPIError) {
@@ -632,7 +609,7 @@ ${scriptContent} \
         } else {
           result = await this.extractHandler.extract();
         }
-        this.addToHistory("extract", instructionOrOptions, result);
+        this.stagehand.addToHistory("extract", instructionOrOptions, result);
         return result;
       }
 
@@ -656,7 +633,7 @@ ${scriptContent} \
 
       if (this.api) {
         const result = await this.api.extract<T>(options);
-        this.addToHistory("extract", instructionOrOptions, result);
+        this.stagehand.addToHistory("extract", instructionOrOptions, result);
         return result;
       }
 
@@ -719,7 +696,7 @@ ${scriptContent} \
           throw e;
         });
 
-      this.addToHistory("extract", instructionOrOptions, result);
+      this.stagehand.addToHistory("extract", instructionOrOptions, result);
 
       return result;
     } catch (err: unknown) {
@@ -757,7 +734,7 @@ ${scriptContent} \
 
       if (this.api) {
         const result = await this.api.observe(options);
-        this.addToHistory("observe", instructionOrOptions, result);
+        this.stagehand.addToHistory("observe", instructionOrOptions, result);
         return result;
       }
 
@@ -834,7 +811,7 @@ ${scriptContent} \
           throw e;
         });
 
-      this.addToHistory("observe", instructionOrOptions, result);
+      this.stagehand.addToHistory("observe", instructionOrOptions, result);
 
       return result;
     } catch (err: unknown) {

lib/index.ts

@@ -17,6 +17,9 @@ import {
   StagehandMetrics,
   StagehandFunctionName,
   HistoryEntry,
+  ActOptions,
+  ExtractOptions,
+  ObserveOptions,
 } from "../types/stagehand";
 import { StagehandContext } from "./StagehandContext";
 import { StagehandPage } from "./StagehandPage";
@@ -41,6 +44,8 @@ import {
   UnsupportedAISDKModelProviderError,
   InvalidAISDKModelFormatError,
 } from "../types/stagehandErrors";
+import { z } from "zod";
+import { GotoOptions } from "@/types/playwright";
 
 dotenv.config({ path: ".env" });
 
@@ -396,6 +401,10 @@ export class Stagehand {
   private _env: "LOCAL" | "BROWSERBASE";
   private _browser: Browser | undefined;
   private _isClosed: boolean = false;
+  private _history: Array<HistoryEntry> = [];
+  public get history(): ReadonlyArray<HistoryEntry> {
+    return Object.freeze([...this._history]);
+  }
   protected setActivePage(page: StagehandPage): void {
     this.stagehandPage = page;
   }
@@ -810,6 +819,24 @@ export class Stagehand {
     }
   }
 
+  public addToHistory(
+    method: HistoryEntry["method"],
+    parameters:
+      | ActOptions
+      | ExtractOptions<z.AnyZodObject>
+      | ObserveOptions
+      | { url: string; options: GotoOptions }
+      | string,
+    result?: unknown,
+  ): void {
+    this._history.push({
+      method,
+      parameters,
+      result: result ?? null,
+      timestamp: new Date().toISOString(),
+    });
+  }
+
   /**
    * Create an agent instance that can be executed with different instructions
    * @returns An agent instance with execute() method
@@ -897,14 +924,6 @@ export class Stagehand {
       },
     };
   }
-
-  public get history(): ReadonlyArray<HistoryEntry> {
-    if (!this.stagehandPage) {
-      throw new StagehandNotInitializedError("history()");
-    }
-
-    return this.stagehandPage.history;
-  }
 }
 
 export * from "../types/browser";