feat(plugin): allow filtering entries from HAR using a custom predicate

[derevnjuk]

You can specify the filter option as a path to a JS/TS module that exports a function to filter out unwanted entries from the HAR. The function should take an Entry object as a parameter and return a boolean indicating whether the entry should be included in the final HAR or not.

Here's an example of how to use the filter option:

cy.recordHar({ filter: '../support/include-password.ts' });

And here's an example of what the include-password.ts filter module might look like:

import { Entry } from 'har-format';

export default async (req: Entry) => {
  try {
    return /\"password":/.test(req.request.postData.text ?? '');
  } catch {
    return false;
  }
};

In this example, the filter function will only exclude entries in the HAR where the request body contains a JSON object with a password field.

You can also specify a rootDir option that will be used to resolve the path of the filter option. By default, the path is relative to the spec folder. But by providing a rootDir it will look for the module in the provided directory:

cy.recordHar({
  filter: 'cypress/support/include-password.ts',
  rootDir: Cypress.config('projectRoot')
});

closes #163

[codeclimate]

Code Climate has analyzed commit b5cada5 and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 96.6% (50% is the threshold).

This pull request will bring the total coverage in the repository to 92.1% (0.1% change).

View more on Code Climate.