@elastic/synthetics 1.7.2 → 1.9.0

package/src/push/monitor.ts

@@ -25,7 +25,7 @@
 
 import { mkdir, rm, readFile } from 'fs/promises';
 import { extname, join } from 'path';
-import { LineCounter, parseDocument, YAMLSeq, YAMLMap } from 'yaml';
+import { LineCounter, parseDocument, Document, YAMLSeq, YAMLMap } from 'yaml';
 import { bold, red } from 'kleur/colors';
 import { Bundler } from './bundler';
 import { SYNTHETICS_PATH, totalist, indent, warn } from '../helpers';
@@ -167,8 +167,8 @@ export async function createLightweightMonitors(
 ) {
   const lwFiles = new Set<string>();
   // Filter monitor files based on the provided pattern
-  const pattern = options.pattern
-    ? new RegExp(options.pattern, 'i')
+  const pattern = options.grepOpts?.pattern
+    ? new RegExp(options.grepOpts?.pattern, 'i')
     : /.(yml|yaml)$/;
   const ignore = /(node_modules|.github)/;
   await totalist(workDir, (rel, abs) => {
@@ -188,8 +188,9 @@ export async function createLightweightMonitors(
     const lineCounter = new LineCounter();
     const parsedDoc = parseDocument(content, {
       lineCounter,
+      merge: true,
       keepSourceTokens: true,
-    });
+    }) as Document.Parsed;
     // Skip other yml files that are not relevant
     const monitorSeq = parsedDoc.get('heartbeat.monitors') as YAMLSeq<YAMLMap>;
     if (!monitorSeq) {
@@ -203,21 +204,38 @@ export async function createLightweightMonitors(
       warnOnce = true;
     }
 
+    // Store the offsets of each monitor in the sequence to construct the source
+    // location later for capturing the error
+    const offsets = [];
     for (const monNode of monitorSeq.items) {
+      offsets.push(monNode.srcToken.offset);
+    }
+
+    const mergedConfig = parsedDoc.toJS()[
+      'heartbeat.monitors'
+    ] as Array<MonitorConfig>;
+    for (let i = 0; i < mergedConfig.length; i++) {
+      const monitor = mergedConfig[i];
       // Skip browser monitors from the YML files
-      if (monNode.get('type') === 'browser') {
+      if (monitor['type'] === 'browser') {
         continue;
       }
-      const config = monNode.toJSON();
-      const { line, col } = lineCounter.linePos(monNode.srcToken.offset);
+      const { line, col } = lineCounter.linePos(offsets[i]);
       try {
-        const mon = buildMonitorFromYaml(config, options);
+        /**
+         * Build the monitor object from the yaml config along with global configuration
+         * and perform the match based on the provided filters
+         */
+        const mon = buildMonitorFromYaml(monitor, options);
+        if (!mon.isMatch(options.grepOpts?.match, options.grepOpts?.tags)) {
+          continue;
+        }
         mon.setSource({ file, line, column: col });
         monitors.push(mon);
       } catch (e) {
         let outer = bold(`Aborted: ${e}\n`);
         outer += indent(
-          `* ${config.id || config.name} - ${file}:${line}:${col}\n`
+          `* ${monitor.id || monitor.name} - ${file}:${line}:${col}\n`
         );
         throw red(outer);
       }

package/src/reporters/json.ts

@@ -154,8 +154,41 @@ function formatTLS(tls: SecurityDetails) {
   };
 }
 
+/**
+ * List of wildcard header keys that should be sanitized/redacted from the request/response headers
+ *
+ * Spec followed by APM agent is used as a reference.
+ * https://github.com/elastic/apm/blob/36a5abd49ff156c80cf0c9e2e1eac919873cb18b/specs/agents/sanitization.md?plain=1#L27
+ */
+const SANITIZE_HEADER_KEYS = [
+  /^password$/i,
+  /^secret$/i,
+  /^.*key$/i,
+  /^.*token.*$/i,
+  /^.*session.*$/i,
+  /^.*auth.*$/i,
+  /^cookie$/i,
+  /^set\x2dcookie$/i,
+];
+export function redactKeys(obj: Record<string, string> = {}) {
+  const result = {};
+  for (const key of Object.keys(obj)) {
+    const shouldRedact = SANITIZE_HEADER_KEYS.some(regex => regex.test(key));
+    result[key] = shouldRedact ? '[REDACTED]' : obj[key];
+  }
+  return result;
+}
+
 export function formatNetworkFields(network: NetworkInfo) {
   const { request, response, url, browser } = network;
+  // Perform redaction on the headers before writing results
+  if (request?.headers) {
+    request.headers = redactKeys(request.headers);
+  }
+  if (response?.headers) {
+    response.headers = redactKeys(response.headers);
+  }
+
   const ecs = {
     // URL would be parsed and mapped by heartbeat
     url,