@intuned/runtime-dev 0.0.1-split.0

package/WebTemplate/utils.ts

@@ -0,0 +1,294 @@
+import * as playwright from "@intuned/playwright-core";
+import { Handler, Response } from "@tinyhttp/app";
+import { cleanEnvironmentVariables } from "@intuned/runtime/dist/common/cleanEnvironmentVariables";
+import { AUTH_SESSIONS_FOLDER_NAME } from "@intuned/runtime/dist/common/constants";
+import { Page, BrowserContext } from "@intuned/playwright-core";
+import * as path from "path";
+import { getExecutionContext } from "@intuned/runtime";
+import { setTimeout } from "timers/promises";
+
+export class FunctionNotFoundError extends Error {
+  functionName: string;
+  path: string;
+  constructor(functionName: string, path: string) {
+    const message = `function ${functionName} not found in ${path}`;
+    super(message);
+    this.functionName = functionName;
+    this.path = path;
+    this.name = "FunctionNotFound";
+    Object.setPrototypeOf(this, FunctionNotFoundError.prototype);
+  }
+}
+
+export async function callFunction(
+  folderName: string,
+  functionName: string,
+  args: any[]
+) {
+  // cleanup environment variables before running the user code
+  cleanEnvironmentVariables();
+
+  const path = `./${folderName}/${functionName}.ts`;
+
+  const functionNameParts = functionName.split("/");
+  const functionNameDepth = functionNameParts.length;
+
+  // string literals should be inline
+  // currently we support only 5 levels of depth
+  // rollup dynamic import does not support multiple levels of dynamic imports so we need to specify the possible paths explicitly
+  try {
+    let imported: any = undefined;
+    switch (functionNameDepth) {
+      case 1:
+        imported = await import(`./${folderName}/${functionNameParts[0]}.ts`);
+        break;
+      case 2:
+        imported = await import(
+          `./${folderName}/${functionNameParts[0]}/${functionNameParts[1]}.ts`
+        );
+        break;
+      case 3:
+        imported = await import(
+          `./${folderName}/${functionNameParts[0]}/${functionNameParts[1]}/${functionNameParts[2]}.ts`
+        );
+        break;
+      case 4:
+        imported = await import(
+          `./${folderName}/${functionNameParts[0]}/${functionNameParts[1]}/${functionNameParts[2]}/${functionNameParts[3]}.ts`
+        );
+        break;
+      case 5:
+        imported = await import(
+          `./${folderName}/${functionNameParts[0]}/${functionNameParts[1]}/${functionNameParts[2]}/${functionNameParts[3]}/${functionNameParts[4]}.ts`
+        );
+        break;
+      default:
+        throw new Error(
+          "intuned supports maximum 5 levels of depth in the api folder"
+        );
+    }
+    return await imported?.default(...args);
+  } catch (error: any) {
+    if (error.message.includes("Unknown variable dynamic import")) {
+      throw new FunctionNotFoundError(functionName, path);
+    }
+    throw error;
+  }
+}
+
+export function getIsRetryableError(error: any) {
+  if (error?.message) {
+    return error.message.includes("ERR_NETWORK_CHANGED");
+  }
+  return false;
+}
+
+export function getErrorResponse(error: any): {
+  status: number;
+  body: any;
+} {
+  if (error instanceof FunctionNotFoundError) {
+    return {
+      status: 404,
+      body: {
+        message: error.message,
+        error: error.name,
+      },
+    };
+  }
+  if (error instanceof playwright.errors.TimeoutError) {
+    return {
+      status: 500,
+      body: { message: error.message, error: error.name },
+    };
+  }
+  /**
+   * here we use error.constructor.name instead of error instanceof RunError
+   * this is because the error is thrown by importing the runner from the api code on intuned app
+   * the definition of class RunError which is imported from here is different than the class RunError
+   * imported from the user.
+   */
+  if (error.constructor.name === "RunError") {
+    return {
+      status: 200,
+      body: {
+        status: error.options.status_code ?? 500,
+        message: error.message,
+        error: error.options.error_code ?? error.name,
+        intunedOptions: error.options,
+      },
+    };
+  }
+  return {
+    status: 500,
+    body: { error: error?.name ?? error, message: error?.message },
+  };
+}
+
+export function handlePlaywrightExecutionError(error: any, res: Response) {
+  const { status, body } = getErrorResponse(error);
+  return res.status(status).json(body);
+}
+
+type EventTraceEvent = {
+  type: "event";
+  time: number;
+  class: string;
+  method: string;
+  params: any;
+  pageId?: string;
+};
+
+type AppHandlerParams = Parameters<Handler>;
+
+export function errorRetryMiddleware(handler: Handler) {
+  return async (...args: AppHandlerParams) => {
+    let attempts = 1;
+    const [req, res, next] = args;
+    // eslint-disable-next-line no-constant-condition
+    while (true) {
+      try {
+        await handler(req, res, next);
+        break;
+      } catch (error) {
+        console.log(error?.name, error?.message);
+        if (!getIsRetryableError(error) || attempts >= 3) {
+          return handlePlaywrightExecutionError(error, res);
+        }
+        attempts++;
+      }
+    }
+  };
+}
+
+export async function checkAuthSessionWithRetries(
+  page: Page,
+  context: BrowserContext,
+  retries = 3
+): Promise<boolean> {
+  if (retries === 0) {
+    return false;
+  }
+
+  let tryNumber = 0;
+
+  while (retries > tryNumber) {
+    const result: boolean = await callFunction(
+      AUTH_SESSIONS_FOLDER_NAME,
+      "check" as string,
+      [page, context]
+    );
+    if (result) return true;
+
+    tryNumber++;
+  }
+
+  return false;
+}
+
+export function getTraceFilePath(runId: string, attemptNumber?: string) {
+  const fileName = `${runId}${attemptNumber ? `_${attemptNumber}` : ""}`;
+  return path.join(process.env.TRACES_DIRECTORY ?? "", `${fileName}.zip`);
+}
+
+export interface ProxyConfig {
+  username: string;
+  server: string;
+  password: string;
+}
+
+export function proxyToUrl(proxy: ProxyConfig) {
+  const url = new URL(proxy.server);
+  url.username = proxy.username;
+  url.password = proxy.password;
+  return url.toString();
+}
+
+export function isJobRunMachine() {
+  return process.env.JOB_ID && process.env.JOB_RUN_ID;
+}
+
+export function isHeadless() {
+  return process.env.INTUNED_PLAYWRIGHT_HEADLESS !== "0";
+}
+
+export abstract class AsyncRunEndpointController {
+  private static activeRequests: Set<string> = new Set();
+
+  static isRunning(taskToken: string) {
+    return this.activeRequests.has(taskToken);
+  }
+
+  static addRequest(taskToken: string) {
+    this.activeRequests.add(taskToken);
+  }
+
+  static removeRequest(taskToken: string) {
+    this.activeRequests.delete(taskToken);
+  }
+
+  static get activeRequestsCount() {
+    return this.activeRequests.size;
+  }
+}
+
+export async function waitWithExtendableTimeout<T>({
+  initialTimeout,
+  promise,
+  abortController,
+}: {
+  initialTimeout: number;
+  promise: Promise<T>;
+  abortController?: AbortController;
+}): Promise<
+  | {
+      timedOut: true;
+    }
+  | {
+      timedOut: false;
+      result: T;
+    }
+> {
+  const context = getExecutionContext()!;
+  if (context.timeoutInfo) {
+    context.timeoutInfo.timeoutTimestamp = Date.now() + initialTimeout;
+  }
+  const timerSymbol = Symbol("timer");
+  if (!context) {
+    const result = await Promise.race([
+      promise,
+      setTimeout(initialTimeout, timerSymbol),
+    ]);
+    if (result === timerSymbol) {
+      abortController?.abort("Timed out");
+      return { timedOut: true };
+    }
+    return { timedOut: false, result };
+  }
+
+  let taskTimeout = initialTimeout;
+  while (true as boolean) {
+    const result = await Promise.race([
+      promise,
+      setTimeout(taskTimeout, timerSymbol),
+    ]);
+
+    if (result !== timerSymbol) {
+      break;
+    }
+
+    const remainingTime =
+      (context.timeoutInfo?.timeoutTimestamp ?? 0) - Date.now();
+    if (remainingTime < 0) {
+      abortController?.abort("Timed out");
+      return { timedOut: true };
+    }
+
+    taskTimeout = remainingTime;
+  }
+
+  return {
+    timedOut: false,
+    result: await promise,
+  };
+}

