Make bindReporter generic over metric type
#359
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
brendankenny
commented
Jun 16, 2023
| @@ -27,8 +26,8 @@ let interactionCountEstimate = 0; | |||
| let minKnownInteractionId = Infinity; | |||
| let maxKnownInteractionId = 0; | |||
|
|
|||
| const updateEstimate = (entries: Metric['entries']) => { | |||
| (entries as PerformanceEventTiming[]).forEach((e) => { | |||
| const updateEstimate = (entries: PerformanceEventTiming[]) => { | |||
There was a problem hiding this comment.
observe() checks the callback type, might as well trust it :)
| @@ -66,9 +65,8 @@ export const onCLS = (onReport: CLSReportCallback, opts?: ReportOpts) => { | |||
| let report: ReturnType<typeof bindReporter>; | |||
|
|
|||
| let sessionValue = 0; | |||
| let sessionEntries: PerformanceEntry[] = []; | |||
| let sessionEntries: LayoutShift[] = []; | |||
There was a problem hiding this comment.
minor type bug that's an explicit error now with these changes (on sessionEntries.push(entry) below), but no functional change
| import type {FIDMetric} from './fid.js'; | ||
| import type {INPMetric} from './inp.js'; | ||
| import type {LCPMetric} from './lcp.js'; | ||
| import type {TTFBMetric} from './ttfb.js'; |
There was a problem hiding this comment.
import type vs import here doesn't change anything in the output since these files (currently) have only types in them, but generally good to be explicit that the circular dependency is purely in type-space and so won't ever be an issue
tunetheweb
reviewed
Jun 19, 2023
tunetheweb
reviewed
Jun 20, 2023
philipwalton
approved these changes
Jun 22, 2023
brendankenny
force-pushed
the
generic-bind-reporter
branch
from
581705c
to
591e059
Compare
tunetheweb
changed the title
bindReporter generic over metric type
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.
Can land after #356
Parameterizes the
bindReportertype on themetricpassed in so that thecallbackcan now be typed specifically for that metric (e.g. a result forCLSMetricmust be using aCLSReportCallback).This required
initMetricto be parameterized similarly, so the returned metric type is now based on the metricnamepassed in.The main change required was using a union of the metric types wherever the base
Metricinterface is currently used. This leaves most uses of it unchanged, but allows narrowing to which specific metric is being used based on thenameproperty.I renamed the existing
Metricto beMetricBaseand named the unionMetricto keep the uses of it unchanged, but if someone has better naming suggestions, changing is no problem :)