@elastic/synthetics 1.0.0-beta.37 → 1.0.0-beta.39

package/src/push/index.ts

@@ -25,7 +25,7 @@
 
 import { readFile, writeFile } from 'fs/promises';
 import { prompt } from 'enquirer';
-import { bold } from 'kleur/colors';
+import { bold, grey } from 'kleur/colors';
 import {
   ok,
   formatAPIError,
@@ -34,7 +34,7 @@ import {
   formatStaleMonitors,
 } from './request';
 import { buildMonitorSchema, createMonitors, MonitorSchema } from './monitor';
-import { Monitor } from '../dsl/monitor';
+import { ALLOWED_SCHEDULES, Monitor } from '../dsl/monitor';
 import {
   progress,
   apiProgress,
@@ -44,6 +44,8 @@ import {
   indent,
   safeNDJSONParse,
   done,
+  getMonitorManagementURL,
+  getArrayChunks,
 } from '../helpers';
 import type { PushOptions, ProjectSettings } from '../common_types';
 import { findSyntheticsConfig, readConfig } from '../config';
@@ -60,8 +62,9 @@ export async function push(monitors: Monitor[], options: PushOptions) {
     schemas = await buildMonitorSchema(monitors);
 
     progress(`creating all monitors`);
-    for (const schema of schemas) {
-      await pushMonitors({ schemas: [schema], keepStale: true, options });
+    const chunks = getArrayChunks(schemas, 10);
+    for (const chunk of chunks) {
+      await pushMonitors({ schemas: chunk, keepStale: true, options });
     }
   } else {
     write('');
@@ -85,7 +88,7 @@ export async function push(monitors: Monitor[], options: PushOptions) {
   progress(`deleting all stale monitors`);
   await pushMonitors({ schemas, keepStale: false, options });
 
-  done('Pushed');
+  done(`Pushed: ${grey(getMonitorManagementURL(options.url))}`);
 }
 
 export async function pushMonitors({
@@ -109,26 +112,27 @@ export async function pushMonitors({
     const { error, message } = await body.json();
     throw formatAPIError(statusCode, error, message);
   }
-  body.setEncoding('utf-8');
+  const allchunks = [];
   for await (const data of body) {
-    // Its kind of hacky for now where Kibana streams the response by
-    // writing the data as NDJSON events (data can be interleaved), we
-    // distinguish the final data by checking if the event was a progress vs complete event
-    const chunks = safeNDJSONParse(data);
-    for (const chunk of chunks) {
-      if (typeof chunk === 'string') {
-        // TODO: add progress back for all states once we get the fix
-        // on kibana side
-        keepStale && apiProgress(chunk);
-        continue;
-      }
-      const { failedMonitors, failedStaleMonitors } = chunk;
-      if (failedMonitors && failedMonitors.length > 0) {
-        throw formatFailedMonitors(failedMonitors);
-      }
-      if (failedStaleMonitors.length > 0) {
-        throw formatStaleMonitors(failedStaleMonitors);
-      }
+    allchunks.push(Buffer.from(data));
+  }
+  const chunks = safeNDJSONParse(Buffer.concat(allchunks).toString('utf-8'));
+  // Its kind of hacky for now where Kibana streams the response by
+  // writing the data as NDJSON events (data can be interleaved), we
+  // distinguish the final data by checking if the event was a progress vs complete event
+  for (const chunk of chunks) {
+    if (typeof chunk === 'string') {
+      // TODO: add progress back for all states once we get the fix
+      // on kibana side
+      keepStale && apiProgress(chunk);
+      continue;
+    }
+    const { failedMonitors, failedStaleMonitors } = chunk;
+    if (failedMonitors && failedMonitors.length > 0) {
+      throw formatFailedMonitors(failedMonitors);
+    }
+    if (failedStaleMonitors.length > 0) {
+      throw formatStaleMonitors(failedStaleMonitors);
     }
   }
 }
@@ -192,6 +196,10 @@ export function validateSettings(opts: PushOptions) {
     reason = `Set default schedule in minutes for all monitors via
   - CLI '--schedule <mins>'
   - Config file 'monitors.schedule' field`;
+  } else if (opts.schedule && !ALLOWED_SCHEDULES.includes(opts.schedule)) {
+    reason = `Set default schedule(${
+      opts.schedule
+    }) to one of the allowed values - ${ALLOWED_SCHEDULES.join(',')}`;
   }
 
   if (!reason) return;

package/src/push/monitor.ts

@@ -37,7 +37,7 @@ import {
   warn,
 } from '../helpers';
 import { LocationsMap } from '../locations/public-locations';
-import { Monitor, MonitorConfig } from '../dsl/monitor';
+import { ALLOWED_SCHEDULES, Monitor, MonitorConfig } from '../dsl/monitor';
 import { PushOptions } from '../common_types';
 
 export type MonitorSchema = Omit<MonitorConfig, 'locations'> & {
@@ -95,13 +95,8 @@ export async function createLightweightMonitors(
       lwFiles.add(abs);
     }
   });
-  // Warn users about schedule that are less than 60 seconds
-  if (lwFiles.size > 0) {
-    warn(
-      'lightweight monitors schedule < 1 minute resolution are not supported, will get reset to their nearest minute interval.'
-    );
-  }
 
+  let warnOnce = false;
   const monitors: Monitor[] = [];
   for (const file of lwFiles.values()) {
     const content = await readFile(file, 'utf-8');
@@ -115,6 +110,13 @@ export async function createLightweightMonitors(
     if (!monitorSeq) {
       continue;
     }
+    // Warn users about schedule that are less than 60 seconds
+    if (!warnOnce) {
+      warn(
+        'If you are using lightweight monitors with less than 1 minute resolution, these will be saved to the nearest supported frequency'
+      );
+      warnOnce = true;
+    }
 
     for (const monNode of monitorSeq.items) {
       // Skip browser monitors and disabled monitors from pushing
@@ -193,7 +195,26 @@ export function parseSchedule(schedule: string) {
         break;
     }
   }
-  return minutes;
+  return nearestSchedule(minutes);
+}
+
+// Find the nearest schedule that is supported by the platform
+// from the parsed schedule value
+export function nearestSchedule(schedule: number) {
+  let start = 0;
+  let end = ALLOWED_SCHEDULES.length - 1;
+  while (start <= end) {
+    const mid = Math.floor((start + end) / 2);
+    const midValue = ALLOWED_SCHEDULES[mid];
+    if (midValue === schedule) {
+      return midValue;
+    } else if (midValue < schedule) {
+      start = mid + 1;
+    } else {
+      end = mid - 1;
+    }
+  }
+  return ALLOWED_SCHEDULES[end];
 }
 
 export async function createMonitors(

package/src/push/plugin.ts

@@ -39,6 +39,11 @@ export function commonOptions(): esbuild.BuildOptions {
     bundle: true,
     external: ['@elastic/synthetics'],
     minify: false,
+    minifyIdentifiers: false,
+    minifySyntax: false,
+    minifyWhitespace: false,
+    treeShaking: false,
+    keepNames: false,
     platform: 'node',
     logLevel: 'silent',
     format: 'esm',
@@ -108,7 +113,7 @@ export function MultiAssetPlugin(callback: PluginCallback): esbuild.Plugin {
         if (args.kind === 'entry-point') {
           return {
             path: args.path,
-            namespace: 'asset',
+            namespace: 'journey',
           };
         }
 
@@ -142,10 +147,21 @@ export function MultiAssetPlugin(callback: PluginCallback): esbuild.Plugin {
         };
       });
 
-      build.onLoad({ filter: /.*?/, namespace: 'asset' }, async args => {
+      build.onLoad({ filter: /.*?/, namespace: 'journey' }, async args => {
         const contents = await fs.readFile(args.path, 'utf-8');
         callback({ path: args.path, contents });
-        return { contents };
+
+        // Use correct loader for the journey entry path
+        let loader: esbuild.Loader = 'default';
+        const ext = extname(args.path).slice(1);
+        if (ext === 'cjs' || ext === 'mjs') {
+          loader = 'js';
+        } else if (ext === 'cts' || ext === 'mts') {
+          loader = 'ts';
+        } else {
+          loader = ext as esbuild.Loader;
+        }
+        return { contents, loader };
       });
     },
   };

package/templates/.github/workflows/run-synthetics.yml

@@ -8,19 +8,20 @@ on:
     - cron: '* 0 * * *'
 jobs:
   test:
+    defaults:
+      run:
+        working-directory: ./advanced-examples
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 18
       - run: npm install
       - run: "SYNTHETICS_JUNIT_FILE='junit-synthetics.xml' npx @elastic/synthetics . --reporter=junit"
-        continue-on-error: true
       - name: Publish Unit Test Results
-        uses: EnricoMi/publish-unit-test-result-action@v1.19
+        uses: EnricoMi/publish-unit-test-result-action@v2
         if: always()
         with:
-          files: '**/junit-*.xml'
-          fail_on: 'test failures'
-          check_name: Elastic Synthetics Tests
+          junit_files: '**/junit-*.xml'
+          check_name: Elastic Synthetics Tests

package/templates/lightweight/heartbeat.yml

@@ -0,0 +1,7 @@
+- type: http
+  name: Todos Lightweight
+  id: todos-lightweight
+  enabled: true
+  urls: "https://elastic.github.io/synthetics-demo/"
+  schedule: '@every 3m'
+  timeout: 16s