@intuned/runtime-dev 0.0.1 → 0.1.0-test.0

package/package.json

@@ -1,18 +1,21 @@
 {
   "name": "@intuned/runtime-dev",
-  "version": "0.0.1",
+  "version": "0.1.0-test.0",
   "description": "Intuned runtime",
   "exports": {
     ".": "./dist/index.js",
-    "./runtime": "./dist/runtime/index.js",
+    "./dist/runtime": "./dist/runtime/index.js",
+    "./dist/common/runApi": "./dist/common/runApi/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"
+    "./dist/common/constants": "./dist/common/constants.js",
+    "./dist/commands/interface/run": "./dist/commands/interface/run.js"
   },
+  "types": "./dist/index.d.ts",
   "author": "Intuned Team",
   "license": "MIT",
   "scripts": {
@@ -25,7 +28,6 @@
     "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",
@@ -122,12 +124,12 @@
     "typedoc-plugin-frontmatter": "^1.0.0",
     "typedoc-plugin-markdown": "^4.0.2",
     "typedoc-plugin-remove-references": "^0.0.6",
-    "vite": "^5.2.14",
+    "vite": "^5.4.12",
     "vite-node": "^1.1.3",
     "vite-plugin-babel-macros": "^1.0.6",
     "vitest": "^1.1.3"
   },
   "peerDependencies": {
-    "@intuned/runtime": "0.0.1"
+    "@intuned/runtime": "*"
   }
-}
+}

package/tsconfig.json

@@ -12,7 +12,8 @@
     "sourceMap": false,
     "declaration": true,
     "emitDeclarationOnly": false,
-    "skipLibCheck": true
+    "skipLibCheck": true,
+    "baseUrl": "./"
   },
   "include": [
     "src/**/*.ts",

package/.vite/deps_temp_01af7156/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "module"
-}

package/.vscode/extensions.json

@@ -1,3 +0,0 @@
-{
-  "recommendations": ["zixuanchen.vitest-explorer"]
-}

package/.vscode/launch.json

@@ -1,102 +0,0 @@
-{
-  // Use IntelliSense to learn about possible attributes.
-  // Hover to view descriptions of existing attributes.
-  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-  "version": "0.2.0",
-  "configurations": [
-    {
-      "name": "Hiltion api",
-      "type": "node",
-      "request": "launch",
-      "runtimeExecutable": "node",
-      "runtimeArgs": ["--nolazy", "-r", "ts-node/register/transpile-only"],
-
-      "args": ["src/commands/api/run.ts", "hilton", "-j", "{}", "playwright"],
-
-      "cwd": "${workspaceRoot}",
-      "internalConsoleOptions": "openOnSessionStart",
-      "skipFiles": ["<node_internals>/**", "node_modules/**"]
-    },
-    {
-      "name": "Books Extractor",
-      "type": "node",
-      "request": "launch",
-      "runtimeExecutable": "node",
-      "runtimeArgs": ["--nolazy", "-r", "ts-node/register/transpile-only"],
-
-      "args": [
-        "src/commands/api/run.ts",
-        "books-array",
-        "-j",
-        "{}",
-        "playwright"
-      ],
-
-      "cwd": "${workspaceRoot}",
-      "internalConsoleOptions": "openOnSessionStart",
-      "skipFiles": ["<node_internals>/**", "node_modules/**"]
-    },
-    {
-      "name": "Run execution-info",
-      "type": "node",
-      "request": "launch",
-      "runtimeExecutable": "node",
-      "runtimeArgs": ["--nolazy", "-r", "ts-node/register/transpile-only"],
-
-      "args": [
-        "src/commands/api/run.ts",
-        "execution-info",
-        "-j",
-        "{}",
-        "playwright"
-      ],
-
-      "cwd": "${workspaceRoot}",
-      "internalConsoleOptions": "openOnSessionStart",
-      "skipFiles": ["<node_internals>/**", "node_modules/**"]
-    },
-    {
-      "name": "Run progressive",
-      "type": "node",
-      "request": "launch",
-      "runtimeExecutable": "node",
-      "runtimeArgs": ["--nolazy", "-r", "ts-node/register/transpile-only"],
-
-      "args": [
-        "src/commands/api/run.ts",
-        "progressive",
-        "-j",
-        "{}",
-        "playwright"
-      ],
-
-      "cwd": "${workspaceRoot}",
-      "internalConsoleOptions": "openOnSessionStart",
-      "skipFiles": ["<node_internals>/**", "node_modules/**"]
-    },
-    {
-      "name": "Run progressive - standalone",
-      "type": "node",
-      "request": "launch",
-      "runtimeExecutable": "node",
-      "runtimeArgs": ["--nolazy", "-r", "ts-node/register/transpile-only"],
-
-      "args": ["src/commands/api/run.ts", "progressive", "-j", "{}"],
-      "cwd": "${workspaceRoot}",
-      "internalConsoleOptions": "openOnSessionStart",
-      "skipFiles": ["<node_internals>/**", "node_modules/**"]
-    },
-    {
-      "name": "Run progressive extract - standalone",
-      "type": "node",
-      "request": "launch",
-      "runtimeExecutable": "node",
-      "runtimeArgs": ["--nolazy", "-r", "ts-node/register/transpile-only"],
-
-      "args": ["src/commands/api/run.ts", "progressive-extract", "-j", "{}"],
-      "cwd": "${workspaceRoot}",
-      "internalConsoleOptions": "openOnSessionStart",
-      "skipFiles": ["<node_internals>/**", "node_modules/**"]
-    }
-  ]
-}

