feat: set default headless mode (#239)

* set default headless mode * update headless parameter
ChainSafe · Jan 13, 2023 · 9fcb540 · 9fcb540
1 parent 0a8d442
commit 9fcb540
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 20 deletions.
diff --git a/src/setup/index.ts b/src/setup/index.ts
@@ -18,7 +18,10 @@ export const bootstrap = async ({
   browser: DappeteerBrowser;
   metaMaskPage: DappeteerPage;
 }> => {
-  const browser = await launch(launchOptions);
+  const browser = await launch({
+    headless: true,
+    ...launchOptions,
+  });
   const metaMask = await setupMetaMask(browser, {
     seed,
     password,
@@ -43,6 +46,7 @@ export const initSnapEnv = async (
   snapId: string;
 }> => {
   const browser = await launch({
+    headless: true,
     ...opts,
     metaMaskFlask: true,
   });

diff --git a/src/setup/launch.ts b/src/setup/launch.ts
@@ -37,9 +37,11 @@ export async function launch(
       );
     else
       console.log(
-        `Running tests on MetaMask version ${metaMaskVersion} (flask: ${String(
-          options.metaMaskFlask ?? false
-        )})`
+        `
+        Running tests on MetaMask version ${metaMaskVersion} 
+        Flask version: ${String(options.metaMaskFlask ?? false)}, 
+        Headless: ${String(options.headless)}
+        `
       );
 
     console.warn(); // new line

diff --git a/src/setup/playwright.ts b/src/setup/playwright.ts
@@ -19,12 +19,12 @@ export async function launchPlaywright(
       await import("playwright")
     ).chromium.launchPersistentContext(tmpdir, {
       ...(options.playwrightOptions ?? {}),
-      headless: options.playwrightOptions?.headless,
+      headless: options.headless,
       args: [
         `--disable-extensions-except=${metamaskPath}`,
         `--load-extension=${metamaskPath}`,
         ...(options.playwrightOptions?.args || []),
-        ...(options.puppeteerOptions?.headless ? ["--headless=chrome"] : []),
+        ...(options.headless ? ["--headless=chrome"] : []),
       ],
     });
   }

diff --git a/src/setup/puppeteer.ts b/src/setup/puppeteer.ts
@@ -9,12 +9,12 @@ export async function launchPuppeteer(
     await import("puppeteer")
   ).default.launch({
     ...(options.puppeteerOptions ?? {}),
-    headless: options.puppeteerOptions?.headless,
+    headless: options.headless,
     args: [
       `--disable-extensions-except=${metamaskPath}`,
       `--load-extension=${metamaskPath}`,
       ...(options.puppeteerOptions?.args || []),
-      ...(options.puppeteerOptions?.headless ? ["--headless=chrome"] : []),
+      ...(options.headless ? ["--headless=chrome"] : []),
     ],
   });
   const { DPuppeteerBrowser } = await import("../puppeteer");

diff --git a/src/types.ts b/src/types.ts
@@ -21,6 +21,7 @@ export type DappeteerLaunchOptions = {
   //fallbacks to installed dependency and prefers playwright if both are installed
   automation?: "puppeteer" | "playwright";
   browser: "chrome";
+  headless?: boolean; // default true
   puppeteerOptions?: Parameters<typeof puppeteerLaunch>[0];
   playwrightOptions?: PlaywrightLaunchOptions;
 };

diff --git a/test/global.ts b/test/global.ts
@@ -29,12 +29,6 @@ export const mochaHooks = {
       browser: "chrome",
       metaMaskVersion:
         process.env.METAMASK_VERSION || dappeteer.RECOMMENDED_METAMASK_VERSION,
-      playwrightOptions: {
-        headless: true,
-      },
-      puppeteerOptions: {
-        headless: true,
-      },
     });
 
     // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment

diff --git a/test/global_flask.ts b/test/global_flask.ts
@@ -27,12 +27,6 @@ export const mochaHooks = {
       metaMaskVersion:
         process.env.METAMASK_VERSION || dappeteer.RECOMMENDED_METAMASK_VERSION,
       metaMaskFlask: true,
-      playwrightOptions: {
-        headless: true,
-      },
-      puppeteerOptions: {
-        headless: true,
-      },
     });
 
     const snapServers = await buildSnaps();