@intuned/runtime 1.0.5

package/dist/common/runApi/errors.js

@@ -0,0 +1,156 @@
+"use strict";
+
+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;
+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); }
+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 apiNotFoundErrorCode = exports.apiNotFoundErrorCode = "APINotFoundError";
+const invalidApiErrorCode = exports.invalidApiErrorCode = "InvalidAPIError";
+const invalidCheckErrorCode = exports.invalidCheckErrorCode = "InvalidCheckError";
+const abortedErrorCode = exports.abortedErrorCode = "AbortedError";
+const authRequiredErrorCode = exports.authRequiredErrorCode = "AuthRequiredError";
+const authCheckNotFoundErrorCode = exports.authCheckNotFoundErrorCode = "AuthCheckNotFoundError";
+const authCheckFailedErrorCode = exports.authCheckFailedErrorCode = "AuthCheckFailedError";
+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];
+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
+    };
+  }
+}
+exports.RunAutomationError = RunAutomationError;
+class ApiNotFoundError extends RunAutomationError {
+  constructor(apiName) {
+    super();
+    this.code = apiNotFoundErrorCode;
+    this.statusCode = 404;
+    this.message = `API ${apiName} not found`;
+  }
+}
+exports.ApiNotFoundError = ApiNotFoundError;
+class InvalidApiError extends RunAutomationError {
+  constructor(message) {
+    super();
+    this.code = invalidApiErrorCode;
+    this.statusCode = 400;
+    this.message = `API is invalid: ${message}`;
+  }
+}
+exports.InvalidApiError = InvalidApiError;
+class InvalidCheckError extends RunAutomationError {
+  constructor(message, cause) {
+    super();
+    this.code = invalidCheckErrorCode;
+    this.statusCode = 400;
+    this.message = message;
+    this.cause = cause;
+  }
+}
+exports.InvalidCheckError = InvalidCheckError;
+class AbortedError extends RunAutomationError {
+  constructor() {
+    super();
+    this.code = abortedErrorCode;
+    this.statusCode = 200;
+    this.message = "Operation was aborted";
+  }
+}
+exports.AbortedError = AbortedError;
+class AuthRequiredError extends RunAutomationError {
+  constructor() {
+    super();
+    this.code = authRequiredErrorCode;
+    this.statusCode = 401;
+    this.message = "Authentication is required";
+    this.wrapped = true;
+  }
+}
+exports.AuthRequiredError = AuthRequiredError;
+class AuthCheckNotFoundError extends RunAutomationError {
+  constructor() {
+    super();
+    this.code = authCheckNotFoundErrorCode;
+    this.statusCode = 404;
+    this.message = "Auth check not found";
+  }
+}
+exports.AuthCheckNotFoundError = AuthCheckNotFoundError;
+class AuthCheckFailedError extends RunAutomationError {
+  constructor() {
+    super();
+    this.code = authCheckFailedErrorCode;
+    this.statusCode = 401;
+    this.message = "auth session check failed";
+    this.wrapped = true;
+  }
+}
+exports.AuthCheckFailedError = AuthCheckFailedError;
+class MaxLevelsExceededError extends RunAutomationError {
+  constructor(levels) {
+    super();
+    this.code = maxLevelsExceededErrorCode;
+    this.statusCode = 400;
+    this.message = `Max levels exceeded. Only ${levels} levels are supported`;
+    this.details = {
+      levels
+    };
+  }
+}
+exports.MaxLevelsExceededError = MaxLevelsExceededError;
+class AutomationError extends RunAutomationError {
+  constructor(error) {
+    super();
+    this.error = error;
+    this.code = automationError;
+    if (error instanceof playwright.errors.TimeoutError) {
+      this.statusCode = 500;
+      this.message = `[${error.name}] ${error.message}`;
+      this.details = {
+        name: error.name,
+        message: error.message
+      };
+      return;
+    }
+    if (error instanceof _runtime.RunError) {
+      this.wrapped = true;
+      this.statusCode = error.options.status_code ?? 500;
+      this.message = `[${error.options.error_code ?? error.name}] ${error.message}`;
+      this.details = {
+        name: error.name,
+        statusCode: error.options.status_code,
+        errorCode: error.options.error_code,
+        message: error.message,
+        options: error.options
+      };
+    }
+    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.details = {
+      name: error === null || error === void 0 ? void 0 : error.name,
+      message: error === null || error === void 0 ? void 0 : error.message
+    };
+  }
+}
+exports.AutomationError = AutomationError;
+class InternalInvalidInputError extends RunAutomationError {
+  constructor(message, details) {
+    super();
+    this.code = internalInvalidInputErrorCode;
+    this.statusCode = 500;
+    this.message = message;
+    this.details = details;
+  }
+}
+exports.InternalInvalidInputError = InternalInvalidInputError;

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

