@dev-blinq/cucumber-js 1.0.0-amdocs

package/lib/publish/http_stream.js

@@ -0,0 +1,112 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const stream_1 = require("stream");
+const tmp_1 = __importDefault(require("tmp"));
+const fs_1 = __importDefault(require("fs"));
+const http_1 = __importDefault(require("http"));
+const https_1 = __importDefault(require("https"));
+const value_checker_1 = require("../value_checker");
+/**
+ * This Writable writes data to a HTTP/HTTPS URL.
+ *
+ * It has special handling for https://reports.cucumber.io/
+ * which uses an API where the first request is a `GET`,
+ * and if the response is 202 with a Location header, issues
+ * a PUT request to that URL.
+ *
+ * 3xx redirects are not currently followed.
+ */
+class HttpStream extends stream_1.Transform {
+    constructor(url, method, headers) {
+        super({
+            readableObjectMode: true,
+        });
+        this.url = url;
+        this.method = method;
+        this.headers = headers;
+    }
+    _write(chunk, encoding, callback) {
+        if (this.tempFile === undefined) {
+            tmp_1.default.file((err, name, fd) => {
+                if ((0, value_checker_1.doesHaveValue)(err))
+                    return callback(err);
+                this.tempFilePath = name;
+                this.tempFile = fs_1.default.createWriteStream(name, { fd });
+                this.tempFile.write(chunk, encoding, callback);
+            });
+        }
+        else {
+            this.tempFile.write(chunk, encoding, callback);
+        }
+    }
+    _final(callback) {
+        this.tempFile.end(() => {
+            this.sendHttpRequest(this.url, this.method, this.headers, (err1, res1) => {
+                if ((0, value_checker_1.doesHaveValue)(err1))
+                    return callback(err1);
+                this.pushResponseBody(res1, () => {
+                    this.emitErrorUnlessHttp2xx(res1, this.url, this.method);
+                    if (res1.statusCode === 202 &&
+                        res1.headers.location !== undefined) {
+                        this.sendHttpRequest(res1.headers.location, 'PUT', {}, (err2, res2) => {
+                            if ((0, value_checker_1.doesHaveValue)(err2))
+                                return callback(err2);
+                            this.emitErrorUnlessHttp2xx(res2, this.url, this.method);
+                            callback();
+                        });
+                    }
+                    else {
+                        callback();
+                    }
+                });
+            });
+        });
+    }
+    pushResponseBody(res, done) {
+        let body = Buffer.alloc(0);
+        res.on('data', (chunk) => {
+            body = Buffer.concat([body, chunk]);
+        });
+        res.on('end', () => {
+            this.push(body.toString('utf-8'));
+            done();
+        });
+    }
+    emitErrorUnlessHttp2xx(res, url, method) {
+        if (res.statusCode >= 300)
+            this.emit('error', new Error(`Unexpected http status ${res.statusCode} from ${method} ${url}`));
+    }
+    sendHttpRequest(url, method, headers, callback) {
+        const httpx = (0, value_checker_1.doesHaveValue)(url.match(/^https:/)) ? https_1.default : http_1.default;
+        const additionalHttpHeaders = {};
+        const upload = method === 'PUT' || method === 'POST';
+        if (upload) {
+            additionalHttpHeaders['Content-Length'] = fs_1.default.statSync(this.tempFilePath).size;
+        }
+        const allHeaders = { ...headers, ...additionalHttpHeaders };
+        const req = httpx.request(url, {
+            method,
+            headers: allHeaders,
+        });
+        req.on('error', (err) => this.emit('error', err));
+        req.on('response', (res) => {
+            res.on('error', (err) => this.emit('error', err));
+            callback(null, res);
+        });
+        if (upload) {
+            (0, stream_1.pipeline)(fs_1.default.createReadStream(this.tempFilePath), req, (err) => {
+                if ((0, value_checker_1.doesHaveValue)(err)) {
+                    this.emit('error', err);
+                }
+            });
+        }
+        else {
+            req.end();
+        }
+    }
+}
+exports.default = HttpStream;
+//# sourceMappingURL=http_stream.js.map

