make dedicated package

Author: mydea

.github/workflows/build.yml

@@ -369,6 +369,7 @@ jobs:
             ${{ github.workspace }}/packages/browser/build/bundles/**
             ${{ github.workspace }}/packages/integrations/build/bundles/**
             ${{ github.workspace }}/packages/replay/build/bundles/**
+            ${{ github.workspace }}/packages/replay-canvas/build/bundles/**
             ${{ github.workspace }}/packages/**/*.tgz
             ${{ github.workspace }}/packages/serverless/build/aws/dist-serverless/*.zip
 

package.json

@@ -69,6 +69,7 @@
     "packages/remix",
     "packages/replay",
     "packages/replay-worker",
+    "packages/replay-canvas",
     "packages/serverless",
     "packages/svelte",
     "packages/sveltekit",

packages/browser/package.json

@@ -32,6 +32,7 @@
   },
   "devDependencies": {
     "@sentry-internal/integration-shims": "7.88.0",
+    "@sentry-internal/replay-canvas": "7.88.0",
     "@types/md5": "2.1.33",
     "btoa": "^1.2.1",
     "chai": "^4.1.2",

packages/browser/rollup.npm.config.js

@@ -4,5 +4,14 @@ export default makeNPMConfigVariants(
   makeBaseNPMConfig({
     // packages with bundles have a different build directory structure
     hasBundles: true,
+    packageSpecificConfig: {
+      output: {
+        // set exports to 'named' or 'auto' so that rollup doesn't warn
+        exports: 'named',
+        // set preserveModules to false because for Replay we actually want
+        // to bundle everything into one file.
+        preserveModules: false,
+      },
+    },
   }),
 );

packages/browser/src/index.ts

@@ -20,7 +20,8 @@ const INTEGRATIONS = {
 
 export { INTEGRATIONS as Integrations };
 
-export { Replay, ReplayCanvas } from '@sentry/replay';
+export { Replay } from '@sentry/replay';
+export { ReplayCanvas } from '@sentry-internal/replay-canvas';
 export type {
   ReplayEventType,
   ReplayEventWithTime,

packages/deno/package.json

@@ -17,7 +17,6 @@
     "index.d.ts"
   ],
   "dependencies": {
-    "@sentry/browser": "7.88.0",
     "@sentry/core": "7.88.0",
     "@sentry/types": "7.88.0",
     "@sentry/utils": "7.88.0"
@@ -37,7 +36,7 @@
     "build:types:bundle": "rollup -c rollup.types.config.js",
     "build:tarball": "ts-node ../../scripts/prepack.ts && npm pack ./build",
     "circularDepCheck": "madge --circular src/index.ts",
-    "clean": "rimraf build build-types build-test coverage",
+    "clean": "rimraf build build-types build-test coverage sentry-deno-*.tgz",
     "prefix": "yarn deno-types",
     "fix": "eslint . --format stylish --fix",
     "prelint": "yarn deno-types",

packages/deno/src/debug-build.ts

@@ -0,0 +1,8 @@
+declare const __DEBUG_BUILD__: boolean;
+
+/**
+ * This serves as a build time flag that will be true by default, but false in non-debug builds or if users replace `__SENTRY_DEBUG__` in their generated code.
+ *
+ * ATTENTION: This constant must never cross package boundaries (i.e. be exported) to guarantee that it can be used for tree shaking.
+ */
+export const DEBUG_BUILD = __DEBUG_BUILD__;

packages/deno/src/integrations/breadcrumbs.ts

