@intuned/runtime-dev 0.1.0-test.11 → 0.1.0-test.13

package/dist/common/getPlaywrightConstructs.js

@@ -1,6 +1,6 @@
 import * as playwright from "@intuned/playwright-core";
 import { existsSync, mkdir, mkdtemp, rm, writeFile, readFile } from "fs-extra";
-import { setContextStorageState } from "./contextStorageStateHelpers";
+import { setContextStorageState, } from "./contextStorageStateHelpers.js";
 import { join } from "path";
 import path from "path";
 import * as fs from "fs-extra";
@@ -8,174 +8,204 @@ import { getFullPathInProject } from "../commands/common/utils/fileUtils";
 import waitOn from "wait-on";
 import { getDownloadDirectoryPath } from "../runtime";
 async function createUserDirWithPreferences() {
-  const playwrightTempDir = await mkdtemp("/tmp/pw-");
-  const userDir = join(playwrightTempDir, "userdir");
-  const defaultDir = join(userDir, "Default");
-  await mkdir(defaultDir, {
-    recursive: true
-  });
-  const preferences = {
-    plugins: {
-      always_open_pdf_externally: true
-    }
-  };
-  await writeFile(join(defaultDir, "Preferences"), JSON.stringify(preferences));
-  return userDir;
-}
-export async function getProductionPlaywrightConstructs({
-  proxy,
-  headless = true,
-  storageState,
-  downloadsPath
-}) {
-  const extraArgs = ["--no-first-run", "--disable-sync", "--disable-translate", "--disable-features=TranslateUI", "--disable-features=NetworkService", "--lang=en"];
-  if (headless) {
-    extraArgs.push("--headless=new");
-  }
-  const executablePath = playwright.chromium.executablePath();
-  const chromium127Path = executablePath.replace("chromium-1117", "chromium-1124");
-  const isChrome127There = existsSync(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 rm(userDataDir, {
+    const playwrightTempDir = await mkdtemp("/tmp/pw-");
+    const userDir = join(playwrightTempDir, "userdir");
+    const defaultDir = join(userDir, "Default");
+    await mkdir(defaultDir, {
         recursive: true,
-        force: true,
-        retryDelay: 1000,
-        maxRetries: 5
-      });
-    } catch (error) {
-      console.error("Failed to remove user data dir", error);
-    }
-  });
-  if (storageState) {
-    await loadSessionToContext({
-      context,
-      session: storageState
     });
-  }
-  const assetsFile = path.join(__dirname, "./assets/browser_scripts.js");
-  await context.addInitScript({
-    path: assetsFile
-  });
-  let page = context.pages().at(0);
-  if (page) {
-    const scriptString = await readFile(assetsFile, "utf8");
-    await page.evaluate(scriptString);
-  } else {
-    page = await context.newPage();
-  }
-  return {
-    page,
-    context
-  };
+    const preferences = {
+        plugins: {
+            always_open_pdf_externally: true,
+        },
+    };
+    await writeFile(join(defaultDir, "Preferences"), JSON.stringify(preferences));
+    return userDir;
 }