package/bin/intuned-api-run

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require("../dist/commands/api/run.js");

package/bin/intuned-auth-session-check

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require("../dist/commands/auth-sessions/run-check.js");

package/bin/intuned-auth-session-create

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require("../dist/commands/auth-sessions/run-create.js");

package/bin/intuned-auth-session-load

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require("../dist/commands/auth-sessions/load.js");

package/bin/intuned-auth-session-refresh

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require("../dist/commands/auth-sessions/run-refresh.js");

package/bin/intuned-browser-save-state

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require("../dist/commands/browser/save-state.js");

package/bin/intuned-browser-start

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require("../dist/commands/browser/start-browser.js");

package/bin/intuned-build

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require("../dist/commands/build.js");

package/bin/intuned-ts-check

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require("../dist/commands/ts-check.js");

package/package.json

@@ -0,0 +1,133 @@
+{
+  "name": "@intuned/runtime-dev",
+  "version": "0.0.1-split.0",
+  "description": "Intuned runtime",
+  "exports": {
+    ".": "./dist/index.js",
+    "./runtime": "./dist/runtime/index.js",
+    "./dist/common/settingsSchema": "./dist/common/settingsSchema.js",
+    "./dist/common/contextStorageStateHelpers": "./dist/common/contextStorageStateHelpers.js",
+    "./dist/common/telemetry": "./dist/common/telemetry.js",
+    "./dist/common/jwtTokenManager": "./dist/common/jwtTokenManager.js",
+    "./dist/common/asyncLocalStorage": "./dist/common/asyncLocalStorage/index.js",
+    "./dist/common/cleanEnvironmentVariables": "./dist/common/cleanEnvironmentVariables.js",
+    "./dist/common/constants": "./dist/common/constants.js"
+  },
+  "author": "Intuned Team",
+  "license": "MIT",
+  "scripts": {
+    "intuned-api-run": "vite-node ./src/commands/api/run.ts",
+    "intuned-browser-save-state": "vite-node ./src/commands/browser/save-state.ts",
+    "intuned-browser-start": "vite-node ./src/commands/browser/start-browser.ts",
+    "intuned-build": "yarn prepublishOnly && vite-node ./src/commands/build.ts",
+    "intuned-auth-session-check": "vite-node ./src/commands/auth/run-check.ts",
+    "intuned-auth-session-create": "vite-node ./src/commands/auth/run-create.ts",
+    "intuned-auth-session-refresh": "vite-node ./src/commands/auth/run-refresh.ts",
+    "intuned-auth-session-load": "vite-node ./src/commands/auth/load.ts",
+    "intuned-ts-check": "yarn prepublishOnly && vite-node ./src/commands/ts-check.ts",
+    "save-html": "vite-node ./src/commands/testing/saveVisibleHtml.ts",
+    "build": "rm -rf dist && tsc -p tsconfig.json  && yarn copy-dts && babel src --out-dir dist --extensions '.ts' &&  cp -r ./src/common/assets dist/common/assets",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "e2e": "yarn playwright test --config ./playwright.config.ts",
+    "clean-declarations": "find ./types-package -name \"*.d.ts\" -type f -delete",
+    "lint": "eslint .",
+    "fix": "eslint . --fix",
+    "generate-docs": "./scripts/generate-docs.sh",
+    "build-browser-scripts": "rollup -c ./src/common/browserScripts/rollup.config.mjs",
+    "copy-dts": "copyfiles -u 1 \"src/**/*.d.ts\" dist"
+  },
+  "bin": {
+    "intuned-api-run": "./bin/intuned-api-run",
+    "intuned-auth-session-create": "./bin/intuned-auth-session-create",
+    "intuned-auth-session-refresh": "./bin/intuned-auth-session-refresh",
+    "intuned-auth-session-load": "./bin/intuned-auth-session-load",
+    "intuned-auth-session-check": "./bin/intuned-auth-session-check",
+    "intuned-build": "./bin/intuned-build",
+    "intuned-browser-start": "./bin/intuned-browser-start",
+    "intuned-browser-save-state": "./bin/intuned-browser-save-state",
+    "intuned-ts-check": "./bin/intuned-ts-check"
+  },
+  "dependencies": {
+    "@intuned/playwright": "^1.44.1-4",
+    "@intuned/playwright-core": "^1.44.1-4",
+    "@rollup/plugin-commonjs": "^25.0.2",
+    "@rollup/plugin-dynamic-import-vars": "^2.0.4",
+    "@rollup/plugin-json": "^6.0.0",
+    "@rollup/plugin-node-resolve": "^15.1.0",
+    "@rollup/plugin-typescript": "^11.1.2",
+    "@tinyhttp/app": "^2.1.0",
+    "@types/async-retry": "^1.4.8",
+    "@types/fs-extra": "^11.0.1",
+    "@types/lodash": "^4.14.200",
+    "@types/node": "^20.4.1",
+    "applicationinsights": "^2.9.2",
+    "async-retry": "^1.3.3",
+    "chalk": "^4.1.2",
+    "commander": "^11.0.0",
+    "cross-fetch": "^4.0.0",
+    "dotenv": "^16.3.1",
+    "express": "4.20.0",
+    "fastify": "^4.19.2",
+    "file-type": "16.5.4",
+    "fs-extra": "^11.3.0",
+    "https-proxy-agent": "^7.0.5",
+    "image-size": "^1.1.1",
+    "jsonwebtoken": "^9.0.2",
+    "lodash": "^4.17.21",
+    "milliparsec": "^2.3.0",
+    "ms": "^2.1.3",
+    "nanoid": "3",
+    "neverthrow": "^6.1.0",
+    "playwright-extra": "^4.3.6",
+    "prettier": "^2.8.0",
+    "promptly": "^3.2.0",
+    "read-chunk": "^3.2.0",
+    "rollup": "^3.26.2",
+    "source-map": "^0.7.4",
+    "stack-utils": "^2.0.6",
+    "ts-morph": "^21.0.1",
+    "ts-node": "^10.9.1",
+    "tslib": "^2.6.0",
+    "typescript": "^5.1.6",
+    "wait-on": "^7.2.0",
+    "zod": "^3.21.4",
+    "zod-validation-error": "^3.0.3"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.23.4",
+    "@babel/core": "^7.23.7",
+    "@babel/plugin-transform-export-namespace-from": "^7.24.1",
+    "@babel/preset-env": "^7.23.7",
+    "@babel/preset-typescript": "^7.23.3",
+    "@jest/globals": "^29.6.2",
+    "@ngneat/falso": "^7.2.0",
+    "@types/jest": "^29.5.3",
+    "@types/jsdom": "^21.1.1",
+    "@types/promptly": "^3.0.4",
+    "@types/wait-on": "^5.3.4",
+    "@typescript-eslint/eslint-plugin": "^5.47.1",
+    "@typescript-eslint/parser": "^7.5.0",
+    "@vitest/ui": "^1.1.3",
+    "babel-plugin-macros": "^3.1.0",
+    "babel-preset-minify": "^0.5.2",
+    "copyfiles": "^2.4.1",
+    "dts-bundle-generator": "^8.0.1",
+    "eslint": "7.32.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-deprecation": "^1.3.3",
+    "eslint-plugin-prettier": "^4.2.1",
+    "msw": "^2.1.2",
+    "typedoc": "^0.25.13",
+    "typedoc-plugin-frontmatter": "^1.0.0",
+    "typedoc-plugin-markdown": "^4.0.2",
+    "typedoc-plugin-remove-references": "^0.0.6",
+    "vite": "^5.2.14",
+    "vite-node": "^1.1.3",
+    "vite-plugin-babel-macros": "^1.0.6",
+    "vitest": "^1.1.3"
+  },
+  "peerDependencies": {
+    "@intuned/runtime": "0.0.1"
+  }
+}

