Skip to content

[HIG-3472] investigate cross origin iframe #99

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 12 commits into from
Closed

[HIG-3472] investigate cross origin iframe #99

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
9dcc1fa
[HIG] add Highlight features for rrweb up to [email protected]
jay-khatri Dec 15, 2020
d44473d
[HIG-2649] use yarn v3 workspace dependencies (#91)
Vadman97 Sep 27, 2022
415dcef
fix rrweb publishing (#92)
Vadman97 Sep 27, 2022
5cbd07f
support for highlight yarn workspaces monorepo
Vadman97 Sep 29, 2022
a84270e
apply highlight prettier config
Vadman97 Oct 17, 2022
1461130
fix rrweb ci checks (#95)
Vadman97 Oct 18, 2022
3138f39
build rrweb with sourcemaps
Vadman97 Oct 21, 2022
6800b72
ensure media elements have their source blocked correctly (#97)
Vadman97 Dec 9, 2022
41594b5
fix: remove passive:true from event listener patch (#98)
aptlin Dec 14, 2022
9a3dd85
Apply formatting changes
Vadman97 Jan 6, 2023
8fdd684
fixes
Vadman97 Jan 6, 2023
52dfcca
cleanup iframe-manager
Vadman97 Jan 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 12 additions & 24 deletions .github/workflows/style-check.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,16 @@ on: [push, pull_request_target]
jobs:
eslint_check_upload:
runs-on: ubuntu-latest
name: ESLint Check and Report Upload
name: Build & ESLint Check

steps:
- uses: actions/checkout@v3
with:
repository: ${{ github.event.pull_request.head.repo.full_name }}
ref: ${{ github.head_ref }}
- name: Setup Node
- name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: 16
cache: 'yarn'
- name: Install Dependencies
run: yarn
- name: Install
run: YARN_ENABLE_IMMUTABLE_INSTALLS=false yarn
- name: Build Packages
run: yarn build:all
- name: Eslint Check
Expand Down Expand Up @@ -51,41 +47,33 @@ jobs:

prettier_check:
# In the forked PR, it's hard to format code and push to the branch directly, so the action only check the format correctness.
if: github.event_name != 'push' && github.event.pull_request.head.repo.full_name != 'rrweb-io/rrweb'
if: github.event_name != 'push'
runs-on: ubuntu-latest
name: Format Check
steps:
- uses: actions/checkout@v3
with:
repository: ${{ github.event.pull_request.head.repo.full_name }}
ref: ${{ github.head_ref }}
- name: Setup Node
- name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: 16
cache: 'yarn'
- name: Install Dependencies
run: yarn
- name: Install
run: YARN_ENABLE_IMMUTABLE_INSTALLS=false yarn
- name: Prettier Check
run: yarn prettier --check '**/*.{ts,md}'

prettier:
# Skip the format code action in forked PRs
if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name == 'rrweb-io/rrweb'
if: github.event_name == 'push'
runs-on: ubuntu-latest
name: Format Code
steps:
- uses: actions/checkout@v3
with:
repository: ${{ github.event.pull_request.head.repo.full_name }}
ref: ${{ github.head_ref }}
- name: Setup Node
- name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: 16
cache: 'yarn'
- name: Install Dependencies
run: yarn
- name: Install
run: YARN_ENABLE_IMMUTABLE_INSTALLS=false yarn
- name: Prettify Code
run: yarn prettier --write '**/*.{ts,md}'
- name: Commit Changes
Expand Down
17 changes: 16 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ node_modules
package-lock.json
tsconfig.tsbuildinfo

# since this repo is referenced from the highlight monorepo which has its own yarn.lock file,
# don't include yarn.lock files from rrweb to avoid interfering with the monorepo
yarn.lock

temp

*.log
Expand All @@ -20,4 +24,15 @@ dist

# `.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
.yarn/install-state.gz

.pnp.*
.yarn/*
!.yarn/patches
!.yarn/plugins
!.yarn/releases
!.yarn/sdks
!.yarn/versions

tsconfig.tsbuildinfo

4 changes: 2 additions & 2 deletions .vscode/rrweb-monorepo.code-workspace
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@
"path": "../packages/rrweb-snapshot"
},
{
"name": "@rrweb/types",
"name": "@highlight-run/rrweb-types",
"path": "../packages/types"
}
],
"settings": {
"jest.disabledWorkspaceFolders": [
" rrweb monorepo",
"rrweb-player (package)",
"@rrweb/types"
"@highlight-run/rrweb-types"
]
}
}
783 changes: 783 additions & 0 deletions .yarn/releases/yarn-berry.cjs
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 3 additions & 1 deletion .yarnrc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
yarnPath: '.yarn/releases/yarn-1.23.0-20220130.1630.cjs'
nodeLinker: node-modules

yarnPath: .yarn/releases/yarn-berry.cjs
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,14 @@ rrweb refers to 'record and replay the web', which is a tool for recording and r

[**🍳 Recipes 🍳**](./docs/recipes/index.md)

## Version History

### 2.0.0

This version updates the highlight rrweb fork on rrweb 1.1.3 April 2022 Release.
Because this is a major update, it may not be suitable for customers looking for stable recording and replay functionality.
However, the major update brings lots of rrweb features that have been in development. See the rrweb release notes for more details.

## Project Structure

rrweb is mainly composed of 3 parts:
Expand Down
50 changes: 25 additions & 25 deletions guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,11 +140,11 @@ The parameter of `rrweb.record` accepts the following options.
| emit | required | the callback function to get emitted events |
| checkoutEveryNth | - | take a full snapshot after every N events<br />refer to the [checkout](#checkout) chapter |
| checkoutEveryNms | - | take a full snapshot after every N ms<br />refer to the [checkout](#checkout) chapter |
| blockClass | 'rr-block' | Use a string or RegExp to configure which elements should be blocked, refer to the [privacy](#privacy) chapter |
| blockClass | 'highlight-block' | Use a string or RegExp to configure which elements should be blocked, refer to the [privacy](#privacy) chapter |
| blockSelector | null | Use a string to configure which selector should be blocked, refer to the [privacy](#privacy) chapter |
| ignoreClass | 'rr-ignore' | Use a string or RegExp to configure which elements should be ignored, refer to the [privacy](#privacy) chapter |
| ignoreClass | 'highlight-ignore' | Use a string or RegExp to configure which elements should be ignored, refer to the [privacy](#privacy) chapter |
| ignoreCSSAttributes | null | array of CSS attributes that should be ignored |
| maskTextClass | 'rr-mask' | Use a string or RegExp to configure which elements should be masked, refer to the [privacy](#privacy) chapter |
| maskTextClass | 'highlight-mask' | Use a string or RegExp to configure which elements should be masked, refer to the [privacy](#privacy) chapter |
| maskTextSelector | null | Use a string to configure which selector should be masked, refer to the [privacy](#privacy) chapter |
| maskAllInputs | false | mask all input content as \* |
| maskInputOptions | { password: true } | mask some kinds of input \*<br />refer to the [list](https://github.com/rrweb-io/rrweb/blob/588164aa12f1d94576f89ae0210b98f6e971c895/packages/rrweb-snapshot/src/types.ts#L77-L95) |
Expand All @@ -167,9 +167,9 @@ The parameter of `rrweb.record` accepts the following options.

You may find some contents on the webpage which are not willing to be recorded, then you can use the following approaches:

- An element with the class name `.rr-block` will not be recorded. Instead, it will replay as a placeholder with the same dimension.
- An element with the class name `.rr-ignore` will not record its input events.
- All text of elements with the class name `.rr-mask` and their children will be masked.
- An element with the class name `.highlight-block` will not be recorded. Instead, it will replay as a placeholder with the same dimension.
- An element with the class name `.highlight-ignore` will not record its input events.
- All text of elements with the class name `.highlight-mask` and their children will be masked.
- `input[type="password"]` will be masked by default.
- Mask options to mask the content in input elements.

Expand Down Expand Up @@ -292,25 +292,25 @@ replayer.destroy();

The replayer accepts options as its constructor's second parameter, and it has the following options:

| key | default | description |
| ------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| speed | 1 | replay speed ratio |
| root | document.body | the root element of replayer |
| loadTimeout | 0 | timeout of loading remote style sheet |
| skipInactive | false | whether to skip inactive time |
| showWarning | true | whether to print warning messages during replay |
| showDebug | false | whether to print debug messages during replay |
| blockClass | 'rr-block' | element with the class name will display as a blocked area |
| liveMode | false | whether to enable live mode |
| insertStyleRules | [] | accepts multiple CSS rule string, which will be injected into the replay iframe |
| triggerFocus | true | whether to trigger focus during replay |
| UNSAFE_replayCanvas | false | whether to replay the canvas element. **Enable this will remove the sandbox, which is unsafe.** |
| pauseAnimation | true | whether to pause CSS animation when the replayer is paused |
| mouseTail | true | whether to show mouse tail during replay. Set to false to disable mouse tail. A complete config can be found in this [type](https://github.com/rrweb-io/rrweb/blob/9488deb6d54a5f04350c063d942da5e96ab74075/src/types.ts#L407) |
| unpackFn | - | refer to the [storage optimization recipe](./docs/recipes/optimize-storage.md) |
| logConfig | - | configuration of console output playback, refer to the [console recipe](./docs/recipes/console.md) |
| plugins | [] | load plugins to provide extended replay functions. [What is plugins?](./docs/recipes/plugin.md) |
| useVirtualDom | true | whether to use Virtual Dom optimization in the process of skipping to a new point of time |
| key | default | description |
| ------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| speed | 1 | replay speed ratio |
| root | document.body | the root element of replayer |
| loadTimeout | 0 | timeout of loading remote style sheet |
| skipInactive | false | whether to skip inactive time |
| showWarning | true | whether to print warning messages during replay |
| showDebug | false | whether to print debug messages during replay |
| blockClass | 'highlight-block' | element with the class name will display as a blocked area |
| liveMode | false | whether to enable live mode |
| insertStyleRules | [] | accepts multiple CSS rule string, which will be injected into the replay iframe |
| triggerFocus | true | whether to trigger focus during replay |
| UNSAFE_replayCanvas | false | whether to replay the canvas element. **Enable this will remove the sandbox, which is unsafe.** |
| pauseAnimation | true | whether to pause CSS animation when the replayer is paused |
| mouseTail | true | whether to show mouse tail during replay. Set to false to disable mouse tail. A complete config can be found in this [type](https://github.com/rrweb-io/rrweb/blob/9488deb6d54a5f04350c063d942da5e96ab74075/src/types.ts#L407) |
| unpackFn | - | refer to the [storage optimization recipe](./docs/recipes/optimize-storage.md) |
| logConfig | - | configuration of console output playback, refer to the [console recipe](./docs/recipes/console.md) |
| plugins | [] | load plugins to provide extended replay functions. [What is plugins?](./docs/recipes/plugin.md) |
| useVirtualDom | true | whether to use Virtual Dom optimization in the process of skipping to a new point of time |

#### Use rrweb-player

Expand Down
Loading