feat: run pushed monitors locally in dry-run mode (#991)

* feat: run pushed monitors locally in dry-run mode

* move lookup code

* unpack all journeys and run local

* fix tests

* some cleanup

* review comments

* fix formatting issues

Author: vigneshshanmugam

__tests__/push/bundler.test.ts

@@ -25,7 +25,7 @@
 
 import { createReadStream } from 'fs';
 import { writeFile, unlink, mkdir, rm } from 'fs/promises';
-import unzipper from 'unzipper';
+import unzip from 'unzip-stream';
 import { join } from 'path';
 import { generateTempPath } from '../../src/helpers';
 import { Bundler } from '../../src/push/bundler';
@@ -74,11 +74,10 @@ async function validateZip(content) {
   await writeFile(pathToZip, decoded);
 
   const files: Array<string> = [];
-
   let contents = '';
   await new Promise(r => {
     createReadStream(pathToZip)
-      .pipe(unzipper.Parse())
+      .pipe(unzip.Parse())
       .on('entry', function (entry) {
         files.push(entry.path);
         contents += '\n' + entry.path + '\n';

__tests__/push/monitor.test.ts

@@ -70,11 +70,11 @@ describe('Monitors', () => {
   });
 
   it('build lightweight monitor schema', async () => {
-    const schema = await buildMonitorSchema(
+    const { schemas } = await buildMonitorSchema(
       [createTestMonitor('heartbeat.yml', 'http')],
       true
     );
-    expect(schema[0]).toEqual({
+    expect(schemas[0]).toEqual({
       id: 'test-monitor',
       name: 'test',
       schedule: 10,
@@ -89,8 +89,8 @@ describe('Monitors', () => {
 
   it('build browser monitor schema', async () => {
     const monitor = createTestMonitor('example.journey.ts');
-    const schema = await buildMonitorSchema([monitor], true);
-    expect(schema[0]).toEqual({
+    const { schemas } = await buildMonitorSchema([monitor], true);
+    expect(schemas[0]).toEqual({
       id: 'test-monitor',
       name: 'test',
       schedule: 10,
@@ -106,9 +106,9 @@ describe('Monitors', () => {
       fields: { area: 'website' },
     });
     monitor.update({ locations: ['brazil'], fields: { env: 'dev' } });
-    const schema1 = await buildMonitorSchema([monitor], true);
-    expect(schema1[0].hash).not.toEqual(schema[0].hash);
-    expect(schema1[0].fields).toEqual({
+    const { schemas: schemas1 } = await buildMonitorSchema([monitor], true);
+    expect(schemas1[0].hash).not.toEqual(schemas[0].hash);
+    expect(schemas1[0].fields).toEqual({
       area: 'website',
       env: 'dev',
     });

package-lock.json

@@ -75,6 +75,7 @@
     "source-map-support": "^0.5.21",
     "stack-utils": "^2.0.6",
     "undici": "^5.28.3",
+    "unzip-stream": "^0.3.4",
     "yaml": "^2.2.2"
   },
   "devDependencies": {
@@ -99,8 +100,7 @@
     "rimraf": "^3.0.2",
     "semantic-release": "^21.1.1",
     "ts-jest": "^29.1.1",
-    "typescript": "^5.1.6",
-    "unzipper": "^0.10.11"
+    "typescript": "^5.1.6"
   },
   "overrides": {
     "follow-redirects": "^1.15.6",

package.json

@@ -34,4 +34,16 @@ if (!global[SYNTHETICS_RUNNER]) {
   global[SYNTHETICS_RUNNER] = new Runner();
 }
 
+/**
+ * Set debug based on DEBUG ENV and namespace - synthetics
+ */
+if (process.env.DEBUG && process.env.DEBUG.includes('synthetics')) {
+  process.env['__SYNTHETICS__DEBUG__'] = '1';
+}
+
 export const runner: Runner = global[SYNTHETICS_RUNNER];
+
+// is Debug mode enabled
+export function inDebugMode() {
+  return !!process.env['__SYNTHETICS__DEBUG__'];
+}

src/core/globals.ts

@@ -25,16 +25,10 @@
 
 import { grey, cyan, dim, italic } from 'kleur/colors';
 import { now } from '../helpers';
-
-/**
- * Set debug based on DEBUG ENV and namespace - synthetics
- */
-if (process.env.DEBUG && process.env.DEBUG.includes('synthetics')) {
-  process.env['__SYNTHETICS__DEBUG__'] = '1';
-}
+import { inDebugMode } from './globals';
 
 export function log(msg) {
-  if (!process.env['__SYNTHETICS__DEBUG__'] || !msg) {
+  if (!inDebugMode() || !msg) {
     return;
   }
   if (typeof msg === 'object') {

src/core/logger.ts

@@ -158,6 +158,13 @@ export class Monitor {
       .digest('base64');
   }
 
+  /**
+   * Returns the size of the monitor in bytes which is sent as payload to Kibana
+   */
+  size() {
+    return JSON.stringify(this).length;
+  }
+
   validate() {
     const schedule = this.config.schedule;
     if (ALLOWED_SCHEDULES.includes(schedule)) {