Emit messages for suggestions (#2703)

Author: davidjgoss

CHANGELOG.md

@@ -10,6 +10,7 @@ Please see [CONTRIBUTING.md](./CONTRIBUTING.md) on how to contribute to Cucumber
 ## [Unreleased]
 ### Added
 - Support named BeforeAll/AfterAll hooks ([#2661](https://github.com/cucumber/cucumber-js/pull/2661))
+- Emit messages for suggestions ([#2703](https://github.com/cucumber/cucumber-js/pull/2703))
 
 ### Changed
 - Render a more test case-centric HTML report ([react-components/#396](https://github.com/cucumber/react-components/pull/396))

compatibility/cck_spec.ts

@@ -23,12 +23,6 @@ const UNSUPPORTED = [
   'global-hooks-afterall-error',
   // not a test sample
   'test-run-exception',
-  // suggestions not implemented yet
-  'examples-tables-undefined',
-  'hooks-undefined',
-  'retry-undefined',
-  'undefined',
-  'unknown-parameter-type',
 ]
 
 config.truncateThreshold = 100

features/step_definition_snippets_custom_syntax.feature

@@ -8,8 +8,19 @@ Feature: step definition snippets custom syntax
       """
       Feature: a feature
         Scenario: a scenario
+          Given a step
+
+        Scenario: another scenario
           Given an undefined step
       """
+    And a file named "features/steps.js" with:
+      """
+      const {Given} = require('@cucumber/cucumber')
+
+      Given('a step', function() {
+        // noop
+      })
+      """
     And a file named "coffeescript_syntax.js" with:
       """
       function CoffeeScriptSyntax(snippetInterface) {
@@ -61,3 +72,13 @@ Feature: step definition snippets custom syntax
       | promise     | ->                           | 'pending'              |
       | async-await | ->                           | 'pending'              |
       | synchronous | ->                           | 'pending'              |
+
+  Scenario: Custom snippet syntax works in parallel runtime
+    When I run cucumber-js with `--parallel 2 --format-options '{"snippetInterface": "async-await", "snippetSyntax": "./coffeescript_syntax.js"}'`
+    Then it fails
+    And the output contains the text:
+      """
+      @Given 'an undefined step', ->
+        # Write code here that turns the phrase above into concrete actions
+        'pending'
+      """

features/support/formatter_output_helpers.ts

@@ -121,4 +121,7 @@ export const ignorableKeys = [
   // errors
   'message',
   'stackTrace',
+  // snippets
+  'language',
+  'code',
 ]

src/api/run_cucumber.ts

@@ -153,6 +153,7 @@ Running from: ${__dirname}
     newId,
     supportCodeLibrary,
     options: options.runtime,
+    snippetOptions: options.formats.options,
   })
   const success = await runtime.run()
   await pluginManager.cleanup()

src/formatter/step_definition_snippet_builder/index.ts

@@ -47,6 +47,23 @@ export default class StepDefinitionSnippetBuilder {
     })
   }
 
+  buildMultiple({ keywordType, pickleStep }: IBuildRequest): string[] {
+    const comment =
+      'Write code here that turns the phrase above into concrete actions'
+    const functionName = this.getFunctionName(keywordType)
+    const generatedExpressions =
+      this.cucumberExpressionGenerator.generateExpressions(pickleStep.text)
+    const stepParameterNames = this.getStepParameterNames(pickleStep)
+    return generatedExpressions.map((generatedExpression) => {
+      return this.snippetSyntax.build({
+        comment,
+        functionName,
+        generatedExpressions: [generatedExpression],
+        stepParameterNames,
+      })
+    })
+  }
+
   getFunctionName(keywordType: KeywordType): string {
     switch (keywordType) {
       case KeywordType.Event:

src/runtime/make_runtime.ts

@@ -1,11 +1,12 @@
 import { EventEmitter } from 'node:events'
 import { IdGenerator } from '@cucumber/messages'
 import { IRunOptionsRuntime } from '../api'
-import { ILogger } from '../environment'
+import { ILogger, IRunEnvironment } from '../environment'
 import { SourcedPickle } from '../assemble'
 import { SupportCodeLibrary } from '../support_code_library_builder/types'
-import { IRunEnvironment } from '../environment'
-import { Runtime, RuntimeAdapter } from './types'
+import FormatterBuilder from '../formatter/builder'
+import { FormatOptions } from '../formatter'
+import { Runtime } from './types'
 import { ChildProcessAdapter } from './parallel/adapter'
 import { InProcessAdapter } from './serial/adapter'
 import { Coordinator } from './coordinator'
@@ -18,6 +19,7 @@ export async function makeRuntime({
   newId,
   supportCodeLibrary,
   options,
+  snippetOptions,
 }: {
   environment: IRunEnvironment
   logger: ILogger
@@ -26,25 +28,19 @@ export async function makeRuntime({
   sourcedPickles: ReadonlyArray<SourcedPickle>
   supportCodeLibrary: SupportCodeLibrary
   options: IRunOptionsRuntime
+  snippetOptions: Pick<FormatOptions, 'snippetInterface' | 'snippetSyntax'>
 }): Promise<Runtime> {
   const testRunStartedId = newId()
-  const adapter: RuntimeAdapter =
-    options.parallel > 0
-      ? new ChildProcessAdapter(
-          testRunStartedId,
-          environment,
-          logger,
-          eventBroadcaster,
-          options,
-          supportCodeLibrary
-        )
-      : new InProcessAdapter(
-          testRunStartedId,
-          eventBroadcaster,
-          newId,
-          options,
-          supportCodeLibrary
-        )
+  const adapter = await makeAdapter(
+    options,
+    snippetOptions,
+    testRunStartedId,
+    environment,
+    logger,
+    eventBroadcaster,
+    supportCodeLibrary,
+    newId
+  )
   return new Coordinator(
     testRunStartedId,
     eventBroadcaster,
@@ -54,3 +50,42 @@ export async function makeRuntime({
     adapter
   )
 }
+
+async function makeAdapter(
+  options: IRunOptionsRuntime,
+  snippetOptions: Pick<FormatOptions, 'snippetInterface' | 'snippetSyntax'>,
+  testRunStartedId: string,
+  environment: IRunEnvironment,
+  logger: ILogger,
+  eventBroadcaster: EventEmitter,
+  supportCodeLibrary: SupportCodeLibrary,
+  newId: () => string
+) {
+  if (options.parallel > 0) {
+    return new ChildProcessAdapter(
+      testRunStartedId,
+      environment,
+      logger,
+      eventBroadcaster,
+      options,
+      snippetOptions,
+      supportCodeLibrary
+    )
+  }
+  const snippetBuilder = await FormatterBuilder.getStepDefinitionSnippetBuilder(
+    {
+      cwd: environment.cwd,
+      snippetInterface: snippetOptions.snippetInterface,
+      snippetSyntax: snippetOptions.snippetSyntax,
+      supportCodeLibrary,
+    }
+  )
+  return new InProcessAdapter(
+    testRunStartedId,
+    eventBroadcaster,
+    newId,
+    options,
+    supportCodeLibrary,
+    snippetBuilder
+  )
+}

src/runtime/make_suggestion.ts

@@ -0,0 +1,44 @@
+import {
+  IdGenerator,
+  PickleStep,
+  PickleStepType,
+  Suggestion,
+} from '@cucumber/messages'
+import StepDefinitionSnippetBuilder from '../formatter/step_definition_snippet_builder'
+import { KeywordType } from '../formatter/helpers'
+
+function mapPickleStepTypeToKeywordType(type?: PickleStepType): KeywordType {
+  switch (type) {
+    case PickleStepType.CONTEXT:
+      return KeywordType.Precondition
+    case PickleStepType.ACTION:
+      return KeywordType.Event
+    case PickleStepType.OUTCOME:
+      return KeywordType.Outcome
+    default:
+      return KeywordType.Precondition
+  }
+}
+
+export function makeSuggestion({
+  newId,
+  snippetBuilder,
+  pickleStep,
+}: {
+  newId: IdGenerator.NewId
+  snippetBuilder: StepDefinitionSnippetBuilder
+  pickleStep: PickleStep
+}): Suggestion {
+  const keywordType = mapPickleStepTypeToKeywordType(pickleStep.type)
+  const codes = snippetBuilder.buildMultiple({ keywordType, pickleStep })
+  const snippets = codes.map((code) => ({
+    code,
+    language: 'javascript',
+  }))
+
+  return {
+    id: newId(),
+    pickleStepId: pickleStep.id,
+    snippets,
+  }
+}

src/runtime/make_suggestion_spec.ts

@@ -0,0 +1,46 @@
+import { describe, it } from 'mocha'
+import { expect } from 'chai'
+import { IdGenerator } from '@cucumber/messages'
+import * as messages from '@cucumber/messages'
+import { buildSupportCodeLibrary } from '../../test/runtime_helpers'
+import FormatterBuilder from '../formatter/builder'
+import { makeSuggestion } from './make_suggestion'
+
+describe('makeSuggestion', () => {
+  it('generates multiple snippets for expressions with numeric parameters', async () => {
+    const supportCodeLibrary = buildSupportCodeLibrary()
+    const snippetBuilder =
+      await FormatterBuilder.getStepDefinitionSnippetBuilder({
+        cwd: process.cwd(),
+        supportCodeLibrary,
+      })
+    const newId = IdGenerator.incrementing()
+    const pickleStep: messages.PickleStep = {
+      id: '1',
+      text: 'I have 5 apples',
+      type: messages.PickleStepType.CONTEXT,
+      astNodeIds: [],
+    }
+
+    const suggestion = makeSuggestion({
+      newId,
+      snippetBuilder,
+      pickleStep,
+    })
+
+    expect(suggestion).to.deep.equal({
+      id: '0',
+      pickleStepId: '1',
+      snippets: [
+        {
+          code: "Given('I have {int} apples', function (int) {\n  // Write code here that turns the phrase above into concrete actions\n  return 'pending';\n});",
+          language: 'javascript',
+        },
+        {
+          code: "Given('I have {float} apples', function (float) {\n  // Write code here that turns the phrase above into concrete actions\n  return 'pending';\n});",
+          language: 'javascript',
+        },
+      ],
+    })
+  })
+})

src/runtime/parallel/adapter.ts

@@ -6,6 +6,7 @@ import { AssembledTestCase } from '../../assemble'
 import { ILogger, IRunEnvironment } from '../../environment'
 import { RuntimeAdapter } from '../types'
 import { IRunOptionsRuntime } from '../../api'
+import { FormatOptions } from '../../formatter'
 import {
   FinalizeCommand,
   InitializeCommand,
@@ -47,6 +48,10 @@ export class ChildProcessAdapter implements RuntimeAdapter {
     private readonly logger: ILogger,
     private readonly eventBroadcaster: EventEmitter,
     private readonly options: IRunOptionsRuntime,
+    private readonly snippetOptions: Pick<
+      FormatOptions,
+      'snippetInterface' | 'snippetSyntax'
+    >,
     private readonly supportCodeLibrary: SupportCodeLibrary
   ) {}
 
@@ -131,6 +136,7 @@ export class ChildProcessAdapter implements RuntimeAdapter {
           this.supportCodeLibrary.afterTestRunHookDefinitions.map((h) => h.id),
       },
       options: this.options,
+      snippetOptions: this.snippetOptions,
     } satisfies InitializeCommand)
   }