ref: tweaks to tasks to get builds/pkg names working for Sentry

Author: billyvg

.github/workflows/ci-cd.yml

@@ -40,7 +40,7 @@ jobs:
         run: PUPPETEER_HEADLESS=true xvfb-run --server-args="-screen 0 1920x1080x24" yarn test
 
       - name: Upload diff images to GitHub
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         if: failure()
         with:
           name: image-diff
@@ -71,11 +71,11 @@ jobs:
 
       - name: Build Tarballs
         env:
-          NODE_OPTIONS: "--max_old_space_size=4096"
+          NODE_OPTIONS: '--max_old_space_size=4096'
         run: yarn build:tarball
 
       - name: Upload Artifacts
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: ${{ github.sha }}
           path: |

.github/workflows/size-check.yml

@@ -28,7 +28,7 @@ jobs:
         # Continue to the next step even if this fails
         continue-on-error: true
       - name: Upload ESLint Report
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: eslint_report.json
           path: eslint_report.json

.github/workflows/style-check.yml

@@ -14,6 +14,8 @@ From this monorepo, Sentry maintains and publishes the following NPM packages:
 - `@sentry-internal/rrdom` (corresponds to the [original `rrdom` package](https://www.npmjs.com/package/rrdom))
 - `@sentry-internal/rrweb-player` (corresponds to the [original `rrweb-player` package](https://www.npmjs.com/package/rrweb-player))
 - `@sentry-internal/rrweb-snapshot` (corresponds to the [original `rrweb-snapshot` package](https://www.npmjs.com/package/rrweb-snapshot))
+- `@sentry-internal/rrweb-types` (corresponds to the [original `@rrweb/types` package](https://www.npmjs.com/package/@rrweb/types))
+- `@sentry-internal/rrweb-worker` (new package)
 
 ## Major changes from upstream branch
 

README.md

@@ -44,7 +44,7 @@
     "typescript": "^4.9.5"
   },
   "scripts": {
-    "build:all": "NODE_OPTIONS='--max-old-space-size=4096' yarn run concurrently --success=all -r -m=1 'yarn workspaces-to-typescript-project-references' 'yarn turbo run prepare'",
+    "build:all": "NODE_OPTIONS='--max-old-space-size=4096' yarn run concurrently --success=all -r -m=1 'yarn workspaces-to-typescript-project-references' 'yarn turbo run prepack'",
     "build:tarball": "yarn lerna run build:tarball",
     "test": "yarn run concurrently --success=all -r -m=1 'yarn workspaces-to-typescript-project-references --check' 'yarn turbo run test --concurrency=1 --continue'",
     "test:watch": "yarn turbo run test:watch",
@@ -54,7 +54,6 @@
     "format:head": "git diff --name-only HEAD^ |grep '\\.ts$\\|\\.md$' |xargs yarn prettier --write",
     "dev": "CLEAR_DIST_DIR=false yarn turbo run dev --concurrency=17",
     "repl": "cd packages/rrweb && npm run repl",
-    "typings": "yarn turbo run typings",
     "live-stream": "cd packages/rrweb && yarn live-stream",
     "lint": "yarn run concurrently --success=all -r -m=1 'yarn run markdownlint docs' 'yarn eslint packages/*/src --ext .ts,.tsx,.js,.jsx,.svelte'",
     "lint:report": "yarn eslint --output-file eslint_report.json --format json packages/*/src --ext .ts,.tsx,.js,.jsx",

package.json

@@ -14,7 +14,7 @@
     "test": "vitest run",
     "test:watch": "vitest watch",
     "check-types": "tsc -noEmit",
-    "prepublish": "npm run build",
+    "prepack": "npm run build",
     "lint": "yarn eslint src/**/*.ts"
   },
   "homepage": "https://github.com/rrweb-io/rrweb/tree/main/packages/@rrweb/all#readme",
@@ -56,9 +56,9 @@
     "typescript": "^4.7.3"
   },
   "dependencies": {
-    "@rrweb/types": "^2.0.0-alpha.14",
-    "@rrweb/packer": "^2.0.0-alpha.14",
-    "rrweb": "^2.0.0-alpha.14"
+    "@sentry-internal/rrweb": "^2.0.0-alpha.14",
+    "@sentry-internal/rrweb-packer": "^2.0.0-alpha.14",
+    "@sentry-internal/rrweb-types": "^2.0.0-alpha.14"
   },
   "browserslist": [
     "supports es6-class"

packages/all/package.json

@@ -1,4 +1,4 @@
-export * from 'rrweb';
-export * from '@rrweb/packer';
+export * from '@sentry-internal/rrweb';
+export * from '@sentry-internal/rrweb-packer';
 // export * from '@rrweb/rrweb-plugin-console-record';
 // export * from '@rrweb/rrweb-plugin-console-replay';

packages/all/src/index.ts

@@ -11,14 +11,14 @@ import type {
   eventWithTime,
   listenerHandler,
   mutationData,
-} from '@rrweb/types';
-import { unpack } from '@rrweb/packer';
+} from '@sentry-internal/rrweb-types';
+import { unpack } from '@sentry-internal/rrweb-packer';
 import * as fs from 'fs';
 import * as path from 'path';
 import type * as puppeteer from 'puppeteer';
-import type { recordOptions } from 'rrweb';
-import type {} from '@rrweb/types';
-import { EventType } from '@rrweb/types';
+import type { recordOptions } from '@sentry-internal/rrweb';
+import type {} from '@sentry-internal/rrweb-types';
+import { EventType } from '@sentry-internal/rrweb-types';
 import {
   assertSnapshot,
   getServerURL,

packages/all/test/cross-origin-iframe-packer.test.ts

@@ -1,4 +1,4 @@
-import { NodeType } from 'rrweb-snapshot';
+import { NodeType } from '@sentry-internal/rrweb-snapshot';
 import { expect } from 'vitest';
 import {
   EventType,
@@ -8,7 +8,7 @@ import {
   mouseInteractionData,
   event,
   pluginEvent,
-} from '@rrweb/types';
+} from '@sentry-internal/rrweb-types';
 import * as puppeteer from 'puppeteer';
 import * as path from 'path';
 import * as http from 'http';

packages/all/test/utils.ts

@@ -1,19 +1,21 @@
 {
   "extends": "../../tsconfig.base.json",
-  "include": ["src"],
+  "include": [
+    "src"
+  ],
   "compilerOptions": {
     "rootDir": "src",
     "tsBuildInfoFile": "./tsconfig.tsbuildinfo"
   },
   "references": [
     {
-      "path": "../types"
+      "path": "../rrweb"
     },
     {
       "path": "../packer"
     },
     {
-      "path": "../rrweb"
+      "path": "../types"
     }
   ]
 }

packages/all/tsconfig.json

@@ -1,6 +1,6 @@
 {
-  "name": "@rrweb/packer",
-  "version": "2.0.0-alpha.14",
+  "name": "@sentry-internal/rrweb-packer",
+  "version": "2.31.0",
   "publishConfig": {
     "access": "public"
   },
@@ -11,10 +11,11 @@
   "scripts": {
     "dev": "vite build --watch",
     "build": "tsc -noEmit && vite build",
+    "build:tarball": "npm pack",
     "test": "vitest run",
     "test:watch": "vitest watch",
     "check-types": "tsc -noEmit",
-    "prepublish": "npm run build",
+    "prepack": "npm run build",
     "lint": "yarn eslint src/**/*.ts"
   },
   "homepage": "https://github.com/rrweb-io/rrweb/tree/main/packages/@rrweb/packer#readme",
@@ -78,7 +79,7 @@
   },
   "dependencies": {
     "fflate": "^0.4.4",
-    "@rrweb/types": "^2.0.0-alpha.14"
+    "@sentry-internal/rrweb-types": "^2.31.0"
   },
   "browserslist": [
     "supports es6-class"

packages/packer/package.json

@@ -1,8 +1,8 @@
 import { strFromU8, strToU8, zlibSync } from 'fflate';
-import type { PackFn } from '@rrweb/types';
+import type { PackFn, eventWithTime } from '@sentry-internal/rrweb-types';
 import { eventWithTimeAndPacker, MARK } from './base';
 
-export const pack: PackFn = (event) => {
+export const pack: PackFn = (event: eventWithTime) => {
   const _e: eventWithTimeAndPacker = {
     ...event,
     v: MARK,

packages/packer/src/pack.ts

@@ -27,7 +27,7 @@
     "dev": "vite build --watch",
     "build": "tsc -noEmit && vite build",
     "check-types": "tsc -noEmit",
-    "prepublish": "npm run build"
+    "prepack": "npm run build"
   },
   "repository": {
     "type": "git",
@@ -43,12 +43,12 @@
   },
   "homepage": "https://github.com/rrweb-io/rrweb#readme",
   "devDependencies": {
-    "rrweb": "^2.0.0-alpha.14",
+    "@sentry-internal/rrweb": "^2.0.0-alpha.14",
     "typescript": "^4.7.3",
     "vite": "^5.2.8",
     "vite-plugin-dts": "^3.8.1"
   },
   "peerDependencies": {
-    "rrweb": "^2.0.0-alpha.14"
+    "@sentry-internal/rrweb": "^2.0.0-alpha.14"
   }
 }

packages/plugins/rrweb-plugin-canvas-webrtc-record/package.json

@@ -1,7 +1,11 @@
 {
   "extends": "../../../tsconfig.base.json",
-  "include": ["src"],
-  "exclude": ["vite.config.ts"],
+  "include": [
+    "src"
+  ],
+  "exclude": [
+    "vite.config.ts"
+  ],
   "compilerOptions": {
     "rootDir": "src",
     "tsBuildInfoFile": "./tsconfig.tsbuildinfo"

packages/plugins/rrweb-plugin-canvas-webrtc-record/tsconfig.json

@@ -27,7 +27,7 @@
     "dev": "vite build --watch",
     "build": "tsc -noEmit && vite build",
     "check-types": "tsc -noEmit",
-    "prepublish": "npm run build"
+    "prepack": "npm run build"
   },
   "repository": {
     "type": "git",
@@ -43,12 +43,12 @@
   },
   "homepage": "https://github.com/rrweb-io/rrweb#readme",
   "devDependencies": {
-    "rrweb": "^2.0.0-alpha.14",
+    "@sentry-internal/rrweb": "^2.0.0-alpha.14",
     "typescript": "^4.7.3",
     "vite": "^5.2.8",
     "vite-plugin-dts": "^3.8.1"
   },
   "peerDependencies": {
-    "rrweb": "^2.0.0-alpha.14"
+    "@sentry-internal/rrweb": "^2.0.0-alpha.14"
   }
 }

packages/plugins/rrweb-plugin-canvas-webrtc-replay/package.json

@@ -1,7 +1,7 @@
 import type { RRNode } from '@sentry-internal/rrdom';
 import type { Mirror } from '@sentry-internal/rrweb-snapshot';
 import SimplePeer from 'simple-peer-light';
-import type { ReplayPlugin, Replayer } from 'rrweb';
+import type { ReplayPlugin, Replayer } from '@sentry-internal/rrweb';
 import type { WebRTCDataChannel } from './types';
 
 // TODO: restrict callback to real nodes only, or make sure callback gets called when real node gets added to dom as well

packages/plugins/rrweb-plugin-canvas-webrtc-replay/src/index.ts

@@ -1,7 +1,11 @@
 {
   "extends": "../../../tsconfig.base.json",
-  "include": ["src"],
-  "exclude": ["vite.config.ts"],
+  "include": [
+    "src"
+  ],
+  "exclude": [
+    "vite.config.ts"
+  ],
   "compilerOptions": {
     "rootDir": "src",
     "tsBuildInfoFile": "./tsconfig.tsbuildinfo"

packages/plugins/rrweb-plugin-canvas-webrtc-replay/tsconfig.json

@@ -29,7 +29,7 @@
     "test:watch": "vitest watch",
     "build": "tsc -noEmit && vite build",
     "check-types": "tsc -noEmit",
-    "prepublish": "npm run build"
+    "prepack": "npm run build"
   },
   "repository": {
     "type": "git",
@@ -45,14 +45,14 @@
   },
   "homepage": "https://github.com/rrweb-io/rrweb#readme",
   "devDependencies": {
-    "rrweb": "^2.0.0-alpha.14",
+    "@sentry-internal/rrweb": "^2.0.0-alpha.14",
     "typescript": "^4.7.3",
     "vite": "^5.2.8",
     "vite-plugin-dts": "^3.8.1",
     "vitest": "^1.4.0",
     "puppeteer": "^20.9.0"
   },
   "peerDependencies": {
-    "rrweb": "^2.0.0-alpha.14"
+    "@sentry-internal/rrweb": "^2.0.0-alpha.14"
   }
 }

packages/plugins/rrweb-plugin-console-record/package.json

@@ -1,5 +1,5 @@
-import type { eventWithTime } from '@rrweb/types';
-import { record } from 'rrweb';
+import type { eventWithTime } from '@sentry-internal/rrweb-types';
+import { record } from '@sentry-internal/rrweb';
 import { getRecordConsolePlugin } from '../../src/index';
 
 window.Date.now = () => new Date(Date.UTC(2018, 10, 15, 8)).valueOf();

packages/plugins/rrweb-plugin-console-record/test/html/index.ts

@@ -3,7 +3,7 @@ import { stringifySnapshots } from '../../../rrweb/test/utils';
 import { createServer, ViteDevServer } from 'vite';
 import * as puppeteer from 'puppeteer';
 import type { Browser, Page } from 'puppeteer';
-import type { eventWithTime } from '@rrweb/types';
+import type { eventWithTime } from '@sentry-internal/rrweb-types';
 
 export async function launchPuppeteer(
   options?: Parameters<(typeof puppeteer)['launch']>[0],

packages/plugins/rrweb-plugin-console-record/test/index.test.ts

@@ -1,11 +1,16 @@
 {
   "extends": "../../../tsconfig.base.json",
-  "include": ["src"],
-  "exclude": ["vite.config.ts", "vitest.config.ts", "test"],
+  "include": [
+    "src"
+  ],
+  "exclude": [
+    "vite.config.ts",
+    "vitest.config.ts",
+    "test"
+  ],
   "compilerOptions": {
     "rootDir": "src",
     "tsBuildInfoFile": "./tsconfig.tsbuildinfo",
-
     // TODO: enable me in the future
     // at time of writing (April 2024) there are 6 errors in this package
     "strict": false