Cleanup dangling chromium processes on exit. Resolves #394

package.json

@@ -11,7 +11,7 @@
     "entrypoint-config": "node dist/src/entrypoint-config.js",
     "build": "rimraf dist && tsc",
     "lint": "tsc --noEmit && eslint .",
-    "docker:build": "docker build . -t charlocharlie/epicgames-freegames-node:latest --target deploy",
+    "docker:build": "docker build . -t charlocharlie/epicgames-freegames-node:latest --target deploy --build-arg=\"COMMIT_SHA=$(git rev-parse HEAD)\"",
     "docker:build-debian": "docker build . -t charlocharlie/epicgames-freegames-node:debian --target deploy --file Dockerfile.debian",
     "docker:build-dev": "docker build . -t charlocharlie/epicgames-freegames:dev --target deploy",
     "docker:run": "docker run --rm -ti -v $(pwd)/config:/usr/app/config -p 3000:3000 -p 3001:3001 -e DEBUG=puppeteer-extra-plugin:portal* charlocharlie/epicgames-freegames-node:latest",

src/common/puppeteer.ts

@@ -8,6 +8,7 @@ import pidtree from 'pidtree';
 import findProcess from 'find-process';
 import { ETCCookie, ToughCookieFileStore } from './cookie.js';
 import { config } from './config/index.js';
+import { getCommitSha } from '../version.js';
 
 const puppeteer = _puppeteer as unknown as PuppeteerExtra;
 const stealth = StealthPlugin();
@@ -154,7 +155,7 @@ const retryFunction = async <T>(
     chromiumProcesses.forEach((p) => process.kill(p.pid));
     if (attempts >= MAX_ATTEMPTS) {
       L.error(
-        `If not already, consider using the Debian (:bullseye-slim) version of the image. More: https://github.com/claabs/epicgames-freegames-node#docker-configuration`,
+        `If not already, consider using the Debian (:debian) version of the image. More: https://github.com/claabs/epicgames-freegames-node#docker-configuration`,
       );
       throw new Error(`Could not do ${outputName} after ${MAX_ATTEMPTS + 1} failed attempts.`);
     }
@@ -166,6 +167,20 @@ const retryFunction = async <T>(
   }
 };
 
+export const killBrowserProcesses = async (L: Logger) => {
+  if (!getCommitSha()) return; // Don't kill processes if not in docker
+  const afterProcesses = await pidtree(process.pid);
+  const newProcesses = await Promise.all(
+    afterProcesses.map(async (p) => (await findProcess('pid', p))[0]),
+  );
+  const browserProcesses = newProcesses.filter(
+    (p): p is NonNullable<typeof p> =>
+      p !== undefined && ['chromium', 'chrome', 'headless_shell'].some((n) => p.name.includes(n)),
+  );
+  L.debug({ browserProcesses }, 'Killing dangling browser processes');
+  browserProcesses.forEach((p) => process.kill(p.pid));
+};
+
 /**
  * Create a new page within a wrapper that will retry if it hangs for 30 seconds
  */

src/index.ts

@@ -5,7 +5,7 @@ import logger from './common/logger.js';
 import { sendNotification, testNotifiers } from './notify.js';
 import { checkForUpdate, logVersionOnError } from './version.js';
 import PuppetLogin from './puppet/login.js';
-import { safeLaunchBrowser } from './common/puppeteer.js';
+import { killBrowserProcesses, safeLaunchBrowser } from './common/puppeteer.js';
 import PuppetFreeGames from './puppet/free-games.js';
 import { createServer } from './common/server.js';
 import { convertImportCookies } from './common/cookie.js';
@@ -84,13 +84,15 @@ export async function main(): Promise<void> {
     );
     await Promise.all(accountPromises);
     server.close();
+    await killBrowserProcesses(logger);
     logger.info('Exiting successfully');
     exit(0); // For some reason, puppeteer will keep a zombie promise alive and stop Node from exiting
   }
 }
 
-main().catch((err) => {
+main().catch(async (err) => {
   logger.error(err);
+  await killBrowserProcesses(logger);
   logVersionOnError();
   exit(1);
 });

src/version.ts

@@ -43,6 +43,10 @@ export async function checkForUpdate(): Promise<void> {
   }
 }
 
+export const getCommitSha = () => {
+  return COMMIT_SHA;
+};
+
 export function logVersionOnError(): void {
   if (COMMIT_SHA || BRANCH || DISTRO) {
     L.warn({ COMMIT_SHA, BRANCH, DISTRO }, 'Current version');