@elastic/synthetics 1.0.0-beta.2 → 1.0.0-beta.22

package/src/core/gatherer.ts

@@ -23,23 +23,11 @@
  *
  */
 
-import {
-  CDPSession,
-  chromium,
-  ChromiumBrowser,
-  ChromiumBrowserContext,
-  Page,
-} from 'playwright-chromium';
+import { chromium, ChromiumBrowser, BrowserContext } from 'playwright-chromium';
 import { PluginManager } from '../plugins';
 import { RunOptions } from './runner';
 import { log } from './logger';
-
-export type Driver = {
-  browser: ChromiumBrowser;
-  context: ChromiumBrowserContext;
-  page: Page;
-  client: CDPSession;
-};
+import { Driver } from '../common_types';
 
 /**
  * Purpose of the Gatherer is to set up the necessary browser driver
@@ -49,36 +37,72 @@ export class Gatherer {
   static browser: ChromiumBrowser;
 
   static async setupDriver(options: RunOptions): Promise<Driver> {
+    log('Gatherer: setup driver');
+    const { wsEndpoint, playwrightOptions, networkConditions } = options;
+
     if (Gatherer.browser == null) {
-      const { wsEndpoint, headless, sandbox = false } = options;
       if (wsEndpoint) {
         log(`Gatherer: connecting to WS endpoint: ${wsEndpoint}`);
-        Gatherer.browser = await chromium.connect({ wsEndpoint });
+        Gatherer.browser = await chromium.connect(wsEndpoint);
       } else {
         Gatherer.browser = await chromium.launch({
-          headless,
-          chromiumSandbox: sandbox,
+          ...playwrightOptions,
+          args: [
+            ...(playwrightOptions?.headless ? ['--disable-gpu'] : []),
+            ...(playwrightOptions?.args ?? []),
+          ],
         });
       }
     }
-    const context = await Gatherer.browser.newContext();
+    const context = await Gatherer.browser.newContext({
+      ...playwrightOptions,
+      userAgent: await Gatherer.getUserAgent(playwrightOptions?.userAgent),
+    });
+    await Gatherer.setNetworkConditions(context, networkConditions);
+
     const page = await context.newPage();
     const client = await context.newCDPSession(page);
     return { browser: Gatherer.browser, context, page, client };
   }
 
+  static async getUserAgent(userAgent?: string) {
+    const syntheticsIdentifier = ' Elastic/Synthetics';
+    if (!userAgent) {
+      const session = await Gatherer.browser.newBrowserCDPSession();
+      ({ userAgent } = await session.send('Browser.getVersion'));
+    }
+    return userAgent + syntheticsIdentifier;
+  }
+
+  static async setNetworkConditions(
+    context: BrowserContext,
+    networkConditions: RunOptions['networkConditions']
+  ) {
+    if (networkConditions) {
+      context.on('page', async page => {
+        const context = page.context();
+        const client = await context.newCDPSession(page);
+        await client.send(
+          'Network.emulateNetworkConditions',
+          networkConditions
+        );
+      });
+    }
+  }
+
   /**
    * Starts recording all events related to the v8 devtools protocol
    * https://chromedevtools.github.io/devtools-protocol/v8/
    */
   static async beginRecording(driver: Driver, options: RunOptions) {
     log('Gatherer: started recording');
-    const { filmstrips, network, metrics } = options;
+    const { network, metrics } = options;
     const pluginManager = new PluginManager(driver);
-    pluginManager.start('browserconsole');
-    filmstrips && (await pluginManager.start('trace'));
-    network && (await pluginManager.start('network'));
-    metrics && (await pluginManager.start('performance'));
+    pluginManager.registerAll(options);
+    const plugins = [await pluginManager.start('browserconsole')];
+    network && plugins.push(await pluginManager.start('network'));
+    metrics && plugins.push(await pluginManager.start('performance'));
+    await Promise.all(plugins);
     return pluginManager;
   }
 

package/src/core/index.ts

@@ -25,7 +25,7 @@
 
 import { Journey, JourneyCallback, JourneyOptions } from '../dsl';
 import Runner from './runner';
-import { VoidCallback } from '../common_types';
+import { VoidCallback, HooksCallback } from '../common_types';
 import { log } from './logger';
 
 /**
@@ -43,7 +43,7 @@ export const journey = (
   options: JourneyOptions | string,
   callback: JourneyCallback
 ) => {
-  log(`register journey: ${options}`);
+  log(`register journey: ${JSON.stringify(options)}`);
   if (typeof options === 'string') {
     options = { name: options, id: options };
   }
@@ -57,22 +57,22 @@ export const step = (name: string, callback: VoidCallback) => {
   return runner.currentJourney?.addStep(name, callback);
 };
 
-export const beforeAll = (callback: VoidCallback) => {
+export const beforeAll = (callback: HooksCallback) => {
   runner.addHook('beforeAll', callback);
 };
 
-export const afterAll = (callback: VoidCallback) => {
+export const afterAll = (callback: HooksCallback) => {
   runner.addHook('afterAll', callback);
 };
 
-export const before = (callback: VoidCallback) => {
+export const before = (callback: HooksCallback) => {
   if (!runner.currentJourney) {
     throw new Error('before is called outside of the journey context');
   }
   return runner.currentJourney.addHook('before', callback);
 };
 
-export const after = (callback: VoidCallback) => {
+export const after = (callback: HooksCallback) => {
   if (!runner.currentJourney) {
     throw new Error('after is called outside of the journey context');
   }

package/src/core/logger.ts

@@ -23,20 +23,9 @@
  *
  */
 
-import SonicBoom from 'sonic-boom';
 import { grey, cyan, dim, italic } from 'kleur/colors';
 import { now } from '../helpers';
 
-const defaultFd = process.stdout.fd;
-let logger = new SonicBoom({ fd: defaultFd, sync: true });
-
-export const setLogger = (fd: number) => {
-  if (fd && fd !== defaultFd) {
-    logger = new SonicBoom({ fd });
-  }
-  return logger;
-};
-
 export function log(msg) {
   if (!process.env.DEBUG || !msg) {
     return;
@@ -45,5 +34,5 @@ export function log(msg) {
     msg = JSON.stringify(msg);
   }
   const time = dim(cyan(`at ${parseInt(String(now()))} ms `));
-  logger.write(time + italic(grey(msg)) + '\n');
+  console.log(time + italic(grey(msg)) + '\n');
 }