package/lib/publish/http_stream.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"http_stream.js","sourceRoot":"","sources":["../../src/publish/http_stream.ts"],"names":[],"mappings":";;;;;AAAA,mCAAsD;AACtD,8CAAqB;AACrB,4CAAmB;AACnB,gDAAuB;AACvB,kDAAyB;AACzB,oDAAgD;AAIhD;;;;;;;;;GASG;AACH,MAAqB,UAAW,SAAQ,kBAAS;IAI/C,YACmB,GAAW,EACX,MAAkB,EAClB,OAAiC;QAElD,KAAK,CAAC;YACJ,kBAAkB,EAAE,IAAI;SACzB,CAAC,CAAA;QANe,QAAG,GAAH,GAAG,CAAQ;QACX,WAAM,GAAN,MAAM,CAAY;QAClB,YAAO,GAAP,OAAO,CAA0B;IAKpD,CAAC;IAED,MAAM,CACJ,KAAU,EACV,QAAwB,EACxB,QAAsC;QAEtC,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE;YAC/B,aAAG,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE;gBACzB,IAAI,IAAA,6BAAa,EAAC,GAAG,CAAC;oBAAE,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAA;gBAC5C,IAAI,CAAC,YAAY,GAAG,IAAI,CAAA;gBACxB,IAAI,CAAC,QAAQ,GAAG,YAAE,CAAC,iBAAiB,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE,CAAC,CAAA;gBAClD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;YAChD,CAAC,CAAC,CAAA;SACH;aAAM;YACL,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;SAC/C;IACH,CAAC;IAED,MAAM,CAAC,QAAwC;QAC7C,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE;YACrB,IAAI,CAAC,eAAe,CAClB,IAAI,CAAC,GAAG,EACR,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,OAAO,EACZ,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;gBACb,IAAI,IAAA,6BAAa,EAAC,IAAI,CAAC;oBAAE,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAA;gBAC9C,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,GAAG,EAAE;oBAC/B,IAAI,CAAC,sBAAsB,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;oBACxD,IACE,IAAI,CAAC,UAAU,KAAK,GAAG;wBACvB,IAAI,CAAC,OAAO,CAAC,QAAQ,KAAK,SAAS,EACnC;wBACA,IAAI,CAAC,eAAe,CAClB,IAAI,CAAC,OAAO,CAAC,QAAQ,EACrB,KAAK,EACL,EAAE,EACF,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;4BACb,IAAI,IAAA,6BAAa,EAAC,IAAI,CAAC;gCAAE,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAA;4BAC9C,IAAI,CAAC,sBAAsB,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;4BACxD,QAAQ,EAAE,CAAA;wBACZ,CAAC,CACF,CAAA;qBACF;yBAAM;wBACL,QAAQ,EAAE,CAAA;qBACX;gBACH,CAAC,CAAC,CAAA;YACJ,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAEO,gBAAgB,CAAC,GAAyB,EAAE,IAAgB;QAClE,IAAI,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;QAC1B,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE;YACvB,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAA;QACrC,CAAC,CAAC,CAAA;QACF,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;YACjB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAA;YACjC,IAAI,EAAE,CAAA;QACR,CAAC,CAAC,CAAA;IACJ,CAAC;IAEO,sBAAsB,CAC5B,GAAyB,EACzB,GAAW,EACX,MAAc;QAEd,IAAI,GAAG,CAAC,UAAU,IAAI,GAAG;YACvB,IAAI,CAAC,IAAI,CACP,OAAO,EACP,IAAI,KAAK,CACP,0BAA0B,GAAG,CAAC,UAAU,SAAS,MAAM,IAAI,GAAG,EAAE,CACjE,CACF,CAAA;IACL,CAAC;IAEO,eAAe,CACrB,GAAW,EACX,MAAkB,EAClB,OAAiC,EACjC,QAAkE;QAElE,MAAM,KAAK,GAAG,IAAA,6BAAa,EAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,eAAK,CAAC,CAAC,CAAC,cAAI,CAAA;QAChE,MAAM,qBAAqB,GAA6B,EAAE,CAAA;QAE1D,MAAM,MAAM,GAAG,MAAM,KAAK,KAAK,IAAI,MAAM,KAAK,MAAM,CAAA;QACpD,IAAI,MAAM,EAAE;YACV,qBAAqB,CAAC,gBAAgB,CAAC,GAAG,YAAE,CAAC,QAAQ,CACnD,IAAI,CAAC,YAAY,CAClB,CAAC,IAAI,CAAA;SACP;QAED,MAAM,UAAU,GAAG,EAAE,GAAG,OAAO,EAAE,GAAG,qBAAqB,EAAE,CAAA;QAC3D,MAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE;YAC7B,MAAM;YACN,OAAO,EAAE,UAAU;SACpB,CAAC,CAAA;QACF,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAA;QACjD,GAAG,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE;YACzB,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAA;YACjD,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;QACrB,CAAC,CAAC,CAAA;QAEF,IAAI,MAAM,EAAE;YACV,IAAA,iBAAQ,EAAC,YAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,EAAE,EAAE;gBAC5D,IAAI,IAAA,6BAAa,EAAC,GAAG,CAAC,EAAE;oBACtB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAA;iBACxB;YACH,CAAC,CAAC,CAAA;SACH;aAAM;YACL,GAAG,CAAC,GAAG,EAAE,CAAA;SACV;IACH,CAAC;CACF;AA9HD,6BA8HC","sourcesContent":["import { pipeline, Transform, Writable } from 'stream'\nimport tmp from 'tmp'\nimport fs from 'fs'\nimport http from 'http'\nimport https from 'https'\nimport { doesHaveValue } from '../value_checker'\n\ntype HttpMethod = 'GET' | 'POST' | 'PUT'\n\n/**\n * This Writable writes data to a HTTP/HTTPS URL.\n *\n * It has special handling for https://reports.cucumber.io/\n * which uses an API where the first request is a `GET`,\n * and if the response is 202 with a Location header, issues\n * a PUT request to that URL.\n *\n * 3xx redirects are not currently followed.\n */\nexport default class HttpStream extends Transform {\n  private tempFilePath: string\n  private tempFile: Writable\n\n  constructor(\n    private readonly url: string,\n    private readonly method: HttpMethod,\n    private readonly headers: http.OutgoingHttpHeaders\n  ) {\n    super({\n      readableObjectMode: true,\n    })\n  }\n\n  _write(\n    chunk: any,\n    encoding: BufferEncoding,\n    callback: (err?: Error | null) => void\n  ): void {\n    if (this.tempFile === undefined) {\n      tmp.file((err, name, fd) => {\n        if (doesHaveValue(err)) return callback(err)\n        this.tempFilePath = name\n        this.tempFile = fs.createWriteStream(name, { fd })\n        this.tempFile.write(chunk, encoding, callback)\n      })\n    } else {\n      this.tempFile.write(chunk, encoding, callback)\n    }\n  }\n\n  _final(callback: (error?: Error | null) => void): void {\n    this.tempFile.end(() => {\n      this.sendHttpRequest(\n        this.url,\n        this.method,\n        this.headers,\n        (err1, res1) => {\n          if (doesHaveValue(err1)) return callback(err1)\n          this.pushResponseBody(res1, () => {\n            this.emitErrorUnlessHttp2xx(res1, this.url, this.method)\n            if (\n              res1.statusCode === 202 &&\n              res1.headers.location !== undefined\n            ) {\n              this.sendHttpRequest(\n                res1.headers.location,\n                'PUT',\n                {},\n                (err2, res2) => {\n                  if (doesHaveValue(err2)) return callback(err2)\n                  this.emitErrorUnlessHttp2xx(res2, this.url, this.method)\n                  callback()\n                }\n              )\n            } else {\n              callback()\n            }\n          })\n        }\n      )\n    })\n  }\n\n  private pushResponseBody(res: http.IncomingMessage, done: () => void): void {\n    let body = Buffer.alloc(0)\n    res.on('data', (chunk) => {\n      body = Buffer.concat([body, chunk])\n    })\n    res.on('end', () => {\n      this.push(body.toString('utf-8'))\n      done()\n    })\n  }\n\n  private emitErrorUnlessHttp2xx(\n    res: http.IncomingMessage,\n    url: string,\n    method: string\n  ): void {\n    if (res.statusCode >= 300)\n      this.emit(\n        'error',\n        new Error(\n          `Unexpected http status ${res.statusCode} from ${method} ${url}`\n        )\n      )\n  }\n\n  private sendHttpRequest(\n    url: string,\n    method: HttpMethod,\n    headers: http.OutgoingHttpHeaders,\n    callback: (err?: Error | null, res?: http.IncomingMessage) => void\n  ): void {\n    const httpx = doesHaveValue(url.match(/^https:/)) ? https : http\n    const additionalHttpHeaders: http.OutgoingHttpHeaders = {}\n\n    const upload = method === 'PUT' || method === 'POST'\n    if (upload) {\n      additionalHttpHeaders['Content-Length'] = fs.statSync(\n        this.tempFilePath\n      ).size\n    }\n\n    const allHeaders = { ...headers, ...additionalHttpHeaders }\n    const req = httpx.request(url, {\n      method,\n      headers: allHeaders,\n    })\n    req.on('error', (err) => this.emit('error', err))\n    req.on('response', (res) => {\n      res.on('error', (err) => this.emit('error', err))\n      callback(null, res)\n    })\n\n    if (upload) {\n      pipeline(fs.createReadStream(this.tempFilePath), req, (err) => {\n        if (doesHaveValue(err)) {\n          this.emit('error', err)\n        }\n      })\n    } else {\n      req.end()\n    }\n  }\n}\n"]}

