core: rename diagnostics to debugData #8298
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
patrickhulce
requested review from
brendankenny,
exterkamp and
paulirish
as code owners
exterkamp
reviewed
Apr 15, 2019
8 tasks
| @@ -63,11 +63,11 @@ class AxeAudit extends Audit { | |||
| {key: 'node', itemType: 'node', text: str_(UIStrings.failingElementsHeader)}, | |||
| ]; | |||
|
|
|||
| /** @type {LH.Audit.Details.Diagnostic|undefined} */ | |||
| /** @type {LH.Audit.Details.DebugData|undefined} */ | |||
| let diagnostic; | |||
types/audit-details.d.ts
Outdated
| @@ -51,7 +51,7 @@ declare global { | |||
| overallSavingsBytes?: number; | |||
| headings: OpportunityColumnHeading[]; | |||
| items: OpportunityItem[]; | |||
| diagnostic?: Diagnostic; | |||
| diagnostic?: DebugData; | |||
There was a problem hiding this comment.
I think all these diagnostic need to be renamed?
There was a problem hiding this comment.
yeah fo sho, didn't expect the first name go around to be accepted :D
| /** @type {LH.Audit.Details.Diagnostic|undefined} */ | ||
| let diagnostic; | ||
| /** @type {LH.Audit.Details.DebugData|undefined} */ | ||
| let debugData; |
There was a problem hiding this comment.
just debug?
edit: or keep as debugData, see below
types/audit-details.d.ts
Outdated
| export interface Diagnostic { | ||
| type: 'diagnostic'; | ||
| export interface DebugData { | ||
| type: 'debug'; |
There was a problem hiding this comment.
if we go with type DebugData maybe this string should be debugdata and the property name debugData?
It's a little confusing having both debug and debugData as reasonable local variable names
There was a problem hiding this comment.
agreed, debugdata SGTM :)
|
name wfm. 👍 |
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
All the data here is essentially used for debugging, so
debugDataseems fair.metricsaudit is probably the one exception where I'd expect folks to be explicitly relying on this for presentation, so I'm not sure what to do there. OTOH I also don't feel particularly strongly it needs to be renamed away fromdiagnosticssince neither of them describe how it's being used inmetrics:)Related Issues/PRs
No issue was filed specifically, so it can't be closed yet! ;)
#7752