-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"];
-export async function getPlaywrightConstructsForMode(mode, cdpAddress, authSession) {
-  if (mode == "playwright-standalone") {
-    if (!cdpAddress) {
-      throw new Error("cdpAddress is required");
+export async function getProductionPlaywrightConstructs({ proxy, headless = true, storageState, downloadsPath, }) {
+    const extraArgs = [
+        "--no-first-run",
+        "--disable-sync",
+        "--disable-translate",
+        "--disable-features=TranslateUI",
+        "--disable-features=NetworkService",
+        "--lang=en",
+    ];
+    if (headless) {
+        extraArgs.push("--headless=new");
     }
-    const {
-      context
-    } = await getRemotePlaywrightContext(cdpAddress);
-    if (!context) {
-      throw new Error("no context found");
+    const executablePath = playwright.chromium.executablePath();
+    // use chromium 127 instead of 125, this depends on the docker image playwright version.
+    const chromium127Path = executablePath.replace("chromium-1117", "chromium-1124");
+    const isChrome127There = existsSync(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 rm(userDataDir, {
+                recursive: true,
+                force: true,
+                retryDelay: 1000,
+                maxRetries: 5,
+            });
+        }
+        catch (error) {
+            console.error("Failed to remove user data dir", error);
+        }
+    });
+    if (storageState) {
+        await loadSessionToContext({ context, session: storageState });
     }
-    const assetsFile = path.join(__dirname, "./assets/browser_scripts.js");
+    const assetsFile = path.join(path.dirname(import.meta.url), "./assets/browser_scripts.js");
     await context.addInitScript({
-      path: assetsFile
+        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 {
-      page = await context.newPage();
+    let page = context.pages().at(0);
+    if (page) {
+        const scriptString = await readFile(assetsFile, "utf8");
+        await page.evaluate(scriptString);
     }
-    if (authSession) {
-      await loadSessionToContext({
-        context,
-        session: authSession
-      });
+    else {
+        page = await context.newPage();
     }
     return {
-      page,
-      context
+        page,
+        context,
     };
-  }
-  const downloadsPath = 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
-      });
+}
+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",
+];
+export async function getPlaywrightConstructsForMode(mode, cdpAddress, authSession) {
+    if (mode == "playwright-standalone") {
+        if (!cdpAddress) {
+            throw new Error("cdpAddress is required");
+        }
+        const { context } = await getRemotePlaywrightContext(cdpAddress);
+        if (!context) {
+            throw new Error("no context found");
+        }
+        const assetsFile = path.join(path.dirname(import.meta.url), "./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 {
+            page = await context.newPage();
+        }
+        if (authSession) {
+            await loadSessionToContext({ context, session: authSession });
+        }
+        return {
+            page,
+            context,
+        };
     }
-    return {
-      ...productionConstructs
-    };
-  }
-  throw "invalid mode";
+    const downloadsPath = 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,
+            });
+        }
+        return {
+            ...productionConstructs,
+        };
+    }
+    throw "invalid mode";
 }
