Generic type for StatsDClient to accept restrictions #2743
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
It is often useful to be able to create a StatsDClient that has a
well-defined Stat type parameter that restricts the types of stat that
can be emitted. This allows us to create a list of allowed metrics in a
single place and ensure that we're not emitting any others.
This preserves the existing behaviour by defaulting to string, but
allows the creation of a StatsDClient parameterized with a string union
or string enum to restrict to a subset.
For example
```
const client = new StatsDClient<'foo' | 'bar'>(...);
client.increment('foo', 1); // valid
client.increment('bar', 1); // valid
client.increment('baz', 1); // invalid
```
mattkubej
approved these changes
Mar 28, 2024
|
/snapit |
|
🫰✨ Thanks @ryanwilsonperkin! Your snapshots have been published to npm. Test the snapshots by updating your yarn add @shopify/koa-metrics@0.0.0-snapshot-20240401130529yarn add @shopify/koa-performance@0.0.0-snapshot-20240401130529yarn add @shopify/statsd@0.0.0-snapshot-20240401130529 |
Default to the parent's type for Stat, but allow an override so that a child client can be passed a different set of stats to use.
|
/snapit |
|
🫰✨ Thanks @ryanwilsonperkin! Your snapshots have been published to npm. Test the snapshots by updating your yarn add @shopify/koa-metrics@0.0.0-snapshot-20240401141052yarn add @shopify/koa-performance@0.0.0-snapshot-20240401141052yarn add @shopify/statsd@0.0.0-snapshot-20240401141052 |
emiryy
approved these changes
Apr 1, 2024
Merged
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.
Description
It is often useful to be able to create a StatsDClient that has a well-defined Stat type parameter that restricts the types of stat that can be emitted. This allows us to create a list of allowed metrics in a single place and ensure that we're not emitting any others.
This preserves the existing behaviour by defaulting to string, but allows the creation of a StatsDClient parameterized with a string union or string enum to restrict to a subset.
For example