Skip to content

Commit

Permalink
upstream: merge commits up to 46f1b25 (#216)
Browse files Browse the repository at this point in the history
Merges the following commits:

* [Ensure there is separation of
timestamps](rrweb-io#1455)
* [perf(snapshot): avoid recreate element a every
time](rrweb-io#1387)
* [Fix that blob urls persist on the shared anchor element and can't be
later modified](rrweb-io#1467)
* [yarn format - prettier improvements & add
.editorconfig](rrweb-io#1471)
* [Fixup for background-clip
replacement](rrweb-io#1476)
* [Fix and test for bug](rrweb-io#1481)
  • Loading branch information
billyvg authored Sep 6, 2024
2 parents 9fadbb2 + cbc4e92 commit 50b54a9
Show file tree
Hide file tree
Showing 25 changed files with 247 additions and 43 deletions.
2 changes: 2 additions & 0 deletions .changeset/curvy-balloons-brake.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
---
4 changes: 2 additions & 2 deletions .changeset/eleven-bobcats-peel.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
'rrweb-snapshot': patch
'rrweb': patch
"rrweb-snapshot": patch
"rrweb": patch
---

better support for coexistence with older libraries (e.g. MooTools & Prototype.js) which modify the in-built `Array.from` function
6 changes: 6 additions & 0 deletions .changeset/fair-ducks-clean.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"rrweb-snapshot": patch
"rrweb": patch
---

Fix and test for bug #1457 which was affecting replay of complex tailwind css
6 changes: 6 additions & 0 deletions .changeset/fast-pets-exist.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"rrweb-snapshot": patch
"rrweb": patch
---

Fixup for multiple background-clip replacement
2 changes: 2 additions & 0 deletions .changeset/format-head-prettier.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
---
10 changes: 10 additions & 0 deletions .changeset/hungry-dodos-taste.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
'rrweb-snapshot': patch
---

Avoid recreating the same element every time, instead, we cache and we just update the element.

Before: 779k ops/s
After: 860k ops/s

Benchmark: https://jsbench.me/ktlqztuf95/1
4 changes: 2 additions & 2 deletions .changeset/little-moons-camp.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
'rrweb-snapshot': minor
'rrweb': minor
"rrweb-snapshot": minor
"rrweb": minor
---

feat: Better masking of option/radio/checkbox values
6 changes: 6 additions & 0 deletions .changeset/nervous-kiwis-nail.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'rrweb-snapshot': patch
'rrweb': patch
---

Bugfix after #1434 perf improvements: fix that blob urls persist on the shared anchor element and can't be later modified
4 changes: 2 additions & 2 deletions .changeset/twenty-tables-call.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
'rrweb-snapshot': patch
'rrweb': patch
"rrweb-snapshot": patch
"rrweb": patch
---

Add `maskAttributesFn` to be called when transforming an attribute. This is typically used to determine if an attribute should be masked or not.
14 changes: 14 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
root = true

# initialized from https://prettier.io/docs/en/configuration.html#editorconfig
[*]
charset = utf-8
insert_final_newline = true
end_of_line = lf
indent_style = space
indent_size = 2
max_line_length = 80
quote_type = single

[.changeset/*.md]
quote_type = double
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ dist

.turbo

# emacs working files end in a tilde
*~

# `.yarn/install-state.gz` is an optimization file that you shouldn't ever have to commit.
# It simply stores the exact state of your project so that the next commands can boot without having to resolve your workspaces all over again.
.yarn/install-state.gz
Expand Down
107 changes: 107 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
# list of old changeset files that were mutated to use single quotes by a previous version of prettier:
.changeset/attribute-text-reductions.md
.changeset/avoid-costly-createlement.md
.changeset/brave-numbers-joke.md
.changeset/breezy-cats-heal.md
.changeset/breezy-mice-breathe.md
.changeset/calm-bulldogs-speak.md
.changeset/calm-oranges-sin.md
.changeset/chatty-cherries-train.md
.changeset/clean-plants-play.md
.changeset/clean-shrimps-lay.md
.changeset/cold-eyes-hunt.md
.changeset/cold-hounds-teach.md
.changeset/controller-finish-flag.md
.changeset/cool-grapes-hug.md
.changeset/cuddly-readers-warn.md
.changeset/curvy-apples-lay.md
.changeset/curvy-balloons-brake.md
.changeset/date-now-guard.md
.changeset/dirty-rules-dress.md
.changeset/eight-terms-hunt.md
.changeset/empty-bikes-cheer.md
.changeset/event-single-wrap.md
.changeset/fair-dragons-greet.md
.changeset/fast-chefs-smell.md
.changeset/few-rockets-travel.md
.changeset/few-turkeys-reflect.md
.changeset/five-peas-lay.md
.changeset/fluffy-planes-retire.md
.changeset/forty-elephants-attack.md
.changeset/fresh-cars-impress.md
.changeset/fresh-spoons-drive.md
.changeset/friendly-numbers-leave.md
.changeset/gold-apples-joke.md
.changeset/gold-terms-look.md
.changeset/grumpy-ways-own.md
.changeset/hip-worms-relax.md
.changeset/hungry-dodos-taste.md
.changeset/itchy-dryers-double.md
.changeset/khaki-dots-bathe.md
.changeset/large-ants-prove.md
.changeset/lazy-squids-draw.md
.changeset/lazy-toes-confess.md
.changeset/lemon-lamps-switch.md
.changeset/light-fireants-exercise.md
.changeset/little-radios-thank.md
.changeset/little-suits-leave.md
.changeset/loud-seals-raise.md
.changeset/lovely-pears-cross.md
.changeset/lovely-students-boil.md
.changeset/mean-tips-impress.md
.changeset/mighty-ads-worry.md
.changeset/mighty-bulldogs-begin.md
.changeset/mighty-frogs-sparkle.md
.changeset/modern-doors-watch.md
.changeset/moody-dots-refuse.md
.changeset/nervous-buses-pump.md
.changeset/nervous-kiwis-nail.md
.changeset/nervous-mirrors-perform.md
.changeset/nervous-poets-grin.md
.changeset/nervous-tables-travel.md
.changeset/new-snakes-call.md
.changeset/nice-pugs-reply.md
.changeset/old-dryers-hide.md
.changeset/polite-olives-wave.md
.changeset/pretty-plums-rescue.md
.changeset/pretty-schools-remember.md
.changeset/proud-experts-jam.md
.changeset/rare-adults-sneeze.md
.changeset/README.md
.changeset/real-masks-explode.md
.changeset/real-trains-switch.md
.changeset/rich-crews-protect.md
.changeset/rich-dots-lay.md
.changeset/rich-jars-remember.md
.changeset/rotten-spies-enjoy.md
.changeset/serious-ants-juggle.md
.changeset/silver-pots-sit.md
.changeset/silver-windows-float.md
.changeset/sixty-impalas-laugh.md
.changeset/small-olives-arrive.md
.changeset/smart-ears-refuse.md
.changeset/smart-geckos-cover.md
.changeset/smooth-papayas-boil.md
.changeset/smooth-poems-bake.md
.changeset/spotty-bees-destroy.md
.changeset/stupid-ghosts-help.md
.changeset/swift-dancers-rest.md
.changeset/swift-peas-film.md
.changeset/thin-vans-applaud.md
.changeset/thirty-baboons-punch.md
.changeset/three-baboons-bow.md
.changeset/tidy-swans-repair.md
.changeset/tidy-yaks-joke.md
.changeset/tiny-buckets-love.md
.changeset/tiny-candles-whisper.md
.changeset/tiny-chairs-build.md
.changeset/tricky-panthers-guess.md
.changeset/twenty-goats-kneel.md
.changeset/twenty-lies-switch.md
.changeset/twenty-planets-repeat.md
.changeset/violet-melons-itch.md
.changeset/violet-zebras-cry.md
.changeset/wise-spiders-jog.md
.changeset/witty-kids-talk.md
.changeset/yellow-mails-cheat.md
.changeset/young-timers-grow.md
1 change: 0 additions & 1 deletion .prettierrc
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
{
"singleQuote": true,
"trailingComma": "all"
}
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ clear and has sufficient instructions to be able to reproduce the issue.
- Run a cobrowsing/mirroring session locally: `yarn live-stream`
- Test: `yarn test` or `yarn test:watch`
- Lint: `yarn lint`
- Rewrite files with prettier: `yarn format` or `yarn format:head`

## Coding style

Expand Down
4 changes: 3 additions & 1 deletion docs/development/coding-style.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Coding Style

These are the style guidelines for coding in Electron.
These have been adapted from the style guidelines for coding in Electron.

You can run `yarn lint` to show any style issues detected by `eslint`.

Expand All @@ -9,6 +9,8 @@ You can run `yarn lint` to show any style issues detected by `eslint`.
- End files with a newline.
- Using a plain `return` when returning explicitly at the end of a function.
- Not `return null`, `return undefined`, `null` or `undefined`
- run `yarn format` to rewrite all files in the standard format
- run `yarn format:head` to rewrite files from your last commit

## Documentation

Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
"test:watch": "yarn turbo run test:watch",
"test:update": "yarn turbo run test:update",
"format": "yarn prettier --write '**/*.{ts,md}'",
"format:head": "git diff --name-only HEAD^ |grep '\\.ts$\\|\\.md$' |xargs yarn prettier --write",
"dev": "yarn turbo run dev",
"repl": "cd packages/rrweb && npm run repl",
"typings": "yarn turbo run typings",
Expand Down
12 changes: 11 additions & 1 deletion packages/rrweb-snapshot/src/css.ts
Original file line number Diff line number Diff line change
Expand Up @@ -893,7 +893,17 @@ export function parse(css: string, options: ParserOptions = {}) {
*/

function _compileAtrule(name: string) {
const re = new RegExp('^@' + name + '\\s*([^;]+);');
const re = new RegExp(
'^@' +
name +
'\\s*((?:' +
[
'(?<!\\\\)"(?:\\\\"|[^"])*"',
"(?<!\\\\)'(?:\\\\'|[^'])*'",
'[^;]',
].join('|') +
')+);',
);
return () => {
const pos = position();
const m = match(re);
Expand Down
32 changes: 22 additions & 10 deletions packages/rrweb-snapshot/src/snapshot.ts
Original file line number Diff line number Diff line change
Expand Up @@ -200,23 +200,33 @@ function getAbsoluteSrcsetString(doc: Document, attributeValue: string) {
return output.join(', ');
}

const cachedDocument = new WeakMap<Document, HTMLAnchorElement>();

export function absoluteToDoc(doc: Document, attributeValue: string): string {
if (!attributeValue || attributeValue.trim() === '') {
return attributeValue;
}
const a: HTMLAnchorElement = doc.createElement('a');
a.href = attributeValue;
return a.href;

return getHref(doc, attributeValue);
}

function isSVGElement(el: Element): boolean {
return Boolean(el.tagName === 'svg' || (el as SVGElement).ownerSVGElement);
}

function getHref() {
// return a href without hash
const a = document.createElement('a');
a.href = '';
function getHref(doc: Document, customHref?: string) {
let a = cachedDocument.get(doc);
if (!a) {
a = doc.createElement('a');
cachedDocument.set(doc, a);
}
if (!customHref) {
customHref = '';
} else if (customHref.startsWith('blob:') || customHref.startsWith('data:')) {
return customHref;
}
// note: using `new URL` is slower. See #1434 or https://jsbench.me/uqlud17rxo/1
a.setAttribute('href', customHref);
return a.href;
}

Expand Down Expand Up @@ -250,7 +260,7 @@ export function transformAttribute(
} else if (name === 'srcset') {
return getAbsoluteSrcsetString(doc, value);
} else if (name === 'style') {
return absoluteToStylesheet(value, getHref());
return absoluteToStylesheet(value, getHref(doc));
} else if (tagName === 'object' && name === 'data') {
return absoluteToDoc(doc, value);
}
Expand Down Expand Up @@ -635,6 +645,7 @@ function serializeNode(
});
case n.TEXT_NODE:
return serializeTextNode(n as Text, {
doc,
maskAllText,
maskTextClass,
unmaskTextClass,
Expand Down Expand Up @@ -671,6 +682,7 @@ function getRootId(doc: Document, mirror: Mirror): number | undefined {
function serializeTextNode(
n: Text,
options: {
doc: Document;
maskAllText: boolean;
maskTextClass: string | RegExp;
unmaskTextClass: string | RegExp | null;
Expand Down Expand Up @@ -719,7 +731,7 @@ function serializeTextNode(
n,
);
}
textContent = absoluteToStylesheet(textContent, getHref());
textContent = absoluteToStylesheet(textContent, getHref(options.doc));
}
if (isScript) {
textContent = 'SCRIPT_PLACEHOLDER';
Expand Down Expand Up @@ -873,7 +885,7 @@ function serializeElementNode(
(n as HTMLStyleElement).sheet as CSSStyleSheet,
);
if (cssText) {
attributes._cssText = absoluteToStylesheet(cssText, getHref());
attributes._cssText = absoluteToStylesheet(cssText, getHref(doc));
}
}
// form fields
Expand Down
2 changes: 1 addition & 1 deletion packages/rrweb-snapshot/src/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ function fixBrowserCompatibilityIssuesInCSS(cssText: string): string {
!cssText.includes(' -webkit-background-clip: text;')
) {
cssText = cssText.replace(
' background-clip: text;',
/\sbackground-clip:\s*text;/g,
' -webkit-background-clip: text; background-clip: text;',
);
}
Expand Down
21 changes: 21 additions & 0 deletions packages/rrweb-snapshot/test/rebuild.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -182,4 +182,25 @@ describe('rebuild', function () {
expect(getDuration(cachedEnd) * factor).toBeLessThan(getDuration(end));
});
});

// sentry: skipped because we've removed `adaptCssForReplay` for now
// it('should not incorrectly interpret escaped quotes', () => {
// // the ':hover' in the below is a decoy which is not part of the selector,
// // previously that part was being incorrectly consumed by the selector regex
// const should_not_modify =
// ".tailwind :is(.before\\:content-\\[\\'\\'\\])::before { --tw-content: \":hover\"; content: var(--tw-content); }.tailwind :is(.\\[\\&\\>li\\]\\:before\\:content-\\[\\'-\\'\\] > li)::before { color: pink; }";
// expect(adaptCssForReplay(should_not_modify, cache)).toEqual(
// should_not_modify,
// );
// });

// sentry: skipped because we've removed `adaptCssForReplay` for now
// it('should not incorrectly interpret at rules', () => {
// // the ':hover' in the below is a decoy which is not part of the selector,
// const should_not_modify =
// '@import url("https://fonts.googleapis.com/css2?family=Rubik:ital,wght@0,400;0,500;0,700;1,400&display=:hover");';
// expect(adaptCssForReplay(should_not_modify, cache)).toEqual(
// should_not_modify,
// );
// });
});
1 change: 0 additions & 1 deletion packages/rrweb/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ export { deserializeArg } from './replay/canvas/deserialize-args';
export {
CanvasManager,
takeFullSnapshot,
mirror,
freezePage,
addCustomEvent,
} from './record';
Expand Down
3 changes: 1 addition & 2 deletions packages/rrweb/src/record/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,7 @@ try {
console.debug('Unable to override Array.from', err);
}

export const mirror = createMirror();

const mirror = createMirror();
function record<T = eventWithTime>(
options: recordOptions<T> = {},
): listenerHandler | undefined {
Expand Down
Loading

0 comments on commit 50b54a9

Please sign in to comment.