README.md

     

Cypress Sidekick Plugin

Sidekick plugin for Cypress. Bring Sidekick Actions to Cypress!
Explore the docs »

Sidekick Home · Report Bug & Request Feature

Table of Contents

1. About
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Example Usage
3. Roadmap
4. Contact

About Sidekick

Sidekick is a production debugging and on-demand logging tool where you can debug your running applications while they keep on running. Sidekick provides the ability to add logs and put non-breaking breakpoints in your application code which captures the snapshot of the application state, the call stack, variables, etc.

Sidekick Actions:

• A tracepoint is basically a non-breaking remote breakpoint. In short, it takes a snapshot of the variables when the code hits that line.
• Logpoints open the way for dynamic logging to Sidekick users. Replacing traditional logging with dynamic logging has the potential to lower stage sizes, costs, and time for log searching while adding the ability to add new logpoints without editing the source code, redeploying or restarting the application

(back to top)

Built With

• Sidekick Node.js Client

(back to top)

Prerequisites

Tested with node v16.14.2

• npm

  npm install npm@latest -g

Getting Started

Installation

1. Install Cypress Sidekick Plugin

   $ npm i @runsidekick/cypress

Example usage

Put tracepoint on a line

1. Add Sidekick configs into cypress.config.js

     module.exports = defineConfig({
         e2e: {
             sidekickApiKey: '',
             sidekickApiToken: '',
             sidekickTestModeApiKey: '',
             sidekickTestModeHost: '',
             sidekickTestModePort: 80
         }
     })

2. Import Sidekick plguin into Support/e2e.js

     import ‘@runsidekick/cypress’

3. Call putTracepoint function

     it('putTracepoint', () => {
         const putTracepointRequest = {
             "applicationFilters": [
                 {
                     "name": "sidekick-demo-app",
                     "version": "1.0",
                     "stage": "lab",
                     "customTags": {}
                 }
             ],
             "fileName": "/app/routes/speakers.js",
             "lineNo": 24,
             "expireSecs": 300,
             "expireCount": 100,
             "persist": true
         }
         
         cy.putTracepoint(putTracepointRequest);
     })

Then your tracepoint will be added to line 24 in the given file.

(back to top)

Contact

Sidekick: website

(back to top)