forked from parse-community/parse-dashboard
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathBrowserControlAPI.js
More file actions
468 lines (403 loc) · 13 KB
/
BrowserControlAPI.js
File metadata and controls
468 lines (403 loc) · 13 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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
const express = require('express');
const BrowserSessionManager = require('./BrowserSessionManager');
const ServerOrchestrator = require('./ServerOrchestrator');
/**
* Create Browser Control API
*
* Provides HTTP endpoints for AI agents to control browser sessions.
* Exposes session management, navigation, interaction, and debugging capabilities.
*
* @param {Function} getWebpackState - Function to get current webpack compilation state
* @returns {express.Router} Express router with browser control endpoints
*/
function createBrowserControlAPI(getWebpackState) {
const router = express.Router();
const sessionManager = new BrowserSessionManager();
const orchestrator = new ServerOrchestrator();
// Parse JSON bodies
router.use(express.json());
// Expose sessionManager for BrowserEventStream to access
router.sessionManager = sessionManager;
router.orchestrator = orchestrator;
/**
* POST /session/start
* Create a new browser session, optionally starting Parse Server and Dashboard
*/
router.post('/session/start', async (req, res) => {
try {
const {
headless = true,
width = 1280,
height = 720,
slowMo = 0,
startServers = false,
parseServerOptions = {},
dashboardOptions = {}
} = req.body;
let parseServerInfo, dashboardInfo;
// Start servers if requested
if (startServers) {
try {
parseServerInfo = await orchestrator.startParseServer(parseServerOptions);
dashboardInfo = await orchestrator.startDashboard(parseServerInfo, dashboardOptions);
} catch (error) {
return res.status(500).json({
error: `Failed to start servers: ${error.message}`
});
}
}
// Create browser session
const { sessionId } = await sessionManager.createSession({
headless,
width,
height,
slowMo
});
res.json({
sessionId,
dashboardUrl: dashboardInfo?.url,
parseServerUrl: parseServerInfo?.serverURL,
servers: startServers ? {
parseServer: {
port: parseServerInfo.port,
appId: parseServerInfo.appId
},
dashboard: {
port: dashboardInfo.port
}
} : null
});
} catch (error) {
res.status(500).json({ error: error.message });
}
});
/**
* DELETE /session/:sessionId
* Clean up and destroy a browser session
*/
router.delete('/session/:sessionId', async (req, res) => {
try {
const { sessionId } = req.params;
const cleaned = await sessionManager.cleanup(sessionId);
if (!cleaned) {
return res.status(404).json({ error: `Session ${sessionId} not found` });
}
res.json({ success: true, sessionId });
} catch (error) {
res.status(500).json({ error: error.message });
}
});
/**
* GET /session/:sessionId/status
* Get session status and metadata
*/
router.get('/session/:sessionId/status', (req, res) => {
try {
const { sessionId } = req.params;
const session = sessionManager.getSession(sessionId);
res.json({
sessionId,
active: true,
pageUrl: session.page.url(),
createdAt: session.createdAt,
lastActivity: session.lastActivity,
uptime: Date.now() - session.createdAt
});
} catch (error) {
res.status(404).json({ error: error.message });
}
});
/**
* GET /sessions
* Get all active sessions
*/
router.get('/sessions', (req, res) => {
const sessions = sessionManager.getAllSessions();
res.json({ sessions, count: sessions.length });
});
/**
* POST /session/:sessionId/navigate
* Navigate to a URL
*/
router.post('/session/:sessionId/navigate', async (req, res) => {
try {
const { sessionId } = req.params;
const { url, waitUntil = 'networkidle2', timeout = 30000 } = req.body;
if (!url) {
return res.status(400).json({ error: 'url is required' });
}
const { page } = sessionManager.getSession(sessionId);
await page.goto(url, { waitUntil, timeout });
res.json({
success: true,
currentUrl: page.url()
});
} catch (error) {
res.status(500).json({ error: error.message });
}
});
/**
* POST /session/:sessionId/click
* Click an element
*/
router.post('/session/:sessionId/click', async (req, res) => {
try {
const { sessionId } = req.params;
const { selector, timeout = 5000 } = req.body;
if (!selector) {
return res.status(400).json({ error: 'selector is required' });
}
const { page } = sessionManager.getSession(sessionId);
await page.waitForSelector(selector, { timeout });
await page.click(selector);
res.json({ success: true, selector });
} catch (error) {
res.status(500).json({ error: error.message });
}
});
/**
* POST /session/:sessionId/type
* Type text into an input
*/
router.post('/session/:sessionId/type', async (req, res) => {
try {
const { sessionId } = req.params;
const { selector, text, timeout = 5000, delay = 0 } = req.body;
if (!selector || text === undefined) {
return res.status(400).json({ error: 'selector and text are required' });
}
const { page } = sessionManager.getSession(sessionId);
await page.waitForSelector(selector, { timeout });
// Clear existing text first
await page.click(selector, { clickCount: 3 });
await page.keyboard.press('Backspace');
// Type new text
await page.type(selector, text, { delay });
res.json({ success: true, selector, text });
} catch (error) {
res.status(500).json({ error: error.message });
}
});
/**
* POST /session/:sessionId/wait
* Wait for a selector to appear
*/
router.post('/session/:sessionId/wait', async (req, res) => {
try {
const { sessionId } = req.params;
const { selector, timeout = 10000, visible = true } = req.body;
if (!selector) {
return res.status(400).json({ error: 'selector is required' });
}
const { page } = sessionManager.getSession(sessionId);
const startTime = Date.now();
await page.waitForSelector(selector, { timeout, visible });
const duration = Date.now() - startTime;
res.json({ success: true, selector, found: true, duration });
} catch (error) {
res.status(500).json({ error: error.message, found: false });
}
});
/**
* GET /session/:sessionId/screenshot
* Take a screenshot
*/
router.get('/session/:sessionId/screenshot', async (req, res) => {
try {
const { sessionId } = req.params;
const { fullPage = 'true', encoding = 'base64' } = req.query;
const { page } = sessionManager.getSession(sessionId);
const screenshot = await page.screenshot({
fullPage: fullPage === 'true',
encoding
});
if (encoding === 'base64') {
res.json({ base64: `data:image/png;base64,${screenshot}` });
} else {
res.type('image/png').send(screenshot);
}
} catch (error) {
res.status(500).json({ error: error.message });
}
});
/**
* POST /session/:sessionId/evaluate
* Execute JavaScript in the page context
*/
router.post('/session/:sessionId/evaluate', async (req, res) => {
try {
const { sessionId } = req.params;
const { script } = req.body;
if (!script) {
return res.status(400).json({ error: 'script is required' });
}
const { page } = sessionManager.getSession(sessionId);
// Wrap script in function if it's not already
const scriptToEval = script.startsWith('function') || script.includes('=>')
? `(${script})()`
: script;
const result = await page.evaluate(scriptToEval);
res.json({ result });
} catch (error) {
res.status(500).json({ error: error.message });
}
});
/**
* POST /session/:sessionId/query
* Query elements on the page
*/
router.post('/session/:sessionId/query', async (req, res) => {
try {
const { sessionId } = req.params;
const { selector, multiple = false } = req.body;
if (!selector) {
return res.status(400).json({ error: 'selector is required' });
}
const { page } = sessionManager.getSession(sessionId);
if (multiple) {
// Query multiple elements
const elements = await page.$$eval(selector, els =>
els.map(el => ({
text: el.textContent?.trim(),
visible: el.offsetParent !== null,
tagName: el.tagName,
className: el.className
}))
);
res.json({ elements, count: elements.length });
} else {
// Query single element
const element = await page.$eval(selector, el => ({
text: el.textContent?.trim(),
visible: el.offsetParent !== null,
tagName: el.tagName,
className: el.className
})).catch(() => null);
if (!element) {
return res.status(404).json({ error: `Element not found: ${selector}` });
}
res.json({ element });
}
} catch (error) {
res.status(500).json({ error: error.message });
}
});
/**
* POST /session/:sessionId/reload
* Reload the current page
*/
router.post('/session/:sessionId/reload', async (req, res) => {
try {
const { sessionId } = req.params;
const { waitUntil = 'networkidle2' } = req.body;
const { page } = sessionManager.getSession(sessionId);
await page.reload({ waitUntil });
res.json({ success: true, currentUrl: page.url() });
} catch (error) {
res.status(500).json({ error: error.message });
}
});
/**
* GET /servers/status
* Get status of Parse Server and Dashboard
*/
router.get('/servers/status', (req, res) => {
const status = orchestrator.getStatus();
res.json(status);
});
/**
* GET /ready
* Check if the dashboard is ready (webpack compiled, assets available)
* Returns ready: true when webpack is not compiling, false otherwise
*/
router.get('/ready', (req, res) => {
const webpackState = getWebpackState ? getWebpackState() : { isCompiling: false };
const ready = !webpackState.isCompiling;
res.json({
ready,
webpack: {
compiling: webpackState.isCompiling,
lastCompilationTime: webpackState.lastCompilationTime,
lastCompilationDuration: webpackState.lastCompilationDuration,
compileCount: webpackState.compileCount,
hasErrors: webpackState.errors && webpackState.errors.length > 0,
}
});
});
/**
* GET /ready/wait
* Wait for the dashboard to be ready (webpack compiled)
* Polls until webpack is done compiling or timeout is reached
*/
router.get('/ready/wait', async (req, res) => {
const timeout = parseInt(req.query.timeout, 10) || 30000;
const pollInterval = 100;
const startTime = Date.now();
const checkReady = () => {
const webpackState = getWebpackState ? getWebpackState() : { isCompiling: false };
return !webpackState.isCompiling;
};
// Poll until ready or timeout
while (!checkReady()) {
if (Date.now() - startTime > timeout) {
const webpackState = getWebpackState ? getWebpackState() : {};
return res.status(408).json({
ready: false,
error: 'Timeout waiting for webpack to finish compiling',
waited: Date.now() - startTime,
webpack: {
compiling: webpackState.isCompiling,
compileCount: webpackState.compileCount,
}
});
}
await new Promise(resolve => setTimeout(resolve, pollInterval));
}
const webpackState = getWebpackState ? getWebpackState() : {};
res.json({
ready: true,
waited: Date.now() - startTime,
webpack: {
compiling: false,
lastCompilationTime: webpackState.lastCompilationTime,
lastCompilationDuration: webpackState.lastCompilationDuration,
compileCount: webpackState.compileCount,
}
});
});
/**
* POST /servers/stop
* Stop Parse Server and Dashboard
*/
router.post('/servers/stop', async (req, res) => {
try {
await orchestrator.stopAll();
res.json({ success: true });
} catch (error) {
res.status(500).json({ error: error.message });
}
});
/**
* POST /cleanup
* Clean up all sessions and servers
*/
router.post('/cleanup', async (req, res) => {
try {
await sessionManager.cleanupAll();
await orchestrator.stopAll();
res.json({ success: true });
} catch (error) {
res.status(500).json({ error: error.message });
}
});
// Cleanup on process exit
const cleanup = async () => {
console.log('Browser Control API shutting down...');
await sessionManager.shutdown();
await orchestrator.stopAll();
};
process.on('SIGTERM', cleanup);
process.on('SIGINT', cleanup);
return router;
}
module.exports = createBrowserControlAPI;