package/.vscode/settings.json

@@ -1,12 +0,0 @@
-{
-  "editor.formatOnSave": true,
-  "cSpell.words": ["backcompat", "ـget", "INFINITI", "neverthrow"],
-  "editor.detectIndentation": true,
-  "files.exclude": {
-    "dist": false,
-    "node_modules": false,
-    "output": false,
-    "intuned": false,
-    "htmlFiles": true
-  }
-}

package/playwright.config.ts

@@ -1,48 +0,0 @@
-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,
-  // },
-});

package/src/commands/api/run.ts

@@ -1,225 +0,0 @@
-#!/usr/bin/env node
-import { program, Argument } from "commander";
-import * as fs from "fs-extra";
-import { getDefaultExportFromFile } from "../common/getDefaultExportFromFile";
-import { getFullPathInProject } from "../common/utils/fileUtils";
-import { getSettings } from "../common/utils/settings";
-import getFirstLineNumber from "../common/getFirstLineNumber";
-import { sendBreakPointOnToClient } from "../common/sendMessageToClient";
-import dotenv from "dotenv";
-import {
-  getExecutionContext,
-  runWithContext,
-} from "../../common/asyncLocalStorage";
-import { RunEnvironment } from "../../runtime/enums";
-import { cleanEnvironmentVariables } from "../../common/cleanEnvironmentVariables";
-import { logger } from "../../common/Logger";
-import { nanoid } from "nanoid";
-import chalk from "chalk";
-import { getDownloadDirectoryPath } from "../../runtime";
-import { getPlaywrightConstructsForMode } from "../../common/getPlaywrightConstructs";
-
-dotenv.config({
-  path: `.env`,
-});
-
-export async function executeCLI(
-  apiName: string,
-  mode:
-    | "vanilla"
-    | "playwright"
-    | "playwright-standalone"
-    | "playwright-headless",
-  inputData: object | null | undefined,
-  options: {
-    cdpAddress: string;
-    authSessionPath: undefined | string;
-    outputFileId: string | undefined;
-  }
-) {
-  // cleanup environment variables before running the user code
-  cleanEnvironmentVariables();
-  // Path to the TypeScript file
-  const apiFilePath = getFullPathInProject("api", `${apiName}.ts`);
-
-  let authSessionPathToUse: string | null = null;
-
-  // check auth session
-  const settings = await getSettings();
-
-  if (settings.authSessions.enabled) {
-    // if auth session enabled, check if the auth session is provided
-    if (!options.authSessionPath) {
-      throw new Error("Auth session is enabled but no auth session provided");
-    }
-
-    authSessionPathToUse = options.authSessionPath as string;
-  } else {
-    // if auth session is not enabled, check if the auth session is provided
-    if (options.authSessionPath) {
-      throw new Error(
-        "Auth session is not enabled but auth session provided. To use auth session please enable it in Intuned.json"
-      );
-    }
-  }
-
-  // Dynamically import the TypeScript file
-  const defaultExport = await getDefaultExportFromFile(apiFilePath);
-  const isDebug = process.execArgv.some((arg) => arg.includes("--inspect"));
-  if (isDebug) {
-    const { sourceFileName, lineNumber } = await getFirstLineNumber(
-      apiFilePath
-    );
-    sendBreakPointOnToClient(sourceFileName, lineNumber);
-  }
-
-  if (mode === "vanilla") {
-    // Execute the function with the input data
-    const result = await defaultExport(inputData);
-    return result;
-  }
-
-  const { page, context } = await getPlaywrightConstructsForMode(
-    mode,
-    options.cdpAddress,
-    authSessionPathToUse ? authSessionPathToUse : undefined
-  );
-
-  // wait for the page to get stable, this is a workaround for a bug in playwright when you try to do something
-  // on a page after connecting to it immediately, the page needs some time to get stable.
-  let isPageStable = false;
-  let retry = 0;
-  // will wait maximum 2 seconds before failing.
-  while (!isPageStable && retry < 10) {
-    try {
-      await page.locator("html").all();
-      isPageStable = true;
-      break;
-    } catch (error) {
-      if (error?.message?.includes("Execution context was destroyed")) {
-        await new Promise((resolve) => setTimeout(resolve, 200));
-      } else {
-        // throwing to make sure we do not hide any other unexpected issues.
-        throw error;
-      }
-    }
-    retry++;
-  }
-
-  if (!isPageStable) {
-    throw new Error("The page is not stable, try to run again.");
-  }
-
-  const result = await defaultExport(inputData, page, context);
-  const downloadsPath = getDownloadDirectoryPath();
-  await fs.remove(downloadsPath);
-  if (mode == "playwright") {
-    await context.close();
-  }
-  const isResponseObject = typeof result === "object" && result !== null;
-
-  const hasMoreThank5Keys = isResponseObject && Object.keys(result).length > 5;
-  const hasNestedObjects =
-    isResponseObject &&
-    Object.values(result).some((value) => typeof value === "object");
-
-  const shouldWriteToFile =
-    isResponseObject && (hasMoreThank5Keys || hasNestedObjects);
-
-  const resultsDir = "/tmp/run-results";
-
-  if (options.outputFileId && shouldWriteToFile) {
-    logger.info(
-      chalk.underline.bgBlue.white(
-        `Click to Open: Results saved (Run: ${options.outputFileId})`
-      )
-    );
-
-    fs.ensureDirSync(resultsDir);
-    const path = `${resultsDir}/${options.outputFileId}.json`;
-    await fs.writeJson(path, result, {
-      spaces: 2,
-    });
-  } else {
-    console.log("result:", result);
-  }
-
-  const payloadToAppend = getExecutionContext()?.extendedPayloads;
-  const hasPayloadToAppend = payloadToAppend && payloadToAppend.length > 0;
-
-  if (hasPayloadToAppend && options.outputFileId) {
-    logger.info(
-      chalk.underline.bgBlue.white(
-        `Click to Open: payloads to append (Run: ${options.outputFileId})`
-      )
-    );
-
-    fs.ensureDirSync(resultsDir);
-
-    const path = `${resultsDir}/${options.outputFileId}-payloads-to-append.json`;
-    await fs.writeJson(path, payloadToAppend, {
-      spaces: 2,
-    });
-  } else if (hasPayloadToAppend) {
-    logger.info("payload to append:", payloadToAppend);
-    logger.info(
-      "This will only take an effect if this API run was part of a job."
-    );
-  }
-}
-
-program
-  .description("run the user function in the cli for testing purposes")
-  .option("-i, --input [file]", "input json file")
-  .option("-j, --json [json]", "input json string")
-  .option("--cdpAddress <cdpAddress>", "CDP address", "http://localhost:9222")
-  .option(
-    "--authSessionPath <authSession>",
-    "auth session to use when executing the api"
-  )
-  .option(
-    "--outputFileId <outputFileId>",
-    "the output file id to save the result in"
-  )
-  .option("--proxy <proxy>", "proxy to use")
-  .argument("[apiName]", "name of the api", "default")
-  .allowUnknownOption()
-  .addArgument(
-    new Argument("<mode>", "mode of execution")
-      .choices([
-        "vanilla",
-        "playwright",
-        "playwright-standalone",
-        "playwright-headless",
-      ])
-      .default("playwright-standalone")
-      .argOptional()
-  )
-  .action(async (apiName, mode, options) => {
-    let inputData: null | object = null;
-
-    if (options.input) {
-      inputData = await fs.readJSON(options.input);
-    } else if (options.json) {
-      inputData = JSON.parse(options.json);
-    } else {
-      inputData = {};
-    }
-
-    await runWithContext(
-      {
-        runEnvironment: RunEnvironment.IDE,
-        extendedPayloads: [],
-        runId: nanoid(),
-        proxy: options.proxy,
-      },
-      () => executeCLI(apiName, mode, inputData as object, options)
-    );
-
-    // playwright keeps an open handle to the connected browser and it stops the process from exiting
-    // there is no way to close the connection gracefully without destroying the context/browser
-    // https://github.com/microsoft/playwright/issues/4956
-    process.exit(0);
-  });
-
-program.parse(process.argv);

