@stubber/virtual-worker 1.2.0 → 1.4.0

package/app/commands/api_proxy/api_proxy.js

@@ -0,0 +1,74 @@
+import { create_success } from "#app/functions/create_success.js";
+import * as z from "zod";
+
+const return_data_schema = z.object({
+  // eslint-disable-next-line id-match
+  contentType: z.string(),
+  body: z.any(),
+  status: z.number(),
+  // eslint-disable-next-line id-match
+  statusText: z.string(),
+});
+
+const params_schema = z.looseObject({
+  apiurl: z.string(),
+  options: z.looseObject({}).optional(),
+  timeout_seconds: z.number().optional(),
+  __apicall_params: z
+    .looseObject({})
+    .optional()
+    .describe("apicall params as originally passed to the apicall task on core"),
+});
+
+/**
+ * Run an arbitrary CLI command and return stdout/stderr.
+ * @param {z.infer<typeof params_schema>} params
+ */
+export const api_proxy = async (params, _stubber) => {
+  let { apiurl, options, timeout_seconds, __apicall_params } = params || {};
+
+  const timeout = (timeout_seconds || __apicall_params?.timeout_seconds || 15) * 1000;
+
+  if (!options) {
+    options = {};
+  }
+
+  //   console.log("timeout", timeout);
+
+  options.signal = AbortSignal.timeout(timeout);
+
+  const response = await fetch(apiurl, options);
+
+  const content_type = response.headers.get("content-type") || "";
+  let body;
+  if (content_type.includes("application/json")) {
+    body = await response.json();
+  } else if (content_type.includes("multipart/form-data")) {
+    body = await response.formData();
+  } else if (content_type.includes("application/octet-stream")) {
+    body = await response.blob();
+  } else {
+    body = await response.text();
+  }
+  const status = response.status;
+  const status_text = response.statusText;
+
+  /** @type {z.infer<typeof return_data_schema>} */
+  const result = {
+    // eslint-disable-next-line id-match
+    contentType: content_type,
+    body: body || undefined,
+    status,
+    // eslint-disable-next-line id-match
+    statusText: status_text,
+  };
+
+  const success = response.ok;
+
+  return {
+    success,
+    payload: {
+      apiresult: result,
+    },
+  };
+};

package/app/commands/browser/browser_click.js

