feat(sdk): Add sendDefaultPii option to the JS SDKs (#5341)

Add the `sendDefaultPii` option to the JS SDKs. This patch only adds the flag but functionality will be introduced in future PRs

Author: Lms24

packages/hub/src/hub.ts

@@ -439,6 +439,16 @@ 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.
+   */
+  public shouldSendDefaultPii(): boolean {
+    const client = this.getClient();
+    const options = client && client.getOptions();
+    return Boolean(options && options.sendDefaultPii);
+  }
+
   /**
    * Sends the current Session on the scope
    */

packages/hub/test/hub.test.ts

@@ -431,4 +431,23 @@ describe('Hub', () => {
       });
     });
   });
+
+  describe('shouldSendDefaultPii()', () => {
+    test('return false if sendDefaultPii is not set', () => {
+      const testClient = makeClient();
+      const hub = new Hub(testClient);
+      expect(hub.shouldSendDefaultPii()).toBe(false);
+    });
+
+    test('return true if sendDefaultPii is set in the client options', () => {
+      const testClient = makeClient();
+      testClient.getOptions = () => {
+        return {
+          sendDefaultPii: true,
+        } as unknown as any;
+      };
+      const hub = new Hub(testClient);
+      expect(hub.shouldSendDefaultPii()).toBe(true);
+    });
+  });
 });

packages/types/src/options.ts

@@ -152,6 +152,21 @@ export interface ClientOptions<TO extends BaseTransportOptions = BaseTransportOp
    */
   tunnel?: string;
 
+  /**
+   * Currently controls if the user id (e.g. set by `Sentry.setUser`) should
+   * be used for dynamic sampling. Only if this flag is set to `true`, the user id
+   * will be propagated to outgoing requests in the `baggage` Http header.
+   *
+   * Note that in the next major version of this SDK, this option will not only
+   * control dynamic sampling data: As long as this flag is not set to `true`,
+   * the SDK will not send sensitive data by default.
+   *
+   * Defaults to `false`.
+   *
+   * @experimental (will be fully introduced in the next major version)
+   */
+  sendDefaultPii?: boolean;
+
   /**
    * Set of metadata about the SDK that can be internally used to enhance envelopes and events,
    * and provide additional data about every request.