package/src/commands/auth-sessions/load.ts

@@ -1,42 +0,0 @@
-#!/usr/bin/env node
-import { program } from "commander";
-import { getRemotePlaywrightContext } from "../../common/getPlaywrightConstructs";
-import { getSettings } from "../common/utils/settings";
-
-import dotenv from "dotenv";
-import { loadAuthSessionToContext } from "../../common/getPlaywrightConstructs";
-
-dotenv.config({
-  path: `.env`,
-});
-
-program
-  .description("load auth session to browser")
-  .option("--cdpAddress <cdpAddress>", "CDP address", "http://localhost:9222")
-  .option(
-    "--authSessionPath <authSession>",
-    "auth session to use when executing the api"
-  )
-  .allowUnknownOption()
-  .action(
-    async ({
-      cdpAddress,
-      authSessionPath,
-    }: {
-      cdpAddress: string;
-      authSessionPath: string;
-    }) => {
-      const setting = await getSettings();
-
-      if (!setting.authSessions.enabled) {
-        throw new Error("Auth session is not enabled");
-      }
-
-      const { context } = await getRemotePlaywrightContext(cdpAddress);
-      await loadAuthSessionToContext(context, authSessionPath);
-
-      process.exit(0);
-    }
-  );
-
-program.parse(process.argv);

