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

Author: mydea

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

@@ -10,7 +10,7 @@ import type {
   SeverityLevel,
   UserFeedback,
 } from '@sentry/core';
-import { BaseClient, applySdkMetadata, getSDKSource, logger } from '@sentry/core';
+import { Client, applySdkMetadata, getSDKSource, logger } from '@sentry/core';
 import { DEBUG_BUILD } from './debug-build';
 import { eventFromException, eventFromMessage } from './eventbuilder';
 import { WINDOW } from './helpers';
@@ -61,7 +61,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,4 +1,4 @@
-import type { Client } from '../baseclient';
+import type { Client } from '../client';
 import { getDefaultCurrentScope, getDefaultIsolationScope } from '../defaultScopes';
 import { Scope } from '../scope';
 import { isThenable } from '../utils-hoist/is';

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

@@ -64,33 +64,33 @@ const MISSING_RELEASE_FOR_SESSION_ERROR = 'Discarded session because of missing
  *
  * Call the constructor with the corresponding options
  * specific to the client subclass. To access these options later, use
- * {@link BaseClient.getOptions}.
+ * {@link Client.getOptions}.
  *
  * If a Dsn is specified in the options, it will be parsed and stored. Use
- * {@link BaseClient.getDsn} to retrieve the Dsn at any moment. In case the Dsn is
+ * {@link Client.getDsn} to retrieve the Dsn at any moment. In case the Dsn is
  * invalid, the constructor will throw a {@link SentryException}. Note that
  * 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.
  *
  * To issue automatically created events (e.g. via instrumentation), use
- * {@link BaseClient.captureEvent}. It will prepare the event and pass it through
+ * {@link Client.captureEvent}. It will prepare the event and pass it through
  * the callback lifecycle. To issue auto-breadcrumbs, use
