misc: write command durations to a csv file #32938
Conversation
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
packages/server/lib/automation/commands/record_performance_entry.ts
Outdated
Show resolved
Hide resolved
packages/server/lib/automation/commands/record_performance_entry.ts
Outdated
Show resolved
Hide resolved
|
|
||
| - The keyboard shortcuts modal now displays the keyboard shortcut for saving Studio changes - `⌘` + `s` for Mac or `Ctrl` + `s` for Windows/Linux. Addressed [#32862](https://github.com/cypress-io/cypress/issues/32862). Addressed in [#32864](https://github.com/cypress-io/cypress/pull/32864). | ||
| - The Cursor logo now correctly displays in the External editor dropdown. Addresses [#32062](https://github.com/cypress-io/cypress/issues/32062). Addressed in [#32911](https://github.com/cypress-io/cypress/pull/32911). | ||
| - Command execution can be benchmarked by setting the `CYPRESS_INTERNAL_COMMAND_PERFORMANCE_LOGGING` environment variable to `1` or `true`. The performance log is recorded to `./cypress/logs/performance.log` by default. Addressed in [#32938](https://github.com/cypress-io/cypress/pull/32938) |
There was a problem hiding this comment.
@cacieprins If this is meant to be a user facing feature - I would not prefix this with CYPRESS_INTERNAL as that is used for truly internal env vars that users should never set.
There was a problem hiding this comment.
I think if it's something we want user-facing, it should be a config entry - but that's out of scope for this, I think. This is to prep for benchmarking visibility approaches
cypress
|
|||||||||||||||||||||||||||||||||||||||||||||||||
| Project |
cypress
|
| Branch Review |
csv-benchmark
|
| Run status |
|
| Run duration | 37m 54s |
| Commit |
|
| Committer | Cacie Prins |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
124
|
Flaky
|
0
|
Pending
|
802
|
Skipped
|
4
|
Passing
|
5134
|
| View all changes introduced in this branch ↗︎ | |
Warning
Partial Report: The results for the Application Quality reports may be incomplete.
UI Coverage
38.71%
|
|
|---|---|
|
Untested elements
|
166
|
|
Tested elements
|
108
|
Accessibility
99.03%
|
|
|---|---|
|
Failed rules
|
0 critical
6 serious
1 moderate
1 minor
|
|
Failed elements
|
56
|
Tests for review
commands/actions/type_special_chars.cy.ts • 0 failed tests • 5x-driver-chrome:beta
| Test | Artifacts | |
|---|---|---|
commands/querying/querying.cy.ts • 0 failed tests • 5x-driver-chrome:beta
| Test | Artifacts | |
|---|---|---|
e2e/origin/cookie_behavior.cy.ts • 0 failed tests • 5x-driver-chrome:beta
| Test | Artifacts | |
|---|---|---|
The first 5 failed specs are shown, see all 1150 specs in Cypress Cloud.
| path.join(logFilePath(), 'performance.log'), | ||
| `${row}\n`, | ||
| { flag: 'a' }, | ||
| ) |
There was a problem hiding this comment.
Bug: Resolve Asynchronous File Write Mismatch
fsSync.writeFile is the async callback-based version that requires a callback function as the last parameter. Without it, Node.js throws a runtime error. The function should use fsSync.writeFileSync instead to match the synchronous pattern used in initializePerformanceLogFile and work correctly within the try-catch block.
Additional details
If
CYPRESS_INTERNAL_COMMAND_PERFORMANCE_LOGGINGis enabled, Cypress will:./cypress/logs/performance.log, or$CYPRESS_INTERNAL_PERFORMANCE_LOG_FILE_PATH/performance.logifCYPRESS_INTERNAL_PERFORMANCE_LOG_FILE_PATHis set. This file is overwritten each time Cypress starts.startTime- when the Command Queue began executing the commandduration- How long the command took to executename- The name of the commandnumElements- the number of elements associated with the command (for queries, this is the number of elements that match the query)runnableTitle- the title of the runnable that enqueued the commandspec- the filename of the spec that included the runnableSteps to test
How has the user experience changed?
PR Tasks
cypress-documentation?type definitions?Note
Adds env-gated logging of each command’s execution timing to a CSV file and wires it through driver → automation (CDP/BiDi) → server.
CYPRESS_INTERNAL_COMMAND_PERFORMANCE_LOGGING):runCommandasync, measurestartTime/duration, capturenumElements, and emitCypress.automation('log:command:performance', ...)fromcommand_queue.ts.record_performance_entryto append CSV rows to./cypress/logs/performance.log(path override viaCYPRESS_INTERNAL_PERFORMANCE_LOG_FILE_PATH) and initialize file on mode start (modes/index.ts).log:command:performancethrough generic automation, plus CDP (cdp_automation.ts) and BiDi (bidi_automation.ts) handlers.CommandPerformanceEntryand new automation command in@packages/types.Written by Cursor Bugbot for commit d80bf84. This will update automatically on new commits. Configure here.