Writing seperate loader for *.cucumber files results in esbuild-preprocessor error (headless mode only)

[thomasatdiscoverage]

Hi,

Not too sure that this thread should belong in this forum or the one for the cypress-cucumber-preprocessor plugin, but here's the problem.

So basically, I'm trying to modify the es-build-preprocessor to convert *.cucumber files instead of *.feature to the needed .spec.ts files and I hope I'm doing it completely wrong and there's a better solution/approach than the following:

According to the readme's, I should write my own loader to handle *.cucumber files. This looks as follows (based on the existing cucumber-processor code):

import * as fs from 'fs';
// @ts-expect-error will error
import { compile } from '@badeball/cypress-cucumber-preprocessor/browserify';

export function createCucumberESBuildPlugin(config) {
  return {
    name: 'cucumber',
    setup(build) {
      // @ts-expect-error will error
      build.onLoad({ filter: /\.cucumber$/ }, async (args) => {
        const content = fs.readFileSync(args.path, 'utf8');
        return {
          contents: await compile(config, content, args.path),
          loader: 'js',
        };
      });
    },
  };
}

I'm using this plugin as follows:

import { addCucumberPreprocessorPlugin, } from "@badeball/cypress-cucumber-preprocessor";
import { createCucumberESBuildPlugin } from "./cucumber-plugin";
import createBundler = require("@bahmutov/cypress-esbuild-preprocessor");

export async function setupNodeEvents(
    cypressOn: Cypress.PluginEvents,
    config: Cypress.PluginConfigOptions,
): Promise<Cypress.PluginConfigOptions> {

    // https://github.com/bahmutov/cypress-on-fix
    // eslint-disable-next-line @typescript-eslint/no-var-requires
    const on = require('cypress-on-fix')(cypressOn)

    await addCucumberPreprocessorPlugin(on, config);

    on(
        'file:preprocessor',
        createBundler({
            plugins: [createCucumberESBuildPlugin(config)],
        },),
    );

As you can see, I'm using the cypress-on-fix package to fix possible errors for the 'on' listeners.

When executing the Cypress tests in headless mode, I can see that the *.cucumber files are being converted to the correct format in the generated Cypress bundles, but I get the following error:

CypressError: `cy.task('cypress-cucumber-preprocessor:spec-envelopes')` failed with the following error:
> Unexpected state in specEnvelopesHandler: before-run. This almost always means that you or some other plugin, are overwriting this plugin's event handlers. For more information & workarounds, see https://github.com/badeball/cypress-cucumber-preprocessor/blob/master/docs/event-handlers.md (if neither workaround work, please report at https://github.com/badeball/cypress-cucumber-preprocessor)
https://on.cypress.io/api/task

I have tried both workaround, but without succes. The same error keeps popping up, but only in headless mode, perhaps because that timings in headless mode are conflicting with eachother but not in headed mode.

I'm very curious what is going wrong so some help in this would be very appreciated!

Cheers,

Thomas

[badeball]

You need to provide a minimal, reproducible example that illustrates the issue.

[thomasatdiscoverage]

Thanks for your response. I will work on an example ASAP.

[hamza-amami]

Thanks for your response. I will work on an example ASAP.

Hello, Have you been able to find a workaround for this please ?

I'm also using cypress-on-fix to be able to register cucumber and allure as plugin, but i'm stuck with this error

[thomasatdiscoverage]

At our project, we have chosen to rename the .feature files not to .cucumber files, but to .gherkin.feature files so we can configure IntelliJ to use .gherkin.feature files so the preprocessor plugin does not need to be altered. Hereby we solved our challenge in to use Gherkin feature files together with Karate feature files.

No really a solution for our problem, but the workaround is OK by now.

This issue can be closed (how do I do that? :D).