package/src/commands/auth-sessions/run-check.ts

@@ -1,70 +0,0 @@
-#!/usr/bin/env node
-import { Argument, program } from "commander";
-import { getDefaultExportFromFile } from "../common/getDefaultExportFromFile";
-import * as fs from "fs-extra";
-import { getFullPathInProject } from "../common/utils/fileUtils";
-import { getSettings } from "../common/utils/settings";
-import dotenv from "dotenv";
-import { AUTH_SESSIONS_FOLDER_NAME } from "../../common/constants";
-import { getPlaywrightConstructsForMode } from "../../common/getPlaywrightConstructs";
-
-dotenv.config({
-  path: `.env`,
-});
-
-program
-  .description("run auth session check")
-  .option("--cdpAddress <cdpAddress>", "CDP address", "http://localhost:9222")
-  .option(
-    "--authSessionPath <authSession>",
-    "auth session to use when executing the check"
-  )
-  .allowUnknownOption()
-  .addArgument(
-    new Argument("<mode>", "mode of execution")
-      .choices(["vanilla", "playwright", "playwright-standalone"])
-      .default("playwright-standalone")
-      .argOptional()
-  )
-  .action(
-    async (
-      mode: "vanilla" | "playwright" | "playwright-standalone",
-      {
-        cdpAddress,
-        authSessionPath,
-      }: { cdpAddress: string; authSessionPath?: string }
-    ) => {
-      const setting = await getSettings();
-      if (!setting.authSessions.enabled) {
-        throw new Error("auth session is not enabled");
-      }
-
-      const checkFilePath = getFullPathInProject(
-        AUTH_SESSIONS_FOLDER_NAME,
-        "check.ts"
-      );
-
-      if (!fs.exists(checkFilePath)) {
-        throw new Error("auth session check file not found");
-      }
-
-      // Dynamically import the TypeScript file
-      const defaultExport = await getDefaultExportFromFile(checkFilePath);
-      const { page, context } = await getPlaywrightConstructsForMode(
-        mode,
-        cdpAddress,
-        authSessionPath
-      );
-
-      const result: boolean = await defaultExport(page, context);
-      console.log("check result", result);
-
-      if (!result) {
-        throw new Error("auth session check failed");
-      }
-
-      process.exit(0);
-    }
-  );
-
-program.parse(process.argv);