@cucumber/cucumber 12.4.0 → 12.6.0

package/lib/formatter/helpers/event_data_collector.js.map

@@ -1 +1 @@
-{"version":3,"file":"event_data_collector.js","sourceRoot":"","sources":["../../../src/formatter/helpers/event_data_collector.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,6DAA8C;AAC9C,uDAAqE;AAsBrE,MAAqB,kBAAkB;IAC7B,kBAAkB,GAA6C,EAAE,CAAA;IACjE,SAAS,GAAoC,EAAE,CAAA;IAC/C,WAAW,GAAsC,EAAE,CAAA;IACnD,sBAAsB,GAAyC,EAAE,CAAA;IAChE,uBAAuB,GAAsC,EAAE,CAAA;IAExE,YAAY,gBAA8B;QACxC,gBAAgB,CAAC,EAAE,CAAC,UAAU,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;IAChE,CAAC;IAED,kBAAkB,CAAC,GAAW;QAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAA;IACrC,CAAC;IAED,SAAS,CAAC,QAAgB;QACxB,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAA;IACjC,CAAC;IAED,mBAAmB;QACjB,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC,GAAG,CAAC,CAAC,iBAAiB,EAAE,EAAE;YACxE,OAAO,IAAI,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,CAAA;QACnD,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,kBAAkB,CAAC,iBAAyB;QAC1C,MAAM,mBAAmB,GAAG,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAA;QAC1E,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAA;QACjE,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;QAChD,OAAO;YACL,eAAe,EAAE,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,GAAG,CAAC;YACpD,MAAM;YACN,QAAQ;YACR,OAAO,EAAE,mBAAmB,CAAC,OAAO;YACpC,aAAa,EAAE,mBAAmB,CAAC,aAAa;YAChD,eAAe,EAAE,mBAAmB,CAAC,eAAe;YACpD,WAAW,EAAE,mBAAmB,CAAC,WAAW;YAC5C,mBAAmB,EAAE,mBAAmB,CAAC,mBAAmB;SAC7D,CAAA;IACH,CAAC;IAED,aAAa,CAAC,QAA2B;QACvC,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC;YAC5C,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,eAAe,CAAC,GAAG,CAAC;gBACnD,QAAQ,CAAC,eAAe,CAAA;QAC5B,CAAC;aAAM,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1C,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAA;QACtD,CAAC;aAAM,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,sBAAsB,CAAC,EAAE,CAAC;YAC1D,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAA;QACpE,CAAC;aAAM,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5C,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,QAAQ,CAAA;QAC5D,CAAC;aAAM,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC;YACnD,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAA;QACpD,CAAC;aAAM,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;YAC9C,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;QAC3C,CAAC;aAAM,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC;YACpD,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAA;QACrD,CAAC;aAAM,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC;YACpD,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAA;QACrD,CAAC;IACH,CAAC;IAEO,mBAAmB,CAAC,eAAyC;QACnE,IAAI,CAAC,sBAAsB,CAAC,eAAe,CAAC,EAAE,CAAC,GAAG;YAChD,OAAO,EAAE,eAAe,CAAC,OAAO;YAChC,aAAa,EAAE,KAAK;YACpB,UAAU,EAAE,eAAe,CAAC,UAAU;YACtC,eAAe,EAAE,EAAE;YACnB,WAAW,EAAE,EAAE;YACf,mBAAmB,EAAE;gBACnB,QAAQ,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;gBAClC,MAAM,EAAE,QAAQ,CAAC,oBAAoB,CAAC,OAAO;aAC9C;SACF,CAAA;IACH,CAAC;IAED,eAAe,CAAC,UAA+B;QAC7C,MAAM,EAAE,iBAAiB,EAAE,UAAU,EAAE,GAAG,UAAU,CAAA;QACpD,2FAA2F;QAC3F,IAAI,IAAA,6BAAa,EAAC,iBAAiB,CAAC,IAAI,IAAA,6BAAa,EAAC,UAAU,CAAC,EAAE,CAAC;YAClE,MAAM,EAAE,eAAe,EAAE,GAAG,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAA;YAC1E,IAAI,IAAA,gCAAgB,EAAC,eAAe,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC;gBAClD,eAAe,CAAC,UAAU,CAAC,GAAG,EAAE,CAAA;YAClC,CAAC;YACD,eAAe,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAC9C,CAAC;IACH,CAAC;IAED,mBAAmB,CAAC,EAClB,iBAAiB,EACjB,UAAU,EACV,cAAc,GACY;QAC1B,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC,WAAW,CAAC,UAAU,CAAC;YACpE,cAAc,CAAA;IAClB,CAAC;IAED,mBAAmB,CAAC,EAClB,iBAAiB,EACjB,aAAa,GACa;QAC1B,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAC/B,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC,WAAW,CAC3D,CAAA;QACD,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC,mBAAmB;YAChE,QAAQ,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAA;QAC9C,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC,aAAa,GAAG,aAAa,CAAA;IAC9E,CAAC;CACF;AA5GD,qCA4GC","sourcesContent":["import { EventEmitter } from 'node:events'\nimport * as messages from '@cucumber/messages'\nimport { doesHaveValue, doesNotHaveValue } from '../../value_checker'\n\ninterface ITestCaseAttemptData {\n  attempt: number\n  willBeRetried: boolean\n  testCaseId: string\n  stepAttachments: Record<string, messages.Attachment[]>\n  stepResults: Record<string, messages.TestStepResult>\n  worstTestStepResult: messages.TestStepResult\n}\n\nexport interface ITestCaseAttempt {\n  attempt: number\n  willBeRetried: boolean\n  gherkinDocument: messages.GherkinDocument\n  pickle: messages.Pickle\n  stepAttachments: Record<string, messages.Attachment[]>\n  stepResults: Record<string, messages.TestStepResult>\n  testCase: messages.TestCase\n  worstTestStepResult: messages.TestStepResult\n}\n\nexport default class EventDataCollector {\n  private gherkinDocumentMap: Record<string, messages.GherkinDocument> = {}\n  private pickleMap: Record<string, messages.Pickle> = {}\n  private testCaseMap: Record<string, messages.TestCase> = {}\n  private testCaseAttemptDataMap: Record<string, ITestCaseAttemptData> = {}\n  readonly undefinedParameterTypes: messages.UndefinedParameterType[] = []\n\n  constructor(eventBroadcaster: EventEmitter) {\n    eventBroadcaster.on('envelope', this.parseEnvelope.bind(this))\n  }\n\n  getGherkinDocument(uri: string): messages.GherkinDocument {\n    return this.gherkinDocumentMap[uri]\n  }\n\n  getPickle(pickleId: string): messages.Pickle {\n    return this.pickleMap[pickleId]\n  }\n\n  getTestCaseAttempts(): ITestCaseAttempt[] {\n    return Object.keys(this.testCaseAttemptDataMap).map((testCaseStartedId) => {\n      return this.getTestCaseAttempt(testCaseStartedId)\n    })\n  }\n\n  getTestCaseAttempt(testCaseStartedId: string): ITestCaseAttempt {\n    const testCaseAttemptData = this.testCaseAttemptDataMap[testCaseStartedId]\n    const testCase = this.testCaseMap[testCaseAttemptData.testCaseId]\n    const pickle = this.pickleMap[testCase.pickleId]\n    return {\n      gherkinDocument: this.gherkinDocumentMap[pickle.uri],\n      pickle,\n      testCase,\n      attempt: testCaseAttemptData.attempt,\n      willBeRetried: testCaseAttemptData.willBeRetried,\n      stepAttachments: testCaseAttemptData.stepAttachments,\n      stepResults: testCaseAttemptData.stepResults,\n      worstTestStepResult: testCaseAttemptData.worstTestStepResult,\n    }\n  }\n\n  parseEnvelope(envelope: messages.Envelope): void {\n    if (doesHaveValue(envelope.gherkinDocument)) {\n      this.gherkinDocumentMap[envelope.gherkinDocument.uri] =\n        envelope.gherkinDocument\n    } else if (doesHaveValue(envelope.pickle)) {\n      this.pickleMap[envelope.pickle.id] = envelope.pickle\n    } else if (doesHaveValue(envelope.undefinedParameterType)) {\n      this.undefinedParameterTypes.push(envelope.undefinedParameterType)\n    } else if (doesHaveValue(envelope.testCase)) {\n      this.testCaseMap[envelope.testCase.id] = envelope.testCase\n    } else if (doesHaveValue(envelope.testCaseStarted)) {\n      this.initTestCaseAttempt(envelope.testCaseStarted)\n    } else if (doesHaveValue(envelope.attachment)) {\n      this.storeAttachment(envelope.attachment)\n    } else if (doesHaveValue(envelope.testStepFinished)) {\n      this.storeTestStepResult(envelope.testStepFinished)\n    } else if (doesHaveValue(envelope.testCaseFinished)) {\n      this.storeTestCaseResult(envelope.testCaseFinished)\n    }\n  }\n\n  private initTestCaseAttempt(testCaseStarted: messages.TestCaseStarted): void {\n    this.testCaseAttemptDataMap[testCaseStarted.id] = {\n      attempt: testCaseStarted.attempt,\n      willBeRetried: false,\n      testCaseId: testCaseStarted.testCaseId,\n      stepAttachments: {},\n      stepResults: {},\n      worstTestStepResult: {\n        duration: { seconds: 0, nanos: 0 },\n        status: messages.TestStepResultStatus.UNKNOWN,\n      },\n    }\n  }\n\n  storeAttachment(attachment: messages.Attachment): void {\n    const { testCaseStartedId, testStepId } = attachment\n    // TODO: we shouldn't have to check if these properties have values - they are non-nullable\n    if (doesHaveValue(testCaseStartedId) && doesHaveValue(testStepId)) {\n      const { stepAttachments } = this.testCaseAttemptDataMap[testCaseStartedId]\n      if (doesNotHaveValue(stepAttachments[testStepId])) {\n        stepAttachments[testStepId] = []\n      }\n      stepAttachments[testStepId].push(attachment)\n    }\n  }\n\n  storeTestStepResult({\n    testCaseStartedId,\n    testStepId,\n    testStepResult,\n  }: messages.TestStepFinished): void {\n    this.testCaseAttemptDataMap[testCaseStartedId].stepResults[testStepId] =\n      testStepResult\n  }\n\n  storeTestCaseResult({\n    testCaseStartedId,\n    willBeRetried,\n  }: messages.TestCaseFinished): void {\n    const stepResults = Object.values(\n      this.testCaseAttemptDataMap[testCaseStartedId].stepResults\n    )\n    this.testCaseAttemptDataMap[testCaseStartedId].worstTestStepResult =\n      messages.getWorstTestStepResult(stepResults)\n    this.testCaseAttemptDataMap[testCaseStartedId].willBeRetried = willBeRetried\n  }\n}\n"]}
+{"version":3,"file":"event_data_collector.js","sourceRoot":"","sources":["../../../src/formatter/helpers/event_data_collector.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,6DAA8C;AAC9C,uDAAqE;AAsBrE,MAAqB,kBAAkB;IAC7B,kBAAkB,GAA6C,EAAE,CAAA;IACjE,SAAS,GAAoC,EAAE,CAAA;IAC/C,WAAW,GAAsC,EAAE,CAAA;IACnD,sBAAsB,GAAyC,EAAE,CAAA;IAChE,uBAAuB,GAAsC,EAAE,CAAA;IAExE,YAAY,gBAA8B;QACxC,gBAAgB,CAAC,EAAE,CAAC,UAAU,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;IAChE,CAAC;IAED,kBAAkB,CAAC,GAAW;QAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAA;IACrC,CAAC;IAED,SAAS,CAAC,QAAgB;QACxB,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAA;IACjC,CAAC;IAED,mBAAmB;QACjB,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC,GAAG,CAAC,CAAC,iBAAiB,EAAE,EAAE;YACxE,OAAO,IAAI,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,CAAA;QACnD,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,kBAAkB,CAAC,iBAAyB;QAC1C,MAAM,mBAAmB,GAAG,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAA;QAC1E,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAA;QACjE,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;QAChD,OAAO;YACL,eAAe,EAAE,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,GAAG,CAAC;YACpD,MAAM;YACN,QAAQ;YACR,OAAO,EAAE,mBAAmB,CAAC,OAAO;YACpC,aAAa,EAAE,mBAAmB,CAAC,aAAa;YAChD,eAAe,EAAE,mBAAmB,CAAC,eAAe;YACpD,WAAW,EAAE,mBAAmB,CAAC,WAAW;YAC5C,mBAAmB,EAAE,mBAAmB,CAAC,mBAAmB;SAC7D,CAAA;IACH,CAAC;IAED,aAAa,CAAC,QAA2B;QACvC,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC;YAC5C,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,eAAe,CAAC,GAAG,CAAC;gBACnD,QAAQ,CAAC,eAAe,CAAA;QAC5B,CAAC;aAAM,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1C,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAA;QACtD,CAAC;aAAM,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,sBAAsB,CAAC,EAAE,CAAC;YAC1D,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAA;QACpE,CAAC;aAAM,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5C,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,QAAQ,CAAA;QAC5D,CAAC;aAAM,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC;YACnD,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAA;QACpD,CAAC;aAAM,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;YAC9C,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;QAC3C,CAAC;aAAM,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC;YACpD,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAA;QACrD,CAAC;aAAM,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC;YACpD,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAA;QACrD,CAAC;IACH,CAAC;IAEO,mBAAmB,CAAC,eAAyC;QACnE,IAAI,CAAC,sBAAsB,CAAC,eAAe,CAAC,EAAE,CAAC,GAAG;YAChD,OAAO,EAAE,eAAe,CAAC,OAAO;YAChC,aAAa,EAAE,KAAK;YACpB,UAAU,EAAE,eAAe,CAAC,UAAU;YACtC,eAAe,EAAE,EAAE;YACnB,WAAW,EAAE,EAAE;YACf,mBAAmB,EAAE;gBACnB,QAAQ,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;gBAClC,MAAM,EAAE,QAAQ,CAAC,oBAAoB,CAAC,OAAO;aAC9C;SACF,CAAA;IACH,CAAC;IAED,eAAe,CAAC,UAA+B;QAC7C,MAAM,EAAE,iBAAiB,EAAE,UAAU,EAAE,GAAG,UAAU,CAAA;QACpD,IAAI,IAAA,6BAAa,EAAC,iBAAiB,CAAC,IAAI,IAAA,6BAAa,EAAC,UAAU,CAAC,EAAE,CAAC;YAClE,MAAM,EAAE,eAAe,EAAE,GAAG,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAA;YAC1E,IAAI,IAAA,gCAAgB,EAAC,eAAe,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC;gBAClD,eAAe,CAAC,UAAU,CAAC,GAAG,EAAE,CAAA;YAClC,CAAC;YACD,eAAe,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAC9C,CAAC;IACH,CAAC;IAED,mBAAmB,CAAC,EAClB,iBAAiB,EACjB,UAAU,EACV,cAAc,GACY;QAC1B,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC,WAAW,CAAC,UAAU,CAAC;YACpE,cAAc,CAAA;IAClB,CAAC;IAED,mBAAmB,CAAC,EAClB,iBAAiB,EACjB,aAAa,GACa;QAC1B,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAC/B,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC,WAAW,CAC3D,CAAA;QACD,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC,mBAAmB;YAChE,QAAQ,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAA;QAC9C,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC,aAAa,GAAG,aAAa,CAAA;IAC9E,CAAC;CACF;AA3GD,qCA2GC","sourcesContent":["import { EventEmitter } from 'node:events'\nimport * as messages from '@cucumber/messages'\nimport { doesHaveValue, doesNotHaveValue } from '../../value_checker'\n\ninterface ITestCaseAttemptData {\n  attempt: number\n  willBeRetried: boolean\n  testCaseId: string\n  stepAttachments: Record<string, messages.Attachment[]>\n  stepResults: Record<string, messages.TestStepResult>\n  worstTestStepResult: messages.TestStepResult\n}\n\nexport interface ITestCaseAttempt {\n  attempt: number\n  willBeRetried: boolean\n  gherkinDocument: messages.GherkinDocument\n  pickle: messages.Pickle\n  stepAttachments: Record<string, messages.Attachment[]>\n  stepResults: Record<string, messages.TestStepResult>\n  testCase: messages.TestCase\n  worstTestStepResult: messages.TestStepResult\n}\n\nexport default class EventDataCollector {\n  private gherkinDocumentMap: Record<string, messages.GherkinDocument> = {}\n  private pickleMap: Record<string, messages.Pickle> = {}\n  private testCaseMap: Record<string, messages.TestCase> = {}\n  private testCaseAttemptDataMap: Record<string, ITestCaseAttemptData> = {}\n  readonly undefinedParameterTypes: messages.UndefinedParameterType[] = []\n\n  constructor(eventBroadcaster: EventEmitter) {\n    eventBroadcaster.on('envelope', this.parseEnvelope.bind(this))\n  }\n\n  getGherkinDocument(uri: string): messages.GherkinDocument {\n    return this.gherkinDocumentMap[uri]\n  }\n\n  getPickle(pickleId: string): messages.Pickle {\n    return this.pickleMap[pickleId]\n  }\n\n  getTestCaseAttempts(): ITestCaseAttempt[] {\n    return Object.keys(this.testCaseAttemptDataMap).map((testCaseStartedId) => {\n      return this.getTestCaseAttempt(testCaseStartedId)\n    })\n  }\n\n  getTestCaseAttempt(testCaseStartedId: string): ITestCaseAttempt {\n    const testCaseAttemptData = this.testCaseAttemptDataMap[testCaseStartedId]\n    const testCase = this.testCaseMap[testCaseAttemptData.testCaseId]\n    const pickle = this.pickleMap[testCase.pickleId]\n    return {\n      gherkinDocument: this.gherkinDocumentMap[pickle.uri],\n      pickle,\n      testCase,\n      attempt: testCaseAttemptData.attempt,\n      willBeRetried: testCaseAttemptData.willBeRetried,\n      stepAttachments: testCaseAttemptData.stepAttachments,\n      stepResults: testCaseAttemptData.stepResults,\n      worstTestStepResult: testCaseAttemptData.worstTestStepResult,\n    }\n  }\n\n  parseEnvelope(envelope: messages.Envelope): void {\n    if (doesHaveValue(envelope.gherkinDocument)) {\n      this.gherkinDocumentMap[envelope.gherkinDocument.uri] =\n        envelope.gherkinDocument\n    } else if (doesHaveValue(envelope.pickle)) {\n      this.pickleMap[envelope.pickle.id] = envelope.pickle\n    } else if (doesHaveValue(envelope.undefinedParameterType)) {\n      this.undefinedParameterTypes.push(envelope.undefinedParameterType)\n    } else if (doesHaveValue(envelope.testCase)) {\n      this.testCaseMap[envelope.testCase.id] = envelope.testCase\n    } else if (doesHaveValue(envelope.testCaseStarted)) {\n      this.initTestCaseAttempt(envelope.testCaseStarted)\n    } else if (doesHaveValue(envelope.attachment)) {\n      this.storeAttachment(envelope.attachment)\n    } else if (doesHaveValue(envelope.testStepFinished)) {\n      this.storeTestStepResult(envelope.testStepFinished)\n    } else if (doesHaveValue(envelope.testCaseFinished)) {\n      this.storeTestCaseResult(envelope.testCaseFinished)\n    }\n  }\n\n  private initTestCaseAttempt(testCaseStarted: messages.TestCaseStarted): void {\n    this.testCaseAttemptDataMap[testCaseStarted.id] = {\n      attempt: testCaseStarted.attempt,\n      willBeRetried: false,\n      testCaseId: testCaseStarted.testCaseId,\n      stepAttachments: {},\n      stepResults: {},\n      worstTestStepResult: {\n        duration: { seconds: 0, nanos: 0 },\n        status: messages.TestStepResultStatus.UNKNOWN,\n      },\n    }\n  }\n\n  storeAttachment(attachment: messages.Attachment): void {\n    const { testCaseStartedId, testStepId } = attachment\n    if (doesHaveValue(testCaseStartedId) && doesHaveValue(testStepId)) {\n      const { stepAttachments } = this.testCaseAttemptDataMap[testCaseStartedId]\n      if (doesNotHaveValue(stepAttachments[testStepId])) {\n        stepAttachments[testStepId] = []\n      }\n      stepAttachments[testStepId].push(attachment)\n    }\n  }\n\n  storeTestStepResult({\n    testCaseStartedId,\n    testStepId,\n    testStepResult,\n  }: messages.TestStepFinished): void {\n    this.testCaseAttemptDataMap[testCaseStartedId].stepResults[testStepId] =\n      testStepResult\n  }\n\n  storeTestCaseResult({\n    testCaseStartedId,\n    willBeRetried,\n  }: messages.TestCaseFinished): void {\n    const stepResults = Object.values(\n      this.testCaseAttemptDataMap[testCaseStartedId].stepResults\n    )\n    this.testCaseAttemptDataMap[testCaseStartedId].worstTestStepResult =\n      messages.getWorstTestStepResult(stepResults)\n    this.testCaseAttemptDataMap[testCaseStartedId].willBeRetried = willBeRetried\n  }\n}\n"]}

package/lib/formatter/index.d.ts

@@ -10,6 +10,9 @@ export interface FormatRerunOptions {
     separator?: string;
 }
 export interface FormatOptions {
+    /**
+     * @deprecated use `FORCE_COLOR` instead; see https://github.com/cucumber/cucumber-js/blob/main/docs/deprecations.md
+     */
     colorsEnabled?: boolean;
     html?: {
         externalAttachments?: boolean;

package/lib/formatter/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/formatter/index.ts"],"names":[],"mappings":";;AAGA,oDAAiD;AAyCjD,MAAqB,SAAS;IAClB,QAAQ,CAAW;IACnB,GAAG,CAAQ;IACX,kBAAkB,CAAoB;IACtC,GAAG,CAAiB;IACpB,cAAc,CAA8B;IAC5C,MAAM,CAAU;IAChB,kBAAkB,CAAoB;IACtC,gBAAgB,CAAS;IAClB,OAAO,CAAqB;IAC7C,MAAM,CAAU,aAAa,CAAQ;IAErC,YAAY,OAA0B;QACpC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAA;QAChC,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAA;QACtB,IAAI,CAAC,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAA;QACpD,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAA;QACtB,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAA;QAC5C,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAA;QAC5B,IAAI,CAAC,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAA;QACpD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;QAC9B,IAAI,CAAC,gBAAgB,GAAG,IAAA,8BAAc,EACpC,OAAO,CAAC,iBAAiB,CAAC,gBAAgB,EAC1C,IAAI,CACL,CAAA;IACH,CAAC;IAED,KAAK,CAAC,QAAQ;QACZ,MAAM,IAAI,CAAC,OAAO,EAAE,CAAA;IACtB,CAAC;CACF;AA9BD,4BA8BC","sourcesContent":["import { Writable } from 'node:stream'\nimport { EventEmitter } from 'node:events'\nimport { SupportCodeLibrary } from '../support_code_library_builder/types'\nimport { valueOrDefault } from '../value_checker'\nimport { FormatterPlugin } from '../plugin'\nimport { IColorFns } from './get_color_fns'\nimport { EventDataCollector } from './helpers'\nimport StepDefinitionSnippetBuilder from './step_definition_snippet_builder'\nimport { SnippetInterface } from './step_definition_snippet_builder/snippet_syntax'\n\nexport interface FormatRerunOptions {\n  separator?: string\n}\n\nexport interface FormatOptions {\n  colorsEnabled?: boolean\n  html?: {\n    externalAttachments?: boolean\n  }\n  rerun?: FormatRerunOptions\n  snippetInterface?: SnippetInterface\n  snippetSyntax?: string\n  printAttachments?: boolean\n  [customKey: string]: any\n}\n\nexport type FormatterImplementation = typeof Formatter | FormatterPlugin\nexport type IFormatterStream = Writable\nexport type IFormatterLogFn = (buffer: string | Uint8Array) => void\nexport type IFormatterCleanupFn = () => Promise<any>\n\nexport interface IFormatterOptions {\n  colorFns: IColorFns\n  cwd: string\n  eventBroadcaster: EventEmitter\n  eventDataCollector: EventDataCollector\n  log: IFormatterLogFn\n  parsedArgvOptions: FormatOptions\n  snippetBuilder: StepDefinitionSnippetBuilder\n  stream: Writable\n  cleanup: IFormatterCleanupFn\n  supportCodeLibrary: SupportCodeLibrary\n}\n\nexport default class Formatter {\n  protected colorFns: IColorFns\n  protected cwd: string\n  protected eventDataCollector: EventDataCollector\n  protected log: IFormatterLogFn\n  protected snippetBuilder: StepDefinitionSnippetBuilder\n  protected stream: Writable\n  protected supportCodeLibrary: SupportCodeLibrary\n  protected printAttachments: boolean\n  private readonly cleanup: IFormatterCleanupFn\n  static readonly documentation: string\n\n  constructor(options: IFormatterOptions) {\n    this.colorFns = options.colorFns\n    this.cwd = options.cwd\n    this.eventDataCollector = options.eventDataCollector\n    this.log = options.log\n    this.snippetBuilder = options.snippetBuilder\n    this.stream = options.stream\n    this.supportCodeLibrary = options.supportCodeLibrary\n    this.cleanup = options.cleanup\n    this.printAttachments = valueOrDefault(\n      options.parsedArgvOptions.printAttachments,\n      true\n    )\n  }\n\n  async finished(): Promise<void> {\n    await this.cleanup()\n  }\n}\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/formatter/index.ts"],"names":[],"mappings":";;AAGA,oDAAiD;AA4CjD,MAAqB,SAAS;IAClB,QAAQ,CAAW;IACnB,GAAG,CAAQ;IACX,kBAAkB,CAAoB;IACtC,GAAG,CAAiB;IACpB,cAAc,CAA8B;IAC5C,MAAM,CAAU;IAChB,kBAAkB,CAAoB;IACtC,gBAAgB,CAAS;IAClB,OAAO,CAAqB;IAC7C,MAAM,CAAU,aAAa,CAAQ;IAErC,YAAY,OAA0B;QACpC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAA;QAChC,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAA;QACtB,IAAI,CAAC,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAA;QACpD,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAA;QACtB,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAA;QAC5C,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAA;QAC5B,IAAI,CAAC,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAA;QACpD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;QAC9B,IAAI,CAAC,gBAAgB,GAAG,IAAA,8BAAc,EACpC,OAAO,CAAC,iBAAiB,CAAC,gBAAgB,EAC1C,IAAI,CACL,CAAA;IACH,CAAC;IAED,KAAK,CAAC,QAAQ;QACZ,MAAM,IAAI,CAAC,OAAO,EAAE,CAAA;IACtB,CAAC;CACF;AA9BD,4BA8BC","sourcesContent":["import { Writable } from 'node:stream'\nimport { EventEmitter } from 'node:events'\nimport { SupportCodeLibrary } from '../support_code_library_builder/types'\nimport { valueOrDefault } from '../value_checker'\nimport { FormatterPlugin } from '../plugin'\nimport { IColorFns } from './get_color_fns'\nimport { EventDataCollector } from './helpers'\nimport StepDefinitionSnippetBuilder from './step_definition_snippet_builder'\nimport { SnippetInterface } from './step_definition_snippet_builder/snippet_syntax'\n\nexport interface FormatRerunOptions {\n  separator?: string\n}\n\nexport interface FormatOptions {\n  /**\n   * @deprecated use `FORCE_COLOR` instead; see https://github.com/cucumber/cucumber-js/blob/main/docs/deprecations.md\n   */\n  colorsEnabled?: boolean\n  html?: {\n    externalAttachments?: boolean\n  }\n  rerun?: FormatRerunOptions\n  snippetInterface?: SnippetInterface\n  snippetSyntax?: string\n  printAttachments?: boolean\n  [customKey: string]: any\n}\n\nexport type FormatterImplementation = typeof Formatter | FormatterPlugin\nexport type IFormatterStream = Writable\nexport type IFormatterLogFn = (buffer: string | Uint8Array) => void\nexport type IFormatterCleanupFn = () => Promise<any>\n\nexport interface IFormatterOptions {\n  colorFns: IColorFns\n  cwd: string\n  eventBroadcaster: EventEmitter\n  eventDataCollector: EventDataCollector\n  log: IFormatterLogFn\n  parsedArgvOptions: FormatOptions\n  snippetBuilder: StepDefinitionSnippetBuilder\n  stream: Writable\n  cleanup: IFormatterCleanupFn\n  supportCodeLibrary: SupportCodeLibrary\n}\n\nexport default class Formatter {\n  protected colorFns: IColorFns\n  protected cwd: string\n  protected eventDataCollector: EventDataCollector\n  protected log: IFormatterLogFn\n  protected snippetBuilder: StepDefinitionSnippetBuilder\n  protected stream: Writable\n  protected supportCodeLibrary: SupportCodeLibrary\n  protected printAttachments: boolean\n  private readonly cleanup: IFormatterCleanupFn\n  static readonly documentation: string\n\n  constructor(options: IFormatterOptions) {\n    this.colorFns = options.colorFns\n    this.cwd = options.cwd\n    this.eventDataCollector = options.eventDataCollector\n    this.log = options.log\n    this.snippetBuilder = options.snippetBuilder\n    this.stream = options.stream\n    this.supportCodeLibrary = options.supportCodeLibrary\n    this.cleanup = options.cleanup\n    this.printAttachments = valueOrDefault(\n      options.parsedArgvOptions.printAttachments,\n      true\n    )\n  }\n\n  async finished(): Promise<void> {\n    await this.cleanup()\n  }\n}\n"]}

package/lib/paths/types.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Paths that woll be used to load feature files and user code
+ * @public
+ * @remarks
+ * These values are the result of pre-processing to expand globs, expand
+ * directory references, and apply defaults where applicable.
+ */
 export interface IResolvedPaths {
     unexpandedSourcePaths: string[];
     sourcePaths: string[];

package/lib/paths/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/paths/types.ts"],"names":[],"mappings":"","sourcesContent":["export interface IResolvedPaths {\n  unexpandedSourcePaths: string[]\n  sourcePaths: string[]\n  requirePaths: string[]\n  importPaths: string[]\n}\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/paths/types.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Paths that woll be used to load feature files and user code\n * @public\n * @remarks\n * These values are the result of pre-processing to expand globs, expand\n * directory references, and apply defaults where applicable.\n */\nexport interface IResolvedPaths {\n  unexpandedSourcePaths: string[]\n  sourcePaths: string[]\n  requirePaths: string[]\n  importPaths: string[]\n}\n"]}

package/lib/plugin/plugin_manager.d.ts

@@ -1,14 +1,16 @@
 import { UsableEnvironment } from '../environment';
-import { InternalPlugin, CoordinatorPluginEventValues, CoordinatorPluginEventKey, CoordinatorPluginTransformEventKey, Operation, FormatterPlugin } from './types';
+import { CoordinatorEventKey, CoordinatorEventValues, CoordinatorTransformKey, CoordinatorTransformValues, FormatterPlugin, Plugin, PluginOperation } from './types';
 export declare class PluginManager {
     private readonly environment;
-    private handlers;
+    private readonly handlers;
+    private readonly transformers;
     private cleanupFns;
     constructor(environment: UsableEnvironment);
-    private register;
-    initFormatter<OptionsType>(plugin: FormatterPlugin<OptionsType>, options: OptionsType, stream: NodeJS.WritableStream, write: (buffer: string | Uint8Array) => void, directory?: string): Promise<void>;
-    initCoordinator<OptionsType>(operation: Operation, plugin: InternalPlugin<OptionsType>, options: OptionsType): Promise<void>;
-    emit<K extends CoordinatorPluginEventKey>(event: K, value: CoordinatorPluginEventValues[K]): void;
-    transform<K extends CoordinatorPluginTransformEventKey>(event: K, value: CoordinatorPluginEventValues[K]): Promise<CoordinatorPluginEventValues[K]>;
+    private registerHandler;
+    private registerTransformer;
+    initFormatter<OptionsType>(plugin: FormatterPlugin<OptionsType>, options: OptionsType, stream: NodeJS.WritableStream, write: (buffer: string | Uint8Array) => void, directory?: string, specifier?: string): Promise<void>;
+    initCoordinator<OptionsType>(operation: PluginOperation, plugin: Plugin<OptionsType>, options: OptionsType, specifier?: string): Promise<void>;
+    emit<K extends CoordinatorEventKey>(event: K, value: CoordinatorEventValues[K]): void;
+    transform<K extends CoordinatorTransformKey>(event: K, value: CoordinatorTransformValues[K]): Promise<CoordinatorTransformValues[K]>;
     cleanup(): Promise<void>;
 }

package/lib/plugin/plugin_manager.js

@@ -6,6 +6,8 @@ class PluginManager {
     handlers = {
         message: [],
         'paths:resolve': [],
+    };
+    transformers = {
         'pickles:filter': [],
         'pickles:order': [],
     };
@@ -13,12 +15,27 @@ class PluginManager {
     constructor(environment) {
         this.environment = environment;
     }
-    async register(event, handler) {
-        this.handlers[event]?.push(handler);
+    async registerHandler(event, handler, specifier) {
+        if (!this.handlers[event]) {
+            throw new Error(`Cannot register handler for unknown event "${event}"`);
+        }
+        this.handlers[event].push({
+            handler,
+            specifier,
+        });
     }
-    async initFormatter(plugin, options, stream, write, directory) {
+    async registerTransformer(event, transformer, specifier) {
+        if (!this.transformers[event]) {
+            throw new Error(`Cannot register transformer for unknown event "${event}"`);
+        }
+        this.transformers[event].push({
+            transformer,
+            specifier,
+        });
+    }
+    async initFormatter(plugin, options, stream, write, directory, specifier) {
         const cleanupFn = await plugin.formatter({
-            on: (key, handler) => this.register(key, handler),
+            on: (key, handler) => this.registerHandler(key, handler, specifier),
             options: plugin.optionsKey
                 ? (options[plugin.optionsKey] ?? {})
                 : options,
@@ -28,32 +45,44 @@ class PluginManager {
             directory,
         });
         if (typeof cleanupFn === 'function') {
-            this.cleanupFns.push(cleanupFn);
+            this.cleanupFns.push({
+                cleanupFn: cleanupFn,
+                specifier,
+            });
         }
     }
-    async initCoordinator(operation, plugin, options) {
-        const cleanupFn = await plugin.coordinator({
+    async initCoordinator(operation, plugin, options, specifier) {
+        const context = {
             operation,
-            on: this.register.bind(this),
-            options,
+            on: (event, handler) => this.registerHandler(event, handler, specifier),
+            transform: (event, transformer) => this.registerTransformer(event, transformer, specifier),
+            options: 'optionsKey' in plugin && plugin.optionsKey
+                ? (options[plugin.optionsKey] ?? {})
+                : options,
             logger: this.environment.logger,
             environment: {
                 cwd: this.environment.cwd,
                 stderr: this.environment.stderr,
                 env: { ...this.environment.env },
             },
-        });
+        };
+        const cleanupFn = await wrapErrorAsync(async () => await plugin.coordinator(context), specifier, `Plugin "${specifier}" errored when trying to init`);
         if (typeof cleanupFn === 'function') {
-            this.cleanupFns.push(cleanupFn);
+            this.cleanupFns.push({
+                cleanupFn: cleanupFn,
+                specifier,
+            });
         }
     }
     emit(event, value) {
-        this.handlers[event].forEach((handler) => handler(value));
+        this.handlers[event].forEach(({ handler, specifier }) => {
+            wrapError(() => handler(value), specifier, `Plugin "${specifier}" errored when trying to handle a "${event}" event`);
+        });
     }
     async transform(event, value) {
         let transformed = value;
-        for (const handler of this.handlers[event]) {
-            const returned = await handler(transformed);
+        for (const { transformer, specifier } of this.transformers[event]) {
+            const returned = await wrapErrorAsync(async () => await transformer(transformed), specifier, `Plugin "${specifier}" errored when trying to do a "${event}" transform`);
             if (typeof returned !== 'undefined') {
                 transformed = returned;
             }
@@ -61,10 +90,32 @@ class PluginManager {
         return transformed;
     }
     async cleanup() {
-        for (const cleanupFn of this.cleanupFns) {
-            await cleanupFn();
+        for (const { cleanupFn, specifier } of this.cleanupFns) {
+            await wrapErrorAsync(async () => await cleanupFn(), specifier, `Plugin "${specifier}" errored when trying to cleanup`);
         }
     }
 }
 exports.PluginManager = PluginManager;
+function wrapError(fn, specifier, message) {
+    try {
+        return fn();
+    }
+    catch (error) {
+        if (specifier) {
+            throw new Error(message, { cause: error });
+        }
+        throw error;
+    }
+}
+async function wrapErrorAsync(fn, specifier, message) {
+    try {
+        return await fn();
+    }
+    catch (error) {
+        if (specifier) {
+            throw new Error(message, { cause: error });
+        }
+        throw error;
+    }
+}
 //# sourceMappingURL=plugin_manager.js.map

package/lib/plugin/plugin_manager.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin_manager.js","sourceRoot":"","sources":["../../src/plugin/plugin_manager.ts"],"names":[],"mappings":";;;AAgBA,MAAa,aAAa;IASK;IARrB,QAAQ,GAAoB;QAClC,OAAO,EAAE,EAAE;QACX,eAAe,EAAE,EAAE;QACnB,gBAAgB,EAAE,EAAE;QACpB,eAAe,EAAE,EAAE;KACpB,CAAA;IACO,UAAU,GAAoB,EAAE,CAAA;IAExC,YAA6B,WAA8B;QAA9B,gBAAW,GAAX,WAAW,CAAmB;IAAG,CAAC;IAEvD,KAAK,CAAC,QAAQ,CACpB,KAAQ,EACR,OAAyC;QAEzC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;IACrC,CAAC;IAED,KAAK,CAAC,aAAa,CACjB,MAAoC,EACpC,OAAoB,EACpB,MAA6B,EAC7B,KAA4C,EAC5C,SAAkB;QAElB,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC;YACvC,EAAE,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC;YACjD,OAAO,EAAE,MAAM,CAAC,UAAU;gBACxB,CAAC,CAAC,CAAE,OAAe,CAAC,MAAM,CAAC,UAAU,CAAC,IAAK,EAAkB,CAAC;gBAC9D,CAAC,CAAC,OAAO;YACX,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM;YAC/B,MAAM;YACN,KAAK;YACL,SAAS;SACV,CAAC,CAAA;QACF,IAAI,OAAO,SAAS,KAAK,UAAU,EAAE,CAAC;YACpC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QACjC,CAAC;IACH,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,SAAoB,EACpB,MAAmC,EACnC,OAAoB;QAEpB,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC;YACzC,SAAS;YACT,EAAE,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;YAC5B,OAAO;YACP,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM;YAC/B,WAAW,EAAE;gBACX,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC,GAAG;gBACzB,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM;gBAC/B,GAAG,EAAE,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE;aACjC;SACF,CAAC,CAAA;QACF,IAAI,OAAO,SAAS,KAAK,UAAU,EAAE,CAAC;YACpC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QACjC,CAAC;IACH,CAAC;IAED,IAAI,CACF,KAAQ,EACR,KAAsC;QAEtC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAA;IAC3D,CAAC;IAED,KAAK,CAAC,SAAS,CACb,KAAQ,EACR,KAAsC;QAEtC,IAAI,WAAW,GAAG,KAAK,CAAA;QACvB,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3C,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,CAAA;YAC3C,IAAI,OAAO,QAAQ,KAAK,WAAW,EAAE,CAAC;gBACpC,WAAW,GAAG,QAAQ,CAAA;YACxB,CAAC;QACH,CAAC;QACD,OAAO,WAAW,CAAA;IACpB,CAAC;IAED,KAAK,CAAC,OAAO;QACX,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACxC,MAAM,SAAS,EAAE,CAAA;QACnB,CAAC;IACH,CAAC;CACF;AAvFD,sCAuFC","sourcesContent":["import { UsableEnvironment } from '../environment'\nimport {\n  CoordinatorPluginEventHandler,\n  InternalPlugin,\n  PluginCleanup,\n  CoordinatorPluginEventValues,\n  CoordinatorPluginEventKey,\n  CoordinatorPluginTransformEventKey,\n  Operation,\n  FormatterPlugin,\n} from './types'\n\ntype HandlerRegistry = {\n  [K in CoordinatorPluginEventKey]: Array<CoordinatorPluginEventHandler<K>>\n}\n\nexport class PluginManager {\n  private handlers: HandlerRegistry = {\n    message: [],\n    'paths:resolve': [],\n    'pickles:filter': [],\n    'pickles:order': [],\n  }\n  private cleanupFns: PluginCleanup[] = []\n\n  constructor(private readonly environment: UsableEnvironment) {}\n\n  private async register<K extends CoordinatorPluginEventKey>(\n    event: K,\n    handler: CoordinatorPluginEventHandler<K>\n  ) {\n    this.handlers[event]?.push(handler)\n  }\n\n  async initFormatter<OptionsType>(\n    plugin: FormatterPlugin<OptionsType>,\n    options: OptionsType,\n    stream: NodeJS.WritableStream,\n    write: (buffer: string | Uint8Array) => void,\n    directory?: string\n  ) {\n    const cleanupFn = await plugin.formatter({\n      on: (key, handler) => this.register(key, handler),\n      options: plugin.optionsKey\n        ? ((options as any)[plugin.optionsKey] ?? ({} as OptionsType))\n        : options,\n      logger: this.environment.logger,\n      stream,\n      write,\n      directory,\n    })\n    if (typeof cleanupFn === 'function') {\n      this.cleanupFns.push(cleanupFn)\n    }\n  }\n\n  async initCoordinator<OptionsType>(\n    operation: Operation,\n    plugin: InternalPlugin<OptionsType>,\n    options: OptionsType\n  ) {\n    const cleanupFn = await plugin.coordinator({\n      operation,\n      on: this.register.bind(this),\n      options,\n      logger: this.environment.logger,\n      environment: {\n        cwd: this.environment.cwd,\n        stderr: this.environment.stderr,\n        env: { ...this.environment.env },\n      },\n    })\n    if (typeof cleanupFn === 'function') {\n      this.cleanupFns.push(cleanupFn)\n    }\n  }\n\n  emit<K extends CoordinatorPluginEventKey>(\n    event: K,\n    value: CoordinatorPluginEventValues[K]\n  ): void {\n    this.handlers[event].forEach((handler) => handler(value))\n  }\n\n  async transform<K extends CoordinatorPluginTransformEventKey>(\n    event: K,\n    value: CoordinatorPluginEventValues[K]\n  ): Promise<CoordinatorPluginEventValues[K]> {\n    let transformed = value\n    for (const handler of this.handlers[event]) {\n      const returned = await handler(transformed)\n      if (typeof returned !== 'undefined') {\n        transformed = returned\n      }\n    }\n    return transformed\n  }\n\n  async cleanup(): Promise<void> {\n    for (const cleanupFn of this.cleanupFns) {\n      await cleanupFn()\n    }\n  }\n}\n"]}
+{"version":3,"file":"plugin_manager.js","sourceRoot":"","sources":["../../src/plugin/plugin_manager.ts"],"names":[],"mappings":";;;AAqCA,MAAa,aAAa;IAWK;IAVZ,QAAQ,GAAoB;QAC3C,OAAO,EAAE,EAAE;QACX,eAAe,EAAE,EAAE;KACpB,CAAA;IACgB,YAAY,GAAwB;QACnD,gBAAgB,EAAE,EAAE;QACpB,eAAe,EAAE,EAAE;KACpB,CAAA;IACO,UAAU,GAAqB,EAAE,CAAA;IAEzC,YAA6B,WAA8B;QAA9B,gBAAW,GAAX,WAAW,CAAmB;IAAG,CAAC;IAEvD,KAAK,CAAC,eAAe,CAC3B,KAAQ,EACR,OAAmC,EACnC,SAAkB;QAElB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CAAC,8CAA8C,KAAK,GAAG,CAAC,CAAA;QACzE,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC;YACxB,OAAO;YACP,SAAS;SACV,CAAC,CAAA;IACJ,CAAC;IAEO,KAAK,CAAC,mBAAmB,CAC/B,KAAQ,EACR,WAAsC,EACtC,SAAkB;QAElB,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CACb,kDAAkD,KAAK,GAAG,CAC3D,CAAA;QACH,CAAC;QACD,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC;YAC5B,WAAW;YACX,SAAS;SACV,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,aAAa,CACjB,MAAoC,EACpC,OAAoB,EACpB,MAA6B,EAC7B,KAA4C,EAC5C,SAAkB,EAClB,SAAkB;QAElB,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC;YACvC,EAAE,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,EAAE,OAAO,EAAE,SAAS,CAAC;YACnE,OAAO,EAAE,MAAM,CAAC,UAAU;gBACxB,CAAC,CAAC,CAAE,OAAe,CAAC,MAAM,CAAC,UAAU,CAAC,IAAK,EAAkB,CAAC;gBAC9D,CAAC,CAAC,OAAO;YACX,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM;YAC/B,MAAM;YACN,KAAK;YACL,SAAS;SACV,CAAC,CAAA;QACF,IAAI,OAAO,SAAS,KAAK,UAAU,EAAE,CAAC;YACpC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;gBACnB,SAAS,EAAE,SAAS;gBACpB,SAAS;aACV,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,SAA0B,EAC1B,MAA2B,EAC3B,OAAoB,EACpB,SAAkB;QAElB,MAAM,OAAO,GAAG;YACd,SAAS;YACT,EAAE,EAAE,CACF,KAAQ,EACR,OAAmC,EACnC,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,OAAO,EAAE,SAAS,CAAC;YACpD,SAAS,EAAE,CACT,KAAQ,EACR,WAAsC,EACtC,EAAE,CAAC,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE,WAAW,EAAE,SAAS,CAAC;YAC5D,OAAO,EACL,YAAY,IAAI,MAAM,IAAI,MAAM,CAAC,UAAU;gBACzC,CAAC,CAAC,CAAE,OAAe,CAAC,MAAM,CAAC,UAAU,CAAC,IAAK,EAAkB,CAAC;gBAC9D,CAAC,CAAC,OAAO;YACb,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM;YAC/B,WAAW,EAAE;gBACX,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC,GAAG;gBACzB,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM;gBAC/B,GAAG,EAAE,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE;aACjC;SACF,CAAA;QACD,MAAM,SAAS,GAAG,MAAM,cAAc,CACpC,KAAK,IAAI,EAAE,CAAC,MAAM,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,EAC7C,SAAS,EACT,WAAW,SAAS,+BAA+B,CACpD,CAAA;QACD,IAAI,OAAO,SAAS,KAAK,UAAU,EAAE,CAAC;YACpC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;gBACnB,SAAS,EAAE,SAAS;gBACpB,SAAS;aACV,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;IAED,IAAI,CACF,KAAQ,EACR,KAAgC;QAEhC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE,EAAE;YACtD,SAAS,CACP,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,EACpB,SAAS,EACT,WAAW,SAAS,sCAAsC,KAAK,SAAS,CACzE,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,SAAS,CACb,KAAQ,EACR,KAAoC;QAEpC,IAAI,WAAW,GAAG,KAAK,CAAA;QACvB,KAAK,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,IAAI,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;YAClE,MAAM,QAAQ,GAAG,MAAM,cAAc,CACnC,KAAK,IAAI,EAAE,CAAC,MAAM,WAAW,CAAC,WAAW,CAAC,EAC1C,SAAS,EACT,WAAW,SAAS,kCAAkC,KAAK,aAAa,CACzE,CAAA;YACD,IAAI,OAAO,QAAQ,KAAK,WAAW,EAAE,CAAC;gBACpC,WAAW,GAAG,QAAQ,CAAA;YACxB,CAAC;QACH,CAAC;QACD,OAAO,WAAW,CAAA;IACpB,CAAC;IAED,KAAK,CAAC,OAAO;QACX,KAAK,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACvD,MAAM,cAAc,CAClB,KAAK,IAAI,EAAE,CAAC,MAAM,SAAS,EAAE,EAC7B,SAAS,EACT,WAAW,SAAS,kCAAkC,CACvD,CAAA;QACH,CAAC;IACH,CAAC;CACF;AArJD,sCAqJC;AAED,SAAS,SAAS,CAAI,EAAW,EAAE,SAAiB,EAAE,OAAe;IACnE,IAAI,CAAC;QACH,OAAO,EAAE,EAAE,CAAA;IACb,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,SAAS,EAAE,CAAC;YACd,MAAM,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAA;QAC5C,CAAC;QACD,MAAM,KAAK,CAAA;IACb,CAAC;AACH,CAAC;AAED,KAAK,UAAU,cAAc,CAC3B,EAAoB,EACpB,SAAiB,EACjB,OAAe;IAEf,IAAI,CAAC;QACH,OAAO,MAAM,EAAE,EAAE,CAAA;IACnB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,SAAS,EAAE,CAAC;YACd,MAAM,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAA;QAC5C,CAAC;QACD,MAAM,KAAK,CAAA;IACb,CAAC;AACH,CAAC","sourcesContent":["import { UsableEnvironment } from '../environment'\nimport {\n  CoordinatorEventHandler,\n  CoordinatorEventKey,\n  CoordinatorEventValues,\n  CoordinatorTransformer,\n  CoordinatorTransformKey,\n  CoordinatorTransformValues,\n  FormatterPlugin,\n  Plugin,\n  PluginCleanup,\n  PluginOperation,\n} from './types'\n\ntype SourcedEventHandler<K extends CoordinatorEventKey> = {\n  handler: CoordinatorEventHandler<K>\n  specifier?: string\n}\n\ntype SourcedTransformer<K extends CoordinatorTransformKey> = {\n  transformer: CoordinatorTransformer<K>\n  specifier?: string\n}\n\ntype SourcedCleanup = {\n  cleanupFn: PluginCleanup\n  specifier?: string\n}\n\ntype HandlerRegistry = {\n  [K in CoordinatorEventKey]: Array<SourcedEventHandler<K>>\n}\n\ntype TransformerRegistry = {\n  [K in CoordinatorTransformKey]: Array<SourcedTransformer<K>>\n}\n\nexport class PluginManager {\n  private readonly handlers: HandlerRegistry = {\n    message: [],\n    'paths:resolve': [],\n  }\n  private readonly transformers: TransformerRegistry = {\n    'pickles:filter': [],\n    'pickles:order': [],\n  }\n  private cleanupFns: SourcedCleanup[] = []\n\n  constructor(private readonly environment: UsableEnvironment) {}\n\n  private async registerHandler<K extends CoordinatorEventKey>(\n    event: K,\n    handler: CoordinatorEventHandler<K>,\n    specifier?: string\n  ) {\n    if (!this.handlers[event]) {\n      throw new Error(`Cannot register handler for unknown event \"${event}\"`)\n    }\n    this.handlers[event].push({\n      handler,\n      specifier,\n    })\n  }\n\n  private async registerTransformer<K extends CoordinatorTransformKey>(\n    event: K,\n    transformer: CoordinatorTransformer<K>,\n    specifier?: string\n  ) {\n    if (!this.transformers[event]) {\n      throw new Error(\n        `Cannot register transformer for unknown event \"${event}\"`\n      )\n    }\n    this.transformers[event].push({\n      transformer,\n      specifier,\n    })\n  }\n\n  async initFormatter<OptionsType>(\n    plugin: FormatterPlugin<OptionsType>,\n    options: OptionsType,\n    stream: NodeJS.WritableStream,\n    write: (buffer: string | Uint8Array) => void,\n    directory?: string,\n    specifier?: string\n  ) {\n    const cleanupFn = await plugin.formatter({\n      on: (key, handler) => this.registerHandler(key, handler, specifier),\n      options: plugin.optionsKey\n        ? ((options as any)[plugin.optionsKey] ?? ({} as OptionsType))\n        : options,\n      logger: this.environment.logger,\n      stream,\n      write,\n      directory,\n    })\n    if (typeof cleanupFn === 'function') {\n      this.cleanupFns.push({\n        cleanupFn: cleanupFn,\n        specifier,\n      })\n    }\n  }\n\n  async initCoordinator<OptionsType>(\n    operation: PluginOperation,\n    plugin: Plugin<OptionsType>,\n    options: OptionsType,\n    specifier?: string\n  ) {\n    const context = {\n      operation,\n      on: <K extends CoordinatorEventKey>(\n        event: K,\n        handler: CoordinatorEventHandler<K>\n      ) => this.registerHandler(event, handler, specifier),\n      transform: <K extends CoordinatorTransformKey>(\n        event: K,\n        transformer: CoordinatorTransformer<K>\n      ) => this.registerTransformer(event, transformer, specifier),\n      options:\n        'optionsKey' in plugin && plugin.optionsKey\n          ? ((options as any)[plugin.optionsKey] ?? ({} as OptionsType))\n          : options,\n      logger: this.environment.logger,\n      environment: {\n        cwd: this.environment.cwd,\n        stderr: this.environment.stderr,\n        env: { ...this.environment.env },\n      },\n    }\n    const cleanupFn = await wrapErrorAsync(\n      async () => await plugin.coordinator(context),\n      specifier,\n      `Plugin \"${specifier}\" errored when trying to init`\n    )\n    if (typeof cleanupFn === 'function') {\n      this.cleanupFns.push({\n        cleanupFn: cleanupFn,\n        specifier,\n      })\n    }\n  }\n\n  emit<K extends CoordinatorEventKey>(\n    event: K,\n    value: CoordinatorEventValues[K]\n  ): void {\n    this.handlers[event].forEach(({ handler, specifier }) => {\n      wrapError(\n        () => handler(value),\n        specifier,\n        `Plugin \"${specifier}\" errored when trying to handle a \"${event}\" event`\n      )\n    })\n  }\n\n  async transform<K extends CoordinatorTransformKey>(\n    event: K,\n    value: CoordinatorTransformValues[K]\n  ): Promise<CoordinatorTransformValues[K]> {\n    let transformed = value\n    for (const { transformer, specifier } of this.transformers[event]) {\n      const returned = await wrapErrorAsync(\n        async () => await transformer(transformed),\n        specifier,\n        `Plugin \"${specifier}\" errored when trying to do a \"${event}\" transform`\n      )\n      if (typeof returned !== 'undefined') {\n        transformed = returned\n      }\n    }\n    return transformed\n  }\n\n  async cleanup(): Promise<void> {\n    for (const { cleanupFn, specifier } of this.cleanupFns) {\n      await wrapErrorAsync(\n        async () => await cleanupFn(),\n        specifier,\n        `Plugin \"${specifier}\" errored when trying to cleanup`\n      )\n    }\n  }\n}\n\nfunction wrapError<T>(fn: () => T, specifier: string, message: string): T {\n  try {\n    return fn()\n  } catch (error) {\n    if (specifier) {\n      throw new Error(message, { cause: error })\n    }\n    throw error\n  }\n}\n\nasync function wrapErrorAsync<T>(\n  fn: () => Promise<T>,\n  specifier: string,\n  message: string\n): Promise<T> {\n  try {\n    return await fn()\n  } catch (error) {\n    if (specifier) {\n      throw new Error(message, { cause: error })\n    }\n    throw error\n  }\n}\n"]}

package/lib/plugin/types.d.ts

@@ -1,53 +1,141 @@
+import { Writable } from 'node:stream';
 import { Envelope } from '@cucumber/messages';
-import { ArrayValues, Promisable } from 'type-fest';
-import { IRunEnvironment } from '../environment';
 import { ILogger } from '../environment';
 import { IFilterablePickle } from '../filter';
 import { IResolvedPaths } from '../paths';
-import { coordinatorTransformKeys, coordinatorVoidKeys } from './events';
-export type Operation = 'loadSources' | 'loadSupport' | 'runCucumber';
-export type CoordinatorPluginEnvironment = Required<Pick<IRunEnvironment, 'cwd' | 'stderr' | 'env'>>;
-export type CoordinatorPluginVoidEventKey = ArrayValues<typeof coordinatorVoidKeys>;
-export type CoordinatorPluginTransformEventKey = ArrayValues<typeof coordinatorTransformKeys>;
-export type CoordinatorPluginEventKey = CoordinatorPluginVoidEventKey | CoordinatorPluginTransformEventKey;
-export type CoordinatorPluginEventValues = {
+/**
+ * The operation Cucumber is doing in this process
+ * @public
+ * @remarks
+ * `loadSources` and `loadSupport` are generally used as preflight operations
+ * for complex use cases. `runCucumber` is the one where tests are actually
+ * executed.
+ */
+export type PluginOperation = 'loadSources' | 'loadSupport' | 'runCucumber';
+/**
+ * Subset of the environment available to plugins
+ * @public
+ */
+export type CoordinatorEnvironment = {
+    /**
+     * Working directory for the project
+     */
+    cwd: string;
+    /**
+     * Writable stream where the test run's warning/error output is written
+     * and plugins can write to directly if required
+     */
+    stderr: Writable;
+    /**
+     * Environment variables
+     */
+    env: Record<string, string | undefined>;
+};
+/**
+ * Keys for event handlers that plugins can register
+ * @public
+ */
+export type CoordinatorEventKey = 'message' | 'paths:resolve';
+/**
+ * Keys for transforms that plugins can register
+ * @public
+ */
+export type CoordinatorTransformKey = 'pickles:filter' | 'pickles:order';
+/**
+ * Mapping of event keys to their value types
+ * @public
+ */
+export type CoordinatorEventValues = {
     message: Readonly<Envelope>;
     'paths:resolve': Readonly<IResolvedPaths>;
+};
+/**
+ * Mapping of transform keys to their value types
+ * @public
+ */
+export type CoordinatorTransformValues = {
     'pickles:filter': Readonly<Array<IFilterablePickle>>;
     'pickles:order': Readonly<Array<IFilterablePickle>>;
 };
-export type CoordinatorPluginEventHandler<K extends CoordinatorPluginEventKey> = (value: CoordinatorPluginEventValues[K]) => K extends CoordinatorPluginTransformEventKey ? Promisable<CoordinatorPluginEventValues[K]> : void;
-export interface CoordinatorPluginContext<OptionsType> {
-    operation: Operation;
-    on: <EventKey extends CoordinatorPluginEventKey>(event: EventKey, handler: CoordinatorPluginEventHandler<EventKey>) => void;
+/**
+ * Handler function for a coordinator event
+ * @public
+ * @remarks
+ * You can do async work here, but Cucumber will not await the Promise.
+ */
+export type CoordinatorEventHandler<K extends CoordinatorEventKey> = (value: CoordinatorEventValues[K]) => void;
+/**
+ * Transformer function for a coordinator transform
+ * @remarks
+ * Don't try to modify the original value. Return a transformed value, or
+ * `undefined` to pass through unchanged.
+ * @public
+ */
+export type CoordinatorTransformer<K extends CoordinatorTransformKey> = (value: CoordinatorTransformValues[K]) => PromiseLike<CoordinatorTransformValues[K]> | CoordinatorTransformValues[K];
+/**
+ * Context object passed to a plugin's coordinator function
+ * @public
+ */
+export type CoordinatorContext<OptionsType> = {
+    /**
+     * The operation Cucumber is doing in this process
+     */
+    operation: PluginOperation;
+    /**
+     * Register an event handler
+     */
+    on: <EventKey extends CoordinatorEventKey>(event: EventKey, handler: CoordinatorEventHandler<EventKey>) => void;
+    /**
+     * Register a transformer
+     */
+    transform: <EventKey extends CoordinatorTransformKey>(event: EventKey, handler: CoordinatorTransformer<EventKey>) => void;
+    /**
+     * Options for the plugin
+     */
     options: OptionsType;
+    /**
+     * Logger for emitting user-facing messages or diagnostics
+     */
     logger: ILogger;
-    environment: CoordinatorPluginEnvironment;
-}
-export type CoordinatorPluginFunction<OptionsType> = (context: CoordinatorPluginContext<OptionsType>) => Promisable<PluginCleanup | void>;
-export type PluginCleanup = () => Promisable<void>;
-/**
- * A plugin to implement Cucumber built-in functionality.
- *
- * Uses the same events and mechanisms as user-authored plugins, but is free to require configuration and context from
- * inside of Cucumber as its `options`, whereas user-authored plugins will be limited to `pluginOptions` from the
- * project configuration.
- */
-export interface InternalPlugin<OptionsType = any> {
+    /**
+     * Subset of the environment
+     */
+    environment: CoordinatorEnvironment;
+};
+/**
+ * Optional cleanup function returned by a plugin coordinator
+ * @public
+ */
+export type PluginCleanup = () => PromiseLike<void> | void;
+/**
+ * A plugin that can subscribe to events and register transforms
+ * @public
+ */
+export type Plugin<OptionsType = any> = {
     type: 'plugin';
-    coordinator: CoordinatorPluginFunction<OptionsType>;
-}
-export interface FormatterPluginContext<OptionsType> {
+    /**
+     * Coordinator function called during initialization
+     * @remarks
+     * Can do async work, and the Promise will be awaited. Can optionally return
+     * a cleanup function to be called when Cucumber is about to exit.
+     */
+    coordinator: (context: CoordinatorContext<OptionsType>) => PromiseLike<PluginCleanup | void> | PluginCleanup | void;
+    /**
+     * Optional key to extract plugin-specific options from the root options object
+     */
+    optionsKey?: string;
+};
+export type FormatterPluginContext<OptionsType> = {
     on: (key: 'message', handler: (value: Envelope) => void) => void;
     options: OptionsType;
     logger: ILogger;
     stream: NodeJS.WritableStream;
     write: (buffer: string | Uint8Array) => void;
     directory?: string;
-}
-export type FormatterPluginFunction<OptionsType> = (context: FormatterPluginContext<OptionsType>) => Promisable<PluginCleanup | void>;
-export interface FormatterPlugin<OptionsType = any> {
+};
+export type FormatterPluginFunction<OptionsType> = (context: FormatterPluginContext<OptionsType>) => PromiseLike<PluginCleanup | void> | PluginCleanup | void;
+export type FormatterPlugin<OptionsType = any> = {
     type: 'formatter';
     formatter: FormatterPluginFunction<OptionsType>;
     optionsKey?: string;
-}
+};

package/lib/plugin/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/plugin/types.ts"],"names":[],"mappings":"","sourcesContent":["import { Envelope } from '@cucumber/messages'\nimport { ArrayValues, Promisable } from 'type-fest'\nimport { IRunEnvironment } from '../environment'\nimport { ILogger } from '../environment'\nimport { IFilterablePickle } from '../filter'\nimport { IResolvedPaths } from '../paths'\nimport { coordinatorTransformKeys, coordinatorVoidKeys } from './events'\n\nexport type Operation = 'loadSources' | 'loadSupport' | 'runCucumber'\n\nexport type CoordinatorPluginEnvironment = Required<\n  Pick<IRunEnvironment, 'cwd' | 'stderr' | 'env'>\n>\n\nexport type CoordinatorPluginVoidEventKey = ArrayValues<\n  typeof coordinatorVoidKeys\n>\nexport type CoordinatorPluginTransformEventKey = ArrayValues<\n  typeof coordinatorTransformKeys\n>\nexport type CoordinatorPluginEventKey =\n  | CoordinatorPluginVoidEventKey\n  | CoordinatorPluginTransformEventKey\n\nexport type CoordinatorPluginEventValues = {\n  // void\n  message: Readonly<Envelope>\n  'paths:resolve': Readonly<IResolvedPaths>\n  // transform\n  'pickles:filter': Readonly<Array<IFilterablePickle>>\n  'pickles:order': Readonly<Array<IFilterablePickle>>\n}\n\nexport type CoordinatorPluginEventHandler<K extends CoordinatorPluginEventKey> =\n  (\n    value: CoordinatorPluginEventValues[K]\n  ) => K extends CoordinatorPluginTransformEventKey\n    ? Promisable<CoordinatorPluginEventValues[K]>\n    : void\n\nexport interface CoordinatorPluginContext<OptionsType> {\n  operation: Operation\n  on: <EventKey extends CoordinatorPluginEventKey>(\n    event: EventKey,\n    handler: CoordinatorPluginEventHandler<EventKey>\n  ) => void\n  options: OptionsType\n  logger: ILogger\n  environment: CoordinatorPluginEnvironment\n}\n\nexport type CoordinatorPluginFunction<OptionsType> = (\n  context: CoordinatorPluginContext<OptionsType>\n) => Promisable<PluginCleanup | void>\n\nexport type PluginCleanup = () => Promisable<void>\n\n/**\n * A plugin to implement Cucumber built-in functionality.\n *\n * Uses the same events and mechanisms as user-authored plugins, but is free to require configuration and context from\n * inside of Cucumber as its `options`, whereas user-authored plugins will be limited to `pluginOptions` from the\n * project configuration.\n */\nexport interface InternalPlugin<OptionsType = any> {\n  type: 'plugin'\n  coordinator: CoordinatorPluginFunction<OptionsType>\n}\n\nexport interface FormatterPluginContext<OptionsType> {\n  on: (key: 'message', handler: (value: Envelope) => void) => void\n  options: OptionsType\n  logger: ILogger\n  stream: NodeJS.WritableStream\n  write: (buffer: string | Uint8Array) => void\n  directory?: string\n}\n\nexport type FormatterPluginFunction<OptionsType> = (\n  context: FormatterPluginContext<OptionsType>\n) => Promisable<PluginCleanup | void>\n\nexport interface FormatterPlugin<OptionsType = any> {\n  type: 'formatter'\n  formatter: FormatterPluginFunction<OptionsType>\n  optionsKey?: string\n}\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/plugin/types.ts"],"names":[],"mappings":"","sourcesContent":["import { Writable } from 'node:stream'\nimport { Envelope } from '@cucumber/messages'\nimport { ILogger } from '../environment'\nimport { IFilterablePickle } from '../filter'\nimport { IResolvedPaths } from '../paths'\n\n/**\n * The operation Cucumber is doing in this process\n * @public\n * @remarks\n * `loadSources` and `loadSupport` are generally used as preflight operations\n * for complex use cases. `runCucumber` is the one where tests are actually\n * executed.\n */\nexport type PluginOperation = 'loadSources' | 'loadSupport' | 'runCucumber'\n\n/**\n * Subset of the environment available to plugins\n * @public\n */\nexport type CoordinatorEnvironment = {\n  /**\n   * Working directory for the project\n   */\n  cwd: string\n  /**\n   * Writable stream where the test run's warning/error output is written\n   * and plugins can write to directly if required\n   */\n  stderr: Writable\n  /**\n   * Environment variables\n   */\n  env: Record<string, string | undefined>\n}\n\n/**\n * Keys for event handlers that plugins can register\n * @public\n */\nexport type CoordinatorEventKey = 'message' | 'paths:resolve'\n\n/**\n * Keys for transforms that plugins can register\n * @public\n */\nexport type CoordinatorTransformKey = 'pickles:filter' | 'pickles:order'\n\n/**\n * Mapping of event keys to their value types\n * @public\n */\nexport type CoordinatorEventValues = {\n  message: Readonly<Envelope>\n  'paths:resolve': Readonly<IResolvedPaths>\n}\n\n/**\n * Mapping of transform keys to their value types\n * @public\n */\nexport type CoordinatorTransformValues = {\n  'pickles:filter': Readonly<Array<IFilterablePickle>>\n  'pickles:order': Readonly<Array<IFilterablePickle>>\n}\n\n/**\n * Handler function for a coordinator event\n * @public\n * @remarks\n * You can do async work here, but Cucumber will not await the Promise.\n */\nexport type CoordinatorEventHandler<K extends CoordinatorEventKey> = (\n  value: CoordinatorEventValues[K]\n) => void\n\n/**\n * Transformer function for a coordinator transform\n * @remarks\n * Don't try to modify the original value. Return a transformed value, or\n * `undefined` to pass through unchanged.\n * @public\n */\nexport type CoordinatorTransformer<K extends CoordinatorTransformKey> = (\n  value: CoordinatorTransformValues[K]\n) => PromiseLike<CoordinatorTransformValues[K]> | CoordinatorTransformValues[K]\n\n/**\n * Context object passed to a plugin's coordinator function\n * @public\n */\nexport type CoordinatorContext<OptionsType> = {\n  /**\n   * The operation Cucumber is doing in this process\n   */\n  operation: PluginOperation\n  /**\n   * Register an event handler\n   */\n  on: <EventKey extends CoordinatorEventKey>(\n    event: EventKey,\n    handler: CoordinatorEventHandler<EventKey>\n  ) => void\n  /**\n   * Register a transformer\n   */\n  transform: <EventKey extends CoordinatorTransformKey>(\n    event: EventKey,\n    handler: CoordinatorTransformer<EventKey>\n  ) => void\n  /**\n   * Options for the plugin\n   */\n  options: OptionsType\n  /**\n   * Logger for emitting user-facing messages or diagnostics\n   */\n  logger: ILogger\n  /**\n   * Subset of the environment\n   */\n  environment: CoordinatorEnvironment\n}\n\n/**\n * Optional cleanup function returned by a plugin coordinator\n * @public\n */\nexport type PluginCleanup = () => PromiseLike<void> | void\n\n/**\n * A plugin that can subscribe to events and register transforms\n * @public\n */\nexport type Plugin<OptionsType = any> = {\n  type: 'plugin'\n  /**\n   * Coordinator function called during initialization\n   * @remarks\n   * Can do async work, and the Promise will be awaited. Can optionally return\n   * a cleanup function to be called when Cucumber is about to exit.\n   */\n  coordinator: (\n    context: CoordinatorContext<OptionsType>\n  ) => PromiseLike<PluginCleanup | void> | PluginCleanup | void\n  /**\n   * Optional key to extract plugin-specific options from the root options object\n   */\n  optionsKey?: string\n}\n\nexport type FormatterPluginContext<OptionsType> = {\n  on: (key: 'message', handler: (value: Envelope) => void) => void\n  options: OptionsType\n  logger: ILogger\n  stream: NodeJS.WritableStream\n  write: (buffer: string | Uint8Array) => void\n  directory?: string\n}\n\nexport type FormatterPluginFunction<OptionsType> = (\n  context: FormatterPluginContext<OptionsType>\n) => PromiseLike<PluginCleanup | void> | PluginCleanup | void\n\nexport type FormatterPlugin<OptionsType = any> = {\n  type: 'formatter'\n  formatter: FormatterPluginFunction<OptionsType>\n  optionsKey?: string\n}\n"]}

package/lib/publish/publish_plugin.d.ts

@@ -1,3 +1,2 @@
-import { InternalPlugin } from '../plugin';
-import { IPublishConfig } from './types';
-export declare const publishPlugin: InternalPlugin<IPublishConfig | false>;
+import { Plugin } from '../plugin';
+export declare const publishPlugin: Plugin;

package/lib/publish/publish_plugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"publish_plugin.js","sourceRoot":"","sources":["../../src/publish/publish_plugin.ts"],"names":[],"mappings":";;;;;;AACA,mDAA+C;AAC/C,yCAAoD;AACpD,+CAAgD;AAChD,0DAA4B;AAC5B,qCAAgC;AAChC,qCAA6D;AAC7D,yCAAsC;AACtC,mDAA8C;AAC9C,wDAA8B;AAI9B,MAAM,4BAA4B,GAAG,0CAA0C,CAAA;AAElE,QAAA,aAAa,GAA2C;IACnE,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,EAAE,EAAE;QAC1D,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,SAAS,CAAA;QAClB,CAAC;QACD,MAAM,EAAE,GAAG,GAAG,4BAA4B,EAAE,KAAK,EAAE,GAAG,OAAO,CAAA;QAC7D,MAAM,OAAO,GAA8B,EAAE,CAAA;QAC7C,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,CAAC,aAAa,GAAG,UAAU,KAAK,EAAE,CAAA;QAC3C,CAAC;QACD,MAAM,aAAa,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,CAAC,CAAA;QACnD,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,IAAI,EAAE,CAAA;QAEzC,IAAI,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC;YACtB,OAAO,GAAG,EAAE;gBACV,IAAI,aAAa,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;oBAC/B,WAAW,CAAC,MAAM,CAAC,KAAK,CACtB,qBAAqB,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,IAAI,CACzD,CAAA;gBACH,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,KAAK,CACV,+BAA+B,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,gBAChD,aAAa,CAAC,MAChB,EAAE,CACH,CAAA;oBACD,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,CAAA;gBAC7B,CAAC;YACH,CAAC,CAAA;QACH,CAAC;QAED,MAAM,SAAS,GAAG,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;QACvD,MAAM,OAAO,GAAG,MAAM,IAAA,kBAAO,EAAC,mBAAI,CAAC,IAAI,CAAC,IAAA,gBAAM,GAAE,EAAE,sBAAsB,CAAC,CAAC,CAAA;QAC1E,MAAM,YAAY,GAAG,mBAAI,CAAC,IAAI,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAA;QAC7D,MAAM,WAAW,GAAG,IAAA,sBAAU,GAAE,CAAA;QAChC,MAAM,eAAe,GAAG,IAAA,mBAAQ,EAC9B,WAAW,EACX,IAAA,2BAAiB,EAAC,YAAY,CAAC,CAChC,CAAA;QACD,EAAE,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC,CAAA;QAEzE,OAAO,GAAG,EAAE;YACV,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;gBACnC,WAAW,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;oBACzB,MAAM,eAAe,CAAA;oBACrB,MAAM,KAAK,GAAG,MAAM,IAAA,eAAI,EAAC,YAAY,CAAC,CAAA;oBACtC,MAAM,aAAa,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAA;oBAC3C,MAAM,CAAC,KAAK,CACV,8DAA8D,EAC9D,aAAa,CACd,CAAA;oBACD,MAAM,cAAc,GAAG,MAAM,KAAK,CAAC,SAAS,EAAE;wBAC5C,MAAM,EAAE,KAAK;wBACb,OAAO,EAAE;4BACP,cAAc,EAAE,mBAAmB;4BACnC,kBAAkB,EAAE,MAAM;4BAC1B,gBAAgB,EAAE,aAAa;yBAChC;wBACD,IAAI,EAAE,IAAA,0BAAgB,EAAC,YAAY,CAAC;wBACpC,MAAM,EAAE,MAAM;qBACf,CAAC,CAAA;oBACF,IAAI,cAAc,CAAC,EAAE,EAAE,CAAC;wBACtB,WAAW,CAAC,MAAM,CAAC,KAAK,CACtB,qBAAqB,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,IAAI,CACzD,CAAA;oBACH,CAAC;yBAAM,CAAC;wBACN,MAAM,CAAC,KAAK,CACV,8BACE,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,MACrB,gBAAgB,cAAc,CAAC,MAAM,EAAE,CACxC,CAAA;wBACD,MAAM,CAAC,KAAK,CAAC,MAAM,cAAc,CAAC,IAAI,EAAE,CAAC,CAAA;oBAC3C,CAAC;oBACD,OAAO,EAAE,CAAA;gBACX,CAAC,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;QACJ,CAAC,CAAA;IACH,CAAC;CACF,CAAA;AAED;;;;;GAKG;AACH,SAAS,qBAAqB,CAAC,GAAW,EAAE,MAAgB;IAC1D,IAAI,CAAC,IAAA,8BAAa,EAAC,MAAM,CAAC,IAAI,IAAA,kBAAO,EAAC,GAAG,CAAC,EAAE,CAAC;QAC3C,OAAO,IAAA,oCAAwB,EAAC,GAAG,CAAC,CAAA;IACtC,CAAC;IACD,OAAO,GAAG,CAAA;AACZ,CAAC","sourcesContent":["import { Writable } from 'node:stream'\nimport { pipeline } from 'node:stream/promises'\nimport { stripVTControlCharacters } from 'node:util'\nimport { mkdtemp, stat } from 'node:fs/promises'\nimport path from 'node:path'\nimport { tmpdir } from 'node:os'\nimport { createReadStream, createWriteStream } from 'node:fs'\nimport { createGzip } from 'node:zlib'\nimport { supportsColor } from 'supports-color'\nimport hasAnsi from 'has-ansi'\nimport { InternalPlugin } from '../plugin'\nimport { IPublishConfig } from './types'\n\nconst DEFAULT_CUCUMBER_PUBLISH_URL = 'https://messages.cucumber.io/api/reports'\n\nexport const publishPlugin: InternalPlugin<IPublishConfig | false> = {\n  type: 'plugin',\n  coordinator: async ({ on, logger, options, environment }) => {\n    if (!options) {\n      return undefined\n    }\n    const { url = DEFAULT_CUCUMBER_PUBLISH_URL, token } = options\n    const headers: { [key: string]: string } = {}\n    if (token !== undefined) {\n      headers.Authorization = `Bearer ${token}`\n    }\n    const touchResponse = await fetch(url, { headers })\n    const banner = await touchResponse.text()\n\n    if (!touchResponse.ok) {\n      return () => {\n        if (touchResponse.status < 500) {\n          environment.stderr.write(\n            sanitisePublishOutput(banner, environment.stderr) + '\\n'\n          )\n        } else {\n          logger.error(\n            `Failed to publish report to ${new URL(url).origin} with status ${\n              touchResponse.status\n            }`\n          )\n          logger.debug(touchResponse)\n        }\n      }\n    }\n\n    const uploadUrl = touchResponse.headers.get('Location')\n    const tempDir = await mkdtemp(path.join(tmpdir(), `cucumber-js-publish-`))\n    const tempFilePath = path.join(tempDir, 'envelopes.jsonl.gz')\n    const writeStream = createGzip()\n    const finishedWriting = pipeline(\n      writeStream,\n      createWriteStream(tempFilePath)\n    )\n    on('message', (value) => writeStream.write(JSON.stringify(value) + '\\n'))\n\n    return () => {\n      return new Promise<void>((resolve) => {\n        writeStream.end(async () => {\n          await finishedWriting\n          const stats = await stat(tempFilePath)\n          const contentLength = stats.size.toString()\n          logger.debug(\n            'Uploading envelopes to Cucumber Reports with content length:',\n            contentLength\n          )\n          const uploadResponse = await fetch(uploadUrl, {\n            method: 'PUT',\n            headers: {\n              'Content-Type': 'application/jsonl',\n              'Content-Encoding': 'gzip',\n              'Content-Length': contentLength,\n            },\n            body: createReadStream(tempFilePath),\n            duplex: 'half',\n          })\n          if (uploadResponse.ok) {\n            environment.stderr.write(\n              sanitisePublishOutput(banner, environment.stderr) + '\\n'\n            )\n          } else {\n            logger.error(\n              `Failed to upload report to ${\n                new URL(uploadUrl).origin\n              } with status ${uploadResponse.status}`\n            )\n            logger.debug(await uploadResponse.text())\n          }\n          resolve()\n        })\n      })\n    }\n  },\n}\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 stripVTControlCharacters(raw)\n  }\n  return raw\n}\n"]}
+{"version":3,"file":"publish_plugin.js","sourceRoot":"","sources":["../../src/publish/publish_plugin.ts"],"names":[],"mappings":";;;;;;AACA,mDAA+C;AAC/C,yCAAoD;AACpD,+CAAgD;AAChD,0DAA4B;AAC5B,qCAAgC;AAChC,qCAA6D;AAC7D,yCAAsC;AACtC,mDAA8C;AAC9C,wDAA8B;AAG9B,MAAM,4BAA4B,GAAG,0CAA0C,CAAA;AAElE,QAAA,aAAa,GAAW;IACnC,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,EAAE,EAAE;QAC1D,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,SAAS,CAAA;QAClB,CAAC;QACD,MAAM,EAAE,GAAG,GAAG,4BAA4B,EAAE,KAAK,EAAE,GAAG,OAAO,CAAA;QAC7D,MAAM,OAAO,GAA8B,EAAE,CAAA;QAC7C,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,CAAC,aAAa,GAAG,UAAU,KAAK,EAAE,CAAA;QAC3C,CAAC;QACD,MAAM,aAAa,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,CAAC,CAAA;QACnD,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,IAAI,EAAE,CAAA;QAEzC,IAAI,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC;YACtB,OAAO,GAAG,EAAE;gBACV,IAAI,aAAa,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;oBAC/B,WAAW,CAAC,MAAM,CAAC,KAAK,CACtB,qBAAqB,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,IAAI,CACzD,CAAA;gBACH,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,KAAK,CACV,+BAA+B,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,gBAChD,aAAa,CAAC,MAChB,EAAE,CACH,CAAA;oBACD,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,CAAA;gBAC7B,CAAC;YACH,CAAC,CAAA;QACH,CAAC;QAED,MAAM,SAAS,GAAG,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;QACvD,MAAM,OAAO,GAAG,MAAM,IAAA,kBAAO,EAAC,mBAAI,CAAC,IAAI,CAAC,IAAA,gBAAM,GAAE,EAAE,sBAAsB,CAAC,CAAC,CAAA;QAC1E,MAAM,YAAY,GAAG,mBAAI,CAAC,IAAI,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAA;QAC7D,MAAM,WAAW,GAAG,IAAA,sBAAU,GAAE,CAAA;QAChC,MAAM,eAAe,GAAG,IAAA,mBAAQ,EAC9B,WAAW,EACX,IAAA,2BAAiB,EAAC,YAAY,CAAC,CAChC,CAAA;QACD,EAAE,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC,CAAA;QAEzE,OAAO,GAAG,EAAE;YACV,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;gBACnC,WAAW,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;oBACzB,MAAM,eAAe,CAAA;oBACrB,MAAM,KAAK,GAAG,MAAM,IAAA,eAAI,EAAC,YAAY,CAAC,CAAA;oBACtC,MAAM,aAAa,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAA;oBAC3C,MAAM,CAAC,KAAK,CACV,8DAA8D,EAC9D,aAAa,CACd,CAAA;oBACD,MAAM,cAAc,GAAG,MAAM,KAAK,CAAC,SAAS,EAAE;wBAC5C,MAAM,EAAE,KAAK;wBACb,OAAO,EAAE;4BACP,cAAc,EAAE,mBAAmB;4BACnC,kBAAkB,EAAE,MAAM;4BAC1B,gBAAgB,EAAE,aAAa;yBAChC;wBACD,IAAI,EAAE,IAAA,0BAAgB,EAAC,YAAY,CAAC;wBACpC,MAAM,EAAE,MAAM;qBACf,CAAC,CAAA;oBACF,IAAI,cAAc,CAAC,EAAE,EAAE,CAAC;wBACtB,WAAW,CAAC,MAAM,CAAC,KAAK,CACtB,qBAAqB,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,IAAI,CACzD,CAAA;oBACH,CAAC;yBAAM,CAAC;wBACN,MAAM,CAAC,KAAK,CACV,8BACE,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,MACrB,gBAAgB,cAAc,CAAC,MAAM,EAAE,CACxC,CAAA;wBACD,MAAM,CAAC,KAAK,CAAC,MAAM,cAAc,CAAC,IAAI,EAAE,CAAC,CAAA;oBAC3C,CAAC;oBACD,OAAO,EAAE,CAAA;gBACX,CAAC,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;QACJ,CAAC,CAAA;IACH,CAAC;CACF,CAAA;AAED;;;;;GAKG;AACH,SAAS,qBAAqB,CAAC,GAAW,EAAE,MAAgB;IAC1D,IAAI,CAAC,IAAA,8BAAa,EAAC,MAAM,CAAC,IAAI,IAAA,kBAAO,EAAC,GAAG,CAAC,EAAE,CAAC;QAC3C,OAAO,IAAA,oCAAwB,EAAC,GAAG,CAAC,CAAA;IACtC,CAAC;IACD,OAAO,GAAG,CAAA;AACZ,CAAC","sourcesContent":["import { Writable } from 'node:stream'\nimport { pipeline } from 'node:stream/promises'\nimport { stripVTControlCharacters } from 'node:util'\nimport { mkdtemp, stat } from 'node:fs/promises'\nimport path from 'node:path'\nimport { tmpdir } from 'node:os'\nimport { createReadStream, createWriteStream } from 'node:fs'\nimport { createGzip } from 'node:zlib'\nimport { supportsColor } from 'supports-color'\nimport hasAnsi from 'has-ansi'\nimport { Plugin } from '../plugin'\n\nconst DEFAULT_CUCUMBER_PUBLISH_URL = 'https://messages.cucumber.io/api/reports'\n\nexport const publishPlugin: Plugin = {\n  type: 'plugin',\n  coordinator: async ({ on, logger, options, environment }) => {\n    if (!options) {\n      return undefined\n    }\n    const { url = DEFAULT_CUCUMBER_PUBLISH_URL, token } = options\n    const headers: { [key: string]: string } = {}\n    if (token !== undefined) {\n      headers.Authorization = `Bearer ${token}`\n    }\n    const touchResponse = await fetch(url, { headers })\n    const banner = await touchResponse.text()\n\n    if (!touchResponse.ok) {\n      return () => {\n        if (touchResponse.status < 500) {\n          environment.stderr.write(\n            sanitisePublishOutput(banner, environment.stderr) + '\\n'\n          )\n        } else {\n          logger.error(\n            `Failed to publish report to ${new URL(url).origin} with status ${\n              touchResponse.status\n            }`\n          )\n          logger.debug(touchResponse)\n        }\n      }\n    }\n\n    const uploadUrl = touchResponse.headers.get('Location')\n    const tempDir = await mkdtemp(path.join(tmpdir(), `cucumber-js-publish-`))\n    const tempFilePath = path.join(tempDir, 'envelopes.jsonl.gz')\n    const writeStream = createGzip()\n    const finishedWriting = pipeline(\n      writeStream,\n      createWriteStream(tempFilePath)\n    )\n    on('message', (value) => writeStream.write(JSON.stringify(value) + '\\n'))\n\n    return () => {\n      return new Promise<void>((resolve) => {\n        writeStream.end(async () => {\n          await finishedWriting\n          const stats = await stat(tempFilePath)\n          const contentLength = stats.size.toString()\n          logger.debug(\n            'Uploading envelopes to Cucumber Reports with content length:',\n            contentLength\n          )\n          const uploadResponse = await fetch(uploadUrl, {\n            method: 'PUT',\n            headers: {\n              'Content-Type': 'application/jsonl',\n              'Content-Encoding': 'gzip',\n              'Content-Length': contentLength,\n            },\n            body: createReadStream(tempFilePath),\n            duplex: 'half',\n          })\n          if (uploadResponse.ok) {\n            environment.stderr.write(\n              sanitisePublishOutput(banner, environment.stderr) + '\\n'\n            )\n          } else {\n            logger.error(\n              `Failed to upload report to ${\n                new URL(uploadUrl).origin\n              } with status ${uploadResponse.status}`\n            )\n            logger.debug(await uploadResponse.text())\n          }\n          resolve()\n        })\n      })\n    }\n  },\n}\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 stripVTControlCharacters(raw)\n  }\n  return raw\n}\n"]}

package/lib/sharding/sharding_plugin.d.ts

@@ -1,3 +1,2 @@
-import { InternalPlugin } from '../plugin';
-import { ISourcesCoordinates } from '../api';
-export declare const shardingPlugin: InternalPlugin<ISourcesCoordinates>;
+import { Plugin } from '../plugin';
+export declare const shardingPlugin: Plugin;

package/lib/sharding/sharding_plugin.js

@@ -3,8 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.shardingPlugin = void 0;
 exports.shardingPlugin = {
     type: 'plugin',
-    coordinator: async ({ on, options }) => {
-        on('pickles:filter', async (allPickles) => {
+    coordinator: async ({ transform, options }) => {
+        transform('pickles:filter', async (allPickles) => {
             if (!options.shard) {
                 return allPickles;
             }

package/lib/sharding/sharding_plugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"sharding_plugin.js","sourceRoot":"","sources":["../../src/sharding/sharding_plugin.ts"],"names":[],"mappings":";;;AAGa,QAAA,cAAc,GAAwC;IACjE,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;QACrC,EAAE,CAAC,gBAAgB,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE;YACxC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;gBACnB,OAAO,UAAU,CAAA;YACnB,CAAC;YAED,MAAM,CAAC,aAAa,EAAE,aAAa,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YAC/D,MAAM,UAAU,GAAG,QAAQ,CAAC,aAAa,EAAE,EAAE,CAAC,GAAG,CAAC,CAAA;YAClD,MAAM,UAAU,GAAG,QAAQ,CAAC,aAAa,EAAE,EAAE,CAAC,CAAA;YAE9C,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,UAAU,KAAK,UAAU,CAAC,CAAA;QACnE,CAAC,CAAC,CAAA;IACJ,CAAC;CACF,CAAA","sourcesContent":["import { InternalPlugin } from '../plugin'\nimport { ISourcesCoordinates } from '../api'\n\nexport const shardingPlugin: InternalPlugin<ISourcesCoordinates> = {\n  type: 'plugin',\n  coordinator: async ({ on, options }) => {\n    on('pickles:filter', async (allPickles) => {\n      if (!options.shard) {\n        return allPickles\n      }\n\n      const [shardIndexStr, shardTotalStr] = options.shard.split('/')\n      const shardIndex = parseInt(shardIndexStr, 10) - 1\n      const shardTotal = parseInt(shardTotalStr, 10)\n\n      return allPickles.filter((_, i) => i % shardTotal === shardIndex)\n    })\n  },\n}\n"]}
+{"version":3,"file":"sharding_plugin.js","sourceRoot":"","sources":["../../src/sharding/sharding_plugin.ts"],"names":[],"mappings":";;;AAEa,QAAA,cAAc,GAAW;IACpC,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,EAAE;QAC5C,SAAS,CAAC,gBAAgB,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE;YAC/C,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;gBACnB,OAAO,UAAU,CAAA;YACnB,CAAC;YAED,MAAM,CAAC,aAAa,EAAE,aAAa,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YAC/D,MAAM,UAAU,GAAG,QAAQ,CAAC,aAAa,EAAE,EAAE,CAAC,GAAG,CAAC,CAAA;YAClD,MAAM,UAAU,GAAG,QAAQ,CAAC,aAAa,EAAE,EAAE,CAAC,CAAA;YAE9C,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,UAAU,KAAK,UAAU,CAAC,CAAA;QACnE,CAAC,CAAC,CAAA;IACJ,CAAC;CACF,CAAA","sourcesContent":["import { Plugin } from '../plugin'\n\nexport const shardingPlugin: Plugin = {\n  type: 'plugin',\n  coordinator: async ({ transform, options }) => {\n    transform('pickles:filter', async (allPickles) => {\n      if (!options.shard) {\n        return allPickles\n      }\n\n      const [shardIndexStr, shardTotalStr] = options.shard.split('/')\n      const shardIndex = parseInt(shardIndexStr, 10) - 1\n      const shardTotal = parseInt(shardTotalStr, 10)\n\n      return allPickles.filter((_, i) => i % shardTotal === shardIndex)\n    })\n  },\n}\n"]}

package/lib/tsconfig.node.tsbuildinfo

@@ -1 +1 @@
-{"root":["../src/filter_stack_trace.ts","../src/index.ts","../src/pickle_filter.ts","../src/step_arguments.ts","../src/time.ts","../src/try_require.ts","../src/uncaught_exception_manager.ts","../src/user_code_runner.ts","../src/value_checker.ts","../src/version.ts","../src/api/convert_configuration.ts","../src/api/formatters.ts","../src/api/gherkin.ts","../src/api/index.ts","../src/api/load_configuration.ts","../src/api/load_sources.ts","../src/api/load_support.ts","../src/api/plugins.ts","../src/api/run_cucumber.ts","../src/api/support.ts","../src/api/test_helpers.ts","../src/api/types.ts","../src/assemble/assemble_test_cases.ts","../src/assemble/index.ts","../src/assemble/types.ts","../src/cli/helpers.ts","../src/cli/i18n.ts","../src/cli/index.ts","../src/cli/install_validator.ts","../src/cli/run.ts","../src/cli/validate_node_engine_version.ts","../src/configuration/argv_parser.ts","../src/configuration/check_schema.ts","../src/configuration/default_configuration.ts","../src/configuration/from_file.ts","../src/configuration/helpers.ts","../src/configuration/index.ts","../src/configuration/locate_file.ts","../src/configuration/merge_configurations.ts","../src/configuration/parse_configuration.ts","../src/configuration/split_format_descriptor.ts","../src/configuration/types.ts","../src/configuration/validate_configuration.ts","../src/environment/console_logger.ts","../src/environment/index.ts","../src/environment/make_environment.ts","../src/environment/types.ts","../src/filter/filter_plugin.ts","../src/filter/index.ts","../src/filter/types.ts","../src/formatter/builder.ts","../src/formatter/create_stream.ts","../src/formatter/find_class_or_plugin.ts","../src/formatter/get_color_fns.ts","../src/formatter/import_code.ts","../src/formatter/index.ts","../src/formatter/json_formatter.ts","../src/formatter/progress_bar_formatter.ts","../src/formatter/progress_formatter.ts","../src/formatter/rerun_formatter.ts","../src/formatter/resolve_implementation.ts","../src/formatter/snippets_formatter.ts","../src/formatter/summary_formatter.ts","../src/formatter/usage_formatter.ts","../src/formatter/usage_json_formatter.ts","../src/formatter/builtin/html.ts","../src/formatter/builtin/index.ts","../src/formatter/builtin/message.ts","../src/formatter/helpers/duration_helpers.ts","../src/formatter/helpers/event_data_collector.ts","../src/formatter/helpers/formatters.ts","../src/formatter/helpers/gherkin_document_parser.ts","../src/formatter/helpers/index.ts","../src/formatter/helpers/issue_helpers.ts","../src/formatter/helpers/keyword_type.ts","../src/formatter/helpers/location_helpers.ts","../src/formatter/helpers/pickle_parser.ts","../src/formatter/helpers/step_argument_formatter.ts","../src/formatter/helpers/summary_helpers.ts","../src/formatter/helpers/test_case_attempt_formatter.ts","../src/formatter/helpers/test_case_attempt_parser.ts","../src/formatter/helpers/usage_helpers/index.ts","../src/formatter/step_definition_snippet_builder/index.ts","../src/formatter/step_definition_snippet_builder/javascript_snippet_syntax.ts","../src/formatter/step_definition_snippet_builder/snippet_syntax.ts","../src/models/data_table.ts","../src/models/definition.ts","../src/models/gherkin_step_keyword.ts","../src/models/step_definition.ts","../src/models/test_case_hook_definition.ts","../src/models/test_run_hook_definition.ts","../src/models/test_step_hook_definition.ts","../src/paths/index.ts","../src/paths/paths.ts","../src/paths/types.ts","../src/plugin/events.ts","../src/plugin/index.ts","../src/plugin/plugin_manager.ts","../src/plugin/types.ts","../src/publish/index.ts","../src/publish/publish_plugin.ts","../src/publish/types.ts","../src/runtime/coordinator.ts","../src/runtime/format_error.ts","../src/runtime/helpers.ts","../src/runtime/index.ts","../src/runtime/make_runtime.ts","../src/runtime/make_suggestion.ts","../src/runtime/step_runner.ts","../src/runtime/stopwatch.ts","../src/runtime/test_case_runner.ts","../src/runtime/types.ts","../src/runtime/worker.ts","../src/runtime/attachment_manager/index.ts","../src/runtime/parallel/adapter.ts","../src/runtime/parallel/run_worker.ts","../src/runtime/parallel/types.ts","../src/runtime/parallel/worker.ts","../src/runtime/scope/index.ts","../src/runtime/scope/make_proxy.ts","../src/runtime/scope/test_case_scope.ts","../src/runtime/scope/test_run_scope.ts","../src/runtime/serial/adapter.ts","../src/sharding/index.ts","../src/sharding/sharding_plugin.ts","../src/support_code_library_builder/build_parameter_type.ts","../src/support_code_library_builder/context.ts","../src/support_code_library_builder/get_definition_line_and_uri.ts","../src/support_code_library_builder/index.ts","../src/support_code_library_builder/parallel_can_assign_helpers.ts","../src/support_code_library_builder/sourced_parameter_type_registry.ts","../src/support_code_library_builder/types.ts","../src/support_code_library_builder/validate_arguments.ts","../src/support_code_library_builder/world.ts","../src/types/index.ts","../src/types/assertion-error-formatter/index.d.ts","../src/types/is-generator/index.d.ts","../src/types/knuth-shuffle-seeded/index.d.ts","../src/types/stack-chain/index.d.ts","../src/types/supports-color/index.d.ts"],"version":"5.8.3"}
+{"root":["../src/filter_stack_trace.ts","../src/index.ts","../src/pickle_filter.ts","../src/step_arguments.ts","../src/time.ts","../src/try_require.ts","../src/uncaught_exception_manager.ts","../src/user_code_runner.ts","../src/value_checker.ts","../src/version.ts","../src/api/convert_configuration.ts","../src/api/formatters.ts","../src/api/gherkin.ts","../src/api/index.ts","../src/api/load_configuration.ts","../src/api/load_sources.ts","../src/api/load_support.ts","../src/api/plugins.ts","../src/api/run_cucumber.ts","../src/api/support.ts","../src/api/test_helpers.ts","../src/api/types.ts","../src/assemble/assemble_test_cases.ts","../src/assemble/index.ts","../src/assemble/types.ts","../src/cli/helpers.ts","../src/cli/i18n.ts","../src/cli/index.ts","../src/cli/install_validator.ts","../src/cli/run.ts","../src/cli/validate_node_engine_version.ts","../src/configuration/argv_parser.ts","../src/configuration/check_schema.ts","../src/configuration/default_configuration.ts","../src/configuration/from_file.ts","../src/configuration/helpers.ts","../src/configuration/index.ts","../src/configuration/locate_file.ts","../src/configuration/merge_configurations.ts","../src/configuration/parse_configuration.ts","../src/configuration/split_format_descriptor.ts","../src/configuration/types.ts","../src/configuration/validate_configuration.ts","../src/environment/console_logger.ts","../src/environment/index.ts","../src/environment/make_environment.ts","../src/environment/types.ts","../src/filter/filter_plugin.ts","../src/filter/index.ts","../src/filter/types.ts","../src/formatter/builder.ts","../src/formatter/create_stream.ts","../src/formatter/find_class_or_plugin.ts","../src/formatter/get_color_fns.ts","../src/formatter/import_code.ts","../src/formatter/index.ts","../src/formatter/json_formatter.ts","../src/formatter/progress_bar_formatter.ts","../src/formatter/progress_formatter.ts","../src/formatter/rerun_formatter.ts","../src/formatter/resolve_implementation.ts","../src/formatter/snippets_formatter.ts","../src/formatter/summary_formatter.ts","../src/formatter/usage_formatter.ts","../src/formatter/usage_json_formatter.ts","../src/formatter/builtin/html.ts","../src/formatter/builtin/index.ts","../src/formatter/builtin/message.ts","../src/formatter/helpers/duration_helpers.ts","../src/formatter/helpers/event_data_collector.ts","../src/formatter/helpers/formatters.ts","../src/formatter/helpers/gherkin_document_parser.ts","../src/formatter/helpers/index.ts","../src/formatter/helpers/issue_helpers.ts","../src/formatter/helpers/keyword_type.ts","../src/formatter/helpers/location_helpers.ts","../src/formatter/helpers/pickle_parser.ts","../src/formatter/helpers/step_argument_formatter.ts","../src/formatter/helpers/summary_helpers.ts","../src/formatter/helpers/test_case_attempt_formatter.ts","../src/formatter/helpers/test_case_attempt_parser.ts","../src/formatter/helpers/usage_helpers/index.ts","../src/formatter/step_definition_snippet_builder/index.ts","../src/formatter/step_definition_snippet_builder/javascript_snippet_syntax.ts","../src/formatter/step_definition_snippet_builder/snippet_syntax.ts","../src/models/data_table.ts","../src/models/definition.ts","../src/models/gherkin_step_keyword.ts","../src/models/step_definition.ts","../src/models/test_case_hook_definition.ts","../src/models/test_run_hook_definition.ts","../src/models/test_step_hook_definition.ts","../src/paths/index.ts","../src/paths/paths.ts","../src/paths/types.ts","../src/plugin/index.ts","../src/plugin/plugin_manager.ts","../src/plugin/types.ts","../src/publish/index.ts","../src/publish/publish_plugin.ts","../src/publish/types.ts","../src/runtime/coordinator.ts","../src/runtime/format_error.ts","../src/runtime/helpers.ts","../src/runtime/index.ts","../src/runtime/make_runtime.ts","../src/runtime/make_suggestion.ts","../src/runtime/step_runner.ts","../src/runtime/stopwatch.ts","../src/runtime/test_case_runner.ts","../src/runtime/types.ts","../src/runtime/worker.ts","../src/runtime/attachment_manager/index.ts","../src/runtime/parallel/adapter.ts","../src/runtime/parallel/run_worker.ts","../src/runtime/parallel/types.ts","../src/runtime/parallel/worker.ts","../src/runtime/scope/index.ts","../src/runtime/scope/make_proxy.ts","../src/runtime/scope/test_case_scope.ts","../src/runtime/scope/test_run_scope.ts","../src/runtime/serial/adapter.ts","../src/sharding/index.ts","../src/sharding/sharding_plugin.ts","../src/support_code_library_builder/build_parameter_type.ts","../src/support_code_library_builder/context.ts","../src/support_code_library_builder/get_definition_line_and_uri.ts","../src/support_code_library_builder/index.ts","../src/support_code_library_builder/parallel_can_assign_helpers.ts","../src/support_code_library_builder/sourced_parameter_type_registry.ts","../src/support_code_library_builder/types.ts","../src/support_code_library_builder/validate_arguments.ts","../src/support_code_library_builder/world.ts","../src/types/index.ts","../src/types/assertion-error-formatter/index.d.ts","../src/types/is-generator/index.d.ts","../src/types/knuth-shuffle-seeded/index.d.ts","../src/types/stack-chain/index.d.ts","../src/types/supports-color/index.d.ts"],"version":"5.8.3"}

package/lib/version.d.ts

@@ -1 +1 @@
-export declare const version = "12.4.0";
+export declare const version = "12.6.0";