feat(transport): Add buffer size option to native transport

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Features
+
+- Add `maxQueueSize` option ([#2578](https://github.com/getsentry/sentry-react-native/pull/2578))
+
 ### Dependencies
 
 - Bump JavaScript SDK from v7.16.0 to v7.17.4 ([#2582](https://github.com/getsentry/sentry-react-native/pull/2582), [#2598](https://github.com/getsentry/sentry-react-native/pull/2598))

android/src/main/java/io/sentry/react/RNSentryModule.java

@@ -130,6 +130,9 @@ public void initNativeSdk(final ReadableMap rnOptions, Promise promise) {
             if (rnOptions.hasKey("sendDefaultPii")) {
                 options.setSendDefaultPii(rnOptions.getBoolean("sendDefaultPii"));
             }
+            if (rnOptions.hasKey("maxQueueSize")) {
+                options.setMaxQueueSize(rnOptions.getInt("maxQueueSize"));
+            }
 
             options.setBeforeSend((event, hint) -> {
                 // React native internally throws a JavascriptException

src/js/client.ts

@@ -1,5 +1,4 @@
 import { BrowserClient, defaultStackParser, makeFetchTransport } from '@sentry/browser';
-import { BrowserTransportOptions } from '@sentry/browser/types/transports/types';
 import { FetchImpl } from '@sentry/browser/types/transports/utils';
 import { BaseClient } from '@sentry/core';
 import {
@@ -18,8 +17,8 @@ import { dateTimestampInSeconds, logger, SentryError } from '@sentry/utils';
 import { Alert, LogBox, YellowBox } from 'react-native';
 
 import { defaultSdkInfo } from './integrations/sdkinfo';
-import { ReactNativeClientOptions } from './options';
-import { NativeTransport } from './transports/native';
+import { ReactNativeClientOptions, ReactNativeTransportOptions } from './options';
+import { makeReactNativeTransport } from './transports/native';
 import { createUserFeedbackEnvelope, items } from './utils/envelope';
 import { mergeOutcomes } from './utils/outcome';
 import { NATIVE } from './wrapper';
@@ -42,9 +41,9 @@ export class ReactNativeClient extends BaseClient<ReactNativeClientOptions> {
    */
    public constructor(options: ReactNativeClientOptions) {
      if (!options.transport) {
-       options.transport = (options: BrowserTransportOptions, nativeFetch?: FetchImpl): Transport => {
+       options.transport = (options: ReactNativeTransportOptions, nativeFetch?: FetchImpl): Transport => {
          if (NATIVE.isNativeTransportAvailable()) {
-           return new NativeTransport();
+           return makeReactNativeTransport(options);
          }
          return makeFetchTransport(options, nativeFetch);
        };

src/js/options.ts

@@ -121,17 +121,29 @@ export interface BaseReactNativeOptions {
    * @default 2
    */
   appHangTimeoutInterval?: number;
+
+  /**
+   * The max queue size for capping the number of envelopes waiting to be sent by Transport.
+   */
+  maxQueueSize?: number;
+}
+
+export interface ReactNativeTransportOptions extends BrowserTransportOptions {
+  /**
+   * @deprecated use `maxQueueSize` in the root of the SDK options.
+  */
+  bufferSize?: number;
 }
 
 /**
  * Configuration options for the Sentry ReactNative SDK.
  * @see ReactNativeFrontend for more information.
  */
 
-export interface ReactNativeOptions extends Options<BrowserTransportOptions>, BaseBrowserOptions, BaseReactNativeOptions {
+export interface ReactNativeOptions extends Options<ReactNativeTransportOptions>, BaseBrowserOptions, BaseReactNativeOptions {
 }
 
-export interface ReactNativeClientOptions extends ClientOptions<BrowserTransportOptions>, BaseBrowserOptions, BaseReactNativeOptions {
+export interface ReactNativeClientOptions extends ClientOptions<ReactNativeTransportOptions>, BaseBrowserOptions, BaseReactNativeOptions {
 }
 
 

src/js/sdk.tsx

@@ -22,7 +22,7 @@ import { ReactNativeClientOptions, ReactNativeOptions, ReactNativeWrapperOptions
 import { ReactNativeScope } from './scope';
 import { TouchEventBoundary } from './touchevents';
 import { ReactNativeProfiler, ReactNativeTracing } from './tracing';
-import { makeReactNativeTransport } from './transports/native';
+import { DEFAULT_BUFFER_SIZE, makeReactNativeTransport } from './transports/native';
 import { makeUtf8TextEncoder } from './transports/TextEncoder';
 import { safeFactory, safeTracesSampler } from './utils/safe';
 import { RN_GLOBAL_OBJ } from './utils/worldwide';
@@ -43,6 +43,7 @@ const DEFAULT_OPTIONS: ReactNativeOptions = {
     textEncoder: makeUtf8TextEncoder(),
   },
   sendClientReports: true,
+  maxQueueSize: DEFAULT_BUFFER_SIZE,
 };
 
 /**
@@ -52,6 +53,10 @@ export function init(passedOptions: ReactNativeOptions): void {
   const reactNativeHub = new Hub(undefined, new ReactNativeScope());
   makeMain(reactNativeHub);
 
+  const maxQueueSize = passedOptions.maxQueueSize
+    // eslint-disable-next-line deprecation/deprecation
+    ?? passedOptions.transportOptions?.bufferSize
+    ?? DEFAULT_OPTIONS.maxQueueSize;
   const options: ReactNativeClientOptions = {
     ...DEFAULT_OPTIONS,
     ...passedOptions,
@@ -60,7 +65,9 @@ export function init(passedOptions: ReactNativeOptions): void {
     transportOptions: {
       ...DEFAULT_OPTIONS.transportOptions,
       ...(passedOptions.transportOptions ?? {}),
+      bufferSize: maxQueueSize,
     },
+    maxQueueSize,
     integrations: [],
     stackParser: stackParserFromStackParserOptions(passedOptions.stackParser || defaultStackParser),
     beforeBreadcrumb: safeFactory(passedOptions.beforeBreadcrumb, { loggerMessage: 'The beforeBreadcrumb threw an error' }),

src/js/transports/native.ts

@@ -3,12 +3,22 @@ import { makePromiseBuffer, PromiseBuffer } from '@sentry/utils';
 
 import { NATIVE } from '../wrapper';
 
+export const DEFAULT_BUFFER_SIZE = 30;
+
 export type BaseNativeTransport = BaseTransportOptions
 
+export interface BaseNativeTransportOptions {
+  bufferSize?: number;
+}
+
 /** Native Transport class implementation */
 export class NativeTransport implements Transport {
   /** A simple buffer holding all requests. */
-  protected readonly _buffer: PromiseBuffer<void> = makePromiseBuffer(30);
+  protected readonly _buffer: PromiseBuffer<void>;
+
+  public constructor(options: BaseNativeTransportOptions = {}) {
+    this._buffer = makePromiseBuffer(options.bufferSize || DEFAULT_BUFFER_SIZE);
+  }
 
   /**
    * Sends the envelope to the Store endpoint in Sentry.
@@ -35,4 +45,6 @@ export class NativeTransport implements Transport {
 /**
  * Creates a Native Transport.
  */
-export function makeReactNativeTransport(): NativeTransport { return new NativeTransport(); }
+export function makeReactNativeTransport(options: BaseNativeTransportOptions = {}): NativeTransport {
+  return new NativeTransport(options);
+}

test/sdk.test.ts

@@ -62,7 +62,7 @@ jest.spyOn(logger, 'error');
 
 import { initAndBind } from '@sentry/core';
 import { getCurrentHub } from '@sentry/react';
-import { Integration, Scope } from '@sentry/types';
+import { BaseTransportOptions,ClientOptions, Integration, Scope  } from '@sentry/types';
 
 import { ReactNativeClientOptions } from '../src/js/options';
 import { configureScope,flush, init, withScope } from '../src/js/sdk';
@@ -179,6 +179,36 @@ describe('Tests the SDK functionality', () => {
         }
       });
     });
+
+    describe('transport options buffer size', () => {
+      const usedOptions = (): ClientOptions<BaseTransportOptions> | undefined => {
+        return mockedInitAndBind.mock.calls[0]?.[1];
+      }
+
+      it('uses default transport options buffer size', () => {
+        init({
+          tracesSampleRate: 0.5,
+          enableAutoPerformanceTracking: true,
+        });
+        expect(usedOptions()?.transportOptions?.bufferSize).toBe(30);
+      });
+
+      it('uses custom transport options buffer size', () => {
+        init({
+          transportOptions: {
+            bufferSize: 99,
+          },
+        });
+        expect(usedOptions()?.transportOptions?.bufferSize).toBe(99);
+      });
+
+      it('uses max queue size', () => {
+        init({
+          maxQueueSize: 88,
+        });
+        expect(usedOptions()?.transportOptions?.bufferSize).toBe(88);
+      });
+    });
   });
 
   describe('initIsSafe', () => {