@intuned/runtime-dev 1.2.0-dev-peer → 1.2.1-hooks.0

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

@@ -5,12 +5,12 @@ export declare const asyncLocalStorage: AsyncLocalStorage<InternalRunInfo>;
 export declare function runWithContext<R, TArgs extends any[]>(contextData: InternalRunInfo, callback: (...args: TArgs) => R, ...args: TArgs): R;
 interface TimeoutInfo {
     extendTimeoutCallback?: () => Promise<void>;
-    timeoutDuration?: number;
-    timeoutTimestamp?: number;
 }
 export interface InternalRunInfo extends RunInfo {
     extendedPayloads: Payload[];
+    cdpAddress?: string;
     timeoutInfo?: TimeoutInfo;
+    getAuthSessionParameters?: () => Promise<any>;
 }
 export declare function getExecutionContext(): InternalRunInfo | undefined;
 export {};

package/dist/common/backendFunctions/getAuthSessionParameters.d.ts

@@ -0,0 +1 @@
+export declare function getAuthSessionParameters(): Promise<any>;

package/dist/common/backendFunctions/getAuthSessionParameters.js

@@ -0,0 +1,38 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getAuthSessionParameters = getAuthSessionParameters;
+var _isNil = _interopRequireDefault(require("lodash/isNil"));
+var _asyncLocalStorage = require("../asyncLocalStorage");
+var _zod = require("zod");
+var _jwtTokenManager = require("../jwtTokenManager");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+const authSessionParametersResponseSchema = _zod.z.object({
+  parameters: _zod.z.any().refine(v => v !== undefined)
+});
+async function getAuthSessionParameters() {
+  const context = (0, _asyncLocalStorage.getExecutionContext)();
+  if (!context) {
+    throw new Error("getAuthSessionParameters failed due to an internal error (context was not found).");
+  }
+  const authSessionId = context.authSessionId;
+  if ((0, _isNil.default)(authSessionId)) {
+    throw new Error("Auth sessions are not enabled");
+  }
+  const response = await (0, _jwtTokenManager.callBackendFunctionWithToken)(`auth-session/${authSessionId}/parameters`, {
+    method: "GET"
+  });
+  const body = await response.text();
+  if (!response.ok) {
+    throw new Error(`getAuthSessionParameters failed with status ${response.status}: ${body}`);
+  }
+  let json;
+  try {
+    json = JSON.parse(body);
+  } catch (e) {
+    throw new Error(`Expected JSON response, but got ${body}`);
+  }
+  return authSessionParametersResponseSchema.parse(json).parameters;
+}

package/dist/common/constants.d.ts

@@ -1,2 +1,3 @@
+export declare const API_FOLDER_NAME = "api";
 export declare const AUTH_SESSIONS_FOLDER_NAME = "auth-sessions";
 export declare const AUTH_SESSIONS_INSTANCES_FOLDER_NAME = "auth-sessions-instances";

package/dist/common/constants.js

@@ -3,6 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.AUTH_SESSIONS_INSTANCES_FOLDER_NAME = exports.AUTH_SESSIONS_FOLDER_NAME = void 0;
+exports.AUTH_SESSIONS_INSTANCES_FOLDER_NAME = exports.AUTH_SESSIONS_FOLDER_NAME = exports.API_FOLDER_NAME = void 0;
+const API_FOLDER_NAME = exports.API_FOLDER_NAME = "api";
 const AUTH_SESSIONS_FOLDER_NAME = exports.AUTH_SESSIONS_FOLDER_NAME = "auth-sessions";
 const AUTH_SESSIONS_INSTANCES_FOLDER_NAME = exports.AUTH_SESSIONS_INSTANCES_FOLDER_NAME = "auth-sessions-instances";

package/dist/common/getPlaywrightConstructs.d.ts

