revised Chromium launch flags

alixaxel · alixaxel · commit 594c88dab4f9 · 2021-06-07T06:17:32.000+01:00
diff --git a/source/hooks/adblock.ts b/source/hooks/adblock.ts
@@ -6,7 +6,7 @@ let adblocker: any = null;
 
 /**
  * Enables ad blocking in page.
- * Requires `@cliqz/adblocker-puppeteer` package to be installed.
+ * Requires `@cliqz/adblocker-puppeteer` package.
  *
  * @param page - Page to hook to.
  */
diff --git a/source/hooks/agent.ts b/source/hooks/agent.ts
@@ -1,14 +1,16 @@
 import { Page } from 'puppeteer-core';
 
 /**
- * Removes `Headless` from the User Agent string.
+ * Removes `Headless` from the User Agent string, if present.
  *
  * @param page - Page to hook to.
  */
-export = function (page: Page): Promise<Page> {
-  return page
-    .browser()
-    .userAgent()
-    .then((value) => page.setUserAgent(value.replace('Headless', '')))
-    .then(() => page);
+export = async function (page: Page): Promise<Page> {
+  let result = await page.browser().userAgent();
+
+  if (result.includes('Headless') === true) {
+    await page.setUserAgent(result.replace('Headless', ''));
+  }
+
+  return page;
 };
diff --git a/source/hooks/chrome.ts b/source/hooks/chrome.ts
@@ -7,7 +7,7 @@ import { Writeable } from '../../typings/chrome-aws-lambda';
  * @param page - Page to hook to.
  */
 export = async function (page: Page): Promise<Page> {
-  await page.evaluateOnNewDocument(() => {
+  const handler = () => {
     let alpha = Date.now();
     let delta = Math.floor(500 * Math.random());
 
@@ -179,8 +179,11 @@ export = async function (page: Page): Promise<Page> {
           };
         },
       });
-    }
-  });
+    };
+  }
+
+  await page.evaluate(handler);
+  await page.evaluateOnNewDocument(handler);
 
   return page;
 }
diff --git a/source/hooks/languages.ts b/source/hooks/languages.ts
@@ -6,15 +6,18 @@ import { Page } from 'puppeteer-core';
  * @param page - Page to hook to.
  */
 export = async function (page: Page): Promise<Page> {
-  await page.evaluateOnNewDocument(() => {
+  const handler = () => {
     Object.defineProperty(Object.getPrototypeOf(navigator), 'language', {
       get: () => 'en-US',
     });
 
     Object.defineProperty(Object.getPrototypeOf(navigator), 'languages', {
       get: () => ['en-US', 'en'],
     });
-  });
+  };
+
+  await page.evaluate(handler);
+  await page.evaluateOnNewDocument(handler);
 
   return page;
 }
