@elastic/synthetics 1.0.0-beta.25 → 1.0.0-beta.26

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (116) hide show
  1. package/README.md +1 -1
  2. package/dist/cli.js +42 -5
  3. package/dist/cli.js.map +1 -1
  4. package/dist/common_types.d.ts +59 -5
  5. package/dist/common_types.d.ts.map +1 -1
  6. package/dist/core/gatherer.d.ts +2 -2
  7. package/dist/core/gatherer.d.ts.map +1 -1
  8. package/dist/core/gatherer.js.map +1 -1
  9. package/dist/core/index.d.ts +4 -0
  10. package/dist/core/index.d.ts.map +1 -1
  11. package/dist/core/index.js +15 -1
  12. package/dist/core/index.js.map +1 -1
  13. package/dist/core/runner.d.ts +10 -58
  14. package/dist/core/runner.d.ts.map +1 -1
  15. package/dist/core/runner.js +88 -49
  16. package/dist/core/runner.js.map +1 -1
  17. package/dist/dsl/journey.d.ts +3 -0
  18. package/dist/dsl/journey.d.ts.map +1 -1
  19. package/dist/dsl/journey.js +15 -0
  20. package/dist/dsl/journey.js.map +1 -1
  21. package/dist/dsl/monitor.d.ts +64 -0
  22. package/dist/dsl/monitor.d.ts.map +1 -0
  23. package/dist/dsl/monitor.js +62 -0
  24. package/dist/dsl/monitor.js.map +1 -0
  25. package/dist/generator/index.d.ts +13 -0
  26. package/dist/generator/index.d.ts.map +1 -0
  27. package/dist/generator/index.js +123 -0
  28. package/dist/generator/index.js.map +1 -0
  29. package/dist/{reporters/reporter.js → generator/utils.d.ts} +3 -3
  30. package/dist/generator/utils.d.ts.map +1 -0
  31. package/dist/generator/utils.js +44 -0
  32. package/dist/generator/utils.js.map +1 -0
  33. package/dist/helpers.d.ts +12 -6
  34. package/dist/helpers.d.ts.map +1 -1
  35. package/dist/helpers.js +33 -43
  36. package/dist/helpers.js.map +1 -1
  37. package/dist/index.d.ts +2 -7
  38. package/dist/index.d.ts.map +1 -1
  39. package/dist/index.js +4 -3
  40. package/dist/index.js.map +1 -1
  41. package/dist/loader.js +4 -4
  42. package/dist/loader.js.map +1 -1
  43. package/dist/options.d.ts +12 -0
  44. package/dist/options.d.ts.map +1 -1
  45. package/dist/options.js +66 -4
  46. package/dist/options.js.map +1 -1
  47. package/dist/plugins/performance.d.ts +1 -16
  48. package/dist/plugins/performance.d.ts.map +1 -1
  49. package/dist/plugins/performance.js.map +1 -1
  50. package/dist/plugins/plugin-manager.d.ts +1 -1
  51. package/dist/push/bundler.d.ts +34 -0
  52. package/dist/push/bundler.d.ts.map +1 -0
  53. package/dist/push/bundler.js +119 -0
  54. package/dist/push/bundler.js.map +1 -0
  55. package/{src/reporters/reporter.ts → dist/push/index.d.ts} +4 -11
  56. package/dist/push/index.d.ts.map +1 -0
  57. package/dist/push/index.js +58 -0
  58. package/dist/push/index.js.map +1 -0
  59. package/dist/{reporters/reporter.d.ts → push/monitor.d.ts} +7 -8
  60. package/dist/push/monitor.d.ts.map +1 -0
  61. package/dist/push/monitor.js +67 -0
  62. package/dist/push/monitor.js.map +1 -0
  63. package/dist/push/plugin.d.ts +33 -0
  64. package/dist/push/plugin.d.ts.map +1 -0
  65. package/dist/push/plugin.js +123 -0
  66. package/dist/push/plugin.js.map +1 -0
  67. package/dist/push/request.d.ts +43 -0
  68. package/dist/push/request.d.ts.map +1 -0
  69. package/dist/push/request.js +95 -0
  70. package/dist/push/request.js.map +1 -0
  71. package/dist/reporters/base.d.ts +14 -6
  72. package/dist/reporters/base.d.ts.map +1 -1
  73. package/dist/reporters/base.js +45 -47
  74. package/dist/reporters/base.js.map +1 -1
  75. package/dist/reporters/index.d.ts +18 -8
  76. package/dist/reporters/index.d.ts.map +1 -1
  77. package/dist/reporters/index.js.map +1 -1
  78. package/dist/reporters/json.d.ts +7 -3
  79. package/dist/reporters/json.d.ts.map +1 -1
  80. package/dist/reporters/json.js +118 -118
  81. package/dist/reporters/json.js.map +1 -1
  82. package/dist/reporters/junit.d.ts +7 -1
  83. package/dist/reporters/junit.d.ts.map +1 -1
  84. package/dist/reporters/junit.js +91 -86
  85. package/dist/reporters/junit.js.map +1 -1
  86. package/dist/tsconfig.tsbuildinfo +1 -1
  87. package/package.json +12 -8
  88. package/src/cli.ts +65 -9
  89. package/src/common_types.ts +69 -5
  90. package/src/core/gatherer.ts +2 -2
  91. package/src/core/index.ts +15 -0
  92. package/src/core/runner.ts +86 -113
  93. package/src/dsl/journey.ts +18 -0
  94. package/src/dsl/monitor.ts +83 -0
  95. package/src/generator/index.ts +159 -0
  96. package/src/generator/utils.ts +41 -0
  97. package/src/helpers.ts +36 -52
  98. package/src/index.ts +9 -1
  99. package/src/loader.ts +4 -4
  100. package/src/options.ts +71 -8
  101. package/src/plugins/performance.ts +1 -17
  102. package/src/push/bundler.ts +99 -0
  103. package/src/push/index.ts +63 -0
  104. package/src/push/monitor.ts +77 -0
  105. package/src/push/plugin.ts +113 -0
  106. package/src/push/request.ts +123 -0
  107. package/src/reporters/base.ts +57 -56
  108. package/src/reporters/index.ts +26 -3
  109. package/src/reporters/json.ts +153 -145
  110. package/src/reporters/junit.ts +98 -93
  111. package/templates/journeys/example.journey.ts +18 -0
  112. package/templates/synthetics.config.ts +19 -0
  113. package/CHANGELOG.md +0 -348
  114. package/NOTICE.txt +0 -221
  115. package/dist/reporters/reporter.d.ts.map +0 -1
  116. package/dist/reporters/reporter.js.map +0 -1
