Skip to content

Add the minute and hour units for duration formats #4621

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
julienw merged 2 commits into from
May 16, 2023
Merged

Add the minute and hour units for duration formats #4621

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
39f1162
Add the minute and hour units for duration formats (eg. profile range…
fqueze May 16, 2023
e55df6d
Merge branch 'main' into range-time-units
julienw May 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/test/unit/marker-schema.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,7 @@ describe('marker schema formatting', function () {
['duration', 10],
['duration', 12.3456789],
['duration', 123456.789],
['duration', 123456789],
['duration', 0.000123456],
['time', 12.3456789],
['seconds', 0],
Expand Down Expand Up @@ -250,7 +251,8 @@ describe('marker schema formatting', function () {
"duration - 0s",
"duration - 10ms",
"duration - 12.346ms",
"duration - 123.46s",
"duration - 2.06min",
"duration - 34.3h",

@julienw julienw May 16, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for the tests!

"duration - 123.46ns",
"time - 12.346ms",
"seconds - 0.000s",
Expand Down
44 changes: 43 additions & 1 deletion src/utils/format-numbers.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,13 +244,55 @@ export function formatSeconds(
);
}

export function formatMinutes(
time: Milliseconds,
significantDigits: number = 5,
maxFractionalDigits: number = 2
) {
return (
formatNumber(
time / (60 * 1000),
significantDigits,
Math.min(2, maxFractionalDigits)
) + 'min'
);
}

export function formatHours(
time: Milliseconds,
significantDigits: number = 5,
maxFractionalDigits: number = 1
) {
return (
formatNumber(
time / (3600 * 1000),
significantDigits,
Math.min(1, maxFractionalDigits)
) + 'h'
);
}

export function formatTimestamp(
time: Milliseconds,
significantDigits: number = 5,
maxFractionalDigits: number = 3
) {
// Format in the closest base (seconds, milliseconds, microseconds, or nanoseconds),
// Format in the closest base (hours, minutes, seconds, milliseconds, microseconds, or nanoseconds),
// to avoid cases where times are displayed with too many leading zeroes to be useful.
if (time >= 3600 * 1000) {
return formatHours(
time,
significantDigits,
Number.isInteger(time / (3600 * 1000)) ? 0 : maxFractionalDigits
);
}
if (time >= 60 * 1000) {
return formatMinutes(
time,
significantDigits,
Number.isInteger(time / (60 * 1000)) ? 0 : maxFractionalDigits
);
}
if (time >= 1000) {
return formatSeconds(
time,
Expand Down