package/lib/publish/index.d.ts

@@ -0,0 +1,2 @@
+import { publishPlugin } from './publish_plugin';
+export default publishPlugin;

package/lib/publish/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const publish_plugin_1 = require("./publish_plugin");
+exports.default = publish_plugin_1.publishPlugin;
+//# sourceMappingURL=index.js.map

package/lib/publish/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/publish/index.ts"],"names":[],"mappings":";;AAAA,qDAAgD;AAEhD,kBAAe,8BAAa,CAAA","sourcesContent":["import { publishPlugin } from './publish_plugin'\n\nexport default publishPlugin\n"]}

package/lib/publish/publish_plugin.d.ts

@@ -0,0 +1,2 @@
+import { Plugin } from '../plugin';
+export declare const publishPlugin: Plugin;

package/lib/publish/publish_plugin.js

@@ -0,0 +1,48 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.publishPlugin = void 0;
+const http_stream_1 = __importDefault(require("./http_stream"));
+const stream_1 = require("stream");
+const supports_color_1 = require("supports-color");
+const has_ansi_1 = __importDefault(require("has-ansi"));
+const strip_ansi_1 = __importDefault(require("strip-ansi"));
+const DEFAULT_CUCUMBER_PUBLISH_URL = 'https://messages.cucumber.io/api/reports';
+const publishPlugin = async ({ on, logger, configuration, environment, }) => {
+    if (!configuration.formats.publish) {
+        return undefined;
+    }
+    const { url = DEFAULT_CUCUMBER_PUBLISH_URL, token } = configuration.formats.publish;
+    const headers = {};
+    if (token !== undefined) {
+        headers.Authorization = `Bearer ${token}`;
+    }
+    const stream = new http_stream_1.default(url, 'GET', headers);
+    const readerStream = new stream_1.Writable({
+        objectMode: true,
+        write: function (responseBody, encoding, writeCallback) {
+            environment.stderr.write(sanitisePublishOutput(responseBody, environment.stderr) + '\n');
+            writeCallback();
+        },
+    });
+    stream.pipe(readerStream);
+    stream.on('error', (error) => logger.error(error.message));
+    on('message', (value) => stream.write(JSON.stringify(value) + '\n'));
+    return () => stream.end();
+};
+exports.publishPlugin = publishPlugin;
+/*
+This is because the Cucumber Reports service returns a pre-formatted console message
+including ANSI escapes, so if our stderr stream doesn't support those we need to
+strip them back out. Ideally we should get structured data from the service and
+compose the console message on this end.
+ */
+function sanitisePublishOutput(raw, stderr) {
+    if (!(0, supports_color_1.supportsColor)(stderr) && (0, has_ansi_1.default)(raw)) {
+        return (0, strip_ansi_1.default)(raw);
+    }
+    return raw;
+}
+//# sourceMappingURL=publish_plugin.js.map

package/lib/publish/publish_plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"publish_plugin.js","sourceRoot":"","sources":["../../src/publish/publish_plugin.ts"],"names":[],"mappings":";;;;;;AACA,gEAAsC;AACtC,mCAAiC;AACjC,mDAA8C;AAC9C,wDAA8B;AAC9B,4DAAkC;AAElC,MAAM,4BAA4B,GAAG,0CAA0C,CAAA;AAExE,MAAM,aAAa,GAAW,KAAK,EAAE,EAC1C,EAAE,EACF,MAAM,EACN,aAAa,EACb,WAAW,GACZ,EAAE,EAAE;IACH,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,OAAO,EAAE;QAClC,OAAO,SAAS,CAAA;KACjB;IACD,MAAM,EAAE,GAAG,GAAG,4BAA4B,EAAE,KAAK,EAAE,GACjD,aAAa,CAAC,OAAO,CAAC,OAAO,CAAA;IAC/B,MAAM,OAAO,GAA8B,EAAE,CAAA;IAC7C,IAAI,KAAK,KAAK,SAAS,EAAE;QACvB,OAAO,CAAC,aAAa,GAAG,UAAU,KAAK,EAAE,CAAA;KAC1C;IACD,MAAM,MAAM,GAAG,IAAI,qBAAU,CAAC,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;IAClD,MAAM,YAAY,GAAG,IAAI,iBAAQ,CAAC;QAChC,UAAU,EAAE,IAAI;QAChB,KAAK,EAAE,UAAU,YAAoB,EAAE,QAAQ,EAAE,aAAa;YAC5D,WAAW,CAAC,MAAM,CAAC,KAAK,CACtB,qBAAqB,CAAC,YAAY,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,IAAI,CAC/D,CAAA;YACD,aAAa,EAAE,CAAA;QACjB,CAAC;KACF,CAAC,CAAA;IACF,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;IACzB,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAY,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAA;IACjE,EAAE,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC,CAAA;IACpE,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,GAAG,EAAE,CAAA;AAC3B,CAAC,CAAA;AA7BY,QAAA,aAAa,iBA6BzB;AACD;;;;;GAKG;AACH,SAAS,qBAAqB,CAAC,GAAW,EAAE,MAAgB;IAC1D,IAAI,CAAC,IAAA,8BAAa,EAAC,MAAM,CAAC,IAAI,IAAA,kBAAO,EAAC,GAAG,CAAC,EAAE;QAC1C,OAAO,IAAA,oBAAS,EAAC,GAAG,CAAC,CAAA;KACtB;IACD,OAAO,GAAG,CAAA;AACZ,CAAC","sourcesContent":["import { Plugin } from '../plugin'\nimport HttpStream from './http_stream'\nimport { Writable } from 'stream'\nimport { supportsColor } from 'supports-color'\nimport hasAnsi from 'has-ansi'\nimport stripAnsi from 'strip-ansi'\n\nconst DEFAULT_CUCUMBER_PUBLISH_URL = 'https://messages.cucumber.io/api/reports'\n\nexport const publishPlugin: Plugin = async ({\n  on,\n  logger,\n  configuration,\n  environment,\n}) => {\n  if (!configuration.formats.publish) {\n    return undefined\n  }\n  const { url = DEFAULT_CUCUMBER_PUBLISH_URL, token } =\n    configuration.formats.publish\n  const headers: { [key: string]: string } = {}\n  if (token !== undefined) {\n    headers.Authorization = `Bearer ${token}`\n  }\n  const stream = new HttpStream(url, 'GET', headers)\n  const readerStream = new Writable({\n    objectMode: true,\n    write: function (responseBody: string, encoding, writeCallback) {\n      environment.stderr.write(\n        sanitisePublishOutput(responseBody, environment.stderr) + '\\n'\n      )\n      writeCallback()\n    },\n  })\n  stream.pipe(readerStream)\n  stream.on('error', (error: Error) => logger.error(error.message))\n  on('message', (value) => stream.write(JSON.stringify(value) + '\\n'))\n  return () => stream.end()\n}\n/*\nThis is because the Cucumber Reports service returns a pre-formatted console message\nincluding ANSI escapes, so if our stderr stream doesn't support those we need to\nstrip them back out. Ideally we should get structured data from the service and\ncompose the console message on this end.\n */\nfunction sanitisePublishOutput(raw: string, stderr: Writable) {\n  if (!supportsColor(stderr) && hasAnsi(raw)) {\n    return stripAnsi(raw)\n  }\n  return raw\n}\n"]}