@@ -0,0 +1,176 @@
+import { addBreadcrumb, getClient } from '@sentry/core';
+import type { Event as SentryEvent, HandlerDataConsole, HandlerDataFetch, Integration } from '@sentry/types';
+import type { FetchBreadcrumbData, FetchBreadcrumbHint } from '@sentry/types/build/types/breadcrumb';
+import {
+  addConsoleInstrumentationHandler,
+  addFetchInstrumentationHandler,
+  getEventDescription,
+  safeJoin,
+  severityLevelFromString,
+} from '@sentry/utils';
+
+interface BreadcrumbsOptions {
+  console: boolean;
+  fetch: boolean;
+  sentry: boolean;
+}
+
+/** maxStringLength gets capped to prevent 100 breadcrumbs exceeding 1MB event payload size */
+const MAX_ALLOWED_STRING_LENGTH = 1024;
+
+/**
+ * Default Breadcrumbs instrumentations
+ * TODO: Deprecated - with v6, this will be renamed to `Instrument`
+ */
+export class Breadcrumbs implements Integration {
+  /**
+   * @inheritDoc
+   */
+  public static id: string = 'Breadcrumbs';
+
+  /**
+   * @inheritDoc
+   */
+  public name: string;
+
+  /**
+   * Options of the breadcrumbs integration.
+   */
+  // This field is public, because we use it in the browser client to check if the `sentry` option is enabled.
+  public readonly options: Readonly<BreadcrumbsOptions>;
+
+  /**
+   * @inheritDoc
+   */
+  public constructor(options?: Partial<BreadcrumbsOptions>) {
+    this.name = Breadcrumbs.id;
+    this.options = {
+      console: true,
+      fetch: true,
+      sentry: true,
+      ...options,
+    };
+  }
+
+  /**
+   * Instrument browser built-ins w/ breadcrumb capturing
+   *  - Console API
+   *  - Fetch API
+   */
+  public setupOnce(): void {
+    if (this.options.console) {
+      addConsoleInstrumentationHandler(_consoleBreadcrumb);
+    }
+    if (this.options.fetch) {
+      addFetchInstrumentationHandler(_fetchBreadcrumb);
+    }
+    if (this.options.sentry) {
+      const client = getClient();
+      client && client.on && client.on('beforeSendEvent', addSentryBreadcrumb);
+    }
+  }
+}
+
+/**
+ * Adds a breadcrumb for Sentry events or transactions if this option is enabled.
+ */
+function addSentryBreadcrumb(event: SentryEvent): void {
+  addBreadcrumb(
+    {
+      category: `sentry.${event.type === 'transaction' ? 'transaction' : 'event'}`,
+      event_id: event.event_id,
+      level: event.level,
+      message: getEventDescription(event),
+    },
+    {
+      event,
+    },
+  );
+}
+
+/**
+ * Creates breadcrumbs from console API calls
+ */
+function _consoleBreadcrumb(handlerData: HandlerDataConsole): void {
+  const breadcrumb = {
+    category: 'console',
+    data: {
+      arguments: handlerData.args,
+      logger: 'console',
+    },
+    level: severityLevelFromString(handlerData.level),
+    message: safeJoin(handlerData.args, ' '),
+  };
+
+  if (handlerData.level === 'assert') {
+    if (handlerData.args[0] === false) {
+      breadcrumb.message = `Assertion failed: ${safeJoin(handlerData.args.slice(1), ' ') || 'console.assert'}`;
+      breadcrumb.data.arguments = handlerData.args.slice(1);
+    } else {
+      // Don't capture a breadcrumb for passed assertions
+      return;
+    }
+  }
+
+  addBreadcrumb(breadcrumb, {
+    input: handlerData.args,
+    level: handlerData.level,
+  });
+}
+
+/**
+ * Creates breadcrumbs from fetch API calls
+ */
+function _fetchBreadcrumb(handlerData: HandlerDataFetch): void {
+  const { startTimestamp, endTimestamp } = handlerData;
+
+  // We only capture complete fetch requests
+  if (!endTimestamp) {
+    return;
+  }
+
+  if (handlerData.fetchData.url.match(/sentry_key/) && handlerData.fetchData.method === 'POST') {
+    // We will not create breadcrumbs for fetch requests that contain `sentry_key` (internal sentry requests)
+    return;
+  }
+
+  if (handlerData.error) {
+    const data: FetchBreadcrumbData = handlerData.fetchData;
+    const hint: FetchBreadcrumbHint = {
+      data: handlerData.error,
+      input: handlerData.args,
+      startTimestamp,
+      endTimestamp,
+    };
+
+    addBreadcrumb(
+      {
+        category: 'fetch',
+        data,
+        level: 'error',
+        type: 'http',
+      },
+      hint,
+    );
+  } else {
+    const response = handlerData.response as Response | undefined;
+    const data: FetchBreadcrumbData = {
+      ...handlerData.fetchData,
+      status_code: response && response.status,
+    };
+    const hint: FetchBreadcrumbHint = {
+      input: handlerData.args,
+      response,
+      startTimestamp,
+      endTimestamp,
+    };
+    addBreadcrumb(
+      {
+        category: 'fetch',
+        data,
+        type: 'http',
+      },
+      hint,
+    );
+  }
+}