ref(v8): Remove pushScope, popScope, isOlderThan, shouldSendDefaultPii from hub (#11404)

These are the things that will be fully removed in v8 as they do not
work anymore at all. The other stuff will remain shimmed for the v8
cycle.

I think it is OK to remove `isOlderThan` and `shouldSendDefaultPii` even
though they can technically be shimmed as they are not really "main"
APIs - but happy to leave this in if we think they are important...?

Author: mydea

packages/core/src/hub.ts

@@ -142,18 +142,6 @@ export class Hub implements HubInterface {
     this._isolationScope = assignedIsolationScope;
   }
 
-  /**
-   * Checks if this hub's version is older than the given version.
-   *
-   * @param version A version number to compare to.
-   * @return True if the given version is newer; otherwise false.
-   *
-   * @deprecated This will be removed in v8.
-   */
-  public isOlderThan(version: number): boolean {
-    return this._version < version;
-  }
-
   /**
    * This binds the given client to the current scope.
    * @param client An SDK client (client) instance.
@@ -170,72 +158,37 @@ export class Hub implements HubInterface {
     }
   }
 
-  /**
-   * @inheritDoc
-   *
-   * @deprecated Use `withScope` instead.
-   */
-  public pushScope(): ScopeInterface {
-    // We want to clone the content of prev scope
-    // eslint-disable-next-line deprecation/deprecation
-    const scope = this.getScope().clone();
-    // eslint-disable-next-line deprecation/deprecation
-    this.getStack().push({
-      // eslint-disable-next-line deprecation/deprecation
-      client: this.getClient(),
-      scope,
-    });
-    return scope;
-  }
-
-  /**
-   * @inheritDoc
-   *
-   * @deprecated Use `withScope` instead.
-   */
-  public popScope(): boolean {
-    // eslint-disable-next-line deprecation/deprecation
-    if (this.getStack().length <= 1) return false;
-    // eslint-disable-next-line deprecation/deprecation
-    return !!this.getStack().pop();
-  }
-
   /**
    * @inheritDoc
    *
    * @deprecated Use `Sentry.withScope()` instead.
    */
   public withScope<T>(callback: (scope: ScopeInterface) => T): T {
-    // eslint-disable-next-line deprecation/deprecation
-    const scope = this.pushScope();
+    const scope = this._pushScope();
 
     let maybePromiseResult: T;
     try {
       maybePromiseResult = callback(scope);
     } catch (e) {
-      // eslint-disable-next-line deprecation/deprecation
-      this.popScope();
+      this._popScope();
       throw e;
     }
 
     if (isThenable(maybePromiseResult)) {
       // @ts-expect-error - isThenable returns the wrong type
       return maybePromiseResult.then(
         res => {
-          // eslint-disable-next-line deprecation/deprecation
-          this.popScope();
+          this._popScope();
           return res;
         },
         e => {
-          // eslint-disable-next-line deprecation/deprecation
-          this.popScope();
+          this._popScope();
           throw e;
         },
       );
     }
 
-    // eslint-disable-next-line deprecation/deprecation
-    this.popScope();
+    this._popScope();
     return maybePromiseResult;
   }
 
@@ -501,20 +454,6 @@ export class Hub implements HubInterface {
     return session;
   }
 
-  /**
-   * Returns if default PII should be sent to Sentry and propagated in ourgoing requests
-   * when Tracing is used.
-   *
-   * @deprecated Use top-level `getClient().getOptions().sendDefaultPii` instead. This function
-   * only unnecessarily increased API surface but only wrapped accessing the option.
-   */
-  public shouldSendDefaultPii(): boolean {
-    // eslint-disable-next-line deprecation/deprecation
-    const client = this.getClient();
-    const options = client && client.getOptions();
-    return Boolean(options && options.sendDefaultPii);
-  }
-
   /**
    * Sends the current Session on the scope
    */
@@ -527,6 +466,32 @@ export class Hub implements HubInterface {
       client.captureSession(session);
     }
   }