package/lib/runtime/assemble_test_cases.d.ts

@@ -0,0 +1,13 @@
+/// <reference types="node" />
+import { EventEmitter } from 'events';
+import * as messages from '@cucumber/messages';
+import { IdGenerator } from '@cucumber/messages';
+import { ISupportCodeLibrary } from '../support_code_library_builder/types';
+export declare type IAssembledTestCases = Record<string, messages.TestCase>;
+export interface IAssembleTestCasesOptions {
+    eventBroadcaster: EventEmitter;
+    newId: IdGenerator.NewId;
+    pickles: messages.Pickle[];
+    supportCodeLibrary: ISupportCodeLibrary;
+}
+export declare function assembleTestCases({ eventBroadcaster, newId, pickles, supportCodeLibrary, }: IAssembleTestCasesOptions): Promise<IAssembledTestCases>;

package/lib/runtime/assemble_test_cases.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assembleTestCases = void 0;
+const value_checker_1 = require("../value_checker");
+async function assembleTestCases({ eventBroadcaster, newId, pickles, supportCodeLibrary, }) {
+    const result = {};
+    for (const pickle of pickles) {
+        const { id: pickleId } = pickle;
+        const testCaseId = newId();
+        const fromBeforeHooks = makeBeforeHookSteps({
+            supportCodeLibrary,
+            pickle,
+            newId,
+        });
+        const fromStepDefinitions = makeSteps({
+            pickle,
+            supportCodeLibrary,
+            newId,
+        });
+        const fromAfterHooks = makeAfterHookSteps({
+            supportCodeLibrary,
+            pickle,
+            newId,
+        });
+        const testCase = {
+            pickleId,
+            id: testCaseId,
+            testSteps: [
+                ...fromBeforeHooks,
+                ...fromStepDefinitions,
+                ...fromAfterHooks,
+            ],
+        };
+        eventBroadcaster.emit('envelope', { testCase });
+        result[pickleId] = testCase;
+    }
+    return result;
+}
+exports.assembleTestCases = assembleTestCases;
+function makeAfterHookSteps({ supportCodeLibrary, pickle, newId, }) {
+    return supportCodeLibrary.afterTestCaseHookDefinitions
+        .slice(0)
+        .reverse()
+        .filter((hookDefinition) => hookDefinition.appliesToTestCase(pickle))
+        .map((hookDefinition) => ({
+        id: newId(),
+        hookId: hookDefinition.id,
+    }));
+}
+function makeBeforeHookSteps({ supportCodeLibrary, pickle, newId, }) {
+    return supportCodeLibrary.beforeTestCaseHookDefinitions
+        .filter((hookDefinition) => hookDefinition.appliesToTestCase(pickle))
+        .map((hookDefinition) => ({
+        id: newId(),
+        hookId: hookDefinition.id,
+    }));
+}
+function makeSteps({ pickle, supportCodeLibrary, newId, }) {
+    return pickle.steps.map((pickleStep) => {
+        const stepDefinitions = supportCodeLibrary.stepDefinitions.filter((stepDefinition) => stepDefinition.matchesStepName(pickleStep.text));
+        return {
+            id: newId(),
+            pickleStepId: pickleStep.id,
+            stepDefinitionIds: stepDefinitions.map((stepDefinition) => stepDefinition.id),
+            stepMatchArgumentsLists: stepDefinitions.map((stepDefinition) => {
+                const result = stepDefinition.expression.match(pickleStep.text);
+                return {
+                    stepMatchArguments: result.map((arg) => {
+                        return {
+                            group: mapArgumentGroup(arg.group),
+                            parameterTypeName: arg.parameterType.name,
+                        };
+                    }),
+                };
+            }),
+        };
+    });
+}
+function mapArgumentGroup(group) {
+    return {
+        start: group.start,
+        value: group.value,
+        children: (0, value_checker_1.doesHaveValue)(group.children)
+            ? group.children.map((child) => mapArgumentGroup(child))
+            : undefined,
+    };
+}
+//# sourceMappingURL=assemble_test_cases.js.map

