feat(core): Deprecate Hub.shouldSendDefaultPii (#10062)

Deprecates the unnecessary `Hub. shouldSendDefaultPii`
method which can be easily replaced by accessing client options
directly.

Author: Lms24

MIGRATION.md

@@ -21,7 +21,7 @@ You can [read more about the new performance APIs here](./docs/v8-new-performanc
 
 ## Deprecate `Sentry.lastEventId()` and `hub.lastEventId()`
 
-`Sentry.lastEventId()` sometimes causes race conditons, so we are deprecating it in favour of the `beforeSend` callback.
+`Sentry.lastEventId()` sometimes causes race conditions, so we are deprecating it in favour of the `beforeSend` callback.
 
 ```js
 // Before
@@ -48,6 +48,12 @@ Sentry.init({
 });
 ```
 
+## Deprecated fields on `Hub`
+
+In v8, the Hub class will be removed. The following methods are therefore deprecated:
+
+- `hub.shouldSendDefaultPii()`: Access Sentry client option via `Sentry.getClient().getOptions().sendDefaultPii` instead
+
 ## Deprecated fields on `Span` and `Transaction`
 
 In v8, the Span class is heavily reworked. The following properties & methods are thus deprecated:

packages/core/src/hub.ts

@@ -548,6 +548,9 @@ Sentry.init({...});
   /**
    * 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 {
     const client = this.getClient();

packages/types/src/hub.ts

@@ -247,6 +247,9 @@ export interface Hub {
   /**
    * 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.
    */
   shouldSendDefaultPii(): boolean;
 }