Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Metric types for better TypeScript support #356

Merged
merged 2 commits into from Jun 22, 2023
Merged

Conversation

tunetheweb
Copy link
Member

@tunetheweb tunetheweb commented Jun 13, 2023

Fixes #351
Fixes #358

It appears you can't just change a type of an interface in Typescript by repeating it.

This PR uses Omit to completely replace the metric value, but then has to do an assertion for ReportCall of the more specific metric XXXReportCall type to the generic ReportCall type.

@jantimon
Copy link

fixes #358

src/types/cls.ts Outdated Show resolved Hide resolved
src/types/cls.ts Outdated Show resolved Hide resolved
// Set defaults
opts = opts || {};

let metric = initMetric('TTFB');
let report = bindReporter(
onReport,
onReport as ReportCallback,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is probably fine for now since this is internal code...

...but if we're going to be exporting metric-specific versions of all of these types, it seems like ideally we would be able to make the bindReporter() function understand those types as well. E.g. something similar to what we do here:

export const observe = <K extends keyof PerformanceEntryMap>(
type: K,
callback: (entries: PerformanceEntryMap[K]) => void,
opts?: PerformanceObserverInit
): PerformanceObserver | undefined => {

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I couldn't figure out a way to do this as the metrics are not the same (particularly attribution has an extra attribution attribute). But open to pointers here.

Also, unlike in the observe example (where the specific type had to be passed on to the observer), we're treating all the metrics the same in bindreporter, so seemed easier to just assert this as a ReportCallback type and not treat them as the 12 individual types (6 metrics, and 6 metrics with attribution).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gotcha. I think it may be possible, but I don't think it's worth spending time figuring out so 👍

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, it's the mismatch between the specific callbacks for the on* methods (e.g. TTFBReportCallback for onTTFB()), and the fact that bindReporter() currently requires its onReport to be able to handle any of the metrics (which e.g. TTFBReportCallback purposefully doesn't) that you get the type error and the need for the type assertion.

I'm happy to take a stab at parameterizing bindReporter after this PR lands. Because bindReporter truly doesn't care about the handler internally, it should be relatively disruption-free type rearranging (and I believe should streamline some metric type stuff at the same time).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR in #359

@tunetheweb tunetheweb changed the title Type fix by using Omit Metric type fixes Jun 22, 2023
@tunetheweb tunetheweb merged commit 5973d51 into main Jun 22, 2023
2 checks passed
@tunetheweb tunetheweb changed the title Metric type fixes Fix Metric types for better TypeScript support Jul 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

why does onCLS return non CLS metrics? 3.3.2: type errors using attribution callbacks
4 participants