Files
rrweb/packages/rrweb-snapshot/test/utils.test.ts
Justin Halsall 5a85ddf013 Chore: Migrate build to vite (#1033)
* Chore: Add move most types from rrweb to @rrweb/types package

* Split off type imports

* Split off type import to its own line

* Get vite to generate type definitions

* Apply formatting changes

* noEmit not allowed in tsconfig, moved it to build step

* Migrate rrdom-nodejs build to vite

* Apply formatting changes

* Migrate rrweb-snapshot to vite

* Unify configs

* Chore: Migrate rrdom to vite

Turns out what we where doing by overwriting `public textContent: string | undefined` as a getter in a subclass is something that isn't allowed in typescript. Because we where using `// @ts-ignore`  to hide this error our bundler chose to allow the overwrite. Vite choses to disallow the overwrite making all subclasses' `textContent` undefined.
To mitigate this we're using an abstract class, which does allow sub classes to decide if they wan't to use getters or not.

* Chore: Migrate rrweb to vite WIP

* build:browser was removed (for now)

* BREAKING: moved rrweb-plugin-console to its own npm module

This removes console from rrweb-all.js

* Support cjs files in startServer

* Move canvas-webrtc plugin to its own package

* Chore: move sequential-id plugin to its own package

* Chore: Configure rrweb's vite bundling

* `Id` had lowercase `d` before, making it lowercase again

* Test: Move console tests to their own package

* remove unused utils from rrdom

* pull in latest version of master
something when wrong earlier when resolving merge conflicts, this should be correct

* Fix type casting issue in diff.ts

* Fix typo

* Fix duplicate entries in package.json and tsconfig.json

* Apply formatting changes

* Update dependencies in package.json files

* Update dependencies to use Vite 5.2.8 in package.json files

* Get tests passing for rrdom

`apply virtual style rules to node` tests need to be moved to rrweb to avoid circular dependencies

* Fix image loading issue in integration tests

* Move pack/unpack to its own @rrweb/packer module

* Get tests to work in rrdom-nodejs

* Port tests in rrweb-snapshot to vitest and fix them

* Fix tests for rrweb-plugin-console-record

* Add @rrweb/all package

* Fix publint and attw errors for rrdom and @rrweb/types

* Use shared vitest.config.ts in rrweb-snapshot package

* Fix publint and attw issues for rrweb-snapshot

* Export `ReplayPlugin` type directly from rrweb

* Fix publint and attw issues for packages

* Fix publint & attw issue.

I was bumping into this issue: 3729bc2a3c/docs/problems/NoResolution.md

And had to choose one of these three methods described here:
https://github.com/andrewbranch/example-subpath-exports-ts-compat?tab=readme-ov-file#typescript-friendly-strategies-for-packagejson-subpath-exports-compatibility
And I ended up going for the method described here:
1ffe3425b0/examples/node_modules/package-json-redirects (package-json-redirects)

The redirect method seemed the least invasive and most effective.

* Fix publint & attw issue.

I was bumping into this issue: 3729bc2a3c/docs/problems/NoResolution.md

And had to choose one of these three methods described here:
https://github.com/andrewbranch/example-subpath-exports-ts-compat?tab=readme-ov-file#typescript-friendly-strategies-for-packagejson-subpath-exports-compatibility
And I ended up going for the method described here:
1ffe3425b0/examples/node_modules/package-json-redirects (package-json-redirects)

The redirect method seemed the least invasive and most effective.

* move some rrdom tests that require rrweb to rrweb package

* Use pre-jest 29 syntax for snapshotting

* get rrweb passing publint and attw

* const enum does not work with isolated modules flag

* Fix script tag type in webgl.test.ts.snap and update rrweb.umd.cjs path in webgl.test.ts

* Fix paths

* Move tests for console record plugin and fix bundle path

* Fix tests for rrweb

* pack integration tests were moved to @rrweb/all

* Update rrweb bundle path in test files

* Fix flaky scroll emit from test

* Migrate rrweb's tests over to vitest and make them pass

* Make sure benchmarks & updating tests work

* Remove jest from rrweb

* Fix paths

* always use rrweb's own cssom

* Update tsconfig.json for rrweb-plugin-sequential-id-record

Fixes this error:
Error: @rrweb/rrweb-plugin-sequential-id-record:prepublish: tsconfig.json(9,5): error TS6377: Cannot write file '/home/runner/work/rrweb/rrweb/tsconfig.tsbuildinfo' because it will overwrite '.tsbuildinfo' file generated by referenced project '/home/runner/work/rrweb/rrweb/packages/rrweb'

* Add tsbuildinfo config to extended tsconfig files

* Move rrdom over to vitest

* Apply formatting changes

* Update rrweb imports to use the new package structure

* extend rrweb-snapshot's tsconfig from monorepo base config

* extend @rrweb/types's tsconfig from monorepo base config

* extend rrdom's tsconfig from monorepo base config

* extend rrdom-nodejs's tsconfig from monorepo base config

* extend web-extension's tsconfig from monorepo base config

* unify tsconfigs

* Continue when tests fail

* Add stricter type checking

* Add check-types global command

* remove jest

* Remove unused code

* Add check-types command to build script

* Fix linting issues

* Add setup Chrome action for CI/CD workflow

* Update puppeteer version in package.json for rrweb

* Update Chrome setup in CI/CD workflow

* Update Chrome setup in CI/CD workflow

* Add Chrome setup and test cache location

* Update CI/CD workflow to test chrome cache location

* Add chrome installation step to CI/CD workflow

* Update Puppeteer configuration for headless testing

* Update dependencies and workflow configuration

* Use same version of chrome on CI as is run locally

* Use version of chrome that seems to work with rrdom tests

* Try using puppeteerrc to define chrome version

* Add .cache directory to .gitignore

* Move global flag to vitest config

* Update puppeteer version to 20.9.0

* Update console log messages in rrweb-plugin-console-record for new puppeteer version

* Remove redundant Chrome setup from CI/CD workflow

* Add minification and umd for all built files

* Update import paths for rrweb dist files

* Add @rrweb/replay and @rrweb/record

* Add script to lint packages

* Apply formatting changes

* exclude styles export from typescript package type checking

* WIP Move rrweb-player over to vite

* Apply formatting changes

* chore: Update rrweb plugin import paths

* Remove rollup from rrweb-player

* Fix typing issues

* Fix typing issues

* chore: Update rrweb-player to use vite for build process

* Apply formatting changes

* chore: Export Player class in rrweb-player/src/main.ts

Makes attw happy

* Apply formatting changes

* Gets wiped by yarn workspaces-to-typescript-project-references

* Add .eslintignore and .eslintrc.cjs files for rrweb-player package

* Apply formatting changes

* Update dependencies in rrweb-player/package.json

* Apply formatting changes

* chore: Update eslint configuration for rrweb-player package

* Apply formatting changes

* chore: Remove unused files from rrweb-player package

* Apply formatting changes

* chore: Update rrweb-player import path to use rrweb-player.cjs

* chore: Update addEventListener signature in rrweb-player

* Apply formatting changes

* Add .eslintignore and update .gitignore files for to root

* Apply formatting changes

* Update documentation

* Update @rrweb/types package description

* Apply formatting changes

* Update build and run commands in CONTRIBUTING.md

* Apply formatting changes

* Update package versions to 2.0.0-alpha.13

* Apply formatting changes

* Apply formatting changes

* Fix import statement in media/index.ts

* Apply formatting changes

* chore: Update .gitignore to exclude build and dist directories

* Apply formatting changes

* Apply formatting changes

* Migrate setTimeout to vitest

* Apply formatting changes

* Apply formatting changes

* Fix isNativeShadowDom function signature in utils.ts

* try out jsr

* Apply formatting changes

* Update package versions to 2.0.0-alpha.14

* Apply formatting changes

* Fix name of rrwebSnapshot object

* Apply formatting changes

* Remove unused lock files

* Apply formatting changes

* Update rrweb bundle path to use umd.cjs format

* Apply formatting changes

* Trigger tests to run again

* Rename snapshots for vitest

* Apply formatting changes

* Ping CI

* Apply formatting changes

* Ping CI

* Apply formatting changes

* Ignore files generated by svelte-kit for prettier

* Correct Player object
2026-04-01 12:00:00 +08:00

203 lines
6.3 KiB
TypeScript

/**
* @vitest-environment jsdom
*/
import { describe, it, test, expect } from 'vitest';
import { NodeType, serializedNode } from '../src/types';
import { extractFileExtension, isNodeMetaEqual } from '../src/utils';
import type { serializedNodeWithId } from 'rrweb-snapshot';
describe('utils', () => {
describe('isNodeMetaEqual()', () => {
const document1: serializedNode = {
type: NodeType.Document,
compatMode: 'CSS1Compat',
childNodes: [],
};
const document2: serializedNode = {
type: NodeType.Document,
compatMode: 'BackCompat',
childNodes: [],
};
const documentType1: serializedNode = {
type: NodeType.DocumentType,
name: 'html',
publicId: '',
systemId: '',
};
const documentType2: serializedNode = {
type: NodeType.DocumentType,
name: 'html',
publicId: '',
systemId: 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd',
};
const text1: serializedNode = {
type: NodeType.Text,
textContent: 'Hello World',
};
const text2: serializedNode = {
type: NodeType.Text,
textContent: 'Hello world',
};
const comment1: serializedNode = {
type: NodeType.Comment,
textContent: 'Hello World',
};
const comment2: serializedNode = {
type: NodeType.Comment,
textContent: 'Hello world',
};
const element1: serializedNode = {
type: NodeType.Element,
tagName: 'div',
attributes: {
className: 'test',
},
childNodes: [],
};
const element2: serializedNode = {
type: NodeType.Element,
tagName: 'span',
attributes: {
'aria-label': 'Hello World',
},
childNodes: [],
};
const element3: serializedNode = {
type: NodeType.Element,
tagName: 'div',
attributes: { id: 'test' },
childNodes: [comment1 as serializedNodeWithId],
};
it('should return false if two nodes have different node types', () => {
expect(
isNodeMetaEqual(
undefined as unknown as serializedNode,
null as unknown as serializedNode,
),
).toBeFalsy();
expect(isNodeMetaEqual(document1, element1)).toBeFalsy();
expect(isNodeMetaEqual(document1, documentType1)).toBeFalsy();
expect(isNodeMetaEqual(documentType1, element1)).toBeFalsy();
expect(isNodeMetaEqual(text1, comment1)).toBeFalsy();
expect(isNodeMetaEqual(text1, element1)).toBeFalsy();
expect(isNodeMetaEqual(comment1, element1)).toBeFalsy();
});
it('should compare meta data of two document nodes', () => {
expect(
isNodeMetaEqual(document1, JSON.parse(JSON.stringify(document1))),
).toBeTruthy();
expect(
isNodeMetaEqual(JSON.parse(JSON.stringify(document2)), document2),
).toBeTruthy();
expect(isNodeMetaEqual(document1, document2)).toBeFalsy();
});
it('should compare meta data of two documentType nodes', () => {
expect(
isNodeMetaEqual(
documentType1,
JSON.parse(JSON.stringify(documentType1)),
),
).toBeTruthy();
expect(
isNodeMetaEqual(
JSON.parse(JSON.stringify(documentType2)),
documentType2,
),
).toBeTruthy();
expect(isNodeMetaEqual(documentType1, documentType2)).toBeFalsy();
});
it('should compare meta data of two text nodes', () => {
expect(
isNodeMetaEqual(text1, JSON.parse(JSON.stringify(text1))),
).toBeTruthy();
expect(
isNodeMetaEqual(JSON.parse(JSON.stringify(text2)), text2),
).toBeTruthy();
expect(isNodeMetaEqual(text1, text2)).toBeFalsy();
});
it('should compare meta data of two comment nodes', () => {
expect(
isNodeMetaEqual(comment1, JSON.parse(JSON.stringify(comment1))),
).toBeTruthy();
expect(
isNodeMetaEqual(JSON.parse(JSON.stringify(comment2)), comment2),
).toBeTruthy();
expect(isNodeMetaEqual(comment1, comment2)).toBeFalsy();
});
it('should compare meta data of two HTML elements', () => {
expect(
isNodeMetaEqual(element1, JSON.parse(JSON.stringify(element1))),
).toBeTruthy();
expect(
isNodeMetaEqual(JSON.parse(JSON.stringify(element2)), element2),
).toBeTruthy();
expect(
isNodeMetaEqual(element1, {
...element1,
childNodes: [comment2 as serializedNodeWithId],
}),
).toBeTruthy();
expect(isNodeMetaEqual(element1, element2)).toBeFalsy();
expect(isNodeMetaEqual(element1, element3)).toBeFalsy();
expect(isNodeMetaEqual(element2, element3)).toBeFalsy();
});
});
describe('extractFileExtension', () => {
test('absolute path', () => {
const path = 'https://example.com/styles/main.css';
const extension = extractFileExtension(path);
expect(extension).toBe('css');
});
test('relative path', () => {
const path = 'styles/main.css';
const baseURL = 'https://example.com/';
const extension = extractFileExtension(path, baseURL);
expect(extension).toBe('css');
});
test('path with search parameters', () => {
const path = 'https://example.com/scripts/app.js?version=1.0';
const extension = extractFileExtension(path);
expect(extension).toBe('js');
});
test('path with fragment', () => {
const path = 'https://example.com/styles/main.css#section1';
const extension = extractFileExtension(path);
expect(extension).toBe('css');
});
test('path with search parameters and fragment', () => {
const path = 'https://example.com/scripts/app.js?version=1.0#section1';
const extension = extractFileExtension(path);
expect(extension).toBe('js');
});
test('path without extension', () => {
const path = 'https://example.com/path/to/directory/';
const extension = extractFileExtension(path);
expect(extension).toBeNull();
});
test('invalid URL', () => {
const path = '!@#$%^&*()';
const baseURL = 'invalid';
const extension = extractFileExtension(path, baseURL);
expect(extension).toBeNull();
});
test('path with multiple dots', () => {
const path = 'https://example.com/scripts/app.min.js?version=1.0';
const extension = extractFileExtension(path);
expect(extension).toBe('js');
});
});
});