Skip to content

Display nicer time units in the timeline ruler for values that are be… #4774

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
fqueze merged 1 commit into from
Oct 12, 2023
Merged

Display nicer time units in the timeline ruler for values that are be… #4774

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
52 changes: 37 additions & 15 deletions src/components/timeline/Ruler.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

import React, { PureComponent } from 'react';
import { TIMELINE_RULER_HEIGHT } from 'firefox-profiler/app-logic/constants';
import { formatTimestamp } from 'firefox-profiler/utils/format-numbers';

import './Ruler.css';

Expand All @@ -19,45 +20,66 @@ type Props = {|
|};

export class TimelineRuler extends PureComponent<Props> {
_findNiceNumberGreaterOrEqualTo(uglyNumber: number) {
_findNiceNumberGreaterOrEqualTo(uglyNumber: Milliseconds) {
// Special case numbers in the seconds, minutes or hour ranges.
if (uglyNumber > 10000 && uglyNumber <= 48 * 3600 * 1000) {
for (const seconds of [15, 20, 30]) {
const number = seconds * 1000;
if (uglyNumber <= number) {
return number;
}
}
for (const minutes of [1, 2, 5, 10, 15, 20, 30]) {
const number = minutes * 60 * 1000;
if (uglyNumber <= number) {
return number;
}
}
for (const hours of [1, 2, 3, 4, 6, 8, 12, 24, 48]) {
const number = hours * 3600 * 1000;
if (uglyNumber <= number) {
return number;
}
}
Comment on lines +26 to +43

@julienw julienw Oct 12, 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.

Maybe I'm missing something, but it looks like we could just return number here instead of doing all these loops? Indeed you're not returning anything specific from the loops and the various conditions...

@fqueze fqueze Oct 12, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The point of these loops is to decide which value to assign in the 'number' variable. The possible values for 'number' are pre-defined by the values in the arrays. Then the first 'number' value that's < ugglyNumber is what we keep (ie. return).

}

// Write uglyNumber as a * 10^b, with 1 <= a < 10.
// Return the lowest of 2 * 10^b, 5 * 10^b, 10 * 10^b that is greater or equal to uglyNumber.
const b = Math.floor(Math.log10(uglyNumber));
if (uglyNumber <= 2 * Math.pow(10, b)) {
return { number: 2 * Math.pow(10, b), exponent: b };
return 2 * Math.pow(10, b);
}
if (uglyNumber <= 5 * Math.pow(10, b)) {
return { number: 5 * Math.pow(10, b), exponent: b };
return 5 * Math.pow(10, b);
}
return { number: Math.pow(10, b + 1), exponent: b + 1 };
return Math.pow(10, b + 1);
}

_getNotches() {
if (this.props.width === 0) {
return { notches: [], decimalPlaces: 0 };
return { notches: [], notchTime: 0 };
}

const { zeroAt, rangeStart, rangeEnd, width } = this.props;
const pixelsPerMilliSecond = width / (rangeEnd - rangeStart);
const minimumNotchWidth = 55; // pixels
const { number: notchTime, exponent } =
this._findNiceNumberGreaterOrEqualTo(
minimumNotchWidth / pixelsPerMilliSecond
);
const notchTime = this._findNiceNumberGreaterOrEqualTo(
minimumNotchWidth / pixelsPerMilliSecond
);
const firstNotchIndex = Math.ceil((rangeStart - zeroAt) / notchTime);
const lastNotchIndex = Math.floor((rangeEnd - zeroAt) / notchTime);
const notches = [];
for (let i = firstNotchIndex; i <= lastNotchIndex; i++) {
notches.push({
time: (i * notchTime) / 1000,
time: i * notchTime,
pos: (i * notchTime - (rangeStart - zeroAt)) * pixelsPerMilliSecond,
});
}
return { notches, decimalPlaces: Math.max(0, -(exponent - 3)) };
return { notches, notchTime };
}

render() {
const { notches, decimalPlaces } = this._getNotches();
const { notches, notchTime } = this._getNotches();
return (
<div
className="timelineRuler"
Expand All @@ -70,9 +92,9 @@ export class TimelineRuler extends PureComponent<Props> {
key={i}
style={{ left: `${pos}px` }}
>
<span className="timelineRulerNotchText">{`${time.toFixed(
decimalPlaces
)}s`}</span>
<span className="timelineRulerNotchText">
{formatTimestamp(time, 2, 2, notchTime)}
</span>
</li>
))}
</ol>
Expand Down
6 changes: 3 additions & 3 deletions src/test/components/__snapshots__/ActiveTabTimeline.test.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -357,7 +357,7 @@ exports[`ActiveTabTimeline should be rendered properly from the Timeline compone
<span
class="timelineRulerNotchText"
>
0.0000s
0s
</span>
</li>
<li
Expand All @@ -367,7 +367,7 @@ exports[`ActiveTabTimeline should be rendered properly from the Timeline compone
<span
class="timelineRulerNotchText"
>
0.0005s
500μs
</span>
</li>
<li
Expand All @@ -377,7 +377,7 @@ exports[`ActiveTabTimeline should be rendered properly from the Timeline compone
<span
class="timelineRulerNotchText"
>
0.0010s
1ms
</span>
</li>
</ol>
Expand Down
12 changes: 6 additions & 6 deletions src/test/components/__snapshots__/Timeline.test.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ exports[`TimelineSelection renders the vertical line indicating the time positio
<span
class="timelineRulerNotchText"
>
0.000s
0s
</span>
</li>
<li
Expand All @@ -50,7 +50,7 @@ exports[`TimelineSelection renders the vertical line indicating the time positio
<span
class="timelineRulerNotchText"
>
0.002s
2ms
</span>
</li>
<li
Expand All @@ -60,7 +60,7 @@ exports[`TimelineSelection renders the vertical line indicating the time positio
<span
class="timelineRulerNotchText"
>
0.004s
4ms
</span>
</li>
<li
Expand All @@ -70,7 +70,7 @@ exports[`TimelineSelection renders the vertical line indicating the time positio
<span
class="timelineRulerNotchText"
>
0.006s
6ms
</span>
</li>
<li
Expand All @@ -80,7 +80,7 @@ exports[`TimelineSelection renders the vertical line indicating the time positio
<span
class="timelineRulerNotchText"
>
0.008s
8ms
</span>
</li>
<li
Expand All @@ -90,7 +90,7 @@ exports[`TimelineSelection renders the vertical line indicating the time positio
<span
class="timelineRulerNotchText"
>
0.010s
10ms
</span>
</li>
</ol>
Expand Down
18 changes: 9 additions & 9 deletions src/test/unit/marker-schema.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,21 +299,21 @@ describe('marker schema formatting', function () {
"duration - 0s",
"duration - 10ms",
"duration - 12.346ms",
"duration - 2min3s",
"duration - 6h31min",
"duration - 2m3s",
"duration - 6h31m",
"duration - 50s",
"duration - 33min20s",
"duration - 13h53min",
"duration - 33m20s",
"duration - 13h53m",
"duration - 1d10h",
"duration - 123.46ns",
"duration - 59.499s",
"duration - 1min",
"duration - 1min",
"duration - 13min",
"duration - 59min59s",
"duration - 1m",
"duration - 1m",
"duration - 13m",
"duration - 59m59s",
"duration - 1h",
"duration - 1h",
"duration - 23h59min",
"duration - 23h59m",
"duration - 1d",
"duration - 1d",
"time - 12.346ms",
Expand Down
16 changes: 10 additions & 6 deletions src/utils/format-numbers.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ export function formatSeconds(
const msPerSecond = 1000;
const timeInSeconds = time / msPerSecond;
let result = '';
if (precision !== 0 && precision < msPerSecond) {
if (precision < msPerSecond) {
const exponent = Math.floor(Math.log10(precision / msPerSecond));
const digits = Math.max(0, -exponent);
result = timeInSeconds.toFixed(digits);
Expand Down Expand Up @@ -271,8 +271,8 @@ export function formatMinutes(
const seconds = time % msPerMinute;
return (
formatNumber((time - seconds) / msPerMinute, significantDigits, 0) +
'min' +
(seconds > 0 && (maxFractionalDigits > 0 || precision < msPerMinute)
'm' +
((seconds > 0 && maxFractionalDigits > 0) || precision < msPerMinute
? formatSeconds(seconds, significantDigits, 0, precision)
: '')
);
Expand All @@ -293,7 +293,7 @@ export function formatHours(
return (
formatNumber((time - minutes) / msPerHour, significantDigits, 0) +
'h' +
(minutes > 0 && (maxFractionalDigits > 0 || precision < msPerHour)
((minutes > 0 && maxFractionalDigits > 0) || precision < msPerHour
? formatMinutes(minutes, significantDigits, 0, precision)
: '')
);
Expand All @@ -314,7 +314,7 @@ export function formatDays(
return (
formatNumber((time - hours) / msPerDay, significantDigits, 0) +
'd' +
(hours > 0 && (maxFractionalDigits > 0 || precision < msPerDay)
((hours > 0 && maxFractionalDigits > 0) || precision < msPerDay
? formatHours(hours, significantDigits, 0, precision)
: '')
);
Expand All @@ -330,7 +330,11 @@ export function formatTimestamp(
if (precision !== Infinity) {
// Round the values to display nicer numbers when the extra precision
// isn't useful. (eg. show 3h52min10s instead of 3h52min14s)
precision = 10 ** Math.floor(Math.log10(precision));
// Only do this for values < 10s as after that we use time units that are
// not decimal.
if (precision < 10000) {
precision = 10 ** Math.floor(Math.log10(precision));
}
if (time > precision) {
time = Math.round(time / precision) * precision;
}
Expand Down