Externalize puppeteer launchArgs. Add --disable-dev-shm-usage. #164, #…

…166

src/common/puppeteer.ts

@@ -90,3 +90,16 @@ export function getDevtoolsUrl(page: Page): string {
   // devtools://devtools/bundled/inspector.html?ws=127.0.0.1:35871/devtools/page/2B4E5714B42640A1C61AB9EE7E432730
   return `devtools://devtools/bundled/inspector.html?ws=${wsEndpoint.host}/devtools/page/${targetId}`;
 }
+
+export const launchArgs: Parameters<typeof puppeteer.launch>[0] = {
+  headless: true,
+  args: [
+    '--disable-web-security', // For accessing iframes
+    '--disable-features=IsolateOrigins,site-per-process', // For accessing iframes
+    '--no-sandbox', // For Docker root user
+    '--disable-dev-shm-usage', // https://github.com/puppeteer/puppeteer/blob/main/docs/troubleshooting.md#tips
+    // For debugging in Docker
+    // '--remote-debugging-port=3001',
+    // '--remote-debugging-address=0.0.0.0', // Change devtools url to localhost
+  ],
+};

src/notify.ts

@@ -9,7 +9,7 @@ import {
 } from './common/config';
 import L from './common/logger';
 import { NotificationReason } from './interfaces/notification-reason';