package/lib/runtime/assemble_test_cases.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assemble_test_cases.js","sourceRoot":"","sources":["../../src/runtime/assemble_test_cases.ts"],"names":[],"mappings":";;;AAKA,oDAAgD;AAWzC,KAAK,UAAU,iBAAiB,CAAC,EACtC,gBAAgB,EAChB,KAAK,EACL,OAAO,EACP,kBAAkB,GACQ;IAC1B,MAAM,MAAM,GAAwB,EAAE,CAAA;IACtC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;QAC5B,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAA;QAC/B,MAAM,UAAU,GAAG,KAAK,EAAE,CAAA;QAC1B,MAAM,eAAe,GAAwB,mBAAmB,CAAC;YAC/D,kBAAkB;YAClB,MAAM;YACN,KAAK;SACN,CAAC,CAAA;QACF,MAAM,mBAAmB,GAAwB,SAAS,CAAC;YACzD,MAAM;YACN,kBAAkB;YAClB,KAAK;SACN,CAAC,CAAA;QACF,MAAM,cAAc,GAAwB,kBAAkB,CAAC;YAC7D,kBAAkB;YAClB,MAAM;YACN,KAAK;SACN,CAAC,CAAA;QACF,MAAM,QAAQ,GAAsB;YAClC,QAAQ;YACR,EAAE,EAAE,UAAU;YACd,SAAS,EAAE;gBACT,GAAG,eAAe;gBAClB,GAAG,mBAAmB;gBACtB,GAAG,cAAc;aAClB;SACF,CAAA;QACD,gBAAgB,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAA;QAC/C,MAAM,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAA;KAC5B;IACD,OAAO,MAAM,CAAA;AACf,CAAC;AAtCD,8CAsCC;AAED,SAAS,kBAAkB,CAAC,EAC1B,kBAAkB,EAClB,MAAM,EACN,KAAK,GAKN;IACC,OAAO,kBAAkB,CAAC,4BAA4B;SACnD,KAAK,CAAC,CAAC,CAAC;SACR,OAAO,EAAE;SACT,MAAM,CAAC,CAAC,cAAc,EAAE,EAAE,CAAC,cAAc,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;SACpE,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;QACxB,EAAE,EAAE,KAAK,EAAE;QACX,MAAM,EAAE,cAAc,CAAC,EAAE;KAC1B,CAAC,CAAC,CAAA;AACP,CAAC;AAED,SAAS,mBAAmB,CAAC,EAC3B,kBAAkB,EAClB,MAAM,EACN,KAAK,GAKN;IACC,OAAO,kBAAkB,CAAC,6BAA6B;SACpD,MAAM,CAAC,CAAC,cAAc,EAAE,EAAE,CAAC,cAAc,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;SACpE,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;QACxB,EAAE,EAAE,KAAK,EAAE;QACX,MAAM,EAAE,cAAc,CAAC,EAAE;KAC1B,CAAC,CAAC,CAAA;AACP,CAAC;AAED,SAAS,SAAS,CAAC,EACjB,MAAM,EACN,kBAAkB,EAClB,KAAK,GAKN;IACC,OAAO,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE;QACrC,MAAM,eAAe,GAAG,kBAAkB,CAAC,eAAe,CAAC,MAAM,CAC/D,CAAC,cAAc,EAAE,EAAE,CAAC,cAAc,CAAC,eAAe,CAAC,UAAU,CAAC,IAAI,CAAC,CACpE,CAAA;QACD,OAAO;YACL,EAAE,EAAE,KAAK,EAAE;YACX,YAAY,EAAE,UAAU,CAAC,EAAE;YAC3B,iBAAiB,EAAE,eAAe,CAAC,GAAG,CACpC,CAAC,cAAc,EAAE,EAAE,CAAC,cAAc,CAAC,EAAE,CACtC;YACD,uBAAuB,EAAE,eAAe,CAAC,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE;gBAC9D,MAAM,MAAM,GAAG,cAAc,CAAC,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;gBAC/D,OAAO;oBACL,kBAAkB,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;wBACrC,OAAO;4BACL,KAAK,EAAE,gBAAgB,CAAC,GAAG,CAAC,KAAK,CAAC;4BAClC,iBAAiB,EAAE,GAAG,CAAC,aAAa,CAAC,IAAI;yBAC1C,CAAA;oBACH,CAAC,CAAC;iBACH,CAAA;YACH,CAAC,CAAC;SACH,CAAA;IACH,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,SAAS,gBAAgB,CAAC,KAAY;IACpC,OAAO;QACL,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,QAAQ,EAAE,IAAA,6BAAa,EAAC,KAAK,CAAC,QAAQ,CAAC;YACrC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;YACxD,CAAC,CAAC,SAAS;KACd,CAAA;AACH,CAAC","sourcesContent":["import { EventEmitter } from 'events'\nimport * as messages from '@cucumber/messages'\nimport { IdGenerator } from '@cucumber/messages'\nimport { ISupportCodeLibrary } from '../support_code_library_builder/types'\nimport { Group } from '@cucumber/cucumber-expressions'\nimport { doesHaveValue } from '../value_checker'\n\nexport declare type IAssembledTestCases = Record<string, messages.TestCase>\n\nexport interface IAssembleTestCasesOptions {\n  eventBroadcaster: EventEmitter\n  newId: IdGenerator.NewId\n  pickles: messages.Pickle[]\n  supportCodeLibrary: ISupportCodeLibrary\n}\n\nexport async function assembleTestCases({\n  eventBroadcaster,\n  newId,\n  pickles,\n  supportCodeLibrary,\n}: IAssembleTestCasesOptions): Promise<IAssembledTestCases> {\n  const result: IAssembledTestCases = {}\n  for (const pickle of pickles) {\n    const { id: pickleId } = pickle\n    const testCaseId = newId()\n    const fromBeforeHooks: messages.TestStep[] = makeBeforeHookSteps({\n      supportCodeLibrary,\n      pickle,\n      newId,\n    })\n    const fromStepDefinitions: messages.TestStep[] = makeSteps({\n      pickle,\n      supportCodeLibrary,\n      newId,\n    })\n    const fromAfterHooks: messages.TestStep[] = makeAfterHookSteps({\n      supportCodeLibrary,\n      pickle,\n      newId,\n    })\n    const testCase: messages.TestCase = {\n      pickleId,\n      id: testCaseId,\n      testSteps: [\n        ...fromBeforeHooks,\n        ...fromStepDefinitions,\n        ...fromAfterHooks,\n      ],\n    }\n    eventBroadcaster.emit('envelope', { testCase })\n    result[pickleId] = testCase\n  }\n  return result\n}\n\nfunction makeAfterHookSteps({\n  supportCodeLibrary,\n  pickle,\n  newId,\n}: {\n  supportCodeLibrary: ISupportCodeLibrary\n  pickle: messages.Pickle\n  newId: IdGenerator.NewId\n}): messages.TestStep[] {\n  return supportCodeLibrary.afterTestCaseHookDefinitions\n    .slice(0)\n    .reverse()\n    .filter((hookDefinition) => hookDefinition.appliesToTestCase(pickle))\n    .map((hookDefinition) => ({\n      id: newId(),\n      hookId: hookDefinition.id,\n    }))\n}\n\nfunction makeBeforeHookSteps({\n  supportCodeLibrary,\n  pickle,\n  newId,\n}: {\n  supportCodeLibrary: ISupportCodeLibrary\n  pickle: messages.Pickle\n  newId: IdGenerator.NewId\n}): messages.TestStep[] {\n  return supportCodeLibrary.beforeTestCaseHookDefinitions\n    .filter((hookDefinition) => hookDefinition.appliesToTestCase(pickle))\n    .map((hookDefinition) => ({\n      id: newId(),\n      hookId: hookDefinition.id,\n    }))\n}\n\nfunction makeSteps({\n  pickle,\n  supportCodeLibrary,\n  newId,\n}: {\n  pickle: messages.Pickle\n  supportCodeLibrary: ISupportCodeLibrary\n  newId: () => string\n}): messages.TestStep[] {\n  return pickle.steps.map((pickleStep) => {\n    const stepDefinitions = supportCodeLibrary.stepDefinitions.filter(\n      (stepDefinition) => stepDefinition.matchesStepName(pickleStep.text)\n    )\n    return {\n      id: newId(),\n      pickleStepId: pickleStep.id,\n      stepDefinitionIds: stepDefinitions.map(\n        (stepDefinition) => stepDefinition.id\n      ),\n      stepMatchArgumentsLists: stepDefinitions.map((stepDefinition) => {\n        const result = stepDefinition.expression.match(pickleStep.text)\n        return {\n          stepMatchArguments: result.map((arg) => {\n            return {\n              group: mapArgumentGroup(arg.group),\n              parameterTypeName: arg.parameterType.name,\n            }\n          }),\n        }\n      }),\n    }\n  })\n}\n\nfunction mapArgumentGroup(group: Group): messages.Group {\n  return {\n    start: group.start,\n    value: group.value,\n    children: doesHaveValue(group.children)\n      ? group.children.map((child) => mapArgumentGroup(child))\n      : undefined,\n  }\n}\n"]}

