ref(replay): Extract worker into dedicated package (#7139)

mydea · AbhiPrasad · commit 7fad62fc2e26 · 2023-02-14T12:37:30.000+01:00
diff --git a/package.json b/package.json
@@ -52,6 +52,7 @@
     "packages/react",
     "packages/remix",
     "packages/replay",
+    "packages/replay-worker",
     "packages/serverless",
     "packages/svelte",
     "packages/tracing",
diff --git a/packages/replay-worker/.eslintignore b/packages/replay-worker/.eslintignore
@@ -0,0 +1 @@
+vendor
diff --git a/packages/replay-worker/.eslintrc.js b/packages/replay-worker/.eslintrc.js
@@ -0,0 +1,17 @@
+// Note: All paths are relative to the directory in which eslint is being run, rather than the directory where this file
+// lives
+
+// ESLint config docs: https://eslint.org/docs/user-guide/configuring/
+
+module.exports = {
+  extends: ['../../.eslintrc.js'],
+  overrides: [
+    {
+      files: ['src/**/*.ts'],
+      rules: {
+        // We cannot use backticks, as that conflicts with the stringified worker
+        'prefer-template': 'off',
+      },
+    },
+  ],
+};
diff --git a/packages/replay-worker/.gitignore b/packages/replay-worker/.gitignore
@@ -0,0 +1,5 @@
+node_modules
+/*.tgz
+.eslintcache
+build
+!vendor/*.d.ts
diff --git a/packages/replay-worker/LICENSE b/packages/replay-worker/LICENSE
@@ -0,0 +1,14 @@
+Copyright (c) 2023 Sentry (https://sentry.io) and individual contributors. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/packages/replay-worker/README.md b/packages/replay-worker/README.md
@@ -0,0 +1,12 @@
+<p align="center">
+  <a href="https://sentry.io/?utm_source=github&utm_medium=logo" target="_blank">
+    <img src="https://sentry-brand.storage.googleapis.com/sentry-wordmark-dark-280x84.png" alt="Sentry" width="280" height="84">
+  </a>
+</p>
+
+# Sentry Session Replay Worker
+
+This is an internal package that is used by @sentry/replay.
+It generates a web worker and converts it to a string, so that we can process it easier in replay.
+
+By extracting this into a dedicated (private, internal) package, we can streamline the build of replay.
diff --git a/packages/replay-worker/jest.config.js b/packages/replay-worker/jest.config.js
@@ -0,0 +1 @@
+module.exports = require('../../jest/jest.config.js');
diff --git a/packages/replay-worker/package.json b/packages/replay-worker/package.json
@@ -0,0 +1,51 @@
+{
+  "name": "@sentry-internal/replay-worker",
+  "version": "7.37.2",
+  "description": "Worker for @sentry/replay",
+  "main": "build/index.js",
+  "module": "build/index.js",
+  "sideEffects": false,
+  "private": true,
+  "scripts": {
+    "build": "yarn build:transpile",
+    "build:transpile": "rollup -c rollup.worker.config.js",
+    "build:types": "yarn build:transpile",
+    "build:dev": "yarn build",
+    "build:watch": "run-p build:transpile:watch",
+    "build:dev:watch": "run-p build:watch",
+    "build:transpile:watch": "yarn build:rollup --watch",
+    "clean": "rimraf build",
+    "fix": "run-s fix:eslint fix:prettier",
+    "fix:eslint": "eslint . --format stylish --fix",
+    "fix:prettier": "prettier --write \"{src,test}/**/*.ts\"",
+    "lint": "run-s lint:prettier lint:eslint",
+    "lint:eslint": "eslint . --format stylish",
+    "lint:prettier": "prettier --check \"{src,test}/**/*.ts\"",
+    "test": "jest",
+    "test:watch": "jest --watch"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/getsentry/sentry-javascript.git"
+  },
+  "author": "Sentry",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/getsentry/sentry-javascript/issues"
+  },
+  "homepage": "https://docs.sentry.io/platforms/javascript/session-replay/",
+  "devDependencies": {
+    "@types/pako": "^2.0.0",
+    "rollup-plugin-copy": "~3.4.0",
+    "tslib": "^1.9.3"
+  },
+  "dependencies": {
+    "pako": "^2.1.0"
+  },
+  "engines": {
+    "node": ">=12"
+  },
+  "volta": {
+    "extends": "../../package.json"
+  }
+}
diff --git a/packages/replay-worker/rollup.worker.config.js b/packages/replay-worker/rollup.worker.config.js
@@ -4,15 +4,16 @@ import resolve from '@rollup/plugin-node-resolve';
 import typescript from '@rollup/plugin-typescript';
 import { defineConfig } from 'rollup';
 import { terser } from 'rollup-plugin-terser';
