@intuned/runtime-dev 1.2.1-hooks.9 → 1.2.1-results.0

package/dist/common/{playwrightContext.js → getPlaywrightConstructs.js}

@@ -3,11 +3,10 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.browserScriptsFile = void 0;
+exports.getPlaywrightConstructsForMode = getPlaywrightConstructsForMode;
+exports.getProductionPlaywrightConstructs = getProductionPlaywrightConstructs;
 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;
@@ -15,10 +14,7 @@ var _contextStorageStateHelpers = require("./contextStorageStateHelpers");
 var _path = _interopRequireWildcard(require("path"));
 var _fileUtils = require("../commands/common/utils/fileUtils");
 var _waitOn = _interopRequireDefault(require("wait-on"));
-var _errors = require("./runApi/errors");
-var _neverthrow = require("neverthrow");
-var _initializeContextHook = require("./initializeContextHook");
-var _getPortPlease = require("get-port-please");
+var _runtime = require("../runtime");
 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; }
@@ -37,44 +33,23 @@ async function createUserDirWithPreferences() {
   await (0, _fsExtra.writeFile)((0, _path.join)(defaultDir, "Preferences"), JSON.stringify(preferences));
   return userDir;
 }
-async function launchChromium({
+async function getProductionPlaywrightConstructs({
   proxy,
   headless = true,
-  downloadsPath,
-  cdpAddress,
-  cdpPort
+  storageState,
+  downloadsPath
 }) {
-  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 = ["--no-first-run", "--disable-sync", "--disable-translate", "--disable-features=TranslateUI", "--disable-features=NetworkService", "--lang=en"];
+  if (headless) {
+    extraArgs.push("--headless=new");
   }
-  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
+    downloadsPath
   });
-  if (cdpPort) {
-    const createdCdpAddress = getCdpAddress(cdpPort);
-    await waitOnCdpAddress(createdCdpAddress);
-  }
   context.once("close", async () => {
     try {
       await (0, _fsExtra.rm)(userDataDir, {
@@ -87,101 +62,80 @@ async function launchChromium({
       console.error("Failed to remove user data dir", error);
     }
   });
-  const page = context.pages().at(0) ?? (await context.newPage());
+  if (storageState) {
+    await loadSessionToContext({
+      context,
+      session: storageState
+    });
+  }
+  const assetsFile = _path.default.join(__dirname, "./assets/browser_scripts.js");
+  await context.addInitScript({
+    path: assetsFile
+  });
+  let page = context.pages().at(0);
+  if (page) {
+    const scriptString = await (0, _fsExtra.readFile)(assetsFile, "utf8");
+    await page.evaluate(scriptString);
+  } else {
+    page = await context.newPage();
+  }
   return {
     page,
     context
   };
 }
-const browserScriptsFile = exports.browserScriptsFile = _path.default.join(__dirname, "./assets/browser_scripts.js");
-async function withPlaywrightContext({
-  cdpAddress,
-  proxy,
-  headless = true,
-  downloadsPath,
-  importFunction,
-  apiName,
-  apiParameters
-}, fn) {
-  let context;
-  let page;
-  try {
-    const initializeContextHookResult = await (0, _initializeContextHook.loadInitializeContextHook)({
-      importFunction
-    });
-    if (initializeContextHookResult.isErr()) {
-      return initializeContextHookResult;
+async function getPlaywrightConstructsForMode(mode, cdpAddress, authSession) {
+  if (mode == "playwright-standalone") {
+    if (!cdpAddress) {
+      throw new Error("cdpAddress is required");
     }
-    const initializeContextHook = initializeContextHookResult.value;
-    if (initializeContextHook === null) {
-      if (cdpAddress !== undefined) {
-        ({
-          page,
-          context
-        } = await launchChromium({
-          cdpAddress
-        }));
-      } else {
-        ({
-          page,
-          context
-        } = await launchChromium({
-          proxy,
-          headless,
-          downloadsPath
-        }));
-      }
-      return await fn(context, page);
+    const {
+      context
+    } = await getRemotePlaywrightContext(cdpAddress);
+    if (!context) {
+      throw new Error("no context found");
     }
-    let hookCdpUrl = null;
-    if (cdpAddress) {
-      hookCdpUrl = cdpAddress;
-      ({
-        context,
-        page
-      } = await launchChromium({
-        cdpAddress
-      }));
+    const assetsFile = _path.default.join(__dirname, "./assets/browser_scripts.js");
+    await context.addInitScript({
+      path: assetsFile
+    });
+    const pages = await context.pages();
+    let page = null;
+    if (pages.length > 0) {
+      page = pages[0];
+      const scriptString = await fs.readFile(assetsFile, "utf8");
+      await page.evaluate(scriptString);
     } else {
-      const port = await (0, _getPortPlease.getPort)({
-        port: 9222
-      });
-      hookCdpUrl = getCdpAddress(port);
-      ({
-        context,
-        page
-      } = await launchChromium({
-        proxy,
-        headless,
-        downloadsPath,
-        cdpPort: port
-      }));
+      page = await context.newPage();
     }
-    let hookResult;
-    try {
-      hookResult = await initializeContextHook({
-        apiName,
-        apiParameters,
-        cdpUrl: hookCdpUrl
+    if (authSession) {
+      await loadSessionToContext({
+        context,
+        session: authSession
       });
-    } catch (error) {
-      return (0, _neverthrow.err)(new _errors.AutomationError(error));
-    }
-    if (!hookResult) {
-      return await fn(context, page);
     }
-    const {
-      page: newPage,
-      context: newContext
-    } = hookResult;
-    try {
-      return await fn(newContext, newPage ?? page);
-    } finally {
-      await newContext.close();
+    return {
+      page,
+      context
+    };
+  }
+  const downloadsPath = (0, _runtime.getDownloadDirectoryPath)();
+  if (mode === "playwright" || mode === "playwright-headless") {
+    const productionConstructs = await getProductionPlaywrightConstructs({
+      headless: mode === "playwright-headless",
+      downloadsPath
+    });
+    if (authSession) {
+      await loadSessionToContext({
+        context: productionConstructs.context,
+        session: authSession
+      });
     }
-  } finally {
-    await context?.close();
+    return {
+      ...productionConstructs
+    };
   }
+  throw "invalid mode";
 }
 async function loadSessionToContext({
   context,
@@ -200,28 +154,22 @@ async function loadSessionToContext({
   }
   await (0, _contextStorageStateHelpers.setStorageState)(context, sessionToLoad);
 }
-function getCdpAddress(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");
   }
+  const cdpAddressWithoutProtocol = cdpAddress.replace("http://", "").replace("https://", "").replace("localhost", "127.0.0.1");
   try {
-    await waitOnCdpAddress(cdpAddress);
+    await (0, _waitOn.default)({
+      resources: [`http-get://${cdpAddressWithoutProtocol}/json/version`],
+      delay: 100,
+      interval: 100,
+      timeout: 5000,
+      tcpTimeout: 1000,
+      window: 1000
+    });
   } catch (error) {
     console.error("Failed to connect to the browser");
     process.exit(128 + 9);

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

@@ -9,7 +9,8 @@ export declare const authCheckFailedErrorCode = "AuthCheckFailedError";
 export declare const maxLevelsExceededErrorCode = "MaxLevelsExceededError";
 export declare const automationError = "AutomationError";
 export declare const internalInvalidInputErrorCode = "InternalInvalidInputError";
-export declare const runAutomationErrorCodes: readonly ["APINotFoundError", "InvalidAPIError", "InvalidCheckError", "AbortedError", "AuthRequiredError", "AuthCheckNotFoundError", "AuthCheckFailedError", "MaxLevelsExceededError", "AutomationError", "InternalInvalidInputError"];
+export declare const resultTooBigErrorCode = "ResultTooBigError";
+export declare const runAutomationErrorCodes: readonly ["APINotFoundError", "InvalidAPIError", "InvalidCheckError", "AbortedError", "AuthRequiredError", "AuthCheckNotFoundError", "AuthCheckFailedError", "MaxLevelsExceededError", "AutomationError", "InternalInvalidInputError", "ResultTooBigError"];
 export type RunAutomationErrorCode = typeof runAutomationErrorCodes[number];
 export declare abstract class RunAutomationError<T = any> {
     code: RunAutomationErrorCode;
@@ -19,7 +20,7 @@ export declare abstract class RunAutomationError<T = any> {
     cause?: RunAutomationError;
     details?: T;
     get json(): {
-        code: "APINotFoundError" | "InvalidAPIError" | "InvalidCheckError" | "AbortedError" | "AuthRequiredError" | "AuthCheckNotFoundError" | "AuthCheckFailedError" | "MaxLevelsExceededError" | "AutomationError" | "InternalInvalidInputError";
+        code: "APINotFoundError" | "InvalidAPIError" | "InvalidCheckError" | "AbortedError" | "AuthRequiredError" | "AuthCheckNotFoundError" | "AuthCheckFailedError" | "MaxLevelsExceededError" | "AutomationError" | "InternalInvalidInputError" | "ResultTooBigError";
         details: T | undefined;
         cause: any;
     };
@@ -63,3 +64,9 @@ export declare class AutomationError extends RunAutomationError<{
 export declare class InternalInvalidInputError extends RunAutomationError {
     constructor(message: string, details?: any);
 }
+export declare class ResultTooBigError extends RunAutomationError<{
+    sizeInBytes: number;
+    maxSizeInBytes: number;
+}> {
+    constructor(sizeInBytes: number, maxSizeInBytes: number);
+}

package/dist/common/runApi/errors.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.runAutomationErrorCodes = exports.maxLevelsExceededErrorCode = exports.invalidCheckErrorCode = exports.invalidApiErrorCode = exports.internalInvalidInputErrorCode = exports.automationError = exports.authRequiredErrorCode = exports.authCheckNotFoundErrorCode = exports.authCheckFailedErrorCode = exports.apiNotFoundErrorCode = exports.abortedErrorCode = exports.RunAutomationError = exports.MaxLevelsExceededError = exports.InvalidCheckError = exports.InvalidApiError = exports.InternalInvalidInputError = exports.AutomationError = exports.AuthRequiredError = exports.AuthCheckNotFoundError = exports.AuthCheckFailedError = exports.ApiNotFoundError = exports.AbortedError = void 0;
+exports.runAutomationErrorCodes = exports.resultTooBigErrorCode = exports.maxLevelsExceededErrorCode = exports.invalidCheckErrorCode = exports.invalidApiErrorCode = exports.internalInvalidInputErrorCode = exports.automationError = exports.authRequiredErrorCode = exports.authCheckNotFoundErrorCode = exports.authCheckFailedErrorCode = exports.apiNotFoundErrorCode = exports.abortedErrorCode = exports.RunAutomationError = exports.ResultTooBigError = exports.MaxLevelsExceededError = exports.InvalidCheckError = exports.InvalidApiError = exports.InternalInvalidInputError = exports.AutomationError = exports.AuthRequiredError = exports.AuthCheckNotFoundError = exports.AuthCheckFailedError = exports.ApiNotFoundError = exports.AbortedError = void 0;
 var _runtime = require("../../runtime");
 var playwright = _interopRequireWildcard(require("playwright-core"));
 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); }
@@ -18,7 +18,8 @@ const authCheckFailedErrorCode = exports.authCheckFailedErrorCode = "AuthCheckFa
 const maxLevelsExceededErrorCode = exports.maxLevelsExceededErrorCode = "MaxLevelsExceededError";
 const automationError = exports.automationError = "AutomationError";
 const internalInvalidInputErrorCode = exports.internalInvalidInputErrorCode = "InternalInvalidInputError";
-const runAutomationErrorCodes = exports.runAutomationErrorCodes = [apiNotFoundErrorCode, invalidApiErrorCode, invalidCheckErrorCode, abortedErrorCode, authRequiredErrorCode, authCheckNotFoundErrorCode, authCheckFailedErrorCode, maxLevelsExceededErrorCode, automationError, internalInvalidInputErrorCode];
+const resultTooBigErrorCode = exports.resultTooBigErrorCode = "ResultTooBigError";
+const runAutomationErrorCodes = exports.runAutomationErrorCodes = [apiNotFoundErrorCode, invalidApiErrorCode, invalidCheckErrorCode, abortedErrorCode, authRequiredErrorCode, authCheckNotFoundErrorCode, authCheckFailedErrorCode, maxLevelsExceededErrorCode, automationError, internalInvalidInputErrorCode, resultTooBigErrorCode];
 class RunAutomationError {
   wrapped = false;
   get json() {
@@ -152,4 +153,17 @@ class InternalInvalidInputError extends RunAutomationError {
     this.details = details;
   }
 }
-exports.InternalInvalidInputError = InternalInvalidInputError;
+exports.InternalInvalidInputError = InternalInvalidInputError;
+class ResultTooBigError extends RunAutomationError {
+  constructor(sizeInBytes, maxSizeInBytes) {
+    super();
+    this.code = resultTooBigErrorCode;
+    this.statusCode = 413;
+    this.message = `Automation result is too big. Size: ${Math.round(sizeInBytes / 1024 / 1024 * 100) / 100}MB, Max allowed: ${Math.round(maxSizeInBytes / 1024 / 1024 * 100) / 100}MB`;
+    this.details = {
+      sizeInBytes,
+      maxSizeInBytes
+    };
+  }
+}
+exports.ResultTooBigError = ResultTooBigError;

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

@@ -4,8 +4,13 @@ import { Page, BrowserContext } from "playwright";
 import { ExtendedRunApiParameters, RunApiResult, RunApiResultWithSessionOk } from "./types";
 export * from "./types";
 export * from "./errors";
-export declare function runApi<ResultType = any>(input: ExtendedRunApiParameters & {
+export declare function runApiGenerator<ResultType = any, _YieldType = any, _NextType = any>(params: ExtendedRunApiParameters & {
+    retrieveSession: true;
+}): AsyncGenerator<_YieldType, RunApiResult<ResultType, RunApiResultWithSessionOk>, _NextType>;
+export declare function runApiGenerator<ResultType = any, _YieldType = any, _NextType = any>(params: ExtendedRunApiParameters): AsyncGenerator<_YieldType, RunApiResult<ResultType>, _NextType>;
+export declare function runApi<ResultType = any>(params: ExtendedRunApiParameters & {
     retrieveSession: true;
 }): Promise<RunApiResult<ResultType, RunApiResultWithSessionOk>>;
-export declare function runApi<ResultType = any>(input: ExtendedRunApiParameters): Promise<RunApiResult<ResultType>>;
+export declare function runApi<ResultType = any>(params: ExtendedRunApiParameters): Promise<RunApiResult<ResultType>>;
 export declare function checkAuthSessionWithRetries(page: Page, context: BrowserContext, checkFn: (..._: any) => Promise<boolean>, retries?: number): Promise<Result<boolean, RunAutomationError>>;
+export type ImportFunction = ExtendedRunApiParameters["importFunction"];