Stop runner from hanging indefinitely within ubuntu docker images [elastic/beats#29681] (#441)

* fix: stop runner from hanging indefinitely within ubuntu docker images [elastic/beats#29681]

* fix: enable --disable-gpu flag only for headless runs

Author: lucasfcosta

__tests__/core/gatherer.test.ts

@@ -29,6 +29,7 @@ import { wsEndpoint } from '../utils/test-config';
 import { devices } from 'playwright-chromium';
 import { Server } from '../utils/server';
 import { megabitsToBytes } from '../../src/helpers';
+import { chromium } from 'playwright-chromium';
 
 jest.mock('../../src/plugins/network');
 
@@ -42,12 +43,60 @@ describe('Gatherer', () => {
     await server.close();
   });
 
+  afterEach(() => {
+    jest.restoreAllMocks();
+  });
+
   it('boot and close browser', async () => {
     const driver = await Gatherer.setupDriver({ wsEndpoint });
     expect(typeof driver.page.goto).toBe('function');
     await Gatherer.stop();
   });
 
+  // This test should only run when a browser service is up
+  (wsEndpoint ? it : it.skip)(
+    'does not the disable-gpu flag to start browser when running headful',
+    async () => {
+      const chromiumLaunch = jest
+        .spyOn(chromium, 'launch')
+        .mockImplementation(() => {
+          return chromium.connect({ wsEndpoint });
+        });
+
+      await Gatherer.setupDriver({
+        playwrightOptions: { headless: false },
+      });
+      expect(chromiumLaunch).toHaveBeenCalledWith(
+        expect.objectContaining({
+          args: expect.not.arrayContaining(['--disable-gpu']),
+        })
+      );
+      await Gatherer.stop();
+    }
+  );
+
+  // This test should only run when a browser service is up
+  (wsEndpoint ? it : it.skip)(
+    'uses the disable-gpu flag to start browser when running headlessly',
+    async () => {
+      const chromiumLaunch = jest
+        .spyOn(chromium, 'launch')
+        .mockImplementation(() => {
+          return chromium.connect({ wsEndpoint });
+        });
+
+      await Gatherer.setupDriver({
+        playwrightOptions: { headless: true },
+      });
+      expect(chromiumLaunch).toHaveBeenCalledWith(
+        expect.objectContaining({
+          args: expect.arrayContaining(['--disable-gpu']),
+        })
+      );
+      await Gatherer.stop();
+    }
+  );
+
   it('setup and dispose driver', async () => {
     const driver = await Gatherer.setupDriver({ wsEndpoint });
     await Gatherer.dispose(driver);

src/core/gatherer.ts

@@ -45,7 +45,13 @@ export class Gatherer {
         log(`Gatherer: connecting to WS endpoint: ${wsEndpoint}`);
         Gatherer.browser = await chromium.connect({ wsEndpoint });
       } else {
-        Gatherer.browser = await chromium.launch(playwrightOptions);
+        Gatherer.browser = await chromium.launch({
+          ...playwrightOptions,
+          args: [
+            ...(playwrightOptions?.headless ? ['--disable-gpu'] : []),
+            ...(playwrightOptions?.args ?? []),
+          ],
+        });
       }
     }
     const context = await Gatherer.browser.newContext({