@intuned/runtime 1.3.3 → 1.3.6

package/dist/common/extensionsHelpers.js

@@ -0,0 +1,81 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.buildExtensionsList = buildExtensionsList;
+exports.getIntunedExtensionPath = getIntunedExtensionPath;
+exports.getIntunedExtensionSettings = getIntunedExtensionSettings;
+exports.getIntunedExtensionWorker = getIntunedExtensionWorker;
+exports.isIntunedExtensionEnabled = isIntunedExtensionEnabled;
+exports.setupIntunedExtension = setupIntunedExtension;
+var _settings = require("../commands/common/utils/settings");
+var _settingsSchema = require("./settingsSchema");
+var _constants = require("./constants");
+var _jwtTokenManager = require("./jwtTokenManager");
+var _path = _interopRequireDefault(require("path"));
+var _promises = require("fs/promises");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+const INTUNED_WORKER = "intunedWorker.js";
+const INTUNED_EXTENSION_SETTINGS_FILE_NAME = "intunedSettings.json";
+function buildExtensionsList() {
+  const extensionsList = [];
+  if (isIntunedExtensionEnabled()) {
+    const intunedExtensionPath = getIntunedExtensionPath();
+    extensionsList.push(intunedExtensionPath);
+  }
+  return extensionsList;
+}
+function getIntunedExtensionPath() {
+  return process.env.INTUNED_EXTENSION_PATH;
+}
+function isIntunedExtensionEnabled() {
+  return !!getIntunedExtensionPath();
+}
+async function getIntunedExtensionWorker(context) {
+  if (!isIntunedExtensionEnabled()) {
+    return null;
+  }
+  let attemptCount = 0;
+  while (attemptCount < 4) {
+    const intunedServiceWorker = context.serviceWorkers().find(serviceWorker => serviceWorker.url().includes(INTUNED_WORKER));
+    if (intunedServiceWorker) {
+      return intunedServiceWorker;
+    }
+    try {
+      await context.waitForEvent("serviceworker", {
+        timeout: 3000
+      });
+    } catch (err) {
+      console.log(`Error accessing service workers (attempt ${attemptCount})`);
+    }
+    attemptCount++;
+  }
+  console.error("Failed to get intuned worker after 5 attmepts");
+  return null;
+}
+async function getIntunedExtensionSettings() {
+  const settings = await (0, _settings.getSettings)();
+  const captchaSolverSettings = settings.captchaSolver ?? _settingsSchema.captchaSolverSettingsSchema.parse({});
+  const [domain, workspaceId, projectId] = [process.env.FUNCTIONS_DOMAIN, process.env[_constants.WORKSPACE_ID_ENV_VAR_KEY], process.env.INTUNED_INTEGRATION_ID ?? process.env[_constants.PROJECT_ID_ENV_VAR_KEY]];
+  if (!domain || !workspaceId || !projectId) {
+    const missingEnvVars = [domain && "FUNCTIONS_DOMAIN", workspaceId && _constants.WORKSPACE_ID_ENV_VAR_KEY, projectId && `INTUNED_INTEGRATION_ID OR ${_constants.PROJECT_ID_ENV_VAR_KEY}`];
+    throw new Error(`Missing required environment variables: ${missingEnvVars}`);
+  }
+  return {
+    ...captchaSolverSettings,
+    baseUrl: domain,
+    token: _jwtTokenManager.backendFunctionsTokenManager.token,
+    workspaceId,
+    projectId
+  };
+}
+async function setupIntunedExtension() {
+  if (!isIntunedExtensionEnabled()) {
+    return;
+  }
+  const intunedExtensionPath = getIntunedExtensionPath();
+  const intunedExtensionSettingsPath = _path.default.join(intunedExtensionPath, INTUNED_EXTENSION_SETTINGS_FILE_NAME);
+  const settings = await getIntunedExtensionSettings();
+  await (0, _promises.writeFile)(intunedExtensionSettingsPath, JSON.stringify(settings));
+}

package/dist/common/launchBrowser.d.ts

