include source reference on parameter type message

CHANGELOG.md

@@ -10,6 +10,7 @@ Please see [CONTRIBUTING.md](./CONTRIBUTING.md) on how to contribute to Cucumber
 ## [Unreleased]
 ### Added
 - New option for JUnit test suite name to be passed in `formatOptions` ([#2265](https://github.com/cucumber/cucumber-js/issues/2265))
+- Include source reference in emitted messages for parameter types ([#2287](https://github.com/cucumber/cucumber-js/pull/2287))
 
 ## [9.1.2] - 2023-05-07
 ### Changed

package.json

@@ -207,14 +207,14 @@
     "node": "14 || 16 || 18 || 19"
   },
   "dependencies": {
-    "@cucumber/ci-environment": "9.1.0",
-    "@cucumber/cucumber-expressions": "16.1.1",
-    "@cucumber/gherkin": "26.0.3",
+    "@cucumber/ci-environment": "9.2.0",
+    "@cucumber/cucumber-expressions": "16.1.2",
+    "@cucumber/gherkin": "26.2.0",
     "@cucumber/gherkin-streams": "5.0.1",
     "@cucumber/gherkin-utils": "8.0.2",
-    "@cucumber/html-formatter": "20.2.1",
+    "@cucumber/html-formatter": "20.3.0",
     "@cucumber/message-streams": "4.0.1",
-    "@cucumber/messages": "21.0.1",
+    "@cucumber/messages": "22.0.0",
     "@cucumber/tag-expressions": "5.0.1",
     "assertion-error-formatter": "^3.0.0",
     "capital-case": "^1.0.4",
@@ -249,7 +249,7 @@
     "yup": "^0.32.11"
   },
   "devDependencies": {
-    "@cucumber/compatibility-kit": "11.2.0",
+    "@cucumber/compatibility-kit": "11.3.0",
     "@cucumber/query": "12.0.1",
     "@microsoft/api-documenter": "7.19.27",
     "@microsoft/api-extractor": "7.33.7",

src/cli/helpers.ts

@@ -13,9 +13,9 @@ import { ISupportCodeLibrary } from '../support_code_library_builder/types'
 import TestCaseHookDefinition from '../models/test_case_hook_definition'
 import TestRunHookDefinition from '../models/test_run_hook_definition'
 import { PickleOrder } from '../models/pickle_order'
-import { builtinParameterTypes } from '../support_code_library_builder'
 import { version } from '../version'
 import { ILogger } from '../logger'
+import { ILineAndUri } from '../types'
 
 interface IParseGherkinMessageStreamRequest {
   cwd?: string
@@ -119,23 +119,33 @@ export async function emitMetaMessage(
   })
 }
 
+const makeSourceReference = (source: ILineAndUri) => ({
+  uri: source.uri,
+  location: {
+    line: source.line,
+  },
+})
+
 function emitParameterTypes(
   supportCodeLibrary: ISupportCodeLibrary,
   eventBroadcaster: EventEmitter,
   newId: IdGenerator.NewId
 ): void {
   for (const parameterType of supportCodeLibrary.parameterTypeRegistry
     .parameterTypes) {
-    if (builtinParameterTypes.includes(parameterType.name)) {
+    if (parameterType.builtin) {
       continue
     }
+    const source =
+      supportCodeLibrary.parameterTypeRegistry.lookupSource(parameterType)
     const envelope: messages.Envelope = {
       parameterType: {
         id: newId(),
         name: parameterType.name,
         preferForRegularExpressionMatch: parameterType.preferForRegexpMatch,
         regularExpressions: parameterType.regexpStrings,
         useForSnippets: parameterType.useForSnippets,
+        sourceReference: makeSourceReference(source),
       },
     }
     eventBroadcaster.emit('envelope', envelope)
@@ -169,12 +179,7 @@ function emitStepDefinitions(
               ? messages.StepDefinitionPatternType.CUCUMBER_EXPRESSION
               : messages.StepDefinitionPatternType.REGULAR_EXPRESSION,
         },
-        sourceReference: {
-          uri: stepDefinition.uri,
-          location: {
-            line: stepDefinition.line,
-          },
-        },
+        sourceReference: makeSourceReference(stepDefinition),
       },
     }
     eventBroadcaster.emit('envelope', envelope)
@@ -196,12 +201,7 @@ function emitTestCaseHooks(
           id: testCaseHookDefinition.id,
           name: testCaseHookDefinition.name,
           tagExpression: testCaseHookDefinition.tagExpression,
-          sourceReference: {
-            uri: testCaseHookDefinition.uri,
-            location: {
-              line: testCaseHookDefinition.line,
-            },
-          },
+          sourceReference: makeSourceReference(testCaseHookDefinition),
         },
       }
       eventBroadcaster.emit('envelope', envelope)
@@ -221,12 +221,7 @@ function emitTestRunHooks(
       const envelope: messages.Envelope = {
         hook: {
           id: testRunHookDefinition.id,
-          sourceReference: {
-            uri: testRunHookDefinition.uri,
-            location: {
-              line: testRunHookDefinition.line,
-            },
-          },
+          sourceReference: makeSourceReference(testRunHookDefinition),
         },
       }
       eventBroadcaster.emit('envelope', envelope)

src/cli/helpers_spec.ts

@@ -16,13 +16,13 @@ import StepDefinition from '../models/step_definition'
 import {
   CucumberExpression,
   ParameterType,
-  ParameterTypeRegistry,
   RegularExpression,
 } from '@cucumber/cucumber-expressions'
 import { ISupportCodeLibrary } from '../support_code_library_builder/types'
 import TestCaseHookDefinition from '../models/test_case_hook_definition'
 import TestRunHookDefinition from '../models/test_run_hook_definition'
 import { PickleOrder } from '../models/pickle_order'
+import { SourcedParameterTypeRegistry } from '../support_code_library_builder/sourced_parameter_type_registry'
 
 const noopFunction = (): void => {
   // no code
@@ -79,7 +79,7 @@ function testEmitSupportCodeMessages(
         afterTestCaseHookDefinitions: [],
         afterTestStepHookDefinitions: [],
         defaultTimeout: 0,
-        parameterTypeRegistry: new ParameterTypeRegistry(),
+        parameterTypeRegistry: new SourcedParameterTypeRegistry(),
         undefinedParameterTypes: [],
         World: null,
         parallelCanAssign: () => true,
@@ -105,16 +105,20 @@ describe('helpers', () => {
   })
   describe('emitSupportCodeMessages', () => {
     it('emits messages for parameter types', () => {
-      const parameterTypeRegistry = new ParameterTypeRegistry()
-      parameterTypeRegistry.defineParameterType(
+      const parameterTypeRegistry = new SourcedParameterTypeRegistry()
+      parameterTypeRegistry.defineSourcedParameterType(
         new ParameterType<string>(
           'flight',
           ['([A-Z]{3})-([A-Z]{3})'],
           null,
           () => 'argh',
           true,
           false
-        )
+        ),
+        {
+          line: 4,
+          uri: 'features/support/parameter-types.js',
+        }
       )
 
       const envelopes = testEmitSupportCodeMessages({
@@ -129,6 +133,12 @@ describe('helpers', () => {
             preferForRegularExpressionMatch: false,
             regularExpressions: ['([A-Z]{3})-([A-Z]{3})'],
             useForSnippets: true,
+            sourceReference: {
+              uri: 'features/support/parameter-types.js',
+              location: {
+                line: 4,
+              },
+            },
           },
         },
       ]
@@ -149,7 +159,7 @@ describe('helpers', () => {
             pattern: 'I have {int} cukes in my belly',
             expression: new CucumberExpression(
               'I have {int} cukes in my belly',
-              new ParameterTypeRegistry()
+              new SourcedParameterTypeRegistry()
             ),
           }),
         ],
@@ -188,7 +198,7 @@ describe('helpers', () => {
             pattern: /I have (\d+) cukes in my belly/,
             expression: new RegularExpression(
               /I have (\d+) cukes in my belly/,
-              new ParameterTypeRegistry()
+              new SourcedParameterTypeRegistry()
             ),
           }),
         ],

src/support_code_library_builder/index.ts

@@ -12,7 +12,6 @@ import arity from 'util-arity'
 
 import {
   CucumberExpression,
-  ParameterTypeRegistry,
   RegularExpression,
 } from '@cucumber/cucumber-expressions'
 import { doesHaveValue, doesNotHaveValue } from '../value_checker'
@@ -34,6 +33,7 @@ import {
 import World from './world'
 import { ICanonicalSupportCodeIds } from '../runtime/parallel/command_types'
 import { GherkinStepKeyword } from '../models/gherkin_step_keyword'
+import { SourcedParameterTypeRegistry } from './sourced_parameter_type_registry'
 
 interface IStepDefinitionConfig {
   code: any
@@ -65,20 +65,6 @@ interface ITestRunHookDefinitionConfig {
   uri: string
 }
 
-export const builtinParameterTypes = [
-  'bigdecimal',
-  'biginteger',
-  'byte',
-  'double',
-  'float',
-  'int',
-  'long',
-  'short',
-  'string',
-  'word',
-  '',
-]
-
 export class SupportCodeLibraryBuilder {
   public readonly methods: IDefineSupportCodeMethods
 
@@ -93,7 +79,7 @@ export class SupportCodeLibraryBuilder {
   private defaultTimeout: number
   private definitionFunctionWrapper: any
   private newId: IdGenerator.NewId
-  private parameterTypeRegistry: ParameterTypeRegistry
+  private parameterTypeRegistry: SourcedParameterTypeRegistry
   private stepDefinitionConfigs: IStepDefinitionConfig[]
   private World: any
   private parallelCanAssign: ParallelAssignmentValidator
@@ -166,7 +152,8 @@ export class SupportCodeLibraryBuilder {
 
   defineParameterType(options: IParameterTypeDefinition<any>): void {
     const parameterType = buildParameterType(options)
-    this.parameterTypeRegistry.defineParameterType(parameterType)
+    const source = getDefinitionLineAndUri(this.cwd)
+    this.parameterTypeRegistry.defineSourcedParameterType(parameterType, source)
   }
 
   defineStep(
@@ -481,7 +468,7 @@ export class SupportCodeLibraryBuilder {
     this.beforeTestStepHookDefinitionConfigs = []
     this.definitionFunctionWrapper = null
     this.defaultTimeout = 5000
-    this.parameterTypeRegistry = new ParameterTypeRegistry()
+    this.parameterTypeRegistry = new SourcedParameterTypeRegistry()
     this.stepDefinitionConfigs = []
     this.parallelCanAssign = () => true
     this.World = World