@elastic/synthetics 1.17.2 → 1.18.1

package/src/push/utils.ts

@@ -25,7 +25,7 @@
 
 import semver from 'semver';
 import { progress, removeTrailingSlash } from '../helpers';
-import { green, red, grey, yellow } from 'kleur/colors';
+import { green, red, grey, yellow, Colorize, bold } from 'kleur/colors';
 import { PushOptions } from '../common_types';
 import { Monitor } from '../dsl/monitor';
 
@@ -37,19 +37,97 @@ export function logDiff<T extends Set<string>>(
 ) {
   progress(
     'Monitor Diff: ' +
-    green(`Added(${newIDs.size}) `) +
-    yellow(`Updated(${changedIDs.size}) `) +
-    red(`Removed(${removedIDs.size}) `) +
-    grey(`Unchanged(${unchangedIDs.size})`)
+      green(`Added(${newIDs.size}) `) +
+      yellow(`Updated(${changedIDs.size}) `) +
+      red(`Removed(${removedIDs.size}) `) +
+      grey(`Unchanged(${unchangedIDs.size})`)
   );
 }
 
-export function getChunks<T>(arr: Array<T>, size: number): Array<T[]> {
-  const chunks = [];
+export function logGroups<T extends Set<string>>(
+  sizes: Map<string, number>,
+  newIDs: T,
+  changedIDs: T,
+  removedIDs: T,
+  unchangedIDs: T
+) {
+  console.groupCollapsed();
+  logGroup(sizes, 'Added', newIDs, green);
+  logGroup(sizes, 'Updated', changedIDs, yellow);
+  logGroup(sizes, 'Removed', removedIDs, red);
+  logGroup(sizes, 'Unchanged', unchangedIDs, grey);
+  console.groupEnd();
+}
+
+function logGroup(
+  sizes: Map<string, number>,
+  name: string,
+  ids: Set<string>,
+  color: Colorize
+) {
+  if (ids.size === 0) return;
+  // under collapsed group, so giving 2 space for padding
+  printLine(process.stdout.columns - 2);
+  console.groupCollapsed(color(bold(name)));
+  [...ids].forEach(id => {
+    console.log(grey(`- ${id} (${printBytes(sizes.get(id))})`));
+  });
+  console.groupEnd();
+}
+
+function printLine(length: number = process.stdout.columns) {
+  console.log(grey('-').repeat(length));
+}
+
+const BYTE_UNITS = ['B', 'kB', 'MB', 'GB', 'TB', 'PB'];
+export function printBytes(bytes: number) {
+  if (bytes <= 0) return '0 B';
+  const exponent = Math.min(
+    Math.floor(Math.log10(bytes) / 3),
+    BYTE_UNITS.length - 1
+  );
+  bytes /= 1000 ** exponent;
+  return `${bytes.toFixed(1)} ${BYTE_UNITS[exponent]}`;
+}
+
+export function getBatches(arr: string[], size: number): string[][] {
+  const batches = [];
   for (let i = 0; i < arr.length; i += size) {
-    chunks.push(arr.slice(i, i + size));
+    batches.push(arr.slice(i, i + size));
+  }
+  return batches;
+}
+
+export function getSizedBatches<T extends { id?: string }>(
+  arr: Array<T>,
+  sizes: Map<string, number>,
+  maxBatchSizeKB: number,
+  maxBatchItems: number
+): Array<T[]> {
+  const batches: Array<T[]> = [];
+  let currentBatch: T[] = [];
+  let currentSize = 0;
+
+  for (const item of arr) {
+    const sizeKB = item.id ? Math.round(sizes.get(item.id) / 1000) : 1;
+    // If adding the current item would exceed limits, create a new chunk
+    if (
+      currentBatch.length >= maxBatchItems ||
+      currentSize + sizeKB > maxBatchSizeKB
+    ) {
+      batches.push(currentBatch);
+      currentBatch = [];
+      currentSize = 0;
+    }
+    currentBatch.push(item);
+    currentSize += sizeKB;
+  }
+
+  // Push the last chunk if it contains any items
+  if (currentBatch.length > 0) {
+    batches.push(currentBatch);
   }
-  return chunks;
+  return batches;
 }
 
 type Operation =

package/src/reporters/base.ts

@@ -29,7 +29,11 @@ import { renderError, serializeError } from './reporter-util';
 import { symbols, indent, now } from '../helpers';
 import { Reporter, ReporterOptions } from '.';
 import { Journey, Step } from '../dsl';
-import { JourneyEndResult, JourneyStartResult, StepResult } from '../common_types';
+import {
+  JourneyEndResult,
+  JourneyStartResult,
+  StepResult,
+} from '../common_types';
 
 export function renderDuration(durationMs) {
   return parseInt(durationMs);
@@ -62,11 +66,11 @@ export default class BaseReporter implements Reporter {
     this.metrics.registered++;
   }
 
-  onJourneyStart(journey: Journey, { }: JourneyStartResult) {
+  onJourneyStart(journey: Journey, {}: JourneyStartResult) {
     this.write(`\nJourney: ${journey.name}`);
   }
 
-  onStepEnd(_: Journey, step: Step, { }: StepResult) {
+  onStepEnd(_: Journey, step: Step, {}: StepResult) {
     const { status, error } = step;
     const message = `${symbols[status]}  Step: '${step.name}' ${status} ${gray(
       '(' + renderDuration(step.duration * 1000) + ' ms)'
@@ -80,7 +84,7 @@ export default class BaseReporter implements Reporter {
   }
 
   /* eslint-disable @typescript-eslint/no-unused-vars */
-  onJourneyEnd(journey: Journey, { }: JourneyEndResult) {
+  onJourneyEnd(journey: Journey, {}: JourneyEndResult) {
     const { failed, succeeded, skipped } = this.metrics;
     const total = failed + succeeded + skipped;
     /**

package/src/reporters/build_kite_cli.ts

@@ -43,7 +43,7 @@ export default class BuildKiteCLIReporter extends BaseReporter {
     super(options);
   }
 
-  override onJourneyStart(journey: Journey, { }: JourneyStartResult) {
+  override onJourneyStart(journey: Journey, {}: JourneyStartResult) {
     this.write(`\n--- Journey: ${journey.name}`);
   }
 
@@ -57,7 +57,9 @@ export default class BuildKiteCLIReporter extends BaseReporter {
 
   override async onJourneyEnd(journey: Journey, result: JourneyEndResult) {
     super.onJourneyEnd(journey, result);
-    const message = `${symbols[journey.status]} Took (${renderDuration(journey.duration)} seconds)`;
+    const message = `${symbols[journey.status]} Took (${renderDuration(
+      journey.duration
+    )} seconds)`;
     this.write(message);
   }
 
@@ -76,10 +78,9 @@ export default class BuildKiteCLIReporter extends BaseReporter {
           const name = red(`Journey: ${journeyName} :slightly_frowning_face:`);
           this.write(`\n+++ ${name}`);
           steps.forEach(step => {
-            const message = `${symbols[step.status]
-              }  Step: '${step.name}' ${step.status} (${renderDuration(
-                step.duration * 1000
-              )} ms)`;
+            const message = `${symbols[step.status]}  Step: '${step.name}' ${
+              step.status
+            } (${renderDuration(step.duration * 1000)} ms)`;
             this.write(indent(message));
             if (step.error) {
               this.write(renderError(serializeError(step.error)));

package/src/reporters/json.ts

@@ -253,14 +253,15 @@ function formatJSONError(error: Error | any) {
   };
 }
 
-function journeyInfo(
-  journey: Partial<Journey>,
-  type: OutputFields['type'],
-) {
+function journeyInfo(journey: Partial<Journey>, type: OutputFields['type']) {
   if (!journey) {
     return;
   }
-  const info: JourneyInfo = { name: journey.name, id: journey.id, tags: journey.tags };
+  const info: JourneyInfo = {
+    name: journey.name,
+    id: journey.id,
+    tags: journey.tags,
+  };
   const isEnd = type === 'journey/end';
   if (isEnd) {
     info.status = journey.status;
@@ -271,7 +272,7 @@ function journeyInfo(
 
 function stepInfo(
   step: Partial<Step>,
-  type: OutputFields['type'],
+  type: OutputFields['type']
 ): Omit<Partial<Step>, 'duration'> & Duration {
   if (!step) {
     return;
@@ -375,8 +376,8 @@ export default class JSONReporter extends BaseReporter {
       },
       payload: event.networkConditions
         ? {
-          network_conditions: event.networkConditions,
-        }
+            network_conditions: event.networkConditions,
+          }
         : undefined,
     });
   }
@@ -400,12 +401,7 @@ export default class JSONReporter extends BaseReporter {
   override onStepEnd(
     journey: Journey,
     step: Step,
-    {
-      pagemetrics,
-      traces,
-      metrics,
-      filmstrips,
-    }: StepEndResult
+    { pagemetrics, traces, metrics, filmstrips }: StepEndResult
   ) {
     this.writeMetrics(journey, step, 'relative_trace', traces);
     this.writeMetrics(journey, step, 'experience', metrics);

package/src/reporters/junit.ts

@@ -25,10 +25,7 @@
 
 import { mkdir, writeFile } from 'fs/promises';
 import { dirname } from 'path';
-import {
-  JourneyEndResult,
-  JourneyStartResult,
-} from '../common_types';
+import { JourneyEndResult, JourneyStartResult } from '../common_types';
 import { Journey, Step } from '../dsl';
 import { indent, now } from '../helpers';
 import BaseReporter from './base';
@@ -59,7 +56,7 @@ export default class JUnitReporter extends BaseReporter {
   private totalSkipped = 0;
   #journeyMap = new Map<string, XMLEntry>();
 
-  override onJourneyStart(journey: Journey, { }: JourneyStartResult) {
+  override onJourneyStart(journey: Journey, {}: JourneyStartResult) {
     if (!this.#journeyMap.has(journey.name)) {
       const entry = {
         name: 'testsuite',
@@ -76,10 +73,7 @@ export default class JUnitReporter extends BaseReporter {
     }
   }
 
-  override onStepEnd(
-    journey: Journey,
-    step: Step,
-  ) {
+  override onStepEnd(journey: Journey, step: Step) {
     if (!this.#journeyMap.has(journey.name)) {
       return;
     }
@@ -117,7 +111,7 @@ export default class JUnitReporter extends BaseReporter {
     entry.children.push(caseEntry);
   }
 
-  override onJourneyEnd(journey: Journey, { }: JourneyEndResult) {
+  override onJourneyEnd(journey: Journey, {}: JourneyEndResult) {
     if (!this.#journeyMap.has(journey.name)) {
       return;
     }