mirror/pnpm
1
0
Fork 0
mirror of https://github.com/pnpm/pnpm.git synced 2025-12-26 16:48:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

feat(cli-output): harmonize download progress out (#6902)

Browse Source 
When running the CLI, downloads will show their progress,
e.g. `1.12 MB/ 3 MB`, showing only significant digits.

As the output is constantly updated, the length of the line in the
output might constantly change (2.99 -> 3 -> 3.3 -> 3.33), leading
to a visually very noisy display.

close #6901

---------

Co-authored-by: Zoltan Kochan <z@kochan.io>
This commit is contained in:
Felix Wolfsteller
2023-08-04 03:08:28 +02:00
committed by GitHub
parent c5fbdb55c2
commit 8a4dac63c3
3 changed files with 19 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
.changeset/new-windows-drum.md Normal file
View File

@@ -0,0 +1,6 @@
---
"@pnpm/default-reporter": patch
"pnpm": patch
---
When showing the download progress of big tarball files, always display the same number of digits after the dot [#6902](https://github.com/pnpm/pnpm/issues/6901).

8
cli/default-reporter/src/reporterForClient/reportBigTarballsProgress.ts
View File

@@ -8,6 +8,10 @@ import {
} from './outputConstants'
const BIG_TARBALL_SIZE = 1024 * 1024 * 5 // 5 MB
const PRETTY_OPTS = {
minimumFractionDigits: 2,
maximumFractionDigits: 2,
}
export function reportBigTarballProgress (
log$: {
@@ -22,14 +26,14 @@ export function reportBigTarballProgress (
log.attempt === 1
),
map((startedLog: FetchingProgressLog) => {
const size = prettyBytes(startedLog['size'])
const size = prettyBytes(startedLog['size'], PRETTY_OPTS)
return log$.fetchingProgress.pipe(
filter((log: FetchingProgressLog) => log.status === 'in_progress' && log.packageId === startedLog['packageId']),
map((log: FetchingProgressLog) => log['downloaded']),
startWith(0),
map((downloadedRaw: number) => {
const done = startedLog['size'] === downloadedRaw
const downloaded = prettyBytes(downloadedRaw)
const downloaded = prettyBytes(downloadedRaw, PRETTY_OPTS)
return {
fixed: !done,
msg: `Downloading ${hlPkgId(startedLog['packageId'])}: ${hlValue(downloaded)}/${hlValue(size)}${done ? ', done' : ''}`,

14
cli/default-reporter/test/reportingProgress.ts
View File

@@ -363,29 +363,29 @@ test('prints progress of big files download', (done) => {
case 1:
expect(output).toBe(`\
Progress: resolved ${hlValue('1')}, reused ${hlValue('0')}, downloaded ${hlValue('0')}, added ${hlValue('0')}
Downloading ${hlPkgId(pkgId1)}: ${hlValue('0 B')}/${hlValue('10.5 MB')}`)
Downloading ${hlPkgId(pkgId1)}: ${hlValue('0.00 B')}/${hlValue('10.49 MB')}`)
return
case 2:
expect(output).toBe(`\
Progress: resolved ${hlValue('1')}, reused ${hlValue('0')}, downloaded ${hlValue('0')}, added ${hlValue('0')}
Downloading ${hlPkgId(pkgId1)}: ${hlValue('5.77 MB')}/${hlValue('10.5 MB')}`)
Downloading ${hlPkgId(pkgId1)}: ${hlValue('5.77 MB')}/${hlValue('10.49 MB')}`)
return
case 4:
expect(output).toBe(`\
Progress: resolved ${hlValue('2')}, reused ${hlValue('0')}, downloaded ${hlValue('0')}, added ${hlValue('0')}
Downloading ${hlPkgId(pkgId1)}: ${hlValue('7.34 MB')}/${hlValue('10.5 MB')}`)
Downloading ${hlPkgId(pkgId1)}: ${hlValue('7.34 MB')}/${hlValue('10.49 MB')}`)
return
case 7:
expect(output).toBe(`\
Progress: resolved ${hlValue('3')}, reused ${hlValue('0')}, downloaded ${hlValue('0')}, added ${hlValue('0')}
Downloading ${hlPkgId(pkgId1)}: ${hlValue('7.34 MB')}/${hlValue('10.5 MB')}
Downloading ${hlPkgId(pkgId3)}: ${hlValue('19.9 MB')}/${hlValue('21 MB')}`)
Downloading ${hlPkgId(pkgId1)}: ${hlValue('7.34 MB')}/${hlValue('10.49 MB')}
Downloading ${hlPkgId(pkgId3)}: ${hlValue('19.92 MB')}/${hlValue('20.97 MB')}`)
return
case 8:
expect(output).toBe(`\
Downloading ${hlPkgId(pkgId1)}: ${hlValue('10.5 MB')}/${hlValue('10.5 MB')}, done
Downloading ${hlPkgId(pkgId1)}: ${hlValue('10.49 MB')}/${hlValue('10.49 MB')}, done
Progress: resolved ${hlValue('3')}, reused ${hlValue('0')}, downloaded ${hlValue('0')}, added ${hlValue('0')}
Downloading ${hlPkgId(pkgId3)}: ${hlValue('19.9 MB')}/${hlValue('21 MB')}`)
Downloading ${hlPkgId(pkgId3)}: ${hlValue('19.92 MB')}/${hlValue('20.97 MB')}`)
return // eslint-disable-line
}
})