-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
feat(core)!: Remove standalone Client
interface & deprecate BaseClient
#14800
base: develop
Are you sure you want to change the base?
Conversation
Instead this now is based on the `BaseClient` class.
size-limit report 📦
|
* @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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Was this typed incorrectly before?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes! It differed between here and the type interface 😬
This PR renames the
BaseClient
class toClient
, makes theClientOptions
optional onClient
.It keeps a deprecated
BaseClient
alias around, we can remove that in v9 (it does not really hurt to keep it too much, IMHO).Closes #9840