-import puppeteer, { getDevtoolsUrl } from './common/puppeteer';
+import puppeteer, { getDevtoolsUrl, launchArgs } from './common/puppeteer';
 
 export async function sendNotification(
   url: string,
@@ -51,14 +51,7 @@ export async function sendNotification(
 
 export async function testNotifiers(): Promise<void> {
   L.info('Testing all configured notifiers');
-  const browser = await puppeteer.launch({
-    headless: true,
-    args: [
-      '--disable-web-security',
-      '--disable-features=IsolateOrigins,site-per-process',
-      '--no-sandbox',
-    ],
-  });
+  const browser = await puppeteer.launch(launchArgs);
   const page = await browser.newPage();
   L.trace(getDevtoolsUrl(page));
   await page.goto('https://claabs.github.io/epicgames-freegames-node/test.html');

src/puppet/hcaptcha.ts

@@ -1,7 +1,7 @@
 import fs from 'fs-extra';
 import { ElementHandle, Protocol } from 'puppeteer';
 import path from 'path';
-import puppeteer, { getDevtoolsUrl } from '../common/puppeteer';
+import puppeteer, { getDevtoolsUrl, launchArgs } from '../common/puppeteer';
 import { config, CONFIG_DIR } from '../common/config';
 import L from '../common/logger';
 
@@ -43,7 +43,7 @@ export const getHcaptchaCookies = async (): Promise<Protocol.Network.Cookie[]> =
   if (!cookieData) {
     try {
       L.debug('Setting hCaptcha accessibility cookies');
-      const browser = await puppeteer.launch({ headless: true, args: ['--no-sandbox'] });
+      const browser = await puppeteer.launch(launchArgs);
       const page = await browser.newPage();
 
       L.trace(getDevtoolsUrl(page));

src/puppet/login.ts

@@ -5,6 +5,7 @@ import { Protocol, ElementHandle, Page } from 'puppeteer';
 import logger from '../common/logger';
 import puppeteer, {
   getDevtoolsUrl,
+  launchArgs,
   toughCookieFileStoreToPuppeteerCookie,
 } from '../common/puppeteer';
 import { getCookiesRaw, setPuppeteerCookies } from '../common/request';
@@ -67,17 +68,7 @@ export default class PuppetLogin {
     const userCookies = await getCookiesRaw(this.email);
     const puppeteerCookies = toughCookieFileStoreToPuppeteerCookie(userCookies);
     this.L.debug('Logging in with puppeteer');
-    const browser = await puppeteer.launch({
-      headless: true,
-      args: [
-        '--disable-web-security',
-        '--disable-features=IsolateOrigins,site-per-process',
-        '--no-sandbox',
-        // For debugging in Docker
-        // '--remote-debugging-port=3001',
-        // '--remote-debugging-address=0.0.0.0', // Change devtools url to localhost
-      ],
-    });
+    const browser = await puppeteer.launch(launchArgs);
     const page = await browser.newPage();
     this.L.trace(getDevtoolsUrl(page));
     const cdpClient = await page.target().createCDPSession();

src/puppet/purchase.ts

@@ -4,6 +4,7 @@ import { Protocol, ElementHandle } from 'puppeteer';
 import logger from '../common/logger';
 import puppeteer, {
   getDevtoolsUrl,
+  launchArgs,
   toughCookieFileStoreToPuppeteerCookie,
 } from '../common/puppeteer';
 import { getCookiesRaw, setPuppeteerCookies } from '../common/request';
@@ -30,14 +31,7 @@ export default class PuppetPurchase {
     const userCookies = await getCookiesRaw(this.email);
     const puppeteerCookies = toughCookieFileStoreToPuppeteerCookie(userCookies);
     this.L.debug('Purchasing with puppeteer');
-    const browser = await puppeteer.launch({
-      headless: true,
-      args: [
-        '--disable-web-security',
-        '--disable-features=IsolateOrigins,site-per-process',
-        '--no-sandbox',
-      ],
-    });
+    const browser = await puppeteer.launch(launchArgs);
     const page = await browser.newPage();
     this.L.trace(getDevtoolsUrl(page));
     const cdpClient = await page.target().createCDPSession();
@@ -113,14 +107,7 @@ export default class PuppetPurchase {
     const userCookies = await getCookiesRaw(this.email);
     const puppeteerCookies = toughCookieFileStoreToPuppeteerCookie(userCookies);
     this.L.debug('Purchasing with puppeteer (short)');
-    const browser = await puppeteer.launch({
-      headless: true,
-      args: [
-        '--disable-web-security',
-        '--disable-features=IsolateOrigins,site-per-process',
-        '--no-sandbox',
-      ],
-    });
+    const browser = await puppeteer.launch(launchArgs);
     const page = await browser.newPage();
     this.L.trace(getDevtoolsUrl(page));
     const cdpClient = await page.target().createCDPSession();

test/notify.test.ts

@@ -1,14 +1,11 @@
-import puppeteer from '../src/common/puppeteer';
+import puppeteer, { launchArgs } from '../src/common/puppeteer';
 import { NotificationReason } from '../src/interfaces/notification-reason';
 import { sendNotification } from '../src/notify';
 
 jest.setTimeout(1000000);
 describe('Create account and redeem free games', () => {
   it('should open a portal and notify', async () => {
-    const browser = await puppeteer.launch({
-      headless: true,
-      args: ['--disable-web-security', '--disable-features=IsolateOrigins,site-per-process'],
-    });
+    const browser = await puppeteer.launch(launchArgs);
     const page = await browser.newPage();
     await page.goto('https://google.com');
     const url = await page.openPortal();

test/util/puppet-account.ts

@@ -10,6 +10,7 @@ import { getHcaptchaCookies } from '../../src/puppet/hcaptcha';
 import puppeteer, {
   toughCookieFileStoreToPuppeteerCookie,
   getDevtoolsUrl,
+  launchArgs,
 } from '../../src/common/puppeteer';
 import logger from '../../src/common/logger';
 import Smtp4Dev from './smtp4dev';
@@ -83,10 +84,7 @@ export default class AccountManager {
     const userCookies = await getCookiesRaw(this.email);
     const puppeteerCookies = toughCookieFileStoreToPuppeteerCookie(userCookies);
     this.L.debug('Logging in with puppeteer');
-    const browser = await puppeteer.launch({
-      headless: true,
-      args: ['--disable-web-security', '--disable-features=IsolateOrigins,site-per-process'],
-    });
+    const browser = await puppeteer.launch(launchArgs);
     const page = await browser.newPage();
     this.L.trace(getDevtoolsUrl(page));
     const cdpClient = await page.target().createCDPSession();
@@ -145,10 +143,7 @@ export default class AccountManager {
     const userCookies = await getCookiesRaw(this.email);
     const puppeteerCookies = toughCookieFileStoreToPuppeteerCookie(userCookies);
     this.L.debug('Logging in with puppeteer');
-    const browser = await puppeteer.launch({
-      headless: true,
-      args: ['--disable-web-security', '--disable-features=IsolateOrigins,site-per-process'],
-    });
+    const browser = await puppeteer.launch(launchArgs);
     const page = await browser.newPage();
     this.L.trace(getDevtoolsUrl(page));
     const cdpClient = await page.target().createCDPSession();