Error: Cannot resolve cypress-xray-plugin/plugin

[caique-rd]

When I run my tests in the CLI I get the follow error:

Error: Webpack Compilation Error
./cypress/support/e2e.js
Module not found: Error: Can't resolve 'cypress-xray-plugin/plugin' in '/Users/caiquecoelho/Documents/Projects/directory_ui_test_framework/cypress/support'
resolve 'cypress-xray-plugin/plugin' in '/Users/caiquecoelho/Documents/Projects/directory_ui_test_framework/cypress/support'
  Parsed request is a module
  using description file: /Users/caiquecoelho/Documents/Projects/directory_ui_test_framework/package.json (relative path: ./cypress/support)
    Field 'browser' doesn't contain a valid alias configuration
    Looked for and couldn't find the file at the following paths:

I'm using the 4.0.1 version and my configurations look like this:
e2e.js

import "cypress-xray-plugin/plugin";

cypress.config.js

const {addXrayResultUpload, configureXrayPlugin} = require("cypress-xray-plugin")
....
module.exports = async (on, config) => {
  await configureXrayPlugin(
    config,
    {
        jira: {
            projectKey: "MY_PROJECT_KEY",
            url: "MY_PROJECT_URL",
            testExecutionIssueKey: "MY_PROJECT_TEST_EXECUTION_ISSUE_KEY"
        },
    }
  );
  await addXrayResultUpload(on);

  return config
}

I'm running the test with:

cypress run --env JIRA_PROJECT_KEY='RPF',JIRA_USERNAME='<MY_EMAIL>',JIRA_API_TOKEN='<MY_API_TOKEN>',XRAY_CLIENT_ID='<MY_CLIENT_ID>',XRAY_CLIENT_SECRET='<MY_CLIENT_SECRET>''

[caique-rd]

I was able to fix that importing in e2e.js this way:

import "cypress-xray-plugin/src/register";

[csvtuda]

Yes, your e2e.js file should not import the event listeners like this:

import "cypress-xray-plugin/plugin" // no longer works in 4.0.1

but rather using:

import "cypress-xray-plugin/register"
// or
require("cypress-xray-plugin/register")

I know it doesn't work for you in 4.0.1 (#133), but as of now I cannot reproduce it. You can simply omit the /register import in e2e.js, it does not do anything. Everything in there is commented out and has been for a long time:

cypress-xray-plugin/src/register.ts

Lines 1 to 4 in 86bc8c3

	// Currently not in use.
	// Cypress.on("test:after:run", (test: Cypress.ObjectLike, runnable: Mocha.Test) => {
	// console.log("test:after:run", test, runnable);
	// });

I think I will update the documentation accordingly.