package/playwright.config.ts

@@ -0,0 +1,48 @@
+import { defineConfig, devices } from "@intuned/playwright-test";
+
+/**
+ * Read environment variables from file.
+ * https://github.com/motdotla/dotenv
+ */
+// require('dotenv').config();
+
+/**
+ * See https://playwright.dev/docs/test-configuration.
+ */
+export default defineConfig({
+  testDir: "./e2e-tests",
+  /* Run tests in files in parallel */
+  fullyParallel: true,
+  /* Fail the build on CI if you accidentally left test.only in the source code. */
+  forbidOnly: !!process.env.CI,
+  /* Retry on CI only */
+  retries: process.env.CI ? 2 : 0,
+  /* Opt out of parallel tests on CI. */
+  workers: process.env.CI ? 1 : undefined,
+  /* Reporter to use. See https://playwright.dev/docs/test-reporters */
+  reporter: "html",
+  /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
+  use: {
+    /* Base URL to use in actions like `await page.goto('/')`. */
+    // baseURL: 'http://127.0.0.1:3000',
+
+    /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
+    trace: "on-first-retry",
+    // headless: false,
+  },
+
+  /* Configure projects for major browsers */
+  projects: [
+    {
+      name: "chromium",
+      use: { ...devices["Desktop Chrome"] },
+    },
+  ],
+
+  /* Run your local dev server before starting the tests */
+  // webServer: {
+  //   command: 'npm run start',
+  //   url: 'http://127.0.0.1:3000',
+  //   reuseExistingServer: !process.env.CI,
+  // },
+});