An argument with default value from the optional regex capturing group returns null instead of a default value

[alesiaviktorchyk]

Current behavior

An argument with default value from the optional regex capturing group returns null instead of a default value.

Given I have the following step definition:

Given(/^(?:I am|I'm) logged in( as '(.*)')?$/, (userType = 'user') => {
	cy.log(userType);
});

When in my feature file I use:

Feature: Test
    Scenario: Test
        Given I am logged in as 'user'
        Given I am logged in

I see the following in cypress test runner:

Desired behavior

I expect that for both steps cy.log will log user.

At least this is how the old cypress-cucumber-preprocessor worked.

Here's what I see when I use the old cypress-cucumber-preprocessor:

Test code to reproduce

To reproduce:

• clone https://github.com/alesiaviktorchyk/cypress-cucumber-preprocessor-test
• run npm i
• run npm run test

To compare @badeball/cypress-cucumber-preprocessor vs. cypress-cucumber-preprocessor:

• switch to the old-preprocessor branch and run npm run test again.

Versions

• Cypress version: 9.6.1
• Preprocessor version: 10.0.0
• Node version: 15.8.0

[alesiaviktorchyk]

Unrelated to the issue but just wondering why with the new processor there's an empty wrap after each cypress command:

[badeball]

Regarding optional capturing groups in step definitions and parameter types, it seems that unmatched capturing group in step definition changed from undefined to null in cucumber-expressions-v7.0.1, when typescript was introduced. The previous preprocessor implementation was depending on cucumber-expressions ^6.0.1, while this is now on ^15.0.1, hence the change in behavior you're experiencing.

This is how cucumber-js now behaves and I see no reason for why the preprocessor should behave any differently.

I've relased v10.0.1 which omits logging certain calls to cy.wrap. Hope that helps.

[badeball]

You can use eg. patch-package if you want to change this behavior yourself (you will find the relevant lines in cucumber-expressions in dist/cjs/src/defineDefaultParameterTypes.js and dist/cjs/src/RegularExpression.js).

[alesiaviktorchyk]

@badeball thanks for the explanation and for the quick fix of the wrap thing.