dd-trace integration with Cypress: plugins file override?

[jdborneman-terminus]

Reading the instructions here it looks like it says to override the location of the plugins file to be one that comes with dd-trace. What if we've already got stuff in our /cypress/plugins/index.js file? Is there a way to both use dd-trace AND have our own stuff in plugins?

To resolve this, I tried adding require('dd-trace/cypress/plugin') to my /cypress/plugins/index.js file, but it fails pretty spectacularly:

CypressError: `cy.task('dd:afterEach')` failed with the following error:

The task 'dd:afterEach' was not handled in the plugins file. The following tasks are registered: log

Fix this in your plugins file here:
<Path to cypress project>/cypress-poc/cypress/plugins/index.js

https://on.cypress.io/api/task

Because this error occurred during a `after each` hook we are skipping all of the remaining tests.

Ideally we could just require the plugin from dd-trace like this and have it work so we could have OTHER plugins defined as well. I'm relatively new to Cypress and brand new to DataDog, but the way I read the instructions it seems you have to set your plugins file to what's in dd-trace, which would preclude having other plugins defined I think?

Thanks!

[jdborneman-terminus]

cc @juan-fernandez since I've seen you tagged/answering in another discussion. Thanks!

[jdborneman-terminus]

Looking at the source of the plugin for cypress it really looks like it's written to behave as if it's the only plugin as it does the

module.exports = (on, config) => { 
...
}

within there.

A better example of a plugin, IMO, is cypress-grep. to install it you need to require something in support, and then do a require within the existing module.exports = in your project's plugin file rather than overriding it completely.

Am I totally off base and there's a way to support multiple other plugins in tandem with dd-trace?

[juan-fernandez]

hi @jdborneman-terminus! Thanks for trying our cypress plugin. Pinging me was the right decision 😄 .

You are in the right path with the cypress-grep example. We actually cover this case in our docs: https://docs.datadoghq.com/continuous_integration/setup_tests/javascript/?tab=cypress#instrument-your-tests

I think you can do what you want with this:

module.exports = (on, config) => {
  // your previous code is before this line
  require('dd-trace/cypress/plugin')(on, config)
  // or after :-) 
}

In app docs are usually a bit more concise. If you want the full version it's always better to go to the official docs page: https://docs.datadoghq.com/continuous_integration/setup_tests/

Let me know if this answers your question!

[jdborneman-terminus]

Seems to have done it. Thanks for the assist, @juan-fernandez!