- * {@link BaseClient.addBreadcrumb}.
+ * {@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> {
+export abstract class Client<O extends ClientOptions = ClientOptions> {
   /** Options passed to the SDK. */
   protected readonly _options: O;
 
@@ -960,7 +960,15 @@ export abstract class BaseClient<O extends ClientOptions> {
   ): PromiseLike<Event>;
 }
 
-export type Client<O extends ClientOptions = ClientOptions> = BaseClient<O>;
+/**
+ * @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,6 +1,6 @@
 import { getAsyncContextStrategy } from './asyncContext';
-import type { Client } from './baseclient';
 import { getGlobalSingleton, getMainCarrier } from './carrier';
+import type { Client } from './client';
 import { Scope } from './scope';
 import type { TraceContext } from './types-hoist';
 import { dropUndefinedKeys } from './utils-hoist/object';

packages/core/src/envelope.ts

@@ -1,4 +1,4 @@
-import type { Client } from './baseclient';
+import type { Client } from './client';
 import { getDynamicSamplingContextFromSpan } from './tracing/dynamicSamplingContext';
 import type { SentrySpan } from './tracing/sentrySpan';
 import type {

packages/core/src/fetch.ts

@@ -1,4 +1,4 @@
-import type { Client } from './baseclient';
+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';

packages/core/src/getCurrentHubShim.ts

@@ -1,5 +1,5 @@
-import type { Client } from './baseclient';
 import { addBreadcrumb } from './breadcrumbs';
+import type { Client } from './client';
 import { getClient, getCurrentScope, getIsolationScope, withScope } from './currentScopes';
 import {
   captureEvent,

packages/core/src/index.ts

@@ -51,8 +51,11 @@ export { Scope } from './scope';
 export type { CaptureContext, ScopeContext, ScopeData } from './scope';
 export { notifyEventProcessors } from './eventProcessors';
 export { getEnvelopeEndpointWithUrlEncodedAuth, getReportDialogEndpoint } from './api';
-export { BaseClient } from './baseclient';
-export type { Client } from './baseclient';
+export {
+  Client,
+  // eslint-disable-next-line deprecation/deprecation
+  BaseClient,
+} from './client';
 export { ServerRuntimeClient } from './server-runtime-client';
 export { initAndBind, setCurrentClient } from './sdk';
 export { createTransport } from './transports/base';

packages/core/src/integration.ts

@@ -1,4 +1,4 @@
-import type { Client } from './baseclient';
+import type { Client } from './client';
 import { getClient } from './currentScopes';
 import { DEBUG_BUILD } from './debug-build';
 import type { Event, EventHint, Integration, IntegrationFn, Options } from './types-hoist';

packages/core/src/integrations/functiontostring.ts

@@ -1,4 +1,4 @@
-import type { Client } from '../baseclient';
+import type { Client } from '../client';
 import { getClient } from '../currentScopes';
 import { defineIntegration } from '../integration';
 import type { IntegrationFn, WrappedFunction } from '../types-hoist';

packages/core/src/scope.ts

@@ -1,5 +1,5 @@
 /* eslint-disable max-lines */
-import type { Client } from './baseclient';
+import type { Client } from './client';
 import { updateSession } from './session';
 import type {
   Attachment,

packages/core/src/sdk.ts

@@ -1,4 +1,4 @@
-import type { Client } from './baseclient';
+import type { Client } from './client';
 import { getCurrentScope } from './currentScopes';
 import { DEBUG_BUILD } from './debug-build';
 import type { ClientOptions } from './types-hoist';

packages/core/src/server-runtime-client.ts

@@ -12,8 +12,8 @@ import type {
   TraceContext,
 } from './types-hoist';
 
-import { BaseClient } from './baseclient';
 import { createCheckInEnvelope } from './checkin';
+import { Client } from './client';
 import { getIsolationScope, getTraceContextFromScope } from './currentScopes';
 import { DEBUG_BUILD } from './debug-build';
 import type { Scope } from './scope';
@@ -40,7 +40,7 @@ export interface ServerRuntimeClientOptions extends ClientOptions<BaseTransportO
  */
 export class ServerRuntimeClient<
   O extends ClientOptions & ServerRuntimeClientOptions = ServerRuntimeClientOptions,
-> extends BaseClient<O> {
+> extends Client<O> {
   /**
    * Creates a new Edge SDK instance.
    * @param options Configuration options for this SDK.

packages/core/src/session.ts

@@ -38,7 +38,7 @@ export function makeSession(context?: Omit<SessionContext, 'started' | 'status'>
  * Note that this function mutates the passed object and returns void.
  * (Had to do this instead of returning a new and updated session because closing and sending a session
  * makes an update to the session after it was passed to the sending logic.
- * @see BaseClient.captureSession )
+ * @see Client.captureSession )
  *
  * @param session the `Session` to update
  * @param context the `SessionContext` holding the properties that should be updated in @param session

packages/core/src/tracing/dynamicSamplingContext.ts

@@ -1,4 +1,4 @@
-import type { Client } from '../baseclient';
+import type { Client } from '../client';
 import { DEFAULT_ENVIRONMENT } from '../constants';
 import { getClient } from '../currentScopes';
 import type { Scope } from '../scope';

packages/core/src/types-hoist/hub.ts

@@ -1,4 +1,4 @@
-import type { Client } from '../baseclient';
+import type { Client } from '../client';
 import type { Scope } from '../scope';
 import type { Breadcrumb, BreadcrumbHint } from './breadcrumb';
 import type { Event, EventHint } from './event';

packages/core/src/types-hoist/integration.ts

@@ -1,4 +1,4 @@
-import type { Client } from '../baseclient';
+import type { Client } from '../client';
 import type { Event, EventHint } from './event';
 
 /** Integration Class Interface */

packages/core/src/types-hoist/profiling.ts

@@ -1,4 +1,4 @@
-import type { Client } from '../baseclient';
+import type { Client } from '../client';
 import type { DebugImage } from './debugMeta';
 import type { Integration } from './integration';
 import type { MeasurementUnit } from './measurement';

packages/core/src/types-hoist/transport.ts

@@ -1,4 +1,4 @@
-import type { Client } from '../baseclient';
+import type { Client } from '../client';
 import type { Envelope } from './envelope';
 
 export type TransportRequest = {

packages/core/src/utils-hoist/eventbuilder.ts

@@ -1,4 +1,4 @@
-import type { Client } from '../baseclient';
+import type { Client } from '../client';
 import type {
   Event,
   EventHint,

packages/core/src/utils/isSentryRequestUrl.ts

@@ -1,4 +1,4 @@
-import type { Client } from '../baseclient';
+import type { Client } from '../client';
 import type { DsnComponents } from '../types-hoist';
 
 /**

packages/core/src/utils/prepareEvent.ts

@@ -1,4 +1,4 @@
-import type { Client } from '../baseclient';
+import type { Client } from '../client';
 import { DEFAULT_ENVIRONMENT } from '../constants';
 import { getGlobalScope } from '../currentScopes';
 import { notifyEventProcessors } from '../eventProcessors';

packages/core/test/lib/baseclient.test.ts renamed to packages/core/test/lib/client.test.ts

@@ -1,5 +1,3 @@
-import type {
-  Client} from '../../src';
 import {
   Scope,
   SentryError,
@@ -13,6 +11,7 @@ import {
   setCurrentClient,
   withMonitor,
 } from '../../src';
+import type { BaseClient, Client } from '../../src/client';
 import * as integrationModule from '../../src/integration';
 import type { Envelope, ErrorEvent, Event, TransactionEvent } from '../../src/types-hoist';
 import * as loggerModule from '../../src/utils-hoist/logger';
@@ -36,7 +35,7 @@ jest.spyOn(loggerModule, 'consoleSandbox').mockImplementation(cb => cb());
 jest.spyOn(stringModule, 'truncate').mockImplementation(str => str);
 jest.spyOn(timeModule, 'dateTimestampInSeconds').mockImplementation(() => 2020);
 
-describe('BaseClient', () => {
+describe('Client', () => {
   beforeEach(() => {
     TestClient.sendEventCalled = undefined;
     TestClient.instance = undefined;
@@ -2099,7 +2098,8 @@ describe('BaseClient', () => {
 
     // Make sure types work for both Client & BaseClient
     const scenarios = [
-      ['BaseClient', new TestClient(options)],
+      // eslint-disable-next-line deprecation/deprecation
+      ['BaseClient', new TestClient(options) as BaseClient],
       ['Client', new TestClient(options) as Client],
     ] as const;
 

packages/core/test/lib/envelope.test.ts

@@ -1,5 +1,4 @@
-import type {
-  Client} from '../../src';
+import type { Client } from '../../src';
 import {
   SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
   SentrySpan,

packages/core/test/lib/integrations/third-party-errors-filter.test.ts

@@ -1,4 +1,4 @@
-import type { Client } from '../../../src/baseclient';
+import type { Client } from '../../../src/client';
 import { thirdPartyErrorFilterIntegration } from '../../../src/integrations/third-party-errors-filter';
 import { addMetadataToStackFrames } from '../../../src/metadata';
 import type { Event } from '../../../src/types-hoist';

packages/core/test/lib/scope.test.ts

@@ -1,5 +1,4 @@
-import type {
-  Client} from '../../src';
+import type { Client } from '../../src';
 import {
   applyScopeDataToEvent,
   getCurrentScope,

packages/core/test/lib/sdk.test.ts

@@ -1,4 +1,4 @@
-import type { Client} from '../../src';
+import type { Client } from '../../src';
 import { captureCheckIn, getCurrentScope, setCurrentClient } from '../../src';
 import { installedIntegrations } from '../../src/integration';
 import { initAndBind } from '../../src/sdk';

packages/core/test/lib/utils/isSentryRequestUrl.test.ts

@@ -1,4 +1,4 @@
-import type { Client } from '../../../src/baseclient';
+import type { Client } from '../../../src/client';
 
 import { isSentryRequestUrl } from '../../../src';
 

packages/core/test/lib/utils/traceData.test.ts

@@ -1,5 +1,4 @@
-import type {
-  Client} from '../../../src/';
+import type { Client } from '../../../src/';
 import {
   SentrySpan,
   getCurrentScope,

packages/core/test/mocks/client.ts

@@ -9,7 +9,7 @@ import type {
   SeverityLevel,
 } from '../../src/types-hoist';
 
-import { BaseClient } from '../../src/baseclient';
+import { Client } from '../../src/client';
 import { initAndBind } from '../../src/sdk';
 import { createTransport } from '../../src/transports/base';
 import { resolvedSyncPromise } from '../../src/utils-hoist/syncpromise';
@@ -37,7 +37,7 @@ export interface TestClientOptions extends ClientOptions {
   defaultIntegrations?: Integration[] | false;
 }
 
-export class TestClient extends BaseClient<TestClientOptions> {
+export class TestClient extends Client<TestClientOptions> {
   public static instance?: TestClient;
   public static sendEventCalled?: (event: Event) => void;
 

packages/core/test/mocks/integration.ts

@@ -1,4 +1,4 @@
-import type { Client} from '../../src';
+import type { Client } from '../../src';
 import { getClient, getCurrentScope } from '../../src';
 import type { Event, EventProcessor, Integration } from '../../src/types-hoist';
 

packages/core/test/utils-hoist/eventbuilder.test.ts

@@ -1,4 +1,4 @@
-import type { Client } from '../../src/baseclient';
+import type { Client } from '../../src/client';
 import { eventFromMessage, eventFromUnknownInput } from '../../src/utils-hoist/eventbuilder';
 import { nodeStackLineParser } from '../../src/utils-hoist/node-stack-trace';
 import { createStackParser } from '../../src/utils-hoist/stacktrace';

packages/feedback/src/core/TestClient.ts

@@ -1,12 +1,12 @@
 import type { BrowserClientReplayOptions, ClientOptions, Event, SeverityLevel } from '@sentry/core';
-import { BaseClient, createTransport, initAndBind, resolvedSyncPromise } from '@sentry/core';
+import { Client, createTransport, initAndBind, resolvedSyncPromise } from '@sentry/core';
 
 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/opentelemetry/src/custom/client.ts

@@ -1,7 +1,7 @@
 import type { Tracer } from '@opentelemetry/api';
 import { trace } from '@opentelemetry/api';
 import type { BasicTracerProvider } from '@opentelemetry/sdk-trace-base';
-import type { BaseClient, Client } from '@sentry/core';
+import type { Client } from '@sentry/core';
 import { SDK_VERSION } from '@sentry/core';
 import type { OpenTelemetryClient as OpenTelemetryClientInterface } from '../types';
 
@@ -10,7 +10,8 @@ import type { OpenTelemetryClient as OpenTelemetryClientInterface } from '../typ
 /* eslint-disable @typescript-eslint/no-explicit-any */
 
 /**
- * Wrap an Client with things we need for OpenTelemetry support.
+ * Wrap an Client class with things we need for OpenTelemetry support.
+ * Make sure that the Client class passed in is non-abstract!
  *
  * Usage:
  * const OpenTelemetryClient = getWrappedClientClass(NodeClient);
@@ -19,11 +20,12 @@ import type { OpenTelemetryClient as OpenTelemetryClientInterface } from '../typ
 export function wrapClientClass<
   ClassConstructor extends new (
     ...args: any[]
-  ) => Client & BaseClient<any>,
+  ) => Client,
   WrappedClassConstructor extends new (
     ...args: any[]
-  ) => Client & BaseClient<any> & OpenTelemetryClientInterface,
+  ) => Client & OpenTelemetryClientInterface,
 >(ClientClass: ClassConstructor): WrappedClassConstructor {
+  // @ts-expect-error We just assume that this is non-abstract, if you pass in an abstract class this would make it non-abstract
   class OpenTelemetryClient extends ClientClass implements OpenTelemetryClientInterface {
     public traceProvider: BasicTracerProvider | undefined;
     private _tracer: Tracer | undefined;