@elastic/synthetics 1.0.0-beta.33 → 1.0.0-beta.35

package/src/push/index.ts

@@ -23,11 +23,9 @@
  *
  */
 
-import { join } from 'path';
-import { existsSync } from 'fs';
 import { readFile, writeFile } from 'fs/promises';
 import { prompt } from 'enquirer';
-import { bold, yellow } from 'kleur/colors';
+import { bold } from 'kleur/colors';
 import {
   ok,
   formatAPIError,
@@ -36,40 +34,57 @@ import {
   formatStaleMonitors,
 } from './request';
 import { buildMonitorSchema, createMonitors, MonitorSchema } from './monitor';
-import { ProjectSettings } from '../generator';
 import { Monitor } from '../dsl/monitor';
 import {
   progress,
   apiProgress,
   write,
   error,
-  SYNTHETICS_PATH,
   aborted,
   indent,
   safeNDJSONParse,
   done,
 } from '../helpers';
-import type { PushOptions } from '../common_types';
+import type { PushOptions, ProjectSettings } from '../common_types';
+import { findSyntheticsConfig, readConfig } from '../config';
 
 export async function push(monitors: Monitor[], options: PushOptions) {
-  if (monitors.length === 0) {
-    throw 'No Monitors found';
-  }
-  const duplicates = trackDuplicates(monitors);
-  if (duplicates.size > 0) {
-    throw error(formatDuplicateError(duplicates));
-  }
+  let schemas: MonitorSchema[] = [];
+  if (monitors.length > 0) {
+    const duplicates = trackDuplicates(monitors);
+    if (duplicates.size > 0) {
+      throw error(formatDuplicateError(duplicates));
+    }
 
-  progress(`preparing all monitors`);
-  const schemas = await buildMonitorSchema(monitors);
+    progress(`preparing all monitors`);
+    schemas = await buildMonitorSchema(monitors);
 
-  progress(`creating all monitors`);
-  for (const schema of schemas) {
-    await pushMonitors({ schemas: [schema], keepStale: true, options });
+    progress(`creating all monitors`);
+    for (const schema of schemas) {
+      await pushMonitors({ schemas: [schema], keepStale: true, options });
+    }
+  } else {
+    write('');
+    const { deleteAll } = await prompt<{ deleteAll: boolean }>({
+      type: 'confirm',
+      skip() {
+        if (options.yes) {
+          this.initial = process.env.TEST_OVERRIDE ?? true;
+          return true;
+        }
+        return false;
+      },
+      name: 'deleteAll',
+      message: `Pushing without any monitors will delete all monitors associated with the project.\n Do you want to continue?`,
+      initial: false,
+    });
+    if (!deleteAll) {
+      throw aborted('Push command Aborted');
+    }
   }
-
   progress(`deleting all stale monitors`);
   await pushMonitors({ schemas, keepStale: false, options });
+
   done('Pushed');
 }
 
@@ -82,43 +97,39 @@ export async function pushMonitors({
   keepStale: boolean;
   options: PushOptions;
 }) {
-  try {
-    const { body, statusCode } = await createMonitors(
-      schemas,
-      options,
-      keepStale
-    );
-    if (statusCode === 404) {
-      throw formatNotFoundError(await body.text());
-    }
-    if (!ok(statusCode)) {
-      const { error, message } = await body.json();
-      throw formatAPIError(statusCode, error, message);
-    }
-    body.setEncoding('utf-8');
-    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) {
-          write(yellow(formatStaleMonitors(failedStaleMonitors)));
-        }
+  const { body, statusCode } = await createMonitors(
+    schemas,
+    options,
+    keepStale
+  );
+  if (statusCode === 404) {
+    throw formatNotFoundError(await body.text());
+  }
+  if (!ok(statusCode)) {
+    const { error, message } = await body.json();
+    throw formatAPIError(statusCode, error, message);
+  }
+  body.setEncoding('utf-8');
+  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);
       }
     }
-  } catch (e) {
-    error(e);
   }
 }
 
@@ -148,34 +159,39 @@ export function formatDuplicateError(monitors: Set<Monitor>) {
   return outer;
 }
 
