update: LLMClient default inherits logger from Stagehand (#366) (#367)

* update: LLMClient default inherits logger from Stagehand

* update: add changeset

* update: export LLMClient

Co-authored-by: Arihan Varanasi <[email protected]>

Author: kamath

Diff for: .changeset/mean-swans-fix.md

@@ -0,0 +1,5 @@
+---
+"@browserbasehq/stagehand": minor
+---
+
+Logger in LLMClient is inherited by default from Stagehand. Named rather than positional arguments are used in implemented LLMClients.

Diff for: examples/external_client.ts

@@ -1,4 +1,4 @@
-import { type ConstructorParams, type LogLine, Stagehand } from "../lib";
+import { type ConstructorParams, Stagehand } from "../lib";
 import { z } from "zod";
 import { OllamaClient } from "./external_clients/ollama";
 
@@ -7,13 +7,9 @@ const StagehandConfig: ConstructorParams = {
   apiKey: process.env.BROWSERBASE_API_KEY,
   projectId: process.env.BROWSERBASE_PROJECT_ID,
   verbose: 1,
-  llmClient: new OllamaClient(
-    (message: LogLine) =>
-      console.log(`[stagehand::${message.category}] ${message.message}`),
-    false,
-    undefined,
-    "llama3.2",
-  ),
+  llmClient: new OllamaClient({
+    modelName: "llama3.2",
+  }),
   debugDom: true,
 };
 

Diff for: examples/external_clients/ollama.ts

@@ -28,13 +28,19 @@ export class OllamaClient extends LLMClient {
   private enableCaching: boolean;
   public clientOptions: ClientOptions;
 
-  constructor(
-    logger: (message: LogLine) => void,
+  constructor({
+    logger,
     enableCaching = false,
-    cache: LLMCache | undefined,
-    modelName: "llama3.2",
-    clientOptions?: ClientOptions,
-  ) {
+    cache = undefined,
+    modelName = "llama3.2",
+    clientOptions,
+  }: {
+    logger?: (message: LogLine) => void;
+    enableCaching?: boolean;
+    cache?: LLMCache;
+    modelName?: string;
+    clientOptions?: ClientOptions;
+  }) {
     super(modelName as AvailableModel);
     this.client = new OpenAI({
       ...clientOptions,

Diff for: lib/index.ts

@@ -365,6 +365,11 @@ export class Stagehand {
         modelName ?? DEFAULT_MODEL_NAME,
         modelClientOptions,
       );
+
+    if (!this.llmClient.logger) {
+      this.llmClient.logger = this.logger;
+    }
+
     this.domSettleTimeoutMs = domSettleTimeoutMs ?? 30_000;
     this.headless = headless ?? false;
     this.browserbaseSessionCreateParams = browserbaseSessionCreateParams;
@@ -614,3 +619,4 @@ export * from "../types/model";
 export * from "../types/playwright";
 export * from "../types/stagehand";
 export * from "../types/page";
+export { LLMClient } from "./llm/LLMClient";

Diff for: lib/llm/AnthropicClient.ts

@@ -19,13 +19,19 @@ export class AnthropicClient extends LLMClient {
   private enableCaching: boolean;
   public clientOptions: ClientOptions;
 
-  constructor(
-    logger: (message: LogLine) => void,
+  constructor({
+    logger,
     enableCaching = false,
-    cache: LLMCache | undefined,
-    modelName: AvailableModel,
-    clientOptions?: ClientOptions,
-  ) {
+    cache,
+    modelName,
+    clientOptions,
+  }: {
+    logger: (message: LogLine) => void;
+    enableCaching?: boolean;
+    cache?: LLMCache;
+    modelName: AvailableModel;
+    clientOptions?: ClientOptions;
+  }) {
     super(modelName);
     this.client = new Anthropic(clientOptions);
     this.logger = logger;

Diff for: lib/llm/LLMProvider.ts

@@ -61,21 +61,21 @@ export class LLMProvider {
 
     switch (provider) {
       case "openai":
-        return new OpenAIClient(
-          this.logger,
-          this.enableCaching,
-          this.cache,
+        return new OpenAIClient({
+          logger: this.logger,
+          enableCaching: this.enableCaching,
+          cache: this.cache,
           modelName,
           clientOptions,
-        );
+        });
       case "anthropic":
-        return new AnthropicClient(
-          this.logger,
-          this.enableCaching,
-          this.cache,
+        return new AnthropicClient({
+          logger: this.logger,
+          enableCaching: this.enableCaching,
+          cache: this.cache,
           modelName,
           clientOptions,
-        );
+        });
       default:
         throw new Error(`Unsupported provider: ${provider}`);
     }

Diff for: lib/llm/OpenAIClient.ts

@@ -29,13 +29,19 @@ export class OpenAIClient extends LLMClient {
   private enableCaching: boolean;
   public clientOptions: ClientOptions;
 
-  constructor(
-    logger: (message: LogLine) => void,
+  constructor({
+    logger,
     enableCaching = false,
-    cache: LLMCache | undefined,
-    modelName: AvailableModel,
-    clientOptions?: ClientOptions,
-  ) {
+    cache,
+    modelName,
+    clientOptions,
+  }: {
+    logger: (message: LogLine) => void;
+    enableCaching?: boolean;
+    cache?: LLMCache;
+    modelName: AvailableModel;
+    clientOptions?: ClientOptions;
+  }) {
     super(modelName);
     this.clientOptions = clientOptions;
     this.client = new OpenAI(clientOptions);