feat(allure-cypress): new real-time lifecycle, hooks, and test plan

[delatrie]

Context

The PR contains the following major changes of Allure Cypress:

Real-time reporting

Previously, Allure Cypress reported the results in a batched fashion when the test run ended. The new implementation employs:

• an updated set of messages
• message queueing on the browser side
• queue flushing to the Node side in the plugin's afterEach hook
• the tail flushing in the plugin's after hook

The messages are flushed using Cypress'es tasks mechanism. It works reliably only in hooks, that's why index.ts defines afterEach and after hooks.

In interactive mode, the spec reporting is finalized in Mocha's run end event. In cypress run mode the finalization is done in Cypress'es after:spec event.

environment.properties and categories.json are reported in after:run.

New hooks implementation

The new implementation supports all types of hooks. Spec-level after hooks are supported by intercepting the after calls and injecting the plugin's after hooks right next to user-defined ones. That allows us to issue the reporting chronologically after the user-defined after is completed and its corresponding messages are queued.

New test plan implementation

The previous implementation requested the test plan from the browser side through the Cypress task. It applies the test plan in a beforeEach hook and skipped tests with this.skip().

The downside is that, while correctly skipping the tests, this approach fails to disable the associated hooks, meaning all the before and after hooks will be executed. Given those hooks often contain tasks like spinning up test servers, initializing databases, etc, that may slow down the execution substantially.

The new implementation uses Cypress environment variables to pass the test plan down the specs. That allows us to get it early enough to apply before the spec-level suite runs, disabling both the tests and their hooks (even the ones defined on the spec-level).

The only requirement for a user is to pass the Cypress configuration to allureCypress:

import { defineConfig } from "cypress";
import { allureCypress } from "allure-cypress/reporter";

export default defineConfig({
  e2e: {
    setupNodeEvents: (on, config) => {
      allureCypress(on, config, { /* Allure options go here */ });
      return config;
    },
    // ...
  },
});

Note

For backward compatibility, passing Allure configuration as the 2nd argument also works.

fixes #1078
fixes #1079

Other changes

• New README for Allure Cypress

Checklist

• Sign Allure CLA
• Provide unit tests