+
+  /**
+   * Push a scope to the stack.
+   */
+  private _pushScope(): ScopeInterface {
+    // We want to clone the content of prev scope
+    // eslint-disable-next-line deprecation/deprecation
+    const scope = this.getScope().clone();
+    // eslint-disable-next-line deprecation/deprecation
+    this.getStack().push({
+      // eslint-disable-next-line deprecation/deprecation
+      client: this.getClient(),
+      scope,
+    });
+    return scope;
+  }
+
+  /**
+   * Pop a scope from the stack.
+   */
+  private _popScope(): boolean {
+    // eslint-disable-next-line deprecation/deprecation
+    if (this.getStack().length <= 1) return false;
+    // eslint-disable-next-line deprecation/deprecation
+    return !!this.getStack().pop();
+  }
 }
 
 /**

packages/opentelemetry/src/custom/getCurrentHub.ts

@@ -1,4 +1,4 @@
-import type { Client, EventHint, Hub, Integration, IntegrationClass, Scope, SeverityLevel } from '@sentry/types';
+import type { Client, EventHint, Hub, Integration, IntegrationClass, SeverityLevel } from '@sentry/types';
 
 import {
   addBreadcrumb,
@@ -23,25 +23,11 @@ import {
  */
 export function getCurrentHub(): Hub {
   return {
-    isOlderThan(_version: number): boolean {
-      return false;
-    },
-
     bindClient(client: Client): void {
       const scope = getCurrentScope();
       scope.setClient(client);
     },
 
-    pushScope(): Scope {
-      // TODO: This does not work and is actually deprecated
-      return getCurrentScope();
-    },
-
-    popScope(): boolean {
-      // TODO: This does not work and is actually deprecated
-      return false;
-    },
-
     withScope,
     getClient: <C extends Client>() => getClient() as C | undefined,
     getScope: getCurrentScope,
@@ -79,11 +65,6 @@ export function getCurrentHub(): Hub {
       // only send the update
       _sendSessionUpdate();
     },
-
-    shouldSendDefaultPii(): boolean {
-      const client = getClient();
-      return Boolean(client ? client.getOptions().sendDefaultPii : false);
-    },
   };
 }
 

packages/types/src/hub.ts

@@ -14,16 +14,6 @@ import type { User } from './user';
  * working in case we have a version conflict.
  */
 export interface Hub {
-  /**
-   * Checks if this hub's version is older than the given version.
-   *
-   * @param version A version number to compare to.
-   * @return True if the given version is newer; otherwise false.
-   *
-   * @deprecated This will be removed in v8.
-   */
-  isOlderThan(version: number): boolean;
-
   /**
    * This binds the given client to the current scope.
    * @param client An SDK client (client) instance.
@@ -32,31 +22,6 @@ export interface Hub {
    */
   bindClient(client?: Client): void;
 
-  /**
-   * Create a new scope to store context information.
-   *
-   * The scope will be layered on top of the current one. It is isolated, i.e. all
-   * breadcrumbs and context information added to this scope will be removed once
-   * the scope ends. Be sure to always remove this scope with {@link this.popScope}
-   * when the operation finishes or throws.
-   *
-   * @returns Scope, the new cloned scope
-   *
-   * @deprecated Use `withScope` instead.
-   */
-  pushScope(): Scope;
-
-  /**
-   * Removes a previously pushed scope from the stack.
-   *
-   * This restores the state before the scope was pushed. All breadcrumbs and
-   * context information added since the last call to {@link this.pushScope} are
-   * discarded.
-   *
-   * @deprecated Use `withScope` instead.
-   */
-  popScope(): boolean;
-
   /**
    * Creates a new scope with and executes the given operation within.
    * The scope is automatically removed once the operation
@@ -234,13 +199,4 @@ export interface Hub {
    * @deprecated Use top-level `captureSession` instead.
    */
   captureSession(endSession?: boolean): void;
-
-  /**
-   * Returns if default PII should be sent to Sentry and propagated in outgoing requests
-   * when Tracing is used.
-   *
-   * @deprecated Use top-level `getClient().getOptions().sendDefaultPii` instead. This function
-   * only unnecessarily increased API surface but only wrapped accessing the option.
-   */
-  shouldSendDefaultPii(): boolean;
 }