package/lib/runtime/attachment_manager/index.d.ts

@@ -0,0 +1,33 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { Readable } from 'stream';
+import * as messages from '@cucumber/messages';
+export interface IAttachmentMedia {
+    encoding: messages.AttachmentContentEncoding;
+    contentType: string;
+}
+export interface IAttachment {
+    data: string;
+    media: IAttachmentMedia;
+    fileName?: string;
+}
+export type IAttachFunction = (attachment: IAttachment) => void;
+export interface ICreateAttachmentOptions {
+    mediaType: string;
+    fileName?: string;
+}
+export type ICreateStringAttachment = (data: string, mediaTypeOrOptions?: string | ICreateAttachmentOptions) => void;
+export type ICreateBufferAttachment = (data: Buffer, mediaTypeOrOptions: string | ICreateAttachmentOptions) => void;
+export type ICreateStreamAttachment = (data: Readable, mediaTypeOrOptions: string | ICreateAttachmentOptions) => Promise<void>;
+export type ICreateStreamAttachmentWithCallback = (data: Readable, mediaTypeOrOptions: string | ICreateAttachmentOptions, callback: () => void) => void;
+export type ICreateAttachment = ICreateStringAttachment & ICreateBufferAttachment & ICreateStreamAttachment & ICreateStreamAttachmentWithCallback;
+export type ICreateLog = (text: string) => void;
+export default class AttachmentManager {
+    private readonly onAttachment;
+    constructor(onAttachment: IAttachFunction);
+    log(text: string): void | Promise<void>;
+    create(data: Buffer | Readable | string, mediaTypeOrOptions?: string | ICreateAttachmentOptions, callback?: () => void): void | Promise<void>;
+    createBufferAttachment(data: Buffer, mediaType: string, fileName?: string): void;
+    createStreamAttachment(data: Readable, mediaType: string, fileName?: string, callback?: () => void): void | Promise<void>;
+    createStringAttachment(data: string, media: IAttachmentMedia, fileName?: string): void;
+}

package/lib/runtime/attachment_manager/index.js

@@ -0,0 +1,119 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const is_stream_1 = __importDefault(require("is-stream"));
+const messages = __importStar(require("@cucumber/messages"));
+const value_checker_1 = require("../../value_checker");
+class AttachmentManager {
+    constructor(onAttachment) {
+        this.onAttachment = onAttachment;
+    }
+    log(text) {
+        return this.create(text, 'text/x.cucumber.log+plain');
+    }
+    create(data, mediaTypeOrOptions, callback) {
+        const options = normaliseOptions(mediaTypeOrOptions);
+        if (Buffer.isBuffer(data)) {
+            if ((0, value_checker_1.doesNotHaveValue)(options.mediaType)) {
+                throw Error('Buffer attachments must specify a media type');
+            }
+            this.createBufferAttachment(data, options.mediaType, options.fileName);
+        }
+        else if (is_stream_1.default.readable(data)) {
+            if ((0, value_checker_1.doesNotHaveValue)(options.mediaType)) {
+                throw Error('Stream attachments must specify a media type');
+            }
+            return this.createStreamAttachment(data, options.mediaType, options.fileName, callback);
+        }
+        else if (typeof data === 'string') {
+            if ((0, value_checker_1.doesNotHaveValue)(options.mediaType)) {
+                options.mediaType = 'text/plain';
+            }
+            if (options.mediaType.startsWith('base64:')) {
+                this.createStringAttachment(data, {
+                    encoding: messages.AttachmentContentEncoding.BASE64,
+                    contentType: options.mediaType.replace('base64:', ''),
+                }, options.fileName);
+            }
+            else {
+                this.createStringAttachment(data, {
+                    encoding: messages.AttachmentContentEncoding.IDENTITY,
+                    contentType: options.mediaType,
+                }, options.fileName);
+            }
+        }
+        else {
+            throw Error('Invalid attachment data: must be a buffer, readable stream, or string');
+        }
+    }
+    createBufferAttachment(data, mediaType, fileName) {
+        this.createStringAttachment(data.toString('base64'), {
+            encoding: messages.AttachmentContentEncoding.BASE64,
+            contentType: mediaType,
+        }, fileName);
+    }
+    createStreamAttachment(data, mediaType, fileName, callback) {
+        const promise = new Promise((resolve, reject) => {
+            const buffers = [];
+            data.on('data', (chunk) => {
+                buffers.push(chunk);
+            });
+            data.on('end', () => {
+                this.createBufferAttachment(Buffer.concat(buffers), mediaType, fileName);
+                resolve();
+            });
+            data.on('error', reject);
+        });
+        if ((0, value_checker_1.doesHaveValue)(callback)) {
+            promise.then(callback, callback);
+        }
+        else {
+            return promise;
+        }
+    }
+    createStringAttachment(data, media, fileName) {
+        this.onAttachment({
+            data,
+            media,
+            ...(fileName ? { fileName } : {}),
+        });
+    }
+}
+exports.default = AttachmentManager;
+function normaliseOptions(mediaTypeOrOptions) {
+    if (!mediaTypeOrOptions) {
+        return {};
+    }
+    if (typeof mediaTypeOrOptions === 'string') {
+        return {
+            mediaType: mediaTypeOrOptions,
+        };
+    }
+    return mediaTypeOrOptions;
+}
+//# sourceMappingURL=index.js.map

