-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Expand file tree
/
Copy pathStagehandContext.ts
More file actions
259 lines (235 loc) · 7.92 KB
/
Copy pathStagehandContext.ts
File metadata and controls
259 lines (235 loc) · 7.92 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
import type {
BrowserContext as PlaywrightContext,
CDPSession,
Page as PlaywrightPage,
} from "playwright";
import { Stagehand } from "./index";
import { StagehandPage } from "./StagehandPage";
import { Page } from "../types/page";
import { EnhancedContext } from "../types/context";
import { Protocol } from "devtools-protocol";
import { scriptContent } from "./dom/build/scriptContent";
const stagehandInitScript = `
if (!window.__stagehandInjected) {
window.__stagehandInjected = true;
${scriptContent}
}
`;
export class StagehandContext {
private readonly stagehand: Stagehand;
private readonly intContext: EnhancedContext;
private pageMap: WeakMap<PlaywrightPage, StagehandPage>;
private activeStagehandPage: StagehandPage | null = null;
private readonly frameIdMap: Map<string, StagehandPage> = new Map();
private static readonly contextsWithInitScript =
new WeakSet<PlaywrightContext>();
private constructor(context: PlaywrightContext, stagehand: Stagehand) {
this.stagehand = stagehand;
this.pageMap = new WeakMap();
// Create proxy around the context
this.intContext = new Proxy(context, {
get: (target, prop) => {
if (prop === "newPage") {
return async (): Promise<Page> => {
const pwPage = await target.newPage();
const stagehandPage = await this.createStagehandPage(pwPage);
await this.attachFrameNavigatedListener(pwPage);
// Set as active page when created
this.setActivePage(stagehandPage);
return stagehandPage.page;
};
}
if (prop === "pages") {
return (): Page[] => {
const pwPages = target.pages();
// Convert all pages to StagehandPages synchronously
return pwPages.map((pwPage: PlaywrightPage) => {
let stagehandPage = this.pageMap.get(pwPage);
if (!stagehandPage) {
// Create a new StagehandPage and store it in the map
stagehandPage = new StagehandPage(
pwPage,
this.stagehand,
this,
this.stagehand.llmClient,
this.stagehand.userProvidedInstructions,
this.stagehand.apiClient,
this.stagehand.waitForCaptchaSolves,
);
this.pageMap.set(pwPage, stagehandPage);
}
return stagehandPage.page;
});
};
}
return target[prop as keyof PlaywrightContext];
},
}) as unknown as EnhancedContext;
}
private async createStagehandPage(
page: PlaywrightPage,
): Promise<StagehandPage> {
const stagehandPage = await new StagehandPage(
page,
this.stagehand,
this,
this.stagehand.llmClient,
this.stagehand.userProvidedInstructions,
this.stagehand.apiClient,
this.stagehand.waitForCaptchaSolves,
).init();
this.pageMap.set(page, stagehandPage);
return stagehandPage;
}
static async init(
context: PlaywrightContext,
stagehand: Stagehand,
): Promise<StagehandContext> {
if (!StagehandContext.contextsWithInitScript.has(context)) {
await context.addInitScript({ content: stagehandInitScript });
StagehandContext.contextsWithInitScript.add(context);
}
const instance = new StagehandContext(context, stagehand);
context.on("page", async (pwPage) => {
await instance.handleNewPlaywrightPage(pwPage);
instance
.attachFrameNavigatedListener(pwPage)
.catch((err) =>
stagehand.logger({
category: "cdp",
message: `Failed to attach frameNavigated listener: ${err}`,
level: 0,
}),
)
.finally(() =>
instance.handleNewPlaywrightPage(pwPage).catch((err) =>
stagehand.logger({
category: "context",
message: `Failed to initialise new page: ${err}`,
level: 0,
}),
),
);
});
// Initialize existing pages
const existingPages = context.pages();
for (const page of existingPages) {
const stagehandPage = await instance.createStagehandPage(page);
await instance.attachFrameNavigatedListener(page);
// Set the first page as active
if (!instance.activeStagehandPage) {
instance.setActivePage(stagehandPage);
}
}
return instance;
}
public get frameIdLookup(): ReadonlyMap<string, StagehandPage> {
return this.frameIdMap;
}
public registerFrameId(frameId: string, page: StagehandPage): void {
this.frameIdMap.set(frameId, page);
}
public unregisterFrameId(frameId: string): void {
this.frameIdMap.delete(frameId);
}
public getStagehandPageByFrameId(frameId: string): StagehandPage | undefined {
return this.frameIdMap.get(frameId);
}
public get context(): EnhancedContext {
return this.intContext;
}
public async getStagehandPage(page: PlaywrightPage): Promise<StagehandPage> {
let stagehandPage = this.pageMap.get(page);
if (!stagehandPage) {
stagehandPage = await this.createStagehandPage(page);
}
// Update active page when getting a page
this.setActivePage(stagehandPage);
return stagehandPage;
}
public async getStagehandPages(): Promise<StagehandPage[]> {
const pwPages = this.intContext.pages();
return Promise.all(
pwPages.map((page: PlaywrightPage) => this.getStagehandPage(page)),
);
}
public setActivePage(page: StagehandPage): void {
this.activeStagehandPage = page;
// Update the stagehand's active page reference
this.stagehand["setActivePage"](page);
}
public getActivePage(): StagehandPage | null {
return this.activeStagehandPage;
}
private async handleNewPlaywrightPage(pwPage: PlaywrightPage): Promise<void> {
if (pwPage.isClosed()) return;
// Only register close handler once per page
if (!this.pageMap.has(pwPage)) {
pwPage.once("close", () => {
const shPage = this.pageMap.get(pwPage);
if (shPage) {
if (shPage.frameId) this.unregisterFrameId(shPage.frameId);
if (this.activeStagehandPage === shPage) {
for (const p of this.intContext.pages()) {
const sp = this.pageMap.get(p);
if (sp && sp !== shPage) {
this.setActivePage(sp);
break;
}
}
}
}
});
}
try {
let stagehandPage = this.pageMap.get(pwPage);
if (!stagehandPage) {
stagehandPage = await this.createStagehandPage(pwPage);
}
this.setActivePage(stagehandPage);
} catch (err) {
const msg = (err as Error).message ?? "";
if (
msg.includes("No target with given id") ||
msg.includes("Target closed") ||
msg.includes("Target page, context or browser has been closed")
) {
return;
}
throw err;
}
}
private async attachFrameNavigatedListener(
pwPage: PlaywrightPage,
): Promise<void> {
const shPage = this.pageMap.get(pwPage);
if (!shPage) return;
if (pwPage.isClosed()) return;
let session: CDPSession;
try {
session = await this.intContext.newCDPSession(pwPage);
await session.send("Page.enable");
} catch (err) {
const msg = (err as Error).message ?? "";
if (
msg.includes("No target with given id") ||
msg.includes("Target closed") ||
msg.includes("Target page, context or browser has been closed")
) {
return;
}
throw err;
}
session.on(
"Page.frameNavigated",
(evt: Protocol.Page.FrameNavigatedEvent): void => {
if (evt.frame.parentId) return;
if (evt.frame.id === shPage.frameId) return;
const oldId = shPage.frameId;
if (oldId) this.unregisterFrameId(oldId);
this.registerFrameId(evt.frame.id, shPage);
shPage.updateRootFrameId(evt.frame.id);
},
);
}
}