@@ -1,6 +1,6 @@
-import * as playwright from "playwright-core";
-import type { RunApiSession } from "./runApi";
-interface Proxy {
+import * as playwright from "playwright";
+import type { ImportFunction, RunApiSession } from "./runApi";
+export interface Proxy {
     server: string;
     username: string;
     password: string;
@@ -10,12 +10,13 @@ interface GetPlaywrightConstructsOptions {
     headless?: boolean;
     storageState?: RunApiSession;
     downloadsPath: string;
+    importFunction?: ImportFunction;
 }
-export declare function getProductionPlaywrightConstructs({ proxy, headless, storageState, downloadsPath, }: GetPlaywrightConstructsOptions): Promise<{
+export declare function getProductionPlaywrightConstructs({ proxy, headless, storageState, downloadsPath, importFunction, }: GetPlaywrightConstructsOptions): Promise<{
     page: playwright.Page;
     context: playwright.BrowserContext;
 }>;
-export declare function getPlaywrightConstructsForMode(mode: "vanilla" | "playwright" | "playwright-standalone" | "playwright-headless", cdpAddress: string | undefined, authSession?: RunApiSession): Promise<{
+export declare function getPlaywrightConstructsForMode(mode: "vanilla" | "playwright" | "playwright-standalone" | "playwright-headless", cdpAddress: string | undefined, authSession?: RunApiSession, importFunction?: ImportFunction): Promise<{
     page: playwright.Page;
     context: playwright.BrowserContext;
 }>;

package/dist/common/getPlaywrightConstructs.js

@@ -7,7 +7,7 @@ exports.getPlaywrightConstructsForMode = getPlaywrightConstructsForMode;
 exports.getProductionPlaywrightConstructs = getProductionPlaywrightConstructs;
 exports.getRemotePlaywrightContext = getRemotePlaywrightContext;
 exports.loadSessionToContext = loadSessionToContext;
-var playwright = _interopRequireWildcard(require("playwright-core"));
+var playwright = _interopRequireWildcard(require("playwright"));
 var _fsExtra = _interopRequireWildcard(require("fs-extra"));
 var fs = _fsExtra;
 var _contextStorageStateHelpers = require("./contextStorageStateHelpers");
@@ -33,42 +33,60 @@ async function createUserDirWithPreferences() {
   await (0, _fsExtra.writeFile)((0, _path.join)(defaultDir, "Preferences"), JSON.stringify(preferences));
   return userDir;
 }
+async function loadGetDeployedPageAndContextHook(importFunction) {
+  const result = await importFunction("hooks/createDeployedContextAndPage");
+  if (result.isErr()) {
+    throw result.error;
+  }
+  return result.value.default;
+}
 async function getProductionPlaywrightConstructs({
   proxy,
   headless = true,
   storageState,
-  downloadsPath
+  downloadsPath,
+  importFunction
 }) {
-  const extraArgs = ["--no-first-run", "--disable-sync", "--disable-translate", "--disable-features=TranslateUI", "--disable-features=NetworkService", "--lang=en"];
-  if (headless) {
-    extraArgs.push("--headless=new");
+  let context;
+  let page;
+  let hook = null;
+  if (importFunction) {
+    hook = await loadGetDeployedPageAndContextHook(importFunction);
   }
-  const executablePath = playwright.chromium.executablePath();
-  const chromium127Path = executablePath.replace("chromium-1117", "chromium-1124");
-  const isChrome127There = await (0, _fsExtra.exists)(chromium127Path);
-  const userAgent = `Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/${isChrome127There ? 127 : 125}.0.0.0 Safari/537.36`;
-  const userDataDir = await createUserDirWithPreferences();
-  const context = await playwright.chromium.launchPersistentContext(userDataDir, {
-    headless,
-    ignoreDefaultArgs: [...getChromiumLaunchArgsToIgnore(), "--headless"],
-    proxy,
-    executablePath: isChrome127There ? chromium127Path : executablePath,
-    args: extraArgs,
-    downloadsPath,
-    userAgent
-  });
-  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 (hook) {
+    ({
+      page,
+      context
+    } = await hook({
+      proxy,
+      headless
+    }));
+  } else {
+    const extraArgs = ["--no-first-run", "--disable-sync", "--disable-translate", "--disable-features=TranslateUI", "--disable-features=NetworkService", "--lang=en"];
+    if (headless) {
+      extraArgs.push("--headless=new");
     }
-  });
+    const userDataDir = await createUserDirWithPreferences();
+    context = await playwright.chromium.launchPersistentContext(userDataDir, {
+      headless,
+      viewport: null,
+      proxy,
+      downloadsPath
+    });
+    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);
+      }
+    });
+    page = context.pages().at(0) ?? null;
+  }
   if (storageState) {
     await loadSessionToContext({
       context,
@@ -79,7 +97,6 @@ async function getProductionPlaywrightConstructs({
   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);
@@ -91,15 +108,34 @@ async function getProductionPlaywrightConstructs({
     context
   };
 }
-const getChromiumLaunchArgsToIgnore = () => ["--disable-field-trial-config", "--disable-background-networking", "--enable-features=NetworkService,NetworkServiceInProcess", "--disable-background-timer-throttling", "--disable-backgrounding-occluded-windows", "--disable-back-forward-cache", "--disable-breakpad", "--disable-client-side-phishing-detection", "--disable-component-extensions-with-background-pages", "--disable-component-update", "--no-default-browser-check", "--disable-default-apps", "--disable-dev-shm-usage", "--disable-extensions", "--disable-features=ImprovedCookieControls,LazyFrameLoading,GlobalMediaControls,DestroyProfileOnBrowserClose,MediaRouter,DialMediaRouteProvider,AcceptCHFrame,AutoExpandDetailsElement,CertificateTransparencyComponentUpdater,AvoidUnnecessaryBeforeUnloadCheckSync,Translate,TranslateUI", "--allow-pre-commit-input", "--disable-hang-monitor", "--disable-ipc-flooding-protection", "--disable-prompt-on-repost", "--disable-renderer-backgrounding", "--force-color-profile=srgb", "--metrics-recording-only", "--no-first-run", "--enable-automation", "--password-store=basic", "--use-mock-keychain", "--no-service-autorun", "--export-tagged-pdf", "--enable-use-zoom-for-dsf=false"];
-async function getPlaywrightConstructsForMode(mode, cdpAddress, authSession) {
+async function loadGetIDEPageAndContextHook(importFunction) {
+  const result = await importFunction("hooks/createDeployedContextAndPage");
+  if (result.isErr()) {
+    throw result.error;
+  }
+  return result.value.default;
+}
+async function getPlaywrightConstructsForMode(mode, cdpAddress, authSession, importFunction) {
+  let hook = null;
+  if (importFunction) {
+    hook = await loadGetIDEPageAndContextHook(importFunction);
+  }
   if (mode == "playwright-standalone") {
     if (!cdpAddress) {
       throw new Error("cdpAddress is required");
     }
-    const {
-      context
-    } = await getRemotePlaywrightContext(cdpAddress);
+    let context;
+    if (hook) {
+      ({
+        context
+      } = await hook({
+        cdpAddress
+      }));
+    } else {
+      ({
+        context
+      } = await getRemotePlaywrightContext(cdpAddress));
+    }
     if (!context) {
       throw new Error("no context found");
     }
@@ -163,7 +199,7 @@ async function loadSessionToContext({
   await (0, _contextStorageStateHelpers.setStorageState)(context, sessionToLoad);
 }
 async function getRemotePlaywrightContext(cdpAddress) {
-  const playwright = await Promise.resolve().then(() => _interopRequireWildcard(require("playwright-core")));
+  const playwright = await Promise.resolve().then(() => _interopRequireWildcard(require("playwright")));
   let browser = null;
   if (!cdpAddress) {
     throw new Error("cdpAddress is required");

package/dist/common/jwtTokenManager.js

@@ -36,8 +36,7 @@ class JwtTokenManager {
     return Math.max(timeToRefresh, timeWindow);
   }
   async scheduleTokenRefresh() {
-    var _process$env$RUN_ENVI;
-    if (((_process$env$RUN_ENVI = process.env.RUN_ENVIRONMENT) === null || _process$env$RUN_ENVI === void 0 ? void 0 : _process$env$RUN_ENVI.toLowerCase()) !== "authoring") return;
+    if (process.env.RUN_ENVIRONMENT?.toLowerCase() !== "authoring") return;
     const timeToRefresh = this.timeToRefresh;
     if (timeToRefresh === undefined) return;
     if (this.tokenRefreshTimeout) clearTimeout(this.tokenRefreshTimeout);
@@ -51,8 +50,7 @@ class JwtTokenManager {
     }, timeToRefresh);
   }
   async refreshToken() {
-    var _process$env$RUN_ENVI2;
-    if (((_process$env$RUN_ENVI2 = process.env.RUN_ENVIRONMENT) === null || _process$env$RUN_ENVI2 === void 0 ? void 0 : _process$env$RUN_ENVI2.toLowerCase()) !== "authoring") return;
+    if (process.env.RUN_ENVIRONMENT?.toLowerCase() !== "authoring") return;
     const res = await this.fetchWithToken(this.refreshTokenPath, {
       method: "GET"
     });
@@ -65,7 +63,7 @@ class JwtTokenManager {
     if (newToken) this._token = newToken;
   }
   fetchWithToken(...[input, init]) {
-    const headers = new Headers(init === null || init === void 0 ? void 0 : init.headers);
+    const headers = new Headers(init?.headers);
     headers.set("Authorization", `Bearer ${this.token}`);
     return (0, _crossFetch.default)(input, {
       ...init,

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

@@ -10,7 +10,7 @@ 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 type RunAutomationErrorCode = (typeof runAutomationErrorCodes)[number];
+export type RunAutomationErrorCode = typeof runAutomationErrorCodes[number];
 export declare abstract class RunAutomationError<T = any> {
     code: RunAutomationErrorCode;
     statusCode: number;

package/dist/common/runApi/errors.js

@@ -22,11 +22,10 @@ const runAutomationErrorCodes = exports.runAutomationErrorCodes = [apiNotFoundEr
 class RunAutomationError {
   wrapped = false;
   get json() {
-    var _this$cause;
     return {
       code: this.code,
       details: this.details,
-      cause: (_this$cause = this.cause) === null || _this$cause === void 0 ? void 0 : _this$cause.json
+      cause: this.cause?.json
     };
   }
 }
@@ -136,10 +135,10 @@ class AutomationError extends RunAutomationError {
       };
     }
     this.statusCode = 500;
-    this.message = `[${(error === null || error === void 0 ? void 0 : error.name) ?? error}] ${error === null || error === void 0 ? void 0 : error.message}`;
+    this.message = `[${error?.name ?? error}] ${error?.message}`;
     this.details = {
-      name: error === null || error === void 0 ? void 0 : error.name,
-      message: error === null || error === void 0 ? void 0 : error.message
+      name: error?.name,
+      message: error?.message
     };
   }
 }

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

@@ -1,6 +1,6 @@
 import { Result } from "neverthrow";
 import { RunAutomationError } from "./errors";
-import { Page, BrowserContext } from "playwright-core";
+import { Page, BrowserContext } from "playwright";
 import { ExtendedRunApiParameters, RunApiResult, RunApiResultWithSessionOk } from "./types";
 export * from "./types";
 export * from "./errors";
@@ -8,6 +8,9 @@ export declare function runApiGenerator<ResultType = any, _YieldType = any, _Nex
     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>(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"];

package/dist/common/runApi/index.js

@@ -80,17 +80,15 @@ async function* runApiGenerator({
       return;
     }
     try {
-      var _context;
-      await ((_context = context) === null || _context === void 0 ? void 0 : _context.tracing.stop({
+      await context?.tracing.stop({
         path: tracing.filePath
-      }));
+      });
     } catch (error) {
-      console.log(errorMessage, error === null || error === void 0 ? void 0 : error.message);
+      console.log(errorMessage, error?.message);
       await (0, _fsExtra.remove)(tracing.filePath);
     }
   }
   async function* runAutomation() {
-    var _getExecutionContext;
     let page;
     const validatedModuleResult = await importUsingImportFunction(automationFunction.name, importFunction);
     if (validatedModuleResult.isErr()) {
@@ -98,7 +96,7 @@ async function* runApiGenerator({
     }
     const importedModule = validatedModuleResult.value;
     let checkFn;
-    if (auth !== null && auth !== void 0 && auth.runCheck) {
+    if (auth?.runCheck) {
       if (!auth.session) {
         return (0, _neverthrow.err)(new _errors.AuthRequiredError());
       }
@@ -130,7 +128,8 @@ async function* runApiGenerator({
         headless,
         proxy,
         downloadsPath,
-        storageState: auth === null || auth === void 0 ? void 0 : auth.session
+        storageState: auth?.session,
+        importFunction
       }));
     } else {
       const {
@@ -140,7 +139,7 @@ async function* runApiGenerator({
       ({
         page,
         context
-      } = await (0, _getPlaywrightConstructs.getPlaywrightConstructsForMode)(mode, cdpAddress, auth === null || auth === void 0 ? void 0 : auth.session));
+      } = await (0, _getPlaywrightConstructs.getPlaywrightConstructsForMode)(mode, cdpAddress, auth?.session, importFunction));
     }
     if (tracing.enabled) {
       await context.tracing.start({
@@ -152,20 +151,23 @@ async function* runApiGenerator({
     }
     (0, _cleanEnvironmentVariables.cleanEnvironmentVariables)();
     if (checkFn !== undefined) {
-      console.log("Running auth check");
-      const authCheckResult = await checkAuthSessionWithRetries(page, context, checkFn, 2);
-      if (authCheckResult.isErr()) {
-        const error = authCheckResult.error;
-        if (["APINotFoundError", "InvalidAPIError"].includes(error.code)) {
-          return (0, _neverthrow.err)(new _errors.InvalidCheckError(`Auth session check function failed`, error));
+      try {
+        console.log("Running auth check");
+        const authCheckResult = await checkAuthSessionWithRetries(page, context, checkFn, 2);
+        if (authCheckResult.isErr()) {
+          const error = authCheckResult.error;
+          if (["APINotFoundError", "InvalidAPIError"].includes(error.code)) {
+            return (0, _neverthrow.err)(new _errors.InvalidCheckError(`Auth session check function failed`, error));
+          }
+          return authCheckResult;
         }
-        return authCheckResult;
-      }
-      if (!authCheckResult.value) {
+        if (!authCheckResult.value) {
+          return (0, _neverthrow.err)(new _errors.AuthCheckFailedError());
+        }
+      } catch (error) {
         return (0, _neverthrow.err)(new _errors.AuthCheckFailedError());
       }
     }
-    console.log("Running automation");
     const automationFunctionParameters = [...(automationFunction.params !== undefined ? [automationFunction.params] : []), page, context];
     let result;
     if (importedModule.type === "async-generator") {
@@ -185,7 +187,7 @@ async function* runApiGenerator({
     }
     return (0, _neverthrow.ok)({
       result,
-      extendedPayloads: (_getExecutionContext = (0, _asyncLocalStorage.getExecutionContext)()) === null || _getExecutionContext === void 0 ? void 0 : _getExecutionContext.extendedPayloads,
+      extendedPayloads: (0, _asyncLocalStorage.getExecutionContext)()?.extendedPayloads,
       session: retrieveSession ? await (0, _contextStorageStateHelpers.getStorageState)(context) : undefined
     });
   }
@@ -206,11 +208,10 @@ async function* runApiGenerator({
   } catch (error) {
     return (0, _neverthrow.err)(new _errors.AutomationError(error));
   } finally {
-    var _context2;
     await saveTraceIfNeeded({
       errorMessage: "failed to save trace"
     });
-    await ((_context2 = context) === null || _context2 === void 0 ? void 0 : _context2.close());
+    await context?.close();
     if (downloadsPath !== undefined) {
       await fs.remove(downloadsPath);
     }