firefox-devtools/profiler

Fix the types of some of the ProfilerOverheadStats object fields

Ouverte

#2 856 ouverte le 8 oct. 2020

Voir sur GitHubGuide contributeur
 (23 commentaires) (0 réaction) (0 personne assignée)TypeScript (486 forks)auto 404
code maintenancehelp wantedready

Métriques du dépôt

Stars
 (1 515 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Étudiez les définitions de type existantes dans src/types/profile.js, comprenez les types Microseconds et Percentage, puis mettez à jour le type OverheadStats en conséquence. Exécutez yarn flow et yarn lint js pour vérifier.
Stack technique
typescript
Domaine
performance
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Gitjavascript
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65