firefox-devtools/profiler

Fix the types of some of the ProfilerOverheadStats object fields

Open

#2,856 opened on Oct 8, 2020

View on GitHubContributor guide
 (23 comments) (0 reactions) (0 assignees)TypeScript (486 forks)auto 404
code maintenancehelp wantedready

Repository metrics

Stars
 (1,515 stars)
PR merge metrics
 (PR metrics pending)

Description

We have a type for Overhead statistics, and all its values are Microseconds right now: https://github.com/firefox-devtools/profiler/blob/dcb8c42af81c7ee6f14c1fa5be9881dc5d03c115/src/types/profile.js#L459-L482

But some of it's values are not actually Microseconds. For example samplingCount is just a number and overheadPercentage is a percentage. So we should fix these types to reflect the actual values. For percentage, since we don't have a Percentage type, we need to create that type under the InnerWindowID and will look pretty similar since it's also going to use the number esentially: https://github.com/firefox-devtools/profiler/blob/dcb8c42af81c7ee6f14c1fa5be9881dc5d03c115/src/types/profile.js#L31

After making these changes, you should make sure flow and linter is happy by running yarn flow and yarn lint-js.

┆Issue is synchronized with this Jira Task

Contributor guide

Research direction
Study the existing type definitions in src/types/profile.js, understand the Microseconds and Percentage types, then update the OverheadStats type accordingly. Run yarn flow and yarn lint js to verify.
Tech stack
typescript
Domain
performance
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Gitjavascript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65