Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bahmutov/cypress-cdp
A custom Cypress command to wrap the remote debugger protocol low level command
https://github.com/bahmutov/cypress-cdp
cypress-plugin
Last synced: 3 days ago
JSON representation
A custom Cypress command to wrap the remote debugger protocol low level command
- Host: GitHub
- URL: https://github.com/bahmutov/cypress-cdp
- Owner: bahmutov
- Created: 2022-04-15T11:22:03.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-22T11:38:30.000Z (5 months ago)
- Last Synced: 2024-05-22T12:45:42.598Z (5 months ago)
- Topics: cypress-plugin
- Language: JavaScript
- Homepage: https://glebbahmutov.com/blog/when-can-the-test-click/
- Size: 760 KB
- Stars: 12
- Watchers: 2
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# cypress-cdp [](https://github.com/bahmutov/cypress-cdp/actions/workflows/ci.yml) 
> A custom Cypress command to wrap the [Chrome remote debugger protocol](https://chromedevtools.github.io/devtools-protocol/) low level command
Read the blog posts:
- [Cypress automation](https://glebbahmutov.com/blog/cypress-automation/)
- [When Can The Test Click](https://glebbahmutov.com/blog/when-can-the-test-click/)
- [Solve The First Click](https://glebbahmutov.com/blog/solve-the-first-click/)
- [Rendered font](https://glebbahmutov.com/blog/rendered-font/)
- [Emulate Media In Cypress Tests](https://glebbahmutov.com/blog/cypress-emulate-media/)
🎓 Covered in my course [Cypress Plugins](https://cypress.tips/courses/cypress-plugins) and [Cypress Network Testing Exercises](https://cypress.tips/courses/network-testing).
## Install
Add this plugin as your dev dependency
```
# install using NPM
$ npm i -D cypress-cdp
# or install using Yarn
$ yarn add -D cypress-cdp
```
Then import this plugin in your spec or support file
```js
// https://github.com/bahmutov/cypress-cdp
import 'cypress-cdp'
```
## Examples
### Disable caching
Similar to clicking the checkbox "Disable cache" in the Network tab
```js
import 'cypress-cdp'
cy.CDP('Network.setCacheDisabled', {
cacheDisabled: true,
})
```
## API
### CDP
#### CDP example 1
```js
const selector = 'button#one'
cy.CDP('Runtime.evaluate', {
expression: 'frames[0].document.querySelector("' + selector + '")',
}).should((v) => {
expect(v.result).to.have.property('objectId')
})
```
**Tip:** be careful with selectors, you probably will need to escape them. For example, this library uses this escape
```js
const escapedSelector = JSON.stringify(selector)
cy.CDP('Runtime.evaluate', {
expression: 'frames[0].document.querySelector(' + escapedSelector + ')',
})
```
### hasEventListeners
#### hasEventListeners example
```js
// any event listeners are attached
cy.hasEventListeners('button#one')
// "click" event listeners are attached
cy.hasEventListeners('button#one', { type: 'click' })
```
### getCDPNodeId
Returns the internal element's Node Id that can be used to query the run-time properties, for example the rendered font.
```js
cy.getCDPNodeId('body').then((nodeId) => {
cy.CDP('CSS.getPlatformFontsForNode', {
nodeId,
})
})
```
## Type definitions
Defined in [src/index.d.ts](./src/index.d.ts) and copied from the original [PR 66237](https://github.com/DefinitelyTyped/DefinitelyTyped/pull/66237). If you want your project to "know" the `cy.CDP` command, include this dependency, for example:
```json
{
"types": ["cypress", "cypress-cdp"]
}
```
## Small print
Author: Gleb Bahmutov <[email protected]> © 2022
- [@bahmutov](https://twitter.com/bahmutov)
- [glebbahmutov.com](https://glebbahmutov.com)
- [blog](https://glebbahmutov.com/blog)
- [videos](https://www.youtube.com/glebbahmutov)
- [presentations](https://slides.com/bahmutov)
- [cypress.tips](https://cypress.tips)
- [Cypress Tips & Tricks Newsletter](https://cypresstips.substack.com/)
- [my Cypress courses](https://cypress.tips/courses)
License: MIT - do anything with the code, but don't blame me if it does not work.
Support: if you find any problems with this module, email / tweet /
[open issue](https://github.com/bahmutov/cypress-cdp/issues) on Github
## MIT License
Copyright (c) 2022 Gleb Bahmutov <[email protected]>
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.