Merge pull request #69 from amhsirak/develop

feat: run robot by API
This commit is contained in:
Karishma Shukla
2024-10-12 22:45:03 +05:30
committed by GitHub
2 changed files with 252 additions and 7 deletions

View File

@@ -1,9 +1,16 @@
import { readFile, readFiles } from "../workflow-management/storage";
import { Router, Request, Response } from 'express';
import { chromium } from "playwright";
import { requireAPIKey } from "../middlewares/api";
import Robot from "../models/Robot";
import Run from "../models/Run";
const router = Router();
import { getDecryptedProxyConfig } from "../routes/proxy";
import { uuid } from "uuidv4";
import { createRemoteBrowserForRun, destroyRemoteBrowser } from "../browser-management/controller";
import logger from "../logger";
import { browserPool } from "../server";
import { io, Socket } from "socket.io-client";
const formatRecording = (recordingData: any) => {
const recordingMeta = recordingData.recording_meta;
@@ -146,7 +153,7 @@ router.get("/robots/:id/runs/:runId", requireAPIKey, async (req: Request, res: R
},
raw: true
});
const response = {
statusCode: 200,
messageCode: "success",
@@ -164,4 +171,245 @@ router.get("/robots/:id/runs/:runId", requireAPIKey, async (req: Request, res: R
}
});
async function createWorkflowAndStoreMetadata(id: string, userId: string) {
try {
const recording = await Robot.findOne({
where: {
'recording_meta.id': id
},
raw: true
});
if (!recording || !recording.recording_meta || !recording.recording_meta.id) {
return {
success: false,
error: 'Recording not found'
};
}
const proxyConfig = await getDecryptedProxyConfig(userId);
let proxyOptions: any = {};
if (proxyConfig.proxy_url) {
proxyOptions = {
server: proxyConfig.proxy_url,
...(proxyConfig.proxy_username && proxyConfig.proxy_password && {
username: proxyConfig.proxy_username,
password: proxyConfig.proxy_password,
}),
};
}
const browserId = createRemoteBrowserForRun({
browser: chromium,
launchOptions: {
headless: true,
proxy: proxyOptions.server ? proxyOptions : undefined,
}
});
const runId = uuid();
const run = await Run.create({
status: 'Running',
name: recording.recording_meta.name,
robotId: recording.id,
robotMetaId: recording.recording_meta.id,
startedAt: new Date().toLocaleString(),
finishedAt: '',
browserId,
interpreterSettings: { maxConcurrency: 1, maxRepeats: 1, debug: true },
log: '',
runId,
serializableOutput: {},
binaryOutput: {},
});
const plainRun = run.toJSON();
return {
browserId,
runId: plainRun.runId,
}
} catch (e) {
const { message } = e as Error;
logger.log('info', `Error while scheduling a run with id: ${id}`);
console.log(message);
return {
success: false,
error: message,
};
}
}
async function readyForRunHandler(browserId: string, id: string) {
try {
const result = await executeRun(id);
if (result && result.success) {
logger.log('info', `Interpretation of ${id} succeeded`);
resetRecordingState(browserId, id);
return result.interpretationInfo;
} else {
logger.log('error', `Interpretation of ${id} failed`);
await destroyRemoteBrowser(browserId);
resetRecordingState(browserId, id);
return null;
}
} catch (error: any) {
logger.error(`Error during readyForRunHandler: ${error.message}`);
await destroyRemoteBrowser(browserId);
return null;
}
}
function resetRecordingState(browserId: string, id: string) {
browserId = '';
id = '';
}
async function executeRun(id: string) {
try {
const run = await Run.findOne({ where: { runId: id } });
if (!run) {
return {
success: false,
error: 'Run not found'
};
}
const plainRun = run.toJSON();
const recording = await Robot.findOne({ where: { 'recording_meta.id': plainRun.robotMetaId }, raw: true });
if (!recording) {
return {
success: false,
error: 'Recording not found'
};
}
plainRun.status = 'running';
const browser = browserPool.getRemoteBrowser(plainRun.browserId);
if (!browser) {
throw new Error('Could not access browser');
}
const currentPage = await browser.getCurrentPage();
if (!currentPage) {
throw new Error('Could not create a new page');
}
const interpretationInfo = await browser.interpreter.InterpretRecording(
recording.recording, currentPage, plainRun.interpreterSettings
);
await destroyRemoteBrowser(plainRun.browserId);
const updatedRun = await run.update({
...run,
status: 'success',
finishedAt: new Date().toLocaleString(),
browserId: plainRun.browserId,
log: interpretationInfo.log.join('\n'),
serializableOutput: interpretationInfo.serializableOutput,
binaryOutput: interpretationInfo.binaryOutput,
});
return {
success: true,
interpretationInfo: updatedRun.toJSON()
};
} catch (error: any) {
logger.log('info', `Error while running a recording with id: ${id} - ${error.message}`);
return {
success: false,
error: error.message,
};
}
}
export async function handleRunRecording(id: string, userId: string) {
try {
const result = await createWorkflowAndStoreMetadata(id, userId);
const { browserId, runId: newRunId } = result;
if (!browserId || !newRunId || !userId) {
throw new Error('browserId or runId or userId is undefined');
}
const socket = io(`http://localhost:8080/${browserId}`, {
transports: ['websocket'],
rejectUnauthorized: false
});
socket.on('ready-for-run', () => readyForRunHandler(browserId, newRunId));
logger.log('info', `Running recording: ${id}`);
socket.on('disconnect', () => {
cleanupSocketListeners(socket, browserId, newRunId);
});
// Return the runId immediately, so the client knows the run is started
return newRunId;
} catch (error: any) {
logger.error('Error running recording:', error);
}
}
function cleanupSocketListeners(socket: Socket, browserId: string, id: string) {
socket.off('ready-for-run', () => readyForRunHandler(browserId, id));
logger.log('info', `Cleaned up listeners for browserId: ${browserId}, runId: ${id}`);
}
async function waitForRunCompletion(runId: string, interval: number = 2000) {
while (true) {
const run = await Run.findOne({ where: { runId }, raw: true });
if (!run) throw new Error('Run not found');
if (run.status === 'success') {
return run;
} else if (run.status === 'error') {
throw new Error('Run failed');
}
// Wait for the next polling interval
await new Promise(resolve => setTimeout(resolve, interval));
}
}
router.post("/robots/:id/runs", requireAPIKey, async (req: Request, res: Response) => {
try {
const runId = await handleRunRecording(req.params.id, req.user.dataValues.id);
console.log(`Result`, runId);
if (!runId) {
throw new Error('Run ID is undefined');
}
const completedRun = await waitForRunCompletion(runId);
const response = {
statusCode: 200,
messageCode: "success",
run: completedRun,
};
res.status(200).json(response);
} catch (error) {
console.error("Error running robot:", error);
res.status(500).json({
statusCode: 500,
messageCode: "error",
message: "Failed to run robot",
});
}
});
export default router;