@@ -0,0 +1,25 @@
+import * as playwright from "playwright";
+export interface Proxy {
+    server: string;
+    username: string;
+    password: string;
+}
+export type LaunchBrowserResult = {
+    page: playwright.Page;
+    context: playwright.BrowserContext;
+};
+export type LaunchChromiumStandaloneOptions = {
+    proxy?: Proxy;
+    headless: boolean;
+    downloadsPath?: string;
+    cdpPort?: number;
+    appModeInitialUrl?: string;
+    executablePath?: string;
+};
+export type LaunchChromiumCdpOptions = {
+    cdpAddress: string;
+};
+export declare function launchChromium(options: LaunchChromiumStandaloneOptions): Promise<LaunchBrowserResult>;
+export declare function launchChromium(options: LaunchChromiumCdpOptions): Promise<LaunchBrowserResult>;
+export declare function launchBrowser(options: Omit<LaunchChromiumStandaloneOptions, "executablePath"> | LaunchChromiumCdpOptions): Promise<LaunchBrowserResult>;
+export declare function getLocalCdpAddress(port: number): string;

package/dist/common/launchBrowser.js

@@ -0,0 +1,172 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getLocalCdpAddress = getLocalCdpAddress;
+exports.launchBrowser = launchBrowser;
+exports.launchChromium = launchChromium;
+var playwright = _interopRequireWildcard(require("playwright"));
+var _fsExtra = _interopRequireWildcard(require("fs-extra"));
+var fs = _fsExtra;
+var _path = require("path");
+var _waitOn = _interopRequireDefault(require("wait-on"));
+var _child_process = require("child_process");
+var _extensionsHelpers = require("./extensionsHelpers");
+var _util = require("util");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+const execAsync = (0, _util.promisify)(_child_process.exec);
+async function createUserDirWithPreferences() {
+  const playwrightTempDir = await (0, _fsExtra.mkdtemp)("/tmp/pw-");
+  const userDir = (0, _path.join)(playwrightTempDir, "userdir");
+  const defaultDir = (0, _path.join)(userDir, "Default");
+  await (0, _fsExtra.mkdir)(defaultDir, {
+    recursive: true
+  });
+  const preferences = {
+    plugins: {
+      always_open_pdf_externally: true
+    }
+  };
+  await (0, _fsExtra.writeFile)((0, _path.join)(defaultDir, "Preferences"), JSON.stringify(preferences));
+  return userDir;
+}
+async function launchChromium(options) {
+  if ("cdpAddress" in options) {
+    const browser = await playwright.chromium.connectOverCDP(options.cdpAddress);
+    if (browser.contexts().length === 0) {
+      throw new Error("No browser contexts found in the connected browser");
+    }
+    const context = browser.contexts()[0];
+    let page = context.pages().at(0);
+    if (!page) {
+      page = await context.newPage();
+    }
+    return {
+      page,
+      context
+    };
+  }
+  const {
+    headless,
+    appModeInitialUrl,
+    cdpPort,
+    proxy,
+    downloadsPath
+  } = options;
+  let {
+    executablePath
+  } = options;
+  const defaultArgsToIgnore = ["--disable-extensions", "--disable-component-extensions-with-background-pages", "--disable-background-networking", "--disable-backgrounding-occluded-windows", "--disable-background-timer-throttling"];
+  const extraArgs = [];
+  const userDataDir = await createUserDirWithPreferences();
+  if ((0, _extensionsHelpers.isIntunedExtensionEnabled)()) {
+    const extensionsList = (0, _extensionsHelpers.buildExtensionsList)();
+    const extensions = extensionsList.join(",");
+    extraArgs.push(`--disable-extensions-except=${extensions}`);
+    extraArgs.push(`--load-extension=${extensions}`);
+    await (0, _extensionsHelpers.setupIntunedExtension)();
+  }
+  if (cdpPort) {
+    extraArgs.push(`--remote-debugging-port=${cdpPort}`);
+  }
+  if (headless) {
+    defaultArgsToIgnore.push("--headless=old");
+    extraArgs.push("--headless=new");
+  }
+  if (appModeInitialUrl) {
+    extraArgs.push(`--app=${appModeInitialUrl}`);
+  }
+  if (executablePath) {
+    executablePath = await fs.realpath(executablePath);
+    if (!(await fs.exists(executablePath))) {
+      console.log(`Warning: Executable path ${executablePath} does not exist. Falling back to default.`);
+      executablePath = undefined;
+    }
+  }
+  const context = await playwright.chromium.launchPersistentContext(userDataDir, {
+    executablePath,
+    headless,
+    viewport: null,
+    proxy,
+    downloadsPath,
+    args: extraArgs,
+    ignoreDefaultArgs: defaultArgsToIgnore
+  });
+  context.once("close", async () => {
+    try {
+      await (0, _fsExtra.rm)(userDataDir, {
+        recursive: true,
+        force: true,
+        retryDelay: 1000,
+        maxRetries: 5
+      });
+    } catch (error) {
+      console.error("Failed to remove user data dir", error);
+    }
+  });
+  if (cdpPort) {
+    const createdCdpAddress = getLocalCdpAddress(cdpPort);
+    await waitOnCdpAddress(createdCdpAddress);
+  }
+  const page = context.pages().at(0) ?? (await context.newPage());
+  if ((0, _extensionsHelpers.isIntunedExtensionEnabled)()) {
+    await (0, _extensionsHelpers.getIntunedExtensionWorker)(context);
+  }
+  return {
+    page,
+    context
+  };
+}
+async function launchBrowser(options) {
+  if ("cdpAddress" in options) {
+    return launchChromium(options);
+  }
+  const browserType = getBrowserType();
+  switch (browserType) {
+    case "chromium":
+      {
+        return launchChromium(options);
+      }
+    case "brave":
+      {
+        const braveExecutablePath = await getBraveExecutablePath();
+        return launchChromium({
+          ...options,
+          executablePath: braveExecutablePath
+        });
+      }
+  }
+}
+function getBrowserType() {
+  if (process.env.BROWSER_TYPE === "brave") {
+    return "brave";
+  }
+  return "chromium";
+}
+async function getBraveExecutablePath() {
+  const {
+    stdout
+  } = await execAsync("which brave-browser-stable");
+  const bravePath = stdout.trim();
+  if (bravePath.length === 0) {
+    throw new Error("Brave browser not found");
+  }
+  return bravePath;
+}
+function getLocalCdpAddress(port) {
+  return `http://localhost:${port}`;
+}
+async function waitOnCdpAddress(cdpAddress) {
+  const cdpAddressWithoutProtocol = cdpAddress.replace("http://", "").replace("https://", "").replace("localhost", "127.0.0.1");
+  await (0, _waitOn.default)({
+    resources: [`http-get://${cdpAddressWithoutProtocol}/json/version`],
+    delay: 100,
+    interval: 100,
+    timeout: 5000,
+    tcpTimeout: 1000,
+    window: 1000
+  });
+}