@@ -0,0 +1,95 @@
1
+ "use strict";
2
+ /**
3
+ * MIT License
4
+ *
5
+ * Copyright (c) 2020-present, Elastic NV
6
+ *
7
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
8
+ * of this software and associated documentation files (the "Software"), to deal
9
+ * in the Software without restriction, including without limitation the rights
10
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11
+ * copies of the Software, and to permit persons to whom the Software is
12
+ * furnished to do so, subject to the following conditions:
13
+ *
14
+ * The above copyright notice and this permission notice shall be included in
15
+ * all copies or substantial portions of the Software.
16
+ *
17
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23
+ * THE SOFTWARE.
24
+ *
25
+ */
26
+ Object.defineProperty(exports, "__esModule", { value: true });
27
+ exports.formatStaleMonitors = exports.formatFailedMonitors = exports.formatAPIError = exports.formatNotFoundError = exports.createMonitors = exports.ok = void 0;
28
+ const colors_1 = require("kleur/colors");
29
+ const undici_1 = require("undici");
30
+ const helpers_1 = require("../helpers");
31
+ /* eslint-disable @typescript-eslint/no-var-requires */
32
+ const { version } = require('../../package.json');
33
+ function encodeAuth(auth) {
34
+ if (auth.includes(':')) {
35
+ return Buffer.from(auth).toString('base64');
36
+ }
37
+ return auth;
38
+ }
39
+ function getAPIUrl(options) {
40
+ return (options.url + `/s/${options.space}/api/synthetics/service/project/monitors`);
41
+ }
42
+ function ok(statusCode) {
43
+ return statusCode >= 200 && statusCode <= 299;
44
+ }
45
+ exports.ok = ok;
46
+ async function createMonitors(monitors, options) {
47
+ const schema = {
48
+ project: options.project,
49
+ keep_stale: !options.delete,
50
+ monitors,
51
+ };
52
+ return await (0, undici_1.request)(getAPIUrl(options), {
53
+ method: 'PUT',
54
+ body: JSON.stringify(schema),
55
+ headers: {
56
+ authorization: `Basic ${encodeAuth(options.auth)}`,
57
+ 'content-type': 'application/json',
58
+ 'user-agent': `Elastic/Synthetics ${version}`,
59
+ 'kbn-xsrf': 'true',
60
+ },
61
+ });
62
+ }
63
+ exports.createMonitors = createMonitors;
64
+ function formatNotFoundError(message) {
65
+ return (0, colors_1.bold)(`${helpers_1.symbols['failed']} Please check your kibana url and try again - 404:${message}`);
66
+ }
67
+ exports.formatNotFoundError = formatNotFoundError;
68
+ function formatAPIError(statuCode, error, message) {
69
+ let outer = (0, colors_1.bold)(`${helpers_1.symbols['failed']} Error\n`);
70
+ let inner = (0, colors_1.bold)(`${helpers_1.symbols['failed']} monitor creation failed - ${statuCode}:${error}\n`);
71
+ inner += (0, helpers_1.indent)(message, ' ');
72
+ outer += (0, helpers_1.indent)(inner);
73
+ return outer;
74
+ }
75
+ exports.formatAPIError = formatAPIError;
76
+ function formatFailedMonitors(errors) {
77
+ let outer = (0, colors_1.bold)(`${helpers_1.symbols['failed']} Error\n`);
78
+ for (const error of errors) {
79
+ const monitorId = error.id ? `: monitor(${error.id})` : '';
80
+ let inner = (0, colors_1.bold)(`> ${error.reason}${monitorId}\n`);
81
+ inner += (0, helpers_1.indent)(error.details, ' ');
82
+ outer += (0, helpers_1.indent)(inner) + '\n';
83
+ outer += '\n';
84
+ }
85
+ return outer;
86
+ }
87
+ exports.formatFailedMonitors = formatFailedMonitors;
88
+ function formatStaleMonitors() {
89
+ let outer = (0, colors_1.bold)((0, colors_1.yellow)(`${helpers_1.symbols['warning']} Found stale monitors\n`));
90
+ const inner = (0, colors_1.gray)(`Pass --delete to remove all the stale monitors.`);
91
+ outer += (0, helpers_1.indent)(inner, ' ');
92
+ return outer;
93
+ }
94
+ exports.formatStaleMonitors = formatStaleMonitors;
95
+ //# sourceMappingURL=request.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"request.js","sourceRoot":"","sources":["../../src/push/request.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;;;AAEH,yCAAkD;AAClD,mCAAiC;AAEjC,wCAA6C;AAG7C,uDAAuD;AACvD,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAQlD,SAAS,UAAU,CAAC,IAAY;IAC9B,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;QACtB,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;KAC7C;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,SAAS,CAAC,OAAoB;IACrC,OAAO,CACL,OAAO,CAAC,GAAG,GAAG,MAAM,OAAO,CAAC,KAAK,0CAA0C,CAC5E,CAAC;AACJ,CAAC;AAED,SAAgB,EAAE,CAAC,UAAkB;IACnC,OAAO,UAAU,IAAI,GAAG,IAAI,UAAU,IAAI,GAAG,CAAC;AAChD,CAAC;AAFD,gBAEC;AAEM,KAAK,UAAU,cAAc,CAClC,QAAyB,EACzB,OAAoB;IAEpB,MAAM,MAAM,GAAc;QACxB,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,UAAU,EAAE,CAAC,OAAO,CAAC,MAAM;QAC3B,QAAQ;KACT,CAAC;IAEF,OAAO,MAAM,IAAA,gBAAO,EAAC,SAAS,CAAC,OAAO,CAAC,EAAE;QACvC,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;QAC5B,OAAO,EAAE;YACP,aAAa,EAAE,SAAS,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YAClD,cAAc,EAAE,kBAAkB;YAClC,YAAY,EAAE,sBAAsB,OAAO,EAAE;YAC7C,UAAU,EAAE,MAAM;SACnB;KACF,CAAC,CAAC;AACL,CAAC;AApBD,wCAoBC;AAQD,SAAgB,mBAAmB,CAAC,OAAe;IACjD,OAAO,IAAA,aAAI,EACT,GAAG,iBAAO,CAAC,QAAQ,CAAC,qDAAqD,OAAO,EAAE,CACnF,CAAC;AACJ,CAAC;AAJD,kDAIC;AAED,SAAgB,cAAc,CAC5B,SAAiB,EACjB,KAAa,EACb,OAAe;IAEf,IAAI,KAAK,GAAG,IAAA,aAAI,EAAC,GAAG,iBAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;IACjD,IAAI,KAAK,GAAG,IAAA,aAAI,EACd,GAAG,iBAAO,CAAC,QAAQ,CAAC,8BAA8B,SAAS,IAAI,KAAK,IAAI,CACzE,CAAC;IACF,KAAK,IAAI,IAAA,gBAAM,EAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IACjC,KAAK,IAAI,IAAA,gBAAM,EAAC,KAAK,CAAC,CAAC;IACvB,OAAO,KAAK,CAAC;AACf,CAAC;AAZD,wCAYC;AAED,SAAgB,oBAAoB,CAAC,MAAyB;IAC5D,IAAI,KAAK,GAAG,IAAA,aAAI,EAAC,GAAG,iBAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;IACjD,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;QAC1B,MAAM,SAAS,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,aAAa,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3D,IAAI,KAAK,GAAG,IAAA,aAAI,EAAC,KAAK,KAAK,CAAC,MAAM,GAAG,SAAS,IAAI,CAAC,CAAC;QACpD,KAAK,IAAI,IAAA,gBAAM,EAAC,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACvC,KAAK,IAAI,IAAA,gBAAM,EAAC,KAAK,CAAC,GAAG,IAAI,CAAC;QAC9B,KAAK,IAAI,IAAI,CAAC;KACf;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAVD,oDAUC;AAED,SAAgB,mBAAmB;IACjC,IAAI,KAAK,GAAG,IAAA,aAAI,EAAC,IAAA,eAAM,EAAC,GAAG,iBAAO,CAAC,SAAS,CAAC,yBAAyB,CAAC,CAAC,CAAC;IACzE,MAAM,KAAK,GAAG,IAAA,aAAI,EAAC,iDAAiD,CAAC,CAAC;IACtE,KAAK,IAAI,IAAA,gBAAM,EAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAC9B,OAAO,KAAK,CAAC;AACf,CAAC;AALD,kDAKC"}
@@ -23,14 +23,22 @@
23
23
  *
