Add setEnabled method (#193)

* Add setEnabled method

* Create orange-pears-judge.md

Author: robertcepa

.changeset/orange-pears-judge.md

@@ -0,0 +1,5 @@
+---
+"toucan-js": minor
+---
+
+Add setEnabled method

packages/toucan-js/README.md

@@ -28,6 +28,7 @@ This SDK provides all options and methods of [Hub](https://github.com/getsentry/
 
 ### Additional methods
 
+- `Toucan.setEnabled(enabled: boolean): void`: Can be used to disable and again enable the SDK later in your code.
 - `Toucan.setRequestBody(body: unknown): void`: Attaches request body to future events. `body` can be anything serializable.
 
 ## Integrations

packages/toucan-js/src/client.ts

@@ -127,4 +127,13 @@ export class ToucanClient extends BaseClient<ToucanClientOptions> {
   public setRequestBody(body: unknown) {
     this.getOptions().requestData = body;
   }
+
+  /**
+   * Enable/disable the SDK.
+   *
+   * @param enabled
+   */
+  public setEnabled(enabled: boolean): void {
+    this.getOptions().enabled = enabled;
+  }
 }

packages/toucan-js/src/sdk.ts

@@ -61,4 +61,13 @@ export class Toucan extends Hub {
   setRequestBody(body: unknown) {
     this.getClient<ToucanClient>()?.setRequestBody(body);
   }
+
+  /**
+   * Enable/disable the SDK.
+   *
+   * @param enabled
+   */
+  setEnabled(enabled: boolean): void {
+    this.getClient<ToucanClient>()?.setEnabled(enabled);
+  }
 }

packages/toucan-js/test/index.spec.ts

@@ -21,8 +21,8 @@ const GENERIC_EVENT_BODY_MATCHER = {
   contexts: expect.objectContaining({
     trace: expect.objectContaining({
       span_id: expect.any(String),
-      trace_id: expect.any(String)
-    })
+      trace_id: expect.any(String),
+    }),
   }),
   event_id: expect.any(String),
   timestamp: expect.any(Number),
@@ -237,6 +237,36 @@ describe('Toucan', () => {
       expect(requests.length).toBe(0);
     });
 
+    test('disable / enable', async () => {
+      const toucan = new Toucan({
+        dsn: VALID_DSN,
+        context,
+      });
+
+      // Sent
+      toucan.captureMessage('test 1');
+
+      toucan.setEnabled(false);
+
+      // Not sent
+      toucan.captureMessage('test 2');
+      toucan.captureMessage('test 3');
+      toucan.captureMessage('test 4');
+      toucan.captureException(new Error());
+      toucan.captureException(new Error());
+      toucan.captureException(new Error());
+
+      toucan.setEnabled(true);
+
+      // Sent
+      toucan.captureMessage('test 5');
+
+      const waitUntilResults = await getMiniflareWaitUntil(context);
+
+      expect(waitUntilResults.length).toBe(2);
+      expect(requests.length).toBe(2);
+    });
+
     test('invalid URL does not fail', async () => {
       const toucan = new Toucan({
         dsn: VALID_DSN,