-const PROJECT_SETTINGS_PATH = join(SYNTHETICS_PATH, 'project.json');
 const INSTALLATION_HELP = `Run 'npx @elastic/synthetics init' to create project with default settings.`;
 
 export async function loadSettings() {
-  if (!existsSync(PROJECT_SETTINGS_PATH)) {
-    throw error(`Aborted. Synthetics project not set up.
+  try {
+    const config = await readConfig(process.env['NODE_ENV'] || 'development');
+    // Missing config file, fake throw to capture as missing file
+    if (Object.keys(config).length === 0) {
+      throw '';
+    }
+    return config.project || ({} as ProjectSettings);
+  } catch (e) {
+    throw error(`Aborted (missing synthetics config file), Project not set up corrrectly.
 
 ${INSTALLATION_HELP}`);
   }
-
-  const contents = await readFile(PROJECT_SETTINGS_PATH, 'utf-8');
-  return JSON.parse(contents) as ProjectSettings;
 }
 
 export function validateSettings(opts: PushOptions) {
   const INVALID = 'Aborted. Invalid synthetics project settings.';
 
   let reason = '';
-  if (!opts.project) {
-    reason = 'Set project id via CLI as `--project <id>`';
+  if (!opts.id) {
+    reason = `Set project id via
+  - CLI '--id <id>'
+  - Config file 'project.id' field`;
   } else if (!opts.locations && !opts.privateLocations) {
     reason = `Set default location for all monitors via
-  - CLI as '--locations <values...> or --privateLocations <values...>'
-  - Synthetics config file 'monitors.locations' | 'monitors.privateLocations' field`;
+  - CLI '--locations <values...> or --privateLocations <values...>'
+  - Config file 'monitors.locations' | 'monitors.privateLocations' field`;
   } else if (!opts.schedule) {
     reason = `Set default schedule in minutes for all monitors via
-  - CLI as '--schedule <mins>'
-  - Synthetics config file 'monitors.schedule' field`;
+  - CLI '--schedule <mins>'
+  - Config file 'monitors.schedule' field`;
   }
 
   if (!reason) return;
@@ -187,40 +203,46 @@ ${reason}
 ${INSTALLATION_HELP}`);
 }
 
-async function overrideSettings(project: string) {
-  const settings = JSON.parse(await readFile(PROJECT_SETTINGS_PATH, 'utf-8'));
-  settings.project = project;
-
-  await writeFile(
-    PROJECT_SETTINGS_PATH,
-    JSON.stringify(settings, null, 2),
-    'utf-8'
+async function overrideSettings(oldValue: string, newValue: string) {
+  const cwd = process.cwd();
+  const configPath = await findSyntheticsConfig(cwd, cwd);
+  if (!configPath) {
+    throw aborted(`Unable to find synthetics config file: ${configPath}`);
+  }
+  const config = await readFile(configPath, 'utf-8');
+  const updatedConfig = config.replace(
+    `id: '${oldValue}'`,
+    `id: '${newValue}'`
   );
+  await writeFile(configPath, updatedConfig, 'utf-8');
 }
 
 export async function catchIncorrectSettings(
   settings: ProjectSettings,
   options: PushOptions
 ) {
-  let override = !settings.project;
-  if (settings.project && settings.project !== options.project) {
-    if (typeof process.env.TEST_OVERRIDE != null) {
-      override = Boolean(process.env.TEST_OVERRIDE);
-    } else {
-      // Add an extra line to make it easier to read the prompt
-      write('');
-      ({ override } = await prompt<{ override: boolean }>({
-        type: 'confirm',
-        name: 'override',
-        message: `Monitors were pushed under the '${settings.project}' project. Are you sure you want to push them under the new '${options.project}' (note that this will duplicate the monitors, the old ones being orphaned)`,
-        initial: false,
-      }));
-    }
+  let override = !settings.id;
+  if (settings.id && settings.id !== options.id) {
+    // Add an extra line to make it easier to read the prompt
+    write('');
+    ({ override } = await prompt<{ override: boolean }>({
+      type: 'confirm',
+      name: 'override',
+      skip() {
+        if (options.yes) {
+          this.initial = process.env.TEST_OVERRIDE ?? true;
+          return true;
+        }
+        return false;
+      },
+      message: `Monitors were pushed under the '${settings.id}' project. Are you sure you want to push them under the new '${options.id}' (note that this will duplicate the monitors, the old ones being orphaned)`,
+      initial: false,
+    }));
     if (!override) {
       throw aborted('Push command Aborted');
     }
   }
   if (override) {
-    await overrideSettings(options.project);
+    await overrideSettings(settings.id, options.id);
   }
 }

package/src/push/monitor.ts

@@ -81,7 +81,7 @@ export async function createMonitors(
   keepStale: boolean
 ) {
   const schema: APISchema = {
-    project: options.project,
+    project: options.id,
     keep_stale: keepStale,
     monitors,
   };

package/src/push/plugin.ts

@@ -23,14 +23,17 @@
  *
  */
 
-import path from 'path';
+import { isAbsolute, dirname, extname, join } from 'path';
 import fs from 'fs/promises';
 import * as esbuild from 'esbuild';
 
+const SOURCE_DIR = join(__dirname, '..', '..');
+const SOURCE_NODE_MODULES = join(SOURCE_DIR, 'node_modules');
+
 export function commonOptions(): esbuild.BuildOptions {
   return {
     bundle: true,
-    external: ['node_modules', '@elastic/synthetics'],
+    external: ['@elastic/synthetics'],
     minify: false,
     platform: 'node',
     logLevel: 'silent',
@@ -55,27 +58,49 @@ export function MultiAssetPlugin(callback: PluginCallback): esbuild.Plugin {
     // Note that we use `isAbsolute` to handle UNC/windows style paths like C:\path\to\thing
     // This is not necessary for relative directories since `.\file` is not supported as an import
     // nor is `~/path/to/file`.
-    if (path.isAbsolute(str) || str.startsWith('./') || str.startsWith('../')) {
+    if (isAbsolute(str) || str.startsWith('./') || str.startsWith('../')) {
       return true;
     }
     return false;
   };
 
+  // If we're importing the @elastic/synthetics package
+  // directly from source instead of using the fully
+  // qualified name, we must skip it too. That's just
+  // so it doesn't get bundled on tests or when we locally
+  // refer to the package itself.
+  const isLocalSynthetics = (entryPath: string) => {
+    return entryPath.startsWith(SOURCE_DIR);
+  };
+
+  // When importing the local synthetics module directly
+  // it may import its own local dependencies, so we must
+  // make sure those will be resolved using Node's resolution
+  // algorithm, as they're still "node_modules" that we must bundle
+  const isLocalSyntheticsModule = (str: string) => {
+    return str.startsWith(SOURCE_NODE_MODULES);
+  };
+
   return {
     name: 'esbuild-multiasset-plugin',
     setup(build) {
       build.onResolve({ filter: /.*?/ }, async args => {
         // External and other packages need be marked external to
         // be removed from the bundle
-        if (
-          build.initialOptions.external?.includes(args.path) ||
-          !isBare(args.path)
-        ) {
+        if (build.initialOptions.external?.includes(args.path)) {
           return {
             external: true,
           };
         }
 
+        if (
+          !isBare(args.path) ||
+          args.importer.includes('/node_modules/') ||
+          isLocalSyntheticsModule(args.importer)
+        ) {
+          return;
+        }
+
         if (args.kind === 'entry-point') {
           return {
             path: args.path,
@@ -86,8 +111,12 @@ export function MultiAssetPlugin(callback: PluginCallback): esbuild.Plugin {
         // If the modules are resolved locally, then
         // use the imported path to get full path
         const entryPath =
-          path.join(path.dirname(args.importer), args.path) +
-          path.extname(args.importer);
+          join(dirname(args.importer), args.path) + extname(args.importer);
+
+        if (isLocalSynthetics(entryPath)) {
+          return { external: true };
+        }
+
         // Spin off another build to copy over the imported modules without bundling
         const result = await esbuild.build({
           ...commonOptions(),

package/src/push/request.ts

@@ -23,7 +23,7 @@
  *
  */
 
-import { bold } from 'kleur/colors';
+import { bold, red, yellow } from 'kleur/colors';
 import { Dispatcher, request } from 'undici';
 import { indent, symbols } from '../helpers';
 
@@ -47,7 +47,7 @@ export async function sendRequest(options: APIRequestOptions) {
       'user-agent': `Elastic/Synthetics ${version}`,
       'kbn-xsrf': 'true',
     },
-    headersTimeout: 60 * 1000
+    headersTimeout: 60 * 1000,
   });
 }
 
@@ -62,8 +62,10 @@ export type APIMonitorError = {
 };
 
 export function formatNotFoundError(message: string) {
-  return bold(
-    `${symbols['failed']} Please check your kibana url and try again - 404:${message}`
+  return red(
+    bold(
+      `${symbols['failed']} Please check your kibana url and try again - 404:${message}`
+    )
   );
 }
 
@@ -78,7 +80,7 @@ export function formatAPIError(
   );
   inner += indent(message, '    ');
   outer += indent(inner);
-  return outer;
+  return red(outer);
 }
 
 function formatMonitorError(errors: APIMonitorError[]) {
@@ -95,10 +97,10 @@ function formatMonitorError(errors: APIMonitorError[]) {
 
 export function formatFailedMonitors(errors: APIMonitorError[]) {
   const heading = bold(`${symbols['failed']} Error\n`);
-  return heading + formatMonitorError(errors);
+  return red(heading + formatMonitorError(errors));
 }
 
 export function formatStaleMonitors(errors: APIMonitorError[]) {
   const heading = bold(`${symbols['warning']} Warnings\n`);
-  return heading + formatMonitorError(errors);
+  return yellow(heading + formatMonitorError(errors));
 }

package/templates/synthetics.config.ts

@@ -16,6 +16,14 @@ export default env => {
       locations: ['{{locations}}'],
       privateLocations: ['{{privateLocations}}'],
     },
+    /**
+     * Project monitors settings
+     */
+    project: {
+      id: '{{id}}',
+      url: '{{url}}',
+      space: '{{space}}',
+    },
   };
   if (env !== 'development') {
     /**