24
24
  */
25
25
  import SonicBoom from 'sonic-boom';
26
- import Runner from '../core/runner';
27
- import { ReporterOptions } from './reporter';
28
- export default class BaseReporter {
29
- runner: Runner;
26
+ import { Reporter, ReporterOptions } from '.';
27
+ import { JourneyEndResult, JourneyStartResult, StepEndResult } from '../common_types';
28
+ import { Journey, Step } from '../dsl';
29
+ export default class BaseReporter implements Reporter {
30
30
  stream: SonicBoom;
31
31
  fd: number;
32
- constructor(runner: Runner, options?: ReporterOptions);
33
- _registerListeners(): void;
32
+ metrics: {
33
+ succeeded: number;
34
+ failed: number;
35
+ skipped: number;
36
+ };
37
+ constructor(options?: ReporterOptions);
38
+ onJourneyStart(journey: Journey, {}: JourneyStartResult): void;
39
+ onStepEnd(journey: Journey, step: Step, result: StepEndResult): void;
40
+ onJourneyEnd(journey: Journey, { error }: JourneyEndResult): void;
41
+ onEnd(): void;
34
42
  write(message: any): void;
35
43
  }
36
44
  //# sourceMappingURL=base.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../src/reporters/base.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,OAAO,SAAS,MAAM,YAAY,CAAC;AAEnC,OAAO,MAAM,MAAM,gBAAgB,CAAC;AAQpC,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAyB7C,MAAM,CAAC,OAAO,OAAO,YAAY;IAIZ,MAAM,EAAE,MAAM;IAHjC,MAAM,EAAE,SAAS,CAAC;IAClB,EAAE,EAAE,MAAM,CAAC;gBAEQ,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,eAAoB;IAiBhE,kBAAkB;IAqDlB,KAAK,CAAC,OAAO,KAAA;CAMd"}
1
+ {"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../src/reporters/base.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,OAAO,SAAS,MAAM,YAAY,CAAC;AASnC,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,GAAG,CAAC;AAC9C,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,aAAa,EACd,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAyBvC,MAAM,CAAC,OAAO,OAAO,YAAa,YAAW,QAAQ;IACnD,MAAM,EAAE,SAAS,CAAC;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO;;;;MAIL;gBAEU,OAAO,GAAE,eAAoB;IAUzC,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,kBAAkB;IAIvD,SAAS,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,aAAa;IAW7D,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,EAAE,gBAAgB;IAY1D,KAAK;IAwBL,KAAK,CAAC,OAAO,KAAA;CAMd"}
@@ -52,8 +52,12 @@ function renderDuration(durationMs) {
52
52
  return parseInt(durationMs);
53
53
  }
54
54
  class BaseReporter {
55
- constructor(runner, options = {}) {
56
- this.runner = runner;
55
+ constructor(options = {}) {
56
+ this.metrics = {
57
+ succeeded: 0,
58
+ failed: 0,
59
+ skipped: 0,
60
+ };
57
61
  this.fd = options.fd || process.stdout.fd;
58
62
  /**
59
63
  * minLength is set to 1 byte to make sure we flush the
@@ -61,54 +65,48 @@ class BaseReporter {
61
65
  * before destroying the pipe with underlying file descriptor
62
66
  */
63
67
  this.stream = new sonic_boom_1.default({ fd: this.fd, sync: true, minLength: 1 });
64
- // flushSync is used here to make sure all the data from the underlying
65
- // SonicBoom stream buffer is completely written to the fd before closing
66
- // the process
67
- this.runner.on('end', () => this.stream.flushSync());
68
- this._registerListeners();
69
68
  }
70
- _registerListeners() {
71
- const result = {
72
- succeeded: 0,
73
- failed: 0,
74
- skipped: 0,
75
- };
76
- this.runner.on('journey:start', ({ journey }) => {
77
- this.write(`\nJourney: ${journey.name}`);
78
- });
79
- this.runner.on('step:end', ({ step, start, end, error, status }) => {
80
- const message = `${helpers_1.symbols[status]} Step: '${step.name}' ${status} (${renderDuration((end - start) * 1000)} ms)`;
81
- this.write((0, helpers_1.indent)(message));
82
- error && this.write(renderError(error));
83
- result[status]++;
84
- });
85
- this.runner.on('journey:end', ({ error }) => {
86
- const { failed, succeeded, skipped } = result;
87
- const total = failed + succeeded + skipped;
88
- /**
89
- * Render the error on the terminal only when no steps could
90
- * be executed which means the error happened in one of the hooks
91
- */
92
- if (total === 0 && error) {
93
- this.write(renderError(error));
94
- }
95
- });
96
- this.runner.on('end', () => {
97
- const { failed, succeeded, skipped } = result;
98
- const total = failed + succeeded + skipped;
99
- let message = '\n';
100
- if (total === 0) {
101
- message = 'No tests found!';
102
- message += ` (${renderDuration((0, helpers_1.now)())} ms) \n`;
103
- this.write(message);
104
- return;
105
- }
106
- message += succeeded > 0 ? (0, colors_1.green)(` ${succeeded} passed`) : '';
107
- message += failed > 0 ? (0, colors_1.red)(` ${failed} failed`) : '';
108
- message += skipped > 0 ? (0, colors_1.cyan)(` ${skipped} skipped`) : '';
69
+ onJourneyStart(journey, {}) {
70
+ this.write(`\nJourney: ${journey.name}`);
71
+ }
72
+ onStepEnd(journey, step, result) {
73
+ const { status, end, start, error } = result;
74
+ const message = `${helpers_1.symbols[status]} Step: '${step.name}' ${status} (${renderDuration((end - start) * 1000)} ms)`;
75
+ this.write((0, helpers_1.indent)(message));
76
+ error && this.write(renderError(error));
77
+ this.metrics[status]++;
78
+ }
79
+ /* eslint-disable @typescript-eslint/no-unused-vars */
80
+ onJourneyEnd(journey, { error }) {
81
+ const { failed, succeeded, skipped } = this.metrics;
82
+ const total = failed + succeeded + skipped;
83
+ /**
84
+ * Render the error on the terminal only when no steps could
85
+ * be executed which means the error happened in one of the hooks
86
+ */
87
+ if (total === 0 && error) {
88
+ this.write(renderError(error));
89
+ }
90
+ }
91
+ onEnd() {
92
+ const { failed, succeeded, skipped } = this.metrics;
93
+ const total = failed + succeeded + skipped;
94
+ let message = '\n';
95
+ if (total === 0) {
96
+ message = 'No tests found!';
109
97
  message += ` (${renderDuration((0, helpers_1.now)())} ms) \n`;
110
98
  this.write(message);
111
- });
99
+ return;
100
+ }
101
+ message += succeeded > 0 ? (0, colors_1.green)(` ${succeeded} passed`) : '';
102
+ message += failed > 0 ? (0, colors_1.red)(` ${failed} failed`) : '';
103
+ message += skipped > 0 ? (0, colors_1.cyan)(` ${skipped} skipped`) : '';
104
+ message += ` (${renderDuration((0, helpers_1.now)())} ms) \n`;
105
+ this.write(message);
106
+ // flushSync is used here to make sure all the data from the underlying
107
+ // SonicBoom stream buffer is completely written to the fd before closing
108
+ // the process
109
+ this.stream.flushSync();
112
110
  }
113
111
  write(message) {
114
112
  if (typeof message == 'object') {
@@ -1 +1 @@
1
- {"version":3,"file":"base.js","sourceRoot":"","sources":["../../src/reporters/base.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;;;;;AAEH,4DAAmC;AACnC,yCAAgD;AAEhD,wCAMoB;AAGpB,SAAS,WAAW,CAAC,KAAK;IACxB,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,MAAM,KAAK,GAAG,IAAA,gBAAM,EAAC,EAAE,CAAC,CAAC;IACzB,MAAM,KAAK,GAAG,IAAA,gBAAM,EAAC,KAAK,CAAC,CAAC;IAC5B,MAAM,SAAS,GAAG,KAAK,GAAG,OAAO,CAAC;IAClC,MAAM,IAAI,SAAS,CAAC;IACpB,IAAI,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;IACxB,IAAI,KAAK,EAAE;QACT,MAAM,IAAI,KAAK,GAAG,aAAa,CAAC;QAChC,KAAK,GAAG,IAAA,2BAAiB,EAAC,KAAK,EAAE,IAAA,2BAAiB,EAAC,KAAK,CAAC,CAAC,CAAC;QAC3D,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACxC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,MAAM,IAAI,KAAK,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;SACtC;KACF;IACD,MAAM,IAAI,SAAS,CAAC;IACpB,OAAO,IAAA,YAAG,EAAC,MAAM,CAAC,CAAC;AACrB,CAAC;AAED,SAAS,cAAc,CAAC,UAAU;IAChC,OAAO,QAAQ,CAAC,UAAU,CAAC,CAAC;AAC9B,CAAC;AAED,MAAqB,YAAY;IAI/B,YAAmB,MAAc,EAAE,UAA2B,EAAE;QAA7C,WAAM,GAAN,MAAM,CAAQ;QAC/B,IAAI,CAAC,EAAE,GAAG,OAAO,CAAC,EAAE,IAAI,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1C;;;;WAIG;QACH,IAAI,CAAC,MAAM,GAAG,IAAI,oBAAS,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC,CAAC;QAEvE,uEAAuE;QACvE,yEAAyE;QACzE,cAAc;QACd,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;QAErD,IAAI,CAAC,kBAAkB,EAAE,CAAC;IAC5B,CAAC;IAED,kBAAkB;QAChB,MAAM,MAAM,GAAG;YACb,SAAS,EAAE,CAAC;YACZ,MAAM,EAAE,CAAC;YACT,OAAO,EAAE,CAAC;SACX,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,eAAe,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE;YAC9C,IAAI,CAAC,KAAK,CAAC,cAAc,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE;YACjE,MAAM,OAAO,GAAG,GAAG,iBAAO,CAAC,MAAM,CAAC,YAChC,IAAI,CAAC,IACP,KAAK,MAAM,KAAK,cAAc,CAAC,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;YAC3D,IAAI,CAAC,KAAK,CAAC,IAAA,gBAAM,EAAC,OAAO,CAAC,CAAC,CAAC;YAC5B,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;YACxC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;QACnB,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,aAAa,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE;YAC1C,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;YAC9C,MAAM,KAAK,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC;YAE3C;;;eAGG;YACH,IAAI,KAAK,KAAK,CAAC,IAAI,KAAK,EAAE;gBACxB,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;aAChC;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;YACzB,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;YAC9C,MAAM,KAAK,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC;YAE3C,IAAI,OAAO,GAAG,IAAI,CAAC;YACnB,IAAI,KAAK,KAAK,CAAC,EAAE;gBACf,OAAO,GAAG,iBAAiB,CAAC;gBAC5B,OAAO,IAAI,KAAK,cAAc,CAAC,IAAA,aAAG,GAAE,CAAC,SAAS,CAAC;gBAC/C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBACpB,OAAO;aACR;YAED,OAAO,IAAI,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,IAAA,cAAK,EAAC,IAAI,SAAS,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC9D,OAAO,IAAI,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAA,YAAG,EAAC,IAAI,MAAM,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACtD,OAAO,IAAI,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,IAAA,aAAI,EAAC,IAAI,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC1D,OAAO,IAAI,KAAK,cAAc,CAAC,IAAA,aAAG,GAAE,CAAC,SAAS,CAAC;YAC/C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,OAAO;QACX,IAAI,OAAO,OAAO,IAAI,QAAQ,EAAE;YAC9B,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;SACnC;QACD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;IACpC,CAAC;CACF;AAhFD,+BAgFC"}
1
+ {"version":3,"file":"base.js","sourceRoot":"","sources":["../../src/reporters/base.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;;;;;AAEH,4DAAmC;AACnC,yCAAgD;AAChD,wCAMoB;AASpB,SAAS,WAAW,CAAC,KAAK;IACxB,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,MAAM,KAAK,GAAG,IAAA,gBAAM,EAAC,EAAE,CAAC,CAAC;IACzB,MAAM,KAAK,GAAG,IAAA,gBAAM,EAAC,KAAK,CAAC,CAAC;IAC5B,MAAM,SAAS,GAAG,KAAK,GAAG,OAAO,CAAC;IAClC,MAAM,IAAI,SAAS,CAAC;IACpB,IAAI,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;IACxB,IAAI,KAAK,EAAE;QACT,MAAM,IAAI,KAAK,GAAG,aAAa,CAAC;QAChC,KAAK,GAAG,IAAA,2BAAiB,EAAC,KAAK,EAAE,IAAA,2BAAiB,EAAC,KAAK,CAAC,CAAC,CAAC;QAC3D,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACxC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,MAAM,IAAI,KAAK,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;SACtC;KACF;IACD,MAAM,IAAI,SAAS,CAAC;IACpB,OAAO,IAAA,YAAG,EAAC,MAAM,CAAC,CAAC;AACrB,CAAC;AAED,SAAS,cAAc,CAAC,UAAU;IAChC,OAAO,QAAQ,CAAC,UAAU,CAAC,CAAC;AAC9B,CAAC;AAED,MAAqB,YAAY;IAS/B,YAAY,UAA2B,EAAE;QANzC,YAAO,GAAG;YACR,SAAS,EAAE,CAAC;YACZ,MAAM,EAAE,CAAC;YACT,OAAO,EAAE,CAAC;SACX,CAAC;QAGA,IAAI,CAAC,EAAE,GAAG,OAAO,CAAC,EAAE,IAAI,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1C;;;;WAIG;QACH,IAAI,CAAC,MAAM,GAAG,IAAI,oBAAS,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC,CAAC;IACzE,CAAC;IAED,cAAc,CAAC,OAAgB,EAAE,EAAsB;QACrD,IAAI,CAAC,KAAK,CAAC,cAAc,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IAC3C,CAAC;IAED,SAAS,CAAC,OAAgB,EAAE,IAAU,EAAE,MAAqB;QAC3D,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;QAC7C,MAAM,OAAO,GAAG,GAAG,iBAAO,CAAC,MAAM,CAAC,YAChC,IAAI,CAAC,IACP,KAAK,MAAM,KAAK,cAAc,CAAC,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3D,IAAI,CAAC,KAAK,CAAC,IAAA,gBAAM,EAAC,OAAO,CAAC,CAAC,CAAC;QAC5B,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;QACxC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;IACzB,CAAC;IAED,sDAAsD;IACtD,YAAY,CAAC,OAAgB,EAAE,EAAE,KAAK,EAAoB;QACxD,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QACpD,MAAM,KAAK,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC;QAC3C;;;WAGG;QACH,IAAI,KAAK,KAAK,CAAC,IAAI,KAAK,EAAE;YACxB,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;SAChC;IACH,CAAC;IAED,KAAK;QACH,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QACpD,MAAM,KAAK,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC;QAE3C,IAAI,OAAO,GAAG,IAAI,CAAC;QACnB,IAAI,KAAK,KAAK,CAAC,EAAE;YACf,OAAO,GAAG,iBAAiB,CAAC;YAC5B,OAAO,IAAI,KAAK,cAAc,CAAC,IAAA,aAAG,GAAE,CAAC,SAAS,CAAC;YAC/C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACpB,OAAO;SACR;QAED,OAAO,IAAI,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,IAAA,cAAK,EAAC,IAAI,SAAS,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9D,OAAO,IAAI,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAA,YAAG,EAAC,IAAI,MAAM,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACtD,OAAO,IAAI,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,IAAA,aAAI,EAAC,IAAI,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1D,OAAO,IAAI,KAAK,cAAc,CAAC,IAAA,aAAG,GAAE,CAAC,SAAS,CAAC;QAC/C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAEpB,uEAAuE;QACvE,yEAAyE;QACzE,cAAc;QACd,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;IAC1B,CAAC;IAED,KAAK,CAAC,OAAO;QACX,IAAI,OAAO,OAAO,IAAI,QAAQ,EAAE;YAC9B,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;SACnC;QACD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;IACpC,CAAC;CACF;AA5ED,+BA4EC"}
@@ -22,14 +22,24 @@
22
22
  * THE SOFTWARE.
23
23
  *
24
24
  */
25
- import BaseReporter from './base';
26
- import JSONReporter from './json';
27
- import JUnitReporter from './junit';
28
- import Reporter, { ReporterOptions } from './reporter';
29
- export { Reporter, ReporterOptions };
25
+ import { Journey, Step } from '../dsl';
26
+ import { StartEvent, JourneyEndResult, JourneyStartResult, StepEndResult } from '../common_types';
27
+ export declare type ReporterOptions = {
28
+ fd?: number;
29
+ colors?: boolean;
30
+ };
31
+ export declare type BuiltInReporterName = 'default' | 'json' | 'junit';
32
+ export declare type ReporterInstance = new (opts: ReporterOptions) => Reporter;
30
33
  export declare const reporters: {
31
- default: typeof BaseReporter;
32
- json: typeof JSONReporter;
33
- junit: typeof JUnitReporter;
34
+ [key in BuiltInReporterName]: ReporterInstance;
34
35
  };
36
+ export interface Reporter {
37
+ onStart?(params: StartEvent): void;
38
+ onJourneyRegister?(journey: Journey): void;
39
+ onJourneyStart?(journey: Journey, result: JourneyStartResult): void;
40
+ onStepStart?(journey: Journey, step: Step): void;
41
+ onStepEnd?(journey: Journey, step: Step, result: StepEndResult): void;
42
+ onJourneyEnd?(journey: Journey, result: JourneyEndResult): void | Promise<void>;
43
+ onEnd?(): void | Promise<void>;
44
+ }
35
45
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/reporters/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,OAAO,YAAY,MAAM,QAAQ,CAAC;AAClC,OAAO,YAAY,MAAM,QAAQ,CAAC;AAClC,OAAO,aAAa,MAAM,SAAS,CAAC;AACpC,OAAO,QAAQ,EAAE,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAEvD,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,CAAC;AACrC,eAAO,MAAM,SAAS;;;;CAIrB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/reporters/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAKH,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACvC,OAAO,EACL,UAAU,EACV,gBAAgB,EAChB,kBAAkB,EAClB,aAAa,EACd,MAAM,iBAAiB,CAAC;AAEzB,oBAAY,eAAe,GAAG;IAAE,EAAE,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC;AAChE,oBAAY,mBAAmB,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,CAAC;AAC/D,oBAAY,gBAAgB,GAAG,KAAK,IAAI,EAAE,eAAe,KAAK,QAAQ,CAAC;AACvE,eAAO,MAAM,SAAS,EAAE;KACrB,GAAG,IAAI,mBAAmB,GAAG,gBAAgB;CAK/C,CAAC;AAEF,MAAM,WAAW,QAAQ;IACvB,OAAO,CAAC,CAAC,MAAM,EAAE,UAAU,GAAG,IAAI,CAAC;IACnC,iBAAiB,CAAC,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IAC3C,cAAc,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,kBAAkB,GAAG,IAAI,CAAC;IACpE,WAAW,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;IACjD,SAAS,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,aAAa,GAAG,IAAI,CAAC;IACtE,YAAY,CAAC,CACX,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,gBAAgB,GACvB,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxB,KAAK,CAAC,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAChC"}
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/reporters/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;;;;;;AAEH,kDAAkC;AAClC,kDAAkC;AAClC,oDAAoC;AAIvB,QAAA,SAAS,GAAG;IACvB,OAAO,EAAE,cAAY;IACrB,IAAI,EAAE,cAAY;IAClB,KAAK,EAAE,eAAa;CACrB,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/reporters/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;;;;;;AAEH,kDAAkC;AAClC,kDAAkC;AAClC,oDAAoC;AAYvB,QAAA,SAAS,GAElB;IACF,OAAO,EAAE,cAAY;IACrB,IAAI,EAAE,cAAY;IAClB,KAAK,EAAE,eAAa;CACrB,CAAC"}
@@ -25,8 +25,7 @@
25
25
  /// <reference types="node" />
26
26
  import BaseReporter from './base';
27
27
  import { Journey, Step } from '../dsl';
28
- import { NetworkInfo, NetworkConditions, TraceOutput, StatusValue, PerfMetrics, Params, Screenshot } from '../common_types';
29
- import { PageMetrics } from '../plugins';
28
+ import { NetworkInfo, NetworkConditions, TraceOutput, StatusValue, PerfMetrics, Params, Screenshot, StartEvent, JourneyStartResult, StepEndResult, JourneyEndResult, PageMetrics } from '../common_types';
30
29
  declare type OutputType = 'synthetics/metadata' | 'journey/register' | 'journey/start' | 'screenshot/block' | 'step/screenshot_ref' | 'step/screenshot' | 'step/metrics' | 'step/filmstrips' | 'step/end' | 'journey/network_info' | 'journey/browserconsole' | 'journey/end';
31
30
  declare type Payload = {
32
31
  source?: string;
@@ -116,7 +115,12 @@ export declare function getScreenshotBlocks(screenshot: Buffer): Promise<{
116
115
  */
117
116
  export declare function gatherScreenshots(screenshotsPath: string, callback: (data: Screenshot) => Promise<void>): Promise<void>;
118
117
  export default class JSONReporter extends BaseReporter {
119
- _registerListeners(): void;
118
+ onStart(params: StartEvent): void;
119
+ onJourneyRegister(journey: Journey): void;
120
+ onJourneyStart(journey: Journey, { timestamp, params }: JourneyStartResult): void;
121
+ onStepEnd(journey: Journey, step: Step, { start, end, error, url, status, pagemetrics, traces, metrics, filmstrips, }: StepEndResult): void;
122
+ onJourneyEnd(journey: Journey, { timestamp, start, end, networkinfo, browserconsole, status, error, options, }: JourneyEndResult): Promise<void>;
123
+ onEnd(): void;
120
124
  writeScreenshotBlocks(journey: Journey, screenshot: Screenshot): Promise<void>;
121
125
  writeMetrics(journey: Journey, step: Step, type: string, events: Array<TraceOutput> | PerfMetrics): void;
122
126
  writeJSON({ _id, journey, type, timestamp, step, root_fields, error, payload, blob, blob_mime, url, }: OutputFields): void;
@@ -1 +1 @@
1
- {"version":3,"file":"json.d.ts","sourceRoot":"","sources":["../../src/reporters/json.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;;AAMH,OAAO,YAAY,MAAM,QAAQ,CAAC;AASlC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEvC,OAAO,EACL,WAAW,EAEX,iBAAiB,EACjB,WAAW,EACX,WAAW,EACX,WAAW,EACX,MAAM,EACN,UAAU,EACX,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAKzC,aAAK,UAAU,GACX,qBAAqB,GACrB,kBAAkB,GAClB,eAAe,GACf,kBAAkB,GAClB,qBAAqB,GACrB,iBAAiB,GACjB,cAAc,GACd,iBAAiB,GACjB,UAAU,GACV,sBAAsB,GACtB,wBAAwB,GACxB,aAAa,CAAC;AAElB,aAAK,OAAO,GAAG;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,kBAAkB,CAAC,EAAE,iBAAiB,CAAC;CACxC,CAAC;AAEF,aAAK,YAAY,GAAG;IAClB,IAAI,EAAE,UAAU,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG;QACrB,QAAQ,CAAC,EAAE;YACT,EAAE,EAAE,MAAM,CAAC;SACZ,CAAC;KACH,CAAC;IACF,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACtC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,aAAK,cAAc,GAAG;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF,aAAK,mBAAmB,GAAG;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,KAAK,CAAC;QACZ,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;QACZ,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC,CAAC;CACJ,CAAC;AAqCF,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAkCvD;AAkCD,wBAAsB,mBAAmB,CAAC,UAAU,EAAE,MAAM;;;;GAoD3D;AAED;;;;GAIG;AACH,wBAAsB,iBAAiB,CACrC,eAAe,EAAE,MAAM,EACvB,QAAQ,EAAE,CAAC,IAAI,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC,iBAa9C;AAED,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,YAAY;IAC3C,kBAAkB;IA+KrB,qBAAqB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,UAAU;IAyBpE,YAAY,CACV,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE,IAAI,EACV,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,KAAK,CAAC,WAAW,CAAC,GAAG,WAAW;IAuB1C,SAAS,CAAC,EACR,GAAG,EACH,OAAO,EACP,IAAI,EACJ,SAAS,EACT,IAAI,EACJ,WAAW,EACX,KAAK,EACL,OAAO,EACP,IAAI,EACJ,SAAS,EACT,GAAG,GACJ,EAAE,YAAY;CAgBhB"}
1
+ {"version":3,"file":"json.d.ts","sourceRoot":"","sources":["../../src/reporters/json.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;;AAMH,OAAO,YAAY,MAAM,QAAQ,CAAC;AASlC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEvC,OAAO,EACL,WAAW,EAEX,iBAAiB,EACjB,WAAW,EACX,WAAW,EACX,WAAW,EACX,MAAM,EACN,UAAU,EACV,UAAU,EACV,kBAAkB,EAClB,aAAa,EACb,gBAAgB,EAChB,WAAW,EACZ,MAAM,iBAAiB,CAAC;AAKzB,aAAK,UAAU,GACX,qBAAqB,GACrB,kBAAkB,GAClB,eAAe,GACf,kBAAkB,GAClB,qBAAqB,GACrB,iBAAiB,GACjB,cAAc,GACd,iBAAiB,GACjB,UAAU,GACV,sBAAsB,GACtB,wBAAwB,GACxB,aAAa,CAAC;AAElB,aAAK,OAAO,GAAG;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,kBAAkB,CAAC,EAAE,iBAAiB,CAAC;CACxC,CAAC;AAEF,aAAK,YAAY,GAAG;IAClB,IAAI,EAAE,UAAU,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG;QACrB,QAAQ,CAAC,EAAE;YACT,EAAE,EAAE,MAAM,CAAC;SACZ,CAAC;KACH,CAAC;IACF,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACtC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,aAAK,cAAc,GAAG;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF,aAAK,mBAAmB,GAAG;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,KAAK,CAAC;QACZ,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;QACZ,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC,CAAC;CACJ,CAAC;AAqCF,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAkCvD;AAkCD,wBAAsB,mBAAmB,CAAC,UAAU,EAAE,MAAM;;;;GAoD3D;AAED;;;;GAIG;AACH,wBAAsB,iBAAiB,CACrC,eAAe,EAAE,MAAM,EACvB,QAAQ,EAAE,CAAC,IAAI,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC,iBAa9C;AAED,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,YAAY;IACpD,OAAO,CAAC,MAAM,EAAE,UAAU;IAkB1B,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAOhC,cAAc,CACrB,OAAO,EAAE,OAAO,EAChB,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,kBAAkB;IAUlC,SAAS,CAChB,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE,IAAI,EACV,EACE,KAAK,EACL,GAAG,EACH,KAAK,EACL,GAAG,EACH,MAAM,EACN,WAAW,EACX,MAAM,EACN,OAAO,EACP,UAAU,GACX,EAAE,aAAa;IAyCH,YAAY,CACzB,OAAO,EAAE,OAAO,EAChB,EACE,SAAS,EACT,KAAK,EACL,GAAG,EACH,WAAW,EACX,cAAc,EACd,MAAM,EACN,KAAK,EACL,OAAO,GACR,EAAE,gBAAgB;IAyEZ,KAAK;IAIR,qBAAqB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,UAAU;IAyBpE,YAAY,CACV,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE,IAAI,EACV,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,KAAK,CAAC,WAAW,CAAC,GAAG,WAAW;IAuB1C,SAAS,CAAC,EACR,GAAG,EACH,OAAO,EACP,IAAI,EACJ,SAAS,EACT,IAAI,EACJ,WAAW,EACX,KAAK,EACL,OAAO,EACP,IAAI,EACJ,SAAS,EACT,GAAG,GACJ,EAAE,YAAY;CAgBhB"}
@@ -198,143 +198,143 @@ async function gatherScreenshots(screenshotsPath, callback) {
198
198
  }
199
199
  exports.gatherScreenshots = gatherScreenshots;
200
200
  class JSONReporter extends base_1.default {
201
- _registerListeners() {
201
+ onStart(params) {
202
202
  /**
203
203
  * report the number of journeys that exists on a suite which
204
204
  * could be used for better sharding
205
205
  */
206
- this.runner.on('start', ({ numJourneys, networkConditions }) => {
207
- this.writeJSON({
208
- type: 'synthetics/metadata',
209
- root_fields: {
210
- num_journeys: numJourneys,
211
- },
212
- payload: networkConditions
213
- ? {
214
- network_conditions: networkConditions,
215
- }
216
- : undefined,
217
- });
206
+ this.writeJSON({
207
+ type: 'synthetics/metadata',
208
+ root_fields: {
209
+ num_journeys: params.numJourneys,
210
+ },
211
+ payload: params.networkConditions
212
+ ? {
213
+ network_conditions: params.networkConditions,
214
+ }
215
+ : undefined,
218
216
  });
219
- this.runner.on('journey:register', ({ journey }) => {
220
- this.writeJSON({
221
- type: 'journey/register',
222
- journey,
223
- });
217
+ }
218
+ onJourneyRegister(journey) {
219
+ this.writeJSON({
220
+ type: 'journey/register',
221
+ journey,
224
222
  });
225
- this.runner.on('journey:start', ({ journey, timestamp, params }) => {
226
- this.writeJSON({
227
- type: 'journey/start',
228
- journey,
229
- timestamp,
230
- payload: { params, source: journey.callback.toString() },
231
- });
223
+ }
224
+ onJourneyStart(journey, { timestamp, params }) {
225
+ this.writeJSON({
226
+ type: 'journey/start',
227
+ journey,
228
+ timestamp,
229
+ payload: { params, source: journey.callback.toString() },
232
230
  });
233
- this.runner.on('step:end', ({ journey, step, start, end, error, url, status, pagemetrics, traces, metrics, filmstrips, }) => {
234
- this.writeMetrics(journey, step, 'relative_trace', traces);
235
- this.writeMetrics(journey, step, 'experience', metrics);
236
- if (filmstrips) {
237
- // Write each filmstrip separately so that we don't get documents that are too large
238
- filmstrips.forEach((strip, index) => {
239
- this.writeJSON({
240
- type: 'step/filmstrips',
241
- journey,
242
- step,
243
- payload: { index },
244
- root_fields: {
245
- browser: { relative_trace: { start: strip.start } },
246
- },
247
- blob: strip.blob,
248
- blob_mime: strip.mime,
249
- });
250
- });
251
- }
252
- this.writeJSON({
253
- type: 'step/end',
254
- journey,
255
- step: {
256
- ...step,
257
- duration: {
258
- us: (0, helpers_1.getDurationInUs)(end - start),
231
+ }
232
+ onStepEnd(journey, step, { start, end, error, url, status, pagemetrics, traces, metrics, filmstrips, }) {
233
+ this.writeMetrics(journey, step, 'relative_trace', traces);
234
+ this.writeMetrics(journey, step, 'experience', metrics);
235
+ if (filmstrips) {
236
+ // Write each filmstrip separately so that we don't get documents that are too large
237
+ filmstrips.forEach((strip, index) => {
238
+ this.writeJSON({
239
+ type: 'step/filmstrips',
240
+ journey,
241
+ step,
242
+ payload: { index },
243
+ root_fields: {
244
+ browser: { relative_trace: { start: strip.start } },
259
245
  },
246
+ blob: strip.blob,
247
+ blob_mime: strip.mime,
248
+ });
249
+ });
250
+ }
251
+ this.writeJSON({
252
+ type: 'step/end',
253
+ journey,
254
+ step: {
255
+ ...step,
256
+ duration: {
257
+ us: (0, helpers_1.getDurationInUs)(end - start),
260
258
  },
259
+ },
260
+ url,
261
+ error,
262
+ payload: {
263
+ source: step.callback.toString(),
261
264
  url,
262
- error,
263
- payload: {
264
- source: step.callback.toString(),
265
- url,
266
- status,
267
- pagemetrics,
268
- },
269
- });
265
+ status,
266
+ pagemetrics,
267
+ },
270
268
  });
271
- this.runner.on('journey:end', async ({ journey, timestamp, start, end, networkinfo, browserconsole, status, error, options, }) => {
272
- const { ssblocks, screenshots } = options;
273
- const writeScreenshots = screenshots === 'on' ||
274
- (screenshots === 'only-on-failure' && status === 'failed');
275
- if (writeScreenshots) {
276
- await gatherScreenshots((0, path_1.join)(helpers_1.CACHE_PATH, 'screenshots'), async (screenshot) => {
277
- const { data, timestamp, step } = screenshot;
278
- if (!data) {
279
- return;
280
- }
281
- if (ssblocks) {
282
- await this.writeScreenshotBlocks(journey, screenshot);
283
- }
284
- else {
285
- this.writeJSON({
286
- type: 'step/screenshot',
287
- timestamp,
288
- journey,
289
- step,
290
- blob: data,
291
- blob_mime: 'image/jpeg',
292
- });
293
- }
294
- });
295
- }
296
- if (networkinfo) {
297
- networkinfo.forEach(ni => {
298
- const { ecs, payload } = formatNetworkFields(ni);
299
- this.writeJSON({
300
- type: 'journey/network_info',
301
- journey,
302
- timestamp: ni.timestamp,
303
- root_fields: (0, snakecase_keys_1.default)(ecs),
304
- step: ni.step,
305
- payload: (0, snakecase_keys_1.default)(payload),
306
- });
307
- });
308
- }
309
- if (browserconsole) {
310
- browserconsole.forEach(({ timestamp, text, type, step, error }) => {
269
+ }
270
+ async onJourneyEnd(journey, { timestamp, start, end, networkinfo, browserconsole, status, error, options, }) {
271
+ const { ssblocks, screenshots } = options;
272
+ const writeScreenshots = screenshots === 'on' ||
273
+ (screenshots === 'only-on-failure' && status === 'failed');
274
+ if (writeScreenshots) {
275
+ await gatherScreenshots((0, path_1.join)(helpers_1.CACHE_PATH, 'screenshots'), async (screenshot) => {
276
+ const { data, timestamp, step } = screenshot;
277
+ if (!data) {
278
+ return;
279
+ }
280
+ if (ssblocks) {
281
+ await this.writeScreenshotBlocks(journey, screenshot);
282
+ }
283
+ else {
311
284
  this.writeJSON({
312
- type: 'journey/browserconsole',
313
- journey,
285
+ type: 'step/screenshot',
314
286
  timestamp,
287
+ journey,
315
288
  step,
316
- error,
317
- payload: {
318
- text,
319
- type,
320
- },
289
+ blob: data,
290
+ blob_mime: 'image/jpeg',
321
291
  });
292
+ }
293
+ });
294
+ }
295
+ if (networkinfo) {
296
+ networkinfo.forEach(ni => {
297
+ const { ecs, payload } = formatNetworkFields(ni);
298
+ this.writeJSON({
299
+ type: 'journey/network_info',
300
+ journey,
301
+ timestamp: ni.timestamp,
302
+ root_fields: (0, snakecase_keys_1.default)(ecs),
303
+ step: ni.step,
304
+ payload: (0, snakecase_keys_1.default)(payload),
322
305
  });
323
- }
324
- this.writeJSON({
325
- type: 'journey/end',
326
- journey,
327
- timestamp,
328
- error,
329
- payload: {
330
- start,
331
- end,
332
- status,
333
- },
334
306
  });
335
- process.nextTick(() => this.runner.emit('journey:end:reported', {}));
307
+ }
308
+ if (browserconsole) {
309
+ browserconsole.forEach(({ timestamp, text, type, step, error }) => {
310
+ this.writeJSON({
311
+ type: 'journey/browserconsole',
312
+ journey,
313
+ timestamp,
314
+ step,
315
+ error,
316
+ payload: {
317
+ text,
318
+ type,
319
+ },
320
+ });
321
+ });
322
+ }
323
+ this.writeJSON({
324
+ type: 'journey/end',
325
+ journey,
326
+ timestamp,
327
+ error,
328
+ payload: {
329
+ start,
330
+ end,
331
+ status,
332
+ },
336
333
  });
337
334
  }
335
+ onEnd() {
336
+ this.stream.flushSync();
337
+ }
338
338
  async writeScreenshotBlocks(journey, screenshot) {
339
339
  const { blob_mime, blocks, reference } = await getScreenshotBlocks(Buffer.from(screenshot.data, 'base64'));
340
340
  for (let i = 0; i < blocks.length; i++) {