


Cypress Performance Plugin 'cypress-performance': A Guide to automate the Web Performance Testing
Dec 26, 2024 am 04:56 AMIntroduction
This is my first post on dev.to, so I hope it will be welcomed
The idea to create this plugin came to my mind when I was struggling to measure the web UI performance and the existing plugins were not providing me with the flexibility I needed. The "cypress-performance" plugin introduces a powerful way to measure and assert web performance metrics directly in your Cypress tests. Unlike traditional end-to-end testing that focuses on functionality, this plugin enables teams to catch performance regressions early and maintain high-performance standards through automated testing.
Web performance testing has become crucial today. Users expect lightning-fast experiences, and slow-loading pages can significantly impact business metrics. While Cypress is an excellent tool for end-to-end testing, it lacks built-in performance measurement capabilities.
Today, I'm excited to introduce "cypress-performance", a new plugin that brings performance measurement capabilities to your Cypress tests.
You can check it out here:
https://www.npmjs.com/package/cypress-performance https://github.com/Valiantsin2021/cypress-performance
Key Features
Real-time performance metrics collection during test execution
Built-in retry mechanisms for reliable measurements
Support for Core Web Vitals and other key performance indicators
Seamless integration with existing Cypress tests
Type definitions for TypeScript support
Configurable thresholds and timing options
Why Another Performance Testing Plugin?
You might be wondering, "Don't we already have "@cypress-audit/lighthouse"?" Yes, we do, and it's an excellent tool. However, "cypress-performance" takes a different approach:
Real User Metrics: While Lighthouse simulates performance under specific conditions, cypress-performance captures metrics during actual test execution, giving you insights into real user scenarios.
Test Integration: The plugin seamlessly integrates with your existing tests, allowing you to measure performance while executing your regular test flows, not as a separate audit.
Granular Control: You get fine-grained control over when and how to measure performance, with built-in retry mechanisms for reliable results.
Core Web Vitals: Focus on modern performance metrics that matter, including Largest Contentful Paint (LCP), First Input Delay (FID), and Cumulative Layout Shift (CLS).
Lower overhead - no need for separate Lighthouse runs
Less configuration - minimal setup required for basic usage
Specific metrics focus - Core Web Vitals and key timings
Test integration - natural fit in existing test flows the command is chainable and returns all collected metrics to be asserted
Retry capability - built-in reliability mechanisms to ensure the metrics are collected
Resource timing - detailed resource-level metrics
Total bytes - size of all resources
On the other side - @cypress-audit/lighthouse provides us with
Comprehensive audits including SEO, accessibility
Scoring system aligned with Lighthouse
Static analysis of best practices
Recommendations for improvements
Performance simulation under various conditions
Broader metrics beyond just performance
So what is it and how to use it?
This is a standalone Cypress plugin with 0 external dependencies.
First, install the plugin:
npm install -D cypress-performance
Add to your cypress/support/e2e.js:
import 'cypress-performance'
For TypeScript users, include types in tsconfig.json:
{ "compilerOptions": { "types": ["cypress", "cypress-performance"] } }
Now you're ready to start measuring performance!
Usage
The plugin exposes the single Cypress method:
cy.performance()
The cy.performance() command itself is retriable, meaning Cypress will retry the command until it either:
Gets valid metrics
Reaches the retryTimeout
Default options for the command:
MetricsOptions{ startMark?: keyof PerformanceTiming // Default: 'navigationStart' endMark?: keyof PerformanceTiming // Default: 'loadEventEnd' timeout?: number // Timeout in milliseconds (default: 10000) initialDelay?: number // Initial delay in milliseconds (default: 1000) retryTimeout?: number // Retry timeout in milliseconds (default: 5000) }
A typical test will look like this:
And her like it will look in the Cypress test runner:
Best Practices
Set Realistic Thresholds Consider your users and application when setting performance thresholds: LCP: < 2.5s (good), < 4s (needs improvement) CLS: < 0.1 (good), < 0.25 (needs improvement) TBT: < 300ms (good), < 600ms (needs improvement)
Use Custom Marks For single-page applications or complex user flows, use custom performance marks to measure specific interactions.
Consider Environment Variations Remember that CI environments might perform differently than local development. Adjust thresholds accordingly or use relative comparisons.
Combine with Other Metrics Use cypress-performance alongside other tools like Lighthouse for a complete performance picture
Epilogue
My "cypress-performance" plugin serves for quick valuable and most important web performance metrics collection and brings performance testing capabilities to your Cypress test suite. By focusing on real user metrics and providing fine-grained control, it helps ensure your application performs well under actual use conditions.
Whether you're monitoring Core Web Vitals, measuring specific user interactions, or ensuring smooth resource loading, "cypress-performance" provides the tools you need to catch performance regressions before they reach production.
The good performance is not just about speed—it's about consistency and reliability. With "cypress-performance", you can ensure your application maintains high-performance standards throughout its development lifecycle.
Give it a try in your project, and let me know how it works for you! The plugin is open source, and I welcome all contributions and feedback.
The above is the detailed content of Cypress Performance Plugin 'cypress-performance': A Guide to automate the Web Performance Testing. For more information, please follow other related articles on the PHP Chinese website!

Hot AI Tools

Undress AI Tool
Undress images for free

Undresser.AI Undress
AI-powered app for creating realistic nude photos

AI Clothes Remover
Online AI tool for removing clothes from photos.

Clothoff.io
AI clothes remover

Video Face Swap
Swap faces in any video effortlessly with our completely free AI face swap tool!

Hot Article

Hot Tools

Notepad++7.3.1
Easy-to-use and free code editor

SublimeText3 Chinese version
Chinese version, very easy to use

Zend Studio 13.0.1
Powerful PHP integrated development environment

Dreamweaver CS6
Visual web development tools

SublimeText3 Mac version
God-level code editing software (SublimeText3)

Hot Topics

The following points should be noted when processing dates and time in JavaScript: 1. There are many ways to create Date objects. It is recommended to use ISO format strings to ensure compatibility; 2. Get and set time information can be obtained and set methods, and note that the month starts from 0; 3. Manually formatting dates requires strings, and third-party libraries can also be used; 4. It is recommended to use libraries that support time zones, such as Luxon. Mastering these key points can effectively avoid common mistakes.

PlacingtagsatthebottomofablogpostorwebpageservespracticalpurposesforSEO,userexperience,anddesign.1.IthelpswithSEObyallowingsearchenginestoaccesskeyword-relevanttagswithoutclutteringthemaincontent.2.Itimprovesuserexperiencebykeepingthefocusonthearticl

Event capture and bubble are two stages of event propagation in DOM. Capture is from the top layer to the target element, and bubble is from the target element to the top layer. 1. Event capture is implemented by setting the useCapture parameter of addEventListener to true; 2. Event bubble is the default behavior, useCapture is set to false or omitted; 3. Event propagation can be used to prevent event propagation; 4. Event bubbling supports event delegation to improve dynamic content processing efficiency; 5. Capture can be used to intercept events in advance, such as logging or error processing. Understanding these two phases helps to accurately control the timing and how JavaScript responds to user operations.

If JavaScript applications load slowly and have poor performance, the problem is that the payload is too large. Solutions include: 1. Use code splitting (CodeSplitting), split the large bundle into multiple small files through React.lazy() or build tools, and load it as needed to reduce the first download; 2. Remove unused code (TreeShaking), use the ES6 module mechanism to clear "dead code" to ensure that the introduced libraries support this feature; 3. Compress and merge resource files, enable Gzip/Brotli and Terser to compress JS, reasonably merge files and optimize static resources; 4. Replace heavy-duty dependencies and choose lightweight libraries such as day.js and fetch

The main difference between ES module and CommonJS is the loading method and usage scenario. 1.CommonJS is synchronously loaded, suitable for Node.js server-side environment; 2.ES module is asynchronously loaded, suitable for network environments such as browsers; 3. Syntax, ES module uses import/export and must be located in the top-level scope, while CommonJS uses require/module.exports, which can be called dynamically at runtime; 4.CommonJS is widely used in old versions of Node.js and libraries that rely on it such as Express, while ES modules are suitable for modern front-end frameworks and Node.jsv14; 5. Although it can be mixed, it can easily cause problems.

There are three common ways to initiate HTTP requests in Node.js: use built-in modules, axios, and node-fetch. 1. Use the built-in http/https module without dependencies, which is suitable for basic scenarios, but requires manual processing of data stitching and error monitoring, such as using https.get() to obtain data or send POST requests through .write(); 2.axios is a third-party library based on Promise. It has concise syntax and powerful functions, supports async/await, automatic JSON conversion, interceptor, etc. It is recommended to simplify asynchronous request operations; 3.node-fetch provides a style similar to browser fetch, based on Promise and simple syntax

To write clean and maintainable JavaScript code, the following four points should be followed: 1. Use clear and consistent naming specifications, variable names are used with nouns such as count, function names are started with verbs such as fetchData(), and class names are used with PascalCase such as UserProfile; 2. Avoid excessively long functions and side effects, each function only does one thing, such as splitting update user information into formatUser, saveUser and renderUser; 3. Use modularity and componentization reasonably, such as splitting the page into UserProfile, UserStats and other widgets in React; 4. Write comments and documents until the time, focusing on explaining the key logic and algorithm selection

JavaScript's garbage collection mechanism automatically manages memory through a tag-clearing algorithm to reduce the risk of memory leakage. The engine traverses and marks the active object from the root object, and unmarked is treated as garbage and cleared. For example, when the object is no longer referenced (such as setting the variable to null), it will be released in the next round of recycling. Common causes of memory leaks include: ① Uncleared timers or event listeners; ② References to external variables in closures; ③ Global variables continue to hold a large amount of data. The V8 engine optimizes recycling efficiency through strategies such as generational recycling, incremental marking, parallel/concurrent recycling, and reduces the main thread blocking time. During development, unnecessary global references should be avoided and object associations should be promptly decorated to improve performance and stability.