diff --git a/source/hooks/permissions.ts b/source/hooks/permissions.ts
@@ -6,7 +6,7 @@ import { Page } from 'puppeteer-core';
  * @param page - Page to hook to.
  */
 export = async function (page: Page): Promise<Page> {
-  await page.evaluateOnNewDocument(() => {
+  const handler = () => {
     let query = window.navigator.permissions.query;
 
     (Permissions as any).prototype.query = function (parameters: DevicePermissionDescriptor | MidiPermissionDescriptor | PermissionDescriptor | PushPermissionDescriptor) {
@@ -19,7 +19,10 @@ export = async function (page: Page): Promise<Page> {
 
       return query(parameters);
     };
-  });
+  };
+
+  await page.evaluate(handler);
+  await page.evaluateOnNewDocument(handler);
 
   return page;
 }
diff --git a/source/hooks/webdriver.ts b/source/hooks/webdriver.ts
@@ -6,9 +6,14 @@ import { Page } from 'puppeteer-core';
  * @param page - Page to hook to.
  */
 export = async function (page: Page): Promise<Page> {
-  await page.evaluateOnNewDocument(() => {
-    delete Object.getPrototypeOf(navigator).webdriver;
-  });
+  const handler = () => {
+    Object.defineProperty(Object.getPrototypeOf(navigator), 'webdriver', {
+      get: () => false,
+    });
+  };
+
+  await page.evaluate(handler);
+  await page.evaluateOnNewDocument(handler);
 
   return page;
 }
diff --git a/source/hooks/window.ts b/source/hooks/window.ts
@@ -1,24 +1,47 @@
 import { Page } from 'puppeteer-core';
 
 /**
- * Patches `outerHeight` and `outerWidth` to mimic headful Chrome.
+ * Patches window outer dimentions to mimic headful Chrome.
  *
  * @param page - Page to hook to.
  */
 export = async function (page: Page): Promise<Page> {
-  await page.evaluateOnNewDocument(() => {
+  const handler = () => {
+    if (window.outerWidth === 0) {
+      Object.defineProperty(window, 'outerWidth', {
+        get: () => screen.availWidth,
+      });
+    }
+
     if (window.outerHeight === 0) {
       Object.defineProperty(window, 'outerHeight', {
-        get: () => window.innerHeight,
+        get: () => screen.availHeight,
       });
     }
 
-    if (window.outerWidth === 0) {
-      Object.defineProperty(window, 'outerWidth', {
-        get: () => window.innerWidth,
+    if (window.screenX === 0) {
+      Object.defineProperty(window, 'screenX', {
+        get: () => screen.width - screen.availWidth,
+      });
+
+      Object.defineProperty(window, 'screenLeft', {
+        get: () => screenX,
       });
     }
-  });
+
+    if (window.screenY === 0) {
+      Object.defineProperty(window, 'screenY', {
+        get: () => screen.height - screen.availHeight,
+      });
+
+      Object.defineProperty(window, 'screenTop', {
+        get: () => screenY,
+      });
+    }
+  };
+
+  await page.evaluate(handler);
+  await page.evaluateOnNewDocument(handler);
 
   return page;
 }
diff --git a/source/index.ts b/source/index.ts
@@ -88,53 +88,39 @@ class Chromium {
   }
 
   /**
-   * Returns a list of recommended additional Chromium flags.
+   * Returns a list of additional Chromium flags recommended for serverless environments.
+   * The canonical list of flags can be found on https://peter.sh/experiments/chromium-command-line-switches/.
    */
   static get args(): string[] {
     const result = [
-      '--autoplay-policy=user-gesture-required',
-      '--disable-background-networking',
-      '--disable-background-timer-throttling',
-      '--disable-backgrounding-occluded-windows',
-      '--disable-breakpad',
-      '--disable-client-side-phishing-detection',
-      '--disable-component-update',
-      '--disable-default-apps',
-      '--disable-dev-shm-usage',
-      '--disable-domain-reliability',
-      '--disable-extensions',
-      '--disable-features=AudioServiceOutOfProcess,IsolateOrigins,site-per-process',
-      '--disable-hang-monitor',
-      '--disable-ipc-flooding-protection',
-      '--disable-offer-store-unmasked-wallet-cards',
-      '--disable-popup-blocking',
-      '--disable-print-preview',
-      '--disable-prompt-on-repost',
-      '--disable-renderer-backgrounding',
-      '--disable-setuid-sandbox',
-      '--disable-speech-api',
-      '--disable-sync',
-      '--disable-web-security',
-      '--disk-cache-size=33554432',
-      '--hide-scrollbars',
-      '--ignore-gpu-blocklist',
-      '--metrics-recording-only',
-      '--mute-audio',
-      '--no-default-browser-check',
-      '--no-first-run',
-      '--no-pings',
-      '--no-sandbox',
-      '--no-zygote',
-      '--password-store=basic',
-      '--use-gl=swiftshader',
-      '--use-mock-keychain',
-      '--window-size=1920,1080',
+      '--allow-running-insecure-content', // https://source.chromium.org/search?q=lang:cpp+symbol:kAllowRunningInsecureContent&ss=chromium
+      '--autoplay-policy=user-gesture-required', // https://source.chromium.org/search?q=lang:cpp+symbol:kAutoplayPolicy&ss=chromium
+      '--disable-component-update', // https://source.chromium.org/search?q=lang:cpp+symbol:kDisableComponentUpdate&ss=chromium
+      '--disable-domain-reliability', // https://source.chromium.org/search?q=lang:cpp+symbol:kDisableDomainReliability&ss=chromium
+      '--disable-features=AudioServiceOutOfProcess,IsolateOrigins,site-per-process', // https://source.chromium.org/search?q=file:content_features.cc&ss=chromium
+      '--disable-print-preview', // https://source.chromium.org/search?q=lang:cpp+symbol:kDisablePrintPreview&ss=chromium
+      '--disable-setuid-sandbox', // https://source.chromium.org/search?q=lang:cpp+symbol:kDisableSetuidSandbox&ss=chromium
+      '--disable-site-isolation-trials', // https://source.chromium.org/search?q=lang:cpp+symbol:kDisableSiteIsolation&ss=chromium
+      '--disable-speech-api', // https://source.chromium.org/search?q=lang:cpp+symbol:kDisableSpeechAPI&ss=chromium
+      '--disable-web-security', // https://source.chromium.org/search?q=lang:cpp+symbol:kDisableWebSecurity&ss=chromium
+      '--disk-cache-size=33554432', // https://source.chromium.org/search?q=lang:cpp+symbol:kDiskCacheSize&ss=chromium
+      '--enable-features=SharedArrayBuffer', // https://source.chromium.org/search?q=file:content_features.cc&ss=chromium
+      '--hide-scrollbars', // https://source.chromium.org/search?q=lang:cpp+symbol:kHideScrollbars&ss=chromium
+      '--ignore-gpu-blocklist', // https://source.chromium.org/search?q=lang:cpp+symbol:kIgnoreGpuBlocklist&ss=chromium
+      '--in-process-gpu', // https://source.chromium.org/search?q=lang:cpp+symbol:kInProcessGPU&ss=chromium
+      '--mute-audio', // https://source.chromium.org/search?q=lang:cpp+symbol:kMuteAudio&ss=chromium
+      '--no-default-browser-check', // https://source.chromium.org/search?q=lang:cpp+symbol:kNoDefaultBrowserCheck&ss=chromium
+      '--no-pings', // https://source.chromium.org/search?q=lang:cpp+symbol:kNoPings&ss=chromium
+      '--no-sandbox', // https://source.chromium.org/search?q=lang:cpp+symbol:kNoSandbox&ss=chromium
+      '--no-zygote', // https://source.chromium.org/search?q=lang:cpp+symbol:kNoZygote&ss=chromium
+      '--use-gl=swiftshader', // https://source.chromium.org/search?q=lang:cpp+symbol:kUseGl&ss=chromium
+      '--window-size=1920,1080', // https://source.chromium.org/search?q=lang:cpp+symbol:kWindowSize&ss=chromium
     ];
 
     if (Chromium.headless === true) {
-      result.push('--single-process');
+      result.push('--single-process'); // https://source.chromium.org/search?q=lang:cpp+symbol:kSingleProcess&ss=chromium
     } else {
-      result.push('--start-maximized');
+      result.push('--start-maximized'); // https://source.chromium.org/search?q=lang:cpp+symbol:kStartMaximized&ss=chromium
     }
 
     return result;

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ let adblocker: any = null;`
`6`	`6`
`7`	`7`	`/**`
`8`	`8`	`* Enables ad blocking in page.`
`9`		- * Requires `@cliqz/adblocker-puppeteer` package to be installed.
	`9`	+ * Requires `@cliqz/adblocker-puppeteer` package.
`10`	`10`	`*`
`11`	`11`	`* @param page - Page to hook to.`
`12`	`12`	`*/`