report: add Util.prepareReportResult method #5766
Conversation
There was a problem hiding this comment.
Whoops, forgot to submit the review.
This LGTM, but could we not base it on #5765 for now so we can bikeshed on that one next week?
| @@ -38,6 +38,39 @@ class Util { | |||
| return `%10d${NBSP}ms`; | |||
| } | |||
|
|
|||
| /** | |||
| * | |||
There was a problem hiding this comment.
would be good to have a description, including that it returns a new copy of the results, doesn't mutate the original
| Util.rendererFormattedStrings = clone.i18n.rendererFormattedStrings; | ||
| } | ||
|
|
||
| // TODO(phulce): we all agree this is technical debt we should fix |
There was a problem hiding this comment.
this should be moved up to cover the whole function IMO :)
sure. sg
awwwwwwwww finnnnnne |
paulirish
force-pushed
the
prepareLHRmethod
branch
from
fb85d06
to
3a81c69
Compare
This comment has been minimized.
This comment has been minimized.
|
CLAs look good, thanks! |
|
|
||
| // If LHR is older (≤3.0.3), it has no locale setting. Set default. | ||
| if (!clone.configSettings.locale) { | ||
| clone.configSettings.locale = 'en-US'; |
There was a problem hiding this comment.
should this be en or do you want to fix in #5781 after this?
|
|
||
| container.textContent = ''; // Remove previous report. | ||
| container.appendChild(this._renderReport(clone)); | ||
| container.appendChild(this._renderReport(report)); | ||
|
|
||
| // put the UIStrings back into original state | ||
| ReportRenderer.updateAllUIStrings(originalUIStrings); |
There was a problem hiding this comment.
Method should be on ReportRenderer or Util, but not both :)
There was a problem hiding this comment.
It's pretty ugly that Util.prepareReportResult sets the UI strings but the caller is responsible for resetting them. Would it be acceptable to make two calls for users of this?
const report = Util.prepareReportResult(result);
Util.updateAllUIStrings(report.i18n.rendererFormattedStrings);
// ...
ReportRenderer.updateAllUIStrings(originalUIStrings);(Util.prepareReportResult would have to at least set report.i18n.rendererFormattedStrings to a default empty object or the original UIStrings).
I guess on the other hand both proposed refactors have the string setting handled for the user of Util.prepareReportResult, so maybe it's fine to be ugly for now.
| @@ -40,30 +40,17 @@ class ReportRenderer { | |||
| } | |||
|
|
|||
| /** | |||
| * @param {LH.ReportResult} report | |||
| * @param {LH.ReportResult} result | |||
There was a problem hiding this comment.
really should be @param {LH.Result} result
paulirish
force-pushed
the
prepareLHRmethod
branch
from
7b675e3
to
4aa73f7
Compare
wdyt
currently depends on #5765