package/dist/common/playwrightContext.d.ts

@@ -3,26 +3,7 @@ import { RunAutomationError } from "./runApi/errors";
 import type { RunApiSession } from "./runApi/types";
 import { Err, Ok } from "neverthrow";
 import { type ImportFunction } from "./runApi/importUsingImportFunction";
-export interface Proxy {
-    server: string;
-    username: string;
-    password: string;
-}
-export declare function launchChromium(options: {
-    proxy?: Proxy;
-    headless: boolean;
-    downloadsPath?: string;
-    cdpPort?: number;
-}): Promise<{
-    page: playwright.Page;
-    context: playwright.BrowserContext;
-}>;
-export declare function launchChromium(options: {
-    cdpAddress: string;
-}): Promise<{
-    page: playwright.Page;
-    context: playwright.BrowserContext;
-}>;
+import { type Proxy } from "./launchBrowser";
 export declare const browserScriptsFile: string;
 type WithPlaywrightContextParameters = {
     importFunction: ImportFunction;
@@ -47,8 +28,4 @@ export declare function loadSessionToContext({ context, session, }: {
     context: playwright.BrowserContext;
     session: RunApiSession;
 }): Promise<void>;
-export declare function getRemotePlaywrightContext(cdpAddress: string): Promise<{
-    browser: playwright.Browser;
-    context: playwright.BrowserContext;
-}>;
 export {};

package/dist/common/playwrightContext.js

@@ -4,95 +4,20 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.browserScriptsFile = void 0;
-exports.getRemotePlaywrightContext = getRemotePlaywrightContext;
-exports.launchChromium = launchChromium;
 exports.loadSessionToContext = loadSessionToContext;
 exports.withPlaywrightContext = withPlaywrightContext;
-var playwright = _interopRequireWildcard(require("playwright"));
-var _fsExtra = _interopRequireWildcard(require("fs-extra"));
-var fs = _fsExtra;
 var _contextStorageStateHelpers = require("./contextStorageStateHelpers");
-var _path = _interopRequireWildcard(require("path"));
+var _path = _interopRequireDefault(require("path"));
+var fs = _interopRequireWildcard(require("fs-extra"));
 var _fileUtils = require("../commands/common/utils/fileUtils");
-var _waitOn = _interopRequireDefault(require("wait-on"));
 var _errors = require("./runApi/errors");
 var _neverthrow = require("neverthrow");
 var _setupContextHook = require("./setupContextHook");
 var _portfinder = require("portfinder");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+var _launchBrowser = require("./launchBrowser");
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
-async function createUserDirWithPreferences() {
-  const playwrightTempDir = await (0, _fsExtra.mkdtemp)("/tmp/pw-");
-  const userDir = (0, _path.join)(playwrightTempDir, "userdir");
-  const defaultDir = (0, _path.join)(userDir, "Default");
-  await (0, _fsExtra.mkdir)(defaultDir, {
-    recursive: true
-  });
-  const preferences = {
-    plugins: {
-      always_open_pdf_externally: true
-    }
-  };
-  await (0, _fsExtra.writeFile)((0, _path.join)(defaultDir, "Preferences"), JSON.stringify(preferences));
-  return userDir;
-}
-async function launchChromium({
-  proxy,
-  headless = true,
-  downloadsPath,
-  cdpAddress,
-  cdpPort
-}) {
-  if (cdpAddress) {
-    const browser = await playwright.chromium.connectOverCDP(cdpAddress);
-    if (browser.contexts().length === 0) {
-      throw new Error("No browser contexts found in the connected browser");
-    }
-    const context = browser.contexts()[0];
-    let page = context.pages().at(0);
-    if (!page) {
-      page = await context.newPage();
-    }
-    return {
-      page,
-      context
-    };
-  }
-  const extraArgs = [];
-  const userDataDir = await createUserDirWithPreferences();
-  if (cdpPort) {
-    extraArgs.push(`--remote-debugging-port=${cdpPort}`);
-  }
-  const context = await playwright.chromium.launchPersistentContext(userDataDir, {
-    headless,
-    viewport: null,
-    proxy,
-    downloadsPath,
-    args: extraArgs
-  });
-  context.once("close", async () => {
-    try {
-      await (0, _fsExtra.rm)(userDataDir, {
-        recursive: true,
-        force: true,
-        retryDelay: 1000,
-        maxRetries: 5
-      });
-    } catch (error) {
-      console.error("Failed to remove user data dir", error);
-    }
-  });
-  if (cdpPort) {
-    const createdCdpAddress = getLocalCdpAddress(cdpPort);
-    await waitOnCdpAddress(createdCdpAddress);
-  }
-  const page = context.pages().at(0) ?? (await context.newPage());
-  return {
-    page,
-    context
-  };
-}
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const browserScriptsFile = exports.browserScriptsFile = _path.default.join(__dirname, "./assets/browser_scripts.js");
 async function withPlaywrightContext({
   cdpAddress,
@@ -118,14 +43,14 @@ async function withPlaywrightContext({
         ({
           page,
           context
-        } = await launchChromium({
+        } = await (0, _launchBrowser.launchBrowser)({
           cdpAddress
         }));
       } else {
         ({
           page,
           context
-        } = await launchChromium({
+        } = await (0, _launchBrowser.launchBrowser)({
           proxy,
           headless,
           downloadsPath
@@ -139,18 +64,18 @@ async function withPlaywrightContext({
       ({
         context,
         page
-      } = await launchChromium({
+      } = await (0, _launchBrowser.launchBrowser)({
         cdpAddress
       }));
     } else {
       const port = await (0, _portfinder.getPort)({
         port: 9222
       });
-      hookCdpUrl = getLocalCdpAddress(port);
+      hookCdpUrl = (0, _launchBrowser.getLocalCdpAddress)(port);
       ({
         context,
         page
-      } = await launchChromium({
+      } = await (0, _launchBrowser.launchBrowser)({
         proxy,
         headless,
         downloadsPath,
@@ -216,42 +141,4 @@ async function loadSessionToContext({
     sessionToLoad = await fs.readJson(fullPath);
   }
   await (0, _contextStorageStateHelpers.setStorageState)(context, sessionToLoad);
-}
-function getLocalCdpAddress(port) {
-  return `http://localhost:${port}`;
-}
-async function waitOnCdpAddress(cdpAddress) {
-  const cdpAddressWithoutProtocol = cdpAddress.replace("http://", "").replace("https://", "").replace("localhost", "127.0.0.1");
-  await (0, _waitOn.default)({
-    resources: [`http-get://${cdpAddressWithoutProtocol}/json/version`],
-    delay: 100,
-    interval: 100,
-    timeout: 5000,
-    tcpTimeout: 1000,
-    window: 1000
-  });
-}
-async function getRemotePlaywrightContext(cdpAddress) {
-  const playwright = await Promise.resolve().then(() => _interopRequireWildcard(require("playwright")));
-  let browser = null;
-  if (!cdpAddress) {
-    throw new Error("cdpAddress is required");
-  }
-  try {
-    await waitOnCdpAddress(cdpAddress);
-  } catch (error) {
-    console.error("Failed to connect to the browser");
-    process.exit(128 + 9);
-  }
-  try {
-    browser = await playwright.chromium.connectOverCDP(cdpAddress);
-  } catch (e) {
-    console.log(e);
-    throw new Error("failed to connect to the browser");
-  }
-  const context = browser.contexts()[0];
-  return {
-    browser,
-    context
-  };
 }

package/dist/common/runApi/types.d.ts

@@ -673,22 +673,19 @@ export declare const runApiParametersSchema: z.ZodObject<{
         } | undefined;
     }, {
         environment: "standalone";
+        headless?: boolean | undefined;
         proxy?: {
             server: string;
             username: string;
             password: string;
         } | undefined;
-        headless?: boolean | undefined;
     }>, z.ZodObject<{
         environment: z.ZodLiteral<"cdp">;
         cdpAddress: z.ZodString;
-        mode: z.ZodUnion<[z.ZodLiteral<"vanilla">, z.ZodLiteral<"playwright">, z.ZodLiteral<"playwright-standalone">, z.ZodLiteral<"playwright-headless">]>;
     }, "strip", z.ZodTypeAny, {
-        mode: "vanilla" | "playwright" | "playwright-standalone" | "playwright-headless";
         environment: "cdp";
         cdpAddress: string;
     }, {
-        mode: "vanilla" | "playwright" | "playwright-standalone" | "playwright-headless";
         environment: "cdp";
         cdpAddress: string;
     }>]>>;
@@ -713,7 +710,6 @@ export declare const runApiParametersSchema: z.ZodObject<{
             password: string;
         } | undefined;
     } | {
-        mode: "vanilla" | "playwright" | "playwright-standalone" | "playwright-headless";
         environment: "cdp";
         cdpAddress: string;
     };
@@ -799,14 +795,13 @@ export declare const runApiParametersSchema: z.ZodObject<{
     } | undefined;
     runOptions?: {
         environment: "standalone";
+        headless?: boolean | undefined;
         proxy?: {
             server: string;
             username: string;
             password: string;
         } | undefined;
-        headless?: boolean | undefined;
     } | {
-        mode: "vanilla" | "playwright" | "playwright-standalone" | "playwright-headless";
         environment: "cdp";
         cdpAddress: string;
     } | undefined;

package/dist/common/runApi/types.js

@@ -65,8 +65,7 @@ const runApiParametersSchema = exports.runApiParametersSchema = _zod.default.obj
     }).optional()
   }), _zod.default.object({
     environment: _zod.default.literal("cdp"),
-    cdpAddress: _zod.default.string(),
-    mode: _zod.default.union([_zod.default.literal("vanilla"), _zod.default.literal("playwright"), _zod.default.literal("playwright-standalone"), _zod.default.literal("playwright-headless")])
+    cdpAddress: _zod.default.string()
   })]).default({
     environment: "standalone"
   }),