Adding a New CDN Bundle

Feature Combinations

Naming Conventions

Files to Create

1. Entry Point: packages/browser/src/index.bundle.{FEATURE_COMBO}.ts

// If bundle includes TRACING, add this at the top:
import { registerSpanErrorInstrumentation } from '@sentry/core';
registerSpanErrorInstrumentation();

// Always export base bundle
export * from './index.bundle.base';

export { logger, consoleLoggingIntegration } from '@sentry/core';

export {
  getActiveSpan,
  getRootSpan,
  getSpanDescendants,
  setMeasurement,
  startInactiveSpan,
  startNewTrace,
  startSpan,
  startSpanManual,
  withActiveSpan,
} from '@sentry/core';

export {
  browserTracingIntegration,
  startBrowserTracingNavigationSpan,
  startBrowserTracingPageLoadSpan,
} from './tracing/browserTracingIntegration';
export { reportPageLoaded } from './tracing/reportPageLoaded';
export { setActiveSpanInBrowser } from './tracing/setActiveSpan';

export { replayIntegration, getReplay } from '@sentry/replay';

import { feedbackAsyncIntegration } from './feedbackAsync';
export { getFeedback, sendFeedback } from '@sentry/feedback';
export { feedbackAsyncIntegration as feedbackAsyncIntegration, feedbackAsyncIntegration as feedbackIntegration };

import {
  browserTracingIntegrationShim, // if NO tracing
  feedbackIntegrationShim, // if NO feedback
  replayIntegrationShim, // if NO replay
  consoleLoggingIntegrationShim, // if NO logs
  loggerShim, // if NO logs
} from '@sentry-internal/integration-shims';

// Then export them with proper names:
export { browserTracingIntegrationShim as browserTracingIntegration };
export { feedbackIntegrationShim as feedbackAsyncIntegration, feedbackIntegrationShim as feedbackIntegration };
export { replayIntegrationShim as replayIntegration };
export { consoleLoggingIntegrationShim as consoleLoggingIntegration, loggerShim as logger };

2. Test File: packages/browser/test/index.bundle.{FEATURE_COMBO}.test.ts

import { logger as coreLogger, metrics as coreMetrics } from '@sentry/core';
import { describe, expect, it } from 'vitest';
// Import real integrations for features included in the bundle
import { browserTracingIntegration, feedbackAsyncIntegration, replayIntegration } from '../src';
import * as Bundle from '../src/index.bundle.{FEATURE_COMBO}';

describe('index.bundle.{FEATURE_COMBO}', () => {
  it('has correct exports', () => {
    // Test real exports match core implementations
    expect(Bundle.browserTracingIntegration).toBe(browserTracingIntegration); // if tracing included
    expect(Bundle.feedbackAsyncIntegration).toBe(feedbackAsyncIntegration); // if feedback included
    expect(Bundle.replayIntegration).toBe(replayIntegration); // if replay included
    expect(Bundle.logger).toBe(coreLogger); // if logs included
    expect(Bundle.metrics).toBe(coreMetrics); // always (in base bundle)
  });
});

Files to Modify

3. packages/browser/rollup.bundle.config.mjs

const {featureCombo}BaseBundleConfig = makeBaseBundleConfig({
  bundleType: 'standalone',
  entrypoints: ['src/index.bundle.{FEATURE_COMBO}.ts'],
  licenseTitle: '@sentry/browser ({Human Readable Feature List})',
  outputFileBase: () => 'bundles/bundle.{FEATURE_COMBO}',
});

...makeBundleConfigVariants({featureCombo}BaseBundleConfig),

4. .size-limit.js

// Gzipped (add after similar bundles)
{
  name: 'CDN Bundle (incl. {Human Readable Features})',
  path: createCDNPath('bundle.{FEATURE_COMBO}.min.js'),
  gzip: true,
  limit: '{SIZE} KB',  // Estimate based on features
},

// Uncompressed (add in the non-gzipped section)
{
  name: 'CDN Bundle (incl. {Human Readable Features}) - uncompressed',
  path: createCDNPath('bundle.{FEATURE_COMBO}.min.js'),
  gzip: false,
  brotli: false,
  limit: '{SIZE} KB',  // ~3x the gzipped size
},

Size Estimation Guide

5. dev-packages/browser-integration-tests/package.json

"test:bundle:{feature_combo}": "PW_BUNDLE=bundle_{feature_combo} pnpm run test",
"test:bundle:{feature_combo}:min": "PW_BUNDLE=bundle_{feature_combo}_min pnpm run test",
"test:bundle:{feature_combo}:debug_min": "PW_BUNDLE=bundle_{feature_combo}_debug_min pnpm run test",

6. dev-packages/browser-integration-tests/utils/generatePlugin.ts

bundle_{feature_combo}: 'build/bundles/bundle.{FEATURE_COMBO}.js',
bundle_{feature_combo}_min: 'build/bundles/bundle.{FEATURE_COMBO}.min.js',
bundle_{feature_combo}_debug_min: 'build/bundles/bundle.{FEATURE_COMBO}.debug.min.js',

7. .github/workflows/build.yml

- bundle_{feature_combo}

Verification Steps

Reference: Existing Bundle Examples

Error Handling