-export async function loadSessionToContext({
-  context,
-  session
-}) {
-  let sessionToLoad;
-  if (session.type === "state") {
-    sessionToLoad = session.state;
-  } else {
-    const fullPath = getFullPathInProject(session.path);
-    sessionToLoad = await fs.readJson(fullPath);
-  }
-  await setContextStorageState(context, sessionToLoad);
+export async function loadSessionToContext({ context, session, }) {
+    let sessionToLoad;
+    if (session.type === "state") {
+        sessionToLoad = session.state;
+    }
+    else {
+        const fullPath = getFullPathInProject(session.path);
+        sessionToLoad = await fs.readJson(fullPath);
+    }
+    await setContextStorageState(context, sessionToLoad);
 }
 export async function getRemotePlaywrightContext(cdpAddress) {
-  const playwright = await import("@intuned/playwright-core");
-  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 waitOn({
-      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);
-  }
-  try {
-    browser = await playwright.chromium.connectOverCDP(cdpAddress);
-  } catch (e) {
-    console.log(e);
-    throw new Error("failed to connect to the browser");
-  }
-  const context = browser.contexts()[0];
-  return {
-    browser,
-    context
-  };
-}
+    const playwright = await import("@intuned/playwright-core");
+    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 waitOn({
+            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");
+        // 128 is the exit code for SIGINT https://tldp.org/LDP/abs/html/exitcodes.html
+        // 9 is the SIGKILL signal
+        process.exit(128 + 9);
+    }
+    try {
+        browser = await playwright.chromium.connectOverCDP(cdpAddress);
+    }
+    catch (e) {
+        console.log(e);
+        throw new Error("failed to connect to the browser");
+    }
+    const context = browser.contexts()[0];
+    return { browser, context };
+}

package/dist/common/getPlaywrightConstructs.ts

@@ -0,0 +1,181 @@
+import * as playwright from "@intuned/playwright-core";
+import { existsSync, mkdir, mkdtemp, rm, writeFile, readFile } from "fs-extra";
+import { setContextStorageState } from "./contextStorageStateHelpers.js";
+import { join } from "path";
+import path from "path";
+import * as fs from "fs-extra";
+import { getFullPathInProject } from "../commands/common/utils/fileUtils";
+import waitOn from "wait-on";
+import { getDownloadDirectoryPath } from "../runtime";
+async function createUserDirWithPreferences() {
+  const playwrightTempDir = await mkdtemp("/tmp/pw-");
+  const userDir = join(playwrightTempDir, "userdir");
+  const defaultDir = join(userDir, "Default");
+  await mkdir(defaultDir, {
+    recursive: true
+  });
+  const preferences = {
+    plugins: {
+      always_open_pdf_externally: true
+    }
+  };
+  await writeFile(join(defaultDir, "Preferences"), JSON.stringify(preferences));
+  return userDir;
+}
+export async function getProductionPlaywrightConstructs({
+  proxy,
+  headless = true,
+  storageState,
+  downloadsPath
+}) {
+  const extraArgs = ["--no-first-run", "--disable-sync", "--disable-translate", "--disable-features=TranslateUI", "--disable-features=NetworkService", "--lang=en"];
+  if (headless) {
+    extraArgs.push("--headless=new");
+  }
+  const executablePath = playwright.chromium.executablePath();
+  const chromium127Path = executablePath.replace("chromium-1117", "chromium-1124");
+  const isChrome127There = existsSync(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 rm(userDataDir, {
+        recursive: true,
+        force: true,
+        retryDelay: 1000,
+        maxRetries: 5
+      });
+    } catch (error) {
+      console.error("Failed to remove user data dir", error);
+    }
+  });
+  if (storageState) {
+    await loadSessionToContext({
+      context,
+      session: storageState
+    });
+  }
+  const assetsFile = path.join(path.dirname(import.meta.url), "./assets/browser_scripts.js");
+  await context.addInitScript({
+    path: assetsFile
+  });
+  let page = context.pages().at(0);
+  if (page) {
+    const scriptString = await readFile(assetsFile, "utf8");
+    await page.evaluate(scriptString);
+  } else {
+    page = await context.newPage();
+  }
+  return {
+    page,
+    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"];
+export async function getPlaywrightConstructsForMode(mode, cdpAddress, authSession) {
+  if (mode == "playwright-standalone") {
+    if (!cdpAddress) {
+      throw new Error("cdpAddress is required");
+    }
+    const {
+      context
+    } = await getRemotePlaywrightContext(cdpAddress);
+    if (!context) {
+      throw new Error("no context found");
+    }
+    const assetsFile = path.join(path.dirname(import.meta.url), "./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 {
+      page = await context.newPage();
+    }
+    if (authSession) {
+      await loadSessionToContext({
+        context,
+        session: authSession
+      });
+    }
+    return {
+      page,
+      context
+    };
+  }
+  const downloadsPath = 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
+      });
+    }
+    return {
+      ...productionConstructs
+    };
+  }
+  throw "invalid mode";
+}
+export async function loadSessionToContext({
+  context,
+  session
+}) {
+  let sessionToLoad;
+  if (session.type === "state") {
+    sessionToLoad = session.state;
+  } else {
+    const fullPath = getFullPathInProject(session.path);
+    sessionToLoad = await fs.readJson(fullPath);
+  }
+  await setContextStorageState(context, sessionToLoad);
+}
+export async function getRemotePlaywrightContext(cdpAddress) {
+  const playwright = await import("@intuned/playwright-core");
+  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 waitOn({
+      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);
+  }
+  try {
+    browser = await playwright.chromium.connectOverCDP(cdpAddress);
+  } catch (e) {
+    console.log(e);
+    throw new Error("failed to connect to the browser");
+  }
+  const context = browser.contexts()[0];
+  return {
+    browser,
+    context
+  };
+}