GoogleChrome/lighthouse

runWarnings format difficult for pragmatic usage

Open

#11352 opened on Sep 1, 2020

View on GitHub
 (4 comments) (0 reactions) (0 assignees)JavaScript (27,768 stars) (9,278 forks)batch import
P3breakinggood first issue

Description

I have two concerns with runWarnings specifically around pragmatic usage:

  • runWarnings contains both errors (eg, page hung / non-successful request on main document resource) and warnings (eg, CPU throttling might be bad)
  • The errors and warnings contained within runWarnings are strings. There's no handle to be able to identify one warning/error from another, without searching the string.

Feature request summary

runWarnings to be changed to an object. It should contain code and message. Just like runtimeError.

What is the motivation or use case for changing this?

Node.js/API/PageSpeed users of Lighthouse will be able to handle errors/warnings reliably.

Contributor guide

Tech stack
javascriptnodejs
Domain
apideveloper experiencetooling
Issue type
feature
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with LighthouseJavaScriptNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Locate where `runWarnings` is generated in the Lighthouse codebase (likely in the report or gathering phase). Currently it is an array of strings; modify it to output an array of objects with `code` and `message` fields, similar to `runtimeError`. Update any consumers of `runWarnings` to handle the new format, and ensure tests pass.