fix: SDK removed isDebugBuild (getsentry/sentry-replay#44)

Replaced with a constant that can be treeshaked. See #4842

Author: billyvg

package.json

@@ -1,18 +1,18 @@
 {
   "name": "@sentry/replay",
-  "version": "0.2.0-0",
+  "version": "0.2.0-1",
   "description": "User replays for Sentry",
   "main": "dist/index.js",
   "module": "dist/index.es.js",
   "scripts": {
     "bootstrap": "yarn && cd demo && yarn",
-    "build": "yarn rollup --config rollup.config.ts --configPlugin @rollup/plugin-typescript",
+    "build": "NODE_ENV=production yarn rollup --config rollup.config.ts --configPlugin @rollup/plugin-typescript",
     "clean": "yarn rimraf dist",
     "lint": "yarn eslint . --ext .js,.jsx,.ts,.tsx",
     "prepare": "husky install",
     "start:demo": "yarn build && cd demo && yarn start",
     "test": "yarn jest",
-    "watch": "yarn build --watch"
+    "watch": "NODE_ENV=development yarn build --watch"
   },
   "files": [
     "dist"
@@ -35,6 +35,7 @@
   },
   "devDependencies": {
     "@babel/core": "^7.17.5",
+    "@rollup/plugin-replace": "^4.0.0",
     "@rollup/plugin-typescript": "^8.3.1",
     "@sentry/browser": "^6.19.1",
     "@sentry/tracing": "^6.19.1",

rollup.config.ts

@@ -1,4 +1,5 @@
 import { RollupOptions } from 'rollup';
+import replace from '@rollup/plugin-replace';
 import typescript from '@rollup/plugin-typescript';
 
 import pkg from './package.json';
@@ -20,7 +21,17 @@ const config: RollupOptions = {
     ...Object.keys(pkg.dependencies || {}),
     ...Object.keys(pkg.peerDependencies || {}),
   ],
-  plugins: [typescript()],
+  plugins: [
+    typescript(),
+    replace({
+      // __SENTRY_DEBUG__ should be save to replace in any case, so no checks for assignments necessary
+      preventAssignment: false,
+      values: {
+        // @ts-expect-error not gonna deal with types here
+        __SENTRY_DEBUG__: process.env.NODE_ENV === 'development',
+      },
+    }),
+  ],
 };
 
 export default config;

src/flags.ts

@@ -0,0 +1,20 @@
+/*
+ * See https://github.com/getsentry/sentry-javascript/pull/4842
+ * This file defines flags and constants that can be modified during compile time in order to facilitate tree shaking
+ * for users.
+ *
+ * Debug flags need to be declared in each package individually and must not be imported across package boundaries,
+ * because some build tools have trouble tree-shaking imported guards.
+ *
+ * As a convention, we define debug flags in a `flags.ts` file in the root of a package's `src` folder.
+ *
+ * Debug flag files will contain "magic strings" like `__SENTRY_DEBUG__` that may get replaced with actual values during
+ * our, or the user's build process. Take care when introducing new flags - they must not throw if they are not
+ * replaced.
+ */
+
+declare const __SENTRY_DEBUG__: boolean;
+
+/** Flag that is true for debug builds, false otherwise. */
+export const IS_DEBUG_BUILD =
+  typeof __SENTRY_DEBUG__ === 'undefined' ? true : __SENTRY_DEBUG__;

src/util/logger.ts

@@ -1,8 +1,10 @@
-import { isDebugBuild, logger as sentryLogger } from '@sentry/utils';
+import { logger as sentryLogger } from '@sentry/utils';
+
+import { IS_DEBUG_BUILD } from '../flags';
 
 function wrapLogger(logFn: typeof sentryLogger[keyof typeof sentryLogger]) {
   return function wrappedLog(...args: any[]) {
-    if (!isDebugBuild()) {
+    if (!IS_DEBUG_BUILD) {
       return;
     }
     return logFn.call(sentryLogger, '[Replay]', ...args);

yarn.lock

@@ -680,6 +680,14 @@
     "@nodelib/fs.scandir" "2.1.5"
     fastq "^1.6.0"
 
+"@rollup/plugin-replace@^4.0.0":
+  version "4.0.0"
+  resolved "https://registry.yarnpkg.com/@rollup/plugin-replace/-/plugin-replace-4.0.0.tgz#e34c457d6a285f0213359740b43f39d969b38a67"
+  integrity sha512-+rumQFiaNac9y64OHtkHGmdjm7us9bo1PlbgQfdihQtuNxzjpaB064HbRnewUOggLQxVCCyINfStkgmBeQpv1g==
+  dependencies:
+    "@rollup/pluginutils" "^3.1.0"
+    magic-string "^0.25.7"
+
 "@rollup/plugin-typescript@^8.3.1":
   version "8.3.1"
   resolved "https://registry.yarnpkg.com/@rollup/plugin-typescript/-/plugin-typescript-8.3.1.tgz#b7dc75ed6b4876e260b9e80624fab23bc98e4ac1"
@@ -2815,6 +2823,13 @@ lru-cache@^6.0.0:
   dependencies:
     yallist "^4.0.0"
 
+magic-string@^0.25.7:
+  version "0.25.9"
+  resolved "https://registry.yarnpkg.com/magic-string/-/magic-string-0.25.9.tgz#de7f9faf91ef8a1c91d02c2e5314c8277dbcdd1c"
+  integrity sha512-RmF0AsMzgt25qzqqLc1+MbHmhdx0ojF2Fvs4XnOqz2ZOBXzzkEwc/dJQZCYHAn7v1jbVOjAZfK8msRn4BxO4VQ==
+  dependencies:
+    sourcemap-codec "^1.4.8"
+
 make-dir@^3.0.0:
   version "3.0.0"
   resolved "https://registry.yarnpkg.com/make-dir/-/make-dir-3.0.0.tgz#1b5f39f6b9270ed33f9f054c5c0f84304989f801"
@@ -3366,6 +3381,11 @@ source-map@^0.7.3:
   resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.7.3.tgz#5302f8169031735226544092e64981f751750383"
   integrity sha512-CkCj6giN3S+n9qrYiBTX5gystlENnRW5jZeNLHpe6aue+SrHcG5VYwujhW9s4dY31mEGsxBDrHR6oI69fTXsaQ==
 
+sourcemap-codec@^1.4.8:
+  version "1.4.8"
+  resolved "https://registry.yarnpkg.com/sourcemap-codec/-/sourcemap-codec-1.4.8.tgz#ea804bd94857402e6992d05a38ef1ae35a9ab4c4"
+  integrity sha512-9NykojV5Uih4lgo5So5dtw+f0JgJX30KCNI8gwhz2J9A15wD0Ml6tjHKwf6fTSa6fAdVBdZeNOs9eJ71qCk8vA==
+
 sprintf-js@~1.0.2:
   version "1.0.3"
   resolved "https://registry.yarnpkg.com/sprintf-js/-/sprintf-js-1.0.3.tgz#04e6926f662895354f3dd015203633b857297e2c"