@elastic/synthetics 1.0.0-beta.14 → 1.0.0-beta.18

package/src/reporters/json.ts

@@ -40,10 +40,12 @@ import { Journey, Step } from '../dsl';
 import snakeCaseKeys from 'snakecase-keys';
 import {
   NetworkInfo,
+  NetworkConditions,
   TraceOutput,
   StatusValue,
   PerfMetrics,
   Params,
+  Screenshot,
 } from '../common_types';
 import { Protocol } from 'playwright-chromium/types/protocol';
 import { PageMetrics } from '../plugins';
@@ -76,6 +78,7 @@ type Payload = {
   type?: OutputType;
   text?: string;
   index?: number;
+  network_conditions?: NetworkConditions;
 };
 
 type OutputFields = {
@@ -113,13 +116,6 @@ type ScreenshotReference = {
   }>;
 };
 
-type ScreenshotOutput = {
-  step: Step;
-  blob_mime: string;
-  blocks: Array<ScreenshotBlob>;
-  reference: ScreenshotReference;
-};
-
 function getMetadata() {
   return {
     os: {
@@ -331,14 +327,14 @@ export async function getScreenshotBlocks(screenshot: Buffer) {
  */
 export async function gatherScreenshots(
   screenshotsPath: string,
-  callback: (step: Step, data: string) => Promise<void>
+  callback: (data: Screenshot) => Promise<void>
 ) {
   if (isDirectory(screenshotsPath)) {
     await totalist(screenshotsPath, async (_, absPath) => {
       try {
         const content = readFileSync(absPath, 'utf8');
-        const { step, data } = JSON.parse(content);
-        await callback(step, data);
+        const screenshot: Screenshot = JSON.parse(content);
+        await callback(screenshot);
       } catch (_) {
         // TODO: capture progarammatic synthetic errors under different type
       }
@@ -352,12 +348,17 @@ export default class JSONReporter extends BaseReporter {
      * report the number of journeys that exists on a suite which
      * could be used for better sharding
      */
-    this.runner.on('start', ({ numJourneys }) => {
+    this.runner.on('start', ({ numJourneys, networkConditions }) => {
       this.writeJSON({
         type: 'synthetics/metadata',
         root_fields: {
           num_journeys: numJourneys,
         },
+        payload: networkConditions
+          ? {
+              network_conditions: networkConditions,
+            }
+          : undefined,
       });
     });
 
@@ -435,6 +436,7 @@ export default class JSONReporter extends BaseReporter {
       'journey:end',
       async ({
         journey,
+        timestamp,
         start,
         end,
         networkinfo,
@@ -450,15 +452,17 @@ export default class JSONReporter extends BaseReporter {
         if (writeScreenshots) {
           await gatherScreenshots(
             join(CACHE_PATH, 'screenshots'),
-            async (step, data) => {
+            async screenshot => {
+              const { data, timestamp, step } = screenshot;
               if (!data) {
                 return;
               }
               if (ssblocks) {
-                await this.writeScreenshotBlocks(journey, step, data);
+                await this.writeScreenshotBlocks(journey, screenshot);
               } else {
                 this.writeJSON({
                   type: 'step/screenshot',
+                  timestamp,
                   journey,
                   step,
                   blob: data,
@@ -501,6 +505,7 @@ export default class JSONReporter extends BaseReporter {
         this.writeJSON({
           type: 'journey/end',
           journey,
+          timestamp,
           error,
           payload: {
             start,
@@ -513,14 +518,15 @@ export default class JSONReporter extends BaseReporter {
     );
   }
 
-  async writeScreenshotBlocks(journey: Journey, step: Step, data: string) {
+  async writeScreenshotBlocks(journey: Journey, screenshot: Screenshot) {
     const { blob_mime, blocks, reference } = await getScreenshotBlocks(
-      Buffer.from(data, 'base64')
+      Buffer.from(screenshot.data, 'base64')
     );
     for (let i = 0; i < blocks.length; i++) {
       const block = blocks[i];
       this.writeJSON({
         type: 'screenshot/block',
+        timestamp: screenshot.timestamp,
         _id: block.id,
         blob: block.blob,
         blob_mime,
@@ -528,8 +534,9 @@ export default class JSONReporter extends BaseReporter {
     }
     this.writeJSON({
       type: 'step/screenshot_ref',
+      timestamp: screenshot.timestamp,
       journey,
-      step,
+      step: screenshot.step,
       root_fields: {
         screenshot_ref: reference,
       },