@@ -15,7 +15,7 @@ export const browser_click = async (params, stubber_context) => {
   const { entries } = params || {};
 
   // use playwright to move the mouse and perform a left click
-  const page_result = await get_chromium_page(params?.session_id || stubber_context.stubref);
+  const page_result = await get_chromium_page(params, stubber_context);
 
   if (!page_result.success) {
     return page_result;

package/app/commands/browser/browser_extract_data.js

@@ -9,7 +9,7 @@ export const browser_extract_data = async (params, stubber_context) => {
   }
 
   // Get the Chromium page
-  const page_result = await get_chromium_page(params?.session_id || stubber_context.stubref);
+  const page_result = await get_chromium_page(params, stubber_context);
   if (!page_result.success) {
     return page_result;
   }

package/app/commands/browser/browser_extract_html.js

@@ -10,7 +10,7 @@ import { get_chromium_page } from "../../helpers/get_chromium_page.js";
  */
 export const browser_extract_html = async (params, stubber_context) => {
   // Get the Chromium page
-  const page_result = await get_chromium_page(params?.session_id || stubber_context.stubref);
+  const page_result = await get_chromium_page(params, stubber_context);
   if (!page_result.success) {
     return page_result;
   }

package/app/commands/browser/browser_get_clipboard_text.js

@@ -13,7 +13,7 @@ import { get_chromium_page } from "../../helpers/get_chromium_page.js";
  * @returns
  */
 export const browser_get_clipboard_text = async (params, stubber_context) => {
-  const page_result = await get_chromium_page(params?.session_id || stubber_context.stubref);
+  const page_result = await get_chromium_page(params, stubber_context);
 
   if (!page_result.success) {
     return page_result;

package/app/commands/browser/browser_get_localstorage.js

@@ -3,7 +3,7 @@ import { create_success } from "#app/functions/create_success.js";
 import { get_chromium_page } from "../../helpers/get_chromium_page.js";
 
 export const browser_get_localstorage = async (params, stubber_context) => {
-  const page_result = await get_chromium_page(params?.session_id || stubber_context.stubref);
+  const page_result = await get_chromium_page(params, stubber_context);
 
   if (!page_result.success) {
     return page_result;

package/app/commands/browser/browser_navigate.js

@@ -3,7 +3,7 @@ import { create_success } from "#app/functions/create_success.js";
 import { get_chromium_page } from "../../helpers/get_chromium_page.js";
 
 export const browser_navigate = async (params, stubber_context) => {
-  const result = await get_chromium_page(params?.session_id || stubber_context.stubref);
+  const result = await get_chromium_page(params, stubber_context);
   if (!result.success) {
     return result;
   }

package/app/commands/browser/browser_press_key.js

@@ -11,7 +11,7 @@ import { get_chromium_page } from "#app/helpers/get_chromium_page.js";
  */
 export const browser_press_key = async (params, stubber_context) => {
   const { entries } = params || {};
-  const page_result = await get_chromium_page(params?.session_id || stubber_context.stubref);
+  const page_result = await get_chromium_page(params, stubber_context);
   if (!page_result.success) {
     return page_result;
   }

package/app/commands/browser/browser_screenshot.js

@@ -14,7 +14,7 @@ import { create_error_technical } from "#app/functions/create_error_technical.js
 export const browser_screenshot = async (params, stubber_context) => {
   let { screenshot_options, locator } = params || {};
 
-  const page_result = await get_chromium_page(params?.session_id || stubber_context.stubref);
+  const page_result = await get_chromium_page(params, stubber_context);
   if (!page_result.success) {
     return page_result;
   }
@@ -53,7 +53,7 @@ export const browser_screenshot = async (params, stubber_context) => {
 
     return create_success({
       message: "Screenshot captured successfully",
-      payload: { screenshot: { path: screenshot_options.path, file_info } },
+      payload: { screenshot: { path: screenshot_options.path, file_info }, attachments: file_info ? [file_info] : [] },
     });
   } catch (error) {
     return create_error_technical(error);

package/app/commands/browser/browser_write_text.js

@@ -11,7 +11,7 @@ import { get_chromium_page } from "../../helpers/get_chromium_page.js";
  */
 export const browser_write_text = async (params, stubber_context) => {
   const { entries } = params || {};
-  const page_result = await get_chromium_page(params?.session_id || stubber_context.stubref);
+  const page_result = await get_chromium_page(params, stubber_context);
   if (!page_result.success) {
     return page_result;
   }

package/app/commands/file-server/upload_files.js

@@ -98,9 +98,16 @@ export const upload_files = async (params, _stubber) => {
       };
     }
 
+    let attachments = [];
+
+    if (payload.uploaded_files) {
+      attachments = payload.uploaded_files;
+    }
+
     return create_success({
       message: "Files uploaded successfully",
       payload,
+      attachments,
     });
   } catch (error) {
     return create_error_technical(error);

package/app/commands/index.js

@@ -12,6 +12,8 @@ import { cli_run } from "./cli/cli_run.js";
 import { upload_files } from "./file-server/upload_files.js";
 import { download_files } from "./file-server/download_files.js";
 
+import { api_proxy } from "./api_proxy/api_proxy.js";
+
 const all_commands = {
   browser_click,
   browser_extract_data,
@@ -27,6 +29,8 @@ const all_commands = {
 
   upload_files,
   download_files,
+
+  api_proxy,
 };
 
 export { all_commands };

package/app/helpers/get_chromium_page.js

@@ -16,17 +16,22 @@ const contexts = {};
  * @param {string} session_id
  * @returns {Promise<{ success: boolean, payload?: import("playwright").Page }>}
  */
-export const get_chromium_page = async (session_id) => {
+export const get_chromium_page = async (params, stubber_context) => {
+  const session_id = params?.session_id || stubber_context.stubref;
   if (!session_id) {
     return create_error_conceptual({ message: "session_id is required to get a Chromium page." });
   }
 
+  const slow_mo = params?.slow_mo || process.env.SLOW_MO || 0;
+
+  console.log(`get_chromium_page: session_id=${session_id}, slow_mo=${slow_mo}`);
+
   // Launch the browser once and reuse it
   if (!browser) {
     browser = await chromium.launch({
       headless: false,
       // eslint-disable-next-line id-match
-      slowMo: 500,
+      slowMo: slow_mo,
     });
   }
 

package/lib/interfaces/http/routers/task_gateway.js

@@ -15,7 +15,7 @@ router.post(["/virtual_worker_task", "/virtual_worker_send_commands"], async (re
     const payload = task_payload_schema.parse(req.body);
     const task = payload.task;
 
-    console.log("Received task:", task.task_name, "of type:", task.tasktype, "with params:", task.params);
+    console.log("Received task:", task.task_name, "of type:", task.tasktype);
 
     const result = await virtual_worker_task(task);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stubber/virtual-worker",
-  "version": "1.2.0",
+  "version": "1.4.0",
   "description": "Template to easily create a node app and keep development standards",
   "main": "app.js",
   "directories": {