Avoid importing anything but types from @cucumber/messages

.. in the browser bundle, that is. Due to updated transitive dependencies and deduping, the build + browserify examples suddenly fail to due to error parsing nullish coalescing assignment operators [1]. [1] browserify/detective#88
badeball · Feb 9, 2025 · 510ed11 · 510ed11
1 parent c3f823a
commit 510ed11
Show file tree

Hide file tree

Showing 16 changed files with 82 additions and 35 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 All notable changes to this project will be documented in this file.
 
+## Unreleased
+
+- Import types-only from `@cucumber/messages`, fixes [#1273](https://github.com/badeball/cypress-cucumber-preprocessor/issues/1273).
+
 ## v22.0.0
 
 Breaking changes:

diff --git a/lib/bin/cucumber-json-formatter.ts b/lib/bin/cucumber-json-formatter.ts
@@ -6,7 +6,7 @@ import { Writable } from "stream";
 
 import { NdjsonToMessageStream } from "@cucumber/message-streams";
 
-import messages from "@cucumber/messages";
+import type * as messages from "@cucumber/messages";
 
 import { createJsonFormatter } from "../helpers/formatters";
 

diff --git a/lib/browser-runtime.ts b/lib/browser-runtime.ts
@@ -1,4 +1,4 @@
-import * as messages from "@cucumber/messages";
+import type * as messages from "@cucumber/messages";
 
 import parse from "@cucumber/tag-expressions";
 
@@ -72,6 +72,12 @@ import {
 } from "./helpers/options";
 import { Position } from "./helpers/source-map";
 
+import {
+  SourceMediaType,
+  StepDefinitionPatternType,
+  TestStepResultStatus,
+} from "./helpers/messages-enums";
+
 type Node = ReturnType<typeof parse>;
 
 type TestStepIds = Map<string, Map<string, string>>;
@@ -268,7 +274,7 @@ function emitSkippedPickle(
       testStepId,
       testCaseStartedId,
       testStepResult: {
-        status: messages.TestStepResultStatus.SKIPPED,
+        status: TestStepResultStatus.SKIPPED,
         duration: {
           seconds: 0,
           nanos: 0,
@@ -596,7 +602,7 @@ function createPickle(context: CompositionContext, pickle: messages.Pickle) {
             testStepId,
             testCaseStartedId,
             testStepResult: {
-              status: messages.TestStepResultStatus.PENDING,
+              status: TestStepResultStatus.PENDING,
               duration: duration(start, end),
             },
             timestamp: end,
@@ -606,7 +612,7 @@ function createPickle(context: CompositionContext, pickle: messages.Pickle) {
             testStepId,
             testCaseStartedId,
             testStepResult: {
-              status: messages.TestStepResultStatus.SKIPPED,
+              status: TestStepResultStatus.SKIPPED,
               duration: duration(start, end),
             },
             timestamp: end,
@@ -637,7 +643,7 @@ function createPickle(context: CompositionContext, pickle: messages.Pickle) {
             testStepId,
             testCaseStartedId,
             testStepResult: {
-              status: messages.TestStepResultStatus.SKIPPED,
+              status: TestStepResultStatus.SKIPPED,
               duration: {
                 seconds: 0,
                 nanos: 0,
@@ -657,7 +663,7 @@ function createPickle(context: CompositionContext, pickle: messages.Pickle) {
           testStepId,
           testCaseStartedId,
           testStepResult: {
-            status: messages.TestStepResultStatus.PASSED,
+            status: TestStepResultStatus.PASSED,
             duration: duration(start, end),
           },
           timestamp: end,
@@ -959,7 +965,7 @@ function afterEachHandler(this: Mocha.Context, context: CompositionContext) {
             testStepId,
             testCaseStartedId,
             testStepResult: {
-              status: messages.TestStepResultStatus.UNDEFINED,
+              status: TestStepResultStatus.UNDEFINED,
               duration: {
                 seconds: 0,
                 nanos: 0,
@@ -972,8 +978,8 @@ function afterEachHandler(this: Mocha.Context, context: CompositionContext) {
             testCaseStartedId,
             testStepResult: {
               status: error.includes("Multiple matching step definitions for")
-                ? messages.TestStepResultStatus.AMBIGUOUS
-                : messages.TestStepResultStatus.FAILED,
+                ? TestStepResultStatus.AMBIGUOUS
+                : TestStepResultStatus.FAILED,
               message: error,
               duration: duration(
                 assertAndReturn(
@@ -1010,7 +1016,7 @@ function afterEachHandler(this: Mocha.Context, context: CompositionContext) {
           testStepId,
           testCaseStartedId,
           testStepResult: {
-            status: messages.TestStepResultStatus.SKIPPED,
+            status: TestStepResultStatus.SKIPPED,
             duration: {
               seconds: 0,
               nanos: 0,
@@ -1041,7 +1047,7 @@ function afterEachHandler(this: Mocha.Context, context: CompositionContext) {
           testStepId,
           testCaseStartedId,
           testStepResult: {
-            status: messages.TestStepResultStatus.SKIPPED,
+            status: TestStepResultStatus.SKIPPED,
             duration: duration(currentStepStartedAt, endTimestamp),
           },
           timestamp: endTimestamp,
@@ -1070,7 +1076,7 @@ function afterEachHandler(this: Mocha.Context, context: CompositionContext) {
           testStepId,
           testCaseStartedId,
           testStepResult: {
-            status: messages.TestStepResultStatus.SKIPPED,
+            status: TestStepResultStatus.SKIPPED,
             duration: {
               seconds: 0,
               nanos: 0,
@@ -1102,7 +1108,7 @@ function afterEachHandler(this: Mocha.Context, context: CompositionContext) {
           testStepId,
           testCaseStartedId,
           testStepResult: {
-            status: messages.TestStepResultStatus.UNKNOWN,
+            status: TestStepResultStatus.UNKNOWN,
             duration: {
               seconds: 0,
               nanos: 0,
@@ -1199,8 +1205,8 @@ export default function createTests(
     registry.stepDefinitions.map((stepDefinition) => {
       const type: messages.StepDefinitionPatternType =
         stepDefinition.expression instanceof RegularExpression
-          ? messages.StepDefinitionPatternType.REGULAR_EXPRESSION
-          : messages.StepDefinitionPatternType.CUCUMBER_EXPRESSION;
+          ? StepDefinitionPatternType.REGULAR_EXPRESSION
+          : StepDefinitionPatternType.CUCUMBER_EXPRESSION;
 
       return {
         id: stepDefinition.id,
@@ -1276,7 +1282,7 @@ export default function createTests(
         gherkinDocument.uri,
         "Expected gherkin document to have URI",
       ),
-      mediaType: messages.SourceMediaType.TEXT_X_CUCUMBER_GHERKIN_PLAIN,
+      mediaType: SourceMediaType.TEXT_X_CUCUMBER_GHERKIN_PLAIN,
     },
   });
 

diff --git a/lib/cypress-task-definitions.ts b/lib/cypress-task-definitions.ts
@@ -1,4 +1,4 @@
-import messages from "@cucumber/messages";
+import type * as messages from "@cucumber/messages";
 
 export const TASK_SPEC_ENVELOPES =
   "cypress-cucumber-preprocessor:spec-envelopes";

diff --git a/lib/data_table.test.ts b/lib/data_table.test.ts
@@ -1,6 +1,6 @@
 import assert from "assert";
 
-import messages from "@cucumber/messages";
+import * as messages from "@cucumber/messages";
 
 import DataTable from "./data_table";
 

diff --git a/lib/data_table.ts b/lib/data_table.ts
@@ -1,4 +1,4 @@
-import messages from "@cucumber/messages";
+import type * as messages from "@cucumber/messages";
 
 import { assert, assertAndReturn } from "./helpers/assertions";
 

diff --git a/lib/entrypoint-browser.ts b/lib/entrypoint-browser.ts
@@ -1,4 +1,4 @@
-import { AttachmentContentEncoding, Pickle } from "@cucumber/messages";
+import type * as messages from "@cucumber/messages";
 
 import parse from "@cucumber/tag-expressions";
 
@@ -42,6 +42,8 @@ import {
 
 import { AddOptions } from "./add-cucumber-preprocessor-plugin";
 
+import { AttachmentContentEncoding } from "./helpers/messages-enums";
+
 function defineStep<T extends unknown[], C extends Mocha.Context>(
   description: string | RegExp,
   implementation: IStepDefinitionBody<T, C>,
@@ -162,7 +164,7 @@ function defineAfterAll(
 function createStringAttachment(
   data: string,
   mediaType: string,
-  encoding: AttachmentContentEncoding,
+  encoding: messages.AttachmentContentEncoding,
 ) {
   const taskData: ITaskCreateStringAttachment = {
     data,
@@ -215,7 +217,7 @@ const NOT_FEATURE_ERROR =
   "Expected to find internal properties, but didn't. This is likely because you're calling doesFeatureMatch() in a non-feature spec. Use doesFeatureMatch() in combination with isFeature() if you have both feature and non-feature specs";
 
 function doesFeatureMatch(expression: string) {
-  let pickle: Pickle;
+  let pickle: messages.Pickle;
 
   try {
     pickle = retrieveInternalSpecProperties().pickle;

diff --git a/lib/helpers/ast.ts b/lib/helpers/ast.ts
@@ -1,4 +1,4 @@
-import messages from "@cucumber/messages";
+import type * as messages from "@cucumber/messages";
 
 import { assertAndReturn } from "./assertions";
 

diff --git a/lib/helpers/formatters.ts b/lib/helpers/formatters.ts
@@ -11,7 +11,7 @@ import {
   UsageFormatter,
 } from "@cucumber/cucumber";
 
-import messages from "@cucumber/messages";
+import type * as messages from "@cucumber/messages";
 
 import chalk from "chalk";
 

diff --git a/lib/helpers/merge.ts b/lib/helpers/merge.ts
@@ -1,6 +1,6 @@
 import fs from "fs/promises";
 
-import * as messages from "@cucumber/messages";
+import type * as messages from "@cucumber/messages";
 
 import { notNull } from "./type-guards";
 

diff --git a/lib/helpers/messages-enums.ts b/lib/helpers/messages-enums.ts
@@ -0,0 +1,31 @@
+export enum PickleStepType {
+  UNKNOWN = "Unknown",
+  CONTEXT = "Context",
+  ACTION = "Action",
+  OUTCOME = "Outcome",
+}
+
+export enum AttachmentContentEncoding {
+  IDENTITY = "IDENTITY",
+  BASE64 = "BASE64",
+}
+
+export enum StepDefinitionPatternType {
+  CUCUMBER_EXPRESSION = "CUCUMBER_EXPRESSION",
+  REGULAR_EXPRESSION = "REGULAR_EXPRESSION",
+}
+
+export enum TestStepResultStatus {
+  UNKNOWN = "UNKNOWN",
+  PASSED = "PASSED",
+  SKIPPED = "SKIPPED",
+  PENDING = "PENDING",
+  UNDEFINED = "UNDEFINED",
+  AMBIGUOUS = "AMBIGUOUS",
+  FAILED = "FAILED",
+}
+
+export enum SourceMediaType {
+  TEXT_X_CUCUMBER_GHERKIN_PLAIN = "text/x.cucumber.gherkin+plain",
+  TEXT_X_CUCUMBER_GHERKIN_MARKDOWN = "text/x.cucumber.gherkin+markdown",
+}
diff --git a/lib/helpers/messages.ts b/lib/helpers/messages.ts
@@ -1,4 +1,4 @@
-import * as messages from "@cucumber/messages";
+import type * as messages from "@cucumber/messages";
 
 export type StrictTimestamp = {
   seconds: number;

diff --git a/lib/helpers/options.ts b/lib/helpers/options.ts
@@ -1,4 +1,4 @@
-import * as messages from "@cucumber/messages";
+import type * as messages from "@cucumber/messages";
 
 import { collectTagNames } from "./ast";
 

diff --git a/lib/helpers/snippets.ts b/lib/helpers/snippets.ts
@@ -1,6 +1,8 @@
 import { GeneratedExpression } from "@cucumber/cucumber-expressions";
 
-import * as messages from "@cucumber/messages";
+import type * as messages from "@cucumber/messages";
+
+import { PickleStepType } from "./messages-enums";
 
 const TEMPLATE = `
 [function]("[definition]", function ([arguments]) {
@@ -10,14 +12,16 @@ const TEMPLATE = `
 
 export function getFunctionName(type: messages.PickleStepType) {
   switch (type) {
-    case messages.PickleStepType.CONTEXT:
+    case PickleStepType.CONTEXT:
       return "Given";
-    case messages.PickleStepType.ACTION:
+    case PickleStepType.ACTION:
       return "When";
-    case messages.PickleStepType.OUTCOME:
+    case PickleStepType.OUTCOME:
       return "Then";
-    case messages.PickleStepType.UNKNOWN:
+    case PickleStepType.UNKNOWN:
       return "Given";
+    default:
+      throw "Unknown PickleStepType: " + type;
   }
 }
 

diff --git a/lib/public-member-types.ts b/lib/public-member-types.ts
@@ -1,4 +1,4 @@
-import * as messages from "@cucumber/messages";
+import type * as messages from "@cucumber/messages";
 
 export interface IParameterTypeDefinition<T, C extends Mocha.Context> {
   name: string;

diff --git a/lib/registry.ts b/lib/registry.ts
@@ -8,7 +8,7 @@ import {
 
 import parse from "@cucumber/tag-expressions";
 
-import { IdGenerator } from "@cucumber/messages";
+import type { IdGenerator } from "@cucumber/messages";
 
 import { assertAndReturn } from "./helpers/assertions";