feat(core)!: Remove standalone Client interface & deprecate BaseClient (#14800)

This PR renames the `BaseClient` class to `Client`, makes the
`ClientOptions` optional on `Client`.
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

Author: mydea

docs/migration/v8-to-v9.md

@@ -221,6 +221,7 @@ Since v9, the types have been merged into `@sentry/core`, which removed some of
 - The `Request` type has been removed. Use `RequestEventData` type instead.
 - The `IntegrationClass` type is no longer exported - it was not used anymore. Instead, use `Integration` or `IntegrationFn`.
 - The `samplingContext.request` attribute in the `tracesSampler` has been removed. Use `samplingContext.normalizedRequest` instead. Note that the type of `normalizedRequest` differs from `request`.
+- `Client` now always expects the `BaseClient` class - there is no more abstract `Client` that can be implemented! Any `Client` class has to extend from `BaseClient`.
 
 # No Version Support Timeline
 

packages/browser-utils/test/utils/TestClient.ts

@@ -1,4 +1,4 @@
-import { BaseClient, createTransport, initAndBind } from '@sentry/core';
+import { Client, createTransport, initAndBind } from '@sentry/core';
 import { resolvedSyncPromise } from '@sentry/core';
 import type {
   BrowserClientReplayOptions,
@@ -10,7 +10,7 @@ import type {
 
 export interface TestClientOptions extends ClientOptions, BrowserClientReplayOptions {}
 
-export class TestClient extends BaseClient<TestClientOptions> {
+export class TestClient extends Client<TestClientOptions> {
   public constructor(options: TestClientOptions) {
     super(options);
   }

packages/browser/src/client.ts

@@ -9,7 +9,7 @@ import type {
   Scope,
   SeverityLevel,
 } from '@sentry/core';
-import { BaseClient, applySdkMetadata, getSDKSource } from '@sentry/core';
+import { Client, applySdkMetadata, getSDKSource } from '@sentry/core';
 import { eventFromException, eventFromMessage } from './eventbuilder';
 import { WINDOW } from './helpers';
 import type { BrowserTransportOptions } from './transports/types';
@@ -58,7 +58,7 @@ export type BrowserClientOptions = ClientOptions<BrowserTransportOptions> &
  * @see BrowserOptions for documentation on configuration options.
  * @see SentryClient for usage documentation.
  */
-export class BrowserClient extends BaseClient<BrowserClientOptions> {
+export class BrowserClient extends Client<BrowserClientOptions> {
   /**
    * Creates a new Browser SDK instance.
    *

packages/core/src/asyncContext/stackStrategy.ts

@@ -1,6 +1,6 @@
+import type { Client } from '../client';
 import { getDefaultCurrentScope, getDefaultIsolationScope } from '../defaultScopes';
 import { Scope } from '../scope';
-import type { Client } from '../types-hoist';
 import { isThenable } from '../utils-hoist/is';
 import { getMainCarrier, getSentryCarrier } from './../carrier';
 import type { AsyncContextStrategy } from './types';

packages/core/src/baseclient.ts renamed to packages/core/src/client.ts

@@ -2,7 +2,7 @@
 import type {
   Breadcrumb,
   BreadcrumbHint,
-  Client,
+  CheckIn,
   ClientOptions,
   DataCategory,
   DsnComponents,
@@ -15,6 +15,7 @@ import type {
   EventProcessor,
   FeedbackEvent,
   Integration,
+  MonitorConfig,
   Outcome,
   ParameterizedString,
   SdkMetadata,
@@ -71,7 +72,7 @@ const MISSING_RELEASE_FOR_SESSION_ERROR = 'Discarded session because of missing
  * without a valid Dsn, the SDK will not send any events to Sentry.
  *
  * Before sending an event, it is passed through
- * {@link BaseClient._prepareEvent} to add SDK information and scope data
+ * {@link Client._prepareEvent} to add SDK information and scope data
  * (breadcrumbs and context). To add more custom information, override this
  * method and extend the resulting prepared event.
  *
@@ -81,15 +82,15 @@ const MISSING_RELEASE_FOR_SESSION_ERROR = 'Discarded session because of missing
  * {@link Client.addBreadcrumb}.
  *
  * @example
- * class NodeClient extends BaseClient<NodeOptions> {
+ * class NodeClient extends Client<NodeOptions> {
  *   public constructor(options: NodeOptions) {
  *     super(options);
  *   }
  *
  *   // ...
  * }
  */
-export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
+export abstract class Client<O extends ClientOptions = ClientOptions> {
   /** Options passed to the SDK. */
   protected readonly _options: O;
 
@@ -234,6 +235,17 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
     updateSession(session, { init: false });
   }
 
+  /**
+   * Create a cron monitor check in and send it to Sentry. This method is not available on all clients.
+   *
+   * @param checkIn An object that describes a check in.
+   * @param upsertMonitorConfig An optional object that describes a monitor config. Use this if you want
+   * to create a monitor automatically when sending a check in.
+   * @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;
+
   /**
    * @inheritDoc
    */
@@ -443,7 +455,7 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
   /** @inheritdoc */
   public on(
     hook: 'beforeSendFeedback',
-    callback: (feedback: FeedbackEvent, options?: { includeReplay: boolean }) => void,
+    callback: (feedback: FeedbackEvent, options?: { includeReplay?: boolean }) => void,
   ): () => void;
 
   /** @inheritdoc */
@@ -538,7 +550,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;
 
   /** @inheritdoc */
   public emit(
@@ -946,6 +958,16 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
   ): PromiseLike<Event>;
 }
 
+/**
+ * @deprecated Use `Client` instead. This alias may be removed in a future major version.
+ */
+export type BaseClient = Client;
+
+/**
+ * @deprecated Use `Client` instead. This alias may be removed in a future major version.
+ */
+export const BaseClient = Client;
+
 /**
  * Verifies that return value of configured `beforeSend` or `beforeSendTransaction` is of expected type, and returns the value if so.
  */

packages/core/src/currentScopes.ts

@@ -1,7 +1,8 @@
 import { getAsyncContextStrategy } from './asyncContext';
 import { getGlobalSingleton, getMainCarrier } from './carrier';
+import type { Client } from './client';
 import { Scope } from './scope';
-import type { Client, TraceContext } from './types-hoist';
+import type { TraceContext } from './types-hoist';
 import { dropUndefinedKeys } from './utils-hoist/object';
 
 /**

packages/core/src/envelope.ts

@@ -1,7 +1,7 @@
+import type { Client } from './client';
 import { getDynamicSamplingContextFromSpan } from './tracing/dynamicSamplingContext';
 import type { SentrySpan } from './tracing/sentrySpan';
 import type {
-  Client,
   DsnComponents,
   DynamicSamplingContext,
   Event,

packages/core/src/exports.ts

@@ -1,3 +1,7 @@
+import { getClient, getCurrentScope, getIsolationScope, withIsolationScope } from './currentScopes';
+import { DEBUG_BUILD } from './debug-build';
+import type { CaptureContext } from './scope';
+import { closeSession, makeSession, updateSession } from './session';
 import type {
   CheckIn,
   Event,
@@ -13,11 +17,6 @@ import type {
   SeverityLevel,
   User,
 } from './types-hoist';
-
-import { getClient, getCurrentScope, getIsolationScope, withIsolationScope } from './currentScopes';
-import { DEBUG_BUILD } from './debug-build';
-import type { CaptureContext } from './scope';
-import { closeSession, makeSession, updateSession } from './session';
 import { isThenable } from './utils-hoist/is';
 import { logger } from './utils-hoist/logger';
 import { uuid4 } from './utils-hoist/misc';

packages/core/src/fetch.ts

@@ -1,8 +1,9 @@
+import type { Client } from './client';
 import type { Scope } from './scope';
 import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from './semanticAttributes';
 import { SPAN_STATUS_ERROR, setHttpStatus, startInactiveSpan } from './tracing';
 import { SentryNonRecordingSpan } from './tracing/sentryNonRecordingSpan';
-import type { Client, HandlerDataFetch, Span, SpanOrigin } from './types-hoist';
+import type { HandlerDataFetch, Span, SpanOrigin } from './types-hoist';
 import { SENTRY_BAGGAGE_KEY_PREFIX } from './utils-hoist/baggage';
 import { isInstanceOf } from './utils-hoist/is';
 import { parseUrl } from './utils-hoist/url';

packages/core/src/getCurrentHubShim.ts

@@ -1,4 +1,5 @@
 import { addBreadcrumb } from './breadcrumbs';
+import type { Client } from './client';
 import { getClient, getCurrentScope, getIsolationScope, withScope } from './currentScopes';
 import {
   captureEvent,
@@ -12,7 +13,7 @@ import {
   setUser,
   startSession,
 } from './exports';
-import type { Client, EventHint, Hub, Integration, SeverityLevel } from './types-hoist';
+import type { EventHint, Hub, Integration, SeverityLevel } from './types-hoist';
 
 /**
  * This is for legacy reasons, and returns a proxy object instead of a hub to be used.