fix(benchmark): table reporter for non TTY output #5484

hi-ogawa · 2024-04-04T09:54:44Z

Description

Closes Benchmark doesn't print a table if terminal doesn't support TTY (in CI for example) #5475

This PR implements "non incremental" table output for non TTY case by reusing benchmark renderTree.

The idea is similar to verbose test reporter, which uses onTaskUpdate and waits until status is ready task.result?.state !== 'run' then print a full result:

vitest/packages/vitest/src/node/reporters/verbose.ts

Lines 14 to 20 in 48f762a

    
           onTaskUpdate(packs: TaskResultPack[]) { 
        
             if (this.isTTY) 
        
               return 
        
             for (const pack of packs) { 
        
               const task = this.ctx.state.idMap.get(pack[0]) 
        
               if (task && task.type === 'test' && task.result?.state && task.result?.state !== 'run') { 
        
                 let title = ` ${getStateSymbol(task)} `

Reveal screenshots

tty

no tty

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

It's really useful if your PR references an issue where it is discussed ahead of time. If the feature is substantial or introduces breaking changes without a discussion, PR might be closed.
Ideally, include a test that fails without this PR but passes with it.
Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Tests

Run the tests with pnpm test:ci.

Documentation

If you introduce new functionality, document it. You can run documentation with pnpm run docs command.

Changesets

Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.

netlify · 2024-04-04T09:54:58Z

✅ Deploy Preview for fastidious-cascaron-4ded94 canceled.

Name	Link
🔨 Latest commit	`97734d9`
🔍 Latest deploy log	https://app.netlify.com/sites/fastidious-cascaron-4ded94/deploys/6610a6419f8ef200086e2323

sheremet-va · 2024-04-05T11:01:00Z

Can you resolve the conflict, please?

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [vite-node](https://togithub.com/vitest-dev/vitest/blob/main/packages/vite-node#readme) ([source](https://togithub.com/vitest-dev/vitest/tree/HEAD/packages/vite-node)) | [`1.4.0` -> `1.5.0`](https://renovatebot.com/diffs/npm/vite-node/1.4.0/1.5.0) | [![age](https://developer.mend.io/api/mc/badges/age/npm/vite-node/1.5.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/vite-node/1.5.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/vite-node/1.4.0/1.5.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/vite-node/1.4.0/1.5.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>vitest-dev/vitest (vite-node)</summary> ### [`v1.5.0`](https://togithub.com/vitest-dev/vitest/releases/tag/v1.5.0) [Compare Source](https://togithub.com/vitest-dev/vitest/compare/v1.4.0...v1.5.0) ##### 🚀 Features - Add configuration for diff truncation - by [@willieho](https://togithub.com/willieho) in [vitest-dev/vitest#5073 and [vitest-dev/vitest#5333 [<samp>(6797b)</samp>](https://togithub.com/vitest-dev/vitest/commit/6797b041) - Remove unrelated noise from diff for toMatchObject() - by [@geersch](https://togithub.com/geersch) in [vitest-dev/vitest#5364 [<samp>(99276)</samp>](https://togithub.com/vitest-dev/vitest/commit/99276399) - Allow custom host for --inspect and --inspect-brk - by [@sheremet-va](https://togithub.com/sheremet-va) in [vitest-dev/vitest#5509 [<samp>(61572)</samp>](https://togithub.com/vitest-dev/vitest/commit/6157282c) - **coverage**: V8 to ignore empty lines, comments, types - by [@AriPerkkio](https://togithub.com/AriPerkkio) in [vitest-dev/vitest#5457 [<samp>(10b89)</samp>](https://togithub.com/vitest-dev/vitest/commit/10b89713) ##### 🐞 Bug Fixes - `describe` calls not taking generic type parameters - by [@aryaemami59](https://togithub.com/aryaemami59) in [vitest-dev/vitest#5415 [<samp>(16bac)</samp>](https://togithub.com/vitest-dev/vitest/commit/16bacfab) - Prevent hang when `process` is mocked - by [@AriPerkkio](https://togithub.com/AriPerkkio) in [vitest-dev/vitest#5430 [<samp>(0ec4d)</samp>](https://togithub.com/vitest-dev/vitest/commit/0ec4d0e0) - Don't check for "node:internal/console/" in console interceptor in case the environment is not Node.js - by [@sheremet-va](https://togithub.com/sheremet-va) [<samp>(87d36)</samp>](https://togithub.com/vitest-dev/vitest/commit/87d36a7a) - The value received by toMatch should be a string - by [@btea](https://togithub.com/btea) in [vitest-dev/vitest#5428 [<samp>(67485)</samp>](https://togithub.com/vitest-dev/vitest/commit/674851ca) - Increase stack trace limit for location, don't hardcode suite position - by [@sheremet-va](https://togithub.com/sheremet-va) in [vitest-dev/vitest#5518 [<samp>(04b23)</samp>](https://togithub.com/vitest-dev/vitest/commit/04b234d1) - **benchmark**: - Run benchmark suites sequentially - by [@hi-ogawa](https://togithub.com/hi-ogawa) in [vitest-dev/vitest#5444 [<samp>(1f548)</samp>](https://togithub.com/vitest-dev/vitest/commit/1f548340) - Fix benchmark summary of single bench suite - by [@hi-ogawa](https://togithub.com/hi-ogawa) in [vitest-dev/vitest#5489 [<samp>(db981)</samp>](https://togithub.com/vitest-dev/vitest/commit/db98145f) - Table reporter for non TTY output - by [@hi-ogawa](https://togithub.com/hi-ogawa) in [vitest-dev/vitest#5484 [<samp>(bea23)</samp>](https://togithub.com/vitest-dev/vitest/commit/bea234b1) - **expect**: - Fix `toHaveBeenNthCalledWith` error message when not called - by [@hi-ogawa](https://togithub.com/hi-ogawa) in [vitest-dev/vitest#5420 [<samp>(e5253)</samp>](https://togithub.com/vitest-dev/vitest/commit/e5253de4) - **types**: - Pass correct type for suite factory - by [@sheremet-va](https://togithub.com/sheremet-va) in [vitest-dev/vitest#5437 [<samp>(26718)</samp>](https://togithub.com/vitest-dev/vitest/commit/26718eb5) - **utils**: - Fix object diff with getter only property - by [@hi-ogawa](https://togithub.com/hi-ogawa) in [vitest-dev/vitest#5466 [<samp>(366d9)</samp>](https://togithub.com/vitest-dev/vitest/commit/366d97c3) - **vite-node**: - Fix `isValidNodeImport` to check `"type": "module"` first - by [@hi-ogawa](https://togithub.com/hi-ogawa) in [vitest-dev/vitest#5416 [<samp>(6fb15)</samp>](https://togithub.com/vitest-dev/vitest/commit/6fb15280) - **vitest**: - Correctly send console events when state changes - by [@sheremet-va](https://togithub.com/sheremet-va) [<samp>(3463f)</samp>](https://togithub.com/vitest-dev/vitest/commit/3463f9bb) - Initiate FakeTimers on demand - by [@sheremet-va](https://togithub.com/sheremet-va) in [vitest-dev/vitest#5450 [<samp>(e4e93)</samp>](https://togithub.com/vitest-dev/vitest/commit/e4e939ba) - Check unhighlighted code for code frame line limit - by [@hi-ogawa](https://togithub.com/hi-ogawa) in [vitest-dev/vitest#5465 [<samp>(6ae7e)</samp>](https://togithub.com/vitest-dev/vitest/commit/6ae7eaa2) - Correctly filter by parent folder - by [@sheremet-va](https://togithub.com/sheremet-va) in [vitest-dev/vitest#5408 [<samp>(91b06)</samp>](https://togithub.com/vitest-dev/vitest/commit/91b06cce) - Close inspector immediately if run is canceled - by [@sheremet-va](https://togithub.com/sheremet-va) in [vitest-dev/vitest#5519 [<samp>(b8006)</samp>](https://togithub.com/vitest-dev/vitest/commit/b80062d7) - **workspace**: - Set CWD to config directory, allow overriding local .env - by [@sheremet-va](https://togithub.com/sheremet-va) in [vitest-dev/vitest#5476 [<samp>(d4003)</samp>](https://togithub.com/vitest-dev/vitest/commit/d4003882) ##### [View changes on GitHub](https://togithub.com/vitest-dev/vitest/compare/v1.4.0...v1.5.0) </details> --- ### Configuration 📅 **Schedule**: Branch creation - "before 5am every weekday" in timezone Europe/Berlin, Automerge - "after 10pm every weekday,before 5am every weekday" in timezone Europe/Berlin. 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Never, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/solid-design-system/solid).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

fix(benchmark): print table on non TTY output

48f762a

hi-ogawa added 4 commits April 4, 2024 18:56

chore: tweak

61655c8

refactor: simplify

b5035db

chore: struggle tsc

e33f3b5

test: add test

9ecf0c6

hi-ogawa changed the title ~~fix(benchmark): print table on non TTY output~~ fix(benchmark): table reporter for non TTY output Apr 4, 2024

hi-ogawa marked this pull request as ready for review April 4, 2024 10:41

test: tweak

c5232ba

sheremet-va previously approved these changes Apr 5, 2024

View reviewed changes

hi-ogawa dismissed sheremet-va’s stale review via 97734d9 April 6, 2024 01:32

Merge branch 'main' into fix-non-tty-bench-table

97734d9

sheremet-va merged commit bea234b into vitest-dev:main Apr 6, 2024
18 of 19 checks passed

hi-ogawa deleted the fix-non-tty-bench-table branch April 6, 2024 07:57

hi-ogawa mentioned this pull request Apr 12, 2024

feat(benchmark): support comparing benchmark result #5398

Merged

14 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(benchmark): table reporter for non TTY output #5484

fix(benchmark): table reporter for non TTY output #5484

hi-ogawa commented Apr 4, 2024 •

edited

netlify bot commented Apr 4, 2024 •

edited

sheremet-va commented Apr 5, 2024

	onTaskUpdate(packs: TaskResultPack[]) {
	if (this.isTTY)
	return
	for (const pack of packs) {
	const task = this.ctx.state.idMap.get(pack[0])
	if (task && task.type === 'test' && task.result?.state && task.result?.state !== 'run') {
	let title = ` ${getStateSymbol(task)} `

fix(benchmark): table reporter for non TTY output #5484

fix(benchmark): table reporter for non TTY output #5484

Conversation

hi-ogawa commented Apr 4, 2024 • edited

Description

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

Tests

Documentation

Changesets

netlify bot commented Apr 4, 2024 • edited

✅ Deploy Preview for fastidious-cascaron-4ded94 canceled.

sheremet-va commented Apr 5, 2024

hi-ogawa commented Apr 4, 2024 •

edited

netlify bot commented Apr 4, 2024 •

edited