@elastic/synthetics 1.0.0-beta.15 → 1.0.0-beta.19

package/src/cli.ts

@@ -126,6 +126,25 @@ async function prepareSuites(inputs: string[]) {
 }
 
 (async () => {
+  /**
+   * Transform `.ts` files out of the box by invoking
+   * the `ts-node` via `transpile-only` mode that compiles
+   * TS files without doing any extensive type checks.
+   *
+   * We must register `ts-node` _before_ loading inline
+   * scripts too because otherwise we will not be able to
+   * require `.ts` configuration files.
+   */
+  /* eslint-disable-next-line @typescript-eslint/no-var-requires */
+  require('ts-node').register({
+    transpileOnly: true,
+    compilerOptions: {
+      esModuleInterop: true,
+      allowJs: true,
+      target: 'es2018',
+    },
+  });
+
   if (options.inline) {
     const source = await readStdin();
     loadInlineScript(source);
@@ -141,20 +160,6 @@ async function prepareSuites(inputs: string[]) {
         throw new Error(`cannot find module '${name}'`);
       }
     }
-    /**
-     * Transform `.ts` files out of the box by invoking
-     * the `ts-node` via `transpile-only` mode that compiles
-     * TS files without doing any extensive type checks
-     */
-    /* eslint-disable-next-line @typescript-eslint/no-var-requires */
-    require('ts-node').register({
-      transpileOnly: true,
-      compilerOptions: {
-        esModuleInterop: true,
-        allowJs: true,
-        target: 'es2018',
-      },
-    });
     /**
      * Handle piped files by reading the STDIN
      * ex: ls example/suites/*.js | npx @elastic/synthetics
@@ -174,17 +179,24 @@ async function prepareSuites(inputs: string[]) {
   /**
    * Validate and handle configs
    */
-  const config = readConfig(environment, options.config);
-  const params = merge(
-    config.params,
-    options.suiteParams || {},
-    options.params || {}
-  );
-  const playwrightOptions = merge(config.playwrightOptions, {
-    headless: options.headless,
-    chromiumSandbox: options.sandbox,
-    ignoreHTTPSErrors: options.ignoreHttpsErrors,
-  });
+  const config =
+    options.config || !options.inline
+      ? readConfig(environment, options.config)
+      : {};
+  const params = merge(config.params, options.params || {});
+
+  /**
+   * Favor playwright options passed via cli to inline playwright options
+   */
+  const playwrightOptions = merge.all([
+    config.playwrightOptions || {},
+    options.playwrightOptions || {},
+    {
+      headless: options.headless,
+      chromiumSandbox: options.sandbox,
+      ignoreHTTPSErrors: options.ignoreHttpsErrors,
+    },
+  ]);
 
   const results = await run({
     params: Object.freeze(params),

package/src/common_types.ts

@@ -31,6 +31,7 @@ import {
   ChromiumBrowserContext,
   Page,
 } from 'playwright-chromium';
+import { Protocol } from 'playwright-chromium/types/protocol';
 import { Step } from './dsl';
 import { reporters } from './reporters';
 
@@ -93,45 +94,10 @@ export type BrowserInfo = {
   version: string;
 };
 
-export type SecurityDetails = {
-  issuer?: string;
-  protocol?: string;
-  subjectName?: string;
-  validFrom?: number;
-  validTo?: number;
-};
-
-export type Request = {
-  method: string;
-  url: string;
-  headers: Record<string, string>;
-  // Total size in bytes of the request (body and headers)
-  bytes?: number;
-  body?: {
-    // Size in bytes of the request body
-    bytes: number;
-  };
-  referrer?: string;
-};
-
-export type Response = {
-  url?: string;
-  statusCode: number;
-  statusText?: string;
-  mimeType?: string;
-  httpVersion?: string;
-  headers: Record<string, string>;
-  // Total size in bytes of the response (body and headers)
-  bytes?: number;
-  body?: {
-    // Size in bytes of the response body
-    bytes: number;
-  };
-  transferSize?: number;
-  redirectURL?: string;
-  securityDetails?: SecurityDetails;
-  remoteIPAddress?: string;
-  remotePort?: number;
+export type Screenshot = {
+  timestamp: number;
+  step: Step;
+  data: string;
 };
 
 export type NetworkInfo = {
@@ -139,8 +105,8 @@ export type NetworkInfo = {
   browser: BrowserInfo;
   method: string;
   type: string;
-  request: Request;
-  response?: Response;
+  request: Protocol.Network.Request;
+  response?: Protocol.Network.Response;
   isNavigationRequest: boolean;
   requestSentTime: number;
   loadEndTime: number;
@@ -150,9 +116,10 @@ export type NetworkInfo = {
   transferSize: number;
   timings?: {
     blocked: number;
-    queueing?: number;
+    queueing: number;
     dns: number;
     ssl: number;
+    proxy: number;
     connect: number;
     send: number;
     wait: number;
@@ -203,10 +170,7 @@ export type CliArgs = {
   ignoreHttpsErrors?: boolean;
   params?: Params;
   throttling?: boolean | string;
-  /**
-   * @deprecated use params instead
-   */
-  suiteParams?: Params;
+  playwrightOptions?: LaunchOptions & BrowserContextOptions;
   richEvents?: boolean;
 };
 

package/src/core/gatherer.ts

@@ -37,6 +37,7 @@ 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) {
@@ -44,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({

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');
 }

package/src/core/runner.ts

@@ -48,6 +48,7 @@ import {
   HooksArgs,
   PlaywrightOptions,
   Driver,
+  Screenshot,
 } from '../common_types';
 import { PageMetrics, PluginManager } from '../plugins';
 import { PerformanceManager } from '../plugins';
@@ -73,13 +74,12 @@ export type RunOptions = Omit<
   reporter?: CliArgs['reporter'] | Reporter;
 };
 
-type BaseContext = {
+type HookType = 'beforeAll' | 'afterAll';
+export type SuiteHooks = Record<HookType, Array<HooksCallback>>;
+
+type JourneyContext = {
   params?: Params;
   start: number;
-  end?: number;
-};
-
-type JourneyContext = BaseContext & {
   driver: Driver;
   pluginManager: PluginManager;
 };
@@ -103,8 +103,16 @@ type JourneyResult = {
 
 type RunResult = Record<string, JourneyResult>;
 
-type HookType = 'beforeAll' | 'afterAll';
-export type SuiteHooks = Record<HookType, Array<HooksCallback>>;
+interface StepEvent {
+  step: Step;
+  journey: Journey;
+}
+
+interface JourneyEvent {
+  journey: Journey;
+  timestamp: number;
+  params?: Params;
+}
 
 interface Events {
   start: {
@@ -114,24 +122,21 @@ interface Events {
   'journey:register': {
     journey: Journey;
   };
-  'journey:start': {
-    journey: Journey;
-    timestamp: number;
-    params: Params;
-  };
-  'journey:end': BaseContext &
+  'journey:start': JourneyEvent;
+  'journey:end': JourneyEvent &
     JourneyResult & {
-      journey: Journey;
+      start: number;
+      end: number;
       options: RunOptions;
+      timestamp: number;
     };
   'journey:end:reported': unknown;
-  'step:start': { journey: Journey; step: Step };
-  'step:end': StepResult & {
-    start: number;
-    end: number;
-    journey: Journey;
-    step: Step;
-  };
+  'step:start': StepEvent;
+  'step:end': StepEvent &
+    StepResult & {
+      start: number;
+      end: number;
+    };
   end: unknown;
 }
 
@@ -149,8 +154,12 @@ export default class Runner extends EventEmitter {
   static screenshotPath = join(CACHE_PATH, 'screenshots');
 
   static async createContext(options: RunOptions): Promise<JourneyContext> {
-    const start = monotonicTimeInSeconds();
     const driver = await Gatherer.setupDriver(options);
+    /**
+     * Do not include browser launch/context creation duration
+     * as part of journey duration
+     */
+    const start = monotonicTimeInSeconds();
     const pluginManager = await Gatherer.beginRecording(driver, options);
     /**
      * For each journey we create the screenshots folder for
@@ -180,12 +189,14 @@ export default class Runner extends EventEmitter {
      */
     if (buffer) {
       const fileName = `${generateUniqueId()}.json`;
+      const screenshot: Screenshot = {
+        step,
+        timestamp: getTimestamp(),
+        data: buffer.toString('base64'),
+      };
       await writeFileAsync(
         join(Runner.screenshotPath, fileName),
-        JSON.stringify({
-          step,
-          data: buffer.toString('base64'),
-        })
+        JSON.stringify(screenshot)
       );
     }
   }
@@ -339,6 +350,7 @@ export default class Runner extends EventEmitter {
     result: JourneyContext & JourneyResult,
     options: RunOptions
   ) {
+    const end = monotonicTimeInSeconds();
     const { pluginManager, start, status, error } = result;
     const pluginOutput = pluginManager.output();
     this.emit('journey:end', {
@@ -346,7 +358,8 @@ export default class Runner extends EventEmitter {
       status,
       error,
       start,
-      end: monotonicTimeInSeconds(),
+      end,
+      timestamp: getTimestamp(),
       options,
       ...pluginOutput,
       browserconsole: status == 'failed' ? pluginOutput.browserconsole : [],
@@ -378,6 +391,7 @@ export default class Runner extends EventEmitter {
     };
     this.emit('journey:end', {
       journey,
+      timestamp: getTimestamp(),
       start,
       options,
       end: monotonicTimeInSeconds(),
@@ -393,8 +407,8 @@ export default class Runner extends EventEmitter {
     const result: JourneyResult = {
       status: 'succeeded',
     };
-    log(`Runner: start journey (${journey.name})`);
     const context = await Runner.createContext(options);
+    log(`Runner: start journey (${journey.name})`);
     try {
       this.registerJourney(journey, context);
       const hookArgs = {

package/src/formatter/javascript.ts

@@ -35,6 +35,7 @@ export type ActionInContext = {
   isMainFrame: boolean;
   action: Action;
   committed?: boolean;
+  modified?: boolean;
   title?: string;
 };
 
@@ -47,6 +48,7 @@ type Action = {
   modifiers?: number;
   button?: 'left' | 'middle' | 'right';
   clickCount?: number;
+  text?: string;
   value?: string;
   isAssert?: boolean;
   command?: string;

package/src/index.ts

@@ -25,7 +25,6 @@
 
 import { runner } from './core';
 import { RunOptions } from './core/runner';
-import { setLogger } from './core/logger';
 import sourceMapSupport from 'source-map-support';
 
 export async function run(options: RunOptions) {
@@ -35,11 +34,6 @@ export async function run(options: RunOptions) {
   sourceMapSupport.install({
     environment: 'node',
   });
-  /**
-   * set up logger with appropriate file descriptor
-   * to capture all the DEBUG logs when run through heartbeat
-   */
-  setLogger(options.outfd);
 
   try {
     return await runner.run(options);
@@ -72,3 +66,4 @@ export type { default as Runner } from './core/runner';
 export type { Reporter, ReporterOptions } from './reporters';
 
 export type { SyntheticsConfig } from './common_types';
+export type { ActionInContext } from './formatter/javascript';

package/src/parse_args.ts

@@ -43,11 +43,6 @@ program
     'JSON object that gets injected to all journeys',
     JSON.parse
   )
-  .option(
-    '-s, --suite-params <jsonstring>',
-    'DEPRECATED: Use --params instead',
-    JSON.parse
-  )
   .addOption(
     new Option('--reporter <value>', `output repoter format`).choices(
       Object.keys(reporters)
@@ -112,6 +107,7 @@ program
     ).default(DEFAULT_NETWORK_CONDITIONS_ARG)
   )
   .option('--no-throttling', 'Turns off default network throttling.')
+  .option('--playwright-options <jsonstring>', 'JSON object to pass in custom Playwright options for the agent. Options passed will be merged with Playwright options defined in your synthetics.config.js file. Options defined via --playwright-options take precedence.', JSON.parse)
   .version(version)
   .description('Run synthetic tests');