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

package/src/reporters/json.ts

@@ -45,8 +45,9 @@ import {
   StatusValue,
   PerfMetrics,
   Params,
-  SecurityDetails,
+  Screenshot,
 } from '../common_types';
+import { Protocol } from 'playwright-chromium/types/protocol';
 import { PageMetrics } from '../plugins';
 
 /* eslint-disable @typescript-eslint/no-var-requires */
@@ -127,10 +128,9 @@ function getMetadata() {
   };
 }
 
-/* eslint-disable-next-line @typescript-eslint/no-unused-vars */
 function formatVersion(protocol: string | undefined) {
   if (!protocol) {
-    return 1.1;
+    return;
   }
   if (protocol === 'h2') {
     return 2;
@@ -143,12 +143,41 @@ function formatVersion(protocol: string | undefined) {
   }
 }
 
-function formatTLS(tls: SecurityDetails) {
-  if (!tls || !tls.issuer) {
+function formatRequest(request: Protocol.Network.Request) {
+  const postData = request.postData ? request.postData : '';
+  return {
+    ...request,
+    body: {
+      bytes: postData.length,
+      content: postData,
+    },
+    referrer: request.headers?.Referer,
+  };
+}
+
+function formatResponse(response: Protocol.Network.Response) {
+  if (!response) {
     return;
   }
+  return {
+    ...response,
+    body: {
+      bytes: response.encodedDataLength,
+    },
+    status_code: response.status,
+  };
+}
+
+function formatTLS(tls: Protocol.Network.SecurityDetails) {
+  if (!tls) {
+    return;
+  }
+  const cipher = `${tls.keyExchange ? tls.keyExchange + '_' : ''}${
+    tls.cipher
+  }_${tls.keyExchangeGroup}`;
   const [name, version] = tls.protocol.toLowerCase().split(' ');
   return {
+    cipher,
     server: {
       x509: {
         issuer: {
@@ -174,11 +203,12 @@ export function formatNetworkFields(network: NetworkInfo) {
     user_agent: {
       name: browser.name,
       version: browser.version,
-      original: request.headers?.['user-agent'],
+      original: request.headers?.['User-Agent'],
     },
     http: {
-      request,
-      response,
+      version: formatVersion(response?.protocol),
+      request: formatRequest(request),
+      response: formatResponse(response),
     },
     tls: formatTLS(response?.securityDetails),
   };
@@ -297,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
       }
@@ -406,6 +436,7 @@ export default class JSONReporter extends BaseReporter {
       'journey:end',
       async ({
         journey,
+        timestamp,
         start,
         end,
         networkinfo,
@@ -421,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,
@@ -472,6 +505,7 @@ export default class JSONReporter extends BaseReporter {
         this.writeJSON({
           type: 'journey/end',
           journey,
+          timestamp,
           error,
           payload: {
             start,
@@ -484,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,
@@ -499,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,
       },