package/lib/runtime/attachment_manager/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/runtime/attachment_manager/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,0DAAgC;AAEhC,6DAA8C;AAC9C,uDAAqE;AA0CrE,MAAqB,iBAAiB;IAGpC,YAAY,YAA6B;QACvC,IAAI,CAAC,YAAY,GAAG,YAAY,CAAA;IAClC,CAAC;IAED,GAAG,CAAC,IAAY;QACd,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,2BAA2B,CAAC,CAAA;IACvD,CAAC;IAED,MAAM,CACJ,IAAgC,EAChC,kBAAsD,EACtD,QAAqB;QAErB,MAAM,OAAO,GAAG,gBAAgB,CAAC,kBAAkB,CAAC,CAAA;QACpD,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;YACzB,IAAI,IAAA,gCAAgB,EAAC,OAAO,CAAC,SAAS,CAAC,EAAE;gBACvC,MAAM,KAAK,CAAC,8CAA8C,CAAC,CAAA;aAC5D;YACD,IAAI,CAAC,sBAAsB,CAAC,IAAI,EAAE,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAA;SACvE;aAAM,IAAI,mBAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;YAClC,IAAI,IAAA,gCAAgB,EAAC,OAAO,CAAC,SAAS,CAAC,EAAE;gBACvC,MAAM,KAAK,CAAC,8CAA8C,CAAC,CAAA;aAC5D;YACD,OAAO,IAAI,CAAC,sBAAsB,CAChC,IAAI,EACJ,OAAO,CAAC,SAAS,EACjB,OAAO,CAAC,QAAQ,EAChB,QAAQ,CACT,CAAA;SACF;aAAM,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YACnC,IAAI,IAAA,gCAAgB,EAAC,OAAO,CAAC,SAAS,CAAC,EAAE;gBACvC,OAAO,CAAC,SAAS,GAAG,YAAY,CAAA;aACjC;YACD,IAAI,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;gBAC3C,IAAI,CAAC,sBAAsB,CACzB,IAAI,EACJ;oBACE,QAAQ,EAAE,QAAQ,CAAC,yBAAyB,CAAC,MAAM;oBACnD,WAAW,EAAE,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC;iBACtD,EACD,OAAO,CAAC,QAAQ,CACjB,CAAA;aACF;iBAAM;gBACL,IAAI,CAAC,sBAAsB,CACzB,IAAI,EACJ;oBACE,QAAQ,EAAE,QAAQ,CAAC,yBAAyB,CAAC,QAAQ;oBACrD,WAAW,EAAE,OAAO,CAAC,SAAS;iBAC/B,EACD,OAAO,CAAC,QAAQ,CACjB,CAAA;aACF;SACF;aAAM;YACL,MAAM,KAAK,CACT,uEAAuE,CACxE,CAAA;SACF;IACH,CAAC;IAED,sBAAsB,CACpB,IAAY,EACZ,SAAiB,EACjB,QAAiB;QAEjB,IAAI,CAAC,sBAAsB,CACzB,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EACvB;YACE,QAAQ,EAAE,QAAQ,CAAC,yBAAyB,CAAC,MAAM;YACnD,WAAW,EAAE,SAAS;SACvB,EACD,QAAQ,CACT,CAAA;IACH,CAAC;IAED,sBAAsB,CACpB,IAAc,EACd,SAAiB,EACjB,QAAiB,EACjB,QAAqB;QAErB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACpD,MAAM,OAAO,GAAiB,EAAE,CAAA;YAChC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE;gBACxB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YACrB,CAAC,CAAC,CAAA;YACF,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;gBAClB,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAA;gBACxE,OAAO,EAAE,CAAA;YACX,CAAC,CAAC,CAAA;YACF,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;QAC1B,CAAC,CAAC,CAAA;QACF,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,EAAE;YAC3B,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAA;SACjC;aAAM;YACL,OAAO,OAAO,CAAA;SACf;IACH,CAAC;IAED,sBAAsB,CACpB,IAAY,EACZ,KAAuB,EACvB,QAAiB;QAEjB,IAAI,CAAC,YAAY,CAAC;YAChB,IAAI;YACJ,KAAK;YACL,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAClC,CAAC,CAAA;IACJ,CAAC;CACF;AAhHD,oCAgHC;AAED,SAAS,gBAAgB,CACvB,kBAAsD;IAEtD,IAAI,CAAC,kBAAkB,EAAE;QACvB,OAAO,EAAE,CAAA;KACV;IACD,IAAI,OAAO,kBAAkB,KAAK,QAAQ,EAAE;QAC1C,OAAO;YACL,SAAS,EAAE,kBAAkB;SAC9B,CAAA;KACF;IACD,OAAO,kBAAkB,CAAA;AAC3B,CAAC","sourcesContent":["import isStream from 'is-stream'\nimport { Readable } from 'stream'\nimport * as messages from '@cucumber/messages'\nimport { doesHaveValue, doesNotHaveValue } from '../../value_checker'\n\nexport interface IAttachmentMedia {\n  encoding: messages.AttachmentContentEncoding\n  contentType: string\n}\n\nexport interface IAttachment {\n  data: string\n  media: IAttachmentMedia\n  fileName?: string\n}\n\nexport type IAttachFunction = (attachment: IAttachment) => void\n\nexport interface ICreateAttachmentOptions {\n  mediaType: string\n  fileName?: string\n}\nexport type ICreateStringAttachment = (\n  data: string,\n  mediaTypeOrOptions?: string | ICreateAttachmentOptions\n) => void\nexport type ICreateBufferAttachment = (\n  data: Buffer,\n  mediaTypeOrOptions: string | ICreateAttachmentOptions\n) => void\nexport type ICreateStreamAttachment = (\n  data: Readable,\n  mediaTypeOrOptions: string | ICreateAttachmentOptions\n) => Promise<void>\nexport type ICreateStreamAttachmentWithCallback = (\n  data: Readable,\n  mediaTypeOrOptions: string | ICreateAttachmentOptions,\n  callback: () => void\n) => void\nexport type ICreateAttachment = ICreateStringAttachment &\n  ICreateBufferAttachment &\n  ICreateStreamAttachment &\n  ICreateStreamAttachmentWithCallback\nexport type ICreateLog = (text: string) => void\n\nexport default class AttachmentManager {\n  private readonly onAttachment: IAttachFunction\n\n  constructor(onAttachment: IAttachFunction) {\n    this.onAttachment = onAttachment\n  }\n\n  log(text: string): void | Promise<void> {\n    return this.create(text, 'text/x.cucumber.log+plain')\n  }\n\n  create(\n    data: Buffer | Readable | string,\n    mediaTypeOrOptions?: string | ICreateAttachmentOptions,\n    callback?: () => void\n  ): void | Promise<void> {\n    const options = normaliseOptions(mediaTypeOrOptions)\n    if (Buffer.isBuffer(data)) {\n      if (doesNotHaveValue(options.mediaType)) {\n        throw Error('Buffer attachments must specify a media type')\n      }\n      this.createBufferAttachment(data, options.mediaType, options.fileName)\n    } else if (isStream.readable(data)) {\n      if (doesNotHaveValue(options.mediaType)) {\n        throw Error('Stream attachments must specify a media type')\n      }\n      return this.createStreamAttachment(\n        data,\n        options.mediaType,\n        options.fileName,\n        callback\n      )\n    } else if (typeof data === 'string') {\n      if (doesNotHaveValue(options.mediaType)) {\n        options.mediaType = 'text/plain'\n      }\n      if (options.mediaType.startsWith('base64:')) {\n        this.createStringAttachment(\n          data,\n          {\n            encoding: messages.AttachmentContentEncoding.BASE64,\n            contentType: options.mediaType.replace('base64:', ''),\n          },\n          options.fileName\n        )\n      } else {\n        this.createStringAttachment(\n          data,\n          {\n            encoding: messages.AttachmentContentEncoding.IDENTITY,\n            contentType: options.mediaType,\n          },\n          options.fileName\n        )\n      }\n    } else {\n      throw Error(\n        'Invalid attachment data: must be a buffer, readable stream, or string'\n      )\n    }\n  }\n\n  createBufferAttachment(\n    data: Buffer,\n    mediaType: string,\n    fileName?: string\n  ): void {\n    this.createStringAttachment(\n      data.toString('base64'),\n      {\n        encoding: messages.AttachmentContentEncoding.BASE64,\n        contentType: mediaType,\n      },\n      fileName\n    )\n  }\n\n  createStreamAttachment(\n    data: Readable,\n    mediaType: string,\n    fileName?: string,\n    callback?: () => void\n  ): void | Promise<void> {\n    const promise = new Promise<void>((resolve, reject) => {\n      const buffers: Uint8Array[] = []\n      data.on('data', (chunk) => {\n        buffers.push(chunk)\n      })\n      data.on('end', () => {\n        this.createBufferAttachment(Buffer.concat(buffers), mediaType, fileName)\n        resolve()\n      })\n      data.on('error', reject)\n    })\n    if (doesHaveValue(callback)) {\n      promise.then(callback, callback)\n    } else {\n      return promise\n    }\n  }\n\n  createStringAttachment(\n    data: string,\n    media: IAttachmentMedia,\n    fileName?: string\n  ): void {\n    this.onAttachment({\n      data,\n      media,\n      ...(fileName ? { fileName } : {}),\n    })\n  }\n}\n\nfunction normaliseOptions(\n  mediaTypeOrOptions?: string | ICreateAttachmentOptions\n): Partial<ICreateAttachmentOptions> {\n  if (!mediaTypeOrOptions) {\n    return {}\n  }\n  if (typeof mediaTypeOrOptions === 'string') {\n    return {\n      mediaType: mediaTypeOrOptions,\n    }\n  }\n  return mediaTypeOrOptions\n}\n"]}