@@ -0,0 +1,12 @@
+import { Result } from "neverthrow";
+import { RunAutomationError } from "./errors";
+import { Page, BrowserContext } from "playwright-core";
+import { ExtendedRunApiParameters, RunApiResult, RunApiResultWithSessionOk } from "./types";
+export * from "./types";
+export * from "./errors";
+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): Promise<RunApiResult<ResultType>>;
+export declare function checkAuthSessionWithRetries(page: Page, context: BrowserContext, checkFn: (..._: any) => Promise<boolean>, retries?: number): Promise<Result<boolean, RunAutomationError>>;

package/dist/common/runApi/index.js

@@ -0,0 +1,265 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _exportNames = {
+  runApiGenerator: true,
+  runApi: true,
+  checkAuthSessionWithRetries: true
+};
+exports.checkAuthSessionWithRetries = checkAuthSessionWithRetries;
+exports.runApi = runApi;
+exports.runApiGenerator = runApiGenerator;
+var _downloadDirectory = require("../../runtime/downloadDirectory");
+var _asyncLocalStorage = require("../asyncLocalStorage");
+var _fsExtra = _interopRequireWildcard(require("fs-extra"));
+var fs = _fsExtra;
+var _contextStorageStateHelpers = require("../contextStorageStateHelpers");
+var _neverthrow = require("neverthrow");
+var _errors = require("./errors");
+Object.keys(_errors).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _errors[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _errors[key];
+    }
+  });
+});
+var _constants = require("../constants");
+var _getPlaywrightConstructs = require("../getPlaywrightConstructs");
+var _types = require("./types");
+Object.keys(_types).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _types[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _types[key];
+    }
+  });
+});
+var _formatZodError = require("../formatZodError");
+var _cleanEnvironmentVariables = require("../cleanEnvironmentVariables");
+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* runApiGenerator({
+  retrieveSession = false,
+  abortSignal,
+  importFunction,
+  ...input
+}) {
+  let traceStarted = false;
+  const inputParseResult = _types.runApiParametersSchema.safeParse(input);
+  if (!inputParseResult.success) {
+    return (0, _neverthrow.err)(new _errors.InternalInvalidInputError("Input validation failed", (0, _formatZodError.formatZodError)(inputParseResult.error)));
+  }
+  const {
+    automationFunction,
+    runOptions,
+    tracing,
+    auth
+  } = inputParseResult.data;
+  const abortSymbol = Symbol("abort");
+  const abortPromise = new Promise(resolve => {
+    if (!abortSignal) return;
+    abortSignal.addEventListener("abort", () => {
+      resolve(abortSymbol);
+    });
+  });
+  let context;
+  let downloadsPath;
+  async function saveTraceIfNeeded({
+    errorMessage
+  }) {
+    if (!tracing.enabled || !traceStarted) {
+      return;
+    }
+    try {
+      var _context;
+      await ((_context = context) === null || _context === void 0 ? void 0 : _context.tracing.stop({
+        path: tracing.filePath
+      }));
+    } catch (error) {
+      console.log(errorMessage, error === null || error === void 0 ? void 0 : 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()) {
+      return (0, _neverthrow.err)(validatedModuleResult.error);
+    }
+    const importedModule = validatedModuleResult.value;
+    let checkFn;
+    if (auth !== null && auth !== void 0 && auth.runCheck) {
+      if (!auth.session) {
+        return (0, _neverthrow.err)(new _errors.AuthRequiredError());
+      }
+      const checkImportResult = await importUsingImportFunction(`${_constants.AUTH_SESSIONS_FOLDER_NAME}/check`, importFunction);
+      if (checkImportResult.isErr()) {
+        return (0, _neverthrow.err)(checkImportResult.error);
+      }
+      if (checkImportResult.value.type !== "async") {
+        return (0, _neverthrow.err)(new _errors.InvalidCheckError("Check function is not an async function"));
+      }
+      checkFn = checkImportResult.value.func;
+    }
+    if (auth && auth.session.type === "state") {
+      const state = auth.session.state;
+      if (state === undefined || state === null) {
+        return (0, _neverthrow.err)(new _errors.AuthRequiredError());
+      }
+    }
+    if (runOptions.environment === "standalone") {
+      downloadsPath = (0, _downloadDirectory.getDownloadDirectoryPath)();
+      const {
+        headless,
+        proxy
+      } = runOptions;
+      ({
+        page,
+        context
+      } = await (0, _getPlaywrightConstructs.getProductionPlaywrightConstructs)({
+        headless,
+        proxy,
+        downloadsPath,
+        storageState: auth === null || auth === void 0 ? void 0 : auth.session
+      }));
+    } else {
+      const {
+        mode,
+        cdpAddress
+      } = runOptions;
+      ({
+        page,
+        context
+      } = await (0, _getPlaywrightConstructs.getPlaywrightConstructsForMode)(mode, cdpAddress, auth === null || auth === void 0 ? void 0 : auth.session));
+    }
+    if (tracing.enabled) {
+      await context.tracing.start({
+        screenshots: true,
+        snapshots: true,
+        sources: true
+      });
+      traceStarted = true;
+    }
+    (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));
+        }
+        return authCheckResult;
+      }
+      if (!authCheckResult.value) {
+        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") {
+      const generator = importedModule.generator(...automationFunctionParameters);
+      let next = undefined;
+      while (true) {
+        const generatorResult = await generator.next(...(next ? [next] : []));
+        if (!generatorResult.done) {
+          next = yield generatorResult.value;
+          continue;
+        }
+        result = generatorResult.value;
+        break;
+      }
+    } else {
+      result = await importedModule.func(...automationFunctionParameters);
+    }
+    return (0, _neverthrow.ok)({
+      result,
+      extendedPayloads: (_getExecutionContext = (0, _asyncLocalStorage.getExecutionContext)()) === null || _getExecutionContext === void 0 ? void 0 : _getExecutionContext.extendedPayloads,
+      session: retrieveSession ? await (0, _contextStorageStateHelpers.getStorageState)(context) : undefined
+    });
+  }
+  try {
+    const generator = runAutomation();
+    let next = undefined;
+    while (true) {
+      const result = await Promise.race([generator.next(await next), abortPromise]);
+      if (result === abortSymbol) {
+        return (0, _neverthrow.err)(new _errors.AbortedError());
+      }
+      if (!result.done) {
+        next = yield result.value;
+        continue;
+      }
+      return result.value;
+    }
+  } 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());
+    if (downloadsPath !== undefined) {
+      await fs.remove(downloadsPath);
+    }
+  }
+}
+async function runApi(params) {
+  const generator = runApiGenerator(params);
+  const {
+    value,
+    done
+  } = await generator.next();
+  if (done) {
+    return value;
+  }
+  return (0, _neverthrow.err)(new _errors.InvalidApiError("Expected API to be async function, got async generator"));
+}
+async function checkAuthSessionWithRetries(page, context, checkFn, retries = 3) {
+  if (retries === 0) {
+    return (0, _neverthrow.ok)(false);
+  }
+  let tryNumber = 0;
+  console.log("Checking auth session with retries", `${_constants.AUTH_SESSIONS_FOLDER_NAME}/check`);
+  while (retries > tryNumber) {
+    const result = await checkFn(page, context);
+    if (result) return (0, _neverthrow.ok)(true);
+    tryNumber++;
+  }
+  return (0, _neverthrow.ok)(false);
+}
+async function importUsingImportFunction(path, importFunction) {
+  try {
+    const imported = importFunction ? await importFunction(path) : await (specifier => new Promise(r => r(specifier)).then(s => _interopRequireWildcard(require(s))))(`../../../${path}.ts`);
+    if (!imported || !imported.default || !imported.default.constructor) {
+      return (0, _neverthrow.err)(new _errors.InvalidApiError("API file path does not have a default export"));
+    }
+    if (imported.default.constructor.name === "AsyncGeneratorFunction") {
+      return (0, _neverthrow.ok)({
+        type: "async-generator",
+        generator: imported.default
+      });
+    }
+    if (imported.default.constructor.name === "AsyncFunction") {
+      return (0, _neverthrow.ok)({
+        type: "async",
+        func: imported.default
+      });
+    }
+    return (0, _neverthrow.err)(new _errors.InvalidApiError("API file path does not have a default async function/generator export"));
+  } catch (error) {
+    return (0, _neverthrow.err)(new _errors.ApiNotFoundError(path));
+  }
+}