View File

@@ -1,18 +1,15 @@
import fs from "fs";
import { uuid } from "uuidv4";
import { chromium } from "playwright";
import { io, Socket } from "socket.io-client";
import { readFile, saveFile } from "../storage";
import { createRemoteBrowserForRun, destroyRemoteBrowser } from '../../browser-management/controller';
import logger from '../../logger';
import { browserPool } from "../../server";
import { googleSheetUpdateTasks, processGoogleSheetUpdates } from "../integrations/gsheet";
import { getRecordingByFileName } from "../../routes/storage";
import Robot from "../../models/Robot";
import Run from "../../models/Run";
import { getDecryptedProxyConfig } from "../../routes/proxy";
async function runWorkflow(id: string, userId: string) {
async function createWorkflowAndStoreMetadata(id: string, userId: string) {
if (!id) {
id = uuid();
}
@@ -174,7 +171,7 @@ function resetRecordingState(browserId: string, id: string) {
export async function handleRunRecording(id: string, userId: string) {
try {
const result = await runWorkflow(id, userId);
const result = await createWorkflowAndStoreMetadata(id, userId);
const { browserId, runId: newRunId } = result;
if (!browserId || !newRunId || !userId) {
@@ -204,4 +201,4 @@ function cleanupSocketListeners(socket: Socket, browserId: string, id: string) {
logger.log('info', `Cleaned up listeners for browserId: ${browserId}, runId: ${id}`);
}
export { runWorkflow };
export { createWorkflowAndStoreMetadata };