package/lib/runtime/format_error.d.ts

@@ -0,0 +1,2 @@
+import { TestStepResult } from '@cucumber/messages';
+export declare function formatError(error: Error, filterStackTraces: boolean): Pick<TestStepResult, 'message' | 'exception'>;

package/lib/runtime/format_error.js

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatError = void 0;
+const assertion_error_formatter_1 = require("assertion-error-formatter");
+const error_stack_parser_1 = __importDefault(require("error-stack-parser"));
+const filter_stack_trace_1 = require("../filter_stack_trace");
+function formatError(error, filterStackTraces) {
+    let filteredStack;
+    if (filterStackTraces) {
+        try {
+            filteredStack = (0, filter_stack_trace_1.filterStackTrace)(error_stack_parser_1.default.parse(error))
+                .map((f) => f.source)
+                .join('\n');
+        }
+        catch (_a) {
+            // if we weren't able to parse and filter, we'll settle for the original
+        }
+    }
+    const message = (0, assertion_error_formatter_1.format)(error, {
+        colorFns: {
+            errorStack: (stack) => filteredStack ? `\n${filteredStack}` : stack,
+        },
+    });
+    return {
+        message,
+        exception: {
+            type: error.name || 'Error',
+            message: typeof error === 'string' ? error : error.message,
+        },
+    };
+}
+exports.formatError = formatError;
+//# sourceMappingURL=format_error.js.map

package/lib/runtime/format_error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"format_error.js","sourceRoot":"","sources":["../../src/runtime/format_error.ts"],"names":[],"mappings":";;;;;;AACA,yEAAkD;AAClD,4EAAiD;AACjD,8DAAwD;AAExD,SAAgB,WAAW,CACzB,KAAY,EACZ,iBAA0B;IAE1B,IAAI,aAAqB,CAAA;IACzB,IAAI,iBAAiB,EAAE;QACrB,IAAI;YACF,aAAa,GAAG,IAAA,qCAAgB,EAAC,4BAAgB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;iBAC5D,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;iBACpB,IAAI,CAAC,IAAI,CAAC,CAAA;SACd;QAAC,WAAM;YACN,wEAAwE;SACzE;KACF;IACD,MAAM,OAAO,GAAG,IAAA,kCAAM,EAAC,KAAK,EAAE;QAC5B,QAAQ,EAAE;YACR,UAAU,EAAE,CAAC,KAAa,EAAE,EAAE,CAC5B,aAAa,CAAC,CAAC,CAAC,KAAK,aAAa,EAAE,CAAC,CAAC,CAAC,KAAK;SAC/C;KACF,CAAC,CAAA;IACF,OAAO;QACL,OAAO;QACP,SAAS,EAAE;YACT,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,OAAO;YAC3B,OAAO,EAAE,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO;SAC3D;KACF,CAAA;AACH,CAAC;AA3BD,kCA2BC","sourcesContent":["import { TestStepResult } from '@cucumber/messages'\nimport { format } from 'assertion-error-formatter'\nimport errorStackParser from 'error-stack-parser'\nimport { filterStackTrace } from '../filter_stack_trace'\n\nexport function formatError(\n  error: Error,\n  filterStackTraces: boolean\n): Pick<TestStepResult, 'message' | 'exception'> {\n  let filteredStack: string\n  if (filterStackTraces) {\n    try {\n      filteredStack = filterStackTrace(errorStackParser.parse(error))\n        .map((f) => f.source)\n        .join('\\n')\n    } catch {\n      // if we weren't able to parse and filter, we'll settle for the original\n    }\n  }\n  const message = format(error, {\n    colorFns: {\n      errorStack: (stack: string) =>\n        filteredStack ? `\\n${filteredStack}` : stack,\n    },\n  })\n  return {\n    message,\n    exception: {\n      type: error.name || 'Error',\n      message: typeof error === 'string' ? error : error.message,\n    },\n  }\n}\n"]}

package/lib/runtime/helpers.d.ts

@@ -0,0 +1,6 @@
+import StepDefinition from '../models/step_definition';
+import * as messages from '@cucumber/messages';
+import { IRuntimeOptions } from '.';
+export declare function getAmbiguousStepException(stepDefinitions: StepDefinition[]): string;
+export declare function retriesForPickle(pickle: messages.Pickle, options: IRuntimeOptions): number;
+export declare function shouldCauseFailure(status: messages.TestStepResultStatus, options: IRuntimeOptions): boolean;