feat(core)!: Remove standalone Client interface & deprecate BaseClient
#14800
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
size-limit report 📦
|
AbhiPrasad
reviewed
Dec 19, 2024
| * @param scope An optional scope containing event metadata. | ||
| * @returns A string representing the id of the check in. | ||
| */ | ||
| public captureCheckIn?(checkIn: CheckIn, monitorConfig?: MonitorConfig, scope?: Scope): string; |
There was a problem hiding this comment.
I think we intentionally didn't add this to BaseClient, only to the ServerRuntimeClient so that check-in stays server-side specific.
Why did we make this change here?
There was a problem hiding this comment.
This was in the type of Client. I merged this in as a type, but it is still optional! So not every client has to implement this method. I think that means nothing effectively should change?
| @@ -547,7 +559,7 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> { | |||
| public emit(hook: 'createDsc', dsc: DynamicSamplingContext, rootSpan?: Span): void; | |||
|
|
|||
| /** @inheritdoc */ | |||
| public emit(hook: 'beforeSendFeedback', feedback: FeedbackEvent, options?: { includeReplay: boolean }): void; | |||
| public emit(hook: 'beforeSendFeedback', feedback: FeedbackEvent, options?: { includeReplay?: boolean }): void; | |||
There was a problem hiding this comment.
Was this typed incorrectly before?
There was a problem hiding this comment.
yes! It differed between here and the type interface 😬
chargome
approved these changes
Jan 3, 2025
Lms24
approved these changes
Jan 3, 2025
AbhiPrasad
approved these changes
Jan 3, 2025
Instead this now is based on the `BaseClient` class. feat(core)!: Remove standalone `Client` interface & deprecate `BaseClient`
mydea
added a commit
that referenced
this pull request
Jan 10, 2025
mydea
added a commit
that referenced
this pull request
Jan 13, 2025
From #14800 I noticed I totally forgot to migrate the jsdoc comments from the types to the class, oops!
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.
This PR renames the
BaseClientclass toClient, makes theClientOptionsoptional onClient.It keeps a deprecated
BaseClientalias around, we can remove that in v9 (it does not really hurt to keep it too much, IMHO).Closes #9840