+import copy from 'rollup-plugin-copy';
 
 const config = defineConfig({
-  input: ['./worker/src/worker.ts'],
+  input: ['./src/worker.ts'],
   output: {
-    dir: './src/worker/',
+    dir: './build/',
     format: 'esm',
   },
   plugins: [
-    typescript({ tsconfig: './tsconfig.worker.json' }),
+    typescript({ tsconfig: './tsconfig.json', inlineSourceMap: false, sourceMap: false, inlineSources: false }),
     resolve(),
     terser({
       mangle: {
@@ -25,6 +26,9 @@ const config = defineConfig({
         return `export default \`${code}\`;`;
       },
     },
+    copy({
+      targets: [{ src: 'vendor/*', dest: 'build' }],
+    }),
   ],
 });
 
diff --git a/packages/replay-worker/src/Compressor.ts b/packages/replay-worker/src/Compressor.ts
@@ -1,5 +1,8 @@
-import { constants, Deflate } from 'pako';
+import { constants, Deflate, deflate } from 'pako';
 
+/**
+ * A stateful compressor that can be used to batch compress events.
+ */
 export class Compressor {
   /**
    * pako deflator instance
@@ -15,10 +18,16 @@ export class Compressor {
     this._init();
   }
 
+  /**
+   * Clear the compressor buffer.
+   */
   public clear(): void {
     this._init();
   }
 
+  /**
+   * Add an event to the compressor buffer.
+   */
   public addEvent(data: string): void {
     if (!data) {
       throw new Error('Adding invalid event');
@@ -34,6 +43,9 @@ export class Compressor {
     this._hasEvents = true;
   }
 
+  /**
+   * Finish compression of the current buffer.
+   */
   public finish(): Uint8Array {
     // We should always have a list, it can be empty
     this.deflate.push(']', constants.Z_FINISH);
@@ -51,6 +63,9 @@ export class Compressor {
     return result;
   }
 
+  /**
+   * Re-initialize the compressor buffer.
+   */
   private _init(): void {
     this._hasEvents = false;
     this.deflate = new Deflate();
@@ -59,3 +74,10 @@ export class Compressor {
     this.deflate.push('[', constants.Z_NO_FLUSH);
   }
 }
+
+/**
+ * Compress a string.
+ */
+export function compress(data: string): Uint8Array {
+  return deflate(data);
+}
diff --git a/packages/replay-worker/src/handleMessage.ts b/packages/replay-worker/src/handleMessage.ts
@@ -1,18 +1,18 @@
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
-import { Compressor } from './Compressor';
+import { compress, Compressor } from './Compressor';
 
 const compressor = new Compressor();
 
 interface Handlers {
   clear: () => void;
   addEvent: (data: string) => void;
-  finish: () => void;
+  finish: () => Uint8Array;
+  compress: (data: string) => Uint8Array;
 }
 
 const handlers: Handlers = {
   clear: () => {
     compressor.clear();
-    return '';
   },
 
   addEvent: (data: string) => {
@@ -22,8 +22,15 @@ const handlers: Handlers = {
   finish: () => {
     return compressor.finish();
   },
+
+  compress: (data: string) => {
+    return compress(data);
+  },
 };
 
+/**
+ * Handler for worker messages.
+ */
 export function handleMessage(e: MessageEvent): void {
   const method = e.data.method as string;
   const id = e.data.id as number;
diff --git a/packages/replay-worker/src/worker.ts b/packages/replay-worker/src/worker.ts
diff --git a/packages/replay-worker/test/tsconfig.json b/packages/replay-worker/test/tsconfig.json
@@ -0,0 +1,7 @@
+// TODO Once https://github.com/microsoft/TypeScript/issues/33094 is done (if it ever is), this file can disappear, as
+// it's purely a placeholder to satisfy VSCode.
+{
+  "extends": "../tsconfig.test.json",
+
+  "include": ["./**/*"]
+}
diff --git a/packages/replay-worker/test/unit/Compressor.test.ts b/packages/replay-worker/test/unit/Compressor.test.ts
@@ -1,8 +1,8 @@
 import pako from 'pako';
 
-import { Compressor } from '../../../worker/src/Compressor';
+import { Compressor } from '../../src/Compressor';
 
-describe('Unit | worker | Compressor', () => {
+describe('Compressor', () => {
   it('compresses multiple events', () => {
     const compressor = new Compressor();
 
diff --git a/packages/replay-worker/tsconfig.json b/packages/replay-worker/tsconfig.json
@@ -0,0 +1,11 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "module": "esnext",
+    "lib": ["webworker", "scripthost"],
+    "esModuleInterop": true,
+    "target": "es6",
+    "strictPropertyInitialization": false
+  },
+  "include": ["src/**/*.ts"]
+}
diff --git a/packages/replay-worker/tsconfig.test.json b/packages/replay-worker/tsconfig.test.json
@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["test/**/*.ts"],
+  "compilerOptions": {
+    "types": ["node", "jest"]
+  }
+}
diff --git a/packages/replay-worker/vendor/index.d.ts b/packages/replay-worker/vendor/index.d.ts
@@ -0,0 +1 @@
+export function getWorkerURL(): string;
diff --git a/packages/replay-worker/vendor/index.js b/packages/replay-worker/vendor/index.js
@@ -0,0 +1,6 @@
+import workerString from './worker';
+
+export function getWorkerURL() {
+  const workerBlob = new Blob([workerString]);
+  return URL.createObjectURL(workerBlob);
+}
diff --git a/packages/replay-worker/vendor/worker.d.ts b/packages/replay-worker/vendor/worker.d.ts
diff --git a/packages/replay/.eslintrc.js b/packages/replay/.eslintrc.js
@@ -5,7 +5,6 @@
 
 module.exports = {
   extends: ['../../.eslintrc.js'],
-  ignorePatterns: ['rollup.config.worker.js'],
   overrides: [
     {
       files: ['worker/**/*.ts'],
diff --git a/packages/replay/package.json b/packages/replay/package.json
@@ -7,25 +7,22 @@
   "types": "build/npm/types/index.d.ts",
   "sideEffects": false,
   "scripts": {
-    "build": "run-s build:worker && run-p build:core build:types build:bundle",
-    "build:transpile": "run-s build:worker build:core",
+    "build": "run-p build:transpile build:types build:bundle",
+    "build:transpile": "rollup -c rollup.npm.config.js",
     "build:bundle": "rollup -c rollup.bundle.config.js",
-    "build:dev": "run-p build:worker build:transpile build:types",
-    "build:worker": "rollup -c rollup.config.worker.js",
-    "build:core": "rollup -c rollup.npm.config.js",
+    "build:dev": "run-p build:transpile build:types",
     "build:types": "tsc -p tsconfig.types.json",
-    "build:watch": "run-p build:worker:watch build:core:watch build:bundle:watch build:types:watch",
-    "build:dev:watch": "run-p build:core:watch build:types:watch",
-    "build:core:watch": "yarn build:core --watch",
-    "build:worker:watch": "yarn build:worker --watch",
+    "build:watch": "run-p build:transpile:watch build:bundle:watch build:types:watch",
+    "build:dev:watch": "run-p build:transpile:watch build:types:watch",
+    "build:transpile:watch": "yarn build:transpile --watch",
     "build:bundle:watch": "yarn build:bundle --watch",
     "build:types:watch": "tsc -p tsconfig.types.json --watch",
     "build:tarball": "ts-node ../../scripts/prepack.ts --bundles && npm pack ./build/npm",
     "circularDepCheck": "madge --circular src/index.ts",
     "clean": "rimraf build sentry-replay-*.tgz",
     "fix": "run-s fix:eslint fix:prettier",
     "fix:eslint": "eslint . --format stylish --fix",
-    "fix:prettier": "prettier --write \"{src,test,scripts,worker}/**/*.ts\"",
+    "fix:prettier": "prettier --write \"{src,test,scripts}/**/*.ts\"",
     "lint": "run-s lint:prettier lint:eslint",
     "lint:eslint": "eslint . --format stylish",
     "lint:prettier": "prettier --check \"{src,test,scripts,worker}/**/*.ts\"",
@@ -46,10 +43,9 @@
   "homepage": "https://docs.sentry.io/platforms/javascript/session-replay/",
   "devDependencies": {
     "@babel/core": "^7.17.5",
+    "@sentry-internal/replay-worker": "7.37.2",
     "@sentry-internal/rrweb": "1.103.0",
-    "@types/pako": "^2.0.0",
     "jsdom-worker": "^0.2.1",
-    "pako": "^2.0.4",
     "tslib": "^1.9.3"
   },
   "dependencies": {
diff --git a/packages/replay/rollup.npm.config.js b/packages/replay/rollup.npm.config.js
@@ -5,8 +5,7 @@ export default makeNPMConfigVariants(
     hasBundles: true,
     packageSpecificConfig: {
       output: {
-        // set exports to 'named' or 'auto' so that rollup doesn't warn about
-        // the default export in `worker/worker.js`
+        // 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.
diff --git a/packages/replay/src/eventBuffer/index.ts b/packages/replay/src/eventBuffer/index.ts
@@ -1,7 +1,7 @@
+import { getWorkerURL } from '@sentry-internal/replay-worker';
 import { logger } from '@sentry/utils';
 
 import type { EventBuffer } from '../types';
-import workerString from '../worker/worker.js';
 import { EventBufferArray } from './EventBufferArray';
 import { EventBufferProxy } from './EventBufferProxy';
 
@@ -16,8 +16,7 @@ export function createEventBuffer({ useCompression }: CreateEventBufferParams):
   // eslint-disable-next-line no-restricted-globals
   if (useCompression && window.Worker) {
     try {
-      const workerBlob = new Blob([workerString]);
-      const workerUrl = URL.createObjectURL(workerBlob);
+      const workerUrl = getWorkerURL();
 
       __DEBUG_BUILD__ && logger.log('[Replay] Using compression worker');
       const worker = new Worker(workerUrl);
diff --git a/packages/replay/src/worker/worker.js b/packages/replay/src/worker/worker.js
diff --git a/packages/replay/tsconfig.worker.json b/packages/replay/tsconfig.worker.json
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